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