1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2010-2017 Intel Corporation 3 */ 4 5 #ifndef _RTE_ETHDEV_H_ 6 #define _RTE_ETHDEV_H_ 7 8 /** 9 * @file 10 * 11 * RTE Ethernet Device API 12 * 13 * The Ethernet Device API is composed of two parts: 14 * 15 * - The application-oriented Ethernet API that includes functions to setup 16 * an Ethernet device (configure it, setup its Rx and Tx queues and start it), 17 * to get its MAC address, the speed and the status of its physical link, 18 * to receive and to transmit packets, and so on. 19 * 20 * - The driver-oriented Ethernet API that exports functions allowing 21 * an Ethernet Poll Mode Driver (PMD) to allocate an Ethernet device instance, 22 * create memzone for HW rings and process registered callbacks, and so on. 23 * PMDs should include ethdev_driver.h instead of this header. 24 * 25 * By default, all the functions of the Ethernet Device API exported by a PMD 26 * are lock-free functions which assume to not be invoked in parallel on 27 * different logical cores to work on the same target object. For instance, 28 * the receive function of a PMD cannot be invoked in parallel on two logical 29 * cores to poll the same Rx queue [of the same port]. Of course, this function 30 * can be invoked in parallel by different logical cores on different Rx queues. 31 * It is the responsibility of the upper level application to enforce this rule. 32 * 33 * If needed, parallel accesses by multiple logical cores to shared queues 34 * shall be explicitly protected by dedicated inline lock-aware functions 35 * built on top of their corresponding lock-free functions of the PMD API. 36 * 37 * In all functions of the Ethernet API, the Ethernet device is 38 * designated by an integer >= 0 named the device port identifier. 39 * 40 * At the Ethernet driver level, Ethernet devices are represented by a generic 41 * data structure of type *rte_eth_dev*. 42 * 43 * Ethernet devices are dynamically registered during the PCI probing phase 44 * performed at EAL initialization time. 45 * When an Ethernet device is being probed, an *rte_eth_dev* structure and 46 * a new port identifier are allocated for that device. Then, the eth_dev_init() 47 * function supplied by the Ethernet driver matching the probed PCI 48 * device is invoked to properly initialize the device. 49 * 50 * The role of the device init function consists of resetting the hardware, 51 * checking access to Non-volatile Memory (NVM), reading the MAC address 52 * from NVM etc. 53 * 54 * If the device init operation is successful, the correspondence between 55 * the port identifier assigned to the new device and its associated 56 * *rte_eth_dev* structure is effectively registered. 57 * Otherwise, both the *rte_eth_dev* structure and the port identifier are 58 * freed. 59 * 60 * The functions exported by the application Ethernet API to setup a device 61 * designated by its port identifier must be invoked in the following order: 62 * - rte_eth_dev_configure() 63 * - rte_eth_tx_queue_setup() 64 * - rte_eth_rx_queue_setup() 65 * - rte_eth_dev_start() 66 * 67 * Then, the network application can invoke, in any order, the functions 68 * exported by the Ethernet API to get the MAC address of a given device, to 69 * get the speed and the status of a device physical link, to receive/transmit 70 * [burst of] packets, and so on. 71 * 72 * If the application wants to change the configuration (i.e. call 73 * rte_eth_dev_configure(), rte_eth_tx_queue_setup(), or 74 * rte_eth_rx_queue_setup()), it must call rte_eth_dev_stop() first to stop the 75 * device and then do the reconfiguration before calling rte_eth_dev_start() 76 * again. The transmit and receive functions should not be invoked when the 77 * device or the queue is stopped. 78 * 79 * Please note that some configuration is not stored between calls to 80 * rte_eth_dev_stop()/rte_eth_dev_start(). The following configuration will 81 * be retained: 82 * 83 * - MTU 84 * - flow control settings 85 * - receive mode configuration (promiscuous mode, all-multicast mode, 86 * hardware checksum mode, RSS/VMDq settings etc.) 87 * - VLAN filtering configuration 88 * - default MAC address 89 * - MAC addresses supplied to MAC address array 90 * - flow director filtering mode (but not filtering rules) 91 * - NIC queue statistics mappings 92 * 93 * The following configuration may be retained or not 94 * depending on the device capabilities: 95 * 96 * - flow rules 97 * - flow-related shared objects, e.g. indirect actions 98 * 99 * Any other configuration will not be stored and will need to be re-entered 100 * before a call to rte_eth_dev_start(). 101 * 102 * Finally, a network application can close an Ethernet device by invoking the 103 * rte_eth_dev_close() function. 104 * 105 * Each function of the application Ethernet API invokes a specific function 106 * of the PMD that controls the target device designated by its port 107 * identifier. 108 * For this purpose, all device-specific functions of an Ethernet driver are 109 * supplied through a set of pointers contained in a generic structure of type 110 * *eth_dev_ops*. 111 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev* 112 * structure by the device init function of the Ethernet driver, which is 113 * invoked during the PCI probing phase, as explained earlier. 114 * 115 * In other words, each function of the Ethernet API simply retrieves the 116 * *rte_eth_dev* structure associated with the device port identifier and 117 * performs an indirect invocation of the corresponding driver function 118 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure. 119 * 120 * For performance reasons, the address of the burst-oriented Rx and Tx 121 * functions of the Ethernet driver are not contained in the *eth_dev_ops* 122 * structure. Instead, they are directly stored at the beginning of the 123 * *rte_eth_dev* structure to avoid an extra indirect memory access during 124 * their invocation. 125 * 126 * RTE Ethernet device drivers do not use interrupts for transmitting or 127 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit 128 * functions to applications. 129 * Both receive and transmit functions are packet-burst oriented to minimize 130 * their cost per packet through the following optimizations: 131 * 132 * - Sharing among multiple packets the incompressible cost of the 133 * invocation of receive/transmit functions. 134 * 135 * - Enabling receive/transmit functions to take advantage of burst-oriented 136 * hardware features (L1 cache, prefetch instructions, NIC head/tail 137 * registers) to minimize the number of CPU cycles per packet, for instance, 138 * by avoiding useless read memory accesses to ring descriptors, or by 139 * systematically using arrays of pointers that exactly fit L1 cache line 140 * boundaries and sizes. 141 * 142 * The burst-oriented receive function does not provide any error notification, 143 * to avoid the corresponding overhead. As a hint, the upper-level application 144 * might check the status of the device link once being systematically returned 145 * a 0 value by the receive function of the driver for a given number of tries. 146 */ 147 148 #ifdef __cplusplus 149 extern "C" { 150 #endif 151 152 #include <stdint.h> 153 154 /* Use this macro to check if LRO API is supported */ 155 #define RTE_ETHDEV_HAS_LRO_SUPPORT 156 157 /* Alias RTE_LIBRTE_ETHDEV_DEBUG for backward compatibility. */ 158 #ifdef RTE_LIBRTE_ETHDEV_DEBUG 159 #define RTE_ETHDEV_DEBUG_RX 160 #define RTE_ETHDEV_DEBUG_TX 161 #endif 162 163 #include <rte_cman.h> 164 #include <rte_compat.h> 165 #include <rte_log.h> 166 #include <rte_interrupts.h> 167 #include <rte_dev.h> 168 #include <rte_devargs.h> 169 #include <rte_bitops.h> 170 #include <rte_errno.h> 171 #include <rte_common.h> 172 #include <rte_config.h> 173 #include <rte_power_intrinsics.h> 174 175 #include "rte_ethdev_trace_fp.h" 176 #include "rte_dev_info.h" 177 178 extern int rte_eth_dev_logtype; 179 180 #define RTE_ETHDEV_LOG(level, ...) \ 181 rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__) 182 183 struct rte_mbuf; 184 185 /** 186 * Initializes a device iterator. 187 * 188 * This iterator allows accessing a list of devices matching some devargs. 189 * 190 * @param iter 191 * Device iterator handle initialized by the function. 192 * The fields bus_str and cls_str might be dynamically allocated, 193 * and could be freed by calling rte_eth_iterator_cleanup(). 194 * 195 * @param devargs 196 * Device description string. 197 * 198 * @return 199 * 0 on successful initialization, negative otherwise. 200 */ 201 int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs); 202 203 /** 204 * Iterates on devices with devargs filter. 205 * The ownership is not checked. 206 * 207 * The next port ID is returned, and the iterator is updated. 208 * 209 * @param iter 210 * Device iterator handle initialized by rte_eth_iterator_init(). 211 * Some fields bus_str and cls_str might be freed when no more port is found, 212 * by calling rte_eth_iterator_cleanup(). 213 * 214 * @return 215 * A port ID if found, RTE_MAX_ETHPORTS otherwise. 216 */ 217 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter); 218 219 /** 220 * Free some allocated fields of the iterator. 221 * 222 * This function is automatically called by rte_eth_iterator_next() 223 * on the last iteration (i.e. when no more matching port is found). 224 * 225 * It is safe to call this function twice; it will do nothing more. 226 * 227 * @param iter 228 * Device iterator handle initialized by rte_eth_iterator_init(). 229 * The fields bus_str and cls_str are freed if needed. 230 */ 231 void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter); 232 233 /** 234 * Macro to iterate over all ethdev ports matching some devargs. 235 * 236 * If a break is done before the end of the loop, 237 * the function rte_eth_iterator_cleanup() must be called. 238 * 239 * @param id 240 * Iterated port ID of type uint16_t. 241 * @param devargs 242 * Device parameters input as string of type char*. 243 * @param iter 244 * Iterator handle of type struct rte_dev_iterator, used internally. 245 */ 246 #define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter) \ 247 for (rte_eth_iterator_init(iter, devargs), \ 248 id = rte_eth_iterator_next(iter); \ 249 id != RTE_MAX_ETHPORTS; \ 250 id = rte_eth_iterator_next(iter)) 251 252 /** 253 * A structure used to retrieve statistics for an Ethernet port. 254 * Not all statistics fields in struct rte_eth_stats are supported 255 * by any type of network interface card (NIC). If any statistics 256 * field is not supported, its value is 0. 257 * All byte-related statistics do not include Ethernet FCS regardless 258 * of whether these bytes have been delivered to the application 259 * (see RTE_ETH_RX_OFFLOAD_KEEP_CRC). 260 */ 261 struct rte_eth_stats { 262 uint64_t ipackets; /**< Total number of successfully received packets. */ 263 uint64_t opackets; /**< Total number of successfully transmitted packets.*/ 264 uint64_t ibytes; /**< Total number of successfully received bytes. */ 265 uint64_t obytes; /**< Total number of successfully transmitted bytes. */ 266 /** 267 * Total of Rx packets dropped by the HW, 268 * because there are no available buffer (i.e. Rx queues are full). 269 */ 270 uint64_t imissed; 271 uint64_t ierrors; /**< Total number of erroneous received packets. */ 272 uint64_t oerrors; /**< Total number of failed transmitted packets. */ 273 uint64_t rx_nombuf; /**< Total number of Rx mbuf allocation failures. */ 274 /* Queue stats are limited to max 256 queues */ 275 /** Total number of queue Rx packets. */ 276 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 277 /** Total number of queue Tx packets. */ 278 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 279 /** Total number of successfully received queue bytes. */ 280 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 281 /** Total number of successfully transmitted queue bytes. */ 282 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 283 /** Total number of queue packets received that are dropped. */ 284 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 285 }; 286 287 /**@{@name Link speed capabilities 288 * Device supported speeds bitmap flags 289 */ 290 #define RTE_ETH_LINK_SPEED_AUTONEG 0 /**< Autonegotiate (all speeds) */ 291 #define RTE_ETH_LINK_SPEED_FIXED RTE_BIT32(0) /**< Disable autoneg (fixed speed) */ 292 #define RTE_ETH_LINK_SPEED_10M_HD RTE_BIT32(1) /**< 10 Mbps half-duplex */ 293 #define RTE_ETH_LINK_SPEED_10M RTE_BIT32(2) /**< 10 Mbps full-duplex */ 294 #define RTE_ETH_LINK_SPEED_100M_HD RTE_BIT32(3) /**< 100 Mbps half-duplex */ 295 #define RTE_ETH_LINK_SPEED_100M RTE_BIT32(4) /**< 100 Mbps full-duplex */ 296 #define RTE_ETH_LINK_SPEED_1G RTE_BIT32(5) /**< 1 Gbps */ 297 #define RTE_ETH_LINK_SPEED_2_5G RTE_BIT32(6) /**< 2.5 Gbps */ 298 #define RTE_ETH_LINK_SPEED_5G RTE_BIT32(7) /**< 5 Gbps */ 299 #define RTE_ETH_LINK_SPEED_10G RTE_BIT32(8) /**< 10 Gbps */ 300 #define RTE_ETH_LINK_SPEED_20G RTE_BIT32(9) /**< 20 Gbps */ 301 #define RTE_ETH_LINK_SPEED_25G RTE_BIT32(10) /**< 25 Gbps */ 302 #define RTE_ETH_LINK_SPEED_40G RTE_BIT32(11) /**< 40 Gbps */ 303 #define RTE_ETH_LINK_SPEED_50G RTE_BIT32(12) /**< 50 Gbps */ 304 #define RTE_ETH_LINK_SPEED_56G RTE_BIT32(13) /**< 56 Gbps */ 305 #define RTE_ETH_LINK_SPEED_100G RTE_BIT32(14) /**< 100 Gbps */ 306 #define RTE_ETH_LINK_SPEED_200G RTE_BIT32(15) /**< 200 Gbps */ 307 #define RTE_ETH_LINK_SPEED_400G RTE_BIT32(16) /**< 400 Gbps */ 308 /**@}*/ 309 310 /**@{@name Link speed 311 * Ethernet numeric link speeds in Mbps 312 */ 313 #define RTE_ETH_SPEED_NUM_NONE 0 /**< Not defined */ 314 #define RTE_ETH_SPEED_NUM_10M 10 /**< 10 Mbps */ 315 #define RTE_ETH_SPEED_NUM_100M 100 /**< 100 Mbps */ 316 #define RTE_ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */ 317 #define RTE_ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */ 318 #define RTE_ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */ 319 #define RTE_ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */ 320 #define RTE_ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */ 321 #define RTE_ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */ 322 #define RTE_ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */ 323 #define RTE_ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */ 324 #define RTE_ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */ 325 #define RTE_ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */ 326 #define RTE_ETH_SPEED_NUM_200G 200000 /**< 200 Gbps */ 327 #define RTE_ETH_SPEED_NUM_400G 400000 /**< 400 Gbps */ 328 #define RTE_ETH_SPEED_NUM_UNKNOWN UINT32_MAX /**< Unknown */ 329 /**@}*/ 330 331 /** 332 * A structure used to retrieve link-level information of an Ethernet port. 333 */ 334 __extension__ 335 struct rte_eth_link { 336 uint32_t link_speed; /**< RTE_ETH_SPEED_NUM_ */ 337 uint16_t link_duplex : 1; /**< RTE_ETH_LINK_[HALF/FULL]_DUPLEX */ 338 uint16_t link_autoneg : 1; /**< RTE_ETH_LINK_[AUTONEG/FIXED] */ 339 uint16_t link_status : 1; /**< RTE_ETH_LINK_[DOWN/UP] */ 340 } __rte_aligned(8); /**< aligned for atomic64 read/write */ 341 342 /**@{@name Link negotiation 343 * Constants used in link management. 344 */ 345 #define RTE_ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */ 346 #define RTE_ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */ 347 #define RTE_ETH_LINK_DOWN 0 /**< Link is down (see link_status). */ 348 #define RTE_ETH_LINK_UP 1 /**< Link is up (see link_status). */ 349 #define RTE_ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */ 350 #define RTE_ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */ 351 #define RTE_ETH_LINK_MAX_STR_LEN 40 /**< Max length of default link string. */ 352 /**@}*/ 353 354 /** 355 * A structure used to configure the ring threshold registers of an Rx/Tx 356 * queue for an Ethernet port. 357 */ 358 struct rte_eth_thresh { 359 uint8_t pthresh; /**< Ring prefetch threshold. */ 360 uint8_t hthresh; /**< Ring host threshold. */ 361 uint8_t wthresh; /**< Ring writeback threshold. */ 362 }; 363 364 /**@{@name Multi-queue mode 365 * @see rte_eth_conf.rxmode.mq_mode. 366 */ 367 #define RTE_ETH_MQ_RX_RSS_FLAG RTE_BIT32(0) /**< Enable RSS. @see rte_eth_rss_conf */ 368 #define RTE_ETH_MQ_RX_DCB_FLAG RTE_BIT32(1) /**< Enable DCB. */ 369 #define RTE_ETH_MQ_RX_VMDQ_FLAG RTE_BIT32(2) /**< Enable VMDq. */ 370 /**@}*/ 371 372 /** 373 * A set of values to identify what method is to be used to route 374 * packets to multiple queues. 375 */ 376 enum rte_eth_rx_mq_mode { 377 /** None of DCB, RSS or VMDq mode */ 378 RTE_ETH_MQ_RX_NONE = 0, 379 380 /** For Rx side, only RSS is on */ 381 RTE_ETH_MQ_RX_RSS = RTE_ETH_MQ_RX_RSS_FLAG, 382 /** For Rx side,only DCB is on. */ 383 RTE_ETH_MQ_RX_DCB = RTE_ETH_MQ_RX_DCB_FLAG, 384 /** Both DCB and RSS enable */ 385 RTE_ETH_MQ_RX_DCB_RSS = RTE_ETH_MQ_RX_RSS_FLAG | RTE_ETH_MQ_RX_DCB_FLAG, 386 387 /** Only VMDq, no RSS nor DCB */ 388 RTE_ETH_MQ_RX_VMDQ_ONLY = RTE_ETH_MQ_RX_VMDQ_FLAG, 389 /** RSS mode with VMDq */ 390 RTE_ETH_MQ_RX_VMDQ_RSS = RTE_ETH_MQ_RX_RSS_FLAG | RTE_ETH_MQ_RX_VMDQ_FLAG, 391 /** Use VMDq+DCB to route traffic to queues */ 392 RTE_ETH_MQ_RX_VMDQ_DCB = RTE_ETH_MQ_RX_VMDQ_FLAG | RTE_ETH_MQ_RX_DCB_FLAG, 393 /** Enable both VMDq and DCB in VMDq */ 394 RTE_ETH_MQ_RX_VMDQ_DCB_RSS = RTE_ETH_MQ_RX_RSS_FLAG | RTE_ETH_MQ_RX_DCB_FLAG | 395 RTE_ETH_MQ_RX_VMDQ_FLAG, 396 }; 397 398 /** 399 * A set of values to identify what method is to be used to transmit 400 * packets using multi-TCs. 401 */ 402 enum rte_eth_tx_mq_mode { 403 RTE_ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */ 404 RTE_ETH_MQ_TX_DCB, /**< For Tx side,only DCB is on. */ 405 RTE_ETH_MQ_TX_VMDQ_DCB, /**< For Tx side,both DCB and VT is on. */ 406 RTE_ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */ 407 }; 408 409 /** 410 * A structure used to configure the Rx features of an Ethernet port. 411 */ 412 struct rte_eth_rxmode { 413 /** The multi-queue packet distribution mode to be used, e.g. RSS. */ 414 enum rte_eth_rx_mq_mode mq_mode; 415 uint32_t mtu; /**< Requested MTU. */ 416 /** Maximum allowed size of LRO aggregated packet. */ 417 uint32_t max_lro_pkt_size; 418 /** 419 * Per-port Rx offloads to be set using RTE_ETH_RX_OFFLOAD_* flags. 420 * Only offloads set on rx_offload_capa field on rte_eth_dev_info 421 * structure are allowed to be set. 422 */ 423 uint64_t offloads; 424 425 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 426 void *reserved_ptrs[2]; /**< Reserved for future fields */ 427 }; 428 429 /** 430 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN. 431 * Note that single VLAN is treated the same as inner VLAN. 432 */ 433 enum rte_vlan_type { 434 RTE_ETH_VLAN_TYPE_UNKNOWN = 0, 435 RTE_ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */ 436 RTE_ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */ 437 RTE_ETH_VLAN_TYPE_MAX, 438 }; 439 440 /** 441 * A structure used to describe a VLAN filter. 442 * If the bit corresponding to a VID is set, such VID is on. 443 */ 444 struct rte_vlan_filter_conf { 445 uint64_t ids[64]; 446 }; 447 448 /** 449 * A structure used to configure the Receive Side Scaling (RSS) feature 450 * of an Ethernet port. 451 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points 452 * to an array holding the RSS key to use for hashing specific header 453 * fields of received packets. The length of this array should be indicated 454 * by *rss_key_len* below. Otherwise, a default random hash key is used by 455 * the device driver. 456 * 457 * The *rss_key_len* field of the *rss_conf* structure indicates the length 458 * in bytes of the array pointed by *rss_key*. To be compatible, this length 459 * will be checked in i40e only. Others assume 40 bytes to be used as before. 460 * 461 * The *rss_hf* field of the *rss_conf* structure indicates the different 462 * types of IPv4/IPv6 packets to which the RSS hashing must be applied. 463 * Supplying an *rss_hf* equal to zero disables the RSS feature. 464 */ 465 struct rte_eth_rss_conf { 466 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */ 467 uint8_t rss_key_len; /**< hash key length in bytes. */ 468 uint64_t rss_hf; /**< Hash functions to apply - see below. */ 469 }; 470 471 /* 472 * A packet can be identified by hardware as different flow types. Different 473 * NIC hardware may support different flow types. 474 * Basically, the NIC hardware identifies the flow type as deep protocol as 475 * possible, and exclusively. For example, if a packet is identified as 476 * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types, 477 * though it is an actual IPV4 packet. 478 */ 479 #define RTE_ETH_FLOW_UNKNOWN 0 480 #define RTE_ETH_FLOW_RAW 1 481 #define RTE_ETH_FLOW_IPV4 2 482 #define RTE_ETH_FLOW_FRAG_IPV4 3 483 #define RTE_ETH_FLOW_NONFRAG_IPV4_TCP 4 484 #define RTE_ETH_FLOW_NONFRAG_IPV4_UDP 5 485 #define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP 6 486 #define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER 7 487 #define RTE_ETH_FLOW_IPV6 8 488 #define RTE_ETH_FLOW_FRAG_IPV6 9 489 #define RTE_ETH_FLOW_NONFRAG_IPV6_TCP 10 490 #define RTE_ETH_FLOW_NONFRAG_IPV6_UDP 11 491 #define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP 12 492 #define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13 493 #define RTE_ETH_FLOW_L2_PAYLOAD 14 494 #define RTE_ETH_FLOW_IPV6_EX 15 495 #define RTE_ETH_FLOW_IPV6_TCP_EX 16 496 #define RTE_ETH_FLOW_IPV6_UDP_EX 17 497 /** Consider device port number as a flow differentiator */ 498 #define RTE_ETH_FLOW_PORT 18 499 #define RTE_ETH_FLOW_VXLAN 19 /**< VXLAN protocol based flow */ 500 #define RTE_ETH_FLOW_GENEVE 20 /**< GENEVE protocol based flow */ 501 #define RTE_ETH_FLOW_NVGRE 21 /**< NVGRE protocol based flow */ 502 #define RTE_ETH_FLOW_VXLAN_GPE 22 /**< VXLAN-GPE protocol based flow */ 503 #define RTE_ETH_FLOW_GTPU 23 /**< GTPU protocol based flow */ 504 #define RTE_ETH_FLOW_MAX 24 505 506 /* 507 * Below macros are defined for RSS offload types, they can be used to 508 * fill rte_eth_rss_conf.rss_hf or rte_flow_action_rss.types. 509 */ 510 #define RTE_ETH_RSS_IPV4 RTE_BIT64(2) 511 #define RTE_ETH_RSS_FRAG_IPV4 RTE_BIT64(3) 512 #define RTE_ETH_RSS_NONFRAG_IPV4_TCP RTE_BIT64(4) 513 #define RTE_ETH_RSS_NONFRAG_IPV4_UDP RTE_BIT64(5) 514 #define RTE_ETH_RSS_NONFRAG_IPV4_SCTP RTE_BIT64(6) 515 #define RTE_ETH_RSS_NONFRAG_IPV4_OTHER RTE_BIT64(7) 516 #define RTE_ETH_RSS_IPV6 RTE_BIT64(8) 517 #define RTE_ETH_RSS_FRAG_IPV6 RTE_BIT64(9) 518 #define RTE_ETH_RSS_NONFRAG_IPV6_TCP RTE_BIT64(10) 519 #define RTE_ETH_RSS_NONFRAG_IPV6_UDP RTE_BIT64(11) 520 #define RTE_ETH_RSS_NONFRAG_IPV6_SCTP RTE_BIT64(12) 521 #define RTE_ETH_RSS_NONFRAG_IPV6_OTHER RTE_BIT64(13) 522 #define RTE_ETH_RSS_L2_PAYLOAD RTE_BIT64(14) 523 #define RTE_ETH_RSS_IPV6_EX RTE_BIT64(15) 524 #define RTE_ETH_RSS_IPV6_TCP_EX RTE_BIT64(16) 525 #define RTE_ETH_RSS_IPV6_UDP_EX RTE_BIT64(17) 526 #define RTE_ETH_RSS_PORT RTE_BIT64(18) 527 #define RTE_ETH_RSS_VXLAN RTE_BIT64(19) 528 #define RTE_ETH_RSS_GENEVE RTE_BIT64(20) 529 #define RTE_ETH_RSS_NVGRE RTE_BIT64(21) 530 #define RTE_ETH_RSS_GTPU RTE_BIT64(23) 531 #define RTE_ETH_RSS_ETH RTE_BIT64(24) 532 #define RTE_ETH_RSS_S_VLAN RTE_BIT64(25) 533 #define RTE_ETH_RSS_C_VLAN RTE_BIT64(26) 534 #define RTE_ETH_RSS_ESP RTE_BIT64(27) 535 #define RTE_ETH_RSS_AH RTE_BIT64(28) 536 #define RTE_ETH_RSS_L2TPV3 RTE_BIT64(29) 537 #define RTE_ETH_RSS_PFCP RTE_BIT64(30) 538 #define RTE_ETH_RSS_PPPOE RTE_BIT64(31) 539 #define RTE_ETH_RSS_ECPRI RTE_BIT64(32) 540 #define RTE_ETH_RSS_MPLS RTE_BIT64(33) 541 #define RTE_ETH_RSS_IPV4_CHKSUM RTE_BIT64(34) 542 543 /** 544 * The RTE_ETH_RSS_L4_CHKSUM works on checksum field of any L4 header. 545 * It is similar to RTE_ETH_RSS_PORT that they don't specify the specific type of 546 * L4 header. This macro is defined to replace some specific L4 (TCP/UDP/SCTP) 547 * checksum type for constructing the use of RSS offload bits. 548 * 549 * Due to above reason, some old APIs (and configuration) don't support 550 * RTE_ETH_RSS_L4_CHKSUM. The rte_flow RSS API supports it. 551 * 552 * For the case that checksum is not used in an UDP header, 553 * it takes the reserved value 0 as input for the hash function. 554 */ 555 #define RTE_ETH_RSS_L4_CHKSUM RTE_BIT64(35) 556 557 #define RTE_ETH_RSS_L2TPV2 RTE_BIT64(36) 558 559 /* 560 * We use the following macros to combine with above RTE_ETH_RSS_* for 561 * more specific input set selection. These bits are defined starting 562 * from the high end of the 64 bits. 563 * Note: If we use above RTE_ETH_RSS_* without SRC/DST_ONLY, it represents 564 * both SRC and DST are taken into account. If SRC_ONLY and DST_ONLY of 565 * the same level are used simultaneously, it is the same case as none of 566 * them are added. 567 */ 568 #define RTE_ETH_RSS_L3_SRC_ONLY RTE_BIT64(63) 569 #define RTE_ETH_RSS_L3_DST_ONLY RTE_BIT64(62) 570 #define RTE_ETH_RSS_L4_SRC_ONLY RTE_BIT64(61) 571 #define RTE_ETH_RSS_L4_DST_ONLY RTE_BIT64(60) 572 #define RTE_ETH_RSS_L2_SRC_ONLY RTE_BIT64(59) 573 #define RTE_ETH_RSS_L2_DST_ONLY RTE_BIT64(58) 574 575 /* 576 * Only select IPV6 address prefix as RSS input set according to 577 * https://tools.ietf.org/html/rfc6052 578 * Must be combined with RTE_ETH_RSS_IPV6, RTE_ETH_RSS_NONFRAG_IPV6_UDP, 579 * RTE_ETH_RSS_NONFRAG_IPV6_TCP, RTE_ETH_RSS_NONFRAG_IPV6_SCTP. 580 */ 581 #define RTE_ETH_RSS_L3_PRE32 RTE_BIT64(57) 582 #define RTE_ETH_RSS_L3_PRE40 RTE_BIT64(56) 583 #define RTE_ETH_RSS_L3_PRE48 RTE_BIT64(55) 584 #define RTE_ETH_RSS_L3_PRE56 RTE_BIT64(54) 585 #define RTE_ETH_RSS_L3_PRE64 RTE_BIT64(53) 586 #define RTE_ETH_RSS_L3_PRE96 RTE_BIT64(52) 587 588 /* 589 * Use the following macros to combine with the above layers 590 * to choose inner and outer layers or both for RSS computation. 591 * Bits 50 and 51 are reserved for this. 592 */ 593 594 /** 595 * level 0, requests the default behavior. 596 * Depending on the packet type, it can mean outermost, innermost, 597 * anything in between or even no RSS. 598 * It basically stands for the innermost encapsulation level RSS 599 * can be performed on according to PMD and device capabilities. 600 */ 601 #define RTE_ETH_RSS_LEVEL_PMD_DEFAULT (UINT64_C(0) << 50) 602 603 /** 604 * level 1, requests RSS to be performed on the outermost packet 605 * encapsulation level. 606 */ 607 #define RTE_ETH_RSS_LEVEL_OUTERMOST (UINT64_C(1) << 50) 608 609 /** 610 * level 2, requests RSS to be performed on the specified inner packet 611 * encapsulation level, from outermost to innermost (lower to higher values). 612 */ 613 #define RTE_ETH_RSS_LEVEL_INNERMOST (UINT64_C(2) << 50) 614 #define RTE_ETH_RSS_LEVEL_MASK (UINT64_C(3) << 50) 615 616 #define RTE_ETH_RSS_LEVEL(rss_hf) ((rss_hf & RTE_ETH_RSS_LEVEL_MASK) >> 50) 617 618 /** 619 * For input set change of hash filter, if SRC_ONLY and DST_ONLY of 620 * the same level are used simultaneously, it is the same case as 621 * none of them are added. 622 * 623 * @param rss_hf 624 * RSS types with SRC/DST_ONLY. 625 * @return 626 * RSS types. 627 */ 628 static inline uint64_t 629 rte_eth_rss_hf_refine(uint64_t rss_hf) 630 { 631 if ((rss_hf & RTE_ETH_RSS_L3_SRC_ONLY) && (rss_hf & RTE_ETH_RSS_L3_DST_ONLY)) 632 rss_hf &= ~(RTE_ETH_RSS_L3_SRC_ONLY | RTE_ETH_RSS_L3_DST_ONLY); 633 634 if ((rss_hf & RTE_ETH_RSS_L4_SRC_ONLY) && (rss_hf & RTE_ETH_RSS_L4_DST_ONLY)) 635 rss_hf &= ~(RTE_ETH_RSS_L4_SRC_ONLY | RTE_ETH_RSS_L4_DST_ONLY); 636 637 return rss_hf; 638 } 639 640 #define RTE_ETH_RSS_IPV6_PRE32 ( \ 641 RTE_ETH_RSS_IPV6 | \ 642 RTE_ETH_RSS_L3_PRE32) 643 644 #define RTE_ETH_RSS_IPV6_PRE40 ( \ 645 RTE_ETH_RSS_IPV6 | \ 646 RTE_ETH_RSS_L3_PRE40) 647 648 #define RTE_ETH_RSS_IPV6_PRE48 ( \ 649 RTE_ETH_RSS_IPV6 | \ 650 RTE_ETH_RSS_L3_PRE48) 651 652 #define RTE_ETH_RSS_IPV6_PRE56 ( \ 653 RTE_ETH_RSS_IPV6 | \ 654 RTE_ETH_RSS_L3_PRE56) 655 656 #define RTE_ETH_RSS_IPV6_PRE64 ( \ 657 RTE_ETH_RSS_IPV6 | \ 658 RTE_ETH_RSS_L3_PRE64) 659 660 #define RTE_ETH_RSS_IPV6_PRE96 ( \ 661 RTE_ETH_RSS_IPV6 | \ 662 RTE_ETH_RSS_L3_PRE96) 663 664 #define RTE_ETH_RSS_IPV6_PRE32_UDP ( \ 665 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 666 RTE_ETH_RSS_L3_PRE32) 667 668 #define RTE_ETH_RSS_IPV6_PRE40_UDP ( \ 669 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 670 RTE_ETH_RSS_L3_PRE40) 671 672 #define RTE_ETH_RSS_IPV6_PRE48_UDP ( \ 673 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 674 RTE_ETH_RSS_L3_PRE48) 675 676 #define RTE_ETH_RSS_IPV6_PRE56_UDP ( \ 677 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 678 RTE_ETH_RSS_L3_PRE56) 679 680 #define RTE_ETH_RSS_IPV6_PRE64_UDP ( \ 681 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 682 RTE_ETH_RSS_L3_PRE64) 683 684 #define RTE_ETH_RSS_IPV6_PRE96_UDP ( \ 685 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 686 RTE_ETH_RSS_L3_PRE96) 687 688 #define RTE_ETH_RSS_IPV6_PRE32_TCP ( \ 689 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 690 RTE_ETH_RSS_L3_PRE32) 691 692 #define RTE_ETH_RSS_IPV6_PRE40_TCP ( \ 693 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 694 RTE_ETH_RSS_L3_PRE40) 695 696 #define RTE_ETH_RSS_IPV6_PRE48_TCP ( \ 697 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 698 RTE_ETH_RSS_L3_PRE48) 699 700 #define RTE_ETH_RSS_IPV6_PRE56_TCP ( \ 701 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 702 RTE_ETH_RSS_L3_PRE56) 703 704 #define RTE_ETH_RSS_IPV6_PRE64_TCP ( \ 705 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 706 RTE_ETH_RSS_L3_PRE64) 707 708 #define RTE_ETH_RSS_IPV6_PRE96_TCP ( \ 709 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 710 RTE_ETH_RSS_L3_PRE96) 711 712 #define RTE_ETH_RSS_IPV6_PRE32_SCTP ( \ 713 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \ 714 RTE_ETH_RSS_L3_PRE32) 715 716 #define RTE_ETH_RSS_IPV6_PRE40_SCTP ( \ 717 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \ 718 RTE_ETH_RSS_L3_PRE40) 719 720 #define RTE_ETH_RSS_IPV6_PRE48_SCTP ( \ 721 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \ 722 RTE_ETH_RSS_L3_PRE48) 723 724 #define RTE_ETH_RSS_IPV6_PRE56_SCTP ( \ 725 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \ 726 RTE_ETH_RSS_L3_PRE56) 727 728 #define RTE_ETH_RSS_IPV6_PRE64_SCTP ( \ 729 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \ 730 RTE_ETH_RSS_L3_PRE64) 731 732 #define RTE_ETH_RSS_IPV6_PRE96_SCTP ( \ 733 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \ 734 RTE_ETH_RSS_L3_PRE96) 735 736 #define RTE_ETH_RSS_IP ( \ 737 RTE_ETH_RSS_IPV4 | \ 738 RTE_ETH_RSS_FRAG_IPV4 | \ 739 RTE_ETH_RSS_NONFRAG_IPV4_OTHER | \ 740 RTE_ETH_RSS_IPV6 | \ 741 RTE_ETH_RSS_FRAG_IPV6 | \ 742 RTE_ETH_RSS_NONFRAG_IPV6_OTHER | \ 743 RTE_ETH_RSS_IPV6_EX) 744 745 #define RTE_ETH_RSS_UDP ( \ 746 RTE_ETH_RSS_NONFRAG_IPV4_UDP | \ 747 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 748 RTE_ETH_RSS_IPV6_UDP_EX) 749 750 #define RTE_ETH_RSS_TCP ( \ 751 RTE_ETH_RSS_NONFRAG_IPV4_TCP | \ 752 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 753 RTE_ETH_RSS_IPV6_TCP_EX) 754 755 #define RTE_ETH_RSS_SCTP ( \ 756 RTE_ETH_RSS_NONFRAG_IPV4_SCTP | \ 757 RTE_ETH_RSS_NONFRAG_IPV6_SCTP) 758 759 #define RTE_ETH_RSS_TUNNEL ( \ 760 RTE_ETH_RSS_VXLAN | \ 761 RTE_ETH_RSS_GENEVE | \ 762 RTE_ETH_RSS_NVGRE) 763 764 #define RTE_ETH_RSS_VLAN ( \ 765 RTE_ETH_RSS_S_VLAN | \ 766 RTE_ETH_RSS_C_VLAN) 767 768 /** Mask of valid RSS hash protocols */ 769 #define RTE_ETH_RSS_PROTO_MASK ( \ 770 RTE_ETH_RSS_IPV4 | \ 771 RTE_ETH_RSS_FRAG_IPV4 | \ 772 RTE_ETH_RSS_NONFRAG_IPV4_TCP | \ 773 RTE_ETH_RSS_NONFRAG_IPV4_UDP | \ 774 RTE_ETH_RSS_NONFRAG_IPV4_SCTP | \ 775 RTE_ETH_RSS_NONFRAG_IPV4_OTHER | \ 776 RTE_ETH_RSS_IPV6 | \ 777 RTE_ETH_RSS_FRAG_IPV6 | \ 778 RTE_ETH_RSS_NONFRAG_IPV6_TCP | \ 779 RTE_ETH_RSS_NONFRAG_IPV6_UDP | \ 780 RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \ 781 RTE_ETH_RSS_NONFRAG_IPV6_OTHER | \ 782 RTE_ETH_RSS_L2_PAYLOAD | \ 783 RTE_ETH_RSS_IPV6_EX | \ 784 RTE_ETH_RSS_IPV6_TCP_EX | \ 785 RTE_ETH_RSS_IPV6_UDP_EX | \ 786 RTE_ETH_RSS_PORT | \ 787 RTE_ETH_RSS_VXLAN | \ 788 RTE_ETH_RSS_GENEVE | \ 789 RTE_ETH_RSS_NVGRE | \ 790 RTE_ETH_RSS_MPLS) 791 792 /* 793 * Definitions used for redirection table entry size. 794 * Some RSS RETA sizes may not be supported by some drivers, check the 795 * documentation or the description of relevant functions for more details. 796 */ 797 #define RTE_ETH_RSS_RETA_SIZE_64 64 798 #define RTE_ETH_RSS_RETA_SIZE_128 128 799 #define RTE_ETH_RSS_RETA_SIZE_256 256 800 #define RTE_ETH_RSS_RETA_SIZE_512 512 801 #define RTE_ETH_RETA_GROUP_SIZE 64 802 803 /**@{@name VMDq and DCB maximums */ 804 #define RTE_ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDq VLAN filters. */ 805 #define RTE_ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */ 806 #define RTE_ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDq DCB queues. */ 807 #define RTE_ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */ 808 /**@}*/ 809 810 /**@{@name DCB capabilities */ 811 #define RTE_ETH_DCB_PG_SUPPORT RTE_BIT32(0) /**< Priority Group(ETS) support. */ 812 #define RTE_ETH_DCB_PFC_SUPPORT RTE_BIT32(1) /**< Priority Flow Control support. */ 813 /**@}*/ 814 815 /**@{@name VLAN offload bits */ 816 #define RTE_ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */ 817 #define RTE_ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */ 818 #define RTE_ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */ 819 #define RTE_ETH_QINQ_STRIP_OFFLOAD 0x0008 /**< QINQ Strip On/Off */ 820 821 #define RTE_ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */ 822 #define RTE_ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/ 823 #define RTE_ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/ 824 #define RTE_ETH_QINQ_STRIP_MASK 0x0008 /**< QINQ Strip setting mask */ 825 #define RTE_ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/ 826 /**@}*/ 827 828 /* Definitions used for receive MAC address */ 829 #define RTE_ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */ 830 831 /* Definitions used for unicast hash */ 832 #define RTE_ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */ 833 834 /**@{@name VMDq Rx mode 835 * @see rte_eth_vmdq_rx_conf.rx_mode 836 */ 837 /** Accept untagged packets. */ 838 #define RTE_ETH_VMDQ_ACCEPT_UNTAG RTE_BIT32(0) 839 /** Accept packets in multicast table. */ 840 #define RTE_ETH_VMDQ_ACCEPT_HASH_MC RTE_BIT32(1) 841 /** Accept packets in unicast table. */ 842 #define RTE_ETH_VMDQ_ACCEPT_HASH_UC RTE_BIT32(2) 843 /** Accept broadcast packets. */ 844 #define RTE_ETH_VMDQ_ACCEPT_BROADCAST RTE_BIT32(3) 845 /** Multicast promiscuous. */ 846 #define RTE_ETH_VMDQ_ACCEPT_MULTICAST RTE_BIT32(4) 847 /**@}*/ 848 849 /** 850 * A structure used to configure 64 entries of Redirection Table of the 851 * Receive Side Scaling (RSS) feature of an Ethernet port. To configure 852 * more than 64 entries supported by hardware, an array of this structure 853 * is needed. 854 */ 855 struct rte_eth_rss_reta_entry64 { 856 /** Mask bits indicate which entries need to be updated/queried. */ 857 uint64_t mask; 858 /** Group of 64 redirection table entries. */ 859 uint16_t reta[RTE_ETH_RETA_GROUP_SIZE]; 860 }; 861 862 /** 863 * This enum indicates the possible number of traffic classes 864 * in DCB configurations 865 */ 866 enum rte_eth_nb_tcs { 867 RTE_ETH_4_TCS = 4, /**< 4 TCs with DCB. */ 868 RTE_ETH_8_TCS = 8 /**< 8 TCs with DCB. */ 869 }; 870 871 /** 872 * This enum indicates the possible number of queue pools 873 * in VMDq configurations. 874 */ 875 enum rte_eth_nb_pools { 876 RTE_ETH_8_POOLS = 8, /**< 8 VMDq pools. */ 877 RTE_ETH_16_POOLS = 16, /**< 16 VMDq pools. */ 878 RTE_ETH_32_POOLS = 32, /**< 32 VMDq pools. */ 879 RTE_ETH_64_POOLS = 64 /**< 64 VMDq pools. */ 880 }; 881 882 /* This structure may be extended in future. */ 883 struct rte_eth_dcb_rx_conf { 884 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs */ 885 /** Traffic class each UP mapped to. */ 886 uint8_t dcb_tc[RTE_ETH_DCB_NUM_USER_PRIORITIES]; 887 }; 888 889 struct rte_eth_vmdq_dcb_tx_conf { 890 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools. */ 891 /** Traffic class each UP mapped to. */ 892 uint8_t dcb_tc[RTE_ETH_DCB_NUM_USER_PRIORITIES]; 893 }; 894 895 struct rte_eth_dcb_tx_conf { 896 enum rte_eth_nb_tcs nb_tcs; /**< Possible DCB TCs, 4 or 8 TCs. */ 897 /** Traffic class each UP mapped to. */ 898 uint8_t dcb_tc[RTE_ETH_DCB_NUM_USER_PRIORITIES]; 899 }; 900 901 struct rte_eth_vmdq_tx_conf { 902 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq mode, 64 pools. */ 903 }; 904 905 /** 906 * A structure used to configure the VMDq+DCB feature 907 * of an Ethernet port. 908 * 909 * Using this feature, packets are routed to a pool of queues, based 910 * on the VLAN ID in the VLAN tag, and then to a specific queue within 911 * that pool, using the user priority VLAN tag field. 912 * 913 * A default pool may be used, if desired, to route all traffic which 914 * does not match the VLAN filter rules. 915 */ 916 struct rte_eth_vmdq_dcb_conf { 917 enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */ 918 uint8_t enable_default_pool; /**< If non-zero, use a default pool */ 919 uint8_t default_pool; /**< The default pool, if applicable */ 920 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */ 921 struct { 922 uint16_t vlan_id; /**< The VLAN ID of the received frame */ 923 uint64_t pools; /**< Bitmask of pools for packet Rx */ 924 } pool_map[RTE_ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */ 925 /** Selects a queue in a pool */ 926 uint8_t dcb_tc[RTE_ETH_DCB_NUM_USER_PRIORITIES]; 927 }; 928 929 /** 930 * A structure used to configure the VMDq feature of an Ethernet port when 931 * not combined with the DCB feature. 932 * 933 * Using this feature, packets are routed to a pool of queues. By default, 934 * the pool selection is based on the MAC address, the VLAN ID in the 935 * VLAN tag as specified in the pool_map array. 936 * Passing the RTE_ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool 937 * selection using only the MAC address. MAC address to pool mapping is done 938 * using the rte_eth_dev_mac_addr_add function, with the pool parameter 939 * corresponding to the pool ID. 940 * 941 * Queue selection within the selected pool will be done using RSS when 942 * it is enabled or revert to the first queue of the pool if not. 943 * 944 * A default pool may be used, if desired, to route all traffic which 945 * does not match the VLAN filter rules or any pool MAC address. 946 */ 947 struct rte_eth_vmdq_rx_conf { 948 enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */ 949 uint8_t enable_default_pool; /**< If non-zero, use a default pool */ 950 uint8_t default_pool; /**< The default pool, if applicable */ 951 uint8_t enable_loop_back; /**< Enable VT loop back */ 952 uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */ 953 uint32_t rx_mode; /**< Flags from RTE_ETH_VMDQ_ACCEPT_* */ 954 struct { 955 uint16_t vlan_id; /**< The VLAN ID of the received frame */ 956 uint64_t pools; /**< Bitmask of pools for packet Rx */ 957 } pool_map[RTE_ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */ 958 }; 959 960 /** 961 * A structure used to configure the Tx features of an Ethernet port. 962 */ 963 struct rte_eth_txmode { 964 enum rte_eth_tx_mq_mode mq_mode; /**< Tx multi-queues mode. */ 965 /** 966 * Per-port Tx offloads to be set using RTE_ETH_TX_OFFLOAD_* flags. 967 * Only offloads set on tx_offload_capa field on rte_eth_dev_info 968 * structure are allowed to be set. 969 */ 970 uint64_t offloads; 971 972 uint16_t pvid; 973 __extension__ 974 uint8_t /** If set, reject sending out tagged pkts */ 975 hw_vlan_reject_tagged : 1, 976 /** If set, reject sending out untagged pkts */ 977 hw_vlan_reject_untagged : 1, 978 /** If set, enable port based VLAN insertion */ 979 hw_vlan_insert_pvid : 1; 980 981 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 982 void *reserved_ptrs[2]; /**< Reserved for future fields */ 983 }; 984 985 /** 986 * @warning 987 * @b EXPERIMENTAL: this structure may change without prior notice. 988 * 989 * A structure used to configure an Rx packet segment to split. 990 * 991 * If RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT flag is set in offloads field, 992 * the PMD will split the received packets into multiple segments 993 * according to the specification in the description array: 994 * 995 * - The first network buffer will be allocated from the memory pool, 996 * specified in the first array element, the second buffer, from the 997 * pool in the second element, and so on. 998 * 999 * - The proto_hdrs in the elements define the split position of 1000 * received packets. 1001 * 1002 * - The offsets from the segment description elements specify 1003 * the data offset from the buffer beginning except the first mbuf. 1004 * The first segment offset is added with RTE_PKTMBUF_HEADROOM. 1005 * 1006 * - The lengths in the elements define the maximal data amount 1007 * being received to each segment. The receiving starts with filling 1008 * up the first mbuf data buffer up to specified length. If the 1009 * there are data remaining (packet is longer than buffer in the first 1010 * mbuf) the following data will be pushed to the next segment 1011 * up to its own length, and so on. 1012 * 1013 * - If the length in the segment description element is zero 1014 * the actual buffer size will be deduced from the appropriate 1015 * memory pool properties. 1016 * 1017 * - If there is not enough elements to describe the buffer for entire 1018 * packet of maximal length the following parameters will be used 1019 * for the all remaining segments: 1020 * - pool from the last valid element 1021 * - the buffer size from this pool 1022 * - zero offset 1023 * 1024 * - Length based buffer split: 1025 * - mp, length, offset should be configured. 1026 * - The proto_hdr field must be 0. 1027 * 1028 * - Protocol header based buffer split: 1029 * - mp, offset, proto_hdr should be configured. 1030 * - The length field must be 0. 1031 * - The proto_hdr field in the last segment should be 0. 1032 * 1033 * - When protocol header split is enabled, NIC may receive packets 1034 * which do not match all the protocol headers within the Rx segments. 1035 * At this point, NIC will have two possible split behaviors according to 1036 * matching results, one is exact match, another is longest match. 1037 * The split result of NIC must belong to one of them. 1038 * The exact match means NIC only do split when the packets exactly match all 1039 * the protocol headers in the segments. 1040 * Otherwise, the whole packet will be put into the last valid mempool. 1041 * The longest match means NIC will do split until packets mismatch 1042 * the protocol header in the segments. 1043 * The rest will be put into the last valid pool. 1044 */ 1045 struct rte_eth_rxseg_split { 1046 struct rte_mempool *mp; /**< Memory pool to allocate segment from. */ 1047 uint16_t length; /**< Segment data length, configures split point. */ 1048 uint16_t offset; /**< Data offset from beginning of mbuf data buffer. */ 1049 /** 1050 * proto_hdr defines a bit mask of the protocol sequence as RTE_PTYPE_*. 1051 * The last RTE_PTYPE* in the mask indicates the split position. 1052 * 1053 * If one protocol header is defined to split packets into two segments, 1054 * for non-tunneling packets, the complete protocol sequence should be defined. 1055 * For tunneling packets, for simplicity, only the tunnel and inner part of 1056 * complete protocol sequence is required. 1057 * If several protocol headers are defined to split packets into multi-segments, 1058 * the repeated parts of adjacent segments should be omitted. 1059 */ 1060 uint32_t proto_hdr; 1061 }; 1062 1063 /** 1064 * @warning 1065 * @b EXPERIMENTAL: this structure may change without prior notice. 1066 * 1067 * A common structure used to describe Rx packet segment properties. 1068 */ 1069 union rte_eth_rxseg { 1070 /* The settings for buffer split offload. */ 1071 struct rte_eth_rxseg_split split; 1072 /* The other features settings should be added here. */ 1073 }; 1074 1075 /** 1076 * A structure used to configure an Rx ring of an Ethernet port. 1077 */ 1078 struct rte_eth_rxconf { 1079 struct rte_eth_thresh rx_thresh; /**< Rx ring threshold registers. */ 1080 uint16_t rx_free_thresh; /**< Drives the freeing of Rx descriptors. */ 1081 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */ 1082 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */ 1083 uint16_t rx_nseg; /**< Number of descriptions in rx_seg array. */ 1084 /** 1085 * Share group index in Rx domain and switch domain. 1086 * Non-zero value to enable Rx queue share, zero value disable share. 1087 * PMD is responsible for Rx queue consistency checks to avoid member 1088 * port's configuration contradict to each other. 1089 */ 1090 uint16_t share_group; 1091 uint16_t share_qid; /**< Shared Rx queue ID in group */ 1092 /** 1093 * Per-queue Rx offloads to be set using RTE_ETH_RX_OFFLOAD_* flags. 1094 * Only offloads set on rx_queue_offload_capa or rx_offload_capa 1095 * fields on rte_eth_dev_info structure are allowed to be set. 1096 */ 1097 uint64_t offloads; 1098 /** 1099 * Points to the array of segment descriptions for an entire packet. 1100 * Array elements are properties for consecutive Rx segments. 1101 * 1102 * The supported capabilities of receiving segmentation is reported 1103 * in rte_eth_dev_info.rx_seg_capa field. 1104 */ 1105 union rte_eth_rxseg *rx_seg; 1106 1107 /** 1108 * Array of mempools to allocate Rx buffers from. 1109 * 1110 * This provides support for multiple mbuf pools per Rx queue. 1111 * The capability is reported in device info via positive 1112 * max_rx_mempools. 1113 * 1114 * It could be useful for more efficient usage of memory when an 1115 * application creates different mempools to steer the specific 1116 * size of the packet. 1117 * 1118 * If many mempools are specified, packets received using Rx 1119 * burst may belong to any provided mempool. From ethdev user point 1120 * of view it is undefined how PMD/NIC chooses mempool for a packet. 1121 * 1122 * If Rx scatter is enabled, a packet may be delivered using a chain 1123 * of mbufs obtained from single mempool or multiple mempools based 1124 * on the NIC implementation. 1125 */ 1126 struct rte_mempool **rx_mempools; 1127 uint16_t rx_nmempool; /** < Number of Rx mempools */ 1128 1129 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 1130 void *reserved_ptrs[2]; /**< Reserved for future fields */ 1131 }; 1132 1133 /** 1134 * A structure used to configure a Tx ring of an Ethernet port. 1135 */ 1136 struct rte_eth_txconf { 1137 struct rte_eth_thresh tx_thresh; /**< Tx ring threshold registers. */ 1138 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */ 1139 uint16_t tx_free_thresh; /**< Start freeing Tx buffers if there are 1140 less free descriptors than this value. */ 1141 1142 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */ 1143 /** 1144 * Per-queue Tx offloads to be set using RTE_ETH_TX_OFFLOAD_* flags. 1145 * Only offloads set on tx_queue_offload_capa or tx_offload_capa 1146 * fields on rte_eth_dev_info structure are allowed to be set. 1147 */ 1148 uint64_t offloads; 1149 1150 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 1151 void *reserved_ptrs[2]; /**< Reserved for future fields */ 1152 }; 1153 1154 /** 1155 * @warning 1156 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1157 * 1158 * A structure used to return the Tx or Rx hairpin queue capabilities. 1159 */ 1160 struct rte_eth_hairpin_queue_cap { 1161 /** 1162 * When set, PMD supports placing descriptors and/or data buffers 1163 * in dedicated device memory. 1164 */ 1165 uint32_t locked_device_memory:1; 1166 1167 /** 1168 * When set, PMD supports placing descriptors and/or data buffers 1169 * in host memory managed by DPDK. 1170 */ 1171 uint32_t rte_memory:1; 1172 1173 uint32_t reserved:30; /**< Reserved for future fields */ 1174 }; 1175 1176 /** 1177 * @warning 1178 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1179 * 1180 * A structure used to return the hairpin capabilities that are supported. 1181 */ 1182 struct rte_eth_hairpin_cap { 1183 /** The max number of hairpin queues (different bindings). */ 1184 uint16_t max_nb_queues; 1185 /** Max number of Rx queues to be connected to one Tx queue. */ 1186 uint16_t max_rx_2_tx; 1187 /** Max number of Tx queues to be connected to one Rx queue. */ 1188 uint16_t max_tx_2_rx; 1189 uint16_t max_nb_desc; /**< The max num of descriptors. */ 1190 struct rte_eth_hairpin_queue_cap rx_cap; /**< Rx hairpin queue capabilities. */ 1191 struct rte_eth_hairpin_queue_cap tx_cap; /**< Tx hairpin queue capabilities. */ 1192 }; 1193 1194 #define RTE_ETH_MAX_HAIRPIN_PEERS 32 1195 1196 /** 1197 * @warning 1198 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1199 * 1200 * A structure used to hold hairpin peer data. 1201 */ 1202 struct rte_eth_hairpin_peer { 1203 uint16_t port; /**< Peer port. */ 1204 uint16_t queue; /**< Peer queue. */ 1205 }; 1206 1207 /** 1208 * @warning 1209 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1210 * 1211 * A structure used to configure hairpin binding. 1212 */ 1213 struct rte_eth_hairpin_conf { 1214 uint32_t peer_count:16; /**< The number of peers. */ 1215 1216 /** 1217 * Explicit Tx flow rule mode. 1218 * One hairpin pair of queues should have the same attribute. 1219 * 1220 * - When set, the user should be responsible for inserting the hairpin 1221 * Tx part flows and removing them. 1222 * - When clear, the PMD will try to handle the Tx part of the flows, 1223 * e.g., by splitting one flow into two parts. 1224 */ 1225 uint32_t tx_explicit:1; 1226 1227 /** 1228 * Manually bind hairpin queues. 1229 * One hairpin pair of queues should have the same attribute. 1230 * 1231 * - When set, to enable hairpin, the user should call the hairpin bind 1232 * function after all the queues are set up properly and the ports are 1233 * started. Also, the hairpin unbind function should be called 1234 * accordingly before stopping a port that with hairpin configured. 1235 * - When cleared, the PMD will try to enable the hairpin with the queues 1236 * configured automatically during port start. 1237 */ 1238 uint32_t manual_bind:1; 1239 1240 /** 1241 * Use locked device memory as a backing storage. 1242 * 1243 * - When set, PMD will attempt place descriptors and/or data buffers 1244 * in dedicated device memory. 1245 * - When cleared, PMD will use default memory type as a backing storage. 1246 * Please refer to PMD documentation for details. 1247 * 1248 * API user should check if PMD supports this configuration flag using 1249 * @see rte_eth_dev_hairpin_capability_get. 1250 */ 1251 uint32_t use_locked_device_memory:1; 1252 1253 /** 1254 * Use DPDK memory as backing storage. 1255 * 1256 * - When set, PMD will attempt place descriptors and/or data buffers 1257 * in host memory managed by DPDK. 1258 * - When cleared, PMD will use default memory type as a backing storage. 1259 * Please refer to PMD documentation for details. 1260 * 1261 * API user should check if PMD supports this configuration flag using 1262 * @see rte_eth_dev_hairpin_capability_get. 1263 */ 1264 uint32_t use_rte_memory:1; 1265 1266 /** 1267 * Force usage of hairpin memory configuration. 1268 * 1269 * - When set, PMD will attempt to use specified memory settings. 1270 * If resource allocation fails, then hairpin queue allocation 1271 * will result in an error. 1272 * - When clear, PMD will attempt to use specified memory settings. 1273 * If resource allocation fails, then PMD will retry 1274 * allocation with default configuration. 1275 */ 1276 uint32_t force_memory:1; 1277 1278 uint32_t reserved:11; /**< Reserved bits. */ 1279 1280 struct rte_eth_hairpin_peer peers[RTE_ETH_MAX_HAIRPIN_PEERS]; 1281 }; 1282 1283 /** 1284 * A structure contains information about HW descriptor ring limitations. 1285 */ 1286 struct rte_eth_desc_lim { 1287 uint16_t nb_max; /**< Max allowed number of descriptors. */ 1288 uint16_t nb_min; /**< Min allowed number of descriptors. */ 1289 uint16_t nb_align; /**< Number of descriptors should be aligned to. */ 1290 1291 /** 1292 * Max allowed number of segments per whole packet. 1293 * 1294 * - For TSO packet this is the total number of data descriptors allowed 1295 * by device. 1296 * 1297 * @see nb_mtu_seg_max 1298 */ 1299 uint16_t nb_seg_max; 1300 1301 /** 1302 * Max number of segments per one MTU. 1303 * 1304 * - For non-TSO packet, this is the maximum allowed number of segments 1305 * in a single transmit packet. 1306 * 1307 * - For TSO packet each segment within the TSO may span up to this 1308 * value. 1309 * 1310 * @see nb_seg_max 1311 */ 1312 uint16_t nb_mtu_seg_max; 1313 }; 1314 1315 /** 1316 * This enum indicates the flow control mode 1317 */ 1318 enum rte_eth_fc_mode { 1319 RTE_ETH_FC_NONE = 0, /**< Disable flow control. */ 1320 RTE_ETH_FC_RX_PAUSE, /**< Rx pause frame, enable flowctrl on Tx side. */ 1321 RTE_ETH_FC_TX_PAUSE, /**< Tx pause frame, enable flowctrl on Rx side. */ 1322 RTE_ETH_FC_FULL /**< Enable flow control on both side. */ 1323 }; 1324 1325 /** 1326 * A structure used to configure Ethernet flow control parameter. 1327 * These parameters will be configured into the register of the NIC. 1328 * Please refer to the corresponding data sheet for proper value. 1329 */ 1330 struct rte_eth_fc_conf { 1331 uint32_t high_water; /**< High threshold value to trigger XOFF */ 1332 uint32_t low_water; /**< Low threshold value to trigger XON */ 1333 uint16_t pause_time; /**< Pause quota in the Pause frame */ 1334 uint16_t send_xon; /**< Is XON frame need be sent */ 1335 enum rte_eth_fc_mode mode; /**< Link flow control mode */ 1336 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */ 1337 uint8_t autoneg; /**< Use Pause autoneg */ 1338 }; 1339 1340 /** 1341 * A structure used to configure Ethernet priority flow control parameter. 1342 * These parameters will be configured into the register of the NIC. 1343 * Please refer to the corresponding data sheet for proper value. 1344 */ 1345 struct rte_eth_pfc_conf { 1346 struct rte_eth_fc_conf fc; /**< General flow control parameter. */ 1347 uint8_t priority; /**< VLAN User Priority. */ 1348 }; 1349 1350 /** 1351 * @warning 1352 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1353 * 1354 * A structure used to retrieve information of queue based PFC. 1355 */ 1356 struct rte_eth_pfc_queue_info { 1357 /** 1358 * Maximum supported traffic class as per PFC (802.1Qbb) specification. 1359 */ 1360 uint8_t tc_max; 1361 /** PFC queue mode capabilities. */ 1362 enum rte_eth_fc_mode mode_capa; 1363 }; 1364 1365 /** 1366 * @warning 1367 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1368 * 1369 * A structure used to configure Ethernet priority flow control parameters for 1370 * ethdev queues. 1371 * 1372 * rte_eth_pfc_queue_conf::rx_pause structure shall be used to configure given 1373 * tx_qid with corresponding tc. When ethdev device receives PFC frame with 1374 * rte_eth_pfc_queue_conf::rx_pause::tc, traffic will be paused on 1375 * rte_eth_pfc_queue_conf::rx_pause::tx_qid for that tc. 1376 * 1377 * rte_eth_pfc_queue_conf::tx_pause structure shall be used to configure given 1378 * rx_qid. When rx_qid is congested, PFC frames are generated with 1379 * rte_eth_pfc_queue_conf::rx_pause::tc and 1380 * rte_eth_pfc_queue_conf::rx_pause::pause_time to the peer. 1381 */ 1382 struct rte_eth_pfc_queue_conf { 1383 enum rte_eth_fc_mode mode; /**< Link flow control mode */ 1384 1385 struct { 1386 uint16_t tx_qid; /**< Tx queue ID */ 1387 /** Traffic class as per PFC (802.1Qbb) spec. The value must be 1388 * in the range [0, rte_eth_pfc_queue_info::tx_max - 1] 1389 */ 1390 uint8_t tc; 1391 } rx_pause; /* Valid when (mode == FC_RX_PAUSE || mode == FC_FULL) */ 1392 1393 struct { 1394 uint16_t pause_time; /**< Pause quota in the Pause frame */ 1395 uint16_t rx_qid; /**< Rx queue ID */ 1396 /** Traffic class as per PFC (802.1Qbb) spec. The value must be 1397 * in the range [0, rte_eth_pfc_queue_info::tx_max - 1] 1398 */ 1399 uint8_t tc; 1400 } tx_pause; /* Valid when (mode == FC_TX_PAUSE || mode == FC_FULL) */ 1401 }; 1402 1403 /** 1404 * Tunnel type for device-specific classifier configuration. 1405 * @see rte_eth_udp_tunnel 1406 */ 1407 enum rte_eth_tunnel_type { 1408 RTE_ETH_TUNNEL_TYPE_NONE = 0, 1409 RTE_ETH_TUNNEL_TYPE_VXLAN, 1410 RTE_ETH_TUNNEL_TYPE_GENEVE, 1411 RTE_ETH_TUNNEL_TYPE_TEREDO, 1412 RTE_ETH_TUNNEL_TYPE_NVGRE, 1413 RTE_ETH_TUNNEL_TYPE_IP_IN_GRE, 1414 RTE_ETH_L2_TUNNEL_TYPE_E_TAG, 1415 RTE_ETH_TUNNEL_TYPE_VXLAN_GPE, 1416 RTE_ETH_TUNNEL_TYPE_ECPRI, 1417 RTE_ETH_TUNNEL_TYPE_MAX, 1418 }; 1419 1420 /* Deprecated API file for rte_eth_dev_filter_* functions */ 1421 #include "rte_eth_ctrl.h" 1422 1423 /** 1424 * UDP tunneling configuration. 1425 * 1426 * Used to configure the classifier of a device, 1427 * associating an UDP port with a type of tunnel. 1428 * 1429 * Some NICs may need such configuration to properly parse a tunnel 1430 * with any standard or custom UDP port. 1431 */ 1432 struct rte_eth_udp_tunnel { 1433 uint16_t udp_port; /**< UDP port used for the tunnel. */ 1434 uint8_t prot_type; /**< Tunnel type. @see rte_eth_tunnel_type */ 1435 }; 1436 1437 /** 1438 * A structure used to enable/disable specific device interrupts. 1439 */ 1440 struct rte_eth_intr_conf { 1441 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */ 1442 uint32_t lsc:1; 1443 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */ 1444 uint32_t rxq:1; 1445 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */ 1446 uint32_t rmv:1; 1447 }; 1448 1449 #define rte_intr_conf rte_eth_intr_conf 1450 1451 /** 1452 * A structure used to configure an Ethernet port. 1453 * Depending upon the Rx multi-queue mode, extra advanced 1454 * configuration settings may be needed. 1455 */ 1456 struct rte_eth_conf { 1457 uint32_t link_speeds; /**< bitmap of RTE_ETH_LINK_SPEED_XXX of speeds to be 1458 used. RTE_ETH_LINK_SPEED_FIXED disables link 1459 autonegotiation, and a unique speed shall be 1460 set. Otherwise, the bitmap defines the set of 1461 speeds to be advertised. If the special value 1462 RTE_ETH_LINK_SPEED_AUTONEG (0) is used, all speeds 1463 supported are advertised. */ 1464 struct rte_eth_rxmode rxmode; /**< Port Rx configuration. */ 1465 struct rte_eth_txmode txmode; /**< Port Tx configuration. */ 1466 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value 1467 is 0, meaning the loopback mode is disabled. 1468 Read the datasheet of given Ethernet controller 1469 for details. The possible values of this field 1470 are defined in implementation of each driver. */ 1471 struct { 1472 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */ 1473 /** Port VMDq+DCB configuration. */ 1474 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf; 1475 /** Port DCB Rx configuration. */ 1476 struct rte_eth_dcb_rx_conf dcb_rx_conf; 1477 /** Port VMDq Rx configuration. */ 1478 struct rte_eth_vmdq_rx_conf vmdq_rx_conf; 1479 } rx_adv_conf; /**< Port Rx filtering configuration. */ 1480 union { 1481 /** Port VMDq+DCB Tx configuration. */ 1482 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf; 1483 /** Port DCB Tx configuration. */ 1484 struct rte_eth_dcb_tx_conf dcb_tx_conf; 1485 /** Port VMDq Tx configuration. */ 1486 struct rte_eth_vmdq_tx_conf vmdq_tx_conf; 1487 } tx_adv_conf; /**< Port Tx DCB configuration (union). */ 1488 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC 1489 is needed,and the variable must be set RTE_ETH_DCB_PFC_SUPPORT. */ 1490 uint32_t dcb_capability_en; 1491 struct rte_eth_intr_conf intr_conf; /**< Interrupt mode configuration. */ 1492 }; 1493 1494 /** 1495 * Rx offload capabilities of a device. 1496 */ 1497 #define RTE_ETH_RX_OFFLOAD_VLAN_STRIP RTE_BIT64(0) 1498 #define RTE_ETH_RX_OFFLOAD_IPV4_CKSUM RTE_BIT64(1) 1499 #define RTE_ETH_RX_OFFLOAD_UDP_CKSUM RTE_BIT64(2) 1500 #define RTE_ETH_RX_OFFLOAD_TCP_CKSUM RTE_BIT64(3) 1501 #define RTE_ETH_RX_OFFLOAD_TCP_LRO RTE_BIT64(4) 1502 #define RTE_ETH_RX_OFFLOAD_QINQ_STRIP RTE_BIT64(5) 1503 #define RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM RTE_BIT64(6) 1504 #define RTE_ETH_RX_OFFLOAD_MACSEC_STRIP RTE_BIT64(7) 1505 #define RTE_ETH_RX_OFFLOAD_VLAN_FILTER RTE_BIT64(9) 1506 #define RTE_ETH_RX_OFFLOAD_VLAN_EXTEND RTE_BIT64(10) 1507 #define RTE_ETH_RX_OFFLOAD_SCATTER RTE_BIT64(13) 1508 /** 1509 * Timestamp is set by the driver in RTE_MBUF_DYNFIELD_TIMESTAMP_NAME 1510 * and RTE_MBUF_DYNFLAG_RX_TIMESTAMP_NAME is set in ol_flags. 1511 * The mbuf field and flag are registered when the offload is configured. 1512 */ 1513 #define RTE_ETH_RX_OFFLOAD_TIMESTAMP RTE_BIT64(14) 1514 #define RTE_ETH_RX_OFFLOAD_SECURITY RTE_BIT64(15) 1515 #define RTE_ETH_RX_OFFLOAD_KEEP_CRC RTE_BIT64(16) 1516 #define RTE_ETH_RX_OFFLOAD_SCTP_CKSUM RTE_BIT64(17) 1517 #define RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM RTE_BIT64(18) 1518 #define RTE_ETH_RX_OFFLOAD_RSS_HASH RTE_BIT64(19) 1519 #define RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT RTE_BIT64(20) 1520 1521 #define RTE_ETH_RX_OFFLOAD_CHECKSUM (RTE_ETH_RX_OFFLOAD_IPV4_CKSUM | \ 1522 RTE_ETH_RX_OFFLOAD_UDP_CKSUM | \ 1523 RTE_ETH_RX_OFFLOAD_TCP_CKSUM) 1524 #define RTE_ETH_RX_OFFLOAD_VLAN (RTE_ETH_RX_OFFLOAD_VLAN_STRIP | \ 1525 RTE_ETH_RX_OFFLOAD_VLAN_FILTER | \ 1526 RTE_ETH_RX_OFFLOAD_VLAN_EXTEND | \ 1527 RTE_ETH_RX_OFFLOAD_QINQ_STRIP) 1528 1529 /* 1530 * If new Rx offload capabilities are defined, they also must be 1531 * mentioned in rte_rx_offload_names in rte_ethdev.c file. 1532 */ 1533 1534 /** 1535 * Tx offload capabilities of a device. 1536 */ 1537 #define RTE_ETH_TX_OFFLOAD_VLAN_INSERT RTE_BIT64(0) 1538 #define RTE_ETH_TX_OFFLOAD_IPV4_CKSUM RTE_BIT64(1) 1539 #define RTE_ETH_TX_OFFLOAD_UDP_CKSUM RTE_BIT64(2) 1540 #define RTE_ETH_TX_OFFLOAD_TCP_CKSUM RTE_BIT64(3) 1541 #define RTE_ETH_TX_OFFLOAD_SCTP_CKSUM RTE_BIT64(4) 1542 #define RTE_ETH_TX_OFFLOAD_TCP_TSO RTE_BIT64(5) 1543 #define RTE_ETH_TX_OFFLOAD_UDP_TSO RTE_BIT64(6) 1544 #define RTE_ETH_TX_OFFLOAD_OUTER_IPV4_CKSUM RTE_BIT64(7) /**< Used for tunneling packet. */ 1545 #define RTE_ETH_TX_OFFLOAD_QINQ_INSERT RTE_BIT64(8) 1546 #define RTE_ETH_TX_OFFLOAD_VXLAN_TNL_TSO RTE_BIT64(9) /**< Used for tunneling packet. */ 1547 #define RTE_ETH_TX_OFFLOAD_GRE_TNL_TSO RTE_BIT64(10) /**< Used for tunneling packet. */ 1548 #define RTE_ETH_TX_OFFLOAD_IPIP_TNL_TSO RTE_BIT64(11) /**< Used for tunneling packet. */ 1549 #define RTE_ETH_TX_OFFLOAD_GENEVE_TNL_TSO RTE_BIT64(12) /**< Used for tunneling packet. */ 1550 #define RTE_ETH_TX_OFFLOAD_MACSEC_INSERT RTE_BIT64(13) 1551 /** 1552 * Multiple threads can invoke rte_eth_tx_burst() concurrently on the same 1553 * Tx queue without SW lock. 1554 */ 1555 #define RTE_ETH_TX_OFFLOAD_MT_LOCKFREE RTE_BIT64(14) 1556 /** Device supports multi segment send. */ 1557 #define RTE_ETH_TX_OFFLOAD_MULTI_SEGS RTE_BIT64(15) 1558 /** 1559 * Device supports optimization for fast release of mbufs. 1560 * When set application must guarantee that per-queue all mbufs comes from 1561 * the same mempool and has refcnt = 1. 1562 */ 1563 #define RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE RTE_BIT64(16) 1564 #define RTE_ETH_TX_OFFLOAD_SECURITY RTE_BIT64(17) 1565 /** 1566 * Device supports generic UDP tunneled packet TSO. 1567 * Application must set RTE_MBUF_F_TX_TUNNEL_UDP and other mbuf fields required 1568 * for tunnel TSO. 1569 */ 1570 #define RTE_ETH_TX_OFFLOAD_UDP_TNL_TSO RTE_BIT64(18) 1571 /** 1572 * Device supports generic IP tunneled packet TSO. 1573 * Application must set RTE_MBUF_F_TX_TUNNEL_IP and other mbuf fields required 1574 * for tunnel TSO. 1575 */ 1576 #define RTE_ETH_TX_OFFLOAD_IP_TNL_TSO RTE_BIT64(19) 1577 /** Device supports outer UDP checksum */ 1578 #define RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM RTE_BIT64(20) 1579 /** 1580 * Device sends on time read from RTE_MBUF_DYNFIELD_TIMESTAMP_NAME 1581 * if RTE_MBUF_DYNFLAG_TX_TIMESTAMP_NAME is set in ol_flags. 1582 * The mbuf field and flag are registered when the offload is configured. 1583 */ 1584 #define RTE_ETH_TX_OFFLOAD_SEND_ON_TIMESTAMP RTE_BIT64(21) 1585 /* 1586 * If new Tx offload capabilities are defined, they also must be 1587 * mentioned in rte_tx_offload_names in rte_ethdev.c file. 1588 */ 1589 1590 /**@{@name Device capabilities 1591 * Non-offload capabilities reported in rte_eth_dev_info.dev_capa. 1592 */ 1593 /** Device supports Rx queue setup after device started. */ 1594 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP RTE_BIT64(0) 1595 /** Device supports Tx queue setup after device started. */ 1596 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP RTE_BIT64(1) 1597 /** 1598 * Device supports shared Rx queue among ports within Rx domain and 1599 * switch domain. Mbufs are consumed by shared Rx queue instead of 1600 * each queue. Multiple groups are supported by share_group of Rx 1601 * queue configuration. Shared Rx queue is identified by PMD using 1602 * share_qid of Rx queue configuration. Polling any port in the group 1603 * receive packets of all member ports, source port identified by 1604 * mbuf->port field. 1605 */ 1606 #define RTE_ETH_DEV_CAPA_RXQ_SHARE RTE_BIT64(2) 1607 /** Device supports keeping flow rules across restart. */ 1608 #define RTE_ETH_DEV_CAPA_FLOW_RULE_KEEP RTE_BIT64(3) 1609 /** Device supports keeping shared flow objects across restart. */ 1610 #define RTE_ETH_DEV_CAPA_FLOW_SHARED_OBJECT_KEEP RTE_BIT64(4) 1611 /**@}*/ 1612 1613 /* 1614 * Fallback default preferred Rx/Tx port parameters. 1615 * These are used if an application requests default parameters 1616 * but the PMD does not provide preferred values. 1617 */ 1618 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512 1619 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512 1620 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1 1621 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1 1622 1623 /** 1624 * Preferred Rx/Tx port parameters. 1625 * There are separate instances of this structure for transmission 1626 * and reception respectively. 1627 */ 1628 struct rte_eth_dev_portconf { 1629 uint16_t burst_size; /**< Device-preferred burst size */ 1630 uint16_t ring_size; /**< Device-preferred size of queue rings */ 1631 uint16_t nb_queues; /**< Device-preferred number of queues */ 1632 }; 1633 1634 /** 1635 * Default values for switch domain ID when ethdev does not support switch 1636 * domain definitions. 1637 */ 1638 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (UINT16_MAX) 1639 1640 /** 1641 * Ethernet device associated switch information 1642 */ 1643 struct rte_eth_switch_info { 1644 const char *name; /**< switch name */ 1645 uint16_t domain_id; /**< switch domain ID */ 1646 /** 1647 * Mapping to the devices physical switch port as enumerated from the 1648 * perspective of the embedded interconnect/switch. For SR-IOV enabled 1649 * device this may correspond to the VF_ID of each virtual function, 1650 * but each driver should explicitly define the mapping of switch 1651 * port identifier to that physical interconnect/switch 1652 */ 1653 uint16_t port_id; 1654 /** 1655 * Shared Rx queue sub-domain boundary. Only ports in same Rx domain 1656 * and switch domain can share Rx queue. Valid only if device advertised 1657 * RTE_ETH_DEV_CAPA_RXQ_SHARE capability. 1658 */ 1659 uint16_t rx_domain; 1660 }; 1661 1662 /** 1663 * @warning 1664 * @b EXPERIMENTAL: this structure may change without prior notice. 1665 * 1666 * Ethernet device Rx buffer segmentation capabilities. 1667 */ 1668 struct rte_eth_rxseg_capa { 1669 __extension__ 1670 uint32_t multi_pools:1; /**< Supports receiving to multiple pools.*/ 1671 uint32_t offset_allowed:1; /**< Supports buffer offsets. */ 1672 uint32_t offset_align_log2:4; /**< Required offset alignment. */ 1673 uint16_t max_nseg; /**< Maximum amount of segments to split. */ 1674 uint16_t reserved; /**< Reserved field. */ 1675 }; 1676 1677 /** 1678 * Ethernet device information 1679 */ 1680 1681 /** 1682 * Ethernet device representor port type. 1683 */ 1684 enum rte_eth_representor_type { 1685 RTE_ETH_REPRESENTOR_NONE, /**< not a representor. */ 1686 RTE_ETH_REPRESENTOR_VF, /**< representor of Virtual Function. */ 1687 RTE_ETH_REPRESENTOR_SF, /**< representor of Sub Function. */ 1688 RTE_ETH_REPRESENTOR_PF, /**< representor of Physical Function. */ 1689 }; 1690 1691 /** 1692 * @warning 1693 * @b EXPERIMENTAL: this enumeration may change without prior notice. 1694 * 1695 * Ethernet device error handling mode. 1696 */ 1697 enum rte_eth_err_handle_mode { 1698 /** No error handling modes are supported. */ 1699 RTE_ETH_ERROR_HANDLE_MODE_NONE, 1700 /** Passive error handling, after the PMD detects that a reset is required, 1701 * the PMD reports @see RTE_ETH_EVENT_INTR_RESET event, 1702 * and the application invokes @see rte_eth_dev_reset to recover the port. 1703 */ 1704 RTE_ETH_ERROR_HANDLE_MODE_PASSIVE, 1705 /** Proactive error handling, after the PMD detects that a reset is required, 1706 * the PMD reports @see RTE_ETH_EVENT_ERR_RECOVERING event, 1707 * do recovery internally, and finally reports the recovery result event 1708 * (@see RTE_ETH_EVENT_RECOVERY_*). 1709 */ 1710 RTE_ETH_ERROR_HANDLE_MODE_PROACTIVE, 1711 }; 1712 1713 /** 1714 * A structure used to retrieve the contextual information of 1715 * an Ethernet device, such as the controlling driver of the 1716 * device, etc... 1717 */ 1718 struct rte_eth_dev_info { 1719 struct rte_device *device; /**< Generic device information */ 1720 const char *driver_name; /**< Device Driver name. */ 1721 unsigned int if_index; /**< Index to bound host interface, or 0 if none. 1722 Use if_indextoname() to translate into an interface name. */ 1723 uint16_t min_mtu; /**< Minimum MTU allowed */ 1724 uint16_t max_mtu; /**< Maximum MTU allowed */ 1725 const uint32_t *dev_flags; /**< Device flags */ 1726 uint32_t min_rx_bufsize; /**< Minimum size of Rx buffer. */ 1727 uint32_t max_rx_pktlen; /**< Maximum configurable length of Rx pkt. */ 1728 /** Maximum configurable size of LRO aggregated packet. */ 1729 uint32_t max_lro_pkt_size; 1730 uint16_t max_rx_queues; /**< Maximum number of Rx queues. */ 1731 uint16_t max_tx_queues; /**< Maximum number of Tx queues. */ 1732 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */ 1733 /** Maximum number of hash MAC addresses for MTA and UTA. */ 1734 uint32_t max_hash_mac_addrs; 1735 uint16_t max_vfs; /**< Maximum number of VFs. */ 1736 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */ 1737 struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/ 1738 /** All Rx offload capabilities including all per-queue ones */ 1739 uint64_t rx_offload_capa; 1740 /** All Tx offload capabilities including all per-queue ones */ 1741 uint64_t tx_offload_capa; 1742 /** Device per-queue Rx offload capabilities. */ 1743 uint64_t rx_queue_offload_capa; 1744 /** Device per-queue Tx offload capabilities. */ 1745 uint64_t tx_queue_offload_capa; 1746 /** Device redirection table size, the total number of entries. */ 1747 uint16_t reta_size; 1748 uint8_t hash_key_size; /**< Hash key size in bytes */ 1749 /** Bit mask of RSS offloads, the bit offset also means flow type */ 1750 uint64_t flow_type_rss_offloads; 1751 struct rte_eth_rxconf default_rxconf; /**< Default Rx configuration */ 1752 struct rte_eth_txconf default_txconf; /**< Default Tx configuration */ 1753 uint16_t vmdq_queue_base; /**< First queue ID for VMDq pools. */ 1754 uint16_t vmdq_queue_num; /**< Queue number for VMDq pools. */ 1755 uint16_t vmdq_pool_base; /**< First ID of VMDq pools. */ 1756 struct rte_eth_desc_lim rx_desc_lim; /**< Rx descriptors limits */ 1757 struct rte_eth_desc_lim tx_desc_lim; /**< Tx descriptors limits */ 1758 uint32_t speed_capa; /**< Supported speeds bitmap (RTE_ETH_LINK_SPEED_). */ 1759 /** Configured number of Rx/Tx queues */ 1760 uint16_t nb_rx_queues; /**< Number of Rx queues. */ 1761 uint16_t nb_tx_queues; /**< Number of Tx queues. */ 1762 /** 1763 * Maximum number of Rx mempools supported per Rx queue. 1764 * 1765 * Value greater than 0 means that the driver supports Rx queue 1766 * mempools specification via rx_conf->rx_mempools. 1767 */ 1768 uint16_t max_rx_mempools; 1769 /** Rx parameter recommendations */ 1770 struct rte_eth_dev_portconf default_rxportconf; 1771 /** Tx parameter recommendations */ 1772 struct rte_eth_dev_portconf default_txportconf; 1773 /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */ 1774 uint64_t dev_capa; 1775 /** 1776 * Switching information for ports on a device with a 1777 * embedded managed interconnect/switch. 1778 */ 1779 struct rte_eth_switch_info switch_info; 1780 /** Supported error handling mode. */ 1781 enum rte_eth_err_handle_mode err_handle_mode; 1782 1783 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 1784 void *reserved_ptrs[2]; /**< Reserved for future fields */ 1785 }; 1786 1787 /**@{@name Rx/Tx queue states */ 1788 #define RTE_ETH_QUEUE_STATE_STOPPED 0 /**< Queue stopped. */ 1789 #define RTE_ETH_QUEUE_STATE_STARTED 1 /**< Queue started. */ 1790 #define RTE_ETH_QUEUE_STATE_HAIRPIN 2 /**< Queue used for hairpin. */ 1791 /**@}*/ 1792 1793 /** 1794 * Ethernet device Rx queue information structure. 1795 * Used to retrieve information about configured queue. 1796 */ 1797 struct rte_eth_rxq_info { 1798 struct rte_mempool *mp; /**< mempool used by that queue. */ 1799 struct rte_eth_rxconf conf; /**< queue config parameters. */ 1800 uint8_t scattered_rx; /**< scattered packets Rx supported. */ 1801 uint8_t queue_state; /**< one of RTE_ETH_QUEUE_STATE_*. */ 1802 uint16_t nb_desc; /**< configured number of RXDs. */ 1803 uint16_t rx_buf_size; /**< hardware receive buffer size. */ 1804 /** 1805 * Available Rx descriptors threshold defined as percentage 1806 * of Rx queue size. If number of available descriptors is lower, 1807 * the event RTE_ETH_EVENT_RX_AVAIL_THESH is generated. 1808 * Value 0 means that the threshold monitoring is disabled. 1809 */ 1810 uint8_t avail_thresh; 1811 } __rte_cache_min_aligned; 1812 1813 /** 1814 * Ethernet device Tx queue information structure. 1815 * Used to retrieve information about configured queue. 1816 */ 1817 struct rte_eth_txq_info { 1818 struct rte_eth_txconf conf; /**< queue config parameters. */ 1819 uint16_t nb_desc; /**< configured number of TXDs. */ 1820 uint8_t queue_state; /**< one of RTE_ETH_QUEUE_STATE_*. */ 1821 } __rte_cache_min_aligned; 1822 1823 /* Generic Burst mode flag definition, values can be ORed. */ 1824 1825 /** 1826 * If the queues have different burst mode description, this bit will be set 1827 * by PMD, then the application can iterate to retrieve burst description for 1828 * all other queues. 1829 */ 1830 #define RTE_ETH_BURST_FLAG_PER_QUEUE RTE_BIT64(0) 1831 1832 /** 1833 * Ethernet device Rx/Tx queue packet burst mode information structure. 1834 * Used to retrieve information about packet burst mode setting. 1835 */ 1836 struct rte_eth_burst_mode { 1837 uint64_t flags; /**< The ORed values of RTE_ETH_BURST_FLAG_xxx */ 1838 1839 #define RTE_ETH_BURST_MODE_INFO_SIZE 1024 /**< Maximum size for information */ 1840 char info[RTE_ETH_BURST_MODE_INFO_SIZE]; /**< burst mode information */ 1841 }; 1842 1843 /** Maximum name length for extended statistics counters */ 1844 #define RTE_ETH_XSTATS_NAME_SIZE 64 1845 1846 /** 1847 * An Ethernet device extended statistic structure 1848 * 1849 * This structure is used by rte_eth_xstats_get() to provide 1850 * statistics that are not provided in the generic *rte_eth_stats* 1851 * structure. 1852 * It maps a name ID, corresponding to an index in the array returned 1853 * by rte_eth_xstats_get_names(), to a statistic value. 1854 */ 1855 struct rte_eth_xstat { 1856 uint64_t id; /**< The index in xstats name array. */ 1857 uint64_t value; /**< The statistic counter value. */ 1858 }; 1859 1860 /** 1861 * A name element for extended statistics. 1862 * 1863 * An array of this structure is returned by rte_eth_xstats_get_names(). 1864 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat* 1865 * structure references these names by their array index. 1866 * 1867 * The xstats should follow a common naming scheme. 1868 * Some names are standardized in rte_stats_strings. 1869 * Examples: 1870 * - rx_missed_errors 1871 * - tx_q3_bytes 1872 * - tx_size_128_to_255_packets 1873 */ 1874 struct rte_eth_xstat_name { 1875 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */ 1876 }; 1877 1878 #define RTE_ETH_DCB_NUM_TCS 8 1879 #define RTE_ETH_MAX_VMDQ_POOL 64 1880 1881 /** 1882 * A structure used to get the information of queue and 1883 * TC mapping on both Tx and Rx paths. 1884 */ 1885 struct rte_eth_dcb_tc_queue_mapping { 1886 /** Rx queues assigned to tc per Pool */ 1887 struct { 1888 uint16_t base; 1889 uint16_t nb_queue; 1890 } tc_rxq[RTE_ETH_MAX_VMDQ_POOL][RTE_ETH_DCB_NUM_TCS]; 1891 /** Rx queues assigned to tc per Pool */ 1892 struct { 1893 uint16_t base; 1894 uint16_t nb_queue; 1895 } tc_txq[RTE_ETH_MAX_VMDQ_POOL][RTE_ETH_DCB_NUM_TCS]; 1896 }; 1897 1898 /** 1899 * A structure used to get the information of DCB. 1900 * It includes TC UP mapping and queue TC mapping. 1901 */ 1902 struct rte_eth_dcb_info { 1903 uint8_t nb_tcs; /**< number of TCs */ 1904 uint8_t prio_tc[RTE_ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */ 1905 uint8_t tc_bws[RTE_ETH_DCB_NUM_TCS]; /**< Tx BW percentage for each TC */ 1906 /** Rx queues assigned to tc */ 1907 struct rte_eth_dcb_tc_queue_mapping tc_queue; 1908 }; 1909 1910 /** 1911 * This enum indicates the possible Forward Error Correction (FEC) modes 1912 * of an ethdev port. 1913 */ 1914 enum rte_eth_fec_mode { 1915 RTE_ETH_FEC_NOFEC = 0, /**< FEC is off */ 1916 RTE_ETH_FEC_AUTO, /**< FEC autonegotiation modes */ 1917 RTE_ETH_FEC_BASER, /**< FEC using common algorithm */ 1918 RTE_ETH_FEC_RS, /**< FEC using RS algorithm */ 1919 RTE_ETH_FEC_LLRS, /**< FEC using LLRS algorithm */ 1920 }; 1921 1922 /* Translate from FEC mode to FEC capa */ 1923 #define RTE_ETH_FEC_MODE_TO_CAPA(x) RTE_BIT32(x) 1924 1925 /* This macro indicates FEC capa mask */ 1926 #define RTE_ETH_FEC_MODE_CAPA_MASK(x) RTE_BIT32(RTE_ETH_FEC_ ## x) 1927 1928 /* A structure used to get capabilities per link speed */ 1929 struct rte_eth_fec_capa { 1930 uint32_t speed; /**< Link speed (see RTE_ETH_SPEED_NUM_*) */ 1931 uint32_t capa; /**< FEC capabilities bitmask */ 1932 }; 1933 1934 #define RTE_ETH_ALL RTE_MAX_ETHPORTS 1935 1936 /* Macros to check for valid port */ 1937 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \ 1938 if (!rte_eth_dev_is_valid_port(port_id)) { \ 1939 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \ 1940 return retval; \ 1941 } \ 1942 } while (0) 1943 1944 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \ 1945 if (!rte_eth_dev_is_valid_port(port_id)) { \ 1946 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \ 1947 return; \ 1948 } \ 1949 } while (0) 1950 1951 /** 1952 * Function type used for Rx packet processing packet callbacks. 1953 * 1954 * The callback function is called on Rx with a burst of packets that have 1955 * been received on the given port and queue. 1956 * 1957 * @param port_id 1958 * The Ethernet port on which Rx is being performed. 1959 * @param queue 1960 * The queue on the Ethernet port which is being used to receive the packets. 1961 * @param pkts 1962 * The burst of packets that have just been received. 1963 * @param nb_pkts 1964 * The number of packets in the burst pointed to by "pkts". 1965 * @param max_pkts 1966 * The max number of packets that can be stored in the "pkts" array. 1967 * @param user_param 1968 * The arbitrary user parameter passed in by the application when the callback 1969 * was originally configured. 1970 * @return 1971 * The number of packets returned to the user. 1972 */ 1973 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue, 1974 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts, 1975 void *user_param); 1976 1977 /** 1978 * Function type used for Tx packet processing packet callbacks. 1979 * 1980 * The callback function is called on Tx with a burst of packets immediately 1981 * before the packets are put onto the hardware queue for transmission. 1982 * 1983 * @param port_id 1984 * The Ethernet port on which Tx is being performed. 1985 * @param queue 1986 * The queue on the Ethernet port which is being used to transmit the packets. 1987 * @param pkts 1988 * The burst of packets that are about to be transmitted. 1989 * @param nb_pkts 1990 * The number of packets in the burst pointed to by "pkts". 1991 * @param user_param 1992 * The arbitrary user parameter passed in by the application when the callback 1993 * was originally configured. 1994 * @return 1995 * The number of packets to be written to the NIC. 1996 */ 1997 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue, 1998 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param); 1999 2000 /** 2001 * Possible states of an ethdev port. 2002 */ 2003 enum rte_eth_dev_state { 2004 /** Device is unused before being probed. */ 2005 RTE_ETH_DEV_UNUSED = 0, 2006 /** Device is attached when allocated in probing. */ 2007 RTE_ETH_DEV_ATTACHED, 2008 /** Device is in removed state when plug-out is detected. */ 2009 RTE_ETH_DEV_REMOVED, 2010 }; 2011 2012 struct rte_eth_dev_sriov { 2013 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */ 2014 uint8_t nb_q_per_pool; /**< Rx queue number per pool */ 2015 uint16_t def_vmdq_idx; /**< Default pool num used for PF */ 2016 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */ 2017 }; 2018 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov) 2019 2020 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN 2021 2022 #define RTE_ETH_DEV_NO_OWNER 0 2023 2024 #define RTE_ETH_MAX_OWNER_NAME_LEN 64 2025 2026 struct rte_eth_dev_owner { 2027 uint64_t id; /**< The owner unique identifier. */ 2028 char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */ 2029 }; 2030 2031 /**@{@name Device flags 2032 * Flags internally saved in rte_eth_dev_data.dev_flags 2033 * and reported in rte_eth_dev_info.dev_flags. 2034 */ 2035 /** PMD supports thread-safe flow operations */ 2036 #define RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE RTE_BIT32(0) 2037 /** Device supports link state interrupt */ 2038 #define RTE_ETH_DEV_INTR_LSC RTE_BIT32(1) 2039 /** Device is a bonding member */ 2040 #define RTE_ETH_DEV_BONDING_MEMBER RTE_BIT32(2) 2041 #define RTE_ETH_DEV_BONDED_SLAVE RTE_DEPRECATED(RTE_ETH_DEV_BONDED_SLAVE) RTE_ETH_DEV_BONDING_MEMBER 2042 /** Device supports device removal interrupt */ 2043 #define RTE_ETH_DEV_INTR_RMV RTE_BIT32(3) 2044 /** Device is port representor */ 2045 #define RTE_ETH_DEV_REPRESENTOR RTE_BIT32(4) 2046 /** Device does not support MAC change after started */ 2047 #define RTE_ETH_DEV_NOLIVE_MAC_ADDR RTE_BIT32(5) 2048 /** 2049 * Queue xstats filled automatically by ethdev layer. 2050 * PMDs filling the queue xstats themselves should not set this flag 2051 */ 2052 #define RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS RTE_BIT32(6) 2053 /**@}*/ 2054 2055 /** 2056 * Iterates over valid ethdev ports owned by a specific owner. 2057 * 2058 * @param port_id 2059 * The ID of the next possible valid owned port. 2060 * @param owner_id 2061 * The owner identifier. 2062 * RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports. 2063 * @return 2064 * Next valid port ID owned by owner_id, RTE_MAX_ETHPORTS if there is none. 2065 */ 2066 uint64_t rte_eth_find_next_owned_by(uint16_t port_id, 2067 const uint64_t owner_id); 2068 2069 /** 2070 * Macro to iterate over all enabled ethdev ports owned by a specific owner. 2071 */ 2072 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \ 2073 for (p = rte_eth_find_next_owned_by(0, o); \ 2074 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \ 2075 p = rte_eth_find_next_owned_by(p + 1, o)) 2076 2077 /** 2078 * Iterates over valid ethdev ports. 2079 * 2080 * @param port_id 2081 * The ID of the next possible valid port. 2082 * @return 2083 * Next valid port ID, RTE_MAX_ETHPORTS if there is none. 2084 */ 2085 uint16_t rte_eth_find_next(uint16_t port_id); 2086 2087 /** 2088 * Macro to iterate over all enabled and ownerless ethdev ports. 2089 */ 2090 #define RTE_ETH_FOREACH_DEV(p) \ 2091 RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER) 2092 2093 /** 2094 * Iterates over ethdev ports of a specified device. 2095 * 2096 * @param port_id_start 2097 * The ID of the next possible valid port. 2098 * @param parent 2099 * The generic device behind the ports to iterate. 2100 * @return 2101 * Next port ID of the device, possibly port_id_start, 2102 * RTE_MAX_ETHPORTS if there is none. 2103 */ 2104 uint16_t 2105 rte_eth_find_next_of(uint16_t port_id_start, 2106 const struct rte_device *parent); 2107 2108 /** 2109 * Macro to iterate over all ethdev ports of a specified device. 2110 * 2111 * @param port_id 2112 * The ID of the matching port being iterated. 2113 * @param parent 2114 * The rte_device pointer matching the iterated ports. 2115 */ 2116 #define RTE_ETH_FOREACH_DEV_OF(port_id, parent) \ 2117 for (port_id = rte_eth_find_next_of(0, parent); \ 2118 port_id < RTE_MAX_ETHPORTS; \ 2119 port_id = rte_eth_find_next_of(port_id + 1, parent)) 2120 2121 /** 2122 * Iterates over sibling ethdev ports (i.e. sharing the same rte_device). 2123 * 2124 * @param port_id_start 2125 * The ID of the next possible valid sibling port. 2126 * @param ref_port_id 2127 * The ID of a reference port to compare rte_device with. 2128 * @return 2129 * Next sibling port ID, possibly port_id_start or ref_port_id itself, 2130 * RTE_MAX_ETHPORTS if there is none. 2131 */ 2132 uint16_t 2133 rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id); 2134 2135 /** 2136 * Macro to iterate over all ethdev ports sharing the same rte_device 2137 * as the specified port. 2138 * Note: the specified reference port is part of the loop iterations. 2139 * 2140 * @param port_id 2141 * The ID of the matching port being iterated. 2142 * @param ref_port_id 2143 * The ID of the port being compared. 2144 */ 2145 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \ 2146 for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \ 2147 port_id < RTE_MAX_ETHPORTS; \ 2148 port_id = rte_eth_find_next_sibling(port_id + 1, ref_port_id)) 2149 2150 /** 2151 * Get a new unique owner identifier. 2152 * An owner identifier is used to owns Ethernet devices by only one DPDK entity 2153 * to avoid multiple management of device by different entities. 2154 * 2155 * @param owner_id 2156 * Owner identifier pointer. 2157 * @return 2158 * Negative errno value on error, 0 on success. 2159 */ 2160 int rte_eth_dev_owner_new(uint64_t *owner_id); 2161 2162 /** 2163 * Set an Ethernet device owner. 2164 * 2165 * @param port_id 2166 * The identifier of the port to own. 2167 * @param owner 2168 * The owner pointer. 2169 * @return 2170 * Negative errno value on error, 0 on success. 2171 */ 2172 int rte_eth_dev_owner_set(const uint16_t port_id, 2173 const struct rte_eth_dev_owner *owner); 2174 2175 /** 2176 * Unset Ethernet device owner to make the device ownerless. 2177 * 2178 * @param port_id 2179 * The identifier of port to make ownerless. 2180 * @param owner_id 2181 * The owner identifier. 2182 * @return 2183 * 0 on success, negative errno value on error. 2184 */ 2185 int rte_eth_dev_owner_unset(const uint16_t port_id, 2186 const uint64_t owner_id); 2187 2188 /** 2189 * Remove owner from all Ethernet devices owned by a specific owner. 2190 * 2191 * @param owner_id 2192 * The owner identifier. 2193 * @return 2194 * 0 on success, negative errno value on error. 2195 */ 2196 int rte_eth_dev_owner_delete(const uint64_t owner_id); 2197 2198 /** 2199 * Get the owner of an Ethernet device. 2200 * 2201 * @param port_id 2202 * The port identifier. 2203 * @param owner 2204 * The owner structure pointer to fill. 2205 * @return 2206 * 0 on success, negative errno value on error.. 2207 */ 2208 int rte_eth_dev_owner_get(const uint16_t port_id, 2209 struct rte_eth_dev_owner *owner); 2210 2211 /** 2212 * Get the number of ports which are usable for the application. 2213 * 2214 * These devices must be iterated by using the macro 2215 * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY`` 2216 * to deal with non-contiguous ranges of devices. 2217 * 2218 * @return 2219 * The count of available Ethernet devices. 2220 */ 2221 uint16_t rte_eth_dev_count_avail(void); 2222 2223 /** 2224 * Get the total number of ports which are allocated. 2225 * 2226 * Some devices may not be available for the application. 2227 * 2228 * @return 2229 * The total count of Ethernet devices. 2230 */ 2231 uint16_t rte_eth_dev_count_total(void); 2232 2233 /** 2234 * Convert a numerical speed in Mbps to a bitmap flag that can be used in 2235 * the bitmap link_speeds of the struct rte_eth_conf 2236 * 2237 * @param speed 2238 * Numerical speed value in Mbps 2239 * @param duplex 2240 * RTE_ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds) 2241 * @return 2242 * 0 if the speed cannot be mapped 2243 */ 2244 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex); 2245 2246 /** 2247 * Get RTE_ETH_RX_OFFLOAD_* flag name. 2248 * 2249 * @param offload 2250 * Offload flag. 2251 * @return 2252 * Offload name or 'UNKNOWN' if the flag cannot be recognised. 2253 */ 2254 const char *rte_eth_dev_rx_offload_name(uint64_t offload); 2255 2256 /** 2257 * Get RTE_ETH_TX_OFFLOAD_* flag name. 2258 * 2259 * @param offload 2260 * Offload flag. 2261 * @return 2262 * Offload name or 'UNKNOWN' if the flag cannot be recognised. 2263 */ 2264 const char *rte_eth_dev_tx_offload_name(uint64_t offload); 2265 2266 /** 2267 * @warning 2268 * @b EXPERIMENTAL: this API may change without prior notice. 2269 * 2270 * Get RTE_ETH_DEV_CAPA_* flag name. 2271 * 2272 * @param capability 2273 * Capability flag. 2274 * @return 2275 * Capability name or 'UNKNOWN' if the flag cannot be recognized. 2276 */ 2277 __rte_experimental 2278 const char *rte_eth_dev_capability_name(uint64_t capability); 2279 2280 /** 2281 * Configure an Ethernet device. 2282 * This function must be invoked first before any other function in the 2283 * Ethernet API. This function can also be re-invoked when a device is in the 2284 * stopped state. 2285 * 2286 * @param port_id 2287 * The port identifier of the Ethernet device to configure. 2288 * @param nb_rx_queue 2289 * The number of receive queues to set up for the Ethernet device. 2290 * @param nb_tx_queue 2291 * The number of transmit queues to set up for the Ethernet device. 2292 * @param eth_conf 2293 * The pointer to the configuration data to be used for the Ethernet device. 2294 * The *rte_eth_conf* structure includes: 2295 * - the hardware offload features to activate, with dedicated fields for 2296 * each statically configurable offload hardware feature provided by 2297 * Ethernet devices, such as IP checksum or VLAN tag stripping for 2298 * example. 2299 * The Rx offload bitfield API is obsolete and will be deprecated. 2300 * Applications should set the ignore_bitfield_offloads bit on *rxmode* 2301 * structure and use offloads field to set per-port offloads instead. 2302 * - Any offloading set in eth_conf->[rt]xmode.offloads must be within 2303 * the [rt]x_offload_capa returned from rte_eth_dev_info_get(). 2304 * Any type of device supported offloading set in the input argument 2305 * eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled 2306 * on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup() 2307 * - the Receive Side Scaling (RSS) configuration when using multiple Rx 2308 * queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf 2309 * must be within the flow_type_rss_offloads provided by drivers via 2310 * rte_eth_dev_info_get() API. 2311 * 2312 * Embedding all configuration information in a single data structure 2313 * is the more flexible method that allows the addition of new features 2314 * without changing the syntax of the API. 2315 * @return 2316 * - 0: Success, device configured. 2317 * - <0: Error code returned by the driver configuration function. 2318 */ 2319 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue, 2320 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf); 2321 2322 /** 2323 * Check if an Ethernet device was physically removed. 2324 * 2325 * @param port_id 2326 * The port identifier of the Ethernet device. 2327 * @return 2328 * 1 when the Ethernet device is removed, otherwise 0. 2329 */ 2330 int 2331 rte_eth_dev_is_removed(uint16_t port_id); 2332 2333 /** 2334 * Allocate and set up a receive queue for an Ethernet device. 2335 * 2336 * The function allocates a contiguous block of memory for *nb_rx_desc* 2337 * receive descriptors from a memory zone associated with *socket_id* 2338 * and initializes each receive descriptor with a network buffer allocated 2339 * from the memory pool *mb_pool*. 2340 * 2341 * @param port_id 2342 * The port identifier of the Ethernet device. 2343 * @param rx_queue_id 2344 * The index of the receive queue to set up. 2345 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2346 * to rte_eth_dev_configure(). 2347 * @param nb_rx_desc 2348 * The number of receive descriptors to allocate for the receive ring. 2349 * @param socket_id 2350 * The *socket_id* argument is the socket identifier in case of NUMA. 2351 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for 2352 * the DMA memory allocated for the receive descriptors of the ring. 2353 * @param rx_conf 2354 * The pointer to the configuration data to be used for the receive queue. 2355 * NULL value is allowed, in which case default Rx configuration 2356 * will be used. 2357 * The *rx_conf* structure contains an *rx_thresh* structure with the values 2358 * of the Prefetch, Host, and Write-Back threshold registers of the receive 2359 * ring. 2360 * In addition it contains the hardware offloads features to activate using 2361 * the RTE_ETH_RX_OFFLOAD_* flags. 2362 * If an offloading set in rx_conf->offloads 2363 * hasn't been set in the input argument eth_conf->rxmode.offloads 2364 * to rte_eth_dev_configure(), it is a new added offloading, it must be 2365 * per-queue type and it is enabled for the queue. 2366 * No need to repeat any bit in rx_conf->offloads which has already been 2367 * enabled in rte_eth_dev_configure() at port level. An offloading enabled 2368 * at port level can't be disabled at queue level. 2369 * The configuration structure also contains the pointer to the array 2370 * of the receiving buffer segment descriptions, see rx_seg and rx_nseg 2371 * fields, this extended configuration might be used by split offloads like 2372 * RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT. If mb_pool is not NULL, 2373 * the extended configuration fields must be set to NULL and zero. 2374 * @param mb_pool 2375 * The pointer to the memory pool from which to allocate *rte_mbuf* network 2376 * memory buffers to populate each descriptor of the receive ring. There are 2377 * two options to provide Rx buffer configuration: 2378 * - single pool: 2379 * mb_pool is not NULL, rx_conf.rx_nseg is 0. 2380 * - multiple segments description: 2381 * mb_pool is NULL, rx_conf.rx_seg is not NULL, rx_conf.rx_nseg is not 0. 2382 * Taken only if flag RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT is set in offloads. 2383 * 2384 * @return 2385 * - 0: Success, receive queue correctly set up. 2386 * - -EIO: if device is removed. 2387 * - -ENODEV: if *port_id* is invalid. 2388 * - -EINVAL: The memory pool pointer is null or the size of network buffers 2389 * which can be allocated from this memory pool does not fit the various 2390 * buffer sizes allowed by the device controller. 2391 * - -ENOMEM: Unable to allocate the receive ring descriptors or to 2392 * allocate network memory buffers from the memory pool when 2393 * initializing receive descriptors. 2394 */ 2395 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id, 2396 uint16_t nb_rx_desc, unsigned int socket_id, 2397 const struct rte_eth_rxconf *rx_conf, 2398 struct rte_mempool *mb_pool); 2399 2400 /** 2401 * @warning 2402 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2403 * 2404 * Allocate and set up a hairpin receive queue for an Ethernet device. 2405 * 2406 * The function set up the selected queue to be used in hairpin. 2407 * 2408 * @param port_id 2409 * The port identifier of the Ethernet device. 2410 * @param rx_queue_id 2411 * The index of the receive queue to set up. 2412 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2413 * to rte_eth_dev_configure(). 2414 * @param nb_rx_desc 2415 * The number of receive descriptors to allocate for the receive ring. 2416 * 0 means the PMD will use default value. 2417 * @param conf 2418 * The pointer to the hairpin configuration. 2419 * 2420 * @return 2421 * - (0) if successful. 2422 * - (-ENODEV) if *port_id* is invalid. 2423 * - (-ENOTSUP) if hardware doesn't support. 2424 * - (-EINVAL) if bad parameter. 2425 * - (-ENOMEM) if unable to allocate the resources. 2426 */ 2427 __rte_experimental 2428 int rte_eth_rx_hairpin_queue_setup 2429 (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc, 2430 const struct rte_eth_hairpin_conf *conf); 2431 2432 /** 2433 * Allocate and set up a transmit queue for an Ethernet device. 2434 * 2435 * @param port_id 2436 * The port identifier of the Ethernet device. 2437 * @param tx_queue_id 2438 * The index of the transmit queue to set up. 2439 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2440 * to rte_eth_dev_configure(). 2441 * @param nb_tx_desc 2442 * The number of transmit descriptors to allocate for the transmit ring. 2443 * @param socket_id 2444 * The *socket_id* argument is the socket identifier in case of NUMA. 2445 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for 2446 * the DMA memory allocated for the transmit descriptors of the ring. 2447 * @param tx_conf 2448 * The pointer to the configuration data to be used for the transmit queue. 2449 * NULL value is allowed, in which case default Tx configuration 2450 * will be used. 2451 * The *tx_conf* structure contains the following data: 2452 * - The *tx_thresh* structure with the values of the Prefetch, Host, and 2453 * Write-Back threshold registers of the transmit ring. 2454 * When setting Write-Back threshold to the value greater then zero, 2455 * *tx_rs_thresh* value should be explicitly set to one. 2456 * - The *tx_free_thresh* value indicates the [minimum] number of network 2457 * buffers that must be pending in the transmit ring to trigger their 2458 * [implicit] freeing by the driver transmit function. 2459 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit 2460 * descriptors that must be pending in the transmit ring before setting the 2461 * RS bit on a descriptor by the driver transmit function. 2462 * The *tx_rs_thresh* value should be less or equal then 2463 * *tx_free_thresh* value, and both of them should be less then 2464 * *nb_tx_desc* - 3. 2465 * - The *offloads* member contains Tx offloads to be enabled. 2466 * If an offloading set in tx_conf->offloads 2467 * hasn't been set in the input argument eth_conf->txmode.offloads 2468 * to rte_eth_dev_configure(), it is a new added offloading, it must be 2469 * per-queue type and it is enabled for the queue. 2470 * No need to repeat any bit in tx_conf->offloads which has already been 2471 * enabled in rte_eth_dev_configure() at port level. An offloading enabled 2472 * at port level can't be disabled at queue level. 2473 * 2474 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces 2475 * the transmit function to use default values. 2476 * @return 2477 * - 0: Success, the transmit queue is correctly set up. 2478 * - -ENOMEM: Unable to allocate the transmit ring descriptors. 2479 */ 2480 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id, 2481 uint16_t nb_tx_desc, unsigned int socket_id, 2482 const struct rte_eth_txconf *tx_conf); 2483 2484 /** 2485 * @warning 2486 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2487 * 2488 * Allocate and set up a transmit hairpin queue for an Ethernet device. 2489 * 2490 * @param port_id 2491 * The port identifier of the Ethernet device. 2492 * @param tx_queue_id 2493 * The index of the transmit queue to set up. 2494 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2495 * to rte_eth_dev_configure(). 2496 * @param nb_tx_desc 2497 * The number of transmit descriptors to allocate for the transmit ring. 2498 * 0 to set default PMD value. 2499 * @param conf 2500 * The hairpin configuration. 2501 * 2502 * @return 2503 * - (0) if successful. 2504 * - (-ENODEV) if *port_id* is invalid. 2505 * - (-ENOTSUP) if hardware doesn't support. 2506 * - (-EINVAL) if bad parameter. 2507 * - (-ENOMEM) if unable to allocate the resources. 2508 */ 2509 __rte_experimental 2510 int rte_eth_tx_hairpin_queue_setup 2511 (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc, 2512 const struct rte_eth_hairpin_conf *conf); 2513 2514 /** 2515 * @warning 2516 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2517 * 2518 * Get all the hairpin peer Rx / Tx ports of the current port. 2519 * The caller should ensure that the array is large enough to save the ports 2520 * list. 2521 * 2522 * @param port_id 2523 * The port identifier of the Ethernet device. 2524 * @param peer_ports 2525 * Pointer to the array to store the peer ports list. 2526 * @param len 2527 * Length of the array to store the port identifiers. 2528 * @param direction 2529 * Current port to peer port direction 2530 * positive - current used as Tx to get all peer Rx ports. 2531 * zero - current used as Rx to get all peer Tx ports. 2532 * 2533 * @return 2534 * - (0 or positive) actual peer ports number. 2535 * - (-EINVAL) if bad parameter. 2536 * - (-ENODEV) if *port_id* invalid 2537 * - (-ENOTSUP) if hardware doesn't support. 2538 * - Others detailed errors from PMDs. 2539 */ 2540 __rte_experimental 2541 int rte_eth_hairpin_get_peer_ports(uint16_t port_id, uint16_t *peer_ports, 2542 size_t len, uint32_t direction); 2543 2544 /** 2545 * @warning 2546 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2547 * 2548 * Bind all hairpin Tx queues of one port to the Rx queues of the peer port. 2549 * It is only allowed to call this function after all hairpin queues are 2550 * configured properly and the devices are in started state. 2551 * 2552 * @param tx_port 2553 * The identifier of the Tx port. 2554 * @param rx_port 2555 * The identifier of peer Rx port. 2556 * RTE_MAX_ETHPORTS is allowed for the traversal of all devices. 2557 * Rx port ID could have the same value as Tx port ID. 2558 * 2559 * @return 2560 * - (0) if successful. 2561 * - (-ENODEV) if Tx port ID is invalid. 2562 * - (-EBUSY) if device is not in started state. 2563 * - (-ENOTSUP) if hardware doesn't support. 2564 * - Others detailed errors from PMDs. 2565 */ 2566 __rte_experimental 2567 int rte_eth_hairpin_bind(uint16_t tx_port, uint16_t rx_port); 2568 2569 /** 2570 * @warning 2571 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2572 * 2573 * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port. 2574 * This should be called before closing the Tx or Rx devices, if the bind 2575 * function is called before. 2576 * After unbinding the hairpin ports pair, it is allowed to bind them again. 2577 * Changing queues configuration should be after stopping the device(s). 2578 * 2579 * @param tx_port 2580 * The identifier of the Tx port. 2581 * @param rx_port 2582 * The identifier of peer Rx port. 2583 * RTE_MAX_ETHPORTS is allowed for traversal of all devices. 2584 * Rx port ID could have the same value as Tx port ID. 2585 * 2586 * @return 2587 * - (0) if successful. 2588 * - (-ENODEV) if Tx port ID is invalid. 2589 * - (-EBUSY) if device is in stopped state. 2590 * - (-ENOTSUP) if hardware doesn't support. 2591 * - Others detailed errors from PMDs. 2592 */ 2593 __rte_experimental 2594 int rte_eth_hairpin_unbind(uint16_t tx_port, uint16_t rx_port); 2595 2596 /** 2597 * @warning 2598 * @b EXPERIMENTAL: this API may change without prior notice. 2599 * 2600 * Get the number of aggregated ports of the DPDK port (specified with port_id). 2601 * It is used when multiple ports are aggregated into a single one. 2602 * 2603 * For the regular physical port doesn't have aggregated ports, 2604 * the number of aggregated ports is reported as 0. 2605 * 2606 * @param port_id 2607 * The port identifier of the Ethernet device. 2608 * @return 2609 * - (>=0) the number of aggregated port if success. 2610 */ 2611 __rte_experimental 2612 int rte_eth_dev_count_aggr_ports(uint16_t port_id); 2613 2614 /** 2615 * @warning 2616 * @b EXPERIMENTAL: this API may change without prior notice. 2617 * 2618 * Map a Tx queue with an aggregated port of the DPDK port (specified with port_id). 2619 * When multiple ports are aggregated into a single one, 2620 * it allows to choose which port to use for Tx via a queue. 2621 * 2622 * The application should use rte_eth_dev_map_aggr_tx_affinity() 2623 * after rte_eth_dev_configure(), rte_eth_tx_queue_setup(), and 2624 * before rte_eth_dev_start(). 2625 * 2626 * @param port_id 2627 * The identifier of the port used in rte_eth_tx_burst(). 2628 * @param tx_queue_id 2629 * The index of the transmit queue used in rte_eth_tx_burst(). 2630 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2631 * to rte_eth_dev_configure(). 2632 * @param affinity 2633 * The number of the aggregated port. 2634 * Value 0 means no affinity and traffic could be routed to any aggregated port. 2635 * The first aggregated port is number 1 and so on. 2636 * The maximum number is given by rte_eth_dev_count_aggr_ports(). 2637 * 2638 * @return 2639 * Zero if successful. Non-zero otherwise. 2640 */ 2641 __rte_experimental 2642 int rte_eth_dev_map_aggr_tx_affinity(uint16_t port_id, uint16_t tx_queue_id, 2643 uint8_t affinity); 2644 2645 /** 2646 * Return the NUMA socket to which an Ethernet device is connected 2647 * 2648 * @param port_id 2649 * The port identifier of the Ethernet device 2650 * @return 2651 * - The NUMA socket ID which the Ethernet device is connected to. 2652 * - -1 (which translates to SOCKET_ID_ANY) if the socket could not be 2653 * determined. rte_errno is then set to: 2654 * - EINVAL is the port_id is invalid, 2655 * - 0 is the socket could not be determined, 2656 */ 2657 int rte_eth_dev_socket_id(uint16_t port_id); 2658 2659 /** 2660 * Check if port_id of device is attached 2661 * 2662 * @param port_id 2663 * The port identifier of the Ethernet device 2664 * @return 2665 * - 0 if port is out of range or not attached 2666 * - 1 if device is attached 2667 */ 2668 int rte_eth_dev_is_valid_port(uint16_t port_id); 2669 2670 /** 2671 * @warning 2672 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice. 2673 * 2674 * Check if Rx queue is valid. 2675 * If the queue has been setup, it is considered valid. 2676 * 2677 * @param port_id 2678 * The port identifier of the Ethernet device. 2679 * @param queue_id 2680 * The index of the receive queue. 2681 * @return 2682 * - -ENODEV: if port_id is invalid. 2683 * - -EINVAL: if queue_id is out of range or queue has not been setup. 2684 * - 0 if Rx queue is valid. 2685 */ 2686 __rte_experimental 2687 int rte_eth_rx_queue_is_valid(uint16_t port_id, uint16_t queue_id); 2688 2689 /** 2690 * @warning 2691 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice. 2692 * 2693 * Check if Tx queue is valid. 2694 * If the queue has been setup, it is considered valid. 2695 * 2696 * @param port_id 2697 * The port identifier of the Ethernet device. 2698 * @param queue_id 2699 * The index of the transmit queue. 2700 * @return 2701 * - -ENODEV: if port_id is invalid. 2702 * - -EINVAL: if queue_id is out of range or queue has not been setup. 2703 * - 0 if Tx queue is valid. 2704 */ 2705 __rte_experimental 2706 int rte_eth_tx_queue_is_valid(uint16_t port_id, uint16_t queue_id); 2707 2708 /** 2709 * Start specified Rx queue of a port. It is used when rx_deferred_start 2710 * flag of the specified queue is true. 2711 * 2712 * @param port_id 2713 * The port identifier of the Ethernet device 2714 * @param rx_queue_id 2715 * The index of the Rx queue to update the ring. 2716 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2717 * to rte_eth_dev_configure(). 2718 * @return 2719 * - 0: Success, the receive queue is started. 2720 * - -ENODEV: if *port_id* is invalid. 2721 * - -EINVAL: The queue_id out of range or belong to hairpin. 2722 * - -EIO: if device is removed. 2723 * - -ENOTSUP: The function not supported in PMD. 2724 */ 2725 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id); 2726 2727 /** 2728 * Stop specified Rx queue of a port 2729 * 2730 * @param port_id 2731 * The port identifier of the Ethernet device 2732 * @param rx_queue_id 2733 * The index of the Rx queue to update the ring. 2734 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2735 * to rte_eth_dev_configure(). 2736 * @return 2737 * - 0: Success, the receive queue is stopped. 2738 * - -ENODEV: if *port_id* is invalid. 2739 * - -EINVAL: The queue_id out of range or belong to hairpin. 2740 * - -EIO: if device is removed. 2741 * - -ENOTSUP: The function not supported in PMD. 2742 */ 2743 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id); 2744 2745 /** 2746 * Start Tx for specified queue of a port. It is used when tx_deferred_start 2747 * flag of the specified queue is true. 2748 * 2749 * @param port_id 2750 * The port identifier of the Ethernet device 2751 * @param tx_queue_id 2752 * The index of the Tx queue to update the ring. 2753 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2754 * to rte_eth_dev_configure(). 2755 * @return 2756 * - 0: Success, the transmit queue is started. 2757 * - -ENODEV: if *port_id* is invalid. 2758 * - -EINVAL: The queue_id out of range or belong to hairpin. 2759 * - -EIO: if device is removed. 2760 * - -ENOTSUP: The function not supported in PMD. 2761 */ 2762 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id); 2763 2764 /** 2765 * Stop specified Tx queue of a port 2766 * 2767 * @param port_id 2768 * The port identifier of the Ethernet device 2769 * @param tx_queue_id 2770 * The index of the Tx queue to update the ring. 2771 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2772 * to rte_eth_dev_configure(). 2773 * @return 2774 * - 0: Success, the transmit queue is stopped. 2775 * - -ENODEV: if *port_id* is invalid. 2776 * - -EINVAL: The queue_id out of range or belong to hairpin. 2777 * - -EIO: if device is removed. 2778 * - -ENOTSUP: The function not supported in PMD. 2779 */ 2780 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id); 2781 2782 /** 2783 * Start an Ethernet device. 2784 * 2785 * The device start step is the last one and consists of setting the configured 2786 * offload features and in starting the transmit and the receive units of the 2787 * device. 2788 * 2789 * Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before 2790 * PMD port start callback function is invoked. 2791 * 2792 * On success, all basic functions exported by the Ethernet API (link status, 2793 * receive/transmit, and so on) can be invoked. 2794 * 2795 * @param port_id 2796 * The port identifier of the Ethernet device. 2797 * @return 2798 * - 0: Success, Ethernet device started. 2799 * - -EAGAIN: If start operation must be retried. 2800 * - <0: Error code of the driver device start function. 2801 */ 2802 int rte_eth_dev_start(uint16_t port_id); 2803 2804 /** 2805 * Stop an Ethernet device. The device can be restarted with a call to 2806 * rte_eth_dev_start() 2807 * 2808 * @param port_id 2809 * The port identifier of the Ethernet device. 2810 * @return 2811 * - 0: Success, Ethernet device stopped. 2812 * - -EBUSY: If stopping the port is not allowed in current state. 2813 * - <0: Error code of the driver device stop function. 2814 */ 2815 int rte_eth_dev_stop(uint16_t port_id); 2816 2817 /** 2818 * Link up an Ethernet device. 2819 * 2820 * Set device link up will re-enable the device Rx/Tx 2821 * functionality after it is previously set device linked down. 2822 * 2823 * @param port_id 2824 * The port identifier of the Ethernet device. 2825 * @return 2826 * - 0: Success, Ethernet device linked up. 2827 * - <0: Error code of the driver device link up function. 2828 */ 2829 int rte_eth_dev_set_link_up(uint16_t port_id); 2830 2831 /** 2832 * Link down an Ethernet device. 2833 * The device Rx/Tx functionality will be disabled if success, 2834 * and it can be re-enabled with a call to 2835 * rte_eth_dev_set_link_up() 2836 * 2837 * @param port_id 2838 * The port identifier of the Ethernet device. 2839 */ 2840 int rte_eth_dev_set_link_down(uint16_t port_id); 2841 2842 /** 2843 * Close a stopped Ethernet device. The device cannot be restarted! 2844 * The function frees all port resources. 2845 * 2846 * @param port_id 2847 * The port identifier of the Ethernet device. 2848 * @return 2849 * - Zero if the port is closed successfully. 2850 * - Negative if something went wrong. 2851 */ 2852 int rte_eth_dev_close(uint16_t port_id); 2853 2854 /** 2855 * Reset a Ethernet device and keep its port ID. 2856 * 2857 * When a port has to be reset passively, the DPDK application can invoke 2858 * this function. For example when a PF is reset, all its VFs should also 2859 * be reset. Normally a DPDK application can invoke this function when 2860 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start 2861 * a port reset in other circumstances. 2862 * 2863 * When this function is called, it first stops the port and then calls the 2864 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial 2865 * state, in which no Tx and Rx queues are setup, as if the port has been 2866 * reset and not started. The port keeps the port ID it had before the 2867 * function call. 2868 * 2869 * After calling rte_eth_dev_reset( ), the application should use 2870 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ), 2871 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( ) 2872 * to reconfigure the device as appropriate. 2873 * 2874 * Note: To avoid unexpected behavior, the application should stop calling 2875 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread 2876 * safety, all these controlling functions should be called from the same 2877 * thread. 2878 * 2879 * @param port_id 2880 * The port identifier of the Ethernet device. 2881 * 2882 * @return 2883 * - (0) if successful. 2884 * - (-ENODEV) if *port_id* is invalid. 2885 * - (-ENOTSUP) if hardware doesn't support this function. 2886 * - (-EPERM) if not ran from the primary process. 2887 * - (-EIO) if re-initialisation failed or device is removed. 2888 * - (-ENOMEM) if the reset failed due to OOM. 2889 * - (-EAGAIN) if the reset temporarily failed and should be retried later. 2890 */ 2891 int rte_eth_dev_reset(uint16_t port_id); 2892 2893 /** 2894 * Enable receipt in promiscuous mode for an Ethernet device. 2895 * 2896 * @param port_id 2897 * The port identifier of the Ethernet device. 2898 * @return 2899 * - (0) if successful. 2900 * - (-ENOTSUP) if support for promiscuous_enable() does not exist 2901 * for the device. 2902 * - (-ENODEV) if *port_id* invalid. 2903 */ 2904 int rte_eth_promiscuous_enable(uint16_t port_id); 2905 2906 /** 2907 * Disable receipt in promiscuous mode for an Ethernet device. 2908 * 2909 * @param port_id 2910 * The port identifier of the Ethernet device. 2911 * @return 2912 * - (0) if successful. 2913 * - (-ENOTSUP) if support for promiscuous_disable() does not exist 2914 * for the device. 2915 * - (-ENODEV) if *port_id* invalid. 2916 */ 2917 int rte_eth_promiscuous_disable(uint16_t port_id); 2918 2919 /** 2920 * Return the value of promiscuous mode for an Ethernet device. 2921 * 2922 * @param port_id 2923 * The port identifier of the Ethernet device. 2924 * @return 2925 * - (1) if promiscuous is enabled 2926 * - (0) if promiscuous is disabled. 2927 * - (-1) on error 2928 */ 2929 int rte_eth_promiscuous_get(uint16_t port_id); 2930 2931 /** 2932 * Enable the receipt of any multicast frame by an Ethernet device. 2933 * 2934 * @param port_id 2935 * The port identifier of the Ethernet device. 2936 * @return 2937 * - (0) if successful. 2938 * - (-ENOTSUP) if support for allmulticast_enable() does not exist 2939 * for the device. 2940 * - (-ENODEV) if *port_id* invalid. 2941 */ 2942 int rte_eth_allmulticast_enable(uint16_t port_id); 2943 2944 /** 2945 * Disable the receipt of all multicast frames by an Ethernet device. 2946 * 2947 * @param port_id 2948 * The port identifier of the Ethernet device. 2949 * @return 2950 * - (0) if successful. 2951 * - (-ENOTSUP) if support for allmulticast_disable() does not exist 2952 * for the device. 2953 * - (-ENODEV) if *port_id* invalid. 2954 */ 2955 int rte_eth_allmulticast_disable(uint16_t port_id); 2956 2957 /** 2958 * Return the value of allmulticast mode for an Ethernet device. 2959 * 2960 * @param port_id 2961 * The port identifier of the Ethernet device. 2962 * @return 2963 * - (1) if allmulticast is enabled 2964 * - (0) if allmulticast is disabled. 2965 * - (-1) on error 2966 */ 2967 int rte_eth_allmulticast_get(uint16_t port_id); 2968 2969 /** 2970 * Retrieve the link status (up/down), the duplex mode (half/full), 2971 * the negotiation (auto/fixed), and if available, the speed (Mbps). 2972 * 2973 * It might need to wait up to 9 seconds. 2974 * @see rte_eth_link_get_nowait. 2975 * 2976 * @param port_id 2977 * The port identifier of the Ethernet device. 2978 * @param link 2979 * Link information written back. 2980 * @return 2981 * - (0) if successful. 2982 * - (-ENOTSUP) if the function is not supported in PMD. 2983 * - (-ENODEV) if *port_id* invalid. 2984 * - (-EINVAL) if bad parameter. 2985 */ 2986 int rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link); 2987 2988 /** 2989 * Retrieve the link status (up/down), the duplex mode (half/full), 2990 * the negotiation (auto/fixed), and if available, the speed (Mbps). 2991 * 2992 * @param port_id 2993 * The port identifier of the Ethernet device. 2994 * @param link 2995 * Link information written back. 2996 * @return 2997 * - (0) if successful. 2998 * - (-ENOTSUP) if the function is not supported in PMD. 2999 * - (-ENODEV) if *port_id* invalid. 3000 * - (-EINVAL) if bad parameter. 3001 */ 3002 int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link); 3003 3004 /** 3005 * @warning 3006 * @b EXPERIMENTAL: this API may change without prior notice. 3007 * 3008 * The function converts a link_speed to a string. It handles all special 3009 * values like unknown or none speed. 3010 * 3011 * @param link_speed 3012 * link_speed of rte_eth_link struct 3013 * @return 3014 * Link speed in textual format. It's pointer to immutable memory. 3015 * No free is required. 3016 */ 3017 __rte_experimental 3018 const char *rte_eth_link_speed_to_str(uint32_t link_speed); 3019 3020 /** 3021 * @warning 3022 * @b EXPERIMENTAL: this API may change without prior notice. 3023 * 3024 * The function converts a rte_eth_link struct representing a link status to 3025 * a string. 3026 * 3027 * @param str 3028 * A pointer to a string to be filled with textual representation of 3029 * device status. At least RTE_ETH_LINK_MAX_STR_LEN bytes should be allocated to 3030 * store default link status text. 3031 * @param len 3032 * Length of available memory at 'str' string. 3033 * @param eth_link 3034 * Link status returned by rte_eth_link_get function 3035 * @return 3036 * Number of bytes written to str array or -EINVAL if bad parameter. 3037 */ 3038 __rte_experimental 3039 int rte_eth_link_to_str(char *str, size_t len, 3040 const struct rte_eth_link *eth_link); 3041 3042 /** 3043 * Retrieve the general I/O statistics of an Ethernet device. 3044 * 3045 * @param port_id 3046 * The port identifier of the Ethernet device. 3047 * @param stats 3048 * A pointer to a structure of type *rte_eth_stats* to be filled with 3049 * the values of device counters for the following set of statistics: 3050 * - *ipackets* with the total of successfully received packets. 3051 * - *opackets* with the total of successfully transmitted packets. 3052 * - *ibytes* with the total of successfully received bytes. 3053 * - *obytes* with the total of successfully transmitted bytes. 3054 * - *ierrors* with the total of erroneous received packets. 3055 * - *oerrors* with the total of failed transmitted packets. 3056 * @return 3057 * Zero if successful. Non-zero otherwise. 3058 */ 3059 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats); 3060 3061 /** 3062 * Reset the general I/O statistics of an Ethernet device. 3063 * 3064 * @param port_id 3065 * The port identifier of the Ethernet device. 3066 * @return 3067 * - (0) if device notified to reset stats. 3068 * - (-ENOTSUP) if hardware doesn't support. 3069 * - (-ENODEV) if *port_id* invalid. 3070 * - (<0): Error code of the driver stats reset function. 3071 */ 3072 int rte_eth_stats_reset(uint16_t port_id); 3073 3074 /** 3075 * Retrieve names of extended statistics of an Ethernet device. 3076 * 3077 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched 3078 * by array index: 3079 * xstats_names[i].name => xstats[i].value 3080 * 3081 * And the array index is same with id field of 'struct rte_eth_xstat': 3082 * xstats[i].id == i 3083 * 3084 * This assumption makes key-value pair matching less flexible but simpler. 3085 * 3086 * @param port_id 3087 * The port identifier of the Ethernet device. 3088 * @param xstats_names 3089 * An rte_eth_xstat_name array of at least *size* elements to 3090 * be filled. If set to NULL, the function returns the required number 3091 * of elements. 3092 * @param size 3093 * The size of the xstats_names array (number of elements). 3094 * @return 3095 * - A positive value lower or equal to size: success. The return value 3096 * is the number of entries filled in the stats table. 3097 * - A positive value higher than size: error, the given statistics table 3098 * is too small. The return value corresponds to the size that should 3099 * be given to succeed. The entries in the table are not valid and 3100 * shall not be used by the caller. 3101 * - A negative value on error (invalid port ID). 3102 */ 3103 int rte_eth_xstats_get_names(uint16_t port_id, 3104 struct rte_eth_xstat_name *xstats_names, 3105 unsigned int size); 3106 3107 /** 3108 * Retrieve extended statistics of an Ethernet device. 3109 * 3110 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched 3111 * by array index: 3112 * xstats_names[i].name => xstats[i].value 3113 * 3114 * And the array index is same with id field of 'struct rte_eth_xstat': 3115 * xstats[i].id == i 3116 * 3117 * This assumption makes key-value pair matching less flexible but simpler. 3118 * 3119 * @param port_id 3120 * The port identifier of the Ethernet device. 3121 * @param xstats 3122 * A pointer to a table of structure of type *rte_eth_xstat* 3123 * to be filled with device statistics ids and values. 3124 * This parameter can be set to NULL if and only if n is 0. 3125 * @param n 3126 * The size of the xstats array (number of elements). 3127 * If lower than the required number of elements, the function returns 3128 * the required number of elements. 3129 * If equal to zero, the xstats must be NULL, the function returns the 3130 * required number of elements. 3131 * @return 3132 * - A positive value lower or equal to n: success. The return value 3133 * is the number of entries filled in the stats table. 3134 * - A positive value higher than n: error, the given statistics table 3135 * is too small. The return value corresponds to the size that should 3136 * be given to succeed. The entries in the table are not valid and 3137 * shall not be used by the caller. 3138 * - A negative value on error (invalid port ID). 3139 */ 3140 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, 3141 unsigned int n); 3142 3143 /** 3144 * Retrieve names of extended statistics of an Ethernet device. 3145 * 3146 * @param port_id 3147 * The port identifier of the Ethernet device. 3148 * @param xstats_names 3149 * Array to be filled in with names of requested device statistics. 3150 * Must not be NULL if @p ids are specified (not NULL). 3151 * @param size 3152 * Number of elements in @p xstats_names array (if not NULL) and in 3153 * @p ids array (if not NULL). Must be 0 if both array pointers are NULL. 3154 * @param ids 3155 * IDs array given by app to retrieve specific statistics. May be NULL to 3156 * retrieve names of all available statistics or, if @p xstats_names is 3157 * NULL as well, just the number of available statistics. 3158 * @return 3159 * - A positive value lower or equal to size: success. The return value 3160 * is the number of entries filled in the stats table. 3161 * - A positive value higher than size: success. The given statistics table 3162 * is too small. The return value corresponds to the size that should 3163 * be given to succeed. The entries in the table are not valid and 3164 * shall not be used by the caller. 3165 * - A negative value on error. 3166 */ 3167 int 3168 rte_eth_xstats_get_names_by_id(uint16_t port_id, 3169 struct rte_eth_xstat_name *xstats_names, unsigned int size, 3170 uint64_t *ids); 3171 3172 /** 3173 * Retrieve extended statistics of an Ethernet device. 3174 * 3175 * @param port_id 3176 * The port identifier of the Ethernet device. 3177 * @param ids 3178 * IDs array given by app to retrieve specific statistics. May be NULL to 3179 * retrieve all available statistics or, if @p values is NULL as well, 3180 * just the number of available statistics. 3181 * @param values 3182 * Array to be filled in with requested device statistics. 3183 * Must not be NULL if ids are specified (not NULL). 3184 * @param size 3185 * Number of elements in @p values array (if not NULL) and in @p ids 3186 * array (if not NULL). Must be 0 if both array pointers are NULL. 3187 * @return 3188 * - A positive value lower or equal to size: success. The return value 3189 * is the number of entries filled in the stats table. 3190 * - A positive value higher than size: success: The given statistics table 3191 * is too small. The return value corresponds to the size that should 3192 * be given to succeed. The entries in the table are not valid and 3193 * shall not be used by the caller. 3194 * - A negative value on error. 3195 */ 3196 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids, 3197 uint64_t *values, unsigned int size); 3198 3199 /** 3200 * Gets the ID of a statistic from its name. 3201 * 3202 * This function searches for the statistics using string compares, and 3203 * as such should not be used on the fast-path. For fast-path retrieval of 3204 * specific statistics, store the ID as provided in *id* from this function, 3205 * and pass the ID to rte_eth_xstats_get() 3206 * 3207 * @param port_id The port to look up statistics from 3208 * @param xstat_name The name of the statistic to return 3209 * @param[out] id A pointer to an app-supplied uint64_t which should be 3210 * set to the ID of the stat if the stat exists. 3211 * @return 3212 * 0 on success 3213 * -ENODEV for invalid port_id, 3214 * -EIO if device is removed, 3215 * -EINVAL if the xstat_name doesn't exist in port_id 3216 * -ENOMEM if bad parameter. 3217 */ 3218 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name, 3219 uint64_t *id); 3220 3221 /** 3222 * Reset extended statistics of an Ethernet device. 3223 * 3224 * @param port_id 3225 * The port identifier of the Ethernet device. 3226 * @return 3227 * - (0) if device notified to reset extended stats. 3228 * - (-ENOTSUP) if pmd doesn't support both 3229 * extended stats and basic stats reset. 3230 * - (-ENODEV) if *port_id* invalid. 3231 * - (<0): Error code of the driver xstats reset function. 3232 */ 3233 int rte_eth_xstats_reset(uint16_t port_id); 3234 3235 /** 3236 * Set a mapping for the specified transmit queue to the specified per-queue 3237 * statistics counter. 3238 * 3239 * @param port_id 3240 * The port identifier of the Ethernet device. 3241 * @param tx_queue_id 3242 * The index of the transmit queue for which a queue stats mapping is required. 3243 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 3244 * to rte_eth_dev_configure(). 3245 * @param stat_idx 3246 * The per-queue packet statistics functionality number that the transmit 3247 * queue is to be assigned. 3248 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1]. 3249 * Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256. 3250 * @return 3251 * Zero if successful. Non-zero otherwise. 3252 */ 3253 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id, 3254 uint16_t tx_queue_id, uint8_t stat_idx); 3255 3256 /** 3257 * Set a mapping for the specified receive queue to the specified per-queue 3258 * statistics counter. 3259 * 3260 * @param port_id 3261 * The port identifier of the Ethernet device. 3262 * @param rx_queue_id 3263 * The index of the receive queue for which a queue stats mapping is required. 3264 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3265 * to rte_eth_dev_configure(). 3266 * @param stat_idx 3267 * The per-queue packet statistics functionality number that the receive 3268 * queue is to be assigned. 3269 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1]. 3270 * Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256. 3271 * @return 3272 * Zero if successful. Non-zero otherwise. 3273 */ 3274 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id, 3275 uint16_t rx_queue_id, 3276 uint8_t stat_idx); 3277 3278 /** 3279 * Retrieve the Ethernet address of an Ethernet device. 3280 * 3281 * @param port_id 3282 * The port identifier of the Ethernet device. 3283 * @param mac_addr 3284 * A pointer to a structure of type *ether_addr* to be filled with 3285 * the Ethernet address of the Ethernet device. 3286 * @return 3287 * - (0) if successful 3288 * - (-ENODEV) if *port_id* invalid. 3289 * - (-EINVAL) if bad parameter. 3290 */ 3291 int rte_eth_macaddr_get(uint16_t port_id, struct rte_ether_addr *mac_addr); 3292 3293 /** 3294 * @warning 3295 * @b EXPERIMENTAL: this API may change without prior notice 3296 * 3297 * Retrieve the Ethernet addresses of an Ethernet device. 3298 * 3299 * @param port_id 3300 * The port identifier of the Ethernet device. 3301 * @param ma 3302 * A pointer to an array of structures of type *ether_addr* to be filled with 3303 * the Ethernet addresses of the Ethernet device. 3304 * @param num 3305 * Number of elements in the @p ma array. 3306 * Note that rte_eth_dev_info::max_mac_addrs can be used to retrieve 3307 * max number of Ethernet addresses for given port. 3308 * @return 3309 * - number of retrieved addresses if successful 3310 * - (-ENODEV) if *port_id* invalid. 3311 * - (-EINVAL) if bad parameter. 3312 */ 3313 __rte_experimental 3314 int rte_eth_macaddrs_get(uint16_t port_id, struct rte_ether_addr *ma, 3315 unsigned int num); 3316 3317 /** 3318 * Retrieve the contextual information of an Ethernet device. 3319 * 3320 * This function returns the Ethernet device information based 3321 * on the values stored internally in the device specific data. 3322 * For example: number of queues, descriptor limits, device 3323 * capabilities and offload flags. 3324 * 3325 * @param port_id 3326 * The port identifier of the Ethernet device. 3327 * @param dev_info 3328 * A pointer to a structure of type *rte_eth_dev_info* to be filled with 3329 * the contextual information of the Ethernet device. 3330 * @return 3331 * - (0) if successful. 3332 * - (-ENOTSUP) if support for dev_infos_get() does not exist for the device. 3333 * - (-ENODEV) if *port_id* invalid. 3334 * - (-EINVAL) if bad parameter. 3335 */ 3336 int rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info); 3337 3338 /** 3339 * @warning 3340 * @b EXPERIMENTAL: this API may change without prior notice. 3341 * 3342 * Retrieve the configuration of an Ethernet device. 3343 * 3344 * @param port_id 3345 * The port identifier of the Ethernet device. 3346 * @param dev_conf 3347 * Location for Ethernet device configuration to be filled in. 3348 * @return 3349 * - (0) if successful. 3350 * - (-ENODEV) if *port_id* invalid. 3351 * - (-EINVAL) if bad parameter. 3352 */ 3353 __rte_experimental 3354 int rte_eth_dev_conf_get(uint16_t port_id, struct rte_eth_conf *dev_conf); 3355 3356 /** 3357 * Retrieve the firmware version of a device. 3358 * 3359 * @param port_id 3360 * The port identifier of the device. 3361 * @param fw_version 3362 * A pointer to a string array storing the firmware version of a device, 3363 * the string includes terminating null. This pointer is allocated by caller. 3364 * @param fw_size 3365 * The size of the string array pointed by fw_version, which should be 3366 * large enough to store firmware version of the device. 3367 * @return 3368 * - (0) if successful. 3369 * - (-ENOTSUP) if operation is not supported. 3370 * - (-ENODEV) if *port_id* invalid. 3371 * - (-EIO) if device is removed. 3372 * - (-EINVAL) if bad parameter. 3373 * - (>0) if *fw_size* is not enough to store firmware version, return 3374 * the size of the non truncated string. 3375 */ 3376 int rte_eth_dev_fw_version_get(uint16_t port_id, 3377 char *fw_version, size_t fw_size); 3378 3379 /** 3380 * Retrieve the supported packet types of an Ethernet device. 3381 * 3382 * When a packet type is announced as supported, it *must* be recognized by 3383 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN 3384 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following 3385 * packet types for these packets: 3386 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4 3387 * - Ether/VLAN/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4 3388 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER 3389 * - Ether/VLAN/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN 3390 * 3391 * When a packet is received by a PMD, the most precise type must be 3392 * returned among the ones supported. However a PMD is allowed to set 3393 * packet type that is not in the supported list, at the condition that it 3394 * is more precise. Therefore, a PMD announcing no supported packet types 3395 * can still set a matching packet type in a received packet. 3396 * 3397 * @note 3398 * Better to invoke this API after the device is already started or Rx burst 3399 * function is decided, to obtain correct supported ptypes. 3400 * @note 3401 * if a given PMD does not report what ptypes it supports, then the supported 3402 * ptype count is reported as 0. 3403 * @param port_id 3404 * The port identifier of the Ethernet device. 3405 * @param ptype_mask 3406 * A hint of what kind of packet type which the caller is interested in. 3407 * @param ptypes 3408 * An array pointer to store adequate packet types, allocated by caller. 3409 * @param num 3410 * Size of the array pointed by param ptypes. 3411 * @return 3412 * - (>=0) Number of supported ptypes. If the number of types exceeds num, 3413 * only num entries will be filled into the ptypes array, but the full 3414 * count of supported ptypes will be returned. 3415 * - (-ENODEV) if *port_id* invalid. 3416 * - (-EINVAL) if bad parameter. 3417 */ 3418 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask, 3419 uint32_t *ptypes, int num); 3420 /** 3421 * Inform Ethernet device about reduced range of packet types to handle. 3422 * 3423 * Application can use this function to set only specific ptypes that it's 3424 * interested. This information can be used by the PMD to optimize Rx path. 3425 * 3426 * The function accepts an array `set_ptypes` allocated by the caller to 3427 * store the packet types set by the driver, the last element of the array 3428 * is set to RTE_PTYPE_UNKNOWN. The size of the `set_ptype` array should be 3429 * `rte_eth_dev_get_supported_ptypes() + 1` else it might only be filled 3430 * partially. 3431 * 3432 * @param port_id 3433 * The port identifier of the Ethernet device. 3434 * @param ptype_mask 3435 * The ptype family that application is interested in should be bitwise OR of 3436 * RTE_PTYPE_*_MASK or 0. 3437 * @param set_ptypes 3438 * An array pointer to store set packet types, allocated by caller. The 3439 * function marks the end of array with RTE_PTYPE_UNKNOWN. 3440 * @param num 3441 * Size of the array pointed by param ptypes. 3442 * Should be rte_eth_dev_get_supported_ptypes() + 1 to accommodate the 3443 * set ptypes. 3444 * @return 3445 * - (0) if Success. 3446 * - (-ENODEV) if *port_id* invalid. 3447 * - (-EINVAL) if *ptype_mask* is invalid (or) set_ptypes is NULL and 3448 * num > 0. 3449 */ 3450 int rte_eth_dev_set_ptypes(uint16_t port_id, uint32_t ptype_mask, 3451 uint32_t *set_ptypes, unsigned int num); 3452 3453 /** 3454 * Retrieve the MTU of an Ethernet device. 3455 * 3456 * @param port_id 3457 * The port identifier of the Ethernet device. 3458 * @param mtu 3459 * A pointer to a uint16_t where the retrieved MTU is to be stored. 3460 * @return 3461 * - (0) if successful. 3462 * - (-ENODEV) if *port_id* invalid. 3463 * - (-EINVAL) if bad parameter. 3464 */ 3465 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu); 3466 3467 /** 3468 * Change the MTU of an Ethernet device. 3469 * 3470 * @param port_id 3471 * The port identifier of the Ethernet device. 3472 * @param mtu 3473 * A uint16_t for the MTU to be applied. 3474 * @return 3475 * - (0) if successful. 3476 * - (-ENOTSUP) if operation is not supported. 3477 * - (-ENODEV) if *port_id* invalid. 3478 * - (-EIO) if device is removed. 3479 * - (-EINVAL) if *mtu* invalid, validation of mtu can occur within 3480 * rte_eth_dev_set_mtu if dev_infos_get is supported by the device or 3481 * when the mtu is set using dev->dev_ops->mtu_set. 3482 * - (-EBUSY) if operation is not allowed when the port is running 3483 */ 3484 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu); 3485 3486 /** 3487 * Enable/Disable hardware filtering by an Ethernet device of received 3488 * VLAN packets tagged with a given VLAN Tag Identifier. 3489 * 3490 * @param port_id 3491 * The port identifier of the Ethernet device. 3492 * @param vlan_id 3493 * The VLAN Tag Identifier whose filtering must be enabled or disabled. 3494 * @param on 3495 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*. 3496 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*. 3497 * @return 3498 * - (0) if successful. 3499 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured. 3500 * - (-ENODEV) if *port_id* invalid. 3501 * - (-EIO) if device is removed. 3502 * - (-ENOSYS) if VLAN filtering on *port_id* disabled. 3503 * - (-EINVAL) if *vlan_id* > 4095. 3504 */ 3505 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on); 3506 3507 /** 3508 * Enable/Disable hardware VLAN Strip by a Rx queue of an Ethernet device. 3509 * 3510 * @param port_id 3511 * The port identifier of the Ethernet device. 3512 * @param rx_queue_id 3513 * The index of the receive queue for which a queue stats mapping is required. 3514 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3515 * to rte_eth_dev_configure(). 3516 * @param on 3517 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port. 3518 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port. 3519 * @return 3520 * - (0) if successful. 3521 * - (-ENOTSUP) if hardware-assisted VLAN stripping not configured. 3522 * - (-ENODEV) if *port_id* invalid. 3523 * - (-EINVAL) if *rx_queue_id* invalid. 3524 */ 3525 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id, 3526 int on); 3527 3528 /** 3529 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to 3530 * the VLAN header. 3531 * 3532 * @param port_id 3533 * The port identifier of the Ethernet device. 3534 * @param vlan_type 3535 * The VLAN type. 3536 * @param tag_type 3537 * The Tag Protocol ID 3538 * @return 3539 * - (0) if successful. 3540 * - (-ENOTSUP) if hardware-assisted VLAN TPID setup is not supported. 3541 * - (-ENODEV) if *port_id* invalid. 3542 * - (-EIO) if device is removed. 3543 */ 3544 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id, 3545 enum rte_vlan_type vlan_type, 3546 uint16_t tag_type); 3547 3548 /** 3549 * Set VLAN offload configuration on an Ethernet device. 3550 * 3551 * @param port_id 3552 * The port identifier of the Ethernet device. 3553 * @param offload_mask 3554 * The VLAN Offload bit mask can be mixed use with "OR" 3555 * RTE_ETH_VLAN_STRIP_OFFLOAD 3556 * RTE_ETH_VLAN_FILTER_OFFLOAD 3557 * RTE_ETH_VLAN_EXTEND_OFFLOAD 3558 * RTE_ETH_QINQ_STRIP_OFFLOAD 3559 * @return 3560 * - (0) if successful. 3561 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured. 3562 * - (-ENODEV) if *port_id* invalid. 3563 * - (-EIO) if device is removed. 3564 */ 3565 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask); 3566 3567 /** 3568 * Read VLAN Offload configuration from an Ethernet device 3569 * 3570 * @param port_id 3571 * The port identifier of the Ethernet device. 3572 * @return 3573 * - (>0) if successful. Bit mask to indicate 3574 * RTE_ETH_VLAN_STRIP_OFFLOAD 3575 * RTE_ETH_VLAN_FILTER_OFFLOAD 3576 * RTE_ETH_VLAN_EXTEND_OFFLOAD 3577 * RTE_ETH_QINQ_STRIP_OFFLOAD 3578 * - (-ENODEV) if *port_id* invalid. 3579 */ 3580 int rte_eth_dev_get_vlan_offload(uint16_t port_id); 3581 3582 /** 3583 * Set port based Tx VLAN insertion on or off. 3584 * 3585 * @param port_id 3586 * The port identifier of the Ethernet device. 3587 * @param pvid 3588 * Port based Tx VLAN identifier together with user priority. 3589 * @param on 3590 * Turn on or off the port based Tx VLAN insertion. 3591 * 3592 * @return 3593 * - (0) if successful. 3594 * - negative if failed. 3595 */ 3596 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on); 3597 3598 /** 3599 * @warning 3600 * @b EXPERIMENTAL: this API may change without prior notice. 3601 * 3602 * Set Rx queue available descriptors threshold. 3603 * 3604 * @param port_id 3605 * The port identifier of the Ethernet device. 3606 * @param queue_id 3607 * The index of the receive queue. 3608 * @param avail_thresh 3609 * The available descriptors threshold is percentage of Rx queue size 3610 * which describes the availability of Rx queue for hardware. 3611 * If the Rx queue availability is below it, 3612 * the event RTE_ETH_EVENT_RX_AVAIL_THRESH is triggered. 3613 * [1-99] to set a new available descriptors threshold. 3614 * 0 to disable threshold monitoring. 3615 * 3616 * @return 3617 * - 0 if successful. 3618 * - (-ENODEV) if @p port_id is invalid. 3619 * - (-EINVAL) if bad parameter. 3620 * - (-ENOTSUP) if available Rx descriptors threshold is not supported. 3621 * - (-EIO) if device is removed. 3622 */ 3623 __rte_experimental 3624 int rte_eth_rx_avail_thresh_set(uint16_t port_id, uint16_t queue_id, 3625 uint8_t avail_thresh); 3626 3627 /** 3628 * @warning 3629 * @b EXPERIMENTAL: this API may change without prior notice. 3630 * 3631 * Find Rx queue with RTE_ETH_EVENT_RX_AVAIL_THRESH event pending. 3632 * 3633 * @param port_id 3634 * The port identifier of the Ethernet device. 3635 * @param[inout] queue_id 3636 * On input starting Rx queue index to search from. 3637 * If the queue_id is bigger than maximum queue ID of the port, 3638 * search is started from 0. So that application can keep calling 3639 * this function to handle all pending events with a simple increment 3640 * of queue_id on the next call. 3641 * On output if return value is 1, Rx queue index with the event pending. 3642 * @param[out] avail_thresh 3643 * Location for available descriptors threshold of the found Rx queue. 3644 * 3645 * @return 3646 * - 1 if an Rx queue with pending event is found. 3647 * - 0 if no Rx queue with pending event is found. 3648 * - (-ENODEV) if @p port_id is invalid. 3649 * - (-EINVAL) if bad parameter (e.g. @p queue_id is NULL). 3650 * - (-ENOTSUP) if operation is not supported. 3651 * - (-EIO) if device is removed. 3652 */ 3653 __rte_experimental 3654 int rte_eth_rx_avail_thresh_query(uint16_t port_id, uint16_t *queue_id, 3655 uint8_t *avail_thresh); 3656 3657 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count, 3658 void *userdata); 3659 3660 /** 3661 * Structure used to buffer packets for future Tx 3662 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush 3663 */ 3664 struct rte_eth_dev_tx_buffer { 3665 buffer_tx_error_fn error_callback; 3666 void *error_userdata; 3667 uint16_t size; /**< Size of buffer for buffered Tx */ 3668 uint16_t length; /**< Number of packets in the array */ 3669 /** Pending packets to be sent on explicit flush or when full */ 3670 struct rte_mbuf *pkts[]; 3671 }; 3672 3673 /** 3674 * Calculate the size of the Tx buffer. 3675 * 3676 * @param sz 3677 * Number of stored packets. 3678 */ 3679 #define RTE_ETH_TX_BUFFER_SIZE(sz) \ 3680 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *)) 3681 3682 /** 3683 * Initialize default values for buffered transmitting 3684 * 3685 * @param buffer 3686 * Tx buffer to be initialized. 3687 * @param size 3688 * Buffer size 3689 * @return 3690 * 0 if no error 3691 */ 3692 int 3693 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size); 3694 3695 /** 3696 * Configure a callback for buffered packets which cannot be sent 3697 * 3698 * Register a specific callback to be called when an attempt is made to send 3699 * all packets buffered on an Ethernet port, but not all packets can 3700 * successfully be sent. The callback registered here will be called only 3701 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs. 3702 * The default callback configured for each queue by default just frees the 3703 * packets back to the calling mempool. If additional behaviour is required, 3704 * for example, to count dropped packets, or to retry transmission of packets 3705 * which cannot be sent, this function should be used to register a suitable 3706 * callback function to implement the desired behaviour. 3707 * The example callback "rte_eth_count_unsent_packet_callback()" is also 3708 * provided as reference. 3709 * 3710 * @param buffer 3711 * The port identifier of the Ethernet device. 3712 * @param callback 3713 * The function to be used as the callback. 3714 * @param userdata 3715 * Arbitrary parameter to be passed to the callback function 3716 * @return 3717 * 0 on success, or -EINVAL if bad parameter 3718 */ 3719 int 3720 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer, 3721 buffer_tx_error_fn callback, void *userdata); 3722 3723 /** 3724 * Callback function for silently dropping unsent buffered packets. 3725 * 3726 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to 3727 * adjust the default behavior when buffered packets cannot be sent. This 3728 * function drops any unsent packets silently and is used by Tx buffered 3729 * operations as default behavior. 3730 * 3731 * NOTE: this function should not be called directly, instead it should be used 3732 * as a callback for packet buffering. 3733 * 3734 * NOTE: when configuring this function as a callback with 3735 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter 3736 * should point to an uint64_t value. 3737 * 3738 * @param pkts 3739 * The previously buffered packets which could not be sent 3740 * @param unsent 3741 * The number of unsent packets in the pkts array 3742 * @param userdata 3743 * Not used 3744 */ 3745 void 3746 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent, 3747 void *userdata); 3748 3749 /** 3750 * Callback function for tracking unsent buffered packets. 3751 * 3752 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to 3753 * adjust the default behavior when buffered packets cannot be sent. This 3754 * function drops any unsent packets, but also updates a user-supplied counter 3755 * to track the overall number of packets dropped. The counter should be an 3756 * uint64_t variable. 3757 * 3758 * NOTE: this function should not be called directly, instead it should be used 3759 * as a callback for packet buffering. 3760 * 3761 * NOTE: when configuring this function as a callback with 3762 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter 3763 * should point to an uint64_t value. 3764 * 3765 * @param pkts 3766 * The previously buffered packets which could not be sent 3767 * @param unsent 3768 * The number of unsent packets in the pkts array 3769 * @param userdata 3770 * Pointer to an uint64_t value, which will be incremented by unsent 3771 */ 3772 void 3773 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent, 3774 void *userdata); 3775 3776 /** 3777 * Request the driver to free mbufs currently cached by the driver. The 3778 * driver will only free the mbuf if it is no longer in use. It is the 3779 * application's responsibility to ensure rte_eth_tx_buffer_flush(..) is 3780 * called if needed. 3781 * 3782 * @param port_id 3783 * The port identifier of the Ethernet device. 3784 * @param queue_id 3785 * The index of the transmit queue through which output packets must be 3786 * sent. 3787 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 3788 * to rte_eth_dev_configure(). 3789 * @param free_cnt 3790 * Maximum number of packets to free. Use 0 to indicate all possible packets 3791 * should be freed. Note that a packet may be using multiple mbufs. 3792 * @return 3793 * Failure: < 0 3794 * -ENODEV: Invalid interface 3795 * -EIO: device is removed 3796 * -ENOTSUP: Driver does not support function 3797 * Success: >= 0 3798 * 0-n: Number of packets freed. More packets may still remain in ring that 3799 * are in use. 3800 */ 3801 int 3802 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt); 3803 3804 /** 3805 * Subtypes for MACsec offload event (@ref RTE_ETH_EVENT_MACSEC) 3806 * raised by Ethernet device. 3807 */ 3808 enum rte_eth_event_macsec_subtype { 3809 /** Notifies unknown MACsec subevent. */ 3810 RTE_ETH_SUBEVENT_MACSEC_UNKNOWN, 3811 /** 3812 * Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events 3813 * Validation check: SecTag.TCI.V = 1 3814 */ 3815 RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_V_EQ1, 3816 /** 3817 * Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events 3818 * Validation check: SecTag.TCI.E = 0 && SecTag.TCI.C = 1 3819 */ 3820 RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_E_EQ0_C_EQ1, 3821 /** 3822 * Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events 3823 * Validation check: SecTag.SL >= 'd48 3824 */ 3825 RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_SL_GTE48, 3826 /** 3827 * Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events 3828 * Validation check: SecTag.TCI.ES = 1 && SecTag.TCI.SC = 1 3829 */ 3830 RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_ES_EQ1_SC_EQ1, 3831 /** 3832 * Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events 3833 * Validation check: SecTag.TCI.SC = 1 && SecTag.TCI.SCB = 1 3834 */ 3835 RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_SC_EQ1_SCB_EQ1, 3836 }; 3837 3838 /** 3839 * Event types for MACsec offload event (@ref RTE_ETH_EVENT_MACSEC) 3840 * raised by eth device. 3841 */ 3842 enum rte_eth_event_macsec_type { 3843 /** Notifies unknown MACsec event. */ 3844 RTE_ETH_EVENT_MACSEC_UNKNOWN, 3845 /** Notifies Sectag validation failure events. */ 3846 RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR, 3847 /** Notifies Rx SA hard expiry events. */ 3848 RTE_ETH_EVENT_MACSEC_RX_SA_PN_HARD_EXP, 3849 /** Notifies Rx SA soft expiry events. */ 3850 RTE_ETH_EVENT_MACSEC_RX_SA_PN_SOFT_EXP, 3851 /** Notifies Tx SA hard expiry events. */ 3852 RTE_ETH_EVENT_MACSEC_TX_SA_PN_HARD_EXP, 3853 /** Notifies Tx SA soft events. */ 3854 RTE_ETH_EVENT_MACSEC_TX_SA_PN_SOFT_EXP, 3855 /** Notifies Invalid SA event. */ 3856 RTE_ETH_EVENT_MACSEC_SA_NOT_VALID, 3857 }; 3858 3859 /** 3860 * Descriptor for @ref RTE_ETH_EVENT_MACSEC event. 3861 * Used by ethdev to send extra information of the MACsec offload event. 3862 */ 3863 struct rte_eth_event_macsec_desc { 3864 /** Type of RTE_ETH_EVENT_MACSEC_* event. */ 3865 enum rte_eth_event_macsec_type type; 3866 /** Type of RTE_ETH_SUBEVENT_MACSEC_* subevent. */ 3867 enum rte_eth_event_macsec_subtype subtype; 3868 /** 3869 * Event specific metadata. 3870 * 3871 * For the following events, *userdata* registered 3872 * with the *rte_security_session* would be returned 3873 * as metadata. 3874 * 3875 * @see struct rte_security_session_conf 3876 */ 3877 uint64_t metadata; 3878 }; 3879 3880 /** 3881 * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by 3882 * eth device. 3883 */ 3884 enum rte_eth_event_ipsec_subtype { 3885 /** Unknown event type */ 3886 RTE_ETH_EVENT_IPSEC_UNKNOWN = 0, 3887 /** Sequence number overflow */ 3888 RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW, 3889 /** Soft time expiry of SA */ 3890 RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY, 3891 /** 3892 * Soft byte expiry of SA determined by 3893 * @ref rte_security_ipsec_lifetime::bytes_soft_limit 3894 */ 3895 RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY, 3896 /** 3897 * Soft packet expiry of SA determined by 3898 * @ref rte_security_ipsec_lifetime::packets_soft_limit 3899 */ 3900 RTE_ETH_EVENT_IPSEC_SA_PKT_EXPIRY, 3901 /** 3902 * Hard byte expiry of SA determined by 3903 * @ref rte_security_ipsec_lifetime::bytes_hard_limit 3904 */ 3905 RTE_ETH_EVENT_IPSEC_SA_BYTE_HARD_EXPIRY, 3906 /** 3907 * Hard packet expiry of SA determined by 3908 * @ref rte_security_ipsec_lifetime::packets_hard_limit 3909 */ 3910 RTE_ETH_EVENT_IPSEC_SA_PKT_HARD_EXPIRY, 3911 /** Max value of this enum */ 3912 RTE_ETH_EVENT_IPSEC_MAX 3913 }; 3914 3915 /** 3916 * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra 3917 * information of the IPsec offload event. 3918 */ 3919 struct rte_eth_event_ipsec_desc { 3920 /** Type of RTE_ETH_EVENT_IPSEC_* event */ 3921 enum rte_eth_event_ipsec_subtype subtype; 3922 /** 3923 * Event specific metadata. 3924 * 3925 * For the following events, *userdata* registered 3926 * with the *rte_security_session* would be returned 3927 * as metadata, 3928 * 3929 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW 3930 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY 3931 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY 3932 * - @ref RTE_ETH_EVENT_IPSEC_SA_PKT_EXPIRY 3933 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_HARD_EXPIRY 3934 * - @ref RTE_ETH_EVENT_IPSEC_SA_PKT_HARD_EXPIRY 3935 * 3936 * @see struct rte_security_session_conf 3937 * 3938 */ 3939 uint64_t metadata; 3940 }; 3941 3942 /** 3943 * The eth device event type for interrupt, and maybe others in the future. 3944 */ 3945 enum rte_eth_event_type { 3946 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */ 3947 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */ 3948 /** queue state event (enabled/disabled) */ 3949 RTE_ETH_EVENT_QUEUE_STATE, 3950 /** reset interrupt event, sent to VF on PF reset */ 3951 RTE_ETH_EVENT_INTR_RESET, 3952 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */ 3953 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */ 3954 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */ 3955 RTE_ETH_EVENT_NEW, /**< port is probed */ 3956 RTE_ETH_EVENT_DESTROY, /**< port is released */ 3957 RTE_ETH_EVENT_IPSEC, /**< IPsec offload related event */ 3958 RTE_ETH_EVENT_FLOW_AGED,/**< New aged-out flows is detected */ 3959 /** 3960 * Number of available Rx descriptors is smaller than the threshold. 3961 * @see rte_eth_rx_avail_thresh_set() 3962 */ 3963 RTE_ETH_EVENT_RX_AVAIL_THRESH, 3964 /** Port recovering from a hardware or firmware error. 3965 * If PMD supports proactive error recovery, 3966 * it should trigger this event to notify application 3967 * that it detected an error and the recovery is being started. 3968 * Upon receiving the event, the application should not invoke any control path API 3969 * (such as rte_eth_dev_configure/rte_eth_dev_stop...) until receiving 3970 * RTE_ETH_EVENT_RECOVERY_SUCCESS or RTE_ETH_EVENT_RECOVERY_FAILED event. 3971 * The PMD will set the data path pointers to dummy functions, 3972 * and re-set the data path pointers to non-dummy functions 3973 * before reporting RTE_ETH_EVENT_RECOVERY_SUCCESS event. 3974 * It means that the application cannot send or receive any packets 3975 * during this period. 3976 * @note Before the PMD reports the recovery result, 3977 * the PMD may report the RTE_ETH_EVENT_ERR_RECOVERING event again, 3978 * because a larger error may occur during the recovery. 3979 */ 3980 RTE_ETH_EVENT_ERR_RECOVERING, 3981 /** Port recovers successfully from the error. 3982 * The PMD already re-configured the port, 3983 * and the effect is the same as a restart operation. 3984 * a) The following operation will be retained: (alphabetically) 3985 * - DCB configuration 3986 * - FEC configuration 3987 * - Flow control configuration 3988 * - LRO configuration 3989 * - LSC configuration 3990 * - MTU 3991 * - MAC address (default and those supplied by MAC address array) 3992 * - Promiscuous and allmulticast mode 3993 * - PTP configuration 3994 * - Queue (Rx/Tx) settings 3995 * - Queue statistics mappings 3996 * - RSS configuration by rte_eth_dev_rss_xxx() family 3997 * - Rx checksum configuration 3998 * - Rx interrupt settings 3999 * - Traffic management configuration 4000 * - VLAN configuration (including filtering, tpid, strip, pvid) 4001 * - VMDq configuration 4002 * b) The following configuration maybe retained 4003 * or not depending on the device capabilities: 4004 * - flow rules 4005 * (@see RTE_ETH_DEV_CAPA_FLOW_RULE_KEEP) 4006 * - shared flow objects 4007 * (@see RTE_ETH_DEV_CAPA_FLOW_SHARED_OBJECT_KEEP) 4008 * c) Any other configuration will not be stored 4009 * and will need to be re-configured. 4010 */ 4011 RTE_ETH_EVENT_RECOVERY_SUCCESS, 4012 /** Port recovery failed. 4013 * It means that the port should not be usable anymore. 4014 * The application should close the port. 4015 */ 4016 RTE_ETH_EVENT_RECOVERY_FAILED, 4017 RTE_ETH_EVENT_MAX /**< max value of this enum */ 4018 }; 4019 4020 /** User application callback to be registered for interrupts. */ 4021 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id, 4022 enum rte_eth_event_type event, void *cb_arg, void *ret_param); 4023 4024 /** 4025 * Register a callback function for port event. 4026 * 4027 * @param port_id 4028 * Port ID. 4029 * RTE_ETH_ALL means register the event for all port ids. 4030 * @param event 4031 * Event interested. 4032 * @param cb_fn 4033 * User supplied callback function to be called. 4034 * @param cb_arg 4035 * Pointer to the parameters for the registered callback. 4036 * 4037 * @return 4038 * - On success, zero. 4039 * - On failure, a negative value. 4040 */ 4041 int rte_eth_dev_callback_register(uint16_t port_id, 4042 enum rte_eth_event_type event, 4043 rte_eth_dev_cb_fn cb_fn, void *cb_arg); 4044 4045 /** 4046 * Unregister a callback function for port event. 4047 * 4048 * @param port_id 4049 * Port ID. 4050 * RTE_ETH_ALL means unregister the event for all port ids. 4051 * @param event 4052 * Event interested. 4053 * @param cb_fn 4054 * User supplied callback function to be called. 4055 * @param cb_arg 4056 * Pointer to the parameters for the registered callback. -1 means to 4057 * remove all for the same callback address and same event. 4058 * 4059 * @return 4060 * - On success, zero. 4061 * - On failure, a negative value. 4062 */ 4063 int rte_eth_dev_callback_unregister(uint16_t port_id, 4064 enum rte_eth_event_type event, 4065 rte_eth_dev_cb_fn cb_fn, void *cb_arg); 4066 4067 /** 4068 * When there is no Rx packet coming in Rx Queue for a long time, we can 4069 * sleep lcore related to Rx Queue for power saving, and enable Rx interrupt 4070 * to be triggered when Rx packet arrives. 4071 * 4072 * The rte_eth_dev_rx_intr_enable() function enables Rx queue 4073 * interrupt on specific Rx queue of a port. 4074 * 4075 * @param port_id 4076 * The port identifier of the Ethernet device. 4077 * @param queue_id 4078 * The index of the receive queue from which to retrieve input packets. 4079 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 4080 * to rte_eth_dev_configure(). 4081 * @return 4082 * - (0) if successful. 4083 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 4084 * that operation. 4085 * - (-ENODEV) if *port_id* invalid. 4086 * - (-EIO) if device is removed. 4087 */ 4088 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id); 4089 4090 /** 4091 * When lcore wakes up from Rx interrupt indicating packet coming, disable Rx 4092 * interrupt and returns to polling mode. 4093 * 4094 * The rte_eth_dev_rx_intr_disable() function disables Rx queue 4095 * interrupt on specific Rx queue of a port. 4096 * 4097 * @param port_id 4098 * The port identifier of the Ethernet device. 4099 * @param queue_id 4100 * The index of the receive queue from which to retrieve input packets. 4101 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 4102 * to rte_eth_dev_configure(). 4103 * @return 4104 * - (0) if successful. 4105 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 4106 * that operation. 4107 * - (-ENODEV) if *port_id* invalid. 4108 * - (-EIO) if device is removed. 4109 */ 4110 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id); 4111 4112 /** 4113 * Rx Interrupt control per port. 4114 * 4115 * @param port_id 4116 * The port identifier of the Ethernet device. 4117 * @param epfd 4118 * Epoll instance fd which the intr vector associated to. 4119 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance. 4120 * @param op 4121 * The operation be performed for the vector. 4122 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}. 4123 * @param data 4124 * User raw data. 4125 * @return 4126 * - On success, zero. 4127 * - On failure, a negative value. 4128 */ 4129 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data); 4130 4131 /** 4132 * Rx Interrupt control per queue. 4133 * 4134 * @param port_id 4135 * The port identifier of the Ethernet device. 4136 * @param queue_id 4137 * The index of the receive queue from which to retrieve input packets. 4138 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 4139 * to rte_eth_dev_configure(). 4140 * @param epfd 4141 * Epoll instance fd which the intr vector associated to. 4142 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance. 4143 * @param op 4144 * The operation be performed for the vector. 4145 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}. 4146 * @param data 4147 * User raw data. 4148 * @return 4149 * - On success, zero. 4150 * - On failure, a negative value. 4151 */ 4152 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id, 4153 int epfd, int op, void *data); 4154 4155 /** 4156 * Get interrupt fd per Rx queue. 4157 * 4158 * @param port_id 4159 * The port identifier of the Ethernet device. 4160 * @param queue_id 4161 * The index of the receive queue from which to retrieve input packets. 4162 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 4163 * to rte_eth_dev_configure(). 4164 * @return 4165 * - (>=0) the interrupt fd associated to the requested Rx queue if 4166 * successful. 4167 * - (-1) on error. 4168 */ 4169 int 4170 rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id); 4171 4172 /** 4173 * Turn on the LED on the Ethernet device. 4174 * This function turns on the LED on the Ethernet device. 4175 * 4176 * @param port_id 4177 * The port identifier of the Ethernet device. 4178 * @return 4179 * - (0) if successful. 4180 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 4181 * that operation. 4182 * - (-ENODEV) if *port_id* invalid. 4183 * - (-EIO) if device is removed. 4184 */ 4185 int rte_eth_led_on(uint16_t port_id); 4186 4187 /** 4188 * Turn off the LED on the Ethernet device. 4189 * This function turns off the LED on the Ethernet device. 4190 * 4191 * @param port_id 4192 * The port identifier of the Ethernet device. 4193 * @return 4194 * - (0) if successful. 4195 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 4196 * that operation. 4197 * - (-ENODEV) if *port_id* invalid. 4198 * - (-EIO) if device is removed. 4199 */ 4200 int rte_eth_led_off(uint16_t port_id); 4201 4202 /** 4203 * @warning 4204 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 4205 * 4206 * Get Forward Error Correction(FEC) capability. 4207 * 4208 * @param port_id 4209 * The port identifier of the Ethernet device. 4210 * @param speed_fec_capa 4211 * speed_fec_capa is out only with per-speed capabilities. 4212 * If set to NULL, the function returns the required number 4213 * of required array entries. 4214 * @param num 4215 * a number of elements in an speed_fec_capa array. 4216 * 4217 * @return 4218 * - A non-negative value lower or equal to num: success. The return value 4219 * is the number of entries filled in the fec capa array. 4220 * - A non-negative value higher than num: error, the given fec capa array 4221 * is too small. The return value corresponds to the num that should 4222 * be given to succeed. The entries in fec capa array are not valid and 4223 * shall not be used by the caller. 4224 * - (-ENOTSUP) if underlying hardware OR driver doesn't support. 4225 * that operation. 4226 * - (-EIO) if device is removed. 4227 * - (-ENODEV) if *port_id* invalid. 4228 * - (-EINVAL) if *num* or *speed_fec_capa* invalid 4229 */ 4230 __rte_experimental 4231 int rte_eth_fec_get_capability(uint16_t port_id, 4232 struct rte_eth_fec_capa *speed_fec_capa, 4233 unsigned int num); 4234 4235 /** 4236 * @warning 4237 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 4238 * 4239 * Get current Forward Error Correction(FEC) mode. 4240 * If link is down and AUTO is enabled, AUTO is returned, otherwise, 4241 * configured FEC mode is returned. 4242 * If link is up, current FEC mode is returned. 4243 * 4244 * @param port_id 4245 * The port identifier of the Ethernet device. 4246 * @param fec_capa 4247 * A bitmask with the current FEC mode. 4248 * @return 4249 * - (0) if successful. 4250 * - (-ENOTSUP) if underlying hardware OR driver doesn't support. 4251 * that operation. 4252 * - (-EIO) if device is removed. 4253 * - (-ENODEV) if *port_id* invalid. 4254 */ 4255 __rte_experimental 4256 int rte_eth_fec_get(uint16_t port_id, uint32_t *fec_capa); 4257 4258 /** 4259 * @warning 4260 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 4261 * 4262 * Set Forward Error Correction(FEC) mode. 4263 * 4264 * @param port_id 4265 * The port identifier of the Ethernet device. 4266 * @param fec_capa 4267 * A bitmask of allowed FEC modes. 4268 * If only the AUTO bit is set, the decision on which FEC 4269 * mode to use will be made by HW/FW or driver. 4270 * If the AUTO bit is set with some FEC modes, only specified 4271 * FEC modes can be set. 4272 * If AUTO bit is clear, specify FEC mode to be used 4273 * (only one valid mode per speed may be set). 4274 * @return 4275 * - (0) if successful. 4276 * - (-EINVAL) if the FEC mode is not valid. 4277 * - (-ENOTSUP) if underlying hardware OR driver doesn't support. 4278 * - (-EIO) if device is removed. 4279 * - (-ENODEV) if *port_id* invalid. 4280 */ 4281 __rte_experimental 4282 int rte_eth_fec_set(uint16_t port_id, uint32_t fec_capa); 4283 4284 /** 4285 * Get current status of the Ethernet link flow control for Ethernet device 4286 * 4287 * @param port_id 4288 * The port identifier of the Ethernet device. 4289 * @param fc_conf 4290 * The pointer to the structure where to store the flow control parameters. 4291 * @return 4292 * - (0) if successful. 4293 * - (-ENOTSUP) if hardware doesn't support flow control. 4294 * - (-ENODEV) if *port_id* invalid. 4295 * - (-EIO) if device is removed. 4296 * - (-EINVAL) if bad parameter. 4297 */ 4298 int rte_eth_dev_flow_ctrl_get(uint16_t port_id, 4299 struct rte_eth_fc_conf *fc_conf); 4300 4301 /** 4302 * Configure the Ethernet link flow control for Ethernet device 4303 * 4304 * @param port_id 4305 * The port identifier of the Ethernet device. 4306 * @param fc_conf 4307 * The pointer to the structure of the flow control parameters. 4308 * @return 4309 * - (0) if successful. 4310 * - (-ENOTSUP) if hardware doesn't support flow control mode. 4311 * - (-ENODEV) if *port_id* invalid. 4312 * - (-EINVAL) if bad parameter 4313 * - (-EIO) if flow control setup failure or device is removed. 4314 */ 4315 int rte_eth_dev_flow_ctrl_set(uint16_t port_id, 4316 struct rte_eth_fc_conf *fc_conf); 4317 4318 /** 4319 * Configure the Ethernet priority flow control under DCB environment 4320 * for Ethernet device. 4321 * 4322 * @param port_id 4323 * The port identifier of the Ethernet device. 4324 * @param pfc_conf 4325 * The pointer to the structure of the priority flow control parameters. 4326 * @return 4327 * - (0) if successful. 4328 * - (-ENOTSUP) if hardware doesn't support priority flow control mode. 4329 * - (-ENODEV) if *port_id* invalid. 4330 * - (-EINVAL) if bad parameter 4331 * - (-EIO) if flow control setup failure or device is removed. 4332 */ 4333 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id, 4334 struct rte_eth_pfc_conf *pfc_conf); 4335 4336 /** 4337 * Add a MAC address to the set used for filtering incoming packets. 4338 * 4339 * @param port_id 4340 * The port identifier of the Ethernet device. 4341 * @param mac_addr 4342 * The MAC address to add. 4343 * @param pool 4344 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is 4345 * not enabled, this should be set to 0. 4346 * @return 4347 * - (0) if successfully added or *mac_addr* was already added. 4348 * - (-ENOTSUP) if hardware doesn't support this feature. 4349 * - (-ENODEV) if *port* is invalid. 4350 * - (-EIO) if device is removed. 4351 * - (-ENOSPC) if no more MAC addresses can be added. 4352 * - (-EINVAL) if MAC address is invalid. 4353 */ 4354 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *mac_addr, 4355 uint32_t pool); 4356 4357 /** 4358 * @warning 4359 * @b EXPERIMENTAL: this API may change without prior notice. 4360 * 4361 * Retrieve the information for queue based PFC. 4362 * 4363 * @param port_id 4364 * The port identifier of the Ethernet device. 4365 * @param pfc_queue_info 4366 * A pointer to a structure of type *rte_eth_pfc_queue_info* to be filled with 4367 * the information about queue based PFC. 4368 * @return 4369 * - (0) if successful. 4370 * - (-ENOTSUP) if support for priority_flow_ctrl_queue_info_get does not exist. 4371 * - (-ENODEV) if *port_id* invalid. 4372 * - (-EINVAL) if bad parameter. 4373 */ 4374 __rte_experimental 4375 int rte_eth_dev_priority_flow_ctrl_queue_info_get(uint16_t port_id, 4376 struct rte_eth_pfc_queue_info *pfc_queue_info); 4377 4378 /** 4379 * @warning 4380 * @b EXPERIMENTAL: this API may change without prior notice. 4381 * 4382 * Configure the queue based priority flow control for a given queue 4383 * for Ethernet device. 4384 * 4385 * @note When an ethdev port switches to queue based PFC mode, the 4386 * unconfigured queues shall be configured by the driver with 4387 * default values such as lower priority value for TC etc. 4388 * 4389 * @param port_id 4390 * The port identifier of the Ethernet device. 4391 * @param pfc_queue_conf 4392 * The pointer to the structure of the priority flow control parameters 4393 * for the queue. 4394 * @return 4395 * - (0) if successful. 4396 * - (-ENOTSUP) if hardware doesn't support queue based PFC mode. 4397 * - (-ENODEV) if *port_id* invalid. 4398 * - (-EINVAL) if bad parameter 4399 * - (-EIO) if flow control setup queue failure 4400 */ 4401 __rte_experimental 4402 int rte_eth_dev_priority_flow_ctrl_queue_configure(uint16_t port_id, 4403 struct rte_eth_pfc_queue_conf *pfc_queue_conf); 4404 4405 /** 4406 * Remove a MAC address from the internal array of addresses. 4407 * 4408 * @param port_id 4409 * The port identifier of the Ethernet device. 4410 * @param mac_addr 4411 * MAC address to remove. 4412 * @return 4413 * - (0) if successful, or *mac_addr* didn't exist. 4414 * - (-ENOTSUP) if hardware doesn't support. 4415 * - (-ENODEV) if *port* invalid. 4416 * - (-EADDRINUSE) if attempting to remove the default MAC address. 4417 * - (-EINVAL) if MAC address is invalid. 4418 */ 4419 int rte_eth_dev_mac_addr_remove(uint16_t port_id, 4420 struct rte_ether_addr *mac_addr); 4421 4422 /** 4423 * Set the default MAC address. 4424 * It replaces the address at index 0 of the MAC address list. 4425 * If the address was already in the MAC address list, 4426 * please remove it first. 4427 * 4428 * @param port_id 4429 * The port identifier of the Ethernet device. 4430 * @param mac_addr 4431 * New default MAC address. 4432 * @return 4433 * - (0) if successful, or *mac_addr* didn't exist. 4434 * - (-ENOTSUP) if hardware doesn't support. 4435 * - (-ENODEV) if *port* invalid. 4436 * - (-EINVAL) if MAC address is invalid. 4437 * - (-EEXIST) if MAC address was already in the address list. 4438 */ 4439 int rte_eth_dev_default_mac_addr_set(uint16_t port_id, 4440 struct rte_ether_addr *mac_addr); 4441 4442 /** 4443 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device. 4444 * 4445 * @param port_id 4446 * The port identifier of the Ethernet device. 4447 * @param reta_conf 4448 * RETA to update. 4449 * @param reta_size 4450 * Redirection table size. The table size can be queried by 4451 * rte_eth_dev_info_get(). 4452 * @return 4453 * - (0) if successful. 4454 * - (-ENODEV) if *port_id* is invalid. 4455 * - (-ENOTSUP) if hardware doesn't support. 4456 * - (-EINVAL) if bad parameter. 4457 * - (-EIO) if device is removed. 4458 */ 4459 int rte_eth_dev_rss_reta_update(uint16_t port_id, 4460 struct rte_eth_rss_reta_entry64 *reta_conf, 4461 uint16_t reta_size); 4462 4463 /** 4464 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device. 4465 * 4466 * @param port_id 4467 * The port identifier of the Ethernet device. 4468 * @param reta_conf 4469 * RETA to query. For each requested reta entry, corresponding bit 4470 * in mask must be set. 4471 * @param reta_size 4472 * Redirection table size. The table size can be queried by 4473 * rte_eth_dev_info_get(). 4474 * @return 4475 * - (0) if successful. 4476 * - (-ENODEV) if *port_id* is invalid. 4477 * - (-ENOTSUP) if hardware doesn't support. 4478 * - (-EINVAL) if bad parameter. 4479 * - (-EIO) if device is removed. 4480 */ 4481 int rte_eth_dev_rss_reta_query(uint16_t port_id, 4482 struct rte_eth_rss_reta_entry64 *reta_conf, 4483 uint16_t reta_size); 4484 4485 /** 4486 * Updates unicast hash table for receiving packet with the given destination 4487 * MAC address, and the packet is routed to all VFs for which the Rx mode is 4488 * accept packets that match the unicast hash table. 4489 * 4490 * @param port_id 4491 * The port identifier of the Ethernet device. 4492 * @param addr 4493 * Unicast MAC address. 4494 * @param on 4495 * 1 - Set an unicast hash bit for receiving packets with the MAC address. 4496 * 0 - Clear an unicast hash bit. 4497 * @return 4498 * - (0) if successful. 4499 * - (-ENOTSUP) if hardware doesn't support. 4500 * - (-ENODEV) if *port_id* invalid. 4501 * - (-EIO) if device is removed. 4502 * - (-EINVAL) if bad parameter. 4503 */ 4504 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr, 4505 uint8_t on); 4506 4507 /** 4508 * Updates all unicast hash bitmaps for receiving packet with any Unicast 4509 * Ethernet MAC addresses,the packet is routed to all VFs for which the Rx 4510 * mode is accept packets that match the unicast hash table. 4511 * 4512 * @param port_id 4513 * The port identifier of the Ethernet device. 4514 * @param on 4515 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet 4516 * MAC addresses 4517 * 0 - Clear all unicast hash bitmaps 4518 * @return 4519 * - (0) if successful. 4520 * - (-ENOTSUP) if hardware doesn't support. 4521 * - (-ENODEV) if *port_id* invalid. 4522 * - (-EIO) if device is removed. 4523 * - (-EINVAL) if bad parameter. 4524 */ 4525 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on); 4526 4527 /** 4528 * Set the rate limitation for a queue on an Ethernet device. 4529 * 4530 * @param port_id 4531 * The port identifier of the Ethernet device. 4532 * @param queue_idx 4533 * The queue ID. 4534 * @param tx_rate 4535 * The Tx rate in Mbps. Allocated from the total port link speed. 4536 * @return 4537 * - (0) if successful. 4538 * - (-ENOTSUP) if hardware doesn't support this feature. 4539 * - (-ENODEV) if *port_id* invalid. 4540 * - (-EIO) if device is removed. 4541 * - (-EINVAL) if bad parameter. 4542 */ 4543 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx, 4544 uint32_t tx_rate); 4545 4546 /** 4547 * Configuration of Receive Side Scaling hash computation of Ethernet device. 4548 * 4549 * @param port_id 4550 * The port identifier of the Ethernet device. 4551 * @param rss_conf 4552 * The new configuration to use for RSS hash computation on the port. 4553 * @return 4554 * - (0) if successful. 4555 * - (-ENODEV) if port identifier is invalid. 4556 * - (-EIO) if device is removed. 4557 * - (-ENOTSUP) if hardware doesn't support. 4558 * - (-EINVAL) if bad parameter. 4559 */ 4560 int rte_eth_dev_rss_hash_update(uint16_t port_id, 4561 struct rte_eth_rss_conf *rss_conf); 4562 4563 /** 4564 * Retrieve current configuration of Receive Side Scaling hash computation 4565 * of Ethernet device. 4566 * 4567 * @param port_id 4568 * The port identifier of the Ethernet device. 4569 * @param rss_conf 4570 * Where to store the current RSS hash configuration of the Ethernet device. 4571 * @return 4572 * - (0) if successful. 4573 * - (-ENODEV) if port identifier is invalid. 4574 * - (-EIO) if device is removed. 4575 * - (-ENOTSUP) if hardware doesn't support RSS. 4576 * - (-EINVAL) if bad parameter. 4577 */ 4578 int 4579 rte_eth_dev_rss_hash_conf_get(uint16_t port_id, 4580 struct rte_eth_rss_conf *rss_conf); 4581 4582 /** 4583 * Add UDP tunneling port for a type of tunnel. 4584 * 4585 * Some NICs may require such configuration to properly parse a tunnel 4586 * with any standard or custom UDP port. 4587 * The packets with this UDP port will be parsed for this type of tunnel. 4588 * The device parser will also check the rest of the tunnel headers 4589 * before classifying the packet. 4590 * 4591 * With some devices, this API will affect packet classification, i.e.: 4592 * - mbuf.packet_type reported on Rx 4593 * - rte_flow rules with tunnel items 4594 * 4595 * @param port_id 4596 * The port identifier of the Ethernet device. 4597 * @param tunnel_udp 4598 * UDP tunneling configuration. 4599 * 4600 * @return 4601 * - (0) if successful. 4602 * - (-ENODEV) if port identifier is invalid. 4603 * - (-EIO) if device is removed. 4604 * - (-ENOTSUP) if hardware doesn't support tunnel type. 4605 */ 4606 int 4607 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id, 4608 struct rte_eth_udp_tunnel *tunnel_udp); 4609 4610 /** 4611 * Delete UDP tunneling port for a type of tunnel. 4612 * 4613 * The packets with this UDP port will not be classified as this type of tunnel 4614 * anymore if the device use such mapping for tunnel packet classification. 4615 * 4616 * @see rte_eth_dev_udp_tunnel_port_add 4617 * 4618 * @param port_id 4619 * The port identifier of the Ethernet device. 4620 * @param tunnel_udp 4621 * UDP tunneling configuration. 4622 * 4623 * @return 4624 * - (0) if successful. 4625 * - (-ENODEV) if port identifier is invalid. 4626 * - (-EIO) if device is removed. 4627 * - (-ENOTSUP) if hardware doesn't support tunnel type. 4628 */ 4629 int 4630 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id, 4631 struct rte_eth_udp_tunnel *tunnel_udp); 4632 4633 /** 4634 * Get DCB information on an Ethernet device. 4635 * 4636 * @param port_id 4637 * The port identifier of the Ethernet device. 4638 * @param dcb_info 4639 * DCB information. 4640 * @return 4641 * - (0) if successful. 4642 * - (-ENODEV) if port identifier is invalid. 4643 * - (-EIO) if device is removed. 4644 * - (-ENOTSUP) if hardware doesn't support. 4645 * - (-EINVAL) if bad parameter. 4646 */ 4647 int rte_eth_dev_get_dcb_info(uint16_t port_id, 4648 struct rte_eth_dcb_info *dcb_info); 4649 4650 struct rte_eth_rxtx_callback; 4651 4652 /** 4653 * Add a callback to be called on packet Rx on a given port and queue. 4654 * 4655 * This API configures a function to be called for each burst of 4656 * packets received on a given NIC port queue. The return value is a pointer 4657 * that can be used to later remove the callback using 4658 * rte_eth_remove_rx_callback(). 4659 * 4660 * Multiple functions are called in the order that they are added. 4661 * 4662 * @param port_id 4663 * The port identifier of the Ethernet device. 4664 * @param queue_id 4665 * The queue on the Ethernet device on which the callback is to be added. 4666 * @param fn 4667 * The callback function 4668 * @param user_param 4669 * A generic pointer parameter which will be passed to each invocation of the 4670 * callback function on this port and queue. Inter-thread synchronization 4671 * of any user data changes is the responsibility of the user. 4672 * 4673 * @return 4674 * NULL on error. 4675 * On success, a pointer value which can later be used to remove the callback. 4676 */ 4677 const struct rte_eth_rxtx_callback * 4678 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id, 4679 rte_rx_callback_fn fn, void *user_param); 4680 4681 /** 4682 * Add a callback that must be called first on packet Rx on a given port 4683 * and queue. 4684 * 4685 * This API configures a first function to be called for each burst of 4686 * packets received on a given NIC port queue. The return value is a pointer 4687 * that can be used to later remove the callback using 4688 * rte_eth_remove_rx_callback(). 4689 * 4690 * Multiple functions are called in the order that they are added. 4691 * 4692 * @param port_id 4693 * The port identifier of the Ethernet device. 4694 * @param queue_id 4695 * The queue on the Ethernet device on which the callback is to be added. 4696 * @param fn 4697 * The callback function 4698 * @param user_param 4699 * A generic pointer parameter which will be passed to each invocation of the 4700 * callback function on this port and queue. Inter-thread synchronization 4701 * of any user data changes is the responsibility of the user. 4702 * 4703 * @return 4704 * NULL on error. 4705 * On success, a pointer value which can later be used to remove the callback. 4706 */ 4707 const struct rte_eth_rxtx_callback * 4708 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id, 4709 rte_rx_callback_fn fn, void *user_param); 4710 4711 /** 4712 * Add a callback to be called on packet Tx on a given port and queue. 4713 * 4714 * This API configures a function to be called for each burst of 4715 * packets sent on a given NIC port queue. The return value is a pointer 4716 * that can be used to later remove the callback using 4717 * rte_eth_remove_tx_callback(). 4718 * 4719 * Multiple functions are called in the order that they are added. 4720 * 4721 * @param port_id 4722 * The port identifier of the Ethernet device. 4723 * @param queue_id 4724 * The queue on the Ethernet device on which the callback is to be added. 4725 * @param fn 4726 * The callback function 4727 * @param user_param 4728 * A generic pointer parameter which will be passed to each invocation of the 4729 * callback function on this port and queue. Inter-thread synchronization 4730 * of any user data changes is the responsibility of the user. 4731 * 4732 * @return 4733 * NULL on error. 4734 * On success, a pointer value which can later be used to remove the callback. 4735 */ 4736 const struct rte_eth_rxtx_callback * 4737 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id, 4738 rte_tx_callback_fn fn, void *user_param); 4739 4740 /** 4741 * Remove an Rx packet callback from a given port and queue. 4742 * 4743 * This function is used to removed callbacks that were added to a NIC port 4744 * queue using rte_eth_add_rx_callback(). 4745 * 4746 * Note: the callback is removed from the callback list but it isn't freed 4747 * since the it may still be in use. The memory for the callback can be 4748 * subsequently freed back by the application by calling rte_free(): 4749 * 4750 * - Immediately - if the port is stopped, or the user knows that no 4751 * callbacks are in flight e.g. if called from the thread doing Rx/Tx 4752 * on that queue. 4753 * 4754 * - After a short delay - where the delay is sufficient to allow any 4755 * in-flight callbacks to complete. Alternately, the RCU mechanism can be 4756 * used to detect when data plane threads have ceased referencing the 4757 * callback memory. 4758 * 4759 * @param port_id 4760 * The port identifier of the Ethernet device. 4761 * @param queue_id 4762 * The queue on the Ethernet device from which the callback is to be removed. 4763 * @param user_cb 4764 * User supplied callback created via rte_eth_add_rx_callback(). 4765 * 4766 * @return 4767 * - 0: Success. Callback was removed. 4768 * - -ENODEV: If *port_id* is invalid. 4769 * - -ENOTSUP: Callback support is not available. 4770 * - -EINVAL: The queue_id is out of range, or the callback 4771 * is NULL or not found for the port/queue. 4772 */ 4773 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id, 4774 const struct rte_eth_rxtx_callback *user_cb); 4775 4776 /** 4777 * Remove a Tx packet callback from a given port and queue. 4778 * 4779 * This function is used to removed callbacks that were added to a NIC port 4780 * queue using rte_eth_add_tx_callback(). 4781 * 4782 * Note: the callback is removed from the callback list but it isn't freed 4783 * since the it may still be in use. The memory for the callback can be 4784 * subsequently freed back by the application by calling rte_free(): 4785 * 4786 * - Immediately - if the port is stopped, or the user knows that no 4787 * callbacks are in flight e.g. if called from the thread doing Rx/Tx 4788 * on that queue. 4789 * 4790 * - After a short delay - where the delay is sufficient to allow any 4791 * in-flight callbacks to complete. Alternately, the RCU mechanism can be 4792 * used to detect when data plane threads have ceased referencing the 4793 * callback memory. 4794 * 4795 * @param port_id 4796 * The port identifier of the Ethernet device. 4797 * @param queue_id 4798 * The queue on the Ethernet device from which the callback is to be removed. 4799 * @param user_cb 4800 * User supplied callback created via rte_eth_add_tx_callback(). 4801 * 4802 * @return 4803 * - 0: Success. Callback was removed. 4804 * - -ENODEV: If *port_id* is invalid. 4805 * - -ENOTSUP: Callback support is not available. 4806 * - -EINVAL: The queue_id is out of range, or the callback 4807 * is NULL or not found for the port/queue. 4808 */ 4809 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id, 4810 const struct rte_eth_rxtx_callback *user_cb); 4811 4812 /** 4813 * Retrieve information about given port's Rx queue. 4814 * 4815 * @param port_id 4816 * The port identifier of the Ethernet device. 4817 * @param queue_id 4818 * The Rx queue on the Ethernet device for which information 4819 * will be retrieved. 4820 * @param qinfo 4821 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with 4822 * the information of the Ethernet device. 4823 * 4824 * @return 4825 * - 0: Success 4826 * - -ENODEV: If *port_id* is invalid. 4827 * - -ENOTSUP: routine is not supported by the device PMD. 4828 * - -EINVAL: The queue_id is out of range, or the queue 4829 * is hairpin queue. 4830 */ 4831 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id, 4832 struct rte_eth_rxq_info *qinfo); 4833 4834 /** 4835 * Retrieve information about given port's Tx queue. 4836 * 4837 * @param port_id 4838 * The port identifier of the Ethernet device. 4839 * @param queue_id 4840 * The Tx queue on the Ethernet device for which information 4841 * will be retrieved. 4842 * @param qinfo 4843 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with 4844 * the information of the Ethernet device. 4845 * 4846 * @return 4847 * - 0: Success 4848 * - -ENODEV: If *port_id* is invalid. 4849 * - -ENOTSUP: routine is not supported by the device PMD. 4850 * - -EINVAL: The queue_id is out of range, or the queue 4851 * is hairpin queue. 4852 */ 4853 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id, 4854 struct rte_eth_txq_info *qinfo); 4855 4856 /** 4857 * Retrieve information about the Rx packet burst mode. 4858 * 4859 * @param port_id 4860 * The port identifier of the Ethernet device. 4861 * @param queue_id 4862 * The Rx queue on the Ethernet device for which information 4863 * will be retrieved. 4864 * @param mode 4865 * A pointer to a structure of type *rte_eth_burst_mode* to be filled 4866 * with the information of the packet burst mode. 4867 * 4868 * @return 4869 * - 0: Success 4870 * - -ENODEV: If *port_id* is invalid. 4871 * - -ENOTSUP: routine is not supported by the device PMD. 4872 * - -EINVAL: The queue_id is out of range. 4873 */ 4874 int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id, 4875 struct rte_eth_burst_mode *mode); 4876 4877 /** 4878 * Retrieve information about the Tx packet burst mode. 4879 * 4880 * @param port_id 4881 * The port identifier of the Ethernet device. 4882 * @param queue_id 4883 * The Tx queue on the Ethernet device for which information 4884 * will be retrieved. 4885 * @param mode 4886 * A pointer to a structure of type *rte_eth_burst_mode* to be filled 4887 * with the information of the packet burst mode. 4888 * 4889 * @return 4890 * - 0: Success 4891 * - -ENODEV: If *port_id* is invalid. 4892 * - -ENOTSUP: routine is not supported by the device PMD. 4893 * - -EINVAL: The queue_id is out of range. 4894 */ 4895 int rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id, 4896 struct rte_eth_burst_mode *mode); 4897 4898 /** 4899 * @warning 4900 * @b EXPERIMENTAL: this API may change without prior notice. 4901 * 4902 * Retrieve the monitor condition for a given receive queue. 4903 * 4904 * @param port_id 4905 * The port identifier of the Ethernet device. 4906 * @param queue_id 4907 * The Rx queue on the Ethernet device for which information 4908 * will be retrieved. 4909 * @param pmc 4910 * The pointer to power-optimized monitoring condition structure. 4911 * 4912 * @return 4913 * - 0: Success. 4914 * -ENOTSUP: Operation not supported. 4915 * -EINVAL: Invalid parameters. 4916 * -ENODEV: Invalid port ID. 4917 */ 4918 __rte_experimental 4919 int rte_eth_get_monitor_addr(uint16_t port_id, uint16_t queue_id, 4920 struct rte_power_monitor_cond *pmc); 4921 4922 /** 4923 * Retrieve device registers and register attributes (number of registers and 4924 * register size) 4925 * 4926 * @param port_id 4927 * The port identifier of the Ethernet device. 4928 * @param info 4929 * Pointer to rte_dev_reg_info structure to fill in. If info->data is 4930 * NULL the function fills in the width and length fields. If non-NULL 4931 * the registers are put into the buffer pointed at by the data field. 4932 * @return 4933 * - (0) if successful. 4934 * - (-ENOTSUP) if hardware doesn't support. 4935 * - (-EINVAL) if bad parameter. 4936 * - (-ENODEV) if *port_id* invalid. 4937 * - (-EIO) if device is removed. 4938 * - others depends on the specific operations implementation. 4939 */ 4940 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info); 4941 4942 /** 4943 * Retrieve size of device EEPROM 4944 * 4945 * @param port_id 4946 * The port identifier of the Ethernet device. 4947 * @return 4948 * - (>=0) EEPROM size if successful. 4949 * - (-ENOTSUP) if hardware doesn't support. 4950 * - (-ENODEV) if *port_id* invalid. 4951 * - (-EIO) if device is removed. 4952 * - others depends on the specific operations implementation. 4953 */ 4954 int rte_eth_dev_get_eeprom_length(uint16_t port_id); 4955 4956 /** 4957 * Retrieve EEPROM and EEPROM attribute 4958 * 4959 * @param port_id 4960 * The port identifier of the Ethernet device. 4961 * @param info 4962 * The template includes buffer for return EEPROM data and 4963 * EEPROM attributes to be filled. 4964 * @return 4965 * - (0) if successful. 4966 * - (-ENOTSUP) if hardware doesn't support. 4967 * - (-EINVAL) if bad parameter. 4968 * - (-ENODEV) if *port_id* invalid. 4969 * - (-EIO) if device is removed. 4970 * - others depends on the specific operations implementation. 4971 */ 4972 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info); 4973 4974 /** 4975 * Program EEPROM with provided data 4976 * 4977 * @param port_id 4978 * The port identifier of the Ethernet device. 4979 * @param info 4980 * The template includes EEPROM data for programming and 4981 * EEPROM attributes to be filled 4982 * @return 4983 * - (0) if successful. 4984 * - (-ENOTSUP) if hardware doesn't support. 4985 * - (-ENODEV) if *port_id* invalid. 4986 * - (-EINVAL) if bad parameter. 4987 * - (-EIO) if device is removed. 4988 * - others depends on the specific operations implementation. 4989 */ 4990 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info); 4991 4992 /** 4993 * @warning 4994 * @b EXPERIMENTAL: this API may change without prior notice. 4995 * 4996 * Retrieve the type and size of plugin module EEPROM 4997 * 4998 * @param port_id 4999 * The port identifier of the Ethernet device. 5000 * @param modinfo 5001 * The type and size of plugin module EEPROM. 5002 * @return 5003 * - (0) if successful. 5004 * - (-ENOTSUP) if hardware doesn't support. 5005 * - (-ENODEV) if *port_id* invalid. 5006 * - (-EINVAL) if bad parameter. 5007 * - (-EIO) if device is removed. 5008 * - others depends on the specific operations implementation. 5009 */ 5010 __rte_experimental 5011 int 5012 rte_eth_dev_get_module_info(uint16_t port_id, 5013 struct rte_eth_dev_module_info *modinfo); 5014 5015 /** 5016 * @warning 5017 * @b EXPERIMENTAL: this API may change without prior notice. 5018 * 5019 * Retrieve the data of plugin module EEPROM 5020 * 5021 * @param port_id 5022 * The port identifier of the Ethernet device. 5023 * @param info 5024 * The template includes the plugin module EEPROM attributes, and the 5025 * buffer for return plugin module EEPROM data. 5026 * @return 5027 * - (0) if successful. 5028 * - (-ENOTSUP) if hardware doesn't support. 5029 * - (-EINVAL) if bad parameter. 5030 * - (-ENODEV) if *port_id* invalid. 5031 * - (-EIO) if device is removed. 5032 * - others depends on the specific operations implementation. 5033 */ 5034 __rte_experimental 5035 int 5036 rte_eth_dev_get_module_eeprom(uint16_t port_id, 5037 struct rte_dev_eeprom_info *info); 5038 5039 /** 5040 * Set the list of multicast addresses to filter on an Ethernet device. 5041 * 5042 * @param port_id 5043 * The port identifier of the Ethernet device. 5044 * @param mc_addr_set 5045 * The array of multicast addresses to set. Equal to NULL when the function 5046 * is invoked to flush the set of filtered addresses. 5047 * @param nb_mc_addr 5048 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0 5049 * when the function is invoked to flush the set of filtered addresses. 5050 * @return 5051 * - (0) if successful. 5052 * - (-ENODEV) if *port_id* invalid. 5053 * - (-EIO) if device is removed. 5054 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering. 5055 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources. 5056 * - (-EINVAL) if bad parameter. 5057 */ 5058 int rte_eth_dev_set_mc_addr_list(uint16_t port_id, 5059 struct rte_ether_addr *mc_addr_set, 5060 uint32_t nb_mc_addr); 5061 5062 /** 5063 * Enable IEEE1588/802.1AS timestamping for an Ethernet device. 5064 * 5065 * @param port_id 5066 * The port identifier of the Ethernet device. 5067 * 5068 * @return 5069 * - 0: Success. 5070 * - -ENODEV: The port ID is invalid. 5071 * - -EIO: if device is removed. 5072 * - -ENOTSUP: The function is not supported by the Ethernet driver. 5073 */ 5074 int rte_eth_timesync_enable(uint16_t port_id); 5075 5076 /** 5077 * Disable IEEE1588/802.1AS timestamping for an Ethernet device. 5078 * 5079 * @param port_id 5080 * The port identifier of the Ethernet device. 5081 * 5082 * @return 5083 * - 0: Success. 5084 * - -ENODEV: The port ID is invalid. 5085 * - -EIO: if device is removed. 5086 * - -ENOTSUP: The function is not supported by the Ethernet driver. 5087 */ 5088 int rte_eth_timesync_disable(uint16_t port_id); 5089 5090 /** 5091 * Read an IEEE1588/802.1AS Rx timestamp from an Ethernet device. 5092 * 5093 * @param port_id 5094 * The port identifier of the Ethernet device. 5095 * @param timestamp 5096 * Pointer to the timestamp struct. 5097 * @param flags 5098 * Device specific flags. Used to pass the Rx timesync register index to 5099 * i40e. Unused in igb/ixgbe, pass 0 instead. 5100 * 5101 * @return 5102 * - 0: Success. 5103 * - -EINVAL: No timestamp is available. 5104 * - -ENODEV: The port ID is invalid. 5105 * - -EIO: if device is removed. 5106 * - -ENOTSUP: The function is not supported by the Ethernet driver. 5107 */ 5108 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id, 5109 struct timespec *timestamp, uint32_t flags); 5110 5111 /** 5112 * Read an IEEE1588/802.1AS Tx timestamp from an Ethernet device. 5113 * 5114 * @param port_id 5115 * The port identifier of the Ethernet device. 5116 * @param timestamp 5117 * Pointer to the timestamp struct. 5118 * 5119 * @return 5120 * - 0: Success. 5121 * - -EINVAL: No timestamp is available. 5122 * - -ENODEV: The port ID is invalid. 5123 * - -EIO: if device is removed. 5124 * - -ENOTSUP: The function is not supported by the Ethernet driver. 5125 */ 5126 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id, 5127 struct timespec *timestamp); 5128 5129 /** 5130 * Adjust the timesync clock on an Ethernet device. 5131 * 5132 * This is usually used in conjunction with other Ethdev timesync functions to 5133 * synchronize the device time using the IEEE1588/802.1AS protocol. 5134 * 5135 * @param port_id 5136 * The port identifier of the Ethernet device. 5137 * @param delta 5138 * The adjustment in nanoseconds. 5139 * 5140 * @return 5141 * - 0: Success. 5142 * - -ENODEV: The port ID is invalid. 5143 * - -EIO: if device is removed. 5144 * - -ENOTSUP: The function is not supported by the Ethernet driver. 5145 */ 5146 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta); 5147 5148 /** 5149 * Read the time from the timesync clock on an Ethernet device. 5150 * 5151 * This is usually used in conjunction with other Ethdev timesync functions to 5152 * synchronize the device time using the IEEE1588/802.1AS protocol. 5153 * 5154 * @param port_id 5155 * The port identifier of the Ethernet device. 5156 * @param time 5157 * Pointer to the timespec struct that holds the time. 5158 * 5159 * @return 5160 * - 0: Success. 5161 * - -EINVAL: Bad parameter. 5162 */ 5163 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time); 5164 5165 /** 5166 * Set the time of the timesync clock on an Ethernet device. 5167 * 5168 * This is usually used in conjunction with other Ethdev timesync functions to 5169 * synchronize the device time using the IEEE1588/802.1AS protocol. 5170 * 5171 * @param port_id 5172 * The port identifier of the Ethernet device. 5173 * @param time 5174 * Pointer to the timespec struct that holds the time. 5175 * 5176 * @return 5177 * - 0: Success. 5178 * - -EINVAL: No timestamp is available. 5179 * - -ENODEV: The port ID is invalid. 5180 * - -EIO: if device is removed. 5181 * - -ENOTSUP: The function is not supported by the Ethernet driver. 5182 */ 5183 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time); 5184 5185 /** 5186 * @warning 5187 * @b EXPERIMENTAL: this API may change without prior notice. 5188 * 5189 * Read the current clock counter of an Ethernet device 5190 * 5191 * This returns the current raw clock value of an Ethernet device. It is 5192 * a raw amount of ticks, with no given time reference. 5193 * The value returned here is from the same clock than the one 5194 * filling timestamp field of Rx packets when using hardware timestamp 5195 * offload. Therefore it can be used to compute a precise conversion of 5196 * the device clock to the real time. 5197 * 5198 * E.g, a simple heuristic to derivate the frequency would be: 5199 * uint64_t start, end; 5200 * rte_eth_read_clock(port, start); 5201 * rte_delay_ms(100); 5202 * rte_eth_read_clock(port, end); 5203 * double freq = (end - start) * 10; 5204 * 5205 * Compute a common reference with: 5206 * uint64_t base_time_sec = current_time(); 5207 * uint64_t base_clock; 5208 * rte_eth_read_clock(port, base_clock); 5209 * 5210 * Then, convert the raw mbuf timestamp with: 5211 * base_time_sec + (double)(*timestamp_dynfield(mbuf) - base_clock) / freq; 5212 * 5213 * This simple example will not provide a very good accuracy. One must 5214 * at least measure multiple times the frequency and do a regression. 5215 * To avoid deviation from the system time, the common reference can 5216 * be repeated from time to time. The integer division can also be 5217 * converted by a multiplication and a shift for better performance. 5218 * 5219 * @param port_id 5220 * The port identifier of the Ethernet device. 5221 * @param clock 5222 * Pointer to the uint64_t that holds the raw clock value. 5223 * 5224 * @return 5225 * - 0: Success. 5226 * - -ENODEV: The port ID is invalid. 5227 * - -ENOTSUP: The function is not supported by the Ethernet driver. 5228 * - -EINVAL: if bad parameter. 5229 */ 5230 __rte_experimental 5231 int 5232 rte_eth_read_clock(uint16_t port_id, uint64_t *clock); 5233 5234 /** 5235 * Get the port ID from device name. 5236 * The device name should be specified as below: 5237 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0 5238 * - SoC device name, for example- fsl-gmac0 5239 * - vdev dpdk name, for example- net_[pcap0|null0|tap0] 5240 * 5241 * @param name 5242 * PCI address or name of the device. 5243 * @param port_id 5244 * Pointer to port identifier of the device. 5245 * @return 5246 * - (0) if successful and port_id is filled. 5247 * - (-ENODEV or -EINVAL) on failure. 5248 */ 5249 int 5250 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id); 5251 5252 /** 5253 * Get the device name from port ID. 5254 * The device name is specified as below: 5255 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0 5256 * - SoC device name, for example- fsl-gmac0 5257 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0] 5258 * 5259 * @param port_id 5260 * Port identifier of the device. 5261 * @param name 5262 * Buffer of size RTE_ETH_NAME_MAX_LEN to store the name. 5263 * @return 5264 * - (0) if successful. 5265 * - (-ENODEV) if *port_id* is invalid. 5266 * - (-EINVAL) on failure. 5267 */ 5268 int 5269 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name); 5270 5271 /** 5272 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from 5273 * the Ethernet device information, otherwise adjust them to boundaries. 5274 * 5275 * @param port_id 5276 * The port identifier of the Ethernet device. 5277 * @param nb_rx_desc 5278 * A pointer to a uint16_t where the number of receive 5279 * descriptors stored. 5280 * @param nb_tx_desc 5281 * A pointer to a uint16_t where the number of transmit 5282 * descriptors stored. 5283 * @return 5284 * - (0) if successful. 5285 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure. 5286 */ 5287 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id, 5288 uint16_t *nb_rx_desc, 5289 uint16_t *nb_tx_desc); 5290 5291 /** 5292 * Test if a port supports specific mempool ops. 5293 * 5294 * @param port_id 5295 * Port identifier of the Ethernet device. 5296 * @param [in] pool 5297 * The name of the pool operations to test. 5298 * @return 5299 * - 0: best mempool ops choice for this port. 5300 * - 1: mempool ops are supported for this port. 5301 * - -ENOTSUP: mempool ops not supported for this port. 5302 * - -ENODEV: Invalid port Identifier. 5303 * - -EINVAL: Pool param is null. 5304 */ 5305 int 5306 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool); 5307 5308 /** 5309 * Get the security context for the Ethernet device. 5310 * 5311 * @param port_id 5312 * Port identifier of the Ethernet device 5313 * @return 5314 * - NULL on error. 5315 * - pointer to security context on success. 5316 */ 5317 void * 5318 rte_eth_dev_get_sec_ctx(uint16_t port_id); 5319 5320 /** 5321 * @warning 5322 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5323 * 5324 * Query the device hairpin capabilities. 5325 * 5326 * @param port_id 5327 * The port identifier of the Ethernet device. 5328 * @param cap 5329 * Pointer to a structure that will hold the hairpin capabilities. 5330 * @return 5331 * - (0) if successful. 5332 * - (-ENOTSUP) if hardware doesn't support. 5333 * - (-EINVAL) if bad parameter. 5334 */ 5335 __rte_experimental 5336 int rte_eth_dev_hairpin_capability_get(uint16_t port_id, 5337 struct rte_eth_hairpin_cap *cap); 5338 5339 /** 5340 * @warning 5341 * @b EXPERIMENTAL: this structure may change without prior notice. 5342 * 5343 * Ethernet device representor ID range entry 5344 */ 5345 struct rte_eth_representor_range { 5346 enum rte_eth_representor_type type; /**< Representor type */ 5347 int controller; /**< Controller index */ 5348 int pf; /**< Physical function index */ 5349 __extension__ 5350 union { 5351 int vf; /**< VF start index */ 5352 int sf; /**< SF start index */ 5353 }; 5354 uint32_t id_base; /**< Representor ID start index */ 5355 uint32_t id_end; /**< Representor ID end index */ 5356 char name[RTE_DEV_NAME_MAX_LEN]; /**< Representor name */ 5357 }; 5358 5359 /** 5360 * @warning 5361 * @b EXPERIMENTAL: this structure may change without prior notice. 5362 * 5363 * Ethernet device representor information 5364 */ 5365 struct rte_eth_representor_info { 5366 uint16_t controller; /**< Controller ID of caller device. */ 5367 uint16_t pf; /**< Physical function ID of caller device. */ 5368 uint32_t nb_ranges_alloc; /**< Size of the ranges array. */ 5369 uint32_t nb_ranges; /**< Number of initialized ranges. */ 5370 struct rte_eth_representor_range ranges[];/**< Representor ID range. */ 5371 }; 5372 5373 /** 5374 * Retrieve the representor info of the device. 5375 * 5376 * Get device representor info to be able to calculate a unique 5377 * representor ID. @see rte_eth_representor_id_get helper. 5378 * 5379 * @param port_id 5380 * The port identifier of the device. 5381 * @param info 5382 * A pointer to a representor info structure. 5383 * NULL to return number of range entries and allocate memory 5384 * for next call to store detail. 5385 * The number of ranges that were written into this structure 5386 * will be placed into its nb_ranges field. This number cannot be 5387 * larger than the nb_ranges_alloc that by the user before calling 5388 * this function. It can be smaller than the value returned by the 5389 * function, however. 5390 * @return 5391 * - (-ENOTSUP) if operation is not supported. 5392 * - (-ENODEV) if *port_id* invalid. 5393 * - (-EIO) if device is removed. 5394 * - (>=0) number of available representor range entries. 5395 */ 5396 __rte_experimental 5397 int rte_eth_representor_info_get(uint16_t port_id, 5398 struct rte_eth_representor_info *info); 5399 5400 /** The NIC is able to deliver flag (if set) with packets to the PMD. */ 5401 #define RTE_ETH_RX_METADATA_USER_FLAG RTE_BIT64(0) 5402 5403 /** The NIC is able to deliver mark ID with packets to the PMD. */ 5404 #define RTE_ETH_RX_METADATA_USER_MARK RTE_BIT64(1) 5405 5406 /** The NIC is able to deliver tunnel ID with packets to the PMD. */ 5407 #define RTE_ETH_RX_METADATA_TUNNEL_ID RTE_BIT64(2) 5408 5409 /** 5410 * Negotiate the NIC's ability to deliver specific kinds of metadata to the PMD. 5411 * 5412 * Invoke this API before the first rte_eth_dev_configure() invocation 5413 * to let the PMD make preparations that are inconvenient to do later. 5414 * 5415 * The negotiation process is as follows: 5416 * 5417 * - the application requests features intending to use at least some of them; 5418 * - the PMD responds with the guaranteed subset of the requested feature set; 5419 * - the application can retry negotiation with another set of features; 5420 * - the application can pass zero to clear the negotiation result; 5421 * - the last negotiated result takes effect upon 5422 * the ethdev configure and start. 5423 * 5424 * @note 5425 * The PMD is supposed to first consider enabling the requested feature set 5426 * in its entirety. Only if it fails to do so, does it have the right to 5427 * respond with a smaller set of the originally requested features. 5428 * 5429 * @note 5430 * Return code (-ENOTSUP) does not necessarily mean that the requested 5431 * features are unsupported. In this case, the application should just 5432 * assume that these features can be used without prior negotiations. 5433 * 5434 * @param port_id 5435 * Port (ethdev) identifier 5436 * 5437 * @param[inout] features 5438 * Feature selection buffer 5439 * 5440 * @return 5441 * - (-EBUSY) if the port can't handle this in its current state; 5442 * - (-ENOTSUP) if the method itself is not supported by the PMD; 5443 * - (-ENODEV) if *port_id* is invalid; 5444 * - (-EINVAL) if *features* is NULL; 5445 * - (-EIO) if the device is removed; 5446 * - (0) on success 5447 */ 5448 int rte_eth_rx_metadata_negotiate(uint16_t port_id, uint64_t *features); 5449 5450 /** Flag to offload IP reassembly for IPv4 packets. */ 5451 #define RTE_ETH_DEV_REASSEMBLY_F_IPV4 (RTE_BIT32(0)) 5452 /** Flag to offload IP reassembly for IPv6 packets. */ 5453 #define RTE_ETH_DEV_REASSEMBLY_F_IPV6 (RTE_BIT32(1)) 5454 5455 /** 5456 * A structure used to get/set IP reassembly configuration. It is also used 5457 * to get the maximum capability values that a PMD can support. 5458 * 5459 * If rte_eth_ip_reassembly_capability_get() returns 0, IP reassembly can be 5460 * enabled using rte_eth_ip_reassembly_conf_set() and params values lower than 5461 * capability params can be set in the PMD. 5462 */ 5463 struct rte_eth_ip_reassembly_params { 5464 /** Maximum time in ms which PMD can wait for other fragments. */ 5465 uint32_t timeout_ms; 5466 /** Maximum number of fragments that can be reassembled. */ 5467 uint16_t max_frags; 5468 /** 5469 * Flags to enable reassembly of packet types - 5470 * RTE_ETH_DEV_REASSEMBLY_F_xxx. 5471 */ 5472 uint16_t flags; 5473 }; 5474 5475 /** 5476 * @warning 5477 * @b EXPERIMENTAL: this API may change without prior notice 5478 * 5479 * Get IP reassembly capabilities supported by the PMD. This is the first API 5480 * to be called for enabling the IP reassembly offload feature. PMD will return 5481 * the maximum values of parameters that PMD can support and user can call 5482 * rte_eth_ip_reassembly_conf_set() with param values lower than capability. 5483 * 5484 * @param port_id 5485 * The port identifier of the device. 5486 * @param capa 5487 * A pointer to rte_eth_ip_reassembly_params structure. 5488 * @return 5489 * - (-ENOTSUP) if offload configuration is not supported by device. 5490 * - (-ENODEV) if *port_id* invalid. 5491 * - (-EIO) if device is removed. 5492 * - (-EINVAL) if device is not configured or *capa* passed is NULL. 5493 * - (0) on success. 5494 */ 5495 __rte_experimental 5496 int rte_eth_ip_reassembly_capability_get(uint16_t port_id, 5497 struct rte_eth_ip_reassembly_params *capa); 5498 5499 /** 5500 * @warning 5501 * @b EXPERIMENTAL: this API may change without prior notice 5502 * 5503 * Get IP reassembly configuration parameters currently set in PMD. 5504 * The API will return error if the configuration is not already 5505 * set using rte_eth_ip_reassembly_conf_set() before calling this API or if 5506 * the device is not configured. 5507 * 5508 * @param port_id 5509 * The port identifier of the device. 5510 * @param conf 5511 * A pointer to rte_eth_ip_reassembly_params structure. 5512 * @return 5513 * - (-ENOTSUP) if offload configuration is not supported by device. 5514 * - (-ENODEV) if *port_id* invalid. 5515 * - (-EIO) if device is removed. 5516 * - (-EINVAL) if device is not configured or if *conf* passed is NULL or if 5517 * configuration is not set using rte_eth_ip_reassembly_conf_set(). 5518 * - (0) on success. 5519 */ 5520 __rte_experimental 5521 int rte_eth_ip_reassembly_conf_get(uint16_t port_id, 5522 struct rte_eth_ip_reassembly_params *conf); 5523 5524 /** 5525 * @warning 5526 * @b EXPERIMENTAL: this API may change without prior notice 5527 * 5528 * Set IP reassembly configuration parameters if the PMD supports IP reassembly 5529 * offload. User should first call rte_eth_ip_reassembly_capability_get() to 5530 * check the maximum values supported by the PMD before setting the 5531 * configuration. The use of this API is mandatory to enable this feature and 5532 * should be called before rte_eth_dev_start(). 5533 * 5534 * In datapath, PMD cannot guarantee that IP reassembly is always successful. 5535 * Hence, PMD shall register mbuf dynamic field and dynamic flag using 5536 * rte_eth_ip_reassembly_dynfield_register() to denote incomplete IP reassembly. 5537 * If dynfield is not successfully registered, error will be returned and 5538 * IP reassembly offload cannot be used. 5539 * 5540 * @param port_id 5541 * The port identifier of the device. 5542 * @param conf 5543 * A pointer to rte_eth_ip_reassembly_params structure. 5544 * @return 5545 * - (-ENOTSUP) if offload configuration is not supported by device. 5546 * - (-ENODEV) if *port_id* invalid. 5547 * - (-EIO) if device is removed. 5548 * - (-EINVAL) if device is not configured or if device is already started or 5549 * if *conf* passed is NULL or if mbuf dynfield is not registered 5550 * successfully by the PMD. 5551 * - (0) on success. 5552 */ 5553 __rte_experimental 5554 int rte_eth_ip_reassembly_conf_set(uint16_t port_id, 5555 const struct rte_eth_ip_reassembly_params *conf); 5556 5557 /** 5558 * In case of IP reassembly offload failure, packet will be updated with 5559 * dynamic flag - RTE_MBUF_DYNFLAG_IP_REASSEMBLY_INCOMPLETE_NAME and packets 5560 * will be returned without alteration. 5561 * The application can retrieve the attached fragments using mbuf dynamic field 5562 * RTE_MBUF_DYNFIELD_IP_REASSEMBLY_NAME. 5563 */ 5564 typedef struct { 5565 /** 5566 * Next fragment packet. Application should fetch dynamic field of 5567 * each fragment until a NULL is received and nb_frags is 0. 5568 */ 5569 struct rte_mbuf *next_frag; 5570 /** Time spent(in ms) by HW in waiting for further fragments. */ 5571 uint16_t time_spent; 5572 /** Number of more fragments attached in mbuf dynamic fields. */ 5573 uint16_t nb_frags; 5574 } rte_eth_ip_reassembly_dynfield_t; 5575 5576 /** 5577 * @warning 5578 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5579 * 5580 * Dump private info from device to a file. Provided data and the order depends 5581 * on the PMD. 5582 * 5583 * @param port_id 5584 * The port identifier of the Ethernet device. 5585 * @param file 5586 * A pointer to a file for output. 5587 * @return 5588 * - (0) on success. 5589 * - (-ENODEV) if *port_id* is invalid. 5590 * - (-EINVAL) if null file. 5591 * - (-ENOTSUP) if the device does not support this function. 5592 * - (-EIO) if device is removed. 5593 */ 5594 __rte_experimental 5595 int rte_eth_dev_priv_dump(uint16_t port_id, FILE *file); 5596 5597 /** 5598 * @warning 5599 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5600 * 5601 * Dump ethdev Rx descriptor info to a file. 5602 * 5603 * This API is used for debugging, not a dataplane API. 5604 * 5605 * @param port_id 5606 * The port identifier of the Ethernet device. 5607 * @param queue_id 5608 * A Rx queue identifier on this port. 5609 * @param offset 5610 * The offset of the descriptor starting from tail. (0 is the next 5611 * packet to be received by the driver). 5612 * @param num 5613 * The number of the descriptors to dump. 5614 * @param file 5615 * A pointer to a file for output. 5616 * @return 5617 * - On success, zero. 5618 * - On failure, a negative value. 5619 */ 5620 __rte_experimental 5621 int rte_eth_rx_descriptor_dump(uint16_t port_id, uint16_t queue_id, 5622 uint16_t offset, uint16_t num, FILE *file); 5623 5624 /** 5625 * @warning 5626 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5627 * 5628 * Dump ethdev Tx descriptor info to a file. 5629 * 5630 * This API is used for debugging, not a dataplane API. 5631 * 5632 * @param port_id 5633 * The port identifier of the Ethernet device. 5634 * @param queue_id 5635 * A Tx queue identifier on this port. 5636 * @param offset 5637 * The offset of the descriptor starting from tail. (0 is the place where 5638 * the next packet will be send). 5639 * @param num 5640 * The number of the descriptors to dump. 5641 * @param file 5642 * A pointer to a file for output. 5643 * @return 5644 * - On success, zero. 5645 * - On failure, a negative value. 5646 */ 5647 __rte_experimental 5648 int rte_eth_tx_descriptor_dump(uint16_t port_id, uint16_t queue_id, 5649 uint16_t offset, uint16_t num, FILE *file); 5650 5651 5652 /* Congestion management */ 5653 5654 /** Enumerate list of ethdev congestion management objects */ 5655 enum rte_eth_cman_obj { 5656 /** Congestion management based on Rx queue depth */ 5657 RTE_ETH_CMAN_OBJ_RX_QUEUE = RTE_BIT32(0), 5658 /** 5659 * Congestion management based on mempool depth associated with Rx queue 5660 * @see rte_eth_rx_queue_setup() 5661 */ 5662 RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL = RTE_BIT32(1), 5663 }; 5664 5665 /** 5666 * @warning 5667 * @b EXPERIMENTAL: this structure may change, or be removed, without prior notice 5668 * 5669 * A structure used to retrieve information of ethdev congestion management. 5670 */ 5671 struct rte_eth_cman_info { 5672 /** 5673 * Set of supported congestion management modes 5674 * @see enum rte_cman_mode 5675 */ 5676 uint64_t modes_supported; 5677 /** 5678 * Set of supported congestion management objects 5679 * @see enum rte_eth_cman_obj 5680 */ 5681 uint64_t objs_supported; 5682 /** 5683 * Reserved for future fields. Always returned as 0 when 5684 * rte_eth_cman_info_get() is invoked 5685 */ 5686 uint8_t rsvd[8]; 5687 }; 5688 5689 /** 5690 * @warning 5691 * @b EXPERIMENTAL: this structure may change, or be removed, without prior notice 5692 * 5693 * A structure used to configure the ethdev congestion management. 5694 */ 5695 struct rte_eth_cman_config { 5696 /** Congestion management object */ 5697 enum rte_eth_cman_obj obj; 5698 /** Congestion management mode */ 5699 enum rte_cman_mode mode; 5700 union { 5701 /** 5702 * Rx queue to configure congestion management. 5703 * 5704 * Valid when object is RTE_ETH_CMAN_OBJ_RX_QUEUE or 5705 * RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL. 5706 */ 5707 uint16_t rx_queue; 5708 /** 5709 * Reserved for future fields. 5710 * It must be set to 0 when rte_eth_cman_config_set() is invoked 5711 * and will be returned as 0 when rte_eth_cman_config_get() is 5712 * invoked. 5713 */ 5714 uint8_t rsvd_obj_params[4]; 5715 } obj_param; 5716 union { 5717 /** 5718 * RED configuration parameters. 5719 * 5720 * Valid when mode is RTE_CMAN_RED. 5721 */ 5722 struct rte_cman_red_params red; 5723 /** 5724 * Reserved for future fields. 5725 * It must be set to 0 when rte_eth_cman_config_set() is invoked 5726 * and will be returned as 0 when rte_eth_cman_config_get() is 5727 * invoked. 5728 */ 5729 uint8_t rsvd_mode_params[4]; 5730 } mode_param; 5731 }; 5732 5733 /** 5734 * @warning 5735 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5736 * 5737 * Retrieve the information for ethdev congestion management 5738 * 5739 * @param port_id 5740 * The port identifier of the Ethernet device. 5741 * @param info 5742 * A pointer to a structure of type *rte_eth_cman_info* to be filled with 5743 * the information about congestion management. 5744 * @return 5745 * - (0) if successful. 5746 * - (-ENOTSUP) if support for cman_info_get does not exist. 5747 * - (-ENODEV) if *port_id* invalid. 5748 * - (-EINVAL) if bad parameter. 5749 */ 5750 __rte_experimental 5751 int rte_eth_cman_info_get(uint16_t port_id, struct rte_eth_cman_info *info); 5752 5753 /** 5754 * @warning 5755 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5756 * 5757 * Initialize the ethdev congestion management configuration structure with default values. 5758 * 5759 * @param port_id 5760 * The port identifier of the Ethernet device. 5761 * @param config 5762 * A pointer to a structure of type *rte_eth_cman_config* to be initialized 5763 * with default value. 5764 * @return 5765 * - (0) if successful. 5766 * - (-ENOTSUP) if support for cman_config_init does not exist. 5767 * - (-ENODEV) if *port_id* invalid. 5768 * - (-EINVAL) if bad parameter. 5769 */ 5770 __rte_experimental 5771 int rte_eth_cman_config_init(uint16_t port_id, struct rte_eth_cman_config *config); 5772 5773 /** 5774 * @warning 5775 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5776 * 5777 * Configure ethdev congestion management 5778 * 5779 * @param port_id 5780 * The port identifier of the Ethernet device. 5781 * @param config 5782 * A pointer to a structure of type *rte_eth_cman_config* to be configured. 5783 * @return 5784 * - (0) if successful. 5785 * - (-ENOTSUP) if support for cman_config_set does not exist. 5786 * - (-ENODEV) if *port_id* invalid. 5787 * - (-EINVAL) if bad parameter. 5788 */ 5789 __rte_experimental 5790 int rte_eth_cman_config_set(uint16_t port_id, const struct rte_eth_cman_config *config); 5791 5792 /** 5793 * @warning 5794 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 5795 * 5796 * Retrieve the applied ethdev congestion management parameters for the given port. 5797 * 5798 * @param port_id 5799 * The port identifier of the Ethernet device. 5800 * @param config 5801 * A pointer to a structure of type *rte_eth_cman_config* to retrieve 5802 * congestion management parameters for the given object. 5803 * Application must fill all parameters except mode_param parameter in 5804 * struct rte_eth_cman_config. 5805 * 5806 * @return 5807 * - (0) if successful. 5808 * - (-ENOTSUP) if support for cman_config_get does not exist. 5809 * - (-ENODEV) if *port_id* invalid. 5810 * - (-EINVAL) if bad parameter. 5811 */ 5812 __rte_experimental 5813 int rte_eth_cman_config_get(uint16_t port_id, struct rte_eth_cman_config *config); 5814 5815 #include <rte_ethdev_core.h> 5816 5817 /** 5818 * @internal 5819 * Helper routine for rte_eth_rx_burst(). 5820 * Should be called at exit from PMD's rte_eth_rx_bulk implementation. 5821 * Does necessary post-processing - invokes Rx callbacks if any, etc. 5822 * 5823 * @param port_id 5824 * The port identifier of the Ethernet device. 5825 * @param queue_id 5826 * The index of the receive queue from which to retrieve input packets. 5827 * @param rx_pkts 5828 * The address of an array of pointers to *rte_mbuf* structures that 5829 * have been retrieved from the device. 5830 * @param nb_rx 5831 * The number of packets that were retrieved from the device. 5832 * @param nb_pkts 5833 * The number of elements in @p rx_pkts array. 5834 * @param opaque 5835 * Opaque pointer of Rx queue callback related data. 5836 * 5837 * @return 5838 * The number of packets effectively supplied to the @p rx_pkts array. 5839 */ 5840 uint16_t rte_eth_call_rx_callbacks(uint16_t port_id, uint16_t queue_id, 5841 struct rte_mbuf **rx_pkts, uint16_t nb_rx, uint16_t nb_pkts, 5842 void *opaque); 5843 5844 /** 5845 * 5846 * Retrieve a burst of input packets from a receive queue of an Ethernet 5847 * device. The retrieved packets are stored in *rte_mbuf* structures whose 5848 * pointers are supplied in the *rx_pkts* array. 5849 * 5850 * The rte_eth_rx_burst() function loops, parsing the Rx ring of the 5851 * receive queue, up to *nb_pkts* packets, and for each completed Rx 5852 * descriptor in the ring, it performs the following operations: 5853 * 5854 * - Initialize the *rte_mbuf* data structure associated with the 5855 * Rx descriptor according to the information provided by the NIC into 5856 * that Rx descriptor. 5857 * 5858 * - Store the *rte_mbuf* data structure into the next entry of the 5859 * *rx_pkts* array. 5860 * 5861 * - Replenish the Rx descriptor with a new *rte_mbuf* buffer 5862 * allocated from the memory pool associated with the receive queue at 5863 * initialization time. 5864 * 5865 * When retrieving an input packet that was scattered by the controller 5866 * into multiple receive descriptors, the rte_eth_rx_burst() function 5867 * appends the associated *rte_mbuf* buffers to the first buffer of the 5868 * packet. 5869 * 5870 * The rte_eth_rx_burst() function returns the number of packets 5871 * actually retrieved, which is the number of *rte_mbuf* data structures 5872 * effectively supplied into the *rx_pkts* array. 5873 * A return value equal to *nb_pkts* indicates that the Rx queue contained 5874 * at least *rx_pkts* packets, and this is likely to signify that other 5875 * received packets remain in the input queue. Applications implementing 5876 * a "retrieve as much received packets as possible" policy can check this 5877 * specific case and keep invoking the rte_eth_rx_burst() function until 5878 * a value less than *nb_pkts* is returned. 5879 * 5880 * This receive method has the following advantages: 5881 * 5882 * - It allows a run-to-completion network stack engine to retrieve and 5883 * to immediately process received packets in a fast burst-oriented 5884 * approach, avoiding the overhead of unnecessary intermediate packet 5885 * queue/dequeue operations. 5886 * 5887 * - Conversely, it also allows an asynchronous-oriented processing 5888 * method to retrieve bursts of received packets and to immediately 5889 * queue them for further parallel processing by another logical core, 5890 * for instance. However, instead of having received packets being 5891 * individually queued by the driver, this approach allows the caller 5892 * of the rte_eth_rx_burst() function to queue a burst of retrieved 5893 * packets at a time and therefore dramatically reduce the cost of 5894 * enqueue/dequeue operations per packet. 5895 * 5896 * - It allows the rte_eth_rx_burst() function of the driver to take 5897 * advantage of burst-oriented hardware features (CPU cache, 5898 * prefetch instructions, and so on) to minimize the number of CPU 5899 * cycles per packet. 5900 * 5901 * To summarize, the proposed receive API enables many 5902 * burst-oriented optimizations in both synchronous and asynchronous 5903 * packet processing environments with no overhead in both cases. 5904 * 5905 * @note 5906 * Some drivers using vector instructions require that *nb_pkts* is 5907 * divisible by 4 or 8, depending on the driver implementation. 5908 * 5909 * The rte_eth_rx_burst() function does not provide any error 5910 * notification to avoid the corresponding overhead. As a hint, the 5911 * upper-level application might check the status of the device link once 5912 * being systematically returned a 0 value for a given number of tries. 5913 * 5914 * @param port_id 5915 * The port identifier of the Ethernet device. 5916 * @param queue_id 5917 * The index of the receive queue from which to retrieve input packets. 5918 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 5919 * to rte_eth_dev_configure(). 5920 * @param rx_pkts 5921 * The address of an array of pointers to *rte_mbuf* structures that 5922 * must be large enough to store *nb_pkts* pointers in it. 5923 * @param nb_pkts 5924 * The maximum number of packets to retrieve. 5925 * The value must be divisible by 8 in order to work with any driver. 5926 * @return 5927 * The number of packets actually retrieved, which is the number 5928 * of pointers to *rte_mbuf* structures effectively supplied to the 5929 * *rx_pkts* array. 5930 */ 5931 static inline uint16_t 5932 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id, 5933 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts) 5934 { 5935 uint16_t nb_rx; 5936 struct rte_eth_fp_ops *p; 5937 void *qd; 5938 5939 #ifdef RTE_ETHDEV_DEBUG_RX 5940 if (port_id >= RTE_MAX_ETHPORTS || 5941 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 5942 RTE_ETHDEV_LOG(ERR, 5943 "Invalid port_id=%u or queue_id=%u\n", 5944 port_id, queue_id); 5945 return 0; 5946 } 5947 #endif 5948 5949 /* fetch pointer to queue data */ 5950 p = &rte_eth_fp_ops[port_id]; 5951 qd = p->rxq.data[queue_id]; 5952 5953 #ifdef RTE_ETHDEV_DEBUG_RX 5954 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0); 5955 5956 if (qd == NULL) { 5957 RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u for port_id=%u\n", 5958 queue_id, port_id); 5959 return 0; 5960 } 5961 #endif 5962 5963 nb_rx = p->rx_pkt_burst(qd, rx_pkts, nb_pkts); 5964 5965 #ifdef RTE_ETHDEV_RXTX_CALLBACKS 5966 { 5967 void *cb; 5968 5969 /* __ATOMIC_RELEASE memory order was used when the 5970 * call back was inserted into the list. 5971 * Since there is a clear dependency between loading 5972 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is 5973 * not required. 5974 */ 5975 cb = __atomic_load_n((void **)&p->rxq.clbk[queue_id], 5976 __ATOMIC_RELAXED); 5977 if (unlikely(cb != NULL)) 5978 nb_rx = rte_eth_call_rx_callbacks(port_id, queue_id, 5979 rx_pkts, nb_rx, nb_pkts, cb); 5980 } 5981 #endif 5982 5983 rte_ethdev_trace_rx_burst(port_id, queue_id, (void **)rx_pkts, nb_rx); 5984 return nb_rx; 5985 } 5986 5987 /** 5988 * Get the number of used descriptors of a Rx queue 5989 * 5990 * Since it's a dataplane function, no check is performed on port_id and 5991 * queue_id. The caller must therefore ensure that the port is enabled 5992 * and the queue is configured and running. 5993 * 5994 * @param port_id 5995 * The port identifier of the Ethernet device. 5996 * @param queue_id 5997 * The queue ID on the specific port. 5998 * @return 5999 * The number of used descriptors in the specific queue, or: 6000 * - (-ENODEV) if *port_id* is invalid. 6001 * - (-EINVAL) if *queue_id* is invalid 6002 * - (-ENOTSUP) if the device does not support this function 6003 */ 6004 static inline int 6005 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id) 6006 { 6007 struct rte_eth_fp_ops *p; 6008 void *qd; 6009 6010 #ifdef RTE_ETHDEV_DEBUG_RX 6011 if (port_id >= RTE_MAX_ETHPORTS || 6012 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 6013 RTE_ETHDEV_LOG(ERR, 6014 "Invalid port_id=%u or queue_id=%u\n", 6015 port_id, queue_id); 6016 return -EINVAL; 6017 } 6018 #endif 6019 6020 /* fetch pointer to queue data */ 6021 p = &rte_eth_fp_ops[port_id]; 6022 qd = p->rxq.data[queue_id]; 6023 6024 #ifdef RTE_ETHDEV_DEBUG_RX 6025 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); 6026 if (qd == NULL) 6027 return -EINVAL; 6028 #endif 6029 6030 if (*p->rx_queue_count == NULL) 6031 return -ENOTSUP; 6032 return (int)(*p->rx_queue_count)(qd); 6033 } 6034 6035 /**@{@name Rx hardware descriptor states 6036 * @see rte_eth_rx_descriptor_status 6037 */ 6038 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */ 6039 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */ 6040 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */ 6041 /**@}*/ 6042 6043 /** 6044 * Check the status of a Rx descriptor in the queue 6045 * 6046 * It should be called in a similar context than the Rx function: 6047 * - on a dataplane core 6048 * - not concurrently on the same queue 6049 * 6050 * Since it's a dataplane function, no check is performed on port_id and 6051 * queue_id. The caller must therefore ensure that the port is enabled 6052 * and the queue is configured and running. 6053 * 6054 * Note: accessing to a random descriptor in the ring may trigger cache 6055 * misses and have a performance impact. 6056 * 6057 * @param port_id 6058 * A valid port identifier of the Ethernet device which. 6059 * @param queue_id 6060 * A valid Rx queue identifier on this port. 6061 * @param offset 6062 * The offset of the descriptor starting from tail (0 is the next 6063 * packet to be received by the driver). 6064 * 6065 * @return 6066 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to 6067 * receive a packet. 6068 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but 6069 * not yet processed by the driver (i.e. in the receive queue). 6070 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by 6071 * the driver and not yet returned to hw, or reserved by the hw. 6072 * - (-EINVAL) bad descriptor offset. 6073 * - (-ENOTSUP) if the device does not support this function. 6074 * - (-ENODEV) bad port or queue (only if compiled with debug). 6075 */ 6076 static inline int 6077 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id, 6078 uint16_t offset) 6079 { 6080 struct rte_eth_fp_ops *p; 6081 void *qd; 6082 6083 #ifdef RTE_ETHDEV_DEBUG_RX 6084 if (port_id >= RTE_MAX_ETHPORTS || 6085 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 6086 RTE_ETHDEV_LOG(ERR, 6087 "Invalid port_id=%u or queue_id=%u\n", 6088 port_id, queue_id); 6089 return -EINVAL; 6090 } 6091 #endif 6092 6093 /* fetch pointer to queue data */ 6094 p = &rte_eth_fp_ops[port_id]; 6095 qd = p->rxq.data[queue_id]; 6096 6097 #ifdef RTE_ETHDEV_DEBUG_RX 6098 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); 6099 if (qd == NULL) 6100 return -ENODEV; 6101 #endif 6102 if (*p->rx_descriptor_status == NULL) 6103 return -ENOTSUP; 6104 return (*p->rx_descriptor_status)(qd, offset); 6105 } 6106 6107 /**@{@name Tx hardware descriptor states 6108 * @see rte_eth_tx_descriptor_status 6109 */ 6110 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */ 6111 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */ 6112 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */ 6113 /**@}*/ 6114 6115 /** 6116 * Check the status of a Tx descriptor in the queue. 6117 * 6118 * It should be called in a similar context than the Tx function: 6119 * - on a dataplane core 6120 * - not concurrently on the same queue 6121 * 6122 * Since it's a dataplane function, no check is performed on port_id and 6123 * queue_id. The caller must therefore ensure that the port is enabled 6124 * and the queue is configured and running. 6125 * 6126 * Note: accessing to a random descriptor in the ring may trigger cache 6127 * misses and have a performance impact. 6128 * 6129 * @param port_id 6130 * A valid port identifier of the Ethernet device which. 6131 * @param queue_id 6132 * A valid Tx queue identifier on this port. 6133 * @param offset 6134 * The offset of the descriptor starting from tail (0 is the place where 6135 * the next packet will be send). 6136 * 6137 * @return 6138 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e. 6139 * in the transmit queue. 6140 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can 6141 * be reused by the driver. 6142 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the 6143 * driver or the hardware. 6144 * - (-EINVAL) bad descriptor offset. 6145 * - (-ENOTSUP) if the device does not support this function. 6146 * - (-ENODEV) bad port or queue (only if compiled with debug). 6147 */ 6148 static inline int rte_eth_tx_descriptor_status(uint16_t port_id, 6149 uint16_t queue_id, uint16_t offset) 6150 { 6151 struct rte_eth_fp_ops *p; 6152 void *qd; 6153 6154 #ifdef RTE_ETHDEV_DEBUG_TX 6155 if (port_id >= RTE_MAX_ETHPORTS || 6156 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 6157 RTE_ETHDEV_LOG(ERR, 6158 "Invalid port_id=%u or queue_id=%u\n", 6159 port_id, queue_id); 6160 return -EINVAL; 6161 } 6162 #endif 6163 6164 /* fetch pointer to queue data */ 6165 p = &rte_eth_fp_ops[port_id]; 6166 qd = p->txq.data[queue_id]; 6167 6168 #ifdef RTE_ETHDEV_DEBUG_TX 6169 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); 6170 if (qd == NULL) 6171 return -ENODEV; 6172 #endif 6173 if (*p->tx_descriptor_status == NULL) 6174 return -ENOTSUP; 6175 return (*p->tx_descriptor_status)(qd, offset); 6176 } 6177 6178 /** 6179 * @internal 6180 * Helper routine for rte_eth_tx_burst(). 6181 * Should be called before entry PMD's rte_eth_tx_bulk implementation. 6182 * Does necessary pre-processing - invokes Tx callbacks if any, etc. 6183 * 6184 * @param port_id 6185 * The port identifier of the Ethernet device. 6186 * @param queue_id 6187 * The index of the transmit queue through which output packets must be 6188 * sent. 6189 * @param tx_pkts 6190 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures 6191 * which contain the output packets. 6192 * @param nb_pkts 6193 * The maximum number of packets to transmit. 6194 * @return 6195 * The number of output packets to transmit. 6196 */ 6197 uint16_t rte_eth_call_tx_callbacks(uint16_t port_id, uint16_t queue_id, 6198 struct rte_mbuf **tx_pkts, uint16_t nb_pkts, void *opaque); 6199 6200 /** 6201 * Send a burst of output packets on a transmit queue of an Ethernet device. 6202 * 6203 * The rte_eth_tx_burst() function is invoked to transmit output packets 6204 * on the output queue *queue_id* of the Ethernet device designated by its 6205 * *port_id*. 6206 * The *nb_pkts* parameter is the number of packets to send which are 6207 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them 6208 * allocated from a pool created with rte_pktmbuf_pool_create(). 6209 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets, 6210 * up to the number of transmit descriptors available in the Tx ring of the 6211 * transmit queue. 6212 * For each packet to send, the rte_eth_tx_burst() function performs 6213 * the following operations: 6214 * 6215 * - Pick up the next available descriptor in the transmit ring. 6216 * 6217 * - Free the network buffer previously sent with that descriptor, if any. 6218 * 6219 * - Initialize the transmit descriptor with the information provided 6220 * in the *rte_mbuf data structure. 6221 * 6222 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers, 6223 * the rte_eth_tx_burst() function uses several transmit descriptors 6224 * of the ring. 6225 * 6226 * The rte_eth_tx_burst() function returns the number of packets it 6227 * actually sent. A return value equal to *nb_pkts* means that all packets 6228 * have been sent, and this is likely to signify that other output packets 6229 * could be immediately transmitted again. Applications that implement a 6230 * "send as many packets to transmit as possible" policy can check this 6231 * specific case and keep invoking the rte_eth_tx_burst() function until 6232 * a value less than *nb_pkts* is returned. 6233 * 6234 * It is the responsibility of the rte_eth_tx_burst() function to 6235 * transparently free the memory buffers of packets previously sent. 6236 * This feature is driven by the *tx_free_thresh* value supplied to the 6237 * rte_eth_dev_configure() function at device configuration time. 6238 * When the number of free Tx descriptors drops below this threshold, the 6239 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers 6240 * of those packets whose transmission was effectively completed. 6241 * 6242 * If the PMD is RTE_ETH_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can 6243 * invoke this function concurrently on the same Tx queue without SW lock. 6244 * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads 6245 * 6246 * @see rte_eth_tx_prepare to perform some prior checks or adjustments 6247 * for offloads. 6248 * 6249 * @note This function must not modify mbufs (including packets data) 6250 * unless the refcnt is 1. 6251 * An exception is the bonding PMD, which does not have "Tx prepare" support, 6252 * in this case, mbufs may be modified. 6253 * 6254 * @param port_id 6255 * The port identifier of the Ethernet device. 6256 * @param queue_id 6257 * The index of the transmit queue through which output packets must be 6258 * sent. 6259 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 6260 * to rte_eth_dev_configure(). 6261 * @param tx_pkts 6262 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures 6263 * which contain the output packets. 6264 * @param nb_pkts 6265 * The maximum number of packets to transmit. 6266 * @return 6267 * The number of output packets actually stored in transmit descriptors of 6268 * the transmit ring. The return value can be less than the value of the 6269 * *tx_pkts* parameter when the transmit ring is full or has been filled up. 6270 */ 6271 static inline uint16_t 6272 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id, 6273 struct rte_mbuf **tx_pkts, uint16_t nb_pkts) 6274 { 6275 struct rte_eth_fp_ops *p; 6276 void *qd; 6277 6278 #ifdef RTE_ETHDEV_DEBUG_TX 6279 if (port_id >= RTE_MAX_ETHPORTS || 6280 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 6281 RTE_ETHDEV_LOG(ERR, 6282 "Invalid port_id=%u or queue_id=%u\n", 6283 port_id, queue_id); 6284 return 0; 6285 } 6286 #endif 6287 6288 /* fetch pointer to queue data */ 6289 p = &rte_eth_fp_ops[port_id]; 6290 qd = p->txq.data[queue_id]; 6291 6292 #ifdef RTE_ETHDEV_DEBUG_TX 6293 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0); 6294 6295 if (qd == NULL) { 6296 RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n", 6297 queue_id, port_id); 6298 return 0; 6299 } 6300 #endif 6301 6302 #ifdef RTE_ETHDEV_RXTX_CALLBACKS 6303 { 6304 void *cb; 6305 6306 /* __ATOMIC_RELEASE memory order was used when the 6307 * call back was inserted into the list. 6308 * Since there is a clear dependency between loading 6309 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is 6310 * not required. 6311 */ 6312 cb = __atomic_load_n((void **)&p->txq.clbk[queue_id], 6313 __ATOMIC_RELAXED); 6314 if (unlikely(cb != NULL)) 6315 nb_pkts = rte_eth_call_tx_callbacks(port_id, queue_id, 6316 tx_pkts, nb_pkts, cb); 6317 } 6318 #endif 6319 6320 nb_pkts = p->tx_pkt_burst(qd, tx_pkts, nb_pkts); 6321 6322 rte_ethdev_trace_tx_burst(port_id, queue_id, (void **)tx_pkts, nb_pkts); 6323 return nb_pkts; 6324 } 6325 6326 /** 6327 * Process a burst of output packets on a transmit queue of an Ethernet device. 6328 * 6329 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be 6330 * transmitted on the output queue *queue_id* of the Ethernet device designated 6331 * by its *port_id*. 6332 * The *nb_pkts* parameter is the number of packets to be prepared which are 6333 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them 6334 * allocated from a pool created with rte_pktmbuf_pool_create(). 6335 * For each packet to send, the rte_eth_tx_prepare() function performs 6336 * the following operations: 6337 * 6338 * - Check if packet meets devices requirements for Tx offloads. 6339 * 6340 * - Check limitations about number of segments. 6341 * 6342 * - Check additional requirements when debug is enabled. 6343 * 6344 * - Update and/or reset required checksums when Tx offload is set for packet. 6345 * 6346 * Since this function can modify packet data, provided mbufs must be safely 6347 * writable (e.g. modified data cannot be in shared segment). 6348 * 6349 * The rte_eth_tx_prepare() function returns the number of packets ready to be 6350 * sent. A return value equal to *nb_pkts* means that all packets are valid and 6351 * ready to be sent, otherwise stops processing on the first invalid packet and 6352 * leaves the rest packets untouched. 6353 * 6354 * When this functionality is not implemented in the driver, all packets are 6355 * are returned untouched. 6356 * 6357 * @param port_id 6358 * The port identifier of the Ethernet device. 6359 * The value must be a valid port ID. 6360 * @param queue_id 6361 * The index of the transmit queue through which output packets must be 6362 * sent. 6363 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 6364 * to rte_eth_dev_configure(). 6365 * @param tx_pkts 6366 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures 6367 * which contain the output packets. 6368 * @param nb_pkts 6369 * The maximum number of packets to process. 6370 * @return 6371 * The number of packets correct and ready to be sent. The return value can be 6372 * less than the value of the *tx_pkts* parameter when some packet doesn't 6373 * meet devices requirements with rte_errno set appropriately: 6374 * - EINVAL: offload flags are not correctly set 6375 * - ENOTSUP: the offload feature is not supported by the hardware 6376 * - ENODEV: if *port_id* is invalid (with debug enabled only) 6377 */ 6378 6379 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP 6380 6381 static inline uint16_t 6382 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id, 6383 struct rte_mbuf **tx_pkts, uint16_t nb_pkts) 6384 { 6385 struct rte_eth_fp_ops *p; 6386 void *qd; 6387 6388 #ifdef RTE_ETHDEV_DEBUG_TX 6389 if (port_id >= RTE_MAX_ETHPORTS || 6390 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 6391 RTE_ETHDEV_LOG(ERR, 6392 "Invalid port_id=%u or queue_id=%u\n", 6393 port_id, queue_id); 6394 rte_errno = ENODEV; 6395 return 0; 6396 } 6397 #endif 6398 6399 /* fetch pointer to queue data */ 6400 p = &rte_eth_fp_ops[port_id]; 6401 qd = p->txq.data[queue_id]; 6402 6403 #ifdef RTE_ETHDEV_DEBUG_TX 6404 if (!rte_eth_dev_is_valid_port(port_id)) { 6405 RTE_ETHDEV_LOG(ERR, "Invalid Tx port_id=%u\n", port_id); 6406 rte_errno = ENODEV; 6407 return 0; 6408 } 6409 if (qd == NULL) { 6410 RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n", 6411 queue_id, port_id); 6412 rte_errno = EINVAL; 6413 return 0; 6414 } 6415 #endif 6416 6417 if (!p->tx_pkt_prepare) 6418 return nb_pkts; 6419 6420 return p->tx_pkt_prepare(qd, tx_pkts, nb_pkts); 6421 } 6422 6423 #else 6424 6425 /* 6426 * Native NOOP operation for compilation targets which doesn't require any 6427 * preparations steps, and functional NOOP may introduce unnecessary performance 6428 * drop. 6429 * 6430 * Generally this is not a good idea to turn it on globally and didn't should 6431 * be used if behavior of tx_preparation can change. 6432 */ 6433 6434 static inline uint16_t 6435 rte_eth_tx_prepare(__rte_unused uint16_t port_id, 6436 __rte_unused uint16_t queue_id, 6437 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts) 6438 { 6439 return nb_pkts; 6440 } 6441 6442 #endif 6443 6444 /** 6445 * Send any packets queued up for transmission on a port and HW queue 6446 * 6447 * This causes an explicit flush of packets previously buffered via the 6448 * rte_eth_tx_buffer() function. It returns the number of packets successfully 6449 * sent to the NIC, and calls the error callback for any unsent packets. Unless 6450 * explicitly set up otherwise, the default callback simply frees the unsent 6451 * packets back to the owning mempool. 6452 * 6453 * @param port_id 6454 * The port identifier of the Ethernet device. 6455 * @param queue_id 6456 * The index of the transmit queue through which output packets must be 6457 * sent. 6458 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 6459 * to rte_eth_dev_configure(). 6460 * @param buffer 6461 * Buffer of packets to be transmit. 6462 * @return 6463 * The number of packets successfully sent to the Ethernet device. The error 6464 * callback is called for any packets which could not be sent. 6465 */ 6466 static inline uint16_t 6467 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id, 6468 struct rte_eth_dev_tx_buffer *buffer) 6469 { 6470 uint16_t sent; 6471 uint16_t to_send = buffer->length; 6472 6473 if (to_send == 0) 6474 return 0; 6475 6476 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send); 6477 6478 buffer->length = 0; 6479 6480 /* All packets sent, or to be dealt with by callback below */ 6481 if (unlikely(sent != to_send)) 6482 buffer->error_callback(&buffer->pkts[sent], 6483 (uint16_t)(to_send - sent), 6484 buffer->error_userdata); 6485 6486 return sent; 6487 } 6488 6489 /** 6490 * Buffer a single packet for future transmission on a port and queue 6491 * 6492 * This function takes a single mbuf/packet and buffers it for later 6493 * transmission on the particular port and queue specified. Once the buffer is 6494 * full of packets, an attempt will be made to transmit all the buffered 6495 * packets. In case of error, where not all packets can be transmitted, a 6496 * callback is called with the unsent packets as a parameter. If no callback 6497 * is explicitly set up, the unsent packets are just freed back to the owning 6498 * mempool. The function returns the number of packets actually sent i.e. 6499 * 0 if no buffer flush occurred, otherwise the number of packets successfully 6500 * flushed 6501 * 6502 * @param port_id 6503 * The port identifier of the Ethernet device. 6504 * @param queue_id 6505 * The index of the transmit queue through which output packets must be 6506 * sent. 6507 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 6508 * to rte_eth_dev_configure(). 6509 * @param buffer 6510 * Buffer used to collect packets to be sent. 6511 * @param tx_pkt 6512 * Pointer to the packet mbuf to be sent. 6513 * @return 6514 * 0 = packet has been buffered for later transmission 6515 * N > 0 = packet has been buffered, and the buffer was subsequently flushed, 6516 * causing N packets to be sent, and the error callback to be called for 6517 * the rest. 6518 */ 6519 static __rte_always_inline uint16_t 6520 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id, 6521 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt) 6522 { 6523 buffer->pkts[buffer->length++] = tx_pkt; 6524 if (buffer->length < buffer->size) 6525 return 0; 6526 6527 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer); 6528 } 6529 6530 /** 6531 * @warning 6532 * @b EXPERIMENTAL: this API may change without prior notice 6533 * 6534 * Get supported header protocols to split on Rx. 6535 * 6536 * When a packet type is announced to be split, 6537 * it *must* be supported by the PMD. 6538 * For instance, if eth-ipv4, eth-ipv4-udp is announced, 6539 * the PMD must return the following packet types for these packets: 6540 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4 6541 * - Ether/IPv4/UDP -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4 | RTE_PTYPE_L4_UDP 6542 * 6543 * @param port_id 6544 * The port identifier of the device. 6545 * @param[out] ptypes 6546 * An array pointer to store supported protocol headers, allocated by caller. 6547 * These ptypes are composed with RTE_PTYPE_*. 6548 * @param num 6549 * Size of the array pointed by param ptypes. 6550 * @return 6551 * - (>=0) Number of supported ptypes. If the number of types exceeds num, 6552 * only num entries will be filled into the ptypes array, 6553 * but the full count of supported ptypes will be returned. 6554 * - (-ENOTSUP) if header protocol is not supported by device. 6555 * - (-ENODEV) if *port_id* invalid. 6556 * - (-EINVAL) if bad parameter. 6557 */ 6558 __rte_experimental 6559 int rte_eth_buffer_split_get_supported_hdr_ptypes(uint16_t port_id, uint32_t *ptypes, int num); 6560 6561 #ifdef __cplusplus 6562 } 6563 #endif 6564 6565 #endif /* _RTE_ETHDEV_H_ */ 6566