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 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 * Any other configuration will not be stored and will need to be re-entered 94 * before a call to rte_eth_dev_start(). 95 * 96 * Finally, a network application can close an Ethernet device by invoking the 97 * rte_eth_dev_close() function. 98 * 99 * Each function of the application Ethernet API invokes a specific function 100 * of the PMD that controls the target device designated by its port 101 * identifier. 102 * For this purpose, all device-specific functions of an Ethernet driver are 103 * supplied through a set of pointers contained in a generic structure of type 104 * *eth_dev_ops*. 105 * The address of the *eth_dev_ops* structure is stored in the *rte_eth_dev* 106 * structure by the device init function of the Ethernet driver, which is 107 * invoked during the PCI probing phase, as explained earlier. 108 * 109 * In other words, each function of the Ethernet API simply retrieves the 110 * *rte_eth_dev* structure associated with the device port identifier and 111 * performs an indirect invocation of the corresponding driver function 112 * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure. 113 * 114 * For performance reasons, the address of the burst-oriented Rx and Tx 115 * functions of the Ethernet driver are not contained in the *eth_dev_ops* 116 * structure. Instead, they are directly stored at the beginning of the 117 * *rte_eth_dev* structure to avoid an extra indirect memory access during 118 * their invocation. 119 * 120 * RTE Ethernet device drivers do not use interrupts for transmitting or 121 * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit 122 * functions to applications. 123 * Both receive and transmit functions are packet-burst oriented to minimize 124 * their cost per packet through the following optimizations: 125 * 126 * - Sharing among multiple packets the incompressible cost of the 127 * invocation of receive/transmit functions. 128 * 129 * - Enabling receive/transmit functions to take advantage of burst-oriented 130 * hardware features (L1 cache, prefetch instructions, NIC head/tail 131 * registers) to minimize the number of CPU cycles per packet, for instance, 132 * by avoiding useless read memory accesses to ring descriptors, or by 133 * systematically using arrays of pointers that exactly fit L1 cache line 134 * boundaries and sizes. 135 * 136 * The burst-oriented receive function does not provide any error notification, 137 * to avoid the corresponding overhead. As a hint, the upper-level application 138 * might check the status of the device link once being systematically returned 139 * a 0 value by the receive function of the driver for a given number of tries. 140 */ 141 142 #ifdef __cplusplus 143 extern "C" { 144 #endif 145 146 #include <stdint.h> 147 148 /* Use this macro to check if LRO API is supported */ 149 #define RTE_ETHDEV_HAS_LRO_SUPPORT 150 151 /* Alias RTE_LIBRTE_ETHDEV_DEBUG for backward compatibility. */ 152 #ifdef RTE_LIBRTE_ETHDEV_DEBUG 153 #define RTE_ETHDEV_DEBUG_RX 154 #define RTE_ETHDEV_DEBUG_TX 155 #endif 156 157 #include <rte_compat.h> 158 #include <rte_log.h> 159 #include <rte_interrupts.h> 160 #include <rte_dev.h> 161 #include <rte_devargs.h> 162 #include <rte_bitops.h> 163 #include <rte_errno.h> 164 #include <rte_common.h> 165 #include <rte_config.h> 166 #include <rte_ether.h> 167 #include <rte_power_intrinsics.h> 168 169 #include "rte_ethdev_trace_fp.h" 170 #include "rte_dev_info.h" 171 172 extern int rte_eth_dev_logtype; 173 174 #define RTE_ETHDEV_LOG(level, ...) \ 175 rte_log(RTE_LOG_ ## level, rte_eth_dev_logtype, "" __VA_ARGS__) 176 177 struct rte_mbuf; 178 179 /** 180 * Initializes a device iterator. 181 * 182 * This iterator allows accessing a list of devices matching some devargs. 183 * 184 * @param iter 185 * Device iterator handle initialized by the function. 186 * The fields bus_str and cls_str might be dynamically allocated, 187 * and could be freed by calling rte_eth_iterator_cleanup(). 188 * 189 * @param devargs 190 * Device description string. 191 * 192 * @return 193 * 0 on successful initialization, negative otherwise. 194 */ 195 int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs); 196 197 /** 198 * Iterates on devices with devargs filter. 199 * The ownership is not checked. 200 * 201 * The next port ID is returned, and the iterator is updated. 202 * 203 * @param iter 204 * Device iterator handle initialized by rte_eth_iterator_init(). 205 * Some fields bus_str and cls_str might be freed when no more port is found, 206 * by calling rte_eth_iterator_cleanup(). 207 * 208 * @return 209 * A port ID if found, RTE_MAX_ETHPORTS otherwise. 210 */ 211 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter); 212 213 /** 214 * Free some allocated fields of the iterator. 215 * 216 * This function is automatically called by rte_eth_iterator_next() 217 * on the last iteration (i.e. when no more matching port is found). 218 * 219 * It is safe to call this function twice; it will do nothing more. 220 * 221 * @param iter 222 * Device iterator handle initialized by rte_eth_iterator_init(). 223 * The fields bus_str and cls_str are freed if needed. 224 */ 225 void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter); 226 227 /** 228 * Macro to iterate over all ethdev ports matching some devargs. 229 * 230 * If a break is done before the end of the loop, 231 * the function rte_eth_iterator_cleanup() must be called. 232 * 233 * @param id 234 * Iterated port ID of type uint16_t. 235 * @param devargs 236 * Device parameters input as string of type char*. 237 * @param iter 238 * Iterator handle of type struct rte_dev_iterator, used internally. 239 */ 240 #define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter) \ 241 for (rte_eth_iterator_init(iter, devargs), \ 242 id = rte_eth_iterator_next(iter); \ 243 id != RTE_MAX_ETHPORTS; \ 244 id = rte_eth_iterator_next(iter)) 245 246 /** 247 * A structure used to retrieve statistics for an Ethernet port. 248 * Not all statistics fields in struct rte_eth_stats are supported 249 * by any type of network interface card (NIC). If any statistics 250 * field is not supported, its value is 0. 251 * All byte-related statistics do not include Ethernet FCS regardless 252 * of whether these bytes have been delivered to the application 253 * (see DEV_RX_OFFLOAD_KEEP_CRC). 254 */ 255 struct rte_eth_stats { 256 uint64_t ipackets; /**< Total number of successfully received packets. */ 257 uint64_t opackets; /**< Total number of successfully transmitted packets.*/ 258 uint64_t ibytes; /**< Total number of successfully received bytes. */ 259 uint64_t obytes; /**< Total number of successfully transmitted bytes. */ 260 /** 261 * Total of Rx packets dropped by the HW, 262 * because there are no available buffer (i.e. Rx queues are full). 263 */ 264 uint64_t imissed; 265 uint64_t ierrors; /**< Total number of erroneous received packets. */ 266 uint64_t oerrors; /**< Total number of failed transmitted packets. */ 267 uint64_t rx_nombuf; /**< Total number of Rx mbuf allocation failures. */ 268 /* Queue stats are limited to max 256 queues */ 269 /** Total number of queue Rx packets. */ 270 uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 271 /** Total number of queue Tx packets. */ 272 uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 273 /** Total number of successfully received queue bytes. */ 274 uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 275 /** Total number of successfully transmitted queue bytes. */ 276 uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 277 /** Total number of queue packets received that are dropped. */ 278 uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS]; 279 }; 280 281 /**@{@name Link speed capabilities 282 * Device supported speeds bitmap flags 283 */ 284 #define ETH_LINK_SPEED_AUTONEG 0 /**< Autonegotiate (all speeds) */ 285 #define ETH_LINK_SPEED_FIXED RTE_BIT32(0) /**< Disable autoneg (fixed speed) */ 286 #define ETH_LINK_SPEED_10M_HD RTE_BIT32(1) /**< 10 Mbps half-duplex */ 287 #define ETH_LINK_SPEED_10M RTE_BIT32(2) /**< 10 Mbps full-duplex */ 288 #define ETH_LINK_SPEED_100M_HD RTE_BIT32(3) /**< 100 Mbps half-duplex */ 289 #define ETH_LINK_SPEED_100M RTE_BIT32(4) /**< 100 Mbps full-duplex */ 290 #define ETH_LINK_SPEED_1G RTE_BIT32(5) /**< 1 Gbps */ 291 #define ETH_LINK_SPEED_2_5G RTE_BIT32(6) /**< 2.5 Gbps */ 292 #define ETH_LINK_SPEED_5G RTE_BIT32(7) /**< 5 Gbps */ 293 #define ETH_LINK_SPEED_10G RTE_BIT32(8) /**< 10 Gbps */ 294 #define ETH_LINK_SPEED_20G RTE_BIT32(9) /**< 20 Gbps */ 295 #define ETH_LINK_SPEED_25G RTE_BIT32(10) /**< 25 Gbps */ 296 #define ETH_LINK_SPEED_40G RTE_BIT32(11) /**< 40 Gbps */ 297 #define ETH_LINK_SPEED_50G RTE_BIT32(12) /**< 50 Gbps */ 298 #define ETH_LINK_SPEED_56G RTE_BIT32(13) /**< 56 Gbps */ 299 #define ETH_LINK_SPEED_100G RTE_BIT32(14) /**< 100 Gbps */ 300 #define ETH_LINK_SPEED_200G RTE_BIT32(15) /**< 200 Gbps */ 301 /**@}*/ 302 303 /**@{@name Link speed 304 * Ethernet numeric link speeds in Mbps 305 */ 306 #define ETH_SPEED_NUM_NONE 0 /**< Not defined */ 307 #define ETH_SPEED_NUM_10M 10 /**< 10 Mbps */ 308 #define ETH_SPEED_NUM_100M 100 /**< 100 Mbps */ 309 #define ETH_SPEED_NUM_1G 1000 /**< 1 Gbps */ 310 #define ETH_SPEED_NUM_2_5G 2500 /**< 2.5 Gbps */ 311 #define ETH_SPEED_NUM_5G 5000 /**< 5 Gbps */ 312 #define ETH_SPEED_NUM_10G 10000 /**< 10 Gbps */ 313 #define ETH_SPEED_NUM_20G 20000 /**< 20 Gbps */ 314 #define ETH_SPEED_NUM_25G 25000 /**< 25 Gbps */ 315 #define ETH_SPEED_NUM_40G 40000 /**< 40 Gbps */ 316 #define ETH_SPEED_NUM_50G 50000 /**< 50 Gbps */ 317 #define ETH_SPEED_NUM_56G 56000 /**< 56 Gbps */ 318 #define ETH_SPEED_NUM_100G 100000 /**< 100 Gbps */ 319 #define ETH_SPEED_NUM_200G 200000 /**< 200 Gbps */ 320 #define ETH_SPEED_NUM_UNKNOWN UINT32_MAX /**< Unknown */ 321 /**@}*/ 322 323 /** 324 * A structure used to retrieve link-level information of an Ethernet port. 325 */ 326 __extension__ 327 struct rte_eth_link { 328 uint32_t link_speed; /**< ETH_SPEED_NUM_ */ 329 uint16_t link_duplex : 1; /**< ETH_LINK_[HALF/FULL]_DUPLEX */ 330 uint16_t link_autoneg : 1; /**< ETH_LINK_[AUTONEG/FIXED] */ 331 uint16_t link_status : 1; /**< ETH_LINK_[DOWN/UP] */ 332 } __rte_aligned(8); /**< aligned for atomic64 read/write */ 333 334 /**@{@name Link negotiation 335 * Constants used in link management. 336 */ 337 #define ETH_LINK_HALF_DUPLEX 0 /**< Half-duplex connection (see link_duplex). */ 338 #define ETH_LINK_FULL_DUPLEX 1 /**< Full-duplex connection (see link_duplex). */ 339 #define ETH_LINK_DOWN 0 /**< Link is down (see link_status). */ 340 #define ETH_LINK_UP 1 /**< Link is up (see link_status). */ 341 #define ETH_LINK_FIXED 0 /**< No autonegotiation (see link_autoneg). */ 342 #define ETH_LINK_AUTONEG 1 /**< Autonegotiated (see link_autoneg). */ 343 #define RTE_ETH_LINK_MAX_STR_LEN 40 /**< Max length of default link string. */ 344 /**@}*/ 345 346 /** 347 * A structure used to configure the ring threshold registers of an Rx/Tx 348 * queue for an Ethernet port. 349 */ 350 struct rte_eth_thresh { 351 uint8_t pthresh; /**< Ring prefetch threshold. */ 352 uint8_t hthresh; /**< Ring host threshold. */ 353 uint8_t wthresh; /**< Ring writeback threshold. */ 354 }; 355 356 /**@{@name Multi-queue mode 357 * @see rte_eth_conf.rxmode.mq_mode. 358 */ 359 #define ETH_MQ_RX_RSS_FLAG 0x1 /**< Enable RSS. @see rte_eth_rss_conf */ 360 #define ETH_MQ_RX_DCB_FLAG 0x2 /**< Enable DCB. */ 361 #define ETH_MQ_RX_VMDQ_FLAG 0x4 /**< Enable VMDq. */ 362 /**@}*/ 363 364 /** 365 * A set of values to identify what method is to be used to route 366 * packets to multiple queues. 367 */ 368 enum rte_eth_rx_mq_mode { 369 /** None of DCB, RSS or VMDq mode */ 370 ETH_MQ_RX_NONE = 0, 371 372 /** For Rx side, only RSS is on */ 373 ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG, 374 /** For Rx side,only DCB is on. */ 375 ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG, 376 /** Both DCB and RSS enable */ 377 ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG, 378 379 /** Only VMDq, no RSS nor DCB */ 380 ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG, 381 /** RSS mode with VMDq */ 382 ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG, 383 /** Use VMDq+DCB to route traffic to queues */ 384 ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG, 385 /** Enable both VMDq and DCB in VMDq */ 386 ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG | 387 ETH_MQ_RX_VMDQ_FLAG, 388 }; 389 390 /** 391 * for Rx mq mode backward compatible 392 */ 393 #define ETH_RSS ETH_MQ_RX_RSS 394 #define VMDQ_DCB ETH_MQ_RX_VMDQ_DCB 395 #define ETH_DCB_RX ETH_MQ_RX_DCB 396 397 /** 398 * A set of values to identify what method is to be used to transmit 399 * packets using multi-TCs. 400 */ 401 enum rte_eth_tx_mq_mode { 402 ETH_MQ_TX_NONE = 0, /**< It is in neither DCB nor VT mode. */ 403 ETH_MQ_TX_DCB, /**< For Tx side,only DCB is on. */ 404 ETH_MQ_TX_VMDQ_DCB, /**< For Tx side,both DCB and VT is on. */ 405 ETH_MQ_TX_VMDQ_ONLY, /**< Only VT on, no DCB */ 406 }; 407 408 /** 409 * for Tx mq mode backward compatible 410 */ 411 #define ETH_DCB_NONE ETH_MQ_TX_NONE 412 #define ETH_VMDQ_DCB_TX ETH_MQ_TX_VMDQ_DCB 413 #define ETH_DCB_TX ETH_MQ_TX_DCB 414 415 /** 416 * A structure used to configure the Rx features of an Ethernet port. 417 */ 418 struct rte_eth_rxmode { 419 /** The multi-queue packet distribution mode to be used, e.g. RSS. */ 420 enum rte_eth_rx_mq_mode mq_mode; 421 uint32_t mtu; /**< Requested MTU. */ 422 /** Maximum allowed size of LRO aggregated packet. */ 423 uint32_t max_lro_pkt_size; 424 uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/ 425 /** 426 * Per-port Rx offloads to be set using DEV_RX_OFFLOAD_* flags. 427 * Only offloads set on rx_offload_capa field on rte_eth_dev_info 428 * structure are allowed to be set. 429 */ 430 uint64_t offloads; 431 432 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 433 void *reserved_ptrs[2]; /**< Reserved for future fields */ 434 }; 435 436 /** 437 * VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN. 438 * Note that single VLAN is treated the same as inner VLAN. 439 */ 440 enum rte_vlan_type { 441 ETH_VLAN_TYPE_UNKNOWN = 0, 442 ETH_VLAN_TYPE_INNER, /**< Inner VLAN. */ 443 ETH_VLAN_TYPE_OUTER, /**< Single VLAN, or outer VLAN. */ 444 ETH_VLAN_TYPE_MAX, 445 }; 446 447 /** 448 * A structure used to describe a VLAN filter. 449 * If the bit corresponding to a VID is set, such VID is on. 450 */ 451 struct rte_vlan_filter_conf { 452 uint64_t ids[64]; 453 }; 454 455 /** 456 * A structure used to configure the Receive Side Scaling (RSS) feature 457 * of an Ethernet port. 458 * If not NULL, the *rss_key* pointer of the *rss_conf* structure points 459 * to an array holding the RSS key to use for hashing specific header 460 * fields of received packets. The length of this array should be indicated 461 * by *rss_key_len* below. Otherwise, a default random hash key is used by 462 * the device driver. 463 * 464 * The *rss_key_len* field of the *rss_conf* structure indicates the length 465 * in bytes of the array pointed by *rss_key*. To be compatible, this length 466 * will be checked in i40e only. Others assume 40 bytes to be used as before. 467 * 468 * The *rss_hf* field of the *rss_conf* structure indicates the different 469 * types of IPv4/IPv6 packets to which the RSS hashing must be applied. 470 * Supplying an *rss_hf* equal to zero disables the RSS feature. 471 */ 472 struct rte_eth_rss_conf { 473 uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */ 474 uint8_t rss_key_len; /**< hash key length in bytes. */ 475 uint64_t rss_hf; /**< Hash functions to apply - see below. */ 476 }; 477 478 /* 479 * A packet can be identified by hardware as different flow types. Different 480 * NIC hardware may support different flow types. 481 * Basically, the NIC hardware identifies the flow type as deep protocol as 482 * possible, and exclusively. For example, if a packet is identified as 483 * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types, 484 * though it is an actual IPV4 packet. 485 */ 486 #define RTE_ETH_FLOW_UNKNOWN 0 487 #define RTE_ETH_FLOW_RAW 1 488 #define RTE_ETH_FLOW_IPV4 2 489 #define RTE_ETH_FLOW_FRAG_IPV4 3 490 #define RTE_ETH_FLOW_NONFRAG_IPV4_TCP 4 491 #define RTE_ETH_FLOW_NONFRAG_IPV4_UDP 5 492 #define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP 6 493 #define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER 7 494 #define RTE_ETH_FLOW_IPV6 8 495 #define RTE_ETH_FLOW_FRAG_IPV6 9 496 #define RTE_ETH_FLOW_NONFRAG_IPV6_TCP 10 497 #define RTE_ETH_FLOW_NONFRAG_IPV6_UDP 11 498 #define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP 12 499 #define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13 500 #define RTE_ETH_FLOW_L2_PAYLOAD 14 501 #define RTE_ETH_FLOW_IPV6_EX 15 502 #define RTE_ETH_FLOW_IPV6_TCP_EX 16 503 #define RTE_ETH_FLOW_IPV6_UDP_EX 17 504 /** Consider device port number as a flow differentiator */ 505 #define RTE_ETH_FLOW_PORT 18 506 #define RTE_ETH_FLOW_VXLAN 19 /**< VXLAN protocol based flow */ 507 #define RTE_ETH_FLOW_GENEVE 20 /**< GENEVE protocol based flow */ 508 #define RTE_ETH_FLOW_NVGRE 21 /**< NVGRE protocol based flow */ 509 #define RTE_ETH_FLOW_VXLAN_GPE 22 /**< VXLAN-GPE protocol based flow */ 510 #define RTE_ETH_FLOW_GTPU 23 /**< GTPU protocol based flow */ 511 #define RTE_ETH_FLOW_MAX 24 512 513 /* 514 * Below macros are defined for RSS offload types, they can be used to 515 * fill rte_eth_rss_conf.rss_hf or rte_flow_action_rss.types. 516 */ 517 #define ETH_RSS_IPV4 RTE_BIT64(2) 518 #define ETH_RSS_FRAG_IPV4 RTE_BIT64(3) 519 #define ETH_RSS_NONFRAG_IPV4_TCP RTE_BIT64(4) 520 #define ETH_RSS_NONFRAG_IPV4_UDP RTE_BIT64(5) 521 #define ETH_RSS_NONFRAG_IPV4_SCTP RTE_BIT64(6) 522 #define ETH_RSS_NONFRAG_IPV4_OTHER RTE_BIT64(7) 523 #define ETH_RSS_IPV6 RTE_BIT64(8) 524 #define ETH_RSS_FRAG_IPV6 RTE_BIT64(9) 525 #define ETH_RSS_NONFRAG_IPV6_TCP RTE_BIT64(10) 526 #define ETH_RSS_NONFRAG_IPV6_UDP RTE_BIT64(11) 527 #define ETH_RSS_NONFRAG_IPV6_SCTP RTE_BIT64(12) 528 #define ETH_RSS_NONFRAG_IPV6_OTHER RTE_BIT64(13) 529 #define ETH_RSS_L2_PAYLOAD RTE_BIT64(14) 530 #define ETH_RSS_IPV6_EX RTE_BIT64(15) 531 #define ETH_RSS_IPV6_TCP_EX RTE_BIT64(16) 532 #define ETH_RSS_IPV6_UDP_EX RTE_BIT64(17) 533 #define ETH_RSS_PORT RTE_BIT64(18) 534 #define ETH_RSS_VXLAN RTE_BIT64(19) 535 #define ETH_RSS_GENEVE RTE_BIT64(20) 536 #define ETH_RSS_NVGRE RTE_BIT64(21) 537 #define ETH_RSS_GTPU RTE_BIT64(23) 538 #define ETH_RSS_ETH RTE_BIT64(24) 539 #define ETH_RSS_S_VLAN RTE_BIT64(25) 540 #define ETH_RSS_C_VLAN RTE_BIT64(26) 541 #define ETH_RSS_ESP RTE_BIT64(27) 542 #define ETH_RSS_AH RTE_BIT64(28) 543 #define ETH_RSS_L2TPV3 RTE_BIT64(29) 544 #define ETH_RSS_PFCP RTE_BIT64(30) 545 #define ETH_RSS_PPPOE RTE_BIT64(31) 546 #define ETH_RSS_ECPRI RTE_BIT64(32) 547 #define ETH_RSS_MPLS RTE_BIT64(33) 548 #define ETH_RSS_IPV4_CHKSUM RTE_BIT64(34) 549 550 /** 551 * The ETH_RSS_L4_CHKSUM works on checksum field of any L4 header. 552 * It is similar to ETH_RSS_PORT that they don't specify the specific type of 553 * L4 header. This macro is defined to replace some specific L4 (TCP/UDP/SCTP) 554 * checksum type for constructing the use of RSS offload bits. 555 * 556 * Due to above reason, some old APIs (and configuration) don't support 557 * ETH_RSS_L4_CHKSUM. The rte_flow RSS API supports it. 558 * 559 * For the case that checksum is not used in an UDP header, 560 * it takes the reserved value 0 as input for the hash function. 561 */ 562 #define ETH_RSS_L4_CHKSUM RTE_BIT64(35) 563 564 /* 565 * We use the following macros to combine with above ETH_RSS_* for 566 * more specific input set selection. These bits are defined starting 567 * from the high end of the 64 bits. 568 * Note: If we use above ETH_RSS_* without SRC/DST_ONLY, it represents 569 * both SRC and DST are taken into account. If SRC_ONLY and DST_ONLY of 570 * the same level are used simultaneously, it is the same case as none of 571 * them are added. 572 */ 573 #define ETH_RSS_L3_SRC_ONLY RTE_BIT64(63) 574 #define ETH_RSS_L3_DST_ONLY RTE_BIT64(62) 575 #define ETH_RSS_L4_SRC_ONLY RTE_BIT64(61) 576 #define ETH_RSS_L4_DST_ONLY RTE_BIT64(60) 577 #define ETH_RSS_L2_SRC_ONLY RTE_BIT64(59) 578 #define ETH_RSS_L2_DST_ONLY RTE_BIT64(58) 579 580 /* 581 * Only select IPV6 address prefix as RSS input set according to 582 * https://tools.ietf.org/html/rfc6052 583 * Must be combined with ETH_RSS_IPV6, ETH_RSS_NONFRAG_IPV6_UDP, 584 * ETH_RSS_NONFRAG_IPV6_TCP, ETH_RSS_NONFRAG_IPV6_SCTP. 585 */ 586 #define RTE_ETH_RSS_L3_PRE32 RTE_BIT64(57) 587 #define RTE_ETH_RSS_L3_PRE40 RTE_BIT64(56) 588 #define RTE_ETH_RSS_L3_PRE48 RTE_BIT64(55) 589 #define RTE_ETH_RSS_L3_PRE56 RTE_BIT64(54) 590 #define RTE_ETH_RSS_L3_PRE64 RTE_BIT64(53) 591 #define RTE_ETH_RSS_L3_PRE96 RTE_BIT64(52) 592 593 /* 594 * Use the following macros to combine with the above layers 595 * to choose inner and outer layers or both for RSS computation. 596 * Bits 50 and 51 are reserved for this. 597 */ 598 599 /** 600 * level 0, requests the default behavior. 601 * Depending on the packet type, it can mean outermost, innermost, 602 * anything in between or even no RSS. 603 * It basically stands for the innermost encapsulation level RSS 604 * can be performed on according to PMD and device capabilities. 605 */ 606 #define ETH_RSS_LEVEL_PMD_DEFAULT (0ULL << 50) 607 608 /** 609 * level 1, requests RSS to be performed on the outermost packet 610 * encapsulation level. 611 */ 612 #define ETH_RSS_LEVEL_OUTERMOST (1ULL << 50) 613 614 /** 615 * level 2, requests RSS to be performed on the specified inner packet 616 * encapsulation level, from outermost to innermost (lower to higher values). 617 */ 618 #define ETH_RSS_LEVEL_INNERMOST (2ULL << 50) 619 #define ETH_RSS_LEVEL_MASK (3ULL << 50) 620 621 #define ETH_RSS_LEVEL(rss_hf) ((rss_hf & ETH_RSS_LEVEL_MASK) >> 50) 622 623 /** 624 * For input set change of hash filter, if SRC_ONLY and DST_ONLY of 625 * the same level are used simultaneously, it is the same case as 626 * none of them are added. 627 * 628 * @param rss_hf 629 * RSS types with SRC/DST_ONLY. 630 * @return 631 * RSS types. 632 */ 633 static inline uint64_t 634 rte_eth_rss_hf_refine(uint64_t rss_hf) 635 { 636 if ((rss_hf & ETH_RSS_L3_SRC_ONLY) && (rss_hf & ETH_RSS_L3_DST_ONLY)) 637 rss_hf &= ~(ETH_RSS_L3_SRC_ONLY | ETH_RSS_L3_DST_ONLY); 638 639 if ((rss_hf & ETH_RSS_L4_SRC_ONLY) && (rss_hf & ETH_RSS_L4_DST_ONLY)) 640 rss_hf &= ~(ETH_RSS_L4_SRC_ONLY | ETH_RSS_L4_DST_ONLY); 641 642 return rss_hf; 643 } 644 645 #define ETH_RSS_IPV6_PRE32 ( \ 646 ETH_RSS_IPV6 | \ 647 RTE_ETH_RSS_L3_PRE32) 648 649 #define ETH_RSS_IPV6_PRE40 ( \ 650 ETH_RSS_IPV6 | \ 651 RTE_ETH_RSS_L3_PRE40) 652 653 #define ETH_RSS_IPV6_PRE48 ( \ 654 ETH_RSS_IPV6 | \ 655 RTE_ETH_RSS_L3_PRE48) 656 657 #define ETH_RSS_IPV6_PRE56 ( \ 658 ETH_RSS_IPV6 | \ 659 RTE_ETH_RSS_L3_PRE56) 660 661 #define ETH_RSS_IPV6_PRE64 ( \ 662 ETH_RSS_IPV6 | \ 663 RTE_ETH_RSS_L3_PRE64) 664 665 #define ETH_RSS_IPV6_PRE96 ( \ 666 ETH_RSS_IPV6 | \ 667 RTE_ETH_RSS_L3_PRE96) 668 669 #define ETH_RSS_IPV6_PRE32_UDP ( \ 670 ETH_RSS_NONFRAG_IPV6_UDP | \ 671 RTE_ETH_RSS_L3_PRE32) 672 673 #define ETH_RSS_IPV6_PRE40_UDP ( \ 674 ETH_RSS_NONFRAG_IPV6_UDP | \ 675 RTE_ETH_RSS_L3_PRE40) 676 677 #define ETH_RSS_IPV6_PRE48_UDP ( \ 678 ETH_RSS_NONFRAG_IPV6_UDP | \ 679 RTE_ETH_RSS_L3_PRE48) 680 681 #define ETH_RSS_IPV6_PRE56_UDP ( \ 682 ETH_RSS_NONFRAG_IPV6_UDP | \ 683 RTE_ETH_RSS_L3_PRE56) 684 685 #define ETH_RSS_IPV6_PRE64_UDP ( \ 686 ETH_RSS_NONFRAG_IPV6_UDP | \ 687 RTE_ETH_RSS_L3_PRE64) 688 689 #define ETH_RSS_IPV6_PRE96_UDP ( \ 690 ETH_RSS_NONFRAG_IPV6_UDP | \ 691 RTE_ETH_RSS_L3_PRE96) 692 693 #define ETH_RSS_IPV6_PRE32_TCP ( \ 694 ETH_RSS_NONFRAG_IPV6_TCP | \ 695 RTE_ETH_RSS_L3_PRE32) 696 697 #define ETH_RSS_IPV6_PRE40_TCP ( \ 698 ETH_RSS_NONFRAG_IPV6_TCP | \ 699 RTE_ETH_RSS_L3_PRE40) 700 701 #define ETH_RSS_IPV6_PRE48_TCP ( \ 702 ETH_RSS_NONFRAG_IPV6_TCP | \ 703 RTE_ETH_RSS_L3_PRE48) 704 705 #define ETH_RSS_IPV6_PRE56_TCP ( \ 706 ETH_RSS_NONFRAG_IPV6_TCP | \ 707 RTE_ETH_RSS_L3_PRE56) 708 709 #define ETH_RSS_IPV6_PRE64_TCP ( \ 710 ETH_RSS_NONFRAG_IPV6_TCP | \ 711 RTE_ETH_RSS_L3_PRE64) 712 713 #define ETH_RSS_IPV6_PRE96_TCP ( \ 714 ETH_RSS_NONFRAG_IPV6_TCP | \ 715 RTE_ETH_RSS_L3_PRE96) 716 717 #define ETH_RSS_IPV6_PRE32_SCTP ( \ 718 ETH_RSS_NONFRAG_IPV6_SCTP | \ 719 RTE_ETH_RSS_L3_PRE32) 720 721 #define ETH_RSS_IPV6_PRE40_SCTP ( \ 722 ETH_RSS_NONFRAG_IPV6_SCTP | \ 723 RTE_ETH_RSS_L3_PRE40) 724 725 #define ETH_RSS_IPV6_PRE48_SCTP ( \ 726 ETH_RSS_NONFRAG_IPV6_SCTP | \ 727 RTE_ETH_RSS_L3_PRE48) 728 729 #define ETH_RSS_IPV6_PRE56_SCTP ( \ 730 ETH_RSS_NONFRAG_IPV6_SCTP | \ 731 RTE_ETH_RSS_L3_PRE56) 732 733 #define ETH_RSS_IPV6_PRE64_SCTP ( \ 734 ETH_RSS_NONFRAG_IPV6_SCTP | \ 735 RTE_ETH_RSS_L3_PRE64) 736 737 #define ETH_RSS_IPV6_PRE96_SCTP ( \ 738 ETH_RSS_NONFRAG_IPV6_SCTP | \ 739 RTE_ETH_RSS_L3_PRE96) 740 741 #define ETH_RSS_IP ( \ 742 ETH_RSS_IPV4 | \ 743 ETH_RSS_FRAG_IPV4 | \ 744 ETH_RSS_NONFRAG_IPV4_OTHER | \ 745 ETH_RSS_IPV6 | \ 746 ETH_RSS_FRAG_IPV6 | \ 747 ETH_RSS_NONFRAG_IPV6_OTHER | \ 748 ETH_RSS_IPV6_EX) 749 750 #define ETH_RSS_UDP ( \ 751 ETH_RSS_NONFRAG_IPV4_UDP | \ 752 ETH_RSS_NONFRAG_IPV6_UDP | \ 753 ETH_RSS_IPV6_UDP_EX) 754 755 #define ETH_RSS_TCP ( \ 756 ETH_RSS_NONFRAG_IPV4_TCP | \ 757 ETH_RSS_NONFRAG_IPV6_TCP | \ 758 ETH_RSS_IPV6_TCP_EX) 759 760 #define ETH_RSS_SCTP ( \ 761 ETH_RSS_NONFRAG_IPV4_SCTP | \ 762 ETH_RSS_NONFRAG_IPV6_SCTP) 763 764 #define ETH_RSS_TUNNEL ( \ 765 ETH_RSS_VXLAN | \ 766 ETH_RSS_GENEVE | \ 767 ETH_RSS_NVGRE) 768 769 #define ETH_RSS_VLAN ( \ 770 ETH_RSS_S_VLAN | \ 771 ETH_RSS_C_VLAN) 772 773 /** Mask of valid RSS hash protocols */ 774 #define ETH_RSS_PROTO_MASK ( \ 775 ETH_RSS_IPV4 | \ 776 ETH_RSS_FRAG_IPV4 | \ 777 ETH_RSS_NONFRAG_IPV4_TCP | \ 778 ETH_RSS_NONFRAG_IPV4_UDP | \ 779 ETH_RSS_NONFRAG_IPV4_SCTP | \ 780 ETH_RSS_NONFRAG_IPV4_OTHER | \ 781 ETH_RSS_IPV6 | \ 782 ETH_RSS_FRAG_IPV6 | \ 783 ETH_RSS_NONFRAG_IPV6_TCP | \ 784 ETH_RSS_NONFRAG_IPV6_UDP | \ 785 ETH_RSS_NONFRAG_IPV6_SCTP | \ 786 ETH_RSS_NONFRAG_IPV6_OTHER | \ 787 ETH_RSS_L2_PAYLOAD | \ 788 ETH_RSS_IPV6_EX | \ 789 ETH_RSS_IPV6_TCP_EX | \ 790 ETH_RSS_IPV6_UDP_EX | \ 791 ETH_RSS_PORT | \ 792 ETH_RSS_VXLAN | \ 793 ETH_RSS_GENEVE | \ 794 ETH_RSS_NVGRE | \ 795 ETH_RSS_MPLS) 796 797 /* 798 * Definitions used for redirection table entry size. 799 * Some RSS RETA sizes may not be supported by some drivers, check the 800 * documentation or the description of relevant functions for more details. 801 */ 802 #define ETH_RSS_RETA_SIZE_64 64 803 #define ETH_RSS_RETA_SIZE_128 128 804 #define ETH_RSS_RETA_SIZE_256 256 805 #define ETH_RSS_RETA_SIZE_512 512 806 #define RTE_RETA_GROUP_SIZE 64 807 808 /**@{@name VMDq and DCB maximums */ 809 #define ETH_VMDQ_MAX_VLAN_FILTERS 64 /**< Maximum nb. of VMDq VLAN filters. */ 810 #define ETH_DCB_NUM_USER_PRIORITIES 8 /**< Maximum nb. of DCB priorities. */ 811 #define ETH_VMDQ_DCB_NUM_QUEUES 128 /**< Maximum nb. of VMDq DCB queues. */ 812 #define ETH_DCB_NUM_QUEUES 128 /**< Maximum nb. of DCB queues. */ 813 /**@}*/ 814 815 /**@{@name DCB capabilities */ 816 #define ETH_DCB_PG_SUPPORT 0x00000001 /**< Priority Group(ETS) support. */ 817 #define ETH_DCB_PFC_SUPPORT 0x00000002 /**< Priority Flow Control support. */ 818 /**@}*/ 819 820 /**@{@name VLAN offload bits */ 821 #define ETH_VLAN_STRIP_OFFLOAD 0x0001 /**< VLAN Strip On/Off */ 822 #define ETH_VLAN_FILTER_OFFLOAD 0x0002 /**< VLAN Filter On/Off */ 823 #define ETH_VLAN_EXTEND_OFFLOAD 0x0004 /**< VLAN Extend On/Off */ 824 #define ETH_QINQ_STRIP_OFFLOAD 0x0008 /**< QINQ Strip On/Off */ 825 826 #define ETH_VLAN_STRIP_MASK 0x0001 /**< VLAN Strip setting mask */ 827 #define ETH_VLAN_FILTER_MASK 0x0002 /**< VLAN Filter setting mask*/ 828 #define ETH_VLAN_EXTEND_MASK 0x0004 /**< VLAN Extend setting mask*/ 829 #define ETH_QINQ_STRIP_MASK 0x0008 /**< QINQ Strip setting mask */ 830 #define ETH_VLAN_ID_MAX 0x0FFF /**< VLAN ID is in lower 12 bits*/ 831 /**@}*/ 832 833 /* Definitions used for receive MAC address */ 834 #define ETH_NUM_RECEIVE_MAC_ADDR 128 /**< Maximum nb. of receive mac addr. */ 835 836 /* Definitions used for unicast hash */ 837 #define ETH_VMDQ_NUM_UC_HASH_ARRAY 128 /**< Maximum nb. of UC hash array. */ 838 839 /**@{@name VMDq Rx mode 840 * @see rte_eth_vmdq_rx_conf.rx_mode 841 */ 842 #define ETH_VMDQ_ACCEPT_UNTAG 0x0001 /**< accept untagged packets. */ 843 #define ETH_VMDQ_ACCEPT_HASH_MC 0x0002 /**< accept packets in multicast table . */ 844 #define ETH_VMDQ_ACCEPT_HASH_UC 0x0004 /**< accept packets in unicast table. */ 845 #define ETH_VMDQ_ACCEPT_BROADCAST 0x0008 /**< accept broadcast packets. */ 846 #define ETH_VMDQ_ACCEPT_MULTICAST 0x0010 /**< multicast promiscuous. */ 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_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 ETH_4_TCS = 4, /**< 4 TCs with DCB. */ 868 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 ETH_8_POOLS = 8, /**< 8 VMDq pools. */ 877 ETH_16_POOLS = 16, /**< 16 VMDq pools. */ 878 ETH_32_POOLS = 32, /**< 32 VMDq pools. */ 879 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[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[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[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[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */ 925 /** Selects a queue in a pool */ 926 uint8_t dcb_tc[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 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 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[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 DEV_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 offsets from the segment description elements specify 1000 * the data offset from the buffer beginning except the first mbuf. 1001 * The first segment offset is added with RTE_PKTMBUF_HEADROOM. 1002 * 1003 * - The lengths in the elements define the maximal data amount 1004 * being received to each segment. The receiving starts with filling 1005 * up the first mbuf data buffer up to specified length. If the 1006 * there are data remaining (packet is longer than buffer in the first 1007 * mbuf) the following data will be pushed to the next segment 1008 * up to its own length, and so on. 1009 * 1010 * - If the length in the segment description element is zero 1011 * the actual buffer size will be deduced from the appropriate 1012 * memory pool properties. 1013 * 1014 * - If there is not enough elements to describe the buffer for entire 1015 * packet of maximal length the following parameters will be used 1016 * for the all remaining segments: 1017 * - pool from the last valid element 1018 * - the buffer size from this pool 1019 * - zero offset 1020 */ 1021 struct rte_eth_rxseg_split { 1022 struct rte_mempool *mp; /**< Memory pool to allocate segment from. */ 1023 uint16_t length; /**< Segment data length, configures split point. */ 1024 uint16_t offset; /**< Data offset from beginning of mbuf data buffer. */ 1025 uint32_t reserved; /**< Reserved field. */ 1026 }; 1027 1028 /** 1029 * @warning 1030 * @b EXPERIMENTAL: this structure may change without prior notice. 1031 * 1032 * A common structure used to describe Rx packet segment properties. 1033 */ 1034 union rte_eth_rxseg { 1035 /* The settings for buffer split offload. */ 1036 struct rte_eth_rxseg_split split; 1037 /* The other features settings should be added here. */ 1038 }; 1039 1040 /** 1041 * A structure used to configure an Rx ring of an Ethernet port. 1042 */ 1043 struct rte_eth_rxconf { 1044 struct rte_eth_thresh rx_thresh; /**< Rx ring threshold registers. */ 1045 uint16_t rx_free_thresh; /**< Drives the freeing of Rx descriptors. */ 1046 uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */ 1047 uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */ 1048 uint16_t rx_nseg; /**< Number of descriptions in rx_seg array. */ 1049 /** 1050 * Share group index in Rx domain and switch domain. 1051 * Non-zero value to enable Rx queue share, zero value disable share. 1052 * PMD is responsible for Rx queue consistency checks to avoid member 1053 * port's configuration contradict to each other. 1054 */ 1055 uint16_t share_group; 1056 uint16_t share_qid; /**< Shared Rx queue ID in group */ 1057 /** 1058 * Per-queue Rx offloads to be set using DEV_RX_OFFLOAD_* flags. 1059 * Only offloads set on rx_queue_offload_capa or rx_offload_capa 1060 * fields on rte_eth_dev_info structure are allowed to be set. 1061 */ 1062 uint64_t offloads; 1063 /** 1064 * Points to the array of segment descriptions for an entire packet. 1065 * Array elements are properties for consecutive Rx segments. 1066 * 1067 * The supported capabilities of receiving segmentation is reported 1068 * in rte_eth_dev_info.rx_seg_capa field. 1069 */ 1070 union rte_eth_rxseg *rx_seg; 1071 1072 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 1073 void *reserved_ptrs[2]; /**< Reserved for future fields */ 1074 }; 1075 1076 /** 1077 * A structure used to configure a Tx ring of an Ethernet port. 1078 */ 1079 struct rte_eth_txconf { 1080 struct rte_eth_thresh tx_thresh; /**< Tx ring threshold registers. */ 1081 uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */ 1082 uint16_t tx_free_thresh; /**< Start freeing Tx buffers if there are 1083 less free descriptors than this value. */ 1084 1085 uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */ 1086 /** 1087 * Per-queue Tx offloads to be set using DEV_TX_OFFLOAD_* flags. 1088 * Only offloads set on tx_queue_offload_capa or tx_offload_capa 1089 * fields on rte_eth_dev_info structure are allowed to be set. 1090 */ 1091 uint64_t offloads; 1092 1093 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 1094 void *reserved_ptrs[2]; /**< Reserved for future fields */ 1095 }; 1096 1097 /** 1098 * @warning 1099 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1100 * 1101 * A structure used to return the hairpin capabilities that are supported. 1102 */ 1103 struct rte_eth_hairpin_cap { 1104 /** The max number of hairpin queues (different bindings). */ 1105 uint16_t max_nb_queues; 1106 /** Max number of Rx queues to be connected to one Tx queue. */ 1107 uint16_t max_rx_2_tx; 1108 /** Max number of Tx queues to be connected to one Rx queue. */ 1109 uint16_t max_tx_2_rx; 1110 uint16_t max_nb_desc; /**< The max num of descriptors. */ 1111 }; 1112 1113 #define RTE_ETH_MAX_HAIRPIN_PEERS 32 1114 1115 /** 1116 * @warning 1117 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1118 * 1119 * A structure used to hold hairpin peer data. 1120 */ 1121 struct rte_eth_hairpin_peer { 1122 uint16_t port; /**< Peer port. */ 1123 uint16_t queue; /**< Peer queue. */ 1124 }; 1125 1126 /** 1127 * @warning 1128 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 1129 * 1130 * A structure used to configure hairpin binding. 1131 */ 1132 struct rte_eth_hairpin_conf { 1133 uint32_t peer_count:16; /**< The number of peers. */ 1134 1135 /** 1136 * Explicit Tx flow rule mode. 1137 * One hairpin pair of queues should have the same attribute. 1138 * 1139 * - When set, the user should be responsible for inserting the hairpin 1140 * Tx part flows and removing them. 1141 * - When clear, the PMD will try to handle the Tx part of the flows, 1142 * e.g., by splitting one flow into two parts. 1143 */ 1144 uint32_t tx_explicit:1; 1145 1146 /** 1147 * Manually bind hairpin queues. 1148 * One hairpin pair of queues should have the same attribute. 1149 * 1150 * - When set, to enable hairpin, the user should call the hairpin bind 1151 * function after all the queues are set up properly and the ports are 1152 * started. Also, the hairpin unbind function should be called 1153 * accordingly before stopping a port that with hairpin configured. 1154 * - When clear, the PMD will try to enable the hairpin with the queues 1155 * configured automatically during port start. 1156 */ 1157 uint32_t manual_bind:1; 1158 uint32_t reserved:14; /**< Reserved bits. */ 1159 struct rte_eth_hairpin_peer peers[RTE_ETH_MAX_HAIRPIN_PEERS]; 1160 }; 1161 1162 /** 1163 * A structure contains information about HW descriptor ring limitations. 1164 */ 1165 struct rte_eth_desc_lim { 1166 uint16_t nb_max; /**< Max allowed number of descriptors. */ 1167 uint16_t nb_min; /**< Min allowed number of descriptors. */ 1168 uint16_t nb_align; /**< Number of descriptors should be aligned to. */ 1169 1170 /** 1171 * Max allowed number of segments per whole packet. 1172 * 1173 * - For TSO packet this is the total number of data descriptors allowed 1174 * by device. 1175 * 1176 * @see nb_mtu_seg_max 1177 */ 1178 uint16_t nb_seg_max; 1179 1180 /** 1181 * Max number of segments per one MTU. 1182 * 1183 * - For non-TSO packet, this is the maximum allowed number of segments 1184 * in a single transmit packet. 1185 * 1186 * - For TSO packet each segment within the TSO may span up to this 1187 * value. 1188 * 1189 * @see nb_seg_max 1190 */ 1191 uint16_t nb_mtu_seg_max; 1192 }; 1193 1194 /** 1195 * This enum indicates the flow control mode 1196 */ 1197 enum rte_eth_fc_mode { 1198 RTE_FC_NONE = 0, /**< Disable flow control. */ 1199 RTE_FC_RX_PAUSE, /**< Rx pause frame, enable flowctrl on Tx side. */ 1200 RTE_FC_TX_PAUSE, /**< Tx pause frame, enable flowctrl on Rx side. */ 1201 RTE_FC_FULL /**< Enable flow control on both side. */ 1202 }; 1203 1204 /** 1205 * A structure used to configure Ethernet flow control parameter. 1206 * These parameters will be configured into the register of the NIC. 1207 * Please refer to the corresponding data sheet for proper value. 1208 */ 1209 struct rte_eth_fc_conf { 1210 uint32_t high_water; /**< High threshold value to trigger XOFF */ 1211 uint32_t low_water; /**< Low threshold value to trigger XON */ 1212 uint16_t pause_time; /**< Pause quota in the Pause frame */ 1213 uint16_t send_xon; /**< Is XON frame need be sent */ 1214 enum rte_eth_fc_mode mode; /**< Link flow control mode */ 1215 uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */ 1216 uint8_t autoneg; /**< Use Pause autoneg */ 1217 }; 1218 1219 /** 1220 * A structure used to configure Ethernet priority flow control parameter. 1221 * These parameters will be configured into the register of the NIC. 1222 * Please refer to the corresponding data sheet for proper value. 1223 */ 1224 struct rte_eth_pfc_conf { 1225 struct rte_eth_fc_conf fc; /**< General flow control parameter. */ 1226 uint8_t priority; /**< VLAN User Priority. */ 1227 }; 1228 1229 /** 1230 * Tunnel type for device-specific classifier configuration. 1231 * @see rte_eth_udp_tunnel 1232 */ 1233 enum rte_eth_tunnel_type { 1234 RTE_TUNNEL_TYPE_NONE = 0, 1235 RTE_TUNNEL_TYPE_VXLAN, 1236 RTE_TUNNEL_TYPE_GENEVE, 1237 RTE_TUNNEL_TYPE_TEREDO, 1238 RTE_TUNNEL_TYPE_NVGRE, 1239 RTE_TUNNEL_TYPE_IP_IN_GRE, 1240 RTE_L2_TUNNEL_TYPE_E_TAG, 1241 RTE_TUNNEL_TYPE_VXLAN_GPE, 1242 RTE_TUNNEL_TYPE_ECPRI, 1243 RTE_TUNNEL_TYPE_MAX, 1244 }; 1245 1246 /* Deprecated API file for rte_eth_dev_filter_* functions */ 1247 #include "rte_eth_ctrl.h" 1248 1249 /** 1250 * Memory space that can be configured to store Flow Director filters 1251 * in the board memory. 1252 */ 1253 enum rte_fdir_pballoc_type { 1254 RTE_FDIR_PBALLOC_64K = 0, /**< 64k. */ 1255 RTE_FDIR_PBALLOC_128K, /**< 128k. */ 1256 RTE_FDIR_PBALLOC_256K, /**< 256k. */ 1257 }; 1258 1259 /** 1260 * Select report mode of FDIR hash information in Rx descriptors. 1261 */ 1262 enum rte_fdir_status_mode { 1263 RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */ 1264 RTE_FDIR_REPORT_STATUS, /**< Only report FDIR hash for matching pkts. */ 1265 RTE_FDIR_REPORT_STATUS_ALWAYS, /**< Always report FDIR hash. */ 1266 }; 1267 1268 /** 1269 * A structure used to configure the Flow Director (FDIR) feature 1270 * of an Ethernet port. 1271 * 1272 * If mode is RTE_FDIR_MODE_NONE, the pballoc value is ignored. 1273 */ 1274 struct rte_fdir_conf { 1275 enum rte_fdir_mode mode; /**< Flow Director mode. */ 1276 enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */ 1277 enum rte_fdir_status_mode status; /**< How to report FDIR hash. */ 1278 /** Rx queue of packets matching a "drop" filter in perfect mode. */ 1279 uint8_t drop_queue; 1280 struct rte_eth_fdir_masks mask; 1281 /** Flex payload configuration. */ 1282 struct rte_eth_fdir_flex_conf flex_conf; 1283 }; 1284 1285 /** 1286 * UDP tunneling configuration. 1287 * 1288 * Used to configure the classifier of a device, 1289 * associating an UDP port with a type of tunnel. 1290 * 1291 * Some NICs may need such configuration to properly parse a tunnel 1292 * with any standard or custom UDP port. 1293 */ 1294 struct rte_eth_udp_tunnel { 1295 uint16_t udp_port; /**< UDP port used for the tunnel. */ 1296 uint8_t prot_type; /**< Tunnel type. @see rte_eth_tunnel_type */ 1297 }; 1298 1299 /** 1300 * A structure used to enable/disable specific device interrupts. 1301 */ 1302 struct rte_intr_conf { 1303 /** enable/disable lsc interrupt. 0 (default) - disable, 1 enable */ 1304 uint32_t lsc:1; 1305 /** enable/disable rxq interrupt. 0 (default) - disable, 1 enable */ 1306 uint32_t rxq:1; 1307 /** enable/disable rmv interrupt. 0 (default) - disable, 1 enable */ 1308 uint32_t rmv:1; 1309 }; 1310 1311 /** 1312 * A structure used to configure an Ethernet port. 1313 * Depending upon the Rx multi-queue mode, extra advanced 1314 * configuration settings may be needed. 1315 */ 1316 struct rte_eth_conf { 1317 uint32_t link_speeds; /**< bitmap of ETH_LINK_SPEED_XXX of speeds to be 1318 used. ETH_LINK_SPEED_FIXED disables link 1319 autonegotiation, and a unique speed shall be 1320 set. Otherwise, the bitmap defines the set of 1321 speeds to be advertised. If the special value 1322 ETH_LINK_SPEED_AUTONEG (0) is used, all speeds 1323 supported are advertised. */ 1324 struct rte_eth_rxmode rxmode; /**< Port Rx configuration. */ 1325 struct rte_eth_txmode txmode; /**< Port Tx configuration. */ 1326 uint32_t lpbk_mode; /**< Loopback operation mode. By default the value 1327 is 0, meaning the loopback mode is disabled. 1328 Read the datasheet of given Ethernet controller 1329 for details. The possible values of this field 1330 are defined in implementation of each driver. */ 1331 struct { 1332 struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */ 1333 /** Port VMDq+DCB configuration. */ 1334 struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf; 1335 /** Port DCB Rx configuration. */ 1336 struct rte_eth_dcb_rx_conf dcb_rx_conf; 1337 /** Port VMDq Rx configuration. */ 1338 struct rte_eth_vmdq_rx_conf vmdq_rx_conf; 1339 } rx_adv_conf; /**< Port Rx filtering configuration. */ 1340 union { 1341 /** Port VMDq+DCB Tx configuration. */ 1342 struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf; 1343 /** Port DCB Tx configuration. */ 1344 struct rte_eth_dcb_tx_conf dcb_tx_conf; 1345 /** Port VMDq Tx configuration. */ 1346 struct rte_eth_vmdq_tx_conf vmdq_tx_conf; 1347 } tx_adv_conf; /**< Port Tx DCB configuration (union). */ 1348 /** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC 1349 is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */ 1350 uint32_t dcb_capability_en; 1351 struct rte_fdir_conf fdir_conf; /**< FDIR configuration. DEPRECATED */ 1352 struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */ 1353 }; 1354 1355 /** 1356 * Rx offload capabilities of a device. 1357 */ 1358 #define DEV_RX_OFFLOAD_VLAN_STRIP 0x00000001 1359 #define DEV_RX_OFFLOAD_IPV4_CKSUM 0x00000002 1360 #define DEV_RX_OFFLOAD_UDP_CKSUM 0x00000004 1361 #define DEV_RX_OFFLOAD_TCP_CKSUM 0x00000008 1362 #define DEV_RX_OFFLOAD_TCP_LRO 0x00000010 1363 #define DEV_RX_OFFLOAD_QINQ_STRIP 0x00000020 1364 #define DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000040 1365 #define DEV_RX_OFFLOAD_MACSEC_STRIP 0x00000080 1366 #define DEV_RX_OFFLOAD_HEADER_SPLIT 0x00000100 1367 #define DEV_RX_OFFLOAD_VLAN_FILTER 0x00000200 1368 #define DEV_RX_OFFLOAD_VLAN_EXTEND 0x00000400 1369 #define DEV_RX_OFFLOAD_SCATTER 0x00002000 1370 /** 1371 * Timestamp is set by the driver in RTE_MBUF_DYNFIELD_TIMESTAMP_NAME 1372 * and RTE_MBUF_DYNFLAG_RX_TIMESTAMP_NAME is set in ol_flags. 1373 * The mbuf field and flag are registered when the offload is configured. 1374 */ 1375 #define DEV_RX_OFFLOAD_TIMESTAMP 0x00004000 1376 #define DEV_RX_OFFLOAD_SECURITY 0x00008000 1377 #define DEV_RX_OFFLOAD_KEEP_CRC 0x00010000 1378 #define DEV_RX_OFFLOAD_SCTP_CKSUM 0x00020000 1379 #define DEV_RX_OFFLOAD_OUTER_UDP_CKSUM 0x00040000 1380 #define DEV_RX_OFFLOAD_RSS_HASH 0x00080000 1381 #define RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT 0x00100000 1382 1383 #define DEV_RX_OFFLOAD_CHECKSUM (DEV_RX_OFFLOAD_IPV4_CKSUM | \ 1384 DEV_RX_OFFLOAD_UDP_CKSUM | \ 1385 DEV_RX_OFFLOAD_TCP_CKSUM) 1386 #define DEV_RX_OFFLOAD_VLAN (DEV_RX_OFFLOAD_VLAN_STRIP | \ 1387 DEV_RX_OFFLOAD_VLAN_FILTER | \ 1388 DEV_RX_OFFLOAD_VLAN_EXTEND | \ 1389 DEV_RX_OFFLOAD_QINQ_STRIP) 1390 1391 /* 1392 * If new Rx offload capabilities are defined, they also must be 1393 * mentioned in rte_rx_offload_names in rte_ethdev.c file. 1394 */ 1395 1396 /** 1397 * Tx offload capabilities of a device. 1398 */ 1399 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001 1400 #define DEV_TX_OFFLOAD_IPV4_CKSUM 0x00000002 1401 #define DEV_TX_OFFLOAD_UDP_CKSUM 0x00000004 1402 #define DEV_TX_OFFLOAD_TCP_CKSUM 0x00000008 1403 #define DEV_TX_OFFLOAD_SCTP_CKSUM 0x00000010 1404 #define DEV_TX_OFFLOAD_TCP_TSO 0x00000020 1405 #define DEV_TX_OFFLOAD_UDP_TSO 0x00000040 1406 #define DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM 0x00000080 /**< Used for tunneling packet. */ 1407 #define DEV_TX_OFFLOAD_QINQ_INSERT 0x00000100 1408 #define DEV_TX_OFFLOAD_VXLAN_TNL_TSO 0x00000200 /**< Used for tunneling packet. */ 1409 #define DEV_TX_OFFLOAD_GRE_TNL_TSO 0x00000400 /**< Used for tunneling packet. */ 1410 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO 0x00000800 /**< Used for tunneling packet. */ 1411 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO 0x00001000 /**< Used for tunneling packet. */ 1412 #define DEV_TX_OFFLOAD_MACSEC_INSERT 0x00002000 1413 /** 1414 * Multiple threads can invoke rte_eth_tx_burst() concurrently on the same 1415 * Tx queue without SW lock. 1416 */ 1417 #define DEV_TX_OFFLOAD_MT_LOCKFREE 0x00004000 1418 /** Device supports multi segment send. */ 1419 #define DEV_TX_OFFLOAD_MULTI_SEGS 0x00008000 1420 /** 1421 * Device supports optimization for fast release of mbufs. 1422 * When set application must guarantee that per-queue all mbufs comes from 1423 * the same mempool and has refcnt = 1. 1424 */ 1425 #define DEV_TX_OFFLOAD_MBUF_FAST_FREE 0x00010000 1426 #define DEV_TX_OFFLOAD_SECURITY 0x00020000 1427 /** 1428 * Device supports generic UDP tunneled packet TSO. 1429 * Application must set PKT_TX_TUNNEL_UDP and other mbuf fields required 1430 * for tunnel TSO. 1431 */ 1432 #define DEV_TX_OFFLOAD_UDP_TNL_TSO 0x00040000 1433 /** 1434 * Device supports generic IP tunneled packet TSO. 1435 * Application must set PKT_TX_TUNNEL_IP and other mbuf fields required 1436 * for tunnel TSO. 1437 */ 1438 #define DEV_TX_OFFLOAD_IP_TNL_TSO 0x00080000 1439 /** Device supports outer UDP checksum */ 1440 #define DEV_TX_OFFLOAD_OUTER_UDP_CKSUM 0x00100000 1441 /** 1442 * Device sends on time read from RTE_MBUF_DYNFIELD_TIMESTAMP_NAME 1443 * if RTE_MBUF_DYNFLAG_TX_TIMESTAMP_NAME is set in ol_flags. 1444 * The mbuf field and flag are registered when the offload is configured. 1445 */ 1446 #define DEV_TX_OFFLOAD_SEND_ON_TIMESTAMP 0x00200000 1447 /* 1448 * If new Tx offload capabilities are defined, they also must be 1449 * mentioned in rte_tx_offload_names in rte_ethdev.c file. 1450 */ 1451 1452 /**@{@name Device capabilities 1453 * Non-offload capabilities reported in rte_eth_dev_info.dev_capa. 1454 */ 1455 /** Device supports Rx queue setup after device started. */ 1456 #define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP 0x00000001 1457 /** Device supports Tx queue setup after device started. */ 1458 #define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP 0x00000002 1459 /** 1460 * Device supports shared Rx queue among ports within Rx domain and 1461 * switch domain. Mbufs are consumed by shared Rx queue instead of 1462 * each queue. Multiple groups are supported by share_group of Rx 1463 * queue configuration. Shared Rx queue is identified by PMD using 1464 * share_qid of Rx queue configuration. Polling any port in the group 1465 * receive packets of all member ports, source port identified by 1466 * mbuf->port field. 1467 */ 1468 #define RTE_ETH_DEV_CAPA_RXQ_SHARE RTE_BIT64(2) 1469 /**@}*/ 1470 1471 /* 1472 * Fallback default preferred Rx/Tx port parameters. 1473 * These are used if an application requests default parameters 1474 * but the PMD does not provide preferred values. 1475 */ 1476 #define RTE_ETH_DEV_FALLBACK_RX_RINGSIZE 512 1477 #define RTE_ETH_DEV_FALLBACK_TX_RINGSIZE 512 1478 #define RTE_ETH_DEV_FALLBACK_RX_NBQUEUES 1 1479 #define RTE_ETH_DEV_FALLBACK_TX_NBQUEUES 1 1480 1481 /** 1482 * Preferred Rx/Tx port parameters. 1483 * There are separate instances of this structure for transmission 1484 * and reception respectively. 1485 */ 1486 struct rte_eth_dev_portconf { 1487 uint16_t burst_size; /**< Device-preferred burst size */ 1488 uint16_t ring_size; /**< Device-preferred size of queue rings */ 1489 uint16_t nb_queues; /**< Device-preferred number of queues */ 1490 }; 1491 1492 /** 1493 * Default values for switch domain ID when ethdev does not support switch 1494 * domain definitions. 1495 */ 1496 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (UINT16_MAX) 1497 1498 /** 1499 * Ethernet device associated switch information 1500 */ 1501 struct rte_eth_switch_info { 1502 const char *name; /**< switch name */ 1503 uint16_t domain_id; /**< switch domain ID */ 1504 /** 1505 * Mapping to the devices physical switch port as enumerated from the 1506 * perspective of the embedded interconnect/switch. For SR-IOV enabled 1507 * device this may correspond to the VF_ID of each virtual function, 1508 * but each driver should explicitly define the mapping of switch 1509 * port identifier to that physical interconnect/switch 1510 */ 1511 uint16_t port_id; 1512 /** 1513 * Shared Rx queue sub-domain boundary. Only ports in same Rx domain 1514 * and switch domain can share Rx queue. Valid only if device advertised 1515 * RTE_ETH_DEV_CAPA_RXQ_SHARE capability. 1516 */ 1517 uint16_t rx_domain; 1518 }; 1519 1520 /** 1521 * @warning 1522 * @b EXPERIMENTAL: this structure may change without prior notice. 1523 * 1524 * Ethernet device Rx buffer segmentation capabilities. 1525 */ 1526 struct rte_eth_rxseg_capa { 1527 __extension__ 1528 uint32_t multi_pools:1; /**< Supports receiving to multiple pools.*/ 1529 uint32_t offset_allowed:1; /**< Supports buffer offsets. */ 1530 uint32_t offset_align_log2:4; /**< Required offset alignment. */ 1531 uint16_t max_nseg; /**< Maximum amount of segments to split. */ 1532 uint16_t reserved; /**< Reserved field. */ 1533 }; 1534 1535 /** 1536 * Ethernet device information 1537 */ 1538 1539 /** 1540 * Ethernet device representor port type. 1541 */ 1542 enum rte_eth_representor_type { 1543 RTE_ETH_REPRESENTOR_NONE, /**< not a representor. */ 1544 RTE_ETH_REPRESENTOR_VF, /**< representor of Virtual Function. */ 1545 RTE_ETH_REPRESENTOR_SF, /**< representor of Sub Function. */ 1546 RTE_ETH_REPRESENTOR_PF, /**< representor of Physical Function. */ 1547 }; 1548 1549 /** 1550 * A structure used to retrieve the contextual information of 1551 * an Ethernet device, such as the controlling driver of the 1552 * device, etc... 1553 */ 1554 struct rte_eth_dev_info { 1555 struct rte_device *device; /** Generic device information */ 1556 const char *driver_name; /**< Device Driver name. */ 1557 unsigned int if_index; /**< Index to bound host interface, or 0 if none. 1558 Use if_indextoname() to translate into an interface name. */ 1559 uint16_t min_mtu; /**< Minimum MTU allowed */ 1560 uint16_t max_mtu; /**< Maximum MTU allowed */ 1561 const uint32_t *dev_flags; /**< Device flags */ 1562 uint32_t min_rx_bufsize; /**< Minimum size of Rx buffer. */ 1563 uint32_t max_rx_pktlen; /**< Maximum configurable length of Rx pkt. */ 1564 /** Maximum configurable size of LRO aggregated packet. */ 1565 uint32_t max_lro_pkt_size; 1566 uint16_t max_rx_queues; /**< Maximum number of Rx queues. */ 1567 uint16_t max_tx_queues; /**< Maximum number of Tx queues. */ 1568 uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */ 1569 uint32_t max_hash_mac_addrs; 1570 /** Maximum number of hash MAC addresses for MTA and UTA. */ 1571 uint16_t max_vfs; /**< Maximum number of VFs. */ 1572 uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */ 1573 struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/ 1574 /** All Rx offload capabilities including all per-queue ones */ 1575 uint64_t rx_offload_capa; 1576 /** All Tx offload capabilities including all per-queue ones */ 1577 uint64_t tx_offload_capa; 1578 /** Device per-queue Rx offload capabilities. */ 1579 uint64_t rx_queue_offload_capa; 1580 /** Device per-queue Tx offload capabilities. */ 1581 uint64_t tx_queue_offload_capa; 1582 /** Device redirection table size, the total number of entries. */ 1583 uint16_t reta_size; 1584 uint8_t hash_key_size; /**< Hash key size in bytes */ 1585 /** Bit mask of RSS offloads, the bit offset also means flow type */ 1586 uint64_t flow_type_rss_offloads; 1587 struct rte_eth_rxconf default_rxconf; /**< Default Rx configuration */ 1588 struct rte_eth_txconf default_txconf; /**< Default Tx configuration */ 1589 uint16_t vmdq_queue_base; /**< First queue ID for VMDq pools. */ 1590 uint16_t vmdq_queue_num; /**< Queue number for VMDq pools. */ 1591 uint16_t vmdq_pool_base; /**< First ID of VMDq pools. */ 1592 struct rte_eth_desc_lim rx_desc_lim; /**< Rx descriptors limits */ 1593 struct rte_eth_desc_lim tx_desc_lim; /**< Tx descriptors limits */ 1594 uint32_t speed_capa; /**< Supported speeds bitmap (ETH_LINK_SPEED_). */ 1595 /** Configured number of Rx/Tx queues */ 1596 uint16_t nb_rx_queues; /**< Number of Rx queues. */ 1597 uint16_t nb_tx_queues; /**< Number of Tx queues. */ 1598 /** Rx parameter recommendations */ 1599 struct rte_eth_dev_portconf default_rxportconf; 1600 /** Tx parameter recommendations */ 1601 struct rte_eth_dev_portconf default_txportconf; 1602 /** Generic device capabilities (RTE_ETH_DEV_CAPA_). */ 1603 uint64_t dev_capa; 1604 /** 1605 * Switching information for ports on a device with a 1606 * embedded managed interconnect/switch. 1607 */ 1608 struct rte_eth_switch_info switch_info; 1609 1610 uint64_t reserved_64s[2]; /**< Reserved for future fields */ 1611 void *reserved_ptrs[2]; /**< Reserved for future fields */ 1612 }; 1613 1614 /**@{@name Rx/Tx queue states */ 1615 #define RTE_ETH_QUEUE_STATE_STOPPED 0 /**< Queue stopped. */ 1616 #define RTE_ETH_QUEUE_STATE_STARTED 1 /**< Queue started. */ 1617 #define RTE_ETH_QUEUE_STATE_HAIRPIN 2 /**< Queue used for hairpin. */ 1618 /**@}*/ 1619 1620 /** 1621 * Ethernet device Rx queue information structure. 1622 * Used to retrieve information about configured queue. 1623 */ 1624 struct rte_eth_rxq_info { 1625 struct rte_mempool *mp; /**< mempool used by that queue. */ 1626 struct rte_eth_rxconf conf; /**< queue config parameters. */ 1627 uint8_t scattered_rx; /**< scattered packets Rx supported. */ 1628 uint8_t queue_state; /**< one of RTE_ETH_QUEUE_STATE_*. */ 1629 uint16_t nb_desc; /**< configured number of RXDs. */ 1630 uint16_t rx_buf_size; /**< hardware receive buffer size. */ 1631 } __rte_cache_min_aligned; 1632 1633 /** 1634 * Ethernet device Tx queue information structure. 1635 * Used to retrieve information about configured queue. 1636 */ 1637 struct rte_eth_txq_info { 1638 struct rte_eth_txconf conf; /**< queue config parameters. */ 1639 uint16_t nb_desc; /**< configured number of TXDs. */ 1640 uint8_t queue_state; /**< one of RTE_ETH_QUEUE_STATE_*. */ 1641 } __rte_cache_min_aligned; 1642 1643 /* Generic Burst mode flag definition, values can be ORed. */ 1644 1645 /** 1646 * If the queues have different burst mode description, this bit will be set 1647 * by PMD, then the application can iterate to retrieve burst description for 1648 * all other queues. 1649 */ 1650 #define RTE_ETH_BURST_FLAG_PER_QUEUE RTE_BIT64(0) 1651 1652 /** 1653 * Ethernet device Rx/Tx queue packet burst mode information structure. 1654 * Used to retrieve information about packet burst mode setting. 1655 */ 1656 struct rte_eth_burst_mode { 1657 uint64_t flags; /**< The ORed values of RTE_ETH_BURST_FLAG_xxx */ 1658 1659 #define RTE_ETH_BURST_MODE_INFO_SIZE 1024 /**< Maximum size for information */ 1660 char info[RTE_ETH_BURST_MODE_INFO_SIZE]; /**< burst mode information */ 1661 }; 1662 1663 /** Maximum name length for extended statistics counters */ 1664 #define RTE_ETH_XSTATS_NAME_SIZE 64 1665 1666 /** 1667 * An Ethernet device extended statistic structure 1668 * 1669 * This structure is used by rte_eth_xstats_get() to provide 1670 * statistics that are not provided in the generic *rte_eth_stats* 1671 * structure. 1672 * It maps a name ID, corresponding to an index in the array returned 1673 * by rte_eth_xstats_get_names(), to a statistic value. 1674 */ 1675 struct rte_eth_xstat { 1676 uint64_t id; /**< The index in xstats name array. */ 1677 uint64_t value; /**< The statistic counter value. */ 1678 }; 1679 1680 /** 1681 * A name element for extended statistics. 1682 * 1683 * An array of this structure is returned by rte_eth_xstats_get_names(). 1684 * It lists the names of extended statistics for a PMD. The *rte_eth_xstat* 1685 * structure references these names by their array index. 1686 * 1687 * The xstats should follow a common naming scheme. 1688 * Some names are standardized in rte_stats_strings. 1689 * Examples: 1690 * - rx_missed_errors 1691 * - tx_q3_bytes 1692 * - tx_size_128_to_255_packets 1693 */ 1694 struct rte_eth_xstat_name { 1695 char name[RTE_ETH_XSTATS_NAME_SIZE]; /**< The statistic name. */ 1696 }; 1697 1698 #define ETH_DCB_NUM_TCS 8 1699 #define ETH_MAX_VMDQ_POOL 64 1700 1701 /** 1702 * A structure used to get the information of queue and 1703 * TC mapping on both Tx and Rx paths. 1704 */ 1705 struct rte_eth_dcb_tc_queue_mapping { 1706 /** Rx queues assigned to tc per Pool */ 1707 struct { 1708 uint16_t base; 1709 uint16_t nb_queue; 1710 } tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS]; 1711 /** Rx queues assigned to tc per Pool */ 1712 struct { 1713 uint16_t base; 1714 uint16_t nb_queue; 1715 } tc_txq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS]; 1716 }; 1717 1718 /** 1719 * A structure used to get the information of DCB. 1720 * It includes TC UP mapping and queue TC mapping. 1721 */ 1722 struct rte_eth_dcb_info { 1723 uint8_t nb_tcs; /**< number of TCs */ 1724 uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */ 1725 uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< Tx BW percentage for each TC */ 1726 /** Rx queues assigned to tc */ 1727 struct rte_eth_dcb_tc_queue_mapping tc_queue; 1728 }; 1729 1730 /** 1731 * This enum indicates the possible Forward Error Correction (FEC) modes 1732 * of an ethdev port. 1733 */ 1734 enum rte_eth_fec_mode { 1735 RTE_ETH_FEC_NOFEC = 0, /**< FEC is off */ 1736 RTE_ETH_FEC_AUTO, /**< FEC autonegotiation modes */ 1737 RTE_ETH_FEC_BASER, /**< FEC using common algorithm */ 1738 RTE_ETH_FEC_RS, /**< FEC using RS algorithm */ 1739 }; 1740 1741 /* Translate from FEC mode to FEC capa */ 1742 #define RTE_ETH_FEC_MODE_TO_CAPA(x) RTE_BIT32(x) 1743 1744 /* This macro indicates FEC capa mask */ 1745 #define RTE_ETH_FEC_MODE_CAPA_MASK(x) RTE_BIT32(RTE_ETH_FEC_ ## x) 1746 1747 /* A structure used to get capabilities per link speed */ 1748 struct rte_eth_fec_capa { 1749 uint32_t speed; /**< Link speed (see ETH_SPEED_NUM_*) */ 1750 uint32_t capa; /**< FEC capabilities bitmask */ 1751 }; 1752 1753 #define RTE_ETH_ALL RTE_MAX_ETHPORTS 1754 1755 /* Macros to check for valid port */ 1756 #define RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, retval) do { \ 1757 if (!rte_eth_dev_is_valid_port(port_id)) { \ 1758 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \ 1759 return retval; \ 1760 } \ 1761 } while (0) 1762 1763 #define RTE_ETH_VALID_PORTID_OR_RET(port_id) do { \ 1764 if (!rte_eth_dev_is_valid_port(port_id)) { \ 1765 RTE_ETHDEV_LOG(ERR, "Invalid port_id=%u\n", port_id); \ 1766 return; \ 1767 } \ 1768 } while (0) 1769 1770 /** 1771 * Function type used for Rx packet processing packet callbacks. 1772 * 1773 * The callback function is called on Rx with a burst of packets that have 1774 * been received on the given port and queue. 1775 * 1776 * @param port_id 1777 * The Ethernet port on which Rx is being performed. 1778 * @param queue 1779 * The queue on the Ethernet port which is being used to receive the packets. 1780 * @param pkts 1781 * The burst of packets that have just been received. 1782 * @param nb_pkts 1783 * The number of packets in the burst pointed to by "pkts". 1784 * @param max_pkts 1785 * The max number of packets that can be stored in the "pkts" array. 1786 * @param user_param 1787 * The arbitrary user parameter passed in by the application when the callback 1788 * was originally configured. 1789 * @return 1790 * The number of packets returned to the user. 1791 */ 1792 typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue, 1793 struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts, 1794 void *user_param); 1795 1796 /** 1797 * Function type used for Tx packet processing packet callbacks. 1798 * 1799 * The callback function is called on Tx with a burst of packets immediately 1800 * before the packets are put onto the hardware queue for transmission. 1801 * 1802 * @param port_id 1803 * The Ethernet port on which Tx is being performed. 1804 * @param queue 1805 * The queue on the Ethernet port which is being used to transmit the packets. 1806 * @param pkts 1807 * The burst of packets that are about to be transmitted. 1808 * @param nb_pkts 1809 * The number of packets in the burst pointed to by "pkts". 1810 * @param user_param 1811 * The arbitrary user parameter passed in by the application when the callback 1812 * was originally configured. 1813 * @return 1814 * The number of packets to be written to the NIC. 1815 */ 1816 typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue, 1817 struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param); 1818 1819 /** 1820 * Possible states of an ethdev port. 1821 */ 1822 enum rte_eth_dev_state { 1823 /** Device is unused before being probed. */ 1824 RTE_ETH_DEV_UNUSED = 0, 1825 /** Device is attached when allocated in probing. */ 1826 RTE_ETH_DEV_ATTACHED, 1827 /** Device is in removed state when plug-out is detected. */ 1828 RTE_ETH_DEV_REMOVED, 1829 }; 1830 1831 struct rte_eth_dev_sriov { 1832 uint8_t active; /**< SRIOV is active with 16, 32 or 64 pools */ 1833 uint8_t nb_q_per_pool; /**< Rx queue number per pool */ 1834 uint16_t def_vmdq_idx; /**< Default pool num used for PF */ 1835 uint16_t def_pool_q_idx; /**< Default pool queue start reg index */ 1836 }; 1837 #define RTE_ETH_DEV_SRIOV(dev) ((dev)->data->sriov) 1838 1839 #define RTE_ETH_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN 1840 1841 #define RTE_ETH_DEV_NO_OWNER 0 1842 1843 #define RTE_ETH_MAX_OWNER_NAME_LEN 64 1844 1845 struct rte_eth_dev_owner { 1846 uint64_t id; /**< The owner unique identifier. */ 1847 char name[RTE_ETH_MAX_OWNER_NAME_LEN]; /**< The owner name. */ 1848 }; 1849 1850 /**@{@name Device flags 1851 * Flags internally saved in rte_eth_dev_data.dev_flags 1852 * and reported in rte_eth_dev_info.dev_flags. 1853 */ 1854 /** PMD supports thread-safe flow operations */ 1855 #define RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE 0x0001 1856 /** Device supports link state interrupt */ 1857 #define RTE_ETH_DEV_INTR_LSC 0x0002 1858 /** Device is a bonded slave */ 1859 #define RTE_ETH_DEV_BONDED_SLAVE 0x0004 1860 /** Device supports device removal interrupt */ 1861 #define RTE_ETH_DEV_INTR_RMV 0x0008 1862 /** Device is port representor */ 1863 #define RTE_ETH_DEV_REPRESENTOR 0x0010 1864 /** Device does not support MAC change after started */ 1865 #define RTE_ETH_DEV_NOLIVE_MAC_ADDR 0x0020 1866 /** 1867 * Queue xstats filled automatically by ethdev layer. 1868 * PMDs filling the queue xstats themselves should not set this flag 1869 */ 1870 #define RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS 0x0040 1871 /**@}*/ 1872 1873 /** 1874 * Iterates over valid ethdev ports owned by a specific owner. 1875 * 1876 * @param port_id 1877 * The ID of the next possible valid owned port. 1878 * @param owner_id 1879 * The owner identifier. 1880 * RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports. 1881 * @return 1882 * Next valid port ID owned by owner_id, RTE_MAX_ETHPORTS if there is none. 1883 */ 1884 uint64_t rte_eth_find_next_owned_by(uint16_t port_id, 1885 const uint64_t owner_id); 1886 1887 /** 1888 * Macro to iterate over all enabled ethdev ports owned by a specific owner. 1889 */ 1890 #define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o) \ 1891 for (p = rte_eth_find_next_owned_by(0, o); \ 1892 (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS; \ 1893 p = rte_eth_find_next_owned_by(p + 1, o)) 1894 1895 /** 1896 * Iterates over valid ethdev ports. 1897 * 1898 * @param port_id 1899 * The ID of the next possible valid port. 1900 * @return 1901 * Next valid port ID, RTE_MAX_ETHPORTS if there is none. 1902 */ 1903 uint16_t rte_eth_find_next(uint16_t port_id); 1904 1905 /** 1906 * Macro to iterate over all enabled and ownerless ethdev ports. 1907 */ 1908 #define RTE_ETH_FOREACH_DEV(p) \ 1909 RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER) 1910 1911 /** 1912 * Iterates over ethdev ports of a specified device. 1913 * 1914 * @param port_id_start 1915 * The ID of the next possible valid port. 1916 * @param parent 1917 * The generic device behind the ports to iterate. 1918 * @return 1919 * Next port ID of the device, possibly port_id_start, 1920 * RTE_MAX_ETHPORTS if there is none. 1921 */ 1922 uint16_t 1923 rte_eth_find_next_of(uint16_t port_id_start, 1924 const struct rte_device *parent); 1925 1926 /** 1927 * Macro to iterate over all ethdev ports of a specified device. 1928 * 1929 * @param port_id 1930 * The ID of the matching port being iterated. 1931 * @param parent 1932 * The rte_device pointer matching the iterated ports. 1933 */ 1934 #define RTE_ETH_FOREACH_DEV_OF(port_id, parent) \ 1935 for (port_id = rte_eth_find_next_of(0, parent); \ 1936 port_id < RTE_MAX_ETHPORTS; \ 1937 port_id = rte_eth_find_next_of(port_id + 1, parent)) 1938 1939 /** 1940 * Iterates over sibling ethdev ports (i.e. sharing the same rte_device). 1941 * 1942 * @param port_id_start 1943 * The ID of the next possible valid sibling port. 1944 * @param ref_port_id 1945 * The ID of a reference port to compare rte_device with. 1946 * @return 1947 * Next sibling port ID, possibly port_id_start or ref_port_id itself, 1948 * RTE_MAX_ETHPORTS if there is none. 1949 */ 1950 uint16_t 1951 rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id); 1952 1953 /** 1954 * Macro to iterate over all ethdev ports sharing the same rte_device 1955 * as the specified port. 1956 * Note: the specified reference port is part of the loop iterations. 1957 * 1958 * @param port_id 1959 * The ID of the matching port being iterated. 1960 * @param ref_port_id 1961 * The ID of the port being compared. 1962 */ 1963 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \ 1964 for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \ 1965 port_id < RTE_MAX_ETHPORTS; \ 1966 port_id = rte_eth_find_next_sibling(port_id + 1, ref_port_id)) 1967 1968 /** 1969 * @warning 1970 * @b EXPERIMENTAL: this API may change without prior notice. 1971 * 1972 * Get a new unique owner identifier. 1973 * An owner identifier is used to owns Ethernet devices by only one DPDK entity 1974 * to avoid multiple management of device by different entities. 1975 * 1976 * @param owner_id 1977 * Owner identifier pointer. 1978 * @return 1979 * Negative errno value on error, 0 on success. 1980 */ 1981 __rte_experimental 1982 int rte_eth_dev_owner_new(uint64_t *owner_id); 1983 1984 /** 1985 * @warning 1986 * @b EXPERIMENTAL: this API may change without prior notice. 1987 * 1988 * Set an Ethernet device owner. 1989 * 1990 * @param port_id 1991 * The identifier of the port to own. 1992 * @param owner 1993 * The owner pointer. 1994 * @return 1995 * Negative errno value on error, 0 on success. 1996 */ 1997 __rte_experimental 1998 int rte_eth_dev_owner_set(const uint16_t port_id, 1999 const struct rte_eth_dev_owner *owner); 2000 2001 /** 2002 * @warning 2003 * @b EXPERIMENTAL: this API may change without prior notice. 2004 * 2005 * Unset Ethernet device owner to make the device ownerless. 2006 * 2007 * @param port_id 2008 * The identifier of port to make ownerless. 2009 * @param owner_id 2010 * The owner identifier. 2011 * @return 2012 * 0 on success, negative errno value on error. 2013 */ 2014 __rte_experimental 2015 int rte_eth_dev_owner_unset(const uint16_t port_id, 2016 const uint64_t owner_id); 2017 2018 /** 2019 * @warning 2020 * @b EXPERIMENTAL: this API may change without prior notice. 2021 * 2022 * Remove owner from all Ethernet devices owned by a specific owner. 2023 * 2024 * @param owner_id 2025 * The owner identifier. 2026 * @return 2027 * 0 on success, negative errno value on error. 2028 */ 2029 __rte_experimental 2030 int rte_eth_dev_owner_delete(const uint64_t owner_id); 2031 2032 /** 2033 * @warning 2034 * @b EXPERIMENTAL: this API may change without prior notice. 2035 * 2036 * Get the owner of an Ethernet device. 2037 * 2038 * @param port_id 2039 * The port identifier. 2040 * @param owner 2041 * The owner structure pointer to fill. 2042 * @return 2043 * 0 on success, negative errno value on error.. 2044 */ 2045 __rte_experimental 2046 int rte_eth_dev_owner_get(const uint16_t port_id, 2047 struct rte_eth_dev_owner *owner); 2048 2049 /** 2050 * Get the number of ports which are usable for the application. 2051 * 2052 * These devices must be iterated by using the macro 2053 * ``RTE_ETH_FOREACH_DEV`` or ``RTE_ETH_FOREACH_DEV_OWNED_BY`` 2054 * to deal with non-contiguous ranges of devices. 2055 * 2056 * @return 2057 * The count of available Ethernet devices. 2058 */ 2059 uint16_t rte_eth_dev_count_avail(void); 2060 2061 /** 2062 * Get the total number of ports which are allocated. 2063 * 2064 * Some devices may not be available for the application. 2065 * 2066 * @return 2067 * The total count of Ethernet devices. 2068 */ 2069 uint16_t rte_eth_dev_count_total(void); 2070 2071 /** 2072 * Convert a numerical speed in Mbps to a bitmap flag that can be used in 2073 * the bitmap link_speeds of the struct rte_eth_conf 2074 * 2075 * @param speed 2076 * Numerical speed value in Mbps 2077 * @param duplex 2078 * ETH_LINK_[HALF/FULL]_DUPLEX (only for 10/100M speeds) 2079 * @return 2080 * 0 if the speed cannot be mapped 2081 */ 2082 uint32_t rte_eth_speed_bitflag(uint32_t speed, int duplex); 2083 2084 /** 2085 * Get DEV_RX_OFFLOAD_* flag name. 2086 * 2087 * @param offload 2088 * Offload flag. 2089 * @return 2090 * Offload name or 'UNKNOWN' if the flag cannot be recognised. 2091 */ 2092 const char *rte_eth_dev_rx_offload_name(uint64_t offload); 2093 2094 /** 2095 * Get DEV_TX_OFFLOAD_* flag name. 2096 * 2097 * @param offload 2098 * Offload flag. 2099 * @return 2100 * Offload name or 'UNKNOWN' if the flag cannot be recognised. 2101 */ 2102 const char *rte_eth_dev_tx_offload_name(uint64_t offload); 2103 2104 /** 2105 * @warning 2106 * @b EXPERIMENTAL: this API may change without prior notice. 2107 * 2108 * Get RTE_ETH_DEV_CAPA_* flag name. 2109 * 2110 * @param capability 2111 * Capability flag. 2112 * @return 2113 * Capability name or 'UNKNOWN' if the flag cannot be recognized. 2114 */ 2115 __rte_experimental 2116 const char *rte_eth_dev_capability_name(uint64_t capability); 2117 2118 /** 2119 * Configure an Ethernet device. 2120 * This function must be invoked first before any other function in the 2121 * Ethernet API. This function can also be re-invoked when a device is in the 2122 * stopped state. 2123 * 2124 * @param port_id 2125 * The port identifier of the Ethernet device to configure. 2126 * @param nb_rx_queue 2127 * The number of receive queues to set up for the Ethernet device. 2128 * @param nb_tx_queue 2129 * The number of transmit queues to set up for the Ethernet device. 2130 * @param eth_conf 2131 * The pointer to the configuration data to be used for the Ethernet device. 2132 * The *rte_eth_conf* structure includes: 2133 * - the hardware offload features to activate, with dedicated fields for 2134 * each statically configurable offload hardware feature provided by 2135 * Ethernet devices, such as IP checksum or VLAN tag stripping for 2136 * example. 2137 * The Rx offload bitfield API is obsolete and will be deprecated. 2138 * Applications should set the ignore_bitfield_offloads bit on *rxmode* 2139 * structure and use offloads field to set per-port offloads instead. 2140 * - Any offloading set in eth_conf->[rt]xmode.offloads must be within 2141 * the [rt]x_offload_capa returned from rte_eth_dev_info_get(). 2142 * Any type of device supported offloading set in the input argument 2143 * eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled 2144 * on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup() 2145 * - the Receive Side Scaling (RSS) configuration when using multiple Rx 2146 * queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf 2147 * must be within the flow_type_rss_offloads provided by drivers via 2148 * rte_eth_dev_info_get() API. 2149 * 2150 * Embedding all configuration information in a single data structure 2151 * is the more flexible method that allows the addition of new features 2152 * without changing the syntax of the API. 2153 * @return 2154 * - 0: Success, device configured. 2155 * - <0: Error code returned by the driver configuration function. 2156 */ 2157 int rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_queue, 2158 uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf); 2159 2160 /** 2161 * @warning 2162 * @b EXPERIMENTAL: this API may change without prior notice. 2163 * 2164 * Check if an Ethernet device was physically removed. 2165 * 2166 * @param port_id 2167 * The port identifier of the Ethernet device. 2168 * @return 2169 * 1 when the Ethernet device is removed, otherwise 0. 2170 */ 2171 __rte_experimental 2172 int 2173 rte_eth_dev_is_removed(uint16_t port_id); 2174 2175 /** 2176 * Allocate and set up a receive queue for an Ethernet device. 2177 * 2178 * The function allocates a contiguous block of memory for *nb_rx_desc* 2179 * receive descriptors from a memory zone associated with *socket_id* 2180 * and initializes each receive descriptor with a network buffer allocated 2181 * from the memory pool *mb_pool*. 2182 * 2183 * @param port_id 2184 * The port identifier of the Ethernet device. 2185 * @param rx_queue_id 2186 * The index of the receive queue to set up. 2187 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2188 * to rte_eth_dev_configure(). 2189 * @param nb_rx_desc 2190 * The number of receive descriptors to allocate for the receive ring. 2191 * @param socket_id 2192 * The *socket_id* argument is the socket identifier in case of NUMA. 2193 * The value can be *SOCKET_ID_ANY* if there is no NUMA constraint for 2194 * the DMA memory allocated for the receive descriptors of the ring. 2195 * @param rx_conf 2196 * The pointer to the configuration data to be used for the receive queue. 2197 * NULL value is allowed, in which case default Rx configuration 2198 * will be used. 2199 * The *rx_conf* structure contains an *rx_thresh* structure with the values 2200 * of the Prefetch, Host, and Write-Back threshold registers of the receive 2201 * ring. 2202 * In addition it contains the hardware offloads features to activate using 2203 * the DEV_RX_OFFLOAD_* flags. 2204 * If an offloading set in rx_conf->offloads 2205 * hasn't been set in the input argument eth_conf->rxmode.offloads 2206 * to rte_eth_dev_configure(), it is a new added offloading, it must be 2207 * per-queue type and it is enabled for the queue. 2208 * No need to repeat any bit in rx_conf->offloads which has already been 2209 * enabled in rte_eth_dev_configure() at port level. An offloading enabled 2210 * at port level can't be disabled at queue level. 2211 * The configuration structure also contains the pointer to the array 2212 * of the receiving buffer segment descriptions, see rx_seg and rx_nseg 2213 * fields, this extended configuration might be used by split offloads like 2214 * RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT. If mb_pool is not NULL, 2215 * the extended configuration fields must be set to NULL and zero. 2216 * @param mb_pool 2217 * The pointer to the memory pool from which to allocate *rte_mbuf* network 2218 * memory buffers to populate each descriptor of the receive ring. There are 2219 * two options to provide Rx buffer configuration: 2220 * - single pool: 2221 * mb_pool is not NULL, rx_conf.rx_nseg is 0. 2222 * - multiple segments description: 2223 * mb_pool is NULL, rx_conf.rx_seg is not NULL, rx_conf.rx_nseg is not 0. 2224 * Taken only if flag RTE_ETH_RX_OFFLOAD_BUFFER_SPLIT is set in offloads. 2225 * 2226 * @return 2227 * - 0: Success, receive queue correctly set up. 2228 * - -EIO: if device is removed. 2229 * - -ENODEV: if *port_id* is invalid. 2230 * - -EINVAL: The memory pool pointer is null or the size of network buffers 2231 * which can be allocated from this memory pool does not fit the various 2232 * buffer sizes allowed by the device controller. 2233 * - -ENOMEM: Unable to allocate the receive ring descriptors or to 2234 * allocate network memory buffers from the memory pool when 2235 * initializing receive descriptors. 2236 */ 2237 int rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id, 2238 uint16_t nb_rx_desc, unsigned int socket_id, 2239 const struct rte_eth_rxconf *rx_conf, 2240 struct rte_mempool *mb_pool); 2241 2242 /** 2243 * @warning 2244 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2245 * 2246 * Allocate and set up a hairpin receive queue for an Ethernet device. 2247 * 2248 * The function set up the selected queue to be used in hairpin. 2249 * 2250 * @param port_id 2251 * The port identifier of the Ethernet device. 2252 * @param rx_queue_id 2253 * The index of the receive queue to set up. 2254 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2255 * to rte_eth_dev_configure(). 2256 * @param nb_rx_desc 2257 * The number of receive descriptors to allocate for the receive ring. 2258 * 0 means the PMD will use default value. 2259 * @param conf 2260 * The pointer to the hairpin configuration. 2261 * 2262 * @return 2263 * - (0) if successful. 2264 * - (-ENODEV) if *port_id* is invalid. 2265 * - (-ENOTSUP) if hardware doesn't support. 2266 * - (-EINVAL) if bad parameter. 2267 * - (-ENOMEM) if unable to allocate the resources. 2268 */ 2269 __rte_experimental 2270 int rte_eth_rx_hairpin_queue_setup 2271 (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc, 2272 const struct rte_eth_hairpin_conf *conf); 2273 2274 /** 2275 * Allocate and set up a transmit queue for an Ethernet device. 2276 * 2277 * @param port_id 2278 * The port identifier of the Ethernet device. 2279 * @param tx_queue_id 2280 * The index of the transmit queue to set up. 2281 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2282 * to rte_eth_dev_configure(). 2283 * @param nb_tx_desc 2284 * The number of transmit descriptors to allocate for the transmit ring. 2285 * @param socket_id 2286 * The *socket_id* argument is the socket identifier in case of NUMA. 2287 * Its value can be *SOCKET_ID_ANY* if there is no NUMA constraint for 2288 * the DMA memory allocated for the transmit descriptors of the ring. 2289 * @param tx_conf 2290 * The pointer to the configuration data to be used for the transmit queue. 2291 * NULL value is allowed, in which case default Tx configuration 2292 * will be used. 2293 * The *tx_conf* structure contains the following data: 2294 * - The *tx_thresh* structure with the values of the Prefetch, Host, and 2295 * Write-Back threshold registers of the transmit ring. 2296 * When setting Write-Back threshold to the value greater then zero, 2297 * *tx_rs_thresh* value should be explicitly set to one. 2298 * - The *tx_free_thresh* value indicates the [minimum] number of network 2299 * buffers that must be pending in the transmit ring to trigger their 2300 * [implicit] freeing by the driver transmit function. 2301 * - The *tx_rs_thresh* value indicates the [minimum] number of transmit 2302 * descriptors that must be pending in the transmit ring before setting the 2303 * RS bit on a descriptor by the driver transmit function. 2304 * The *tx_rs_thresh* value should be less or equal then 2305 * *tx_free_thresh* value, and both of them should be less then 2306 * *nb_tx_desc* - 3. 2307 * - The *offloads* member contains Tx offloads to be enabled. 2308 * If an offloading set in tx_conf->offloads 2309 * hasn't been set in the input argument eth_conf->txmode.offloads 2310 * to rte_eth_dev_configure(), it is a new added offloading, it must be 2311 * per-queue type and it is enabled for the queue. 2312 * No need to repeat any bit in tx_conf->offloads which has already been 2313 * enabled in rte_eth_dev_configure() at port level. An offloading enabled 2314 * at port level can't be disabled at queue level. 2315 * 2316 * Note that setting *tx_free_thresh* or *tx_rs_thresh* value to 0 forces 2317 * the transmit function to use default values. 2318 * @return 2319 * - 0: Success, the transmit queue is correctly set up. 2320 * - -ENOMEM: Unable to allocate the transmit ring descriptors. 2321 */ 2322 int rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id, 2323 uint16_t nb_tx_desc, unsigned int socket_id, 2324 const struct rte_eth_txconf *tx_conf); 2325 2326 /** 2327 * @warning 2328 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2329 * 2330 * Allocate and set up a transmit hairpin queue for an Ethernet device. 2331 * 2332 * @param port_id 2333 * The port identifier of the Ethernet device. 2334 * @param tx_queue_id 2335 * The index of the transmit queue to set up. 2336 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2337 * to rte_eth_dev_configure(). 2338 * @param nb_tx_desc 2339 * The number of transmit descriptors to allocate for the transmit ring. 2340 * 0 to set default PMD value. 2341 * @param conf 2342 * The hairpin configuration. 2343 * 2344 * @return 2345 * - (0) if successful. 2346 * - (-ENODEV) if *port_id* is invalid. 2347 * - (-ENOTSUP) if hardware doesn't support. 2348 * - (-EINVAL) if bad parameter. 2349 * - (-ENOMEM) if unable to allocate the resources. 2350 */ 2351 __rte_experimental 2352 int rte_eth_tx_hairpin_queue_setup 2353 (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc, 2354 const struct rte_eth_hairpin_conf *conf); 2355 2356 /** 2357 * @warning 2358 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2359 * 2360 * Get all the hairpin peer Rx / Tx ports of the current port. 2361 * The caller should ensure that the array is large enough to save the ports 2362 * list. 2363 * 2364 * @param port_id 2365 * The port identifier of the Ethernet device. 2366 * @param peer_ports 2367 * Pointer to the array to store the peer ports list. 2368 * @param len 2369 * Length of the array to store the port identifiers. 2370 * @param direction 2371 * Current port to peer port direction 2372 * positive - current used as Tx to get all peer Rx ports. 2373 * zero - current used as Rx to get all peer Tx ports. 2374 * 2375 * @return 2376 * - (0 or positive) actual peer ports number. 2377 * - (-EINVAL) if bad parameter. 2378 * - (-ENODEV) if *port_id* invalid 2379 * - (-ENOTSUP) if hardware doesn't support. 2380 * - Others detailed errors from PMD drivers. 2381 */ 2382 __rte_experimental 2383 int rte_eth_hairpin_get_peer_ports(uint16_t port_id, uint16_t *peer_ports, 2384 size_t len, uint32_t direction); 2385 2386 /** 2387 * @warning 2388 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2389 * 2390 * Bind all hairpin Tx queues of one port to the Rx queues of the peer port. 2391 * It is only allowed to call this function after all hairpin queues are 2392 * configured properly and the devices are in started state. 2393 * 2394 * @param tx_port 2395 * The identifier of the Tx port. 2396 * @param rx_port 2397 * The identifier of peer Rx port. 2398 * RTE_MAX_ETHPORTS is allowed for the traversal of all devices. 2399 * Rx port ID could have the same value as Tx port ID. 2400 * 2401 * @return 2402 * - (0) if successful. 2403 * - (-ENODEV) if Tx port ID is invalid. 2404 * - (-EBUSY) if device is not in started state. 2405 * - (-ENOTSUP) if hardware doesn't support. 2406 * - Others detailed errors from PMD drivers. 2407 */ 2408 __rte_experimental 2409 int rte_eth_hairpin_bind(uint16_t tx_port, uint16_t rx_port); 2410 2411 /** 2412 * @warning 2413 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 2414 * 2415 * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port. 2416 * This should be called before closing the Tx or Rx devices, if the bind 2417 * function is called before. 2418 * After unbinding the hairpin ports pair, it is allowed to bind them again. 2419 * Changing queues configuration should be after stopping the device(s). 2420 * 2421 * @param tx_port 2422 * The identifier of the Tx port. 2423 * @param rx_port 2424 * The identifier of peer Rx port. 2425 * RTE_MAX_ETHPORTS is allowed for traversal of all devices. 2426 * Rx port ID could have the same value as Tx port ID. 2427 * 2428 * @return 2429 * - (0) if successful. 2430 * - (-ENODEV) if Tx port ID is invalid. 2431 * - (-EBUSY) if device is in stopped state. 2432 * - (-ENOTSUP) if hardware doesn't support. 2433 * - Others detailed errors from PMD drivers. 2434 */ 2435 __rte_experimental 2436 int rte_eth_hairpin_unbind(uint16_t tx_port, uint16_t rx_port); 2437 2438 /** 2439 * Return the NUMA socket to which an Ethernet device is connected 2440 * 2441 * @param port_id 2442 * The port identifier of the Ethernet device 2443 * @return 2444 * The NUMA socket ID to which the Ethernet device is connected or 2445 * a default of zero if the socket could not be determined. 2446 * -1 is returned is the port_id value is out of range. 2447 */ 2448 int rte_eth_dev_socket_id(uint16_t port_id); 2449 2450 /** 2451 * Check if port_id of device is attached 2452 * 2453 * @param port_id 2454 * The port identifier of the Ethernet device 2455 * @return 2456 * - 0 if port is out of range or not attached 2457 * - 1 if device is attached 2458 */ 2459 int rte_eth_dev_is_valid_port(uint16_t port_id); 2460 2461 /** 2462 * Start specified Rx queue of a port. It is used when rx_deferred_start 2463 * flag of the specified queue is true. 2464 * 2465 * @param port_id 2466 * The port identifier of the Ethernet device 2467 * @param rx_queue_id 2468 * The index of the Rx queue to update the ring. 2469 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2470 * to rte_eth_dev_configure(). 2471 * @return 2472 * - 0: Success, the receive queue is started. 2473 * - -ENODEV: if *port_id* is invalid. 2474 * - -EINVAL: The queue_id out of range or belong to hairpin. 2475 * - -EIO: if device is removed. 2476 * - -ENOTSUP: The function not supported in PMD driver. 2477 */ 2478 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id); 2479 2480 /** 2481 * Stop specified Rx queue of a port 2482 * 2483 * @param port_id 2484 * The port identifier of the Ethernet device 2485 * @param rx_queue_id 2486 * The index of the Rx queue to update the ring. 2487 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 2488 * to rte_eth_dev_configure(). 2489 * @return 2490 * - 0: Success, the receive queue is stopped. 2491 * - -ENODEV: if *port_id* is invalid. 2492 * - -EINVAL: The queue_id out of range or belong to hairpin. 2493 * - -EIO: if device is removed. 2494 * - -ENOTSUP: The function not supported in PMD driver. 2495 */ 2496 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id); 2497 2498 /** 2499 * Start Tx for specified queue of a port. It is used when tx_deferred_start 2500 * flag of the specified queue is true. 2501 * 2502 * @param port_id 2503 * The port identifier of the Ethernet device 2504 * @param tx_queue_id 2505 * The index of the Tx queue to update the ring. 2506 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2507 * to rte_eth_dev_configure(). 2508 * @return 2509 * - 0: Success, the transmit queue is started. 2510 * - -ENODEV: if *port_id* is invalid. 2511 * - -EINVAL: The queue_id out of range or belong to hairpin. 2512 * - -EIO: if device is removed. 2513 * - -ENOTSUP: The function not supported in PMD driver. 2514 */ 2515 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id); 2516 2517 /** 2518 * Stop specified Tx queue of a port 2519 * 2520 * @param port_id 2521 * The port identifier of the Ethernet device 2522 * @param tx_queue_id 2523 * The index of the Tx queue to update the ring. 2524 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2525 * to rte_eth_dev_configure(). 2526 * @return 2527 * - 0: Success, the transmit queue is stopped. 2528 * - -ENODEV: if *port_id* is invalid. 2529 * - -EINVAL: The queue_id out of range or belong to hairpin. 2530 * - -EIO: if device is removed. 2531 * - -ENOTSUP: The function not supported in PMD driver. 2532 */ 2533 int rte_eth_dev_tx_queue_stop(uint16_t port_id, uint16_t tx_queue_id); 2534 2535 /** 2536 * Start an Ethernet device. 2537 * 2538 * The device start step is the last one and consists of setting the configured 2539 * offload features and in starting the transmit and the receive units of the 2540 * device. 2541 * 2542 * Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before 2543 * PMD port start callback function is invoked. 2544 * 2545 * On success, all basic functions exported by the Ethernet API (link status, 2546 * receive/transmit, and so on) can be invoked. 2547 * 2548 * @param port_id 2549 * The port identifier of the Ethernet device. 2550 * @return 2551 * - 0: Success, Ethernet device started. 2552 * - <0: Error code of the driver device start function. 2553 */ 2554 int rte_eth_dev_start(uint16_t port_id); 2555 2556 /** 2557 * Stop an Ethernet device. The device can be restarted with a call to 2558 * rte_eth_dev_start() 2559 * 2560 * @param port_id 2561 * The port identifier of the Ethernet device. 2562 * @return 2563 * - 0: Success, Ethernet device stopped. 2564 * - <0: Error code of the driver device stop function. 2565 */ 2566 int rte_eth_dev_stop(uint16_t port_id); 2567 2568 /** 2569 * Link up an Ethernet device. 2570 * 2571 * Set device link up will re-enable the device Rx/Tx 2572 * functionality after it is previously set device linked down. 2573 * 2574 * @param port_id 2575 * The port identifier of the Ethernet device. 2576 * @return 2577 * - 0: Success, Ethernet device linked up. 2578 * - <0: Error code of the driver device link up function. 2579 */ 2580 int rte_eth_dev_set_link_up(uint16_t port_id); 2581 2582 /** 2583 * Link down an Ethernet device. 2584 * The device Rx/Tx functionality will be disabled if success, 2585 * and it can be re-enabled with a call to 2586 * rte_eth_dev_set_link_up() 2587 * 2588 * @param port_id 2589 * The port identifier of the Ethernet device. 2590 */ 2591 int rte_eth_dev_set_link_down(uint16_t port_id); 2592 2593 /** 2594 * Close a stopped Ethernet device. The device cannot be restarted! 2595 * The function frees all port resources. 2596 * 2597 * @param port_id 2598 * The port identifier of the Ethernet device. 2599 * @return 2600 * - Zero if the port is closed successfully. 2601 * - Negative if something went wrong. 2602 */ 2603 int rte_eth_dev_close(uint16_t port_id); 2604 2605 /** 2606 * Reset a Ethernet device and keep its port ID. 2607 * 2608 * When a port has to be reset passively, the DPDK application can invoke 2609 * this function. For example when a PF is reset, all its VFs should also 2610 * be reset. Normally a DPDK application can invoke this function when 2611 * RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start 2612 * a port reset in other circumstances. 2613 * 2614 * When this function is called, it first stops the port and then calls the 2615 * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial 2616 * state, in which no Tx and Rx queues are setup, as if the port has been 2617 * reset and not started. The port keeps the port ID it had before the 2618 * function call. 2619 * 2620 * After calling rte_eth_dev_reset( ), the application should use 2621 * rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ), 2622 * rte_eth_tx_queue_setup( ), and rte_eth_dev_start( ) 2623 * to reconfigure the device as appropriate. 2624 * 2625 * Note: To avoid unexpected behavior, the application should stop calling 2626 * Tx and Rx functions before calling rte_eth_dev_reset( ). For thread 2627 * safety, all these controlling functions should be called from the same 2628 * thread. 2629 * 2630 * @param port_id 2631 * The port identifier of the Ethernet device. 2632 * 2633 * @return 2634 * - (0) if successful. 2635 * - (-ENODEV) if *port_id* is invalid. 2636 * - (-ENOTSUP) if hardware doesn't support this function. 2637 * - (-EPERM) if not ran from the primary process. 2638 * - (-EIO) if re-initialisation failed or device is removed. 2639 * - (-ENOMEM) if the reset failed due to OOM. 2640 * - (-EAGAIN) if the reset temporarily failed and should be retried later. 2641 */ 2642 int rte_eth_dev_reset(uint16_t port_id); 2643 2644 /** 2645 * Enable receipt in promiscuous mode for an Ethernet device. 2646 * 2647 * @param port_id 2648 * The port identifier of the Ethernet device. 2649 * @return 2650 * - (0) if successful. 2651 * - (-ENOTSUP) if support for promiscuous_enable() does not exist 2652 * for the device. 2653 * - (-ENODEV) if *port_id* invalid. 2654 */ 2655 int rte_eth_promiscuous_enable(uint16_t port_id); 2656 2657 /** 2658 * Disable receipt in promiscuous mode for an Ethernet device. 2659 * 2660 * @param port_id 2661 * The port identifier of the Ethernet device. 2662 * @return 2663 * - (0) if successful. 2664 * - (-ENOTSUP) if support for promiscuous_disable() does not exist 2665 * for the device. 2666 * - (-ENODEV) if *port_id* invalid. 2667 */ 2668 int rte_eth_promiscuous_disable(uint16_t port_id); 2669 2670 /** 2671 * Return the value of promiscuous mode for an Ethernet device. 2672 * 2673 * @param port_id 2674 * The port identifier of the Ethernet device. 2675 * @return 2676 * - (1) if promiscuous is enabled 2677 * - (0) if promiscuous is disabled. 2678 * - (-1) on error 2679 */ 2680 int rte_eth_promiscuous_get(uint16_t port_id); 2681 2682 /** 2683 * Enable the receipt of any multicast frame by an Ethernet device. 2684 * 2685 * @param port_id 2686 * The port identifier of the Ethernet device. 2687 * @return 2688 * - (0) if successful. 2689 * - (-ENOTSUP) if support for allmulticast_enable() does not exist 2690 * for the device. 2691 * - (-ENODEV) if *port_id* invalid. 2692 */ 2693 int rte_eth_allmulticast_enable(uint16_t port_id); 2694 2695 /** 2696 * Disable the receipt of all multicast frames by an Ethernet device. 2697 * 2698 * @param port_id 2699 * The port identifier of the Ethernet device. 2700 * @return 2701 * - (0) if successful. 2702 * - (-ENOTSUP) if support for allmulticast_disable() does not exist 2703 * for the device. 2704 * - (-ENODEV) if *port_id* invalid. 2705 */ 2706 int rte_eth_allmulticast_disable(uint16_t port_id); 2707 2708 /** 2709 * Return the value of allmulticast mode for an Ethernet device. 2710 * 2711 * @param port_id 2712 * The port identifier of the Ethernet device. 2713 * @return 2714 * - (1) if allmulticast is enabled 2715 * - (0) if allmulticast is disabled. 2716 * - (-1) on error 2717 */ 2718 int rte_eth_allmulticast_get(uint16_t port_id); 2719 2720 /** 2721 * Retrieve the link status (up/down), the duplex mode (half/full), 2722 * the negotiation (auto/fixed), and if available, the speed (Mbps). 2723 * 2724 * It might need to wait up to 9 seconds. 2725 * @see rte_eth_link_get_nowait. 2726 * 2727 * @param port_id 2728 * The port identifier of the Ethernet device. 2729 * @param link 2730 * Link information written back. 2731 * @return 2732 * - (0) if successful. 2733 * - (-ENOTSUP) if the function is not supported in PMD driver. 2734 * - (-ENODEV) if *port_id* invalid. 2735 * - (-EINVAL) if bad parameter. 2736 */ 2737 int rte_eth_link_get(uint16_t port_id, struct rte_eth_link *link); 2738 2739 /** 2740 * Retrieve the link status (up/down), the duplex mode (half/full), 2741 * the negotiation (auto/fixed), and if available, the speed (Mbps). 2742 * 2743 * @param port_id 2744 * The port identifier of the Ethernet device. 2745 * @param link 2746 * Link information written back. 2747 * @return 2748 * - (0) if successful. 2749 * - (-ENOTSUP) if the function is not supported in PMD driver. 2750 * - (-ENODEV) if *port_id* invalid. 2751 * - (-EINVAL) if bad parameter. 2752 */ 2753 int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link); 2754 2755 /** 2756 * @warning 2757 * @b EXPERIMENTAL: this API may change without prior notice. 2758 * 2759 * The function converts a link_speed to a string. It handles all special 2760 * values like unknown or none speed. 2761 * 2762 * @param link_speed 2763 * link_speed of rte_eth_link struct 2764 * @return 2765 * Link speed in textual format. It's pointer to immutable memory. 2766 * No free is required. 2767 */ 2768 __rte_experimental 2769 const char *rte_eth_link_speed_to_str(uint32_t link_speed); 2770 2771 /** 2772 * @warning 2773 * @b EXPERIMENTAL: this API may change without prior notice. 2774 * 2775 * The function converts a rte_eth_link struct representing a link status to 2776 * a string. 2777 * 2778 * @param str 2779 * A pointer to a string to be filled with textual representation of 2780 * device status. At least ETH_LINK_MAX_STR_LEN bytes should be allocated to 2781 * store default link status text. 2782 * @param len 2783 * Length of available memory at 'str' string. 2784 * @param eth_link 2785 * Link status returned by rte_eth_link_get function 2786 * @return 2787 * Number of bytes written to str array or -EINVAL if bad parameter. 2788 */ 2789 __rte_experimental 2790 int rte_eth_link_to_str(char *str, size_t len, 2791 const struct rte_eth_link *eth_link); 2792 2793 /** 2794 * Retrieve the general I/O statistics of an Ethernet device. 2795 * 2796 * @param port_id 2797 * The port identifier of the Ethernet device. 2798 * @param stats 2799 * A pointer to a structure of type *rte_eth_stats* to be filled with 2800 * the values of device counters for the following set of statistics: 2801 * - *ipackets* with the total of successfully received packets. 2802 * - *opackets* with the total of successfully transmitted packets. 2803 * - *ibytes* with the total of successfully received bytes. 2804 * - *obytes* with the total of successfully transmitted bytes. 2805 * - *ierrors* with the total of erroneous received packets. 2806 * - *oerrors* with the total of failed transmitted packets. 2807 * @return 2808 * Zero if successful. Non-zero otherwise. 2809 */ 2810 int rte_eth_stats_get(uint16_t port_id, struct rte_eth_stats *stats); 2811 2812 /** 2813 * Reset the general I/O statistics of an Ethernet device. 2814 * 2815 * @param port_id 2816 * The port identifier of the Ethernet device. 2817 * @return 2818 * - (0) if device notified to reset stats. 2819 * - (-ENOTSUP) if hardware doesn't support. 2820 * - (-ENODEV) if *port_id* invalid. 2821 * - (<0): Error code of the driver stats reset function. 2822 */ 2823 int rte_eth_stats_reset(uint16_t port_id); 2824 2825 /** 2826 * Retrieve names of extended statistics of an Ethernet device. 2827 * 2828 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched 2829 * by array index: 2830 * xstats_names[i].name => xstats[i].value 2831 * 2832 * And the array index is same with id field of 'struct rte_eth_xstat': 2833 * xstats[i].id == i 2834 * 2835 * This assumption makes key-value pair matching less flexible but simpler. 2836 * 2837 * @param port_id 2838 * The port identifier of the Ethernet device. 2839 * @param xstats_names 2840 * An rte_eth_xstat_name array of at least *size* elements to 2841 * be filled. If set to NULL, the function returns the required number 2842 * of elements. 2843 * @param size 2844 * The size of the xstats_names array (number of elements). 2845 * @return 2846 * - A positive value lower or equal to size: success. The return value 2847 * is the number of entries filled in the stats table. 2848 * - A positive value higher than size: error, the given statistics table 2849 * is too small. The return value corresponds to the size that should 2850 * be given to succeed. The entries in the table are not valid and 2851 * shall not be used by the caller. 2852 * - A negative value on error (invalid port ID). 2853 */ 2854 int rte_eth_xstats_get_names(uint16_t port_id, 2855 struct rte_eth_xstat_name *xstats_names, 2856 unsigned int size); 2857 2858 /** 2859 * Retrieve extended statistics of an Ethernet device. 2860 * 2861 * There is an assumption that 'xstat_names' and 'xstats' arrays are matched 2862 * by array index: 2863 * xstats_names[i].name => xstats[i].value 2864 * 2865 * And the array index is same with id field of 'struct rte_eth_xstat': 2866 * xstats[i].id == i 2867 * 2868 * This assumption makes key-value pair matching less flexible but simpler. 2869 * 2870 * @param port_id 2871 * The port identifier of the Ethernet device. 2872 * @param xstats 2873 * A pointer to a table of structure of type *rte_eth_xstat* 2874 * to be filled with device statistics ids and values. 2875 * This parameter can be set to NULL if n is 0. 2876 * @param n 2877 * The size of the xstats array (number of elements). 2878 * @return 2879 * - A positive value lower or equal to n: success. The return value 2880 * is the number of entries filled in the stats table. 2881 * - A positive value higher than n: error, the given statistics table 2882 * is too small. The return value corresponds to the size that should 2883 * be given to succeed. The entries in the table are not valid and 2884 * shall not be used by the caller. 2885 * - A negative value on error (invalid port ID). 2886 */ 2887 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, 2888 unsigned int n); 2889 2890 /** 2891 * Retrieve names of extended statistics of an Ethernet device. 2892 * 2893 * @param port_id 2894 * The port identifier of the Ethernet device. 2895 * @param xstats_names 2896 * Array to be filled in with names of requested device statistics. 2897 * Must not be NULL if @p ids are specified (not NULL). 2898 * @param size 2899 * Number of elements in @p xstats_names array (if not NULL) and in 2900 * @p ids array (if not NULL). Must be 0 if both array pointers are NULL. 2901 * @param ids 2902 * IDs array given by app to retrieve specific statistics. May be NULL to 2903 * retrieve names of all available statistics or, if @p xstats_names is 2904 * NULL as well, just the number of available statistics. 2905 * @return 2906 * - A positive value lower or equal to size: success. The return value 2907 * is the number of entries filled in the stats table. 2908 * - A positive value higher than size: success. The given statistics table 2909 * is too small. The return value corresponds to the size that should 2910 * be given to succeed. The entries in the table are not valid and 2911 * shall not be used by the caller. 2912 * - A negative value on error. 2913 */ 2914 int 2915 rte_eth_xstats_get_names_by_id(uint16_t port_id, 2916 struct rte_eth_xstat_name *xstats_names, unsigned int size, 2917 uint64_t *ids); 2918 2919 /** 2920 * Retrieve extended statistics of an Ethernet device. 2921 * 2922 * @param port_id 2923 * The port identifier of the Ethernet device. 2924 * @param ids 2925 * IDs array given by app to retrieve specific statistics. May be NULL to 2926 * retrieve all available statistics or, if @p values is NULL as well, 2927 * just the number of available statistics. 2928 * @param values 2929 * Array to be filled in with requested device statistics. 2930 * Must not be NULL if ids are specified (not NULL). 2931 * @param size 2932 * Number of elements in @p values array (if not NULL) and in @p ids 2933 * array (if not NULL). Must be 0 if both array pointers are NULL. 2934 * @return 2935 * - A positive value lower or equal to size: success. The return value 2936 * is the number of entries filled in the stats table. 2937 * - A positive value higher than size: success: The given statistics table 2938 * is too small. The return value corresponds to the size that should 2939 * be given to succeed. The entries in the table are not valid and 2940 * shall not be used by the caller. 2941 * - A negative value on error. 2942 */ 2943 int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids, 2944 uint64_t *values, unsigned int size); 2945 2946 /** 2947 * Gets the ID of a statistic from its name. 2948 * 2949 * This function searches for the statistics using string compares, and 2950 * as such should not be used on the fast-path. For fast-path retrieval of 2951 * specific statistics, store the ID as provided in *id* from this function, 2952 * and pass the ID to rte_eth_xstats_get() 2953 * 2954 * @param port_id The port to look up statistics from 2955 * @param xstat_name The name of the statistic to return 2956 * @param[out] id A pointer to an app-supplied uint64_t which should be 2957 * set to the ID of the stat if the stat exists. 2958 * @return 2959 * 0 on success 2960 * -ENODEV for invalid port_id, 2961 * -EIO if device is removed, 2962 * -EINVAL if the xstat_name doesn't exist in port_id 2963 * -ENOMEM if bad parameter. 2964 */ 2965 int rte_eth_xstats_get_id_by_name(uint16_t port_id, const char *xstat_name, 2966 uint64_t *id); 2967 2968 /** 2969 * Reset extended statistics of an Ethernet device. 2970 * 2971 * @param port_id 2972 * The port identifier of the Ethernet device. 2973 * @return 2974 * - (0) if device notified to reset extended stats. 2975 * - (-ENOTSUP) if pmd doesn't support both 2976 * extended stats and basic stats reset. 2977 * - (-ENODEV) if *port_id* invalid. 2978 * - (<0): Error code of the driver xstats reset function. 2979 */ 2980 int rte_eth_xstats_reset(uint16_t port_id); 2981 2982 /** 2983 * Set a mapping for the specified transmit queue to the specified per-queue 2984 * statistics counter. 2985 * 2986 * @param port_id 2987 * The port identifier of the Ethernet device. 2988 * @param tx_queue_id 2989 * The index of the transmit queue for which a queue stats mapping is required. 2990 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 2991 * to rte_eth_dev_configure(). 2992 * @param stat_idx 2993 * The per-queue packet statistics functionality number that the transmit 2994 * queue is to be assigned. 2995 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1]. 2996 * Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256. 2997 * @return 2998 * Zero if successful. Non-zero otherwise. 2999 */ 3000 int rte_eth_dev_set_tx_queue_stats_mapping(uint16_t port_id, 3001 uint16_t tx_queue_id, uint8_t stat_idx); 3002 3003 /** 3004 * Set a mapping for the specified receive queue to the specified per-queue 3005 * statistics counter. 3006 * 3007 * @param port_id 3008 * The port identifier of the Ethernet device. 3009 * @param rx_queue_id 3010 * The index of the receive queue for which a queue stats mapping is required. 3011 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3012 * to rte_eth_dev_configure(). 3013 * @param stat_idx 3014 * The per-queue packet statistics functionality number that the receive 3015 * queue is to be assigned. 3016 * The value must be in the range [0, RTE_ETHDEV_QUEUE_STAT_CNTRS - 1]. 3017 * Max RTE_ETHDEV_QUEUE_STAT_CNTRS being 256. 3018 * @return 3019 * Zero if successful. Non-zero otherwise. 3020 */ 3021 int rte_eth_dev_set_rx_queue_stats_mapping(uint16_t port_id, 3022 uint16_t rx_queue_id, 3023 uint8_t stat_idx); 3024 3025 /** 3026 * Retrieve the Ethernet address of an Ethernet device. 3027 * 3028 * @param port_id 3029 * The port identifier of the Ethernet device. 3030 * @param mac_addr 3031 * A pointer to a structure of type *ether_addr* to be filled with 3032 * the Ethernet address of the Ethernet device. 3033 * @return 3034 * - (0) if successful 3035 * - (-ENODEV) if *port_id* invalid. 3036 * - (-EINVAL) if bad parameter. 3037 */ 3038 int rte_eth_macaddr_get(uint16_t port_id, struct rte_ether_addr *mac_addr); 3039 3040 /** 3041 * @warning 3042 * @b EXPERIMENTAL: this API may change without prior notice 3043 * 3044 * Retrieve the Ethernet addresses of an Ethernet device. 3045 * 3046 * @param port_id 3047 * The port identifier of the Ethernet device. 3048 * @param ma 3049 * A pointer to an array of structures of type *ether_addr* to be filled with 3050 * the Ethernet addresses of the Ethernet device. 3051 * @param num 3052 * Number of elements in the @p ma array. 3053 * Note that rte_eth_dev_info::max_mac_addrs can be used to retrieve 3054 * max number of Ethernet addresses for given port. 3055 * @return 3056 * - number of retrieved addresses if successful 3057 * - (-ENODEV) if *port_id* invalid. 3058 * - (-EINVAL) if bad parameter. 3059 */ 3060 __rte_experimental 3061 int rte_eth_macaddrs_get(uint16_t port_id, struct rte_ether_addr *ma, 3062 unsigned int num); 3063 3064 /** 3065 * Retrieve the contextual information of an Ethernet device. 3066 * 3067 * As part of this function, a number of of fields in dev_info will be 3068 * initialized as follows: 3069 * 3070 * rx_desc_lim = lim 3071 * tx_desc_lim = lim 3072 * 3073 * Where lim is defined within the rte_eth_dev_info_get as 3074 * 3075 * const struct rte_eth_desc_lim lim = { 3076 * .nb_max = UINT16_MAX, 3077 * .nb_min = 0, 3078 * .nb_align = 1, 3079 * .nb_seg_max = UINT16_MAX, 3080 * .nb_mtu_seg_max = UINT16_MAX, 3081 * }; 3082 * 3083 * device = dev->device 3084 * min_mtu = RTE_ETHER_MIN_LEN - RTE_ETHER_HDR_LEN - RTE_ETHER_CRC_LEN 3085 * max_mtu = UINT16_MAX 3086 * 3087 * The following fields will be populated if support for dev_infos_get() 3088 * exists for the device and the rte_eth_dev 'dev' has been populated 3089 * successfully with a call to it: 3090 * 3091 * driver_name = dev->device->driver->name 3092 * nb_rx_queues = dev->data->nb_rx_queues 3093 * nb_tx_queues = dev->data->nb_tx_queues 3094 * dev_flags = &dev->data->dev_flags 3095 * 3096 * @param port_id 3097 * The port identifier of the Ethernet device. 3098 * @param dev_info 3099 * A pointer to a structure of type *rte_eth_dev_info* to be filled with 3100 * the contextual information of the Ethernet device. 3101 * @return 3102 * - (0) if successful. 3103 * - (-ENOTSUP) if support for dev_infos_get() does not exist for the device. 3104 * - (-ENODEV) if *port_id* invalid. 3105 * - (-EINVAL) if bad parameter. 3106 */ 3107 int rte_eth_dev_info_get(uint16_t port_id, struct rte_eth_dev_info *dev_info); 3108 3109 /** 3110 * @warning 3111 * @b EXPERIMENTAL: this API may change without prior notice. 3112 * 3113 * Retrieve the configuration of an Ethernet device. 3114 * 3115 * @param port_id 3116 * The port identifier of the Ethernet device. 3117 * @param dev_conf 3118 * Location for Ethernet device configuration to be filled in. 3119 * @return 3120 * - (0) if successful. 3121 * - (-ENODEV) if *port_id* invalid. 3122 * - (-EINVAL) if bad parameter. 3123 */ 3124 __rte_experimental 3125 int rte_eth_dev_conf_get(uint16_t port_id, struct rte_eth_conf *dev_conf); 3126 3127 /** 3128 * Retrieve the firmware version of a device. 3129 * 3130 * @param port_id 3131 * The port identifier of the device. 3132 * @param fw_version 3133 * A pointer to a string array storing the firmware version of a device, 3134 * the string includes terminating null. This pointer is allocated by caller. 3135 * @param fw_size 3136 * The size of the string array pointed by fw_version, which should be 3137 * large enough to store firmware version of the device. 3138 * @return 3139 * - (0) if successful. 3140 * - (-ENOTSUP) if operation is not supported. 3141 * - (-ENODEV) if *port_id* invalid. 3142 * - (-EIO) if device is removed. 3143 * - (-EINVAL) if bad parameter. 3144 * - (>0) if *fw_size* is not enough to store firmware version, return 3145 * the size of the non truncated string. 3146 */ 3147 int rte_eth_dev_fw_version_get(uint16_t port_id, 3148 char *fw_version, size_t fw_size); 3149 3150 /** 3151 * Retrieve the supported packet types of an Ethernet device. 3152 * 3153 * When a packet type is announced as supported, it *must* be recognized by 3154 * the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN 3155 * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following 3156 * packet types for these packets: 3157 * - Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4 3158 * - Ether/VLAN/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4 3159 * - Ether/[anything else] -> RTE_PTYPE_L2_ETHER 3160 * - Ether/VLAN/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN 3161 * 3162 * When a packet is received by a PMD, the most precise type must be 3163 * returned among the ones supported. However a PMD is allowed to set 3164 * packet type that is not in the supported list, at the condition that it 3165 * is more precise. Therefore, a PMD announcing no supported packet types 3166 * can still set a matching packet type in a received packet. 3167 * 3168 * @note 3169 * Better to invoke this API after the device is already started or Rx burst 3170 * function is decided, to obtain correct supported ptypes. 3171 * @note 3172 * if a given PMD does not report what ptypes it supports, then the supported 3173 * ptype count is reported as 0. 3174 * @param port_id 3175 * The port identifier of the Ethernet device. 3176 * @param ptype_mask 3177 * A hint of what kind of packet type which the caller is interested in. 3178 * @param ptypes 3179 * An array pointer to store adequate packet types, allocated by caller. 3180 * @param num 3181 * Size of the array pointed by param ptypes. 3182 * @return 3183 * - (>=0) Number of supported ptypes. If the number of types exceeds num, 3184 * only num entries will be filled into the ptypes array, but the full 3185 * count of supported ptypes will be returned. 3186 * - (-ENODEV) if *port_id* invalid. 3187 * - (-EINVAL) if bad parameter. 3188 */ 3189 int rte_eth_dev_get_supported_ptypes(uint16_t port_id, uint32_t ptype_mask, 3190 uint32_t *ptypes, int num); 3191 /** 3192 * Inform Ethernet device about reduced range of packet types to handle. 3193 * 3194 * Application can use this function to set only specific ptypes that it's 3195 * interested. This information can be used by the PMD to optimize Rx path. 3196 * 3197 * The function accepts an array `set_ptypes` allocated by the caller to 3198 * store the packet types set by the driver, the last element of the array 3199 * is set to RTE_PTYPE_UNKNOWN. The size of the `set_ptype` array should be 3200 * `rte_eth_dev_get_supported_ptypes() + 1` else it might only be filled 3201 * partially. 3202 * 3203 * @param port_id 3204 * The port identifier of the Ethernet device. 3205 * @param ptype_mask 3206 * The ptype family that application is interested in should be bitwise OR of 3207 * RTE_PTYPE_*_MASK or 0. 3208 * @param set_ptypes 3209 * An array pointer to store set packet types, allocated by caller. The 3210 * function marks the end of array with RTE_PTYPE_UNKNOWN. 3211 * @param num 3212 * Size of the array pointed by param ptypes. 3213 * Should be rte_eth_dev_get_supported_ptypes() + 1 to accommodate the 3214 * set ptypes. 3215 * @return 3216 * - (0) if Success. 3217 * - (-ENODEV) if *port_id* invalid. 3218 * - (-EINVAL) if *ptype_mask* is invalid (or) set_ptypes is NULL and 3219 * num > 0. 3220 */ 3221 int rte_eth_dev_set_ptypes(uint16_t port_id, uint32_t ptype_mask, 3222 uint32_t *set_ptypes, unsigned int num); 3223 3224 /** 3225 * Retrieve the MTU of an Ethernet device. 3226 * 3227 * @param port_id 3228 * The port identifier of the Ethernet device. 3229 * @param mtu 3230 * A pointer to a uint16_t where the retrieved MTU is to be stored. 3231 * @return 3232 * - (0) if successful. 3233 * - (-ENODEV) if *port_id* invalid. 3234 * - (-EINVAL) if bad parameter. 3235 */ 3236 int rte_eth_dev_get_mtu(uint16_t port_id, uint16_t *mtu); 3237 3238 /** 3239 * Change the MTU of an Ethernet device. 3240 * 3241 * @param port_id 3242 * The port identifier of the Ethernet device. 3243 * @param mtu 3244 * A uint16_t for the MTU to be applied. 3245 * @return 3246 * - (0) if successful. 3247 * - (-ENOTSUP) if operation is not supported. 3248 * - (-ENODEV) if *port_id* invalid. 3249 * - (-EIO) if device is removed. 3250 * - (-EINVAL) if *mtu* invalid, validation of mtu can occur within 3251 * rte_eth_dev_set_mtu if dev_infos_get is supported by the device or 3252 * when the mtu is set using dev->dev_ops->mtu_set. 3253 * - (-EBUSY) if operation is not allowed when the port is running 3254 */ 3255 int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu); 3256 3257 /** 3258 * Enable/Disable hardware filtering by an Ethernet device of received 3259 * VLAN packets tagged with a given VLAN Tag Identifier. 3260 * 3261 * @param port_id 3262 * The port identifier of the Ethernet device. 3263 * @param vlan_id 3264 * The VLAN Tag Identifier whose filtering must be enabled or disabled. 3265 * @param on 3266 * If > 0, enable VLAN filtering of VLAN packets tagged with *vlan_id*. 3267 * Otherwise, disable VLAN filtering of VLAN packets tagged with *vlan_id*. 3268 * @return 3269 * - (0) if successful. 3270 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured. 3271 * - (-ENODEV) if *port_id* invalid. 3272 * - (-EIO) if device is removed. 3273 * - (-ENOSYS) if VLAN filtering on *port_id* disabled. 3274 * - (-EINVAL) if *vlan_id* > 4095. 3275 */ 3276 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on); 3277 3278 /** 3279 * Enable/Disable hardware VLAN Strip by a Rx queue of an Ethernet device. 3280 * 3281 * @param port_id 3282 * The port identifier of the Ethernet device. 3283 * @param rx_queue_id 3284 * The index of the receive queue for which a queue stats mapping is required. 3285 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3286 * to rte_eth_dev_configure(). 3287 * @param on 3288 * If 1, Enable VLAN Stripping of the receive queue of the Ethernet port. 3289 * If 0, Disable VLAN Stripping of the receive queue of the Ethernet port. 3290 * @return 3291 * - (0) if successful. 3292 * - (-ENOTSUP) if hardware-assisted VLAN stripping not configured. 3293 * - (-ENODEV) if *port_id* invalid. 3294 * - (-EINVAL) if *rx_queue_id* invalid. 3295 */ 3296 int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id, 3297 int on); 3298 3299 /** 3300 * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to 3301 * the VLAN header. 3302 * 3303 * @param port_id 3304 * The port identifier of the Ethernet device. 3305 * @param vlan_type 3306 * The VLAN type. 3307 * @param tag_type 3308 * The Tag Protocol ID 3309 * @return 3310 * - (0) if successful. 3311 * - (-ENOTSUP) if hardware-assisted VLAN TPID setup is not supported. 3312 * - (-ENODEV) if *port_id* invalid. 3313 * - (-EIO) if device is removed. 3314 */ 3315 int rte_eth_dev_set_vlan_ether_type(uint16_t port_id, 3316 enum rte_vlan_type vlan_type, 3317 uint16_t tag_type); 3318 3319 /** 3320 * Set VLAN offload configuration on an Ethernet device. 3321 * 3322 * @param port_id 3323 * The port identifier of the Ethernet device. 3324 * @param offload_mask 3325 * The VLAN Offload bit mask can be mixed use with "OR" 3326 * ETH_VLAN_STRIP_OFFLOAD 3327 * ETH_VLAN_FILTER_OFFLOAD 3328 * ETH_VLAN_EXTEND_OFFLOAD 3329 * ETH_QINQ_STRIP_OFFLOAD 3330 * @return 3331 * - (0) if successful. 3332 * - (-ENOTSUP) if hardware-assisted VLAN filtering not configured. 3333 * - (-ENODEV) if *port_id* invalid. 3334 * - (-EIO) if device is removed. 3335 */ 3336 int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask); 3337 3338 /** 3339 * Read VLAN Offload configuration from an Ethernet device 3340 * 3341 * @param port_id 3342 * The port identifier of the Ethernet device. 3343 * @return 3344 * - (>0) if successful. Bit mask to indicate 3345 * ETH_VLAN_STRIP_OFFLOAD 3346 * ETH_VLAN_FILTER_OFFLOAD 3347 * ETH_VLAN_EXTEND_OFFLOAD 3348 * ETH_QINQ_STRIP_OFFLOAD 3349 * - (-ENODEV) if *port_id* invalid. 3350 */ 3351 int rte_eth_dev_get_vlan_offload(uint16_t port_id); 3352 3353 /** 3354 * Set port based Tx VLAN insertion on or off. 3355 * 3356 * @param port_id 3357 * The port identifier of the Ethernet device. 3358 * @param pvid 3359 * Port based Tx VLAN identifier together with user priority. 3360 * @param on 3361 * Turn on or off the port based Tx VLAN insertion. 3362 * 3363 * @return 3364 * - (0) if successful. 3365 * - negative if failed. 3366 */ 3367 int rte_eth_dev_set_vlan_pvid(uint16_t port_id, uint16_t pvid, int on); 3368 3369 typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count, 3370 void *userdata); 3371 3372 /** 3373 * Structure used to buffer packets for future Tx 3374 * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush 3375 */ 3376 struct rte_eth_dev_tx_buffer { 3377 buffer_tx_error_fn error_callback; 3378 void *error_userdata; 3379 uint16_t size; /**< Size of buffer for buffered Tx */ 3380 uint16_t length; /**< Number of packets in the array */ 3381 /** Pending packets to be sent on explicit flush or when full */ 3382 struct rte_mbuf *pkts[]; 3383 }; 3384 3385 /** 3386 * Calculate the size of the Tx buffer. 3387 * 3388 * @param sz 3389 * Number of stored packets. 3390 */ 3391 #define RTE_ETH_TX_BUFFER_SIZE(sz) \ 3392 (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *)) 3393 3394 /** 3395 * Initialize default values for buffered transmitting 3396 * 3397 * @param buffer 3398 * Tx buffer to be initialized. 3399 * @param size 3400 * Buffer size 3401 * @return 3402 * 0 if no error 3403 */ 3404 int 3405 rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size); 3406 3407 /** 3408 * Configure a callback for buffered packets which cannot be sent 3409 * 3410 * Register a specific callback to be called when an attempt is made to send 3411 * all packets buffered on an Ethernet port, but not all packets can 3412 * successfully be sent. The callback registered here will be called only 3413 * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs. 3414 * The default callback configured for each queue by default just frees the 3415 * packets back to the calling mempool. If additional behaviour is required, 3416 * for example, to count dropped packets, or to retry transmission of packets 3417 * which cannot be sent, this function should be used to register a suitable 3418 * callback function to implement the desired behaviour. 3419 * The example callback "rte_eth_count_unsent_packet_callback()" is also 3420 * provided as reference. 3421 * 3422 * @param buffer 3423 * The port identifier of the Ethernet device. 3424 * @param callback 3425 * The function to be used as the callback. 3426 * @param userdata 3427 * Arbitrary parameter to be passed to the callback function 3428 * @return 3429 * 0 on success, or -EINVAL if bad parameter 3430 */ 3431 int 3432 rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer, 3433 buffer_tx_error_fn callback, void *userdata); 3434 3435 /** 3436 * Callback function for silently dropping unsent buffered packets. 3437 * 3438 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to 3439 * adjust the default behavior when buffered packets cannot be sent. This 3440 * function drops any unsent packets silently and is used by Tx buffered 3441 * operations as default behavior. 3442 * 3443 * NOTE: this function should not be called directly, instead it should be used 3444 * as a callback for packet buffering. 3445 * 3446 * NOTE: when configuring this function as a callback with 3447 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter 3448 * should point to an uint64_t value. 3449 * 3450 * @param pkts 3451 * The previously buffered packets which could not be sent 3452 * @param unsent 3453 * The number of unsent packets in the pkts array 3454 * @param userdata 3455 * Not used 3456 */ 3457 void 3458 rte_eth_tx_buffer_drop_callback(struct rte_mbuf **pkts, uint16_t unsent, 3459 void *userdata); 3460 3461 /** 3462 * Callback function for tracking unsent buffered packets. 3463 * 3464 * This function can be passed to rte_eth_tx_buffer_set_err_callback() to 3465 * adjust the default behavior when buffered packets cannot be sent. This 3466 * function drops any unsent packets, but also updates a user-supplied counter 3467 * to track the overall number of packets dropped. The counter should be an 3468 * uint64_t variable. 3469 * 3470 * NOTE: this function should not be called directly, instead it should be used 3471 * as a callback for packet buffering. 3472 * 3473 * NOTE: when configuring this function as a callback with 3474 * rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter 3475 * should point to an uint64_t value. 3476 * 3477 * @param pkts 3478 * The previously buffered packets which could not be sent 3479 * @param unsent 3480 * The number of unsent packets in the pkts array 3481 * @param userdata 3482 * Pointer to an uint64_t value, which will be incremented by unsent 3483 */ 3484 void 3485 rte_eth_tx_buffer_count_callback(struct rte_mbuf **pkts, uint16_t unsent, 3486 void *userdata); 3487 3488 /** 3489 * Request the driver to free mbufs currently cached by the driver. The 3490 * driver will only free the mbuf if it is no longer in use. It is the 3491 * application's responsibility to ensure rte_eth_tx_buffer_flush(..) is 3492 * called if needed. 3493 * 3494 * @param port_id 3495 * The port identifier of the Ethernet device. 3496 * @param queue_id 3497 * The index of the transmit queue through which output packets must be 3498 * sent. 3499 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 3500 * to rte_eth_dev_configure(). 3501 * @param free_cnt 3502 * Maximum number of packets to free. Use 0 to indicate all possible packets 3503 * should be freed. Note that a packet may be using multiple mbufs. 3504 * @return 3505 * Failure: < 0 3506 * -ENODEV: Invalid interface 3507 * -EIO: device is removed 3508 * -ENOTSUP: Driver does not support function 3509 * Success: >= 0 3510 * 0-n: Number of packets freed. More packets may still remain in ring that 3511 * are in use. 3512 */ 3513 int 3514 rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt); 3515 3516 /** 3517 * Subtypes for IPsec offload event(@ref RTE_ETH_EVENT_IPSEC) raised by 3518 * eth device. 3519 */ 3520 enum rte_eth_event_ipsec_subtype { 3521 /** Unknown event type */ 3522 RTE_ETH_EVENT_IPSEC_UNKNOWN = 0, 3523 /** Sequence number overflow */ 3524 RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW, 3525 /** Soft time expiry of SA */ 3526 RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY, 3527 /** Soft byte expiry of SA */ 3528 RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY, 3529 /** Max value of this enum */ 3530 RTE_ETH_EVENT_IPSEC_MAX 3531 }; 3532 3533 /** 3534 * Descriptor for @ref RTE_ETH_EVENT_IPSEC event. Used by eth dev to send extra 3535 * information of the IPsec offload event. 3536 */ 3537 struct rte_eth_event_ipsec_desc { 3538 /** Type of RTE_ETH_EVENT_IPSEC_* event */ 3539 enum rte_eth_event_ipsec_subtype subtype; 3540 /** 3541 * Event specific metadata. 3542 * 3543 * For the following events, *userdata* registered 3544 * with the *rte_security_session* would be returned 3545 * as metadata, 3546 * 3547 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW 3548 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY 3549 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY 3550 * 3551 * @see struct rte_security_session_conf 3552 * 3553 */ 3554 uint64_t metadata; 3555 }; 3556 3557 /** 3558 * The eth device event type for interrupt, and maybe others in the future. 3559 */ 3560 enum rte_eth_event_type { 3561 RTE_ETH_EVENT_UNKNOWN, /**< unknown event type */ 3562 RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */ 3563 /** queue state event (enabled/disabled) */ 3564 RTE_ETH_EVENT_QUEUE_STATE, 3565 /** reset interrupt event, sent to VF on PF reset */ 3566 RTE_ETH_EVENT_INTR_RESET, 3567 RTE_ETH_EVENT_VF_MBOX, /**< message from the VF received by PF */ 3568 RTE_ETH_EVENT_MACSEC, /**< MACsec offload related event */ 3569 RTE_ETH_EVENT_INTR_RMV, /**< device removal event */ 3570 RTE_ETH_EVENT_NEW, /**< port is probed */ 3571 RTE_ETH_EVENT_DESTROY, /**< port is released */ 3572 RTE_ETH_EVENT_IPSEC, /**< IPsec offload related event */ 3573 RTE_ETH_EVENT_FLOW_AGED,/**< New aged-out flows is detected */ 3574 RTE_ETH_EVENT_MAX /**< max value of this enum */ 3575 }; 3576 3577 /** User application callback to be registered for interrupts. */ 3578 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id, 3579 enum rte_eth_event_type event, void *cb_arg, void *ret_param); 3580 3581 /** 3582 * Register a callback function for port event. 3583 * 3584 * @param port_id 3585 * Port ID. 3586 * RTE_ETH_ALL means register the event for all port ids. 3587 * @param event 3588 * Event interested. 3589 * @param cb_fn 3590 * User supplied callback function to be called. 3591 * @param cb_arg 3592 * Pointer to the parameters for the registered callback. 3593 * 3594 * @return 3595 * - On success, zero. 3596 * - On failure, a negative value. 3597 */ 3598 int rte_eth_dev_callback_register(uint16_t port_id, 3599 enum rte_eth_event_type event, 3600 rte_eth_dev_cb_fn cb_fn, void *cb_arg); 3601 3602 /** 3603 * Unregister a callback function for port event. 3604 * 3605 * @param port_id 3606 * Port ID. 3607 * RTE_ETH_ALL means unregister the event for all port ids. 3608 * @param event 3609 * Event interested. 3610 * @param cb_fn 3611 * User supplied callback function to be called. 3612 * @param cb_arg 3613 * Pointer to the parameters for the registered callback. -1 means to 3614 * remove all for the same callback address and same event. 3615 * 3616 * @return 3617 * - On success, zero. 3618 * - On failure, a negative value. 3619 */ 3620 int rte_eth_dev_callback_unregister(uint16_t port_id, 3621 enum rte_eth_event_type event, 3622 rte_eth_dev_cb_fn cb_fn, void *cb_arg); 3623 3624 /** 3625 * When there is no Rx packet coming in Rx Queue for a long time, we can 3626 * sleep lcore related to Rx Queue for power saving, and enable Rx interrupt 3627 * to be triggered when Rx packet arrives. 3628 * 3629 * The rte_eth_dev_rx_intr_enable() function enables Rx queue 3630 * interrupt on specific Rx queue of a port. 3631 * 3632 * @param port_id 3633 * The port identifier of the Ethernet device. 3634 * @param queue_id 3635 * The index of the receive queue from which to retrieve input packets. 3636 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3637 * to rte_eth_dev_configure(). 3638 * @return 3639 * - (0) if successful. 3640 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 3641 * that operation. 3642 * - (-ENODEV) if *port_id* invalid. 3643 * - (-EIO) if device is removed. 3644 */ 3645 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id); 3646 3647 /** 3648 * When lcore wakes up from Rx interrupt indicating packet coming, disable Rx 3649 * interrupt and returns to polling mode. 3650 * 3651 * The rte_eth_dev_rx_intr_disable() function disables Rx queue 3652 * interrupt on specific Rx queue of a port. 3653 * 3654 * @param port_id 3655 * The port identifier of the Ethernet device. 3656 * @param queue_id 3657 * The index of the receive queue from which to retrieve input packets. 3658 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3659 * to rte_eth_dev_configure(). 3660 * @return 3661 * - (0) if successful. 3662 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 3663 * that operation. 3664 * - (-ENODEV) if *port_id* invalid. 3665 * - (-EIO) if device is removed. 3666 */ 3667 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id); 3668 3669 /** 3670 * Rx Interrupt control per port. 3671 * 3672 * @param port_id 3673 * The port identifier of the Ethernet device. 3674 * @param epfd 3675 * Epoll instance fd which the intr vector associated to. 3676 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance. 3677 * @param op 3678 * The operation be performed for the vector. 3679 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}. 3680 * @param data 3681 * User raw data. 3682 * @return 3683 * - On success, zero. 3684 * - On failure, a negative value. 3685 */ 3686 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data); 3687 3688 /** 3689 * Rx Interrupt control per queue. 3690 * 3691 * @param port_id 3692 * The port identifier of the Ethernet device. 3693 * @param queue_id 3694 * The index of the receive queue from which to retrieve input packets. 3695 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3696 * to rte_eth_dev_configure(). 3697 * @param epfd 3698 * Epoll instance fd which the intr vector associated to. 3699 * Using RTE_EPOLL_PER_THREAD allows to use per thread epoll instance. 3700 * @param op 3701 * The operation be performed for the vector. 3702 * Operation type of {RTE_INTR_EVENT_ADD, RTE_INTR_EVENT_DEL}. 3703 * @param data 3704 * User raw data. 3705 * @return 3706 * - On success, zero. 3707 * - On failure, a negative value. 3708 */ 3709 int rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id, 3710 int epfd, int op, void *data); 3711 3712 /** 3713 * Get interrupt fd per Rx queue. 3714 * 3715 * @param port_id 3716 * The port identifier of the Ethernet device. 3717 * @param queue_id 3718 * The index of the receive queue from which to retrieve input packets. 3719 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 3720 * to rte_eth_dev_configure(). 3721 * @return 3722 * - (>=0) the interrupt fd associated to the requested Rx queue if 3723 * successful. 3724 * - (-1) on error. 3725 */ 3726 int 3727 rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id); 3728 3729 /** 3730 * Turn on the LED on the Ethernet device. 3731 * This function turns on the LED on the Ethernet device. 3732 * 3733 * @param port_id 3734 * The port identifier of the Ethernet device. 3735 * @return 3736 * - (0) if successful. 3737 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 3738 * that operation. 3739 * - (-ENODEV) if *port_id* invalid. 3740 * - (-EIO) if device is removed. 3741 */ 3742 int rte_eth_led_on(uint16_t port_id); 3743 3744 /** 3745 * Turn off the LED on the Ethernet device. 3746 * This function turns off the LED on the Ethernet device. 3747 * 3748 * @param port_id 3749 * The port identifier of the Ethernet device. 3750 * @return 3751 * - (0) if successful. 3752 * - (-ENOTSUP) if underlying hardware OR driver doesn't support 3753 * that operation. 3754 * - (-ENODEV) if *port_id* invalid. 3755 * - (-EIO) if device is removed. 3756 */ 3757 int rte_eth_led_off(uint16_t port_id); 3758 3759 /** 3760 * @warning 3761 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 3762 * 3763 * Get Forward Error Correction(FEC) capability. 3764 * 3765 * @param port_id 3766 * The port identifier of the Ethernet device. 3767 * @param speed_fec_capa 3768 * speed_fec_capa is out only with per-speed capabilities. 3769 * If set to NULL, the function returns the required number 3770 * of required array entries. 3771 * @param num 3772 * a number of elements in an speed_fec_capa array. 3773 * 3774 * @return 3775 * - A non-negative value lower or equal to num: success. The return value 3776 * is the number of entries filled in the fec capa array. 3777 * - A non-negative value higher than num: error, the given fec capa array 3778 * is too small. The return value corresponds to the num that should 3779 * be given to succeed. The entries in fec capa array are not valid and 3780 * shall not be used by the caller. 3781 * - (-ENOTSUP) if underlying hardware OR driver doesn't support. 3782 * that operation. 3783 * - (-EIO) if device is removed. 3784 * - (-ENODEV) if *port_id* invalid. 3785 * - (-EINVAL) if *num* or *speed_fec_capa* invalid 3786 */ 3787 __rte_experimental 3788 int rte_eth_fec_get_capability(uint16_t port_id, 3789 struct rte_eth_fec_capa *speed_fec_capa, 3790 unsigned int num); 3791 3792 /** 3793 * @warning 3794 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 3795 * 3796 * Get current Forward Error Correction(FEC) mode. 3797 * If link is down and AUTO is enabled, AUTO is returned, otherwise, 3798 * configured FEC mode is returned. 3799 * If link is up, current FEC mode is returned. 3800 * 3801 * @param port_id 3802 * The port identifier of the Ethernet device. 3803 * @param fec_capa 3804 * A bitmask of enabled FEC modes. If AUTO bit is set, other 3805 * bits specify FEC modes which may be negotiated. If AUTO 3806 * bit is clear, specify FEC modes to be used (only one valid 3807 * mode per speed may be set). 3808 * @return 3809 * - (0) if successful. 3810 * - (-ENOTSUP) if underlying hardware OR driver doesn't support. 3811 * that operation. 3812 * - (-EIO) if device is removed. 3813 * - (-ENODEV) if *port_id* invalid. 3814 */ 3815 __rte_experimental 3816 int rte_eth_fec_get(uint16_t port_id, uint32_t *fec_capa); 3817 3818 /** 3819 * @warning 3820 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 3821 * 3822 * Set Forward Error Correction(FEC) mode. 3823 * 3824 * @param port_id 3825 * The port identifier of the Ethernet device. 3826 * @param fec_capa 3827 * A bitmask of allowed FEC modes. If AUTO bit is set, other 3828 * bits specify FEC modes which may be negotiated. If AUTO 3829 * bit is clear, specify FEC modes to be used (only one valid 3830 * mode per speed may be set). 3831 * @return 3832 * - (0) if successful. 3833 * - (-EINVAL) if the FEC mode is not valid. 3834 * - (-ENOTSUP) if underlying hardware OR driver doesn't support. 3835 * - (-EIO) if device is removed. 3836 * - (-ENODEV) if *port_id* invalid. 3837 */ 3838 __rte_experimental 3839 int rte_eth_fec_set(uint16_t port_id, uint32_t fec_capa); 3840 3841 /** 3842 * Get current status of the Ethernet link flow control for Ethernet device 3843 * 3844 * @param port_id 3845 * The port identifier of the Ethernet device. 3846 * @param fc_conf 3847 * The pointer to the structure where to store the flow control parameters. 3848 * @return 3849 * - (0) if successful. 3850 * - (-ENOTSUP) if hardware doesn't support flow control. 3851 * - (-ENODEV) if *port_id* invalid. 3852 * - (-EIO) if device is removed. 3853 * - (-EINVAL) if bad parameter. 3854 */ 3855 int rte_eth_dev_flow_ctrl_get(uint16_t port_id, 3856 struct rte_eth_fc_conf *fc_conf); 3857 3858 /** 3859 * Configure the Ethernet link flow control for Ethernet device 3860 * 3861 * @param port_id 3862 * The port identifier of the Ethernet device. 3863 * @param fc_conf 3864 * The pointer to the structure of the flow control parameters. 3865 * @return 3866 * - (0) if successful. 3867 * - (-ENOTSUP) if hardware doesn't support flow control mode. 3868 * - (-ENODEV) if *port_id* invalid. 3869 * - (-EINVAL) if bad parameter 3870 * - (-EIO) if flow control setup failure or device is removed. 3871 */ 3872 int rte_eth_dev_flow_ctrl_set(uint16_t port_id, 3873 struct rte_eth_fc_conf *fc_conf); 3874 3875 /** 3876 * Configure the Ethernet priority flow control under DCB environment 3877 * for Ethernet device. 3878 * 3879 * @param port_id 3880 * The port identifier of the Ethernet device. 3881 * @param pfc_conf 3882 * The pointer to the structure of the priority flow control parameters. 3883 * @return 3884 * - (0) if successful. 3885 * - (-ENOTSUP) if hardware doesn't support priority flow control mode. 3886 * - (-ENODEV) if *port_id* invalid. 3887 * - (-EINVAL) if bad parameter 3888 * - (-EIO) if flow control setup failure or device is removed. 3889 */ 3890 int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id, 3891 struct rte_eth_pfc_conf *pfc_conf); 3892 3893 /** 3894 * Add a MAC address to the set used for filtering incoming packets. 3895 * 3896 * @param port_id 3897 * The port identifier of the Ethernet device. 3898 * @param mac_addr 3899 * The MAC address to add. 3900 * @param pool 3901 * VMDq pool index to associate address with (if VMDq is enabled). If VMDq is 3902 * not enabled, this should be set to 0. 3903 * @return 3904 * - (0) if successfully added or *mac_addr* was already added. 3905 * - (-ENOTSUP) if hardware doesn't support this feature. 3906 * - (-ENODEV) if *port* is invalid. 3907 * - (-EIO) if device is removed. 3908 * - (-ENOSPC) if no more MAC addresses can be added. 3909 * - (-EINVAL) if MAC address is invalid. 3910 */ 3911 int rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *mac_addr, 3912 uint32_t pool); 3913 3914 /** 3915 * Remove a MAC address from the internal array of addresses. 3916 * 3917 * @param port_id 3918 * The port identifier of the Ethernet device. 3919 * @param mac_addr 3920 * MAC address to remove. 3921 * @return 3922 * - (0) if successful, or *mac_addr* didn't exist. 3923 * - (-ENOTSUP) if hardware doesn't support. 3924 * - (-ENODEV) if *port* invalid. 3925 * - (-EADDRINUSE) if attempting to remove the default MAC address. 3926 * - (-EINVAL) if MAC address is invalid. 3927 */ 3928 int rte_eth_dev_mac_addr_remove(uint16_t port_id, 3929 struct rte_ether_addr *mac_addr); 3930 3931 /** 3932 * Set the default MAC address. 3933 * 3934 * @param port_id 3935 * The port identifier of the Ethernet device. 3936 * @param mac_addr 3937 * New default MAC address. 3938 * @return 3939 * - (0) if successful, or *mac_addr* didn't exist. 3940 * - (-ENOTSUP) if hardware doesn't support. 3941 * - (-ENODEV) if *port* invalid. 3942 * - (-EINVAL) if MAC address is invalid. 3943 */ 3944 int rte_eth_dev_default_mac_addr_set(uint16_t port_id, 3945 struct rte_ether_addr *mac_addr); 3946 3947 /** 3948 * Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device. 3949 * 3950 * @param port_id 3951 * The port identifier of the Ethernet device. 3952 * @param reta_conf 3953 * RETA to update. 3954 * @param reta_size 3955 * Redirection table size. The table size can be queried by 3956 * rte_eth_dev_info_get(). 3957 * @return 3958 * - (0) if successful. 3959 * - (-ENODEV) if *port_id* is invalid. 3960 * - (-ENOTSUP) if hardware doesn't support. 3961 * - (-EINVAL) if bad parameter. 3962 * - (-EIO) if device is removed. 3963 */ 3964 int rte_eth_dev_rss_reta_update(uint16_t port_id, 3965 struct rte_eth_rss_reta_entry64 *reta_conf, 3966 uint16_t reta_size); 3967 3968 /** 3969 * Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device. 3970 * 3971 * @param port_id 3972 * The port identifier of the Ethernet device. 3973 * @param reta_conf 3974 * RETA to query. For each requested reta entry, corresponding bit 3975 * in mask must be set. 3976 * @param reta_size 3977 * Redirection table size. The table size can be queried by 3978 * rte_eth_dev_info_get(). 3979 * @return 3980 * - (0) if successful. 3981 * - (-ENODEV) if *port_id* is invalid. 3982 * - (-ENOTSUP) if hardware doesn't support. 3983 * - (-EINVAL) if bad parameter. 3984 * - (-EIO) if device is removed. 3985 */ 3986 int rte_eth_dev_rss_reta_query(uint16_t port_id, 3987 struct rte_eth_rss_reta_entry64 *reta_conf, 3988 uint16_t reta_size); 3989 3990 /** 3991 * Updates unicast hash table for receiving packet with the given destination 3992 * MAC address, and the packet is routed to all VFs for which the Rx mode is 3993 * accept packets that match the unicast hash table. 3994 * 3995 * @param port_id 3996 * The port identifier of the Ethernet device. 3997 * @param addr 3998 * Unicast MAC address. 3999 * @param on 4000 * 1 - Set an unicast hash bit for receiving packets with the MAC address. 4001 * 0 - Clear an unicast hash bit. 4002 * @return 4003 * - (0) if successful. 4004 * - (-ENOTSUP) if hardware doesn't support. 4005 * - (-ENODEV) if *port_id* invalid. 4006 * - (-EIO) if device is removed. 4007 * - (-EINVAL) if bad parameter. 4008 */ 4009 int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr, 4010 uint8_t on); 4011 4012 /** 4013 * Updates all unicast hash bitmaps for receiving packet with any Unicast 4014 * Ethernet MAC addresses,the packet is routed to all VFs for which the Rx 4015 * mode is accept packets that match the unicast hash table. 4016 * 4017 * @param port_id 4018 * The port identifier of the Ethernet device. 4019 * @param on 4020 * 1 - Set all unicast hash bitmaps for receiving all the Ethernet 4021 * MAC addresses 4022 * 0 - Clear all unicast hash bitmaps 4023 * @return 4024 * - (0) if successful. 4025 * - (-ENOTSUP) if hardware doesn't support. 4026 * - (-ENODEV) if *port_id* invalid. 4027 * - (-EIO) if device is removed. 4028 * - (-EINVAL) if bad parameter. 4029 */ 4030 int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on); 4031 4032 /** 4033 * Set the rate limitation for a queue on an Ethernet device. 4034 * 4035 * @param port_id 4036 * The port identifier of the Ethernet device. 4037 * @param queue_idx 4038 * The queue ID. 4039 * @param tx_rate 4040 * The Tx rate in Mbps. Allocated from the total port link speed. 4041 * @return 4042 * - (0) if successful. 4043 * - (-ENOTSUP) if hardware doesn't support this feature. 4044 * - (-ENODEV) if *port_id* invalid. 4045 * - (-EIO) if device is removed. 4046 * - (-EINVAL) if bad parameter. 4047 */ 4048 int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx, 4049 uint16_t tx_rate); 4050 4051 /** 4052 * Configuration of Receive Side Scaling hash computation of Ethernet device. 4053 * 4054 * @param port_id 4055 * The port identifier of the Ethernet device. 4056 * @param rss_conf 4057 * The new configuration to use for RSS hash computation on the port. 4058 * @return 4059 * - (0) if successful. 4060 * - (-ENODEV) if port identifier is invalid. 4061 * - (-EIO) if device is removed. 4062 * - (-ENOTSUP) if hardware doesn't support. 4063 * - (-EINVAL) if bad parameter. 4064 */ 4065 int rte_eth_dev_rss_hash_update(uint16_t port_id, 4066 struct rte_eth_rss_conf *rss_conf); 4067 4068 /** 4069 * Retrieve current configuration of Receive Side Scaling hash computation 4070 * of Ethernet device. 4071 * 4072 * @param port_id 4073 * The port identifier of the Ethernet device. 4074 * @param rss_conf 4075 * Where to store the current RSS hash configuration of the Ethernet device. 4076 * @return 4077 * - (0) if successful. 4078 * - (-ENODEV) if port identifier is invalid. 4079 * - (-EIO) if device is removed. 4080 * - (-ENOTSUP) if hardware doesn't support RSS. 4081 * - (-EINVAL) if bad parameter. 4082 */ 4083 int 4084 rte_eth_dev_rss_hash_conf_get(uint16_t port_id, 4085 struct rte_eth_rss_conf *rss_conf); 4086 4087 /** 4088 * Add UDP tunneling port for a type of tunnel. 4089 * 4090 * Some NICs may require such configuration to properly parse a tunnel 4091 * with any standard or custom UDP port. 4092 * The packets with this UDP port will be parsed for this type of tunnel. 4093 * The device parser will also check the rest of the tunnel headers 4094 * before classifying the packet. 4095 * 4096 * With some devices, this API will affect packet classification, i.e.: 4097 * - mbuf.packet_type reported on Rx 4098 * - rte_flow rules with tunnel items 4099 * 4100 * @param port_id 4101 * The port identifier of the Ethernet device. 4102 * @param tunnel_udp 4103 * UDP tunneling configuration. 4104 * 4105 * @return 4106 * - (0) if successful. 4107 * - (-ENODEV) if port identifier is invalid. 4108 * - (-EIO) if device is removed. 4109 * - (-ENOTSUP) if hardware doesn't support tunnel type. 4110 */ 4111 int 4112 rte_eth_dev_udp_tunnel_port_add(uint16_t port_id, 4113 struct rte_eth_udp_tunnel *tunnel_udp); 4114 4115 /** 4116 * Delete UDP tunneling port for a type of tunnel. 4117 * 4118 * The packets with this UDP port will not be classified as this type of tunnel 4119 * anymore if the device use such mapping for tunnel packet classification. 4120 * 4121 * @see rte_eth_dev_udp_tunnel_port_add 4122 * 4123 * @param port_id 4124 * The port identifier of the Ethernet device. 4125 * @param tunnel_udp 4126 * UDP tunneling configuration. 4127 * 4128 * @return 4129 * - (0) if successful. 4130 * - (-ENODEV) if port identifier is invalid. 4131 * - (-EIO) if device is removed. 4132 * - (-ENOTSUP) if hardware doesn't support tunnel type. 4133 */ 4134 int 4135 rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id, 4136 struct rte_eth_udp_tunnel *tunnel_udp); 4137 4138 /** 4139 * Get DCB information on an Ethernet device. 4140 * 4141 * @param port_id 4142 * The port identifier of the Ethernet device. 4143 * @param dcb_info 4144 * DCB information. 4145 * @return 4146 * - (0) if successful. 4147 * - (-ENODEV) if port identifier is invalid. 4148 * - (-EIO) if device is removed. 4149 * - (-ENOTSUP) if hardware doesn't support. 4150 * - (-EINVAL) if bad parameter. 4151 */ 4152 int rte_eth_dev_get_dcb_info(uint16_t port_id, 4153 struct rte_eth_dcb_info *dcb_info); 4154 4155 struct rte_eth_rxtx_callback; 4156 4157 /** 4158 * Add a callback to be called on packet Rx on a given port and queue. 4159 * 4160 * This API configures a function to be called for each burst of 4161 * packets received on a given NIC port queue. The return value is a pointer 4162 * that can be used to later remove the callback using 4163 * rte_eth_remove_rx_callback(). 4164 * 4165 * Multiple functions are called in the order that they are added. 4166 * 4167 * @param port_id 4168 * The port identifier of the Ethernet device. 4169 * @param queue_id 4170 * The queue on the Ethernet device on which the callback is to be added. 4171 * @param fn 4172 * The callback function 4173 * @param user_param 4174 * A generic pointer parameter which will be passed to each invocation of the 4175 * callback function on this port and queue. Inter-thread synchronization 4176 * of any user data changes is the responsibility of the user. 4177 * 4178 * @return 4179 * NULL on error. 4180 * On success, a pointer value which can later be used to remove the callback. 4181 */ 4182 const struct rte_eth_rxtx_callback * 4183 rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id, 4184 rte_rx_callback_fn fn, void *user_param); 4185 4186 /** 4187 * Add a callback that must be called first on packet Rx on a given port 4188 * and queue. 4189 * 4190 * This API configures a first function to be called for each burst of 4191 * packets received on a given NIC port queue. The return value is a pointer 4192 * that can be used to later remove the callback using 4193 * rte_eth_remove_rx_callback(). 4194 * 4195 * Multiple functions are called in the order that they are added. 4196 * 4197 * @param port_id 4198 * The port identifier of the Ethernet device. 4199 * @param queue_id 4200 * The queue on the Ethernet device on which the callback is to be added. 4201 * @param fn 4202 * The callback function 4203 * @param user_param 4204 * A generic pointer parameter which will be passed to each invocation of the 4205 * callback function on this port and queue. Inter-thread synchronization 4206 * of any user data changes is the responsibility of the user. 4207 * 4208 * @return 4209 * NULL on error. 4210 * On success, a pointer value which can later be used to remove the callback. 4211 */ 4212 const struct rte_eth_rxtx_callback * 4213 rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id, 4214 rte_rx_callback_fn fn, void *user_param); 4215 4216 /** 4217 * Add a callback to be called on packet Tx on a given port and queue. 4218 * 4219 * This API configures a function to be called for each burst of 4220 * packets sent on a given NIC port queue. The return value is a pointer 4221 * that can be used to later remove the callback using 4222 * rte_eth_remove_tx_callback(). 4223 * 4224 * Multiple functions are called in the order that they are added. 4225 * 4226 * @param port_id 4227 * The port identifier of the Ethernet device. 4228 * @param queue_id 4229 * The queue on the Ethernet device on which the callback is to be added. 4230 * @param fn 4231 * The callback function 4232 * @param user_param 4233 * A generic pointer parameter which will be passed to each invocation of the 4234 * callback function on this port and queue. Inter-thread synchronization 4235 * of any user data changes is the responsibility of the user. 4236 * 4237 * @return 4238 * NULL on error. 4239 * On success, a pointer value which can later be used to remove the callback. 4240 */ 4241 const struct rte_eth_rxtx_callback * 4242 rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id, 4243 rte_tx_callback_fn fn, void *user_param); 4244 4245 /** 4246 * Remove an Rx packet callback from a given port and queue. 4247 * 4248 * This function is used to removed callbacks that were added to a NIC port 4249 * queue using rte_eth_add_rx_callback(). 4250 * 4251 * Note: the callback is removed from the callback list but it isn't freed 4252 * since the it may still be in use. The memory for the callback can be 4253 * subsequently freed back by the application by calling rte_free(): 4254 * 4255 * - Immediately - if the port is stopped, or the user knows that no 4256 * callbacks are in flight e.g. if called from the thread doing Rx/Tx 4257 * on that queue. 4258 * 4259 * - After a short delay - where the delay is sufficient to allow any 4260 * in-flight callbacks to complete. Alternately, the RCU mechanism can be 4261 * used to detect when data plane threads have ceased referencing the 4262 * callback memory. 4263 * 4264 * @param port_id 4265 * The port identifier of the Ethernet device. 4266 * @param queue_id 4267 * The queue on the Ethernet device from which the callback is to be removed. 4268 * @param user_cb 4269 * User supplied callback created via rte_eth_add_rx_callback(). 4270 * 4271 * @return 4272 * - 0: Success. Callback was removed. 4273 * - -ENODEV: If *port_id* is invalid. 4274 * - -ENOTSUP: Callback support is not available. 4275 * - -EINVAL: The queue_id is out of range, or the callback 4276 * is NULL or not found for the port/queue. 4277 */ 4278 int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id, 4279 const struct rte_eth_rxtx_callback *user_cb); 4280 4281 /** 4282 * Remove a Tx packet callback from a given port and queue. 4283 * 4284 * This function is used to removed callbacks that were added to a NIC port 4285 * queue using rte_eth_add_tx_callback(). 4286 * 4287 * Note: the callback is removed from the callback list but it isn't freed 4288 * since the it may still be in use. The memory for the callback can be 4289 * subsequently freed back by the application by calling rte_free(): 4290 * 4291 * - Immediately - if the port is stopped, or the user knows that no 4292 * callbacks are in flight e.g. if called from the thread doing Rx/Tx 4293 * on that queue. 4294 * 4295 * - After a short delay - where the delay is sufficient to allow any 4296 * in-flight callbacks to complete. Alternately, the RCU mechanism can be 4297 * used to detect when data plane threads have ceased referencing the 4298 * callback memory. 4299 * 4300 * @param port_id 4301 * The port identifier of the Ethernet device. 4302 * @param queue_id 4303 * The queue on the Ethernet device from which the callback is to be removed. 4304 * @param user_cb 4305 * User supplied callback created via rte_eth_add_tx_callback(). 4306 * 4307 * @return 4308 * - 0: Success. Callback was removed. 4309 * - -ENODEV: If *port_id* is invalid. 4310 * - -ENOTSUP: Callback support is not available. 4311 * - -EINVAL: The queue_id is out of range, or the callback 4312 * is NULL or not found for the port/queue. 4313 */ 4314 int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id, 4315 const struct rte_eth_rxtx_callback *user_cb); 4316 4317 /** 4318 * Retrieve information about given port's Rx queue. 4319 * 4320 * @param port_id 4321 * The port identifier of the Ethernet device. 4322 * @param queue_id 4323 * The Rx queue on the Ethernet device for which information 4324 * will be retrieved. 4325 * @param qinfo 4326 * A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with 4327 * the information of the Ethernet device. 4328 * 4329 * @return 4330 * - 0: Success 4331 * - -ENODEV: If *port_id* is invalid. 4332 * - -ENOTSUP: routine is not supported by the device PMD. 4333 * - -EINVAL: The queue_id is out of range, or the queue 4334 * is hairpin queue. 4335 */ 4336 int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id, 4337 struct rte_eth_rxq_info *qinfo); 4338 4339 /** 4340 * Retrieve information about given port's Tx queue. 4341 * 4342 * @param port_id 4343 * The port identifier of the Ethernet device. 4344 * @param queue_id 4345 * The Tx queue on the Ethernet device for which information 4346 * will be retrieved. 4347 * @param qinfo 4348 * A pointer to a structure of type *rte_eth_txq_info_info* to be filled with 4349 * the information of the Ethernet device. 4350 * 4351 * @return 4352 * - 0: Success 4353 * - -ENODEV: If *port_id* is invalid. 4354 * - -ENOTSUP: routine is not supported by the device PMD. 4355 * - -EINVAL: The queue_id is out of range, or the queue 4356 * is hairpin queue. 4357 */ 4358 int rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id, 4359 struct rte_eth_txq_info *qinfo); 4360 4361 /** 4362 * Retrieve information about the Rx packet burst mode. 4363 * 4364 * @param port_id 4365 * The port identifier of the Ethernet device. 4366 * @param queue_id 4367 * The Rx queue on the Ethernet device for which information 4368 * will be retrieved. 4369 * @param mode 4370 * A pointer to a structure of type *rte_eth_burst_mode* to be filled 4371 * with the information of the packet burst mode. 4372 * 4373 * @return 4374 * - 0: Success 4375 * - -ENODEV: If *port_id* is invalid. 4376 * - -ENOTSUP: routine is not supported by the device PMD. 4377 * - -EINVAL: The queue_id is out of range. 4378 */ 4379 int rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id, 4380 struct rte_eth_burst_mode *mode); 4381 4382 /** 4383 * Retrieve information about the Tx packet burst mode. 4384 * 4385 * @param port_id 4386 * The port identifier of the Ethernet device. 4387 * @param queue_id 4388 * The Tx queue on the Ethernet device for which information 4389 * will be retrieved. 4390 * @param mode 4391 * A pointer to a structure of type *rte_eth_burst_mode* to be filled 4392 * with the information of the packet burst mode. 4393 * 4394 * @return 4395 * - 0: Success 4396 * - -ENODEV: If *port_id* is invalid. 4397 * - -ENOTSUP: routine is not supported by the device PMD. 4398 * - -EINVAL: The queue_id is out of range. 4399 */ 4400 int rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id, 4401 struct rte_eth_burst_mode *mode); 4402 4403 /** 4404 * @warning 4405 * @b EXPERIMENTAL: this API may change without prior notice. 4406 * 4407 * Retrieve the monitor condition for a given receive queue. 4408 * 4409 * @param port_id 4410 * The port identifier of the Ethernet device. 4411 * @param queue_id 4412 * The Rx queue on the Ethernet device for which information 4413 * will be retrieved. 4414 * @param pmc 4415 * The pointer to power-optimized monitoring condition structure. 4416 * 4417 * @return 4418 * - 0: Success. 4419 * -ENOTSUP: Operation not supported. 4420 * -EINVAL: Invalid parameters. 4421 * -ENODEV: Invalid port ID. 4422 */ 4423 __rte_experimental 4424 int rte_eth_get_monitor_addr(uint16_t port_id, uint16_t queue_id, 4425 struct rte_power_monitor_cond *pmc); 4426 4427 /** 4428 * Retrieve device registers and register attributes (number of registers and 4429 * register size) 4430 * 4431 * @param port_id 4432 * The port identifier of the Ethernet device. 4433 * @param info 4434 * Pointer to rte_dev_reg_info structure to fill in. If info->data is 4435 * NULL the function fills in the width and length fields. If non-NULL 4436 * the registers are put into the buffer pointed at by the data field. 4437 * @return 4438 * - (0) if successful. 4439 * - (-ENOTSUP) if hardware doesn't support. 4440 * - (-EINVAL) if bad parameter. 4441 * - (-ENODEV) if *port_id* invalid. 4442 * - (-EIO) if device is removed. 4443 * - others depends on the specific operations implementation. 4444 */ 4445 int rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info); 4446 4447 /** 4448 * Retrieve size of device EEPROM 4449 * 4450 * @param port_id 4451 * The port identifier of the Ethernet device. 4452 * @return 4453 * - (>=0) EEPROM size if successful. 4454 * - (-ENOTSUP) if hardware doesn't support. 4455 * - (-ENODEV) if *port_id* invalid. 4456 * - (-EIO) if device is removed. 4457 * - others depends on the specific operations implementation. 4458 */ 4459 int rte_eth_dev_get_eeprom_length(uint16_t port_id); 4460 4461 /** 4462 * Retrieve EEPROM and EEPROM attribute 4463 * 4464 * @param port_id 4465 * The port identifier of the Ethernet device. 4466 * @param info 4467 * The template includes buffer for return EEPROM data and 4468 * EEPROM attributes to be filled. 4469 * @return 4470 * - (0) if successful. 4471 * - (-ENOTSUP) if hardware doesn't support. 4472 * - (-EINVAL) if bad parameter. 4473 * - (-ENODEV) if *port_id* invalid. 4474 * - (-EIO) if device is removed. 4475 * - others depends on the specific operations implementation. 4476 */ 4477 int rte_eth_dev_get_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info); 4478 4479 /** 4480 * Program EEPROM with provided data 4481 * 4482 * @param port_id 4483 * The port identifier of the Ethernet device. 4484 * @param info 4485 * The template includes EEPROM data for programming and 4486 * EEPROM attributes to be filled 4487 * @return 4488 * - (0) if successful. 4489 * - (-ENOTSUP) if hardware doesn't support. 4490 * - (-ENODEV) if *port_id* invalid. 4491 * - (-EINVAL) if bad parameter. 4492 * - (-EIO) if device is removed. 4493 * - others depends on the specific operations implementation. 4494 */ 4495 int rte_eth_dev_set_eeprom(uint16_t port_id, struct rte_dev_eeprom_info *info); 4496 4497 /** 4498 * @warning 4499 * @b EXPERIMENTAL: this API may change without prior notice. 4500 * 4501 * Retrieve the type and size of plugin module EEPROM 4502 * 4503 * @param port_id 4504 * The port identifier of the Ethernet device. 4505 * @param modinfo 4506 * The type and size of plugin module EEPROM. 4507 * @return 4508 * - (0) if successful. 4509 * - (-ENOTSUP) if hardware doesn't support. 4510 * - (-ENODEV) if *port_id* invalid. 4511 * - (-EINVAL) if bad parameter. 4512 * - (-EIO) if device is removed. 4513 * - others depends on the specific operations implementation. 4514 */ 4515 __rte_experimental 4516 int 4517 rte_eth_dev_get_module_info(uint16_t port_id, 4518 struct rte_eth_dev_module_info *modinfo); 4519 4520 /** 4521 * @warning 4522 * @b EXPERIMENTAL: this API may change without prior notice. 4523 * 4524 * Retrieve the data of plugin module EEPROM 4525 * 4526 * @param port_id 4527 * The port identifier of the Ethernet device. 4528 * @param info 4529 * The template includes the plugin module EEPROM attributes, and the 4530 * buffer for return plugin module EEPROM data. 4531 * @return 4532 * - (0) if successful. 4533 * - (-ENOTSUP) if hardware doesn't support. 4534 * - (-EINVAL) if bad parameter. 4535 * - (-ENODEV) if *port_id* invalid. 4536 * - (-EIO) if device is removed. 4537 * - others depends on the specific operations implementation. 4538 */ 4539 __rte_experimental 4540 int 4541 rte_eth_dev_get_module_eeprom(uint16_t port_id, 4542 struct rte_dev_eeprom_info *info); 4543 4544 /** 4545 * Set the list of multicast addresses to filter on an Ethernet device. 4546 * 4547 * @param port_id 4548 * The port identifier of the Ethernet device. 4549 * @param mc_addr_set 4550 * The array of multicast addresses to set. Equal to NULL when the function 4551 * is invoked to flush the set of filtered addresses. 4552 * @param nb_mc_addr 4553 * The number of multicast addresses in the *mc_addr_set* array. Equal to 0 4554 * when the function is invoked to flush the set of filtered addresses. 4555 * @return 4556 * - (0) if successful. 4557 * - (-ENODEV) if *port_id* invalid. 4558 * - (-EIO) if device is removed. 4559 * - (-ENOTSUP) if PMD of *port_id* doesn't support multicast filtering. 4560 * - (-ENOSPC) if *port_id* has not enough multicast filtering resources. 4561 * - (-EINVAL) if bad parameter. 4562 */ 4563 int rte_eth_dev_set_mc_addr_list(uint16_t port_id, 4564 struct rte_ether_addr *mc_addr_set, 4565 uint32_t nb_mc_addr); 4566 4567 /** 4568 * Enable IEEE1588/802.1AS timestamping for an Ethernet device. 4569 * 4570 * @param port_id 4571 * The port identifier of the Ethernet device. 4572 * 4573 * @return 4574 * - 0: Success. 4575 * - -ENODEV: The port ID is invalid. 4576 * - -EIO: if device is removed. 4577 * - -ENOTSUP: The function is not supported by the Ethernet driver. 4578 */ 4579 int rte_eth_timesync_enable(uint16_t port_id); 4580 4581 /** 4582 * Disable IEEE1588/802.1AS timestamping for an Ethernet device. 4583 * 4584 * @param port_id 4585 * The port identifier of the Ethernet device. 4586 * 4587 * @return 4588 * - 0: Success. 4589 * - -ENODEV: The port ID is invalid. 4590 * - -EIO: if device is removed. 4591 * - -ENOTSUP: The function is not supported by the Ethernet driver. 4592 */ 4593 int rte_eth_timesync_disable(uint16_t port_id); 4594 4595 /** 4596 * Read an IEEE1588/802.1AS Rx timestamp from an Ethernet device. 4597 * 4598 * @param port_id 4599 * The port identifier of the Ethernet device. 4600 * @param timestamp 4601 * Pointer to the timestamp struct. 4602 * @param flags 4603 * Device specific flags. Used to pass the Rx timesync register index to 4604 * i40e. Unused in igb/ixgbe, pass 0 instead. 4605 * 4606 * @return 4607 * - 0: Success. 4608 * - -EINVAL: No timestamp is available. 4609 * - -ENODEV: The port ID is invalid. 4610 * - -EIO: if device is removed. 4611 * - -ENOTSUP: The function is not supported by the Ethernet driver. 4612 */ 4613 int rte_eth_timesync_read_rx_timestamp(uint16_t port_id, 4614 struct timespec *timestamp, uint32_t flags); 4615 4616 /** 4617 * Read an IEEE1588/802.1AS Tx timestamp from an Ethernet device. 4618 * 4619 * @param port_id 4620 * The port identifier of the Ethernet device. 4621 * @param timestamp 4622 * Pointer to the timestamp struct. 4623 * 4624 * @return 4625 * - 0: Success. 4626 * - -EINVAL: No timestamp is available. 4627 * - -ENODEV: The port ID is invalid. 4628 * - -EIO: if device is removed. 4629 * - -ENOTSUP: The function is not supported by the Ethernet driver. 4630 */ 4631 int rte_eth_timesync_read_tx_timestamp(uint16_t port_id, 4632 struct timespec *timestamp); 4633 4634 /** 4635 * Adjust the timesync clock on an Ethernet device. 4636 * 4637 * This is usually used in conjunction with other Ethdev timesync functions to 4638 * synchronize the device time using the IEEE1588/802.1AS protocol. 4639 * 4640 * @param port_id 4641 * The port identifier of the Ethernet device. 4642 * @param delta 4643 * The adjustment in nanoseconds. 4644 * 4645 * @return 4646 * - 0: Success. 4647 * - -ENODEV: The port ID is invalid. 4648 * - -EIO: if device is removed. 4649 * - -ENOTSUP: The function is not supported by the Ethernet driver. 4650 */ 4651 int rte_eth_timesync_adjust_time(uint16_t port_id, int64_t delta); 4652 4653 /** 4654 * Read the time from the timesync clock on an Ethernet device. 4655 * 4656 * This is usually used in conjunction with other Ethdev timesync functions to 4657 * synchronize the device time using the IEEE1588/802.1AS protocol. 4658 * 4659 * @param port_id 4660 * The port identifier of the Ethernet device. 4661 * @param time 4662 * Pointer to the timespec struct that holds the time. 4663 * 4664 * @return 4665 * - 0: Success. 4666 * - -EINVAL: Bad parameter. 4667 */ 4668 int rte_eth_timesync_read_time(uint16_t port_id, struct timespec *time); 4669 4670 /** 4671 * Set the time of the timesync clock on an Ethernet device. 4672 * 4673 * This is usually used in conjunction with other Ethdev timesync functions to 4674 * synchronize the device time using the IEEE1588/802.1AS protocol. 4675 * 4676 * @param port_id 4677 * The port identifier of the Ethernet device. 4678 * @param time 4679 * Pointer to the timespec struct that holds the time. 4680 * 4681 * @return 4682 * - 0: Success. 4683 * - -EINVAL: No timestamp is available. 4684 * - -ENODEV: The port ID is invalid. 4685 * - -EIO: if device is removed. 4686 * - -ENOTSUP: The function is not supported by the Ethernet driver. 4687 */ 4688 int rte_eth_timesync_write_time(uint16_t port_id, const struct timespec *time); 4689 4690 /** 4691 * @warning 4692 * @b EXPERIMENTAL: this API may change without prior notice. 4693 * 4694 * Read the current clock counter of an Ethernet device 4695 * 4696 * This returns the current raw clock value of an Ethernet device. It is 4697 * a raw amount of ticks, with no given time reference. 4698 * The value returned here is from the same clock than the one 4699 * filling timestamp field of Rx packets when using hardware timestamp 4700 * offload. Therefore it can be used to compute a precise conversion of 4701 * the device clock to the real time. 4702 * 4703 * E.g, a simple heuristic to derivate the frequency would be: 4704 * uint64_t start, end; 4705 * rte_eth_read_clock(port, start); 4706 * rte_delay_ms(100); 4707 * rte_eth_read_clock(port, end); 4708 * double freq = (end - start) * 10; 4709 * 4710 * Compute a common reference with: 4711 * uint64_t base_time_sec = current_time(); 4712 * uint64_t base_clock; 4713 * rte_eth_read_clock(port, base_clock); 4714 * 4715 * Then, convert the raw mbuf timestamp with: 4716 * base_time_sec + (double)(*timestamp_dynfield(mbuf) - base_clock) / freq; 4717 * 4718 * This simple example will not provide a very good accuracy. One must 4719 * at least measure multiple times the frequency and do a regression. 4720 * To avoid deviation from the system time, the common reference can 4721 * be repeated from time to time. The integer division can also be 4722 * converted by a multiplication and a shift for better performance. 4723 * 4724 * @param port_id 4725 * The port identifier of the Ethernet device. 4726 * @param clock 4727 * Pointer to the uint64_t that holds the raw clock value. 4728 * 4729 * @return 4730 * - 0: Success. 4731 * - -ENODEV: The port ID is invalid. 4732 * - -ENOTSUP: The function is not supported by the Ethernet driver. 4733 * - -EINVAL: if bad parameter. 4734 */ 4735 __rte_experimental 4736 int 4737 rte_eth_read_clock(uint16_t port_id, uint64_t *clock); 4738 4739 /** 4740 * Get the port ID from device name. The device name should be specified 4741 * as below: 4742 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0 4743 * - SoC device name, for example- fsl-gmac0 4744 * - vdev dpdk name, for example- net_[pcap0|null0|tap0] 4745 * 4746 * @param name 4747 * pci address or name of the device 4748 * @param port_id 4749 * pointer to port identifier of the device 4750 * @return 4751 * - (0) if successful and port_id is filled. 4752 * - (-ENODEV or -EINVAL) on failure. 4753 */ 4754 int 4755 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id); 4756 4757 /** 4758 * Get the device name from port ID. The device name is specified as below: 4759 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0 4760 * - SoC device name, for example- fsl-gmac0 4761 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0] 4762 * 4763 * @param port_id 4764 * Port identifier of the device. 4765 * @param name 4766 * Buffer of size RTE_ETH_NAME_MAX_LEN to store the name. 4767 * @return 4768 * - (0) if successful. 4769 * - (-ENODEV) if *port_id* is invalid. 4770 * - (-EINVAL) on failure. 4771 */ 4772 int 4773 rte_eth_dev_get_name_by_port(uint16_t port_id, char *name); 4774 4775 /** 4776 * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from 4777 * the Ethernet device information, otherwise adjust them to boundaries. 4778 * 4779 * @param port_id 4780 * The port identifier of the Ethernet device. 4781 * @param nb_rx_desc 4782 * A pointer to a uint16_t where the number of receive 4783 * descriptors stored. 4784 * @param nb_tx_desc 4785 * A pointer to a uint16_t where the number of transmit 4786 * descriptors stored. 4787 * @return 4788 * - (0) if successful. 4789 * - (-ENOTSUP, -ENODEV or -EINVAL) on failure. 4790 */ 4791 int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id, 4792 uint16_t *nb_rx_desc, 4793 uint16_t *nb_tx_desc); 4794 4795 /** 4796 * Test if a port supports specific mempool ops. 4797 * 4798 * @param port_id 4799 * Port identifier of the Ethernet device. 4800 * @param [in] pool 4801 * The name of the pool operations to test. 4802 * @return 4803 * - 0: best mempool ops choice for this port. 4804 * - 1: mempool ops are supported for this port. 4805 * - -ENOTSUP: mempool ops not supported for this port. 4806 * - -ENODEV: Invalid port Identifier. 4807 * - -EINVAL: Pool param is null. 4808 */ 4809 int 4810 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool); 4811 4812 /** 4813 * Get the security context for the Ethernet device. 4814 * 4815 * @param port_id 4816 * Port identifier of the Ethernet device 4817 * @return 4818 * - NULL on error. 4819 * - pointer to security context on success. 4820 */ 4821 void * 4822 rte_eth_dev_get_sec_ctx(uint16_t port_id); 4823 4824 /** 4825 * @warning 4826 * @b EXPERIMENTAL: this API may change, or be removed, without prior notice 4827 * 4828 * Query the device hairpin capabilities. 4829 * 4830 * @param port_id 4831 * The port identifier of the Ethernet device. 4832 * @param cap 4833 * Pointer to a structure that will hold the hairpin capabilities. 4834 * @return 4835 * - (0) if successful. 4836 * - (-ENOTSUP) if hardware doesn't support. 4837 * - (-EINVAL) if bad parameter. 4838 */ 4839 __rte_experimental 4840 int rte_eth_dev_hairpin_capability_get(uint16_t port_id, 4841 struct rte_eth_hairpin_cap *cap); 4842 4843 /** 4844 * @warning 4845 * @b EXPERIMENTAL: this structure may change without prior notice. 4846 * 4847 * Ethernet device representor ID range entry 4848 */ 4849 struct rte_eth_representor_range { 4850 enum rte_eth_representor_type type; /**< Representor type */ 4851 int controller; /**< Controller index */ 4852 int pf; /**< Physical function index */ 4853 __extension__ 4854 union { 4855 int vf; /**< VF start index */ 4856 int sf; /**< SF start index */ 4857 }; 4858 uint32_t id_base; /**< Representor ID start index */ 4859 uint32_t id_end; /**< Representor ID end index */ 4860 char name[RTE_DEV_NAME_MAX_LEN]; /**< Representor name */ 4861 }; 4862 4863 /** 4864 * @warning 4865 * @b EXPERIMENTAL: this structure may change without prior notice. 4866 * 4867 * Ethernet device representor information 4868 */ 4869 struct rte_eth_representor_info { 4870 uint16_t controller; /**< Controller ID of caller device. */ 4871 uint16_t pf; /**< Physical function ID of caller device. */ 4872 uint32_t nb_ranges_alloc; /**< Size of the ranges array. */ 4873 uint32_t nb_ranges; /**< Number of initialized ranges. */ 4874 struct rte_eth_representor_range ranges[];/**< Representor ID range. */ 4875 }; 4876 4877 /** 4878 * Retrieve the representor info of the device. 4879 * 4880 * Get device representor info to be able to calculate a unique 4881 * representor ID. @see rte_eth_representor_id_get helper. 4882 * 4883 * @param port_id 4884 * The port identifier of the device. 4885 * @param info 4886 * A pointer to a representor info structure. 4887 * NULL to return number of range entries and allocate memory 4888 * for next call to store detail. 4889 * The number of ranges that were written into this structure 4890 * will be placed into its nb_ranges field. This number cannot be 4891 * larger than the nb_ranges_alloc that by the user before calling 4892 * this function. It can be smaller than the value returned by the 4893 * function, however. 4894 * @return 4895 * - (-ENOTSUP) if operation is not supported. 4896 * - (-ENODEV) if *port_id* invalid. 4897 * - (-EIO) if device is removed. 4898 * - (>=0) number of available representor range entries. 4899 */ 4900 __rte_experimental 4901 int rte_eth_representor_info_get(uint16_t port_id, 4902 struct rte_eth_representor_info *info); 4903 4904 /** The NIC is able to deliver flag (if set) with packets to the PMD. */ 4905 #define RTE_ETH_RX_METADATA_USER_FLAG RTE_BIT64(0) 4906 4907 /** The NIC is able to deliver mark ID with packets to the PMD. */ 4908 #define RTE_ETH_RX_METADATA_USER_MARK RTE_BIT64(1) 4909 4910 /** The NIC is able to deliver tunnel ID with packets to the PMD. */ 4911 #define RTE_ETH_RX_METADATA_TUNNEL_ID RTE_BIT64(2) 4912 4913 /** 4914 * @warning 4915 * @b EXPERIMENTAL: this API may change without prior notice 4916 * 4917 * Negotiate the NIC's ability to deliver specific kinds of metadata to the PMD. 4918 * 4919 * Invoke this API before the first rte_eth_dev_configure() invocation 4920 * to let the PMD make preparations that are inconvenient to do later. 4921 * 4922 * The negotiation process is as follows: 4923 * 4924 * - the application requests features intending to use at least some of them; 4925 * - the PMD responds with the guaranteed subset of the requested feature set; 4926 * - the application can retry negotiation with another set of features; 4927 * - the application can pass zero to clear the negotiation result; 4928 * - the last negotiated result takes effect upon 4929 * the ethdev configure and start. 4930 * 4931 * @note 4932 * The PMD is supposed to first consider enabling the requested feature set 4933 * in its entirety. Only if it fails to do so, does it have the right to 4934 * respond with a smaller set of the originally requested features. 4935 * 4936 * @note 4937 * Return code (-ENOTSUP) does not necessarily mean that the requested 4938 * features are unsupported. In this case, the application should just 4939 * assume that these features can be used without prior negotiations. 4940 * 4941 * @param port_id 4942 * Port (ethdev) identifier 4943 * 4944 * @param[inout] features 4945 * Feature selection buffer 4946 * 4947 * @return 4948 * - (-EBUSY) if the port can't handle this in its current state; 4949 * - (-ENOTSUP) if the method itself is not supported by the PMD; 4950 * - (-ENODEV) if *port_id* is invalid; 4951 * - (-EINVAL) if *features* is NULL; 4952 * - (-EIO) if the device is removed; 4953 * - (0) on success 4954 */ 4955 __rte_experimental 4956 int rte_eth_rx_metadata_negotiate(uint16_t port_id, uint64_t *features); 4957 4958 #include <rte_ethdev_core.h> 4959 4960 /** 4961 * @internal 4962 * Helper routine for rte_eth_rx_burst(). 4963 * Should be called at exit from PMD's rte_eth_rx_bulk implementation. 4964 * Does necessary post-processing - invokes Rx callbacks if any, etc. 4965 * 4966 * @param port_id 4967 * The port identifier of the Ethernet device. 4968 * @param queue_id 4969 * The index of the receive queue from which to retrieve input packets. 4970 * @param rx_pkts 4971 * The address of an array of pointers to *rte_mbuf* structures that 4972 * have been retrieved from the device. 4973 * @param nb_rx 4974 * The number of packets that were retrieved from the device. 4975 * @param nb_pkts 4976 * The number of elements in @p rx_pkts array. 4977 * @param opaque 4978 * Opaque pointer of Rx queue callback related data. 4979 * 4980 * @return 4981 * The number of packets effectively supplied to the @p rx_pkts array. 4982 */ 4983 uint16_t rte_eth_call_rx_callbacks(uint16_t port_id, uint16_t queue_id, 4984 struct rte_mbuf **rx_pkts, uint16_t nb_rx, uint16_t nb_pkts, 4985 void *opaque); 4986 4987 /** 4988 * 4989 * Retrieve a burst of input packets from a receive queue of an Ethernet 4990 * device. The retrieved packets are stored in *rte_mbuf* structures whose 4991 * pointers are supplied in the *rx_pkts* array. 4992 * 4993 * The rte_eth_rx_burst() function loops, parsing the Rx ring of the 4994 * receive queue, up to *nb_pkts* packets, and for each completed Rx 4995 * descriptor in the ring, it performs the following operations: 4996 * 4997 * - Initialize the *rte_mbuf* data structure associated with the 4998 * Rx descriptor according to the information provided by the NIC into 4999 * that Rx descriptor. 5000 * 5001 * - Store the *rte_mbuf* data structure into the next entry of the 5002 * *rx_pkts* array. 5003 * 5004 * - Replenish the Rx descriptor with a new *rte_mbuf* buffer 5005 * allocated from the memory pool associated with the receive queue at 5006 * initialization time. 5007 * 5008 * When retrieving an input packet that was scattered by the controller 5009 * into multiple receive descriptors, the rte_eth_rx_burst() function 5010 * appends the associated *rte_mbuf* buffers to the first buffer of the 5011 * packet. 5012 * 5013 * The rte_eth_rx_burst() function returns the number of packets 5014 * actually retrieved, which is the number of *rte_mbuf* data structures 5015 * effectively supplied into the *rx_pkts* array. 5016 * A return value equal to *nb_pkts* indicates that the Rx queue contained 5017 * at least *rx_pkts* packets, and this is likely to signify that other 5018 * received packets remain in the input queue. Applications implementing 5019 * a "retrieve as much received packets as possible" policy can check this 5020 * specific case and keep invoking the rte_eth_rx_burst() function until 5021 * a value less than *nb_pkts* is returned. 5022 * 5023 * This receive method has the following advantages: 5024 * 5025 * - It allows a run-to-completion network stack engine to retrieve and 5026 * to immediately process received packets in a fast burst-oriented 5027 * approach, avoiding the overhead of unnecessary intermediate packet 5028 * queue/dequeue operations. 5029 * 5030 * - Conversely, it also allows an asynchronous-oriented processing 5031 * method to retrieve bursts of received packets and to immediately 5032 * queue them for further parallel processing by another logical core, 5033 * for instance. However, instead of having received packets being 5034 * individually queued by the driver, this approach allows the caller 5035 * of the rte_eth_rx_burst() function to queue a burst of retrieved 5036 * packets at a time and therefore dramatically reduce the cost of 5037 * enqueue/dequeue operations per packet. 5038 * 5039 * - It allows the rte_eth_rx_burst() function of the driver to take 5040 * advantage of burst-oriented hardware features (CPU cache, 5041 * prefetch instructions, and so on) to minimize the number of CPU 5042 * cycles per packet. 5043 * 5044 * To summarize, the proposed receive API enables many 5045 * burst-oriented optimizations in both synchronous and asynchronous 5046 * packet processing environments with no overhead in both cases. 5047 * 5048 * @note 5049 * Some drivers using vector instructions require that *nb_pkts* is 5050 * divisible by 4 or 8, depending on the driver implementation. 5051 * 5052 * The rte_eth_rx_burst() function does not provide any error 5053 * notification to avoid the corresponding overhead. As a hint, the 5054 * upper-level application might check the status of the device link once 5055 * being systematically returned a 0 value for a given number of tries. 5056 * 5057 * @param port_id 5058 * The port identifier of the Ethernet device. 5059 * @param queue_id 5060 * The index of the receive queue from which to retrieve input packets. 5061 * The value must be in the range [0, nb_rx_queue - 1] previously supplied 5062 * to rte_eth_dev_configure(). 5063 * @param rx_pkts 5064 * The address of an array of pointers to *rte_mbuf* structures that 5065 * must be large enough to store *nb_pkts* pointers in it. 5066 * @param nb_pkts 5067 * The maximum number of packets to retrieve. 5068 * The value must be divisible by 8 in order to work with any driver. 5069 * @return 5070 * The number of packets actually retrieved, which is the number 5071 * of pointers to *rte_mbuf* structures effectively supplied to the 5072 * *rx_pkts* array. 5073 */ 5074 static inline uint16_t 5075 rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id, 5076 struct rte_mbuf **rx_pkts, const uint16_t nb_pkts) 5077 { 5078 uint16_t nb_rx; 5079 struct rte_eth_fp_ops *p; 5080 void *qd; 5081 5082 #ifdef RTE_ETHDEV_DEBUG_RX 5083 if (port_id >= RTE_MAX_ETHPORTS || 5084 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 5085 RTE_ETHDEV_LOG(ERR, 5086 "Invalid port_id=%u or queue_id=%u\n", 5087 port_id, queue_id); 5088 return 0; 5089 } 5090 #endif 5091 5092 /* fetch pointer to queue data */ 5093 p = &rte_eth_fp_ops[port_id]; 5094 qd = p->rxq.data[queue_id]; 5095 5096 #ifdef RTE_ETHDEV_DEBUG_RX 5097 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0); 5098 5099 if (qd == NULL) { 5100 RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u for port_id=%u\n", 5101 queue_id, port_id); 5102 return 0; 5103 } 5104 #endif 5105 5106 nb_rx = p->rx_pkt_burst(qd, rx_pkts, nb_pkts); 5107 5108 #ifdef RTE_ETHDEV_RXTX_CALLBACKS 5109 { 5110 void *cb; 5111 5112 /* __ATOMIC_RELEASE memory order was used when the 5113 * call back was inserted into the list. 5114 * Since there is a clear dependency between loading 5115 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is 5116 * not required. 5117 */ 5118 cb = __atomic_load_n((void **)&p->rxq.clbk[queue_id], 5119 __ATOMIC_RELAXED); 5120 if (unlikely(cb != NULL)) 5121 nb_rx = rte_eth_call_rx_callbacks(port_id, queue_id, 5122 rx_pkts, nb_rx, nb_pkts, cb); 5123 } 5124 #endif 5125 5126 rte_ethdev_trace_rx_burst(port_id, queue_id, (void **)rx_pkts, nb_rx); 5127 return nb_rx; 5128 } 5129 5130 /** 5131 * Get the number of used descriptors of a Rx queue 5132 * 5133 * @param port_id 5134 * The port identifier of the Ethernet device. 5135 * @param queue_id 5136 * The queue ID on the specific port. 5137 * @return 5138 * The number of used descriptors in the specific queue, or: 5139 * - (-ENODEV) if *port_id* is invalid. 5140 * (-EINVAL) if *queue_id* is invalid 5141 * (-ENOTSUP) if the device does not support this function 5142 */ 5143 static inline int 5144 rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id) 5145 { 5146 struct rte_eth_fp_ops *p; 5147 void *qd; 5148 5149 if (port_id >= RTE_MAX_ETHPORTS || 5150 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 5151 RTE_ETHDEV_LOG(ERR, 5152 "Invalid port_id=%u or queue_id=%u\n", 5153 port_id, queue_id); 5154 return -EINVAL; 5155 } 5156 5157 /* fetch pointer to queue data */ 5158 p = &rte_eth_fp_ops[port_id]; 5159 qd = p->rxq.data[queue_id]; 5160 5161 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); 5162 RTE_FUNC_PTR_OR_ERR_RET(*p->rx_queue_count, -ENOTSUP); 5163 if (qd == NULL) 5164 return -EINVAL; 5165 5166 return (int)(*p->rx_queue_count)(qd); 5167 } 5168 5169 /**@{@name Rx hardware descriptor states 5170 * @see rte_eth_rx_descriptor_status 5171 */ 5172 #define RTE_ETH_RX_DESC_AVAIL 0 /**< Desc available for hw. */ 5173 #define RTE_ETH_RX_DESC_DONE 1 /**< Desc done, filled by hw. */ 5174 #define RTE_ETH_RX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */ 5175 /**@}*/ 5176 5177 /** 5178 * Check the status of a Rx descriptor in the queue 5179 * 5180 * It should be called in a similar context than the Rx function: 5181 * - on a dataplane core 5182 * - not concurrently on the same queue 5183 * 5184 * Since it's a dataplane function, no check is performed on port_id and 5185 * queue_id. The caller must therefore ensure that the port is enabled 5186 * and the queue is configured and running. 5187 * 5188 * Note: accessing to a random descriptor in the ring may trigger cache 5189 * misses and have a performance impact. 5190 * 5191 * @param port_id 5192 * A valid port identifier of the Ethernet device which. 5193 * @param queue_id 5194 * A valid Rx queue identifier on this port. 5195 * @param offset 5196 * The offset of the descriptor starting from tail (0 is the next 5197 * packet to be received by the driver). 5198 * 5199 * @return 5200 * - (RTE_ETH_RX_DESC_AVAIL): Descriptor is available for the hardware to 5201 * receive a packet. 5202 * - (RTE_ETH_RX_DESC_DONE): Descriptor is done, it is filled by hw, but 5203 * not yet processed by the driver (i.e. in the receive queue). 5204 * - (RTE_ETH_RX_DESC_UNAVAIL): Descriptor is unavailable, either hold by 5205 * the driver and not yet returned to hw, or reserved by the hw. 5206 * - (-EINVAL) bad descriptor offset. 5207 * - (-ENOTSUP) if the device does not support this function. 5208 * - (-ENODEV) bad port or queue (only if compiled with debug). 5209 */ 5210 static inline int 5211 rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id, 5212 uint16_t offset) 5213 { 5214 struct rte_eth_fp_ops *p; 5215 void *qd; 5216 5217 #ifdef RTE_ETHDEV_DEBUG_RX 5218 if (port_id >= RTE_MAX_ETHPORTS || 5219 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 5220 RTE_ETHDEV_LOG(ERR, 5221 "Invalid port_id=%u or queue_id=%u\n", 5222 port_id, queue_id); 5223 return -EINVAL; 5224 } 5225 #endif 5226 5227 /* fetch pointer to queue data */ 5228 p = &rte_eth_fp_ops[port_id]; 5229 qd = p->rxq.data[queue_id]; 5230 5231 #ifdef RTE_ETHDEV_DEBUG_RX 5232 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); 5233 if (qd == NULL) 5234 return -ENODEV; 5235 #endif 5236 RTE_FUNC_PTR_OR_ERR_RET(*p->rx_descriptor_status, -ENOTSUP); 5237 return (*p->rx_descriptor_status)(qd, offset); 5238 } 5239 5240 /**@{@name Tx hardware descriptor states 5241 * @see rte_eth_tx_descriptor_status 5242 */ 5243 #define RTE_ETH_TX_DESC_FULL 0 /**< Desc filled for hw, waiting xmit. */ 5244 #define RTE_ETH_TX_DESC_DONE 1 /**< Desc done, packet is transmitted. */ 5245 #define RTE_ETH_TX_DESC_UNAVAIL 2 /**< Desc used by driver or hw. */ 5246 /**@}*/ 5247 5248 /** 5249 * Check the status of a Tx descriptor in the queue. 5250 * 5251 * It should be called in a similar context than the Tx function: 5252 * - on a dataplane core 5253 * - not concurrently on the same queue 5254 * 5255 * Since it's a dataplane function, no check is performed on port_id and 5256 * queue_id. The caller must therefore ensure that the port is enabled 5257 * and the queue is configured and running. 5258 * 5259 * Note: accessing to a random descriptor in the ring may trigger cache 5260 * misses and have a performance impact. 5261 * 5262 * @param port_id 5263 * A valid port identifier of the Ethernet device which. 5264 * @param queue_id 5265 * A valid Tx queue identifier on this port. 5266 * @param offset 5267 * The offset of the descriptor starting from tail (0 is the place where 5268 * the next packet will be send). 5269 * 5270 * @return 5271 * - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e. 5272 * in the transmit queue. 5273 * - (RTE_ETH_TX_DESC_DONE) Hardware is done with this descriptor, it can 5274 * be reused by the driver. 5275 * - (RTE_ETH_TX_DESC_UNAVAIL): Descriptor is unavailable, reserved by the 5276 * driver or the hardware. 5277 * - (-EINVAL) bad descriptor offset. 5278 * - (-ENOTSUP) if the device does not support this function. 5279 * - (-ENODEV) bad port or queue (only if compiled with debug). 5280 */ 5281 static inline int rte_eth_tx_descriptor_status(uint16_t port_id, 5282 uint16_t queue_id, uint16_t offset) 5283 { 5284 struct rte_eth_fp_ops *p; 5285 void *qd; 5286 5287 #ifdef RTE_ETHDEV_DEBUG_TX 5288 if (port_id >= RTE_MAX_ETHPORTS || 5289 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 5290 RTE_ETHDEV_LOG(ERR, 5291 "Invalid port_id=%u or queue_id=%u\n", 5292 port_id, queue_id); 5293 return -EINVAL; 5294 } 5295 #endif 5296 5297 /* fetch pointer to queue data */ 5298 p = &rte_eth_fp_ops[port_id]; 5299 qd = p->txq.data[queue_id]; 5300 5301 #ifdef RTE_ETHDEV_DEBUG_TX 5302 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); 5303 if (qd == NULL) 5304 return -ENODEV; 5305 #endif 5306 RTE_FUNC_PTR_OR_ERR_RET(*p->tx_descriptor_status, -ENOTSUP); 5307 return (*p->tx_descriptor_status)(qd, offset); 5308 } 5309 5310 /** 5311 * @internal 5312 * Helper routine for rte_eth_tx_burst(). 5313 * Should be called before entry PMD's rte_eth_tx_bulk implementation. 5314 * Does necessary pre-processing - invokes Tx callbacks if any, etc. 5315 * 5316 * @param port_id 5317 * The port identifier of the Ethernet device. 5318 * @param queue_id 5319 * The index of the transmit queue through which output packets must be 5320 * sent. 5321 * @param tx_pkts 5322 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures 5323 * which contain the output packets. 5324 * @param nb_pkts 5325 * The maximum number of packets to transmit. 5326 * @return 5327 * The number of output packets to transmit. 5328 */ 5329 uint16_t rte_eth_call_tx_callbacks(uint16_t port_id, uint16_t queue_id, 5330 struct rte_mbuf **tx_pkts, uint16_t nb_pkts, void *opaque); 5331 5332 /** 5333 * Send a burst of output packets on a transmit queue of an Ethernet device. 5334 * 5335 * The rte_eth_tx_burst() function is invoked to transmit output packets 5336 * on the output queue *queue_id* of the Ethernet device designated by its 5337 * *port_id*. 5338 * The *nb_pkts* parameter is the number of packets to send which are 5339 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them 5340 * allocated from a pool created with rte_pktmbuf_pool_create(). 5341 * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets, 5342 * up to the number of transmit descriptors available in the Tx ring of the 5343 * transmit queue. 5344 * For each packet to send, the rte_eth_tx_burst() function performs 5345 * the following operations: 5346 * 5347 * - Pick up the next available descriptor in the transmit ring. 5348 * 5349 * - Free the network buffer previously sent with that descriptor, if any. 5350 * 5351 * - Initialize the transmit descriptor with the information provided 5352 * in the *rte_mbuf data structure. 5353 * 5354 * In the case of a segmented packet composed of a list of *rte_mbuf* buffers, 5355 * the rte_eth_tx_burst() function uses several transmit descriptors 5356 * of the ring. 5357 * 5358 * The rte_eth_tx_burst() function returns the number of packets it 5359 * actually sent. A return value equal to *nb_pkts* means that all packets 5360 * have been sent, and this is likely to signify that other output packets 5361 * could be immediately transmitted again. Applications that implement a 5362 * "send as many packets to transmit as possible" policy can check this 5363 * specific case and keep invoking the rte_eth_tx_burst() function until 5364 * a value less than *nb_pkts* is returned. 5365 * 5366 * It is the responsibility of the rte_eth_tx_burst() function to 5367 * transparently free the memory buffers of packets previously sent. 5368 * This feature is driven by the *tx_free_thresh* value supplied to the 5369 * rte_eth_dev_configure() function at device configuration time. 5370 * When the number of free Tx descriptors drops below this threshold, the 5371 * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf* buffers 5372 * of those packets whose transmission was effectively completed. 5373 * 5374 * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can 5375 * invoke this function concurrently on the same Tx queue without SW lock. 5376 * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads 5377 * 5378 * @see rte_eth_tx_prepare to perform some prior checks or adjustments 5379 * for offloads. 5380 * 5381 * @param port_id 5382 * The port identifier of the Ethernet device. 5383 * @param queue_id 5384 * The index of the transmit queue through which output packets must be 5385 * sent. 5386 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 5387 * to rte_eth_dev_configure(). 5388 * @param tx_pkts 5389 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures 5390 * which contain the output packets. 5391 * @param nb_pkts 5392 * The maximum number of packets to transmit. 5393 * @return 5394 * The number of output packets actually stored in transmit descriptors of 5395 * the transmit ring. The return value can be less than the value of the 5396 * *tx_pkts* parameter when the transmit ring is full or has been filled up. 5397 */ 5398 static inline uint16_t 5399 rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id, 5400 struct rte_mbuf **tx_pkts, uint16_t nb_pkts) 5401 { 5402 struct rte_eth_fp_ops *p; 5403 void *qd; 5404 5405 #ifdef RTE_ETHDEV_DEBUG_TX 5406 if (port_id >= RTE_MAX_ETHPORTS || 5407 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 5408 RTE_ETHDEV_LOG(ERR, 5409 "Invalid port_id=%u or queue_id=%u\n", 5410 port_id, queue_id); 5411 return 0; 5412 } 5413 #endif 5414 5415 /* fetch pointer to queue data */ 5416 p = &rte_eth_fp_ops[port_id]; 5417 qd = p->txq.data[queue_id]; 5418 5419 #ifdef RTE_ETHDEV_DEBUG_TX 5420 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0); 5421 5422 if (qd == NULL) { 5423 RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n", 5424 queue_id, port_id); 5425 return 0; 5426 } 5427 #endif 5428 5429 #ifdef RTE_ETHDEV_RXTX_CALLBACKS 5430 { 5431 void *cb; 5432 5433 /* __ATOMIC_RELEASE memory order was used when the 5434 * call back was inserted into the list. 5435 * Since there is a clear dependency between loading 5436 * cb and cb->fn/cb->next, __ATOMIC_ACQUIRE memory order is 5437 * not required. 5438 */ 5439 cb = __atomic_load_n((void **)&p->txq.clbk[queue_id], 5440 __ATOMIC_RELAXED); 5441 if (unlikely(cb != NULL)) 5442 nb_pkts = rte_eth_call_tx_callbacks(port_id, queue_id, 5443 tx_pkts, nb_pkts, cb); 5444 } 5445 #endif 5446 5447 nb_pkts = p->tx_pkt_burst(qd, tx_pkts, nb_pkts); 5448 5449 rte_ethdev_trace_tx_burst(port_id, queue_id, (void **)tx_pkts, nb_pkts); 5450 return nb_pkts; 5451 } 5452 5453 /** 5454 * Process a burst of output packets on a transmit queue of an Ethernet device. 5455 * 5456 * The rte_eth_tx_prepare() function is invoked to prepare output packets to be 5457 * transmitted on the output queue *queue_id* of the Ethernet device designated 5458 * by its *port_id*. 5459 * The *nb_pkts* parameter is the number of packets to be prepared which are 5460 * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them 5461 * allocated from a pool created with rte_pktmbuf_pool_create(). 5462 * For each packet to send, the rte_eth_tx_prepare() function performs 5463 * the following operations: 5464 * 5465 * - Check if packet meets devices requirements for Tx offloads. 5466 * 5467 * - Check limitations about number of segments. 5468 * 5469 * - Check additional requirements when debug is enabled. 5470 * 5471 * - Update and/or reset required checksums when Tx offload is set for packet. 5472 * 5473 * Since this function can modify packet data, provided mbufs must be safely 5474 * writable (e.g. modified data cannot be in shared segment). 5475 * 5476 * The rte_eth_tx_prepare() function returns the number of packets ready to be 5477 * sent. A return value equal to *nb_pkts* means that all packets are valid and 5478 * ready to be sent, otherwise stops processing on the first invalid packet and 5479 * leaves the rest packets untouched. 5480 * 5481 * When this functionality is not implemented in the driver, all packets are 5482 * are returned untouched. 5483 * 5484 * @param port_id 5485 * The port identifier of the Ethernet device. 5486 * The value must be a valid port ID. 5487 * @param queue_id 5488 * The index of the transmit queue through which output packets must be 5489 * sent. 5490 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 5491 * to rte_eth_dev_configure(). 5492 * @param tx_pkts 5493 * The address of an array of *nb_pkts* pointers to *rte_mbuf* structures 5494 * which contain the output packets. 5495 * @param nb_pkts 5496 * The maximum number of packets to process. 5497 * @return 5498 * The number of packets correct and ready to be sent. The return value can be 5499 * less than the value of the *tx_pkts* parameter when some packet doesn't 5500 * meet devices requirements with rte_errno set appropriately: 5501 * - EINVAL: offload flags are not correctly set 5502 * - ENOTSUP: the offload feature is not supported by the hardware 5503 * - ENODEV: if *port_id* is invalid (with debug enabled only) 5504 * 5505 */ 5506 5507 #ifndef RTE_ETHDEV_TX_PREPARE_NOOP 5508 5509 static inline uint16_t 5510 rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id, 5511 struct rte_mbuf **tx_pkts, uint16_t nb_pkts) 5512 { 5513 struct rte_eth_fp_ops *p; 5514 void *qd; 5515 5516 #ifdef RTE_ETHDEV_DEBUG_TX 5517 if (port_id >= RTE_MAX_ETHPORTS || 5518 queue_id >= RTE_MAX_QUEUES_PER_PORT) { 5519 RTE_ETHDEV_LOG(ERR, 5520 "Invalid port_id=%u or queue_id=%u\n", 5521 port_id, queue_id); 5522 rte_errno = ENODEV; 5523 return 0; 5524 } 5525 #endif 5526 5527 /* fetch pointer to queue data */ 5528 p = &rte_eth_fp_ops[port_id]; 5529 qd = p->txq.data[queue_id]; 5530 5531 #ifdef RTE_ETHDEV_DEBUG_TX 5532 if (!rte_eth_dev_is_valid_port(port_id)) { 5533 RTE_ETHDEV_LOG(ERR, "Invalid Tx port_id=%u\n", port_id); 5534 rte_errno = ENODEV; 5535 return 0; 5536 } 5537 if (qd == NULL) { 5538 RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n", 5539 queue_id, port_id); 5540 rte_errno = EINVAL; 5541 return 0; 5542 } 5543 #endif 5544 5545 if (!p->tx_pkt_prepare) 5546 return nb_pkts; 5547 5548 return p->tx_pkt_prepare(qd, tx_pkts, nb_pkts); 5549 } 5550 5551 #else 5552 5553 /* 5554 * Native NOOP operation for compilation targets which doesn't require any 5555 * preparations steps, and functional NOOP may introduce unnecessary performance 5556 * drop. 5557 * 5558 * Generally this is not a good idea to turn it on globally and didn't should 5559 * be used if behavior of tx_preparation can change. 5560 */ 5561 5562 static inline uint16_t 5563 rte_eth_tx_prepare(__rte_unused uint16_t port_id, 5564 __rte_unused uint16_t queue_id, 5565 __rte_unused struct rte_mbuf **tx_pkts, uint16_t nb_pkts) 5566 { 5567 return nb_pkts; 5568 } 5569 5570 #endif 5571 5572 /** 5573 * Send any packets queued up for transmission on a port and HW queue 5574 * 5575 * This causes an explicit flush of packets previously buffered via the 5576 * rte_eth_tx_buffer() function. It returns the number of packets successfully 5577 * sent to the NIC, and calls the error callback for any unsent packets. Unless 5578 * explicitly set up otherwise, the default callback simply frees the unsent 5579 * packets back to the owning mempool. 5580 * 5581 * @param port_id 5582 * The port identifier of the Ethernet device. 5583 * @param queue_id 5584 * The index of the transmit queue through which output packets must be 5585 * sent. 5586 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 5587 * to rte_eth_dev_configure(). 5588 * @param buffer 5589 * Buffer of packets to be transmit. 5590 * @return 5591 * The number of packets successfully sent to the Ethernet device. The error 5592 * callback is called for any packets which could not be sent. 5593 */ 5594 static inline uint16_t 5595 rte_eth_tx_buffer_flush(uint16_t port_id, uint16_t queue_id, 5596 struct rte_eth_dev_tx_buffer *buffer) 5597 { 5598 uint16_t sent; 5599 uint16_t to_send = buffer->length; 5600 5601 if (to_send == 0) 5602 return 0; 5603 5604 sent = rte_eth_tx_burst(port_id, queue_id, buffer->pkts, to_send); 5605 5606 buffer->length = 0; 5607 5608 /* All packets sent, or to be dealt with by callback below */ 5609 if (unlikely(sent != to_send)) 5610 buffer->error_callback(&buffer->pkts[sent], 5611 (uint16_t)(to_send - sent), 5612 buffer->error_userdata); 5613 5614 return sent; 5615 } 5616 5617 /** 5618 * Buffer a single packet for future transmission on a port and queue 5619 * 5620 * This function takes a single mbuf/packet and buffers it for later 5621 * transmission on the particular port and queue specified. Once the buffer is 5622 * full of packets, an attempt will be made to transmit all the buffered 5623 * packets. In case of error, where not all packets can be transmitted, a 5624 * callback is called with the unsent packets as a parameter. If no callback 5625 * is explicitly set up, the unsent packets are just freed back to the owning 5626 * mempool. The function returns the number of packets actually sent i.e. 5627 * 0 if no buffer flush occurred, otherwise the number of packets successfully 5628 * flushed 5629 * 5630 * @param port_id 5631 * The port identifier of the Ethernet device. 5632 * @param queue_id 5633 * The index of the transmit queue through which output packets must be 5634 * sent. 5635 * The value must be in the range [0, nb_tx_queue - 1] previously supplied 5636 * to rte_eth_dev_configure(). 5637 * @param buffer 5638 * Buffer used to collect packets to be sent. 5639 * @param tx_pkt 5640 * Pointer to the packet mbuf to be sent. 5641 * @return 5642 * 0 = packet has been buffered for later transmission 5643 * N > 0 = packet has been buffered, and the buffer was subsequently flushed, 5644 * causing N packets to be sent, and the error callback to be called for 5645 * the rest. 5646 */ 5647 static __rte_always_inline uint16_t 5648 rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id, 5649 struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt) 5650 { 5651 buffer->pkts[buffer->length++] = tx_pkt; 5652 if (buffer->length < buffer->size) 5653 return 0; 5654 5655 return rte_eth_tx_buffer_flush(port_id, queue_id, buffer); 5656 } 5657 5658 #ifdef __cplusplus 5659 } 5660 #endif 5661 5662 #endif /* _RTE_ETHDEV_H_ */ 5663