1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(C) 2021 Marvell.
10 enum roc_npc_item_type {
11 ROC_NPC_ITEM_TYPE_VOID,
12 ROC_NPC_ITEM_TYPE_ANY,
13 ROC_NPC_ITEM_TYPE_ETH,
14 ROC_NPC_ITEM_TYPE_VLAN,
15 ROC_NPC_ITEM_TYPE_E_TAG,
16 ROC_NPC_ITEM_TYPE_IPV4,
17 ROC_NPC_ITEM_TYPE_IPV6,
18 ROC_NPC_ITEM_TYPE_ARP_ETH_IPV4,
19 ROC_NPC_ITEM_TYPE_MPLS,
20 ROC_NPC_ITEM_TYPE_ICMP,
21 ROC_NPC_ITEM_TYPE_IGMP,
22 ROC_NPC_ITEM_TYPE_UDP,
23 ROC_NPC_ITEM_TYPE_TCP,
24 ROC_NPC_ITEM_TYPE_SCTP,
25 ROC_NPC_ITEM_TYPE_ESP,
26 ROC_NPC_ITEM_TYPE_GRE,
27 ROC_NPC_ITEM_TYPE_NVGRE,
28 ROC_NPC_ITEM_TYPE_VXLAN,
29 ROC_NPC_ITEM_TYPE_GTPC,
30 ROC_NPC_ITEM_TYPE_GTPU,
31 ROC_NPC_ITEM_TYPE_GENEVE,
32 ROC_NPC_ITEM_TYPE_VXLAN_GPE,
33 ROC_NPC_ITEM_TYPE_IPV6_EXT,
34 ROC_NPC_ITEM_TYPE_GRE_KEY,
35 ROC_NPC_ITEM_TYPE_HIGIG2,
36 ROC_NPC_ITEM_TYPE_CPT_HDR,
37 ROC_NPC_ITEM_TYPE_L3_CUSTOM,
38 ROC_NPC_ITEM_TYPE_QINQ,
39 ROC_NPC_ITEM_TYPE_RAW,
40 ROC_NPC_ITEM_TYPE_END,
43 struct roc_npc_item_info {
44 enum roc_npc_item_type type; /* Item type */
45 uint32_t size; /* item size */
46 const void *spec; /**< Pointer to item specification structure. */
47 const void *mask; /**< Bit-mask applied to spec and last. */
48 const void *last; /* For range */
51 struct roc_npc_flow_item_raw {
52 uint32_t relative : 1; /**< Look for pattern after the previous item. */
53 uint32_t search : 1; /**< Search pattern from offset. */
54 uint32_t reserved : 30; /**< Reserved, must be set to zero. */
55 int32_t offset; /**< Absolute or relative offset for pattern. */
56 uint16_t limit; /**< Search area limit for start of pattern. */
57 uint16_t length; /**< Pattern length. */
58 const uint8_t *pattern; /**< Byte string to look for. */
61 #define ROC_NPC_MAX_ACTION_COUNT 19
63 enum roc_npc_action_type {
64 ROC_NPC_ACTION_TYPE_END = (1 << 0),
65 ROC_NPC_ACTION_TYPE_VOID = (1 << 1),
66 ROC_NPC_ACTION_TYPE_MARK = (1 << 2),
67 ROC_NPC_ACTION_TYPE_FLAG = (1 << 3),
68 ROC_NPC_ACTION_TYPE_DROP = (1 << 4),
69 ROC_NPC_ACTION_TYPE_QUEUE = (1 << 5),
70 ROC_NPC_ACTION_TYPE_RSS = (1 << 6),
71 ROC_NPC_ACTION_TYPE_DUP = (1 << 7),
72 ROC_NPC_ACTION_TYPE_SEC = (1 << 8),
73 ROC_NPC_ACTION_TYPE_COUNT = (1 << 9),
74 ROC_NPC_ACTION_TYPE_PF = (1 << 10),
75 ROC_NPC_ACTION_TYPE_VF = (1 << 11),
76 ROC_NPC_ACTION_TYPE_VLAN_STRIP = (1 << 12),
77 ROC_NPC_ACTION_TYPE_VLAN_INSERT = (1 << 13),
78 ROC_NPC_ACTION_TYPE_VLAN_ETHTYPE_INSERT = (1 << 14),
79 ROC_NPC_ACTION_TYPE_VLAN_PCP_INSERT = (1 << 15),
80 ROC_NPC_ACTION_TYPE_PORT_ID = (1 << 16),
81 ROC_NPC_ACTION_TYPE_METER = (1 << 17),
84 struct roc_npc_action {
85 enum roc_npc_action_type type; /**< Action type. */
86 const void *conf; /**< Pointer to action configuration object. */
89 struct roc_npc_action_mark {
90 uint32_t id; /**< Integer value to return with packets. */
93 struct roc_npc_action_vf {
94 uint32_t original : 1; /**< Use original VF ID if possible. */
95 uint32_t reserved : 31; /**< Reserved, must be zero. */
96 uint32_t id; /**< VF ID. */
99 struct roc_npc_action_port_id {
100 uint32_t original : 1; /**< Use original DPDK port ID if possible. */
101 uint32_t reserved : 31; /**< Reserved, must be zero. */
102 uint32_t id; /**< port ID. */
105 struct roc_npc_action_queue {
106 uint16_t index; /**< Queue index to use. */
109 struct roc_npc_action_of_push_vlan {
110 uint16_t ethertype; /**< EtherType. */
113 struct roc_npc_action_of_set_vlan_vid {
114 uint16_t vlan_vid; /**< VLAN id. */
117 struct roc_npc_action_of_set_vlan_pcp {
118 uint8_t vlan_pcp; /**< VLAN priority. */
121 struct roc_npc_action_meter {
122 uint32_t mtr_id; /**< Meter id to be applied. > */
125 struct roc_npc_attr {
126 uint32_t priority; /**< Rule priority level within group. */
127 uint32_t ingress : 1; /**< Rule applies to ingress traffic. */
128 uint32_t egress : 1; /**< Rule applies to egress traffic. */
129 uint32_t reserved : 30; /**< Reserved, must be zero. */
132 struct roc_npc_flow_dump_data {
137 struct roc_npc_flow {
144 #define ROC_NPC_MAX_MCAM_WIDTH_DWORDS 7
145 /* Contiguous match string */
146 uint64_t mcam_data[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
147 uint64_t mcam_mask[ROC_NPC_MAX_MCAM_WIDTH_DWORDS];
149 uint64_t vtag_action;
150 bool vtag_insert_enabled;
151 uint8_t vtag_insert_count;
152 #define ROC_NPC_MAX_FLOW_PATTERNS 32
153 struct roc_npc_flow_dump_data dump_data[ROC_NPC_MAX_FLOW_PATTERNS];
154 uint16_t num_patterns;
156 TAILQ_ENTRY(roc_npc_flow) next;
159 enum roc_npc_rss_hash_function {
160 ROC_NPC_RSS_HASH_FUNCTION_DEFAULT = 0,
161 ROC_NPC_RSS_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
162 ROC_NPC_RSS_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
163 ROC_NPC_RSS_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
164 ROC_NPC_RSS_HASH_FUNCTION_MAX,
167 struct roc_npc_action_rss {
168 enum roc_npc_rss_hash_function func;
170 uint64_t types; /**< Specific RSS hash types (see RTE_ETH_RSS_*). */
171 uint32_t key_len; /**< Hash key length in bytes. */
172 uint32_t queue_num; /**< Number of entries in @p queue. */
173 const uint8_t *key; /**< Hash key. */
174 const uint16_t *queue; /**< Queue indices to use. */
180 ROC_NPC_INTF_MAX = 2,
183 enum flow_vtag_cfg_dir { VTAG_TX, VTAG_RX };
184 #define ROC_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
185 #define ROC_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
188 struct roc_nix *roc_nix;
189 uint8_t switch_header_type;
190 uint16_t flow_prealloc_size;
191 uint16_t flow_max_priority;
194 uint64_t kex_capability;
195 uint64_t rx_parse_nibble;
196 /* Parsed RSS Flowkey cfg for current flow being created */
197 uint32_t flowkey_cfg_state;
198 bool is_sdp_mask_set;
199 uint16_t sdp_channel;
200 uint16_t sdp_channel_mask;
202 #define ROC_NPC_MEM_SZ (5 * 1024)
203 uint8_t reserved[ROC_NPC_MEM_SZ];
204 } __plt_cache_aligned;
206 int __roc_api roc_npc_init(struct roc_npc *roc_npc);
207 int __roc_api roc_npc_fini(struct roc_npc *roc_npc);
208 const char *__roc_api roc_npc_profile_name_get(struct roc_npc *roc_npc);
210 struct roc_npc_flow *__roc_api
211 roc_npc_flow_create(struct roc_npc *roc_npc, const struct roc_npc_attr *attr,
212 const struct roc_npc_item_info pattern[],
213 const struct roc_npc_action actions[], int *errcode);
214 int __roc_api roc_npc_flow_destroy(struct roc_npc *roc_npc,
215 struct roc_npc_flow *flow);
216 int __roc_api roc_npc_mcam_free_entry(struct roc_npc *roc_npc, uint32_t entry);
217 int __roc_api roc_npc_mcam_alloc_entry(struct roc_npc *roc_npc,
218 struct roc_npc_flow *mcam,
219 struct roc_npc_flow *ref_mcam, int prio,
221 int __roc_api roc_npc_mcam_alloc_entries(struct roc_npc *roc_npc, int ref_entry,
222 int *alloc_entry, int req_count,
223 int priority, int *resp_count);
224 int __roc_api roc_npc_mcam_ena_dis_entry(struct roc_npc *roc_npc,
225 struct roc_npc_flow *mcam,
227 int __roc_api roc_npc_mcam_write_entry(struct roc_npc *roc_npc,
228 struct roc_npc_flow *mcam);
229 int __roc_api roc_npc_flow_parse(struct roc_npc *roc_npc,
230 const struct roc_npc_attr *attr,
231 const struct roc_npc_item_info pattern[],
232 const struct roc_npc_action actions[],
233 struct roc_npc_flow *flow);
234 int __roc_api roc_npc_get_low_priority_mcam(struct roc_npc *roc_npc);
235 int __roc_api roc_npc_mcam_free_counter(struct roc_npc *roc_npc,
237 int __roc_api roc_npc_mcam_read_counter(struct roc_npc *roc_npc,
238 uint32_t ctr_id, uint64_t *count);
239 int __roc_api roc_npc_mcam_clear_counter(struct roc_npc *roc_npc,
241 int __roc_api roc_npc_mcam_free_all_resources(struct roc_npc *roc_npc);
242 void __roc_api roc_npc_flow_dump(FILE *file, struct roc_npc *roc_npc);
243 void __roc_api roc_npc_flow_mcam_dump(FILE *file, struct roc_npc *roc_npc,
244 struct roc_npc_flow *mcam);
245 int __roc_api roc_npc_mark_actions_get(struct roc_npc *roc_npc);
246 int __roc_api roc_npc_mark_actions_sub_return(struct roc_npc *roc_npc,
248 int __roc_api roc_npc_vtag_actions_get(struct roc_npc *roc_npc);
249 int __roc_api roc_npc_vtag_actions_sub_return(struct roc_npc *roc_npc,
251 int __roc_api roc_npc_mcam_merge_base_steering_rule(struct roc_npc *roc_npc,
252 struct roc_npc_flow *flow);
253 int __roc_api roc_npc_validate_portid_action(struct roc_npc *roc_npc_src,
254 struct roc_npc *roc_npc_dst);
255 #endif /* _ROC_NPC_H_ */