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