1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2019 Intel Corporation
5 #ifndef _RTE_PMD_IAVF_H_
6 #define _RTE_PMD_IAVF_H_
11 * iavf PMD specific functions.
13 * @b EXPERIMENTAL: this API may change, or be removed, without prior notiavf
19 #include <rte_mbuf_dyn.h>
26 * The supported network flexible descriptor's extraction metadata format.
28 union rte_pmd_ifd_proto_xtr_metadata {
85 /* Offset of mbuf dynamic field for flexible descriptor's extraction data */
86 extern int rte_pmd_ifd_dynfield_proto_xtr_metadata_offs;
88 /* Mask of mbuf dynamic flags for flexible descriptor's extraction type */
89 extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_vlan_mask;
90 extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipv4_mask;
91 extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipv6_mask;
92 extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipv6_flow_mask;
93 extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_tcp_mask;
94 extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ip_offset_mask;
95 extern uint64_t rte_pmd_ifd_dynflag_proto_xtr_ipsec_crypto_said_mask;
98 * The mbuf dynamic field pointer for flexible descriptor's extraction metadata.
100 #define RTE_PMD_IFD_DYNF_PROTO_XTR_METADATA(m) \
101 RTE_MBUF_DYNFIELD((m), \
102 rte_pmd_ifd_dynfield_proto_xtr_metadata_offs, \
106 * The mbuf dynamic flag for VLAN protocol extraction metadata, it is valid
107 * when dev_args 'proto_xtr' has 'vlan' specified.
109 #define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_VLAN \
110 (rte_pmd_ifd_dynflag_proto_xtr_vlan_mask)
113 * The mbuf dynamic flag for IPv4 protocol extraction metadata, it is valid
114 * when dev_args 'proto_xtr' has 'ipv4' specified.
116 #define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV4 \
117 (rte_pmd_ifd_dynflag_proto_xtr_ipv4_mask)
120 * The mbuf dynamic flag for IPv6 protocol extraction metadata, it is valid
121 * when dev_args 'proto_xtr' has 'ipv6' specified.
123 #define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6 \
124 (rte_pmd_ifd_dynflag_proto_xtr_ipv6_mask)
127 * The mbuf dynamic flag for IPv6 with flow protocol extraction metadata, it is
128 * valid when dev_args 'proto_xtr' has 'ipv6_flow' specified.
130 #define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6_FLOW \
131 (rte_pmd_ifd_dynflag_proto_xtr_ipv6_flow_mask)
134 * The mbuf dynamic flag for TCP protocol extraction metadata, it is valid
135 * when dev_args 'proto_xtr' has 'tcp' specified.
137 #define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_TCP \
138 (rte_pmd_ifd_dynflag_proto_xtr_tcp_mask)
141 * The mbuf dynamic flag for IP_OFFSET extraction metadata, it is valid
142 * when dev_args 'proto_xtr' has 'ip_offset' specified.
144 #define RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IP_OFFSET \
145 (rte_pmd_ifd_dynflag_proto_xtr_ip_offset_mask)
148 * Check if mbuf dynamic field for flexible descriptor's extraction metadata
152 * True if registered, false otherwise.
155 static __rte_always_inline int
156 rte_pmd_ifd_dynf_proto_xtr_metadata_avail(void)
158 return rte_pmd_ifd_dynfield_proto_xtr_metadata_offs != -1;
162 * Get the mbuf dynamic field for flexible descriptor's extraction metadata.
165 * The pointer to the mbuf.
167 * The saved protocol extraction metadata.
170 static __rte_always_inline uint32_t
171 rte_pmd_ifd_dynf_proto_xtr_metadata_get(struct rte_mbuf *m)
173 return *RTE_PMD_IFD_DYNF_PROTO_XTR_METADATA(m);
177 * Dump the mbuf dynamic field for flexible descriptor's extraction metadata.
180 * The pointer to the mbuf.
184 rte_pmd_ifd_dump_proto_xtr_metadata(struct rte_mbuf *m)
186 union rte_pmd_ifd_proto_xtr_metadata data;
188 if (!rte_pmd_ifd_dynf_proto_xtr_metadata_avail())
191 data.metadata = rte_pmd_ifd_dynf_proto_xtr_metadata_get(m);
193 if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_VLAN)
194 printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
195 "vlan,stag=%u:%u:%u,ctag=%u:%u:%u",
196 data.raw.data0, data.raw.data1,
203 else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV4)
204 printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
205 "ipv4,ver=%u,hdrlen=%u,tos=%u,ttl=%u,proto=%u",
206 data.raw.data0, data.raw.data1,
212 else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6)
213 printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
214 "ipv6,ver=%u,tc=%u,flow_hi4=0x%x,nexthdr=%u,hoplimit=%u",
215 data.raw.data0, data.raw.data1,
221 else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IPV6_FLOW)
222 printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
223 "ipv6_flow,ver=%u,tc=%u,flow=0x%x%04x",
224 data.raw.data0, data.raw.data1,
225 data.ipv6_flow.version,
227 data.ipv6_flow.flowhi4,
228 data.ipv6_flow.flowlo16);
229 else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_TCP)
230 printf(" - Flexible descriptor's Metadata: [0x%04x:0x%04x],"
231 "tcp,doff=%u,flags=%s%s%s%s%s%s%s%s",
232 data.raw.data0, data.raw.data1,
234 data.tcp.cwr ? "C" : "",
235 data.tcp.ece ? "E" : "",
236 data.tcp.urg ? "U" : "",
237 data.tcp.ack ? "A" : "",
238 data.tcp.psh ? "P" : "",
239 data.tcp.rst ? "R" : "",
240 data.tcp.syn ? "S" : "",
241 data.tcp.fin ? "F" : "");
242 else if (m->ol_flags & RTE_IAVF_PKT_RX_DYNF_PROTO_XTR_IP_OFFSET)
243 printf(" - Flexible descriptor's Extraction: ip_offset=%u",
251 #endif /* _RTE_PMD_IAVF_H_ */