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