1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2021, Intel Corporation. */
3 
4 #include "ice_virtchnl_allowlist.h"
5 
6 /* Purpose of this file is to share functionality to allowlist or denylist
7  * opcodes used in PF <-> VF communication. Group of opcodes:
8  * - default -> should be always allowed after creating VF,
9  *   default_allowlist_opcodes
10  * - opcodes needed by VF to work correctly, but not associated with caps ->
11  *   should be allowed after successful VF resources allocation,
12  *   working_allowlist_opcodes
13  * - opcodes needed by VF when caps are activated
14  *
15  * Caps that don't use new opcodes (no opcodes should be allowed):
16  * - VIRTCHNL_VF_OFFLOAD_RSS_AQ
17  * - VIRTCHNL_VF_OFFLOAD_RSS_REG
18  * - VIRTCHNL_VF_OFFLOAD_WB_ON_ITR
19  * - VIRTCHNL_VF_OFFLOAD_CRC
20  * - VIRTCHNL_VF_OFFLOAD_RX_POLLING
21  * - VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2
22  * - VIRTCHNL_VF_OFFLOAD_ENCAP
23  * - VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM
24  * - VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM
25  * - VIRTCHNL_VF_OFFLOAD_USO
26  */
27 
28 /* default opcodes to communicate with VF */
29 static const u32 default_allowlist_opcodes[] = {
30 	VIRTCHNL_OP_GET_VF_RESOURCES, VIRTCHNL_OP_VERSION, VIRTCHNL_OP_RESET_VF,
31 };
32 
33 /* opcodes supported after successful VIRTCHNL_OP_GET_VF_RESOURCES */
34 static const u32 working_allowlist_opcodes[] = {
35 	VIRTCHNL_OP_CONFIG_TX_QUEUE, VIRTCHNL_OP_CONFIG_RX_QUEUE,
36 	VIRTCHNL_OP_CONFIG_VSI_QUEUES, VIRTCHNL_OP_CONFIG_IRQ_MAP,
37 	VIRTCHNL_OP_ENABLE_QUEUES, VIRTCHNL_OP_DISABLE_QUEUES,
38 	VIRTCHNL_OP_GET_STATS, VIRTCHNL_OP_EVENT,
39 };
40 
41 /* VIRTCHNL_VF_OFFLOAD_L2 */
42 static const u32 l2_allowlist_opcodes[] = {
43 	VIRTCHNL_OP_ADD_ETH_ADDR, VIRTCHNL_OP_DEL_ETH_ADDR,
44 	VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE,
45 };
46 
47 /* VIRTCHNL_VF_OFFLOAD_REQ_QUEUES */
48 static const u32 req_queues_allowlist_opcodes[] = {
49 	VIRTCHNL_OP_REQUEST_QUEUES,
50 };
51 
52 /* VIRTCHNL_VF_OFFLOAD_VLAN */
53 static const u32 vlan_allowlist_opcodes[] = {
54 	VIRTCHNL_OP_ADD_VLAN, VIRTCHNL_OP_DEL_VLAN,
55 	VIRTCHNL_OP_ENABLE_VLAN_STRIPPING, VIRTCHNL_OP_DISABLE_VLAN_STRIPPING,
56 };
57 
58 /* VIRTCHNL_VF_OFFLOAD_VLAN_V2 */
59 static const u32 vlan_v2_allowlist_opcodes[] = {
60 	VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS, VIRTCHNL_OP_ADD_VLAN_V2,
61 	VIRTCHNL_OP_DEL_VLAN_V2, VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2,
62 	VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2,
63 	VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2,
64 	VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2,
65 };
66 
67 /* VIRTCHNL_VF_OFFLOAD_RSS_PF */
68 static const u32 rss_pf_allowlist_opcodes[] = {
69 	VIRTCHNL_OP_CONFIG_RSS_KEY, VIRTCHNL_OP_CONFIG_RSS_LUT,
70 	VIRTCHNL_OP_GET_RSS_HENA_CAPS, VIRTCHNL_OP_SET_RSS_HENA,
71 	VIRTCHNL_OP_CONFIG_RSS_HFUNC,
72 };
73 
74 /* VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC */
75 static const u32 rx_flex_desc_allowlist_opcodes[] = {
76 	VIRTCHNL_OP_GET_SUPPORTED_RXDIDS,
77 };
78 
79 /* VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF */
80 static const u32 adv_rss_pf_allowlist_opcodes[] = {
81 	VIRTCHNL_OP_ADD_RSS_CFG, VIRTCHNL_OP_DEL_RSS_CFG,
82 };
83 
84 /* VIRTCHNL_VF_OFFLOAD_FDIR_PF */
85 static const u32 fdir_pf_allowlist_opcodes[] = {
86 	VIRTCHNL_OP_ADD_FDIR_FILTER, VIRTCHNL_OP_DEL_FDIR_FILTER,
87 };
88 
89 struct allowlist_opcode_info {
90 	const u32 *opcodes;
91 	size_t size;
92 };
93 
94 #define BIT_INDEX(caps) (HWEIGHT((caps) - 1))
95 #define ALLOW_ITEM(caps, list) \
96 	[BIT_INDEX(caps)] = { \
97 		.opcodes = list, \
98 		.size = ARRAY_SIZE(list) \
99 	}
100 static const struct allowlist_opcode_info allowlist_opcodes[] = {
101 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_L2, l2_allowlist_opcodes),
102 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_REQ_QUEUES, req_queues_allowlist_opcodes),
103 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_VLAN, vlan_allowlist_opcodes),
104 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_RSS_PF, rss_pf_allowlist_opcodes),
105 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC, rx_flex_desc_allowlist_opcodes),
106 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF, adv_rss_pf_allowlist_opcodes),
107 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_FDIR_PF, fdir_pf_allowlist_opcodes),
108 	ALLOW_ITEM(VIRTCHNL_VF_OFFLOAD_VLAN_V2, vlan_v2_allowlist_opcodes),
109 };
110 
111 /**
112  * ice_vc_is_opcode_allowed - check if this opcode is allowed on this VF
113  * @vf: pointer to VF structure
114  * @opcode: virtchnl opcode
115  *
116  * Return true if message is allowed on this VF
117  */
118 bool ice_vc_is_opcode_allowed(struct ice_vf *vf, u32 opcode)
119 {
120 	if (opcode >= VIRTCHNL_OP_MAX)
121 		return false;
122 
123 	return test_bit(opcode, vf->opcodes_allowlist);
124 }
125 
126 /**
127  * ice_vc_allowlist_opcodes - allowlist selected opcodes
128  * @vf: pointer to VF structure
129  * @opcodes: array of opocodes to allowlist
130  * @size: size of opcodes array
131  *
132  * Function should be called to allowlist opcodes on VF.
133  */
134 static void
135 ice_vc_allowlist_opcodes(struct ice_vf *vf, const u32 *opcodes, size_t size)
136 {
137 	unsigned int i;
138 
139 	for (i = 0; i < size; i++)
140 		set_bit(opcodes[i], vf->opcodes_allowlist);
141 }
142 
143 /**
144  * ice_vc_clear_allowlist - clear all allowlist opcodes
145  * @vf: pointer to VF structure
146  */
147 static void ice_vc_clear_allowlist(struct ice_vf *vf)
148 {
149 	bitmap_zero(vf->opcodes_allowlist, VIRTCHNL_OP_MAX);
150 }
151 
152 /**
153  * ice_vc_set_default_allowlist - allowlist default opcodes for VF
154  * @vf: pointer to VF structure
155  */
156 void ice_vc_set_default_allowlist(struct ice_vf *vf)
157 {
158 	ice_vc_clear_allowlist(vf);
159 	ice_vc_allowlist_opcodes(vf, default_allowlist_opcodes,
160 				 ARRAY_SIZE(default_allowlist_opcodes));
161 }
162 
163 /**
164  * ice_vc_set_working_allowlist - allowlist opcodes needed to by VF to work
165  * @vf: pointer to VF structure
166  *
167  * allowlist opcodes that aren't associated with specific caps, but
168  * are needed by VF to work.
169  */
170 void ice_vc_set_working_allowlist(struct ice_vf *vf)
171 {
172 	ice_vc_allowlist_opcodes(vf, working_allowlist_opcodes,
173 				 ARRAY_SIZE(working_allowlist_opcodes));
174 }
175 
176 /**
177  * ice_vc_set_caps_allowlist - allowlist VF opcodes according caps
178  * @vf: pointer to VF structure
179  */
180 void ice_vc_set_caps_allowlist(struct ice_vf *vf)
181 {
182 	unsigned long caps = vf->driver_caps;
183 	unsigned int i;
184 
185 	for_each_set_bit(i, &caps, ARRAY_SIZE(allowlist_opcodes))
186 		ice_vc_allowlist_opcodes(vf, allowlist_opcodes[i].opcodes,
187 					 allowlist_opcodes[i].size);
188 }
189