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