lib/librte_ethdev/rte_ethdev_driver.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_ETHDEV_DRIVER_H_
   6 #define _RTE_ETHDEV_DRIVER_H_
   7
   8 /**
   9  * @file
  10  *
  11  * RTE Ethernet Device PMD API
  12  *
  13  * These APIs for the use from Ethernet drivers, user applications shouldn't
  14  * use them.
  15  *
  16  */
  17
  18 #include <rte_ethdev.h>
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 /**< @internal Declaration of the hairpin peer queue information structure. */
  25 struct rte_hairpin_peer_info;
  26
  27 /*
  28  * Definitions of all functions exported by an Ethernet driver through the
  29  * generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
  30  * structure associated with an Ethernet device.
  31  */
  32
  33 typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
  34 /**< @internal Ethernet device configuration. */
  35
  36 typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
  37 /**< @internal Function used to start a configured Ethernet device. */
  38
  39 typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
  40 /**< @internal Function used to stop a configured Ethernet device. */
  41
  42 typedef int  (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
  43 /**< @internal Function used to link up a configured Ethernet device. */
  44
  45 typedef int  (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
  46 /**< @internal Function used to link down a configured Ethernet device. */
  47
  48 typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
  49 /**< @internal Function used to close a configured Ethernet device. */
  50
  51 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
  52 /** <@internal Function used to reset a configured Ethernet device. */
  53
  54 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
  55 /**< @internal Function used to detect an Ethernet device removal. */
  56
  57 /**
  58  * @internal
  59  * Function used to enable the Rx promiscuous mode of an Ethernet device.
  60  *
  61  * @param dev
  62  *   ethdev handle of port.
  63  *
  64  * @return
  65  *   Negative errno value on error, 0 on success.
  66  *
  67  * @retval 0
  68  *   Success, promiscuous mode is enabled.
  69  * @retval -ENOTSUP
  70  *   Promiscuous mode is not supported.
  71  * @retval -ENODEV
  72  *   Device is gone.
  73  * @retval -E_RTE_SECONDARY
  74  *   Function was called from a secondary process instance and not supported.
  75  * @retval -ETIMEDOUT
  76  *   Attempt to enable promiscuos mode failed because of timeout.
  77  * @retval -EAGAIN
  78  *   Failed to enable promiscuous mode.
  79  */
  80 typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
  81
  82 /**
  83  * @internal
  84  * Function used to disable the Rx promiscuous mode of an Ethernet device.
  85  *
  86  * @param dev
  87  *   ethdev handle of port.
  88  *
  89  * @return
  90  *   Negative errno value on error, 0 on success.
  91  *
  92  * @retval 0
  93  *   Success, promiscuous mode is disabled.
  94  * @retval -ENOTSUP
  95  *   Promiscuous mode disabling is not supported.
  96  * @retval -ENODEV
  97  *   Device is gone.
  98  * @retval -E_RTE_SECONDARY
  99  *   Function was called from a secondary process instance and not supported.
 100  * @retval -ETIMEDOUT
 101  *   Attempt to disable promiscuos mode failed because of timeout.
 102  * @retval -EAGAIN
 103  *   Failed to disable promiscuous mode.
 104  */
 105 typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
 106
 107 /**
 108  * @internal
 109  * Enable the receipt of all multicast packets by an Ethernet device.
 110  *
 111  * @param dev
 112  *   ethdev handle of port.
 113  *
 114  * @return
 115  *   Negative errno value on error, 0 on success.
 116  *
 117  * @retval 0
 118  *   Success, all-multicast mode is enabled.
 119  * @retval -ENOTSUP
 120  *   All-multicast mode is not supported.
 121  * @retval -ENODEV
 122  *   Device is gone.
 123  * @retval -E_RTE_SECONDARY
 124  *   Function was called from a secondary process instance and not supported.
 125  * @retval -ETIMEDOUT
 126  *   Attempt to enable all-multicast mode failed because of timeout.
 127  * @retval -EAGAIN
 128  *   Failed to enable all-multicast mode.
 129  */
 130 typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
 131
 132 /**
 133  * @internal
 134  * Disable the receipt of all multicast packets by an Ethernet device.
 135  *
 136  * @param dev
 137  *   ethdev handle of port.
 138  *
 139  * @return
 140  *   Negative errno value on error, 0 on success.
 141  *
 142  * @retval 0
 143  *   Success, all-multicast mode is disabled.
 144  * @retval -ENOTSUP
 145  *   All-multicast mode disabling is not supported.
 146  * @retval -ENODEV
 147  *   Device is gone.
 148  * @retval -E_RTE_SECONDARY
 149  *   Function was called from a secondary process instance and not supported.
 150  * @retval -ETIMEDOUT
 151  *   Attempt to disable all-multicast mode failed because of timeout.
 152  * @retval -EAGAIN
 153  *   Failed to disable all-multicast mode.
 154  */
 155 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
 156
 157 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
 158                                 int wait_to_complete);
 159 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
 160
 161 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
 162                                 struct rte_eth_stats *igb_stats);
 163 /**< @internal Get global I/O statistics of an Ethernet device. */
 164
 165 /**
 166  * @internal
 167  * Reset global I/O statistics of an Ethernet device to 0.
 168  *
 169  * @param dev
 170  *   ethdev handle of port.
 171  *
 172  * @return
 173  *   Negative errno value on error, 0 on success.
 174  *
 175  * @retval 0
 176  *   Success, statistics has been reset.
 177  * @retval -ENOTSUP
 178  *   Resetting statistics is not supported.
 179  * @retval -EINVAL
 180  *   Resetting statistics is not valid.
 181  * @retval -ENOMEM
 182  *   Not enough memory to get the stats.
 183  */
 184 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
 185
 186 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
 187         struct rte_eth_xstat *stats, unsigned int n);
 188 /**< @internal Get extended stats of an Ethernet device. */
 189
 190 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
 191                                       const uint64_t *ids,
 192                                       uint64_t *values,
 193                                       unsigned int n);
 194 /**< @internal Get extended stats of an Ethernet device. */
 195
 196 /**
 197  * @internal
 198  * Reset extended stats of an Ethernet device.
 199  *
 200  * @param dev
 201  *   ethdev handle of port.
 202  *
 203  * @return
 204  *   Negative errno value on error, 0 on success.
 205  *
 206  * @retval 0
 207  *   Success, statistics has been reset.
 208  * @retval -ENOTSUP
 209  *   Resetting statistics is not supported.
 210  * @retval -EINVAL
 211  *   Resetting statistics is not valid.
 212  * @retval -ENOMEM
 213  *   Not enough memory to get the stats.
 214  */
 215 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
 216
 217 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
 218         struct rte_eth_xstat_name *xstats_names, unsigned int size);
 219 /**< @internal Get names of extended stats of an Ethernet device. */
 220
 221 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
 222         struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
 223         unsigned int size);
 224 /**< @internal Get names of extended stats of an Ethernet device. */
 225
 226 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
 227                                              uint16_t queue_id,
 228                                              uint8_t stat_idx,
 229                                              uint8_t is_rx);
 230 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
 231
 232 typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
 233                                    struct rte_eth_dev_info *dev_info);
 234 /**< @internal Get specific information of an Ethernet device. */
 235
 236 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
 237 /**< @internal Get supported ptypes of an Ethernet device. */
 238
 239 /**
 240  * @internal
 241  * Inform Ethernet device about reduced range of packet types to handle.
 242  *
 243  * @param dev
 244  *   The Ethernet device identifier.
 245  * @param ptype_mask
 246  *   The ptype family that application is interested in should be bitwise OR of
 247  *   RTE_PTYPE_*_MASK or 0.
 248  * @return
 249  *   - (0) if Success.
 250  */
 251 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
 252                                      uint32_t ptype_mask);
 253
 254 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
 255                                     uint16_t queue_id);
 256 /**< @internal Start rx and tx of a queue of an Ethernet device. */
 257
 258 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
 259                                     uint16_t queue_id);
 260 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
 261
 262 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
 263                                     uint16_t rx_queue_id,
 264                                     uint16_t nb_rx_desc,
 265                                     unsigned int socket_id,
 266                                     const struct rte_eth_rxconf *rx_conf,
 267                                     struct rte_mempool *mb_pool);
 268 /**< @internal Set up a receive queue of an Ethernet device. */
 269
 270 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
 271                                     uint16_t tx_queue_id,
 272                                     uint16_t nb_tx_desc,
 273                                     unsigned int socket_id,
 274                                     const struct rte_eth_txconf *tx_conf);
 275 /**< @internal Setup a transmit queue of an Ethernet device. */
 276
 277 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
 278                                     uint16_t rx_queue_id);
 279 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
 280
 281 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
 282                                     uint16_t rx_queue_id);
 283 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
 284
 285 typedef void (*eth_queue_release_t)(void *queue);
 286 /**< @internal Release memory resources allocated by given RX/TX queue. */
 287
 288 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
 289                                      char *fw_version, size_t fw_size);
 290 /**< @internal Get firmware information of an Ethernet device. */
 291
 292 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
 293 /**< @internal Force mbufs to be from TX ring. */
 294
 295 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
 296         uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
 297
 298 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
 299         uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
 300
 301 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
 302         uint16_t queue_id, struct rte_eth_burst_mode *mode);
 303
 304 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
 305 /**< @internal Set MTU. */
 306
 307 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
 308                                   uint16_t vlan_id,
 309                                   int on);
 310 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
 311
 312 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
 313                                enum rte_vlan_type type, uint16_t tpid);
 314 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
 315
 316 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
 317 /**< @internal set VLAN offload function by an Ethernet device. */
 318
 319 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
 320                                uint16_t vlan_id,
 321                                int on);
 322 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
 323
 324 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
 325                                   uint16_t rx_queue_id,
 326                                   int on);
 327 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
 328
 329 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
 330                                struct rte_eth_fc_conf *fc_conf);
 331 /**< @internal Get current flow control parameter on an Ethernet device */
 332
 333 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
 334                                struct rte_eth_fc_conf *fc_conf);
 335 /**< @internal Setup flow control parameter on an Ethernet device */
 336
 337 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
 338                                 struct rte_eth_pfc_conf *pfc_conf);
 339 /**< @internal Setup priority flow control parameter on an Ethernet device */
 340
 341 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
 342                              struct rte_eth_rss_reta_entry64 *reta_conf,
 343                              uint16_t reta_size);
 344 /**< @internal Update RSS redirection table on an Ethernet device */
 345
 346 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
 347                             struct rte_eth_rss_reta_entry64 *reta_conf,
 348                             uint16_t reta_size);
 349 /**< @internal Query RSS redirection table on an Ethernet device */
 350
 351 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
 352                                  struct rte_eth_rss_conf *rss_conf);
 353 /**< @internal Update RSS hash configuration of an Ethernet device */
 354
 355 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
 356                                    struct rte_eth_rss_conf *rss_conf);
 357 /**< @internal Get current RSS hash configuration of an Ethernet device */
 358
 359 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
 360 /**< @internal Turn on SW controllable LED on an Ethernet device */
 361
 362 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
 363 /**< @internal Turn off SW controllable LED on an Ethernet device */
 364
 365 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
 366 /**< @internal Remove MAC address from receive address register */
 367
 368 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
 369                                   struct rte_ether_addr *mac_addr,
 370                                   uint32_t index,
 371                                   uint32_t vmdq);
 372 /**< @internal Set a MAC address into Receive Address Register */
 373
 374 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
 375                                   struct rte_ether_addr *mac_addr);
 376 /**< @internal Set a MAC address into Receive Address Register */
 377
 378 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
 379                                   struct rte_ether_addr *mac_addr,
 380                                   uint8_t on);
 381 /**< @internal Set a Unicast Hash bitmap */
 382
 383 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
 384                                   uint8_t on);
 385 /**< @internal Set all Unicast Hash bitmap */
 386
 387 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
 388                                 uint16_t queue_idx,
 389                                 uint16_t tx_rate);
 390 /**< @internal Set queue TX rate */
 391
 392 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
 393                                   struct rte_eth_mirror_conf *mirror_conf,
 394                                   uint8_t rule_id,
 395                                   uint8_t on);
 396 /**< @internal Add a traffic mirroring rule on an Ethernet device */
 397
 398 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
 399                                   uint8_t rule_id);
 400 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
 401
 402 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
 403                                          struct rte_eth_udp_tunnel *tunnel_udp);
 404 /**< @internal Add tunneling UDP port */
 405
 406 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
 407                                          struct rte_eth_udp_tunnel *tunnel_udp);
 408 /**< @internal Delete tunneling UDP port */
 409
 410 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
 411                                       struct rte_ether_addr *mc_addr_set,
 412                                       uint32_t nb_mc_addr);
 413 /**< @internal set the list of multicast addresses on an Ethernet device */
 414
 415 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
 416 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
 417
 418 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
 419 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
 420
 421 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
 422                                                 struct timespec *timestamp,
 423                                                 uint32_t flags);
 424 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
 425
 426 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
 427                                                 struct timespec *timestamp);
 428 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
 429
 430 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
 431 /**< @internal Function used to adjust the device clock */
 432
 433 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
 434                                       struct timespec *timestamp);
 435 /**< @internal Function used to get time from the device clock. */
 436
 437 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
 438                                        const struct timespec *timestamp);
 439 /**< @internal Function used to get time from the device clock */
 440
 441 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
 442                                       uint64_t *timestamp);
 443 /**< @internal Function used to get the current value of the device clock. */
 444
 445 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
 446                                 struct rte_dev_reg_info *info);
 447 /**< @internal Retrieve registers  */
 448
 449 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
 450 /**< @internal Retrieve eeprom size  */
 451
 452 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
 453                                 struct rte_dev_eeprom_info *info);
 454 /**< @internal Retrieve eeprom data  */
 455
 456 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
 457                                 struct rte_dev_eeprom_info *info);
 458 /**< @internal Program eeprom data  */
 459
 460 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
 461                                      struct rte_eth_dev_module_info *modinfo);
 462 /**< @internal Retrieve type and size of plugin module eeprom */
 463
 464 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
 465                                        struct rte_dev_eeprom_info *info);
 466 /**< @internal Retrieve plugin module eeprom data */
 467
 468 typedef int (*eth_l2_tunnel_offload_set_t)
 469         (struct rte_eth_dev *dev,
 470          struct rte_eth_l2_tunnel_conf *l2_tunnel,
 471          uint32_t mask,
 472          uint8_t en);
 473 /**< @internal enable/disable the l2 tunnel offload functions */
 474
 475 /**
 476  * Feature filter types
 477  */
 478 enum rte_filter_type {
 479         RTE_ETH_FILTER_NONE = 0,
 480         RTE_ETH_FILTER_ETHERTYPE,
 481         RTE_ETH_FILTER_FLEXIBLE,
 482         RTE_ETH_FILTER_SYN,
 483         RTE_ETH_FILTER_NTUPLE,
 484         RTE_ETH_FILTER_TUNNEL,
 485         RTE_ETH_FILTER_FDIR,
 486         RTE_ETH_FILTER_HASH,
 487         RTE_ETH_FILTER_L2_TUNNEL,
 488         RTE_ETH_FILTER_GENERIC,
 489 };
 490
 491 /**
 492  * Generic operations on filters
 493  */
 494 enum rte_filter_op {
 495         RTE_ETH_FILTER_GET,      /**< get flow API ops */
 496 };
 497
 498 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
 499                                  enum rte_filter_type filter_type,
 500                                  enum rte_filter_op filter_op,
 501                                  void *arg);
 502 /**< @internal Take operations to assigned filter type on an Ethernet device */
 503
 504 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 505 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
 506
 507 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 508 /**< @internal Get Traffic Metering and Policing (MTR) operations */
 509
 510 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
 511                                  struct rte_eth_dcb_info *dcb_info);
 512 /**< @internal Get dcb information on an Ethernet device */
 513
 514 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
 515                                                 const char *pool);
 516 /**< @internal Test if a port supports specific mempool ops */
 517
 518 /**
 519  * @internal
 520  * Get the hairpin capabilities.
 521  *
 522  * @param dev
 523  *   ethdev handle of port.
 524  * @param cap
 525  *   returns the hairpin capabilities from the device.
 526  *
 527  * @return
 528  *   Negative errno value on error, 0 on success.
 529  *
 530  * @retval 0
 531  *   Success, hairpin is supported.
 532  * @retval -ENOTSUP
 533  *   Hairpin is not supported.
 534  */
 535 typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
 536                                      struct rte_eth_hairpin_cap *cap);
 537
 538 /**
 539  * @internal
 540  * Setup RX hairpin queue.
 541  *
 542  * @param dev
 543  *   ethdev handle of port.
 544  * @param rx_queue_id
 545  *   the selected RX queue index.
 546  * @param nb_rx_desc
 547  *   the requested number of descriptors for this queue. 0 - use PMD default.
 548  * @param conf
 549  *   the RX hairpin configuration structure.
 550  *
 551  * @return
 552  *   Negative errno value on error, 0 on success.
 553  *
 554  * @retval 0
 555  *   Success, hairpin is supported.
 556  * @retval -ENOTSUP
 557  *   Hairpin is not supported.
 558  * @retval -EINVAL
 559  *   One of the parameters is invalid.
 560  * @retval -ENOMEM
 561  *   Unable to allocate resources.
 562  */
 563 typedef int (*eth_rx_hairpin_queue_setup_t)
 564         (struct rte_eth_dev *dev, uint16_t rx_queue_id,
 565          uint16_t nb_rx_desc,
 566          const struct rte_eth_hairpin_conf *conf);
 567
 568 /**
 569  * @internal
 570  * Setup TX hairpin queue.
 571  *
 572  * @param dev
 573  *   ethdev handle of port.
 574  * @param tx_queue_id
 575  *   the selected TX queue index.
 576  * @param nb_tx_desc
 577  *   the requested number of descriptors for this queue. 0 - use PMD default.
 578  * @param conf
 579  *   the TX hairpin configuration structure.
 580  *
 581  * @return
 582  *   Negative errno value on error, 0 on success.
 583  *
 584  * @retval 0
 585  *   Success, hairpin is supported.
 586  * @retval -ENOTSUP
 587  *   Hairpin is not supported.
 588  * @retval -EINVAL
 589  *   One of the parameters is invalid.
 590  * @retval -ENOMEM
 591  *   Unable to allocate resources.
 592  */
 593 typedef int (*eth_tx_hairpin_queue_setup_t)
 594         (struct rte_eth_dev *dev, uint16_t tx_queue_id,
 595          uint16_t nb_tx_desc,
 596          const struct rte_eth_hairpin_conf *hairpin_conf);
 597
 598 /**
 599  * @internal
 600  * Get Forward Error Correction(FEC) capability.
 601  *
 602  * @param dev
 603  *   ethdev handle of port.
 604  * @param speed_fec_capa
 605  *   speed_fec_capa is out only with per-speed capabilities.
 606  * @param num
 607  *   a number of elements in an speed_fec_capa array.
 608  *
 609  * @return
 610  *   Negative errno value on error, positive value on success.
 611  *
 612  * @retval positive value
 613  *   A non-negative value lower or equal to num: success. The return value
 614  *   is the number of entries filled in the fec capa array.
 615  *   A non-negative value higher than num: error, the given fec capa array
 616  *   is too small. The return value corresponds to the num that should
 617  *   be given to succeed. The entries in the fec capa array are not valid
 618  *   and shall not be used by the caller.
 619  * @retval -ENOTSUP
 620  *   Operation is not supported.
 621  * @retval -EIO
 622  *   Device is removed.
 623  * @retval -EINVAL
 624  *   *num* or *speed_fec_capa* invalid.
 625  */
 626 typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
 627                 struct rte_eth_fec_capa *speed_fec_capa, unsigned int num);
 628
 629 /**
 630  * @internal
 631  * Get Forward Error Correction(FEC) mode.
 632  *
 633  * @param dev
 634  *   ethdev handle of port.
 635  * @param fec_capa
 636  *   a bitmask of enabled FEC modes. If AUTO bit is set, other
 637  *   bits specify FEC modes which may be negotiated. If AUTO
 638  *   bit is clear, specify FEC modes to be used (only one valid
 639  *   mode per speed may be set).
 640  *
 641  * @return
 642  *   Negative errno value on error, 0 on success.
 643  *
 644  * @retval 0
 645  *   Success, get FEC success.
 646  * @retval -ENOTSUP
 647  *   Operation is not supported.
 648  * @retval -EIO
 649  *   Device is removed.
 650  */
 651 typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev,
 652                              uint32_t *fec_capa);
 653
 654 /**
 655  * @internal
 656  * Set Forward Error Correction(FEC) mode.
 657  *
 658  * @param dev
 659  *   ethdev handle of port.
 660  * @param fec_capa
 661  *   bitmask of allowed FEC modes. It must be only one
 662  *   if AUTO is disabled. If AUTO is enabled, other
 663  *   bits specify FEC modes which may be negotiated.
 664  *
 665  * @return
 666  *   Negative errno value on error, 0 on success.
 667  *
 668  * @retval 0
 669  *   Success, set FEC success.
 670  * @retval -ENOTSUP
 671  *   Operation is not supported.
 672  * @retval -EINVAL
 673  *   Unsupported FEC mode requested.
 674  * @retval -EIO
 675  *   Device is removed.
 676  */
 677 typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, uint32_t fec_capa);
 678
 679 /**
 680  * @internal
 681  * Get all hairpin Tx/Rx peer ports of the current device, if any.
 682  *
 683  * @param dev
 684  *   ethdev handle of port.
 685  * @param peer_ports
 686  *   array to save the ports list.
 687  * @param len
 688  *   array length.
 689  * @param direction
 690  *   value to decide the current to peer direction
 691  *   positive - used as Tx to get all peer Rx ports.
 692  *   zero - used as Rx to get all peer Tx ports.
 693  *
 694  * @return
 695  *   Negative errno value on error, 0 or positive on success.
 696  *
 697  * @retval 0
 698  *   Success, no peer ports.
 699  * @retval >0
 700  *   Actual number of the peer ports.
 701  * @retval -ENOTSUP
 702  *   Get peer ports API is not supported.
 703  * @retval -EINVAL
 704  *   One of the parameters is invalid.
 705  */
 706 typedef int (*hairpin_get_peer_ports_t)(struct rte_eth_dev *dev,
 707                                         uint16_t *peer_ports, size_t len,
 708                                         uint32_t direction);
 709
 710 /**
 711  * @internal
 712  * Bind all hairpin Tx queues of one port to the Rx queues of the peer port.
 713  *
 714  * @param dev
 715  *   ethdev handle of port.
 716  * @param rx_port
 717  *   the peer Rx port.
 718  *
 719  * @return
 720  *   Negative errno value on error, 0 on success.
 721  *
 722  * @retval 0
 723  *   Success, bind successfully.
 724  * @retval -ENOTSUP
 725  *   Bind API is not supported.
 726  * @retval -EINVAL
 727  *   One of the parameters is invalid.
 728  * @retval -EBUSY
 729  *   Device is not started.
 730  */
 731 typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
 732                                 uint16_t rx_port);
 733
 734 /**
 735  * @internal
 736  * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port.
 737  *
 738  * @param dev
 739  *   ethdev handle of port.
 740  * @param rx_port
 741  *   the peer Rx port.
 742  *
 743  * @return
 744  *   Negative errno value on error, 0 on success.
 745  *
 746  * @retval 0
 747  *   Success, unbind successfully.
 748  * @retval -ENOTSUP
 749  *   Bind API is not supported.
 750  * @retval -EINVAL
 751  *   One of the parameters is invalid.
 752  * @retval -EBUSY
 753  *   Device is already stopped.
 754  */
 755 typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
 756                                   uint16_t rx_port);
 757
 758 typedef int (*eth_hairpin_queue_peer_update_t)
 759         (struct rte_eth_dev *dev, uint16_t peer_queue,
 760          struct rte_hairpin_peer_info *current_info,
 761          struct rte_hairpin_peer_info *peer_info, uint32_t direction);
 762 /**< @internal Update and fetch peer queue information. */
 763
 764 typedef int (*eth_hairpin_queue_peer_bind_t)
 765         (struct rte_eth_dev *dev, uint16_t cur_queue,
 766          struct rte_hairpin_peer_info *peer_info, uint32_t direction);
 767 /**< @internal Bind peer queue to the current queue with fetched information. */
 768
 769 typedef int (*eth_hairpin_queue_peer_unbind_t)
 770         (struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
 771 /**< @internal Unbind peer queue from the current queue. */
 772
 773 /**
 774  * @internal A structure containing the functions exported by an Ethernet driver.
 775  */
 776 struct eth_dev_ops {
 777         eth_dev_configure_t        dev_configure; /**< Configure device. */
 778         eth_dev_start_t            dev_start;     /**< Start device. */
 779         eth_dev_stop_t             dev_stop;      /**< Stop device. */
 780         eth_dev_set_link_up_t      dev_set_link_up;   /**< Device link up. */
 781         eth_dev_set_link_down_t    dev_set_link_down; /**< Device link down. */
 782         eth_dev_close_t            dev_close;     /**< Close device. */
 783         eth_dev_reset_t            dev_reset;     /**< Reset device. */
 784         eth_link_update_t          link_update;   /**< Get device link state. */
 785         eth_is_removed_t           is_removed;
 786         /**< Check if the device was physically removed. */
 787
 788         eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
 789         eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
 790         eth_allmulticast_enable_t  allmulticast_enable;/**< RX multicast ON. */
 791         eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
 792         eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address. */
 793         eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address. */
 794         eth_mac_addr_set_t         mac_addr_set;  /**< Set a MAC address. */
 795         eth_set_mc_addr_list_t     set_mc_addr_list; /**< set list of mcast addrs. */
 796         mtu_set_t                  mtu_set;       /**< Set MTU. */
 797
 798         eth_stats_get_t            stats_get;     /**< Get generic device statistics. */
 799         eth_stats_reset_t          stats_reset;   /**< Reset generic device statistics. */
 800         eth_xstats_get_t           xstats_get;    /**< Get extended device statistics. */
 801         eth_xstats_reset_t         xstats_reset;  /**< Reset extended device statistics. */
 802         eth_xstats_get_names_t     xstats_get_names;
 803         /**< Get names of extended statistics. */
 804         eth_queue_stats_mapping_set_t queue_stats_mapping_set;
 805         /**< Configure per queue stat counter mapping. */
 806
 807         eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
 808         eth_rxq_info_get_t         rxq_info_get; /**< retrieve RX queue information. */
 809         eth_txq_info_get_t         txq_info_get; /**< retrieve TX queue information. */
 810         eth_burst_mode_get_t       rx_burst_mode_get; /**< Get RX burst mode */
 811         eth_burst_mode_get_t       tx_burst_mode_get; /**< Get TX burst mode */
 812         eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
 813         eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
 814         /**< Get packet types supported and identified by device. */
 815         eth_dev_ptypes_set_t dev_ptypes_set;
 816         /**< Inform Ethernet device about reduced range of packet types to handle. */
 817
 818         vlan_filter_set_t          vlan_filter_set; /**< Filter VLAN Setup. */
 819         vlan_tpid_set_t            vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
 820         vlan_strip_queue_set_t     vlan_strip_queue_set; /**< VLAN Stripping on queue. */
 821         vlan_offload_set_t         vlan_offload_set; /**< Set VLAN Offload. */
 822         vlan_pvid_set_t            vlan_pvid_set; /**< Set port based TX VLAN insertion. */
 823
 824         eth_queue_start_t          rx_queue_start;/**< Start RX for a queue. */
 825         eth_queue_stop_t           rx_queue_stop; /**< Stop RX for a queue. */
 826         eth_queue_start_t          tx_queue_start;/**< Start TX for a queue. */
 827         eth_queue_stop_t           tx_queue_stop; /**< Stop TX for a queue. */
 828         eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue. */
 829         eth_queue_release_t        rx_queue_release; /**< Release RX queue. */
 830
 831         eth_rx_enable_intr_t       rx_queue_intr_enable;  /**< Enable Rx queue interrupt. */
 832         eth_rx_disable_intr_t      rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
 833         eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue. */
 834         eth_queue_release_t        tx_queue_release; /**< Release TX queue. */
 835         eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free tx ring mbufs */
 836
 837         eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
 838         eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
 839
 840         flow_ctrl_get_t            flow_ctrl_get; /**< Get flow control. */
 841         flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control. */
 842         priority_flow_ctrl_set_t   priority_flow_ctrl_set; /**< Setup priority flow control. */
 843
 844         eth_uc_hash_table_set_t    uc_hash_table_set; /**< Set Unicast Table Array. */
 845         eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
 846
 847         eth_mirror_rule_set_t      mirror_rule_set; /**< Add a traffic mirror rule. */
 848         eth_mirror_rule_reset_t    mirror_rule_reset; /**< reset a traffic mirror rule. */
 849
 850         eth_udp_tunnel_port_add_t  udp_tunnel_port_add; /** Add UDP tunnel port. */
 851         eth_udp_tunnel_port_del_t  udp_tunnel_port_del; /** Del UDP tunnel port. */
 852         eth_l2_tunnel_offload_set_t   l2_tunnel_offload_set;
 853         /** Enable/disable l2 tunnel offload functions. */
 854
 855         eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
 856
 857         rss_hash_update_t          rss_hash_update; /** Configure RSS hash protocols. */
 858         rss_hash_conf_get_t        rss_hash_conf_get; /** Get current RSS hash configuration. */
 859         reta_update_t              reta_update;   /** Update redirection table. */
 860         reta_query_t               reta_query;    /** Query redirection table. */
 861
 862         eth_get_reg_t              get_reg;           /**< Get registers. */
 863         eth_get_eeprom_length_t    get_eeprom_length; /**< Get eeprom length. */
 864         eth_get_eeprom_t           get_eeprom;        /**< Get eeprom data. */
 865         eth_set_eeprom_t           set_eeprom;        /**< Set eeprom. */
 866
 867         eth_get_module_info_t      get_module_info;
 868         /** Get plugin module eeprom attribute. */
 869         eth_get_module_eeprom_t    get_module_eeprom;
 870         /** Get plugin module eeprom data. */
 871
 872         eth_filter_ctrl_t          filter_ctrl; /**< common filter control. */
 873
 874         eth_get_dcb_info           get_dcb_info; /** Get DCB information. */
 875
 876         eth_timesync_enable_t      timesync_enable;
 877         /** Turn IEEE1588/802.1AS timestamping on. */
 878         eth_timesync_disable_t     timesync_disable;
 879         /** Turn IEEE1588/802.1AS timestamping off. */
 880         eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
 881         /** Read the IEEE1588/802.1AS RX timestamp. */
 882         eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
 883         /** Read the IEEE1588/802.1AS TX timestamp. */
 884         eth_timesync_adjust_time   timesync_adjust_time; /** Adjust the device clock. */
 885         eth_timesync_read_time     timesync_read_time; /** Get the device clock time. */
 886         eth_timesync_write_time    timesync_write_time; /** Set the device clock time. */
 887
 888         eth_read_clock             read_clock;
 889
 890         eth_xstats_get_by_id_t     xstats_get_by_id;
 891         /**< Get extended device statistic values by ID. */
 892         eth_xstats_get_names_by_id_t xstats_get_names_by_id;
 893         /**< Get name of extended device statistics by ID. */
 894
 895         eth_tm_ops_get_t tm_ops_get;
 896         /**< Get Traffic Management (TM) operations. */
 897
 898         eth_mtr_ops_get_t mtr_ops_get;
 899         /**< Get Traffic Metering and Policing (MTR) operations. */
 900
 901         eth_pool_ops_supported_t pool_ops_supported;
 902         /**< Test if a port supports specific mempool ops */
 903
 904         eth_hairpin_cap_get_t hairpin_cap_get;
 905         /**< Returns the hairpin capabilities. */
 906         eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
 907         /**< Set up device RX hairpin queue. */
 908         eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
 909         /**< Set up device TX hairpin queue. */
 910
 911         eth_fec_get_capability_t fec_get_capability;
 912         /**< Get Forward Error Correction(FEC) capability. */
 913         eth_fec_get_t fec_get;
 914         /**< Get Forward Error Correction(FEC) mode. */
 915         eth_fec_set_t fec_set;
 916         /**< Set Forward Error Correction(FEC) mode. */
 917         hairpin_get_peer_ports_t hairpin_get_peer_ports;
 918         /**< Get hairpin peer ports list. */
 919         eth_hairpin_bind_t hairpin_bind;
 920         /**< Bind all hairpin Tx queues of device to the peer port Rx queues. */
 921         eth_hairpin_unbind_t hairpin_unbind;
 922         /**< Unbind all hairpin Tx queues from the peer port Rx queues. */
 923         eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
 924         /**< Pass the current queue info and get the peer queue info. */
 925         eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
 926         /**< Set up the connection between the pair of hairpin queues. */
 927         eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
 928         /**< Disconnect the hairpin queues of a pair from each other. */
 929 };
 930
 931 /**
 932  * RX/TX queue states
 933  */
 934 #define RTE_ETH_QUEUE_STATE_STOPPED 0
 935 #define RTE_ETH_QUEUE_STATE_STARTED 1
 936 #define RTE_ETH_QUEUE_STATE_HAIRPIN 2
 937
 938 /**
 939  * @internal
 940  * Check if the selected Rx queue is hairpin queue.
 941  *
 942  * @param dev
 943  *  Pointer to the selected device.
 944  * @param queue_id
 945  *  The selected queue.
 946  *
 947  * @return
 948  *   - (1) if the queue is hairpin queue, 0 otherwise.
 949  */
 950 __rte_internal
 951 int rte_eth_dev_is_rx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
 952
 953 /**
 954  * @internal
 955  * Check if the selected Tx queue is hairpin queue.
 956  *
 957  * @param dev
 958  *  Pointer to the selected device.
 959  * @param queue_id
 960  *  The selected queue.
 961  *
 962  * @return
 963  *   - (1) if the queue is hairpin queue, 0 otherwise.
 964  */
 965 __rte_internal
 966 int rte_eth_dev_is_tx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
 967
 968 /**
 969  * @internal
 970  * Returns a ethdev slot specified by the unique identifier name.
 971  *
 972  * @param       name
 973  *  The pointer to the Unique identifier name for each Ethernet device
 974  * @return
 975  *   - The pointer to the ethdev slot, on success. NULL on error
 976  */
 977 __rte_internal
 978 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
 979
 980 /**
 981  * @internal
 982  * Allocates a new ethdev slot for an ethernet device and returns the pointer
 983  * to that slot for the driver to use.
 984  *
 985  * @param       name    Unique identifier name for each Ethernet device
 986  * @return
 987  *   - Slot in the rte_dev_devices array for a new device;
 988  */
 989 __rte_internal
 990 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
 991
 992 /**
 993  * @internal
 994  * Attach to the ethdev already initialized by the primary
 995  * process.
 996  *
 997  * @param       name    Ethernet device's name.
 998  * @return
 999  *   - Success: Slot in the rte_dev_devices array for attached
1000  *        device.
1001  *   - Error: Null pointer.
1002  */
1003 __rte_internal
1004 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1005
1006 /**
1007  * @internal
1008  * Notify RTE_ETH_EVENT_DESTROY and release the specified ethdev port.
1009  *
1010  * The following PMD-managed data fields will be freed:
1011  *   - dev_private
1012  *   - mac_addrs
1013  *   - hash_mac_addrs
1014  * If one of these fields should not be freed,
1015  * it must be reset to NULL by the PMD, typically in dev_close method.
1016  *
1017  * @param eth_dev
1018  * Device to be detached.
1019  * @return
1020  *   - 0 on success, negative on error
1021  */
1022 __rte_internal
1023 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1024
1025 /**
1026  * @internal
1027  * Release device queues and clear its configuration to force the user
1028  * application to reconfigure it. It is for internal use only.
1029  *
1030  * @param dev
1031  *  Pointer to struct rte_eth_dev.
1032  *
1033  * @return
1034  *  void
1035  */
1036 __rte_internal
1037 void rte_eth_dev_internal_reset(struct rte_eth_dev *dev);
1038
1039 /**
1040  * @internal Executes all the user application registered callbacks for
1041  * the specific device. It is for DPDK internal user only. User
1042  * application should not call it directly.
1043  *
1044  * @param dev
1045  *  Pointer to struct rte_eth_dev.
1046  * @param event
1047  *  Eth device interrupt event type.
1048  * @param ret_param
1049  *  To pass data back to user application.
1050  *  This allows the user application to decide if a particular function
1051  *  is permitted or not.
1052  *
1053  * @return
1054  *  int
1055  */
1056 __rte_internal
1057 int rte_eth_dev_callback_process(struct rte_eth_dev *dev,
1058                 enum rte_eth_event_type event, void *ret_param);
1059
1060 /**
1061  * @internal
1062  * This is the last step of device probing.
1063  * It must be called after a port is allocated and initialized successfully.
1064  *
1065  * The notification RTE_ETH_EVENT_NEW is sent to other entities
1066  * (libraries and applications).
1067  * The state is set as RTE_ETH_DEV_ATTACHED.
1068  *
1069  * @param dev
1070  *  New ethdev port.
1071  */
1072 __rte_internal
1073 void rte_eth_dev_probing_finish(struct rte_eth_dev *dev);
1074
1075 /**
1076  * Create memzone for HW rings.
1077  * malloc can't be used as the physical address is needed.
1078  * If the memzone is already created, then this function returns a ptr
1079  * to the old one.
1080  *
1081  * @param eth_dev
1082  *   The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1083  * @param name
1084  *   The name of the memory zone
1085  * @param queue_id
1086  *   The index of the queue to add to name
1087  * @param size
1088  *   The sizeof of the memory area
1089  * @param align
1090  *   Alignment for resulting memzone. Must be a power of 2.
1091  * @param socket_id
1092  *   The *socket_id* argument is the socket identifier in case of NUMA.
1093  */
1094 __rte_internal
1095 const struct rte_memzone *
1096 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
1097                          uint16_t queue_id, size_t size,
1098                          unsigned align, int socket_id);
1099
1100 /**
1101  * Free previously allocated memzone for HW rings.
1102  *
1103  * @param eth_dev
1104  *   The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1105  * @param name
1106  *   The name of the memory zone
1107  * @param queue_id
1108  *   The index of the queue to add to name
1109  * @return
1110  *   Negative errno value on error, 0 on success.
1111  */
1112 __rte_internal
1113 int
1114 rte_eth_dma_zone_free(const struct rte_eth_dev *eth_dev, const char *name,
1115                  uint16_t queue_id);
1116
1117 /**
1118  * @internal
1119  * Atomically set the link status for the specific device.
1120  * It is for use by DPDK device driver use only.
1121  * User applications should not call it
1122  *
1123  * @param dev
1124  *  Pointer to struct rte_eth_dev.
1125  * @param link
1126  *  New link status value.
1127  * @return
1128  *  Same convention as eth_link_update operation.
1129  *  0   if link up status has changed
1130  *  -1  if link up status was unchanged
1131  */
1132 static inline int
1133 rte_eth_linkstatus_set(struct rte_eth_dev *dev,
1134                        const struct rte_eth_link *new_link)
1135 {
1136         uint64_t *dev_link = (uint64_t *)&(dev->data->dev_link);
1137         union {
1138                 uint64_t val64;
1139                 struct rte_eth_link link;
1140         } orig;
1141
1142         RTE_BUILD_BUG_ON(sizeof(*new_link) != sizeof(uint64_t));
1143
1144         orig.val64 = __atomic_exchange_n(dev_link, *(const uint64_t *)new_link,
1145                                         __ATOMIC_SEQ_CST);
1146
1147         return (orig.link.link_status == new_link->link_status) ? -1 : 0;
1148 }
1149
1150 /**
1151  * @internal
1152  * Atomically get the link speed and status.
1153  *
1154  * @param dev
1155  *  Pointer to struct rte_eth_dev.
1156  * @param link
1157  *  link status value.
1158  */
1159 static inline void
1160 rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
1161                        struct rte_eth_link *link)
1162 {
1163         uint64_t *src = (uint64_t *)&(dev->data->dev_link);
1164         uint64_t *dst = (uint64_t *)link;
1165
1166         RTE_BUILD_BUG_ON(sizeof(*link) != sizeof(uint64_t));
1167
1168         *dst = __atomic_load_n(src, __ATOMIC_SEQ_CST);
1169 }
1170
1171 /**
1172  * Allocate an unique switch domain identifier.
1173  *
1174  * A pool of switch domain identifiers which can be allocated on request. This
1175  * will enabled devices which support the concept of switch domains to request
1176  * a switch domain id which is guaranteed to be unique from other devices
1177  * running in the same process.
1178  *
1179  * @param domain_id
1180  *  switch domain identifier parameter to pass back to application
1181  *
1182  * @return
1183  *   Negative errno value on error, 0 on success.
1184  */
1185 __rte_internal
1186 int
1187 rte_eth_switch_domain_alloc(uint16_t *domain_id);
1188
1189 /**
1190  * Free switch domain.
1191  *
1192  * Return a switch domain identifier to the pool of free identifiers after it is
1193  * no longer in use by device.
1194  *
1195  * @param domain_id
1196  *  switch domain identifier to free
1197  *
1198  * @return
1199  *   Negative errno value on error, 0 on success.
1200  */
1201 __rte_internal
1202 int
1203 rte_eth_switch_domain_free(uint16_t domain_id);
1204
1205 /** Generic Ethernet device arguments  */
1206 struct rte_eth_devargs {
1207         uint16_t ports[RTE_MAX_ETHPORTS];
1208         /** port/s number to enable on a multi-port single function */
1209         uint16_t nb_ports;
1210         /** number of ports in ports field */
1211         uint16_t representor_ports[RTE_MAX_ETHPORTS];
1212         /** representor port/s identifier to enable on device */
1213         uint16_t nb_representor_ports;
1214         /** number of ports in representor port field */
1215 };
1216
1217 /**
1218  * PMD helper function to parse ethdev arguments
1219  *
1220  * @param devargs
1221  *  device arguments
1222  * @param eth_devargs
1223  *  parsed ethdev specific arguments.
1224  *
1225  * @return
1226  *   Negative errno value on error, 0 on success.
1227  */
1228 __rte_internal
1229 int
1230 rte_eth_devargs_parse(const char *devargs, struct rte_eth_devargs *eth_devargs);
1231
1232
1233 typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
1234 typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
1235         void *bus_specific_init_params);
1236
1237 /**
1238  * PMD helper function for the creation of a new ethdev ports.
1239  *
1240  * @param device
1241  *  rte_device handle.
1242  * @param name
1243  *  port name.
1244  * @param priv_data_size
1245  *  size of private data required for port.
1246  * @param bus_specific_init
1247  *  port bus specific initialisation callback function
1248  * @param bus_init_params
1249  *  port bus specific initialisation parameters
1250  * @param ethdev_init
1251  *  device specific port initialization callback function
1252  * @param init_params
1253  *  port initialisation parameters
1254  *
1255  * @return
1256  *   Negative errno value on error, 0 on success.
1257  */
1258 __rte_internal
1259 int
1260 rte_eth_dev_create(struct rte_device *device, const char *name,
1261         size_t priv_data_size,
1262         ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
1263         ethdev_init_t ethdev_init, void *init_params);
1264
1265
1266 typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);
1267
1268 /**
1269  * PMD helper function for cleaning up the resources of a ethdev port on it's
1270  * destruction.
1271  *
1272  * @param ethdev
1273  *   ethdev handle of port.
1274  * @param ethdev_uninit
1275  *   device specific port un-initialise callback function
1276  *
1277  * @return
1278  *   Negative errno value on error, 0 on success.
1279  */
1280 __rte_internal
1281 int
1282 rte_eth_dev_destroy(struct rte_eth_dev *ethdev, ethdev_uninit_t ethdev_uninit);
1283
1284 /**
1285  * @internal
1286  * Pass the current hairpin queue HW and/or SW information to the peer queue
1287  * and fetch back the information of the peer queue.
1288  *
1289  * @param peer_port
1290  *  Peer port identifier of the Ethernet device.
1291  * @param peer_queue
1292  *  Peer queue index of the port.
1293  * @param cur_info
1294  *  Pointer to the current information structure.
1295  * @param peer_info
1296  *  Pointer to the peer information, output.
1297  * @param direction
1298  *  Direction to pass the information.
1299  *  positive - pass Tx queue information and get peer Rx queue information
1300  *  zero - pass Rx queue information and get peer Tx queue information
1301  *
1302  * @return
1303  *  Negative errno value on error, 0 on success.
1304  */
1305 __rte_internal
1306 int
1307 rte_eth_hairpin_queue_peer_update(uint16_t peer_port, uint16_t peer_queue,
1308                                   struct rte_hairpin_peer_info *cur_info,
1309                                   struct rte_hairpin_peer_info *peer_info,
1310                                   uint32_t direction);
1311
1312 /**
1313  * @internal
1314  * Configure current hairpin queue with the peer information fetched to create
1315  * the connection (bind) with peer queue in the specified direction.
1316  * This function might need to be called twice to fully create the connections.
1317  *
1318  * @param cur_port
1319  *  Current port identifier of the Ethernet device.
1320  * @param cur_queue
1321  *  Current queue index of the port.
1322  * @param peer_info
1323  *  Pointer to the peer information, input.
1324  * @param direction
1325  *  Direction to create the connection.
1326  *  positive - bind current Tx queue to peer Rx queue
1327  *  zero - bind current Rx queue to peer Tx queue
1328  *
1329  * @return
1330  *  Negative errno value on error, 0 on success.
1331  */
1332 __rte_internal
1333 int
1334 rte_eth_hairpin_queue_peer_bind(uint16_t cur_port, uint16_t cur_queue,
1335                                 struct rte_hairpin_peer_info *peer_info,
1336                                 uint32_t direction);
1337
1338 /**
1339  * @internal
1340  * Reset the current queue state and configuration to disconnect (unbind) it
1341  * from the peer queue.
1342  * This function might need to be called twice to disconnect each other.
1343  *
1344  * @param cur_port
1345  *  Current port identifier of the Ethernet device.
1346  * @param cur_queue
1347  *  Current queue index of the port.
1348  * @param direction
1349  *  Direction to destroy the connection.
1350  *  positive - unbind current Tx queue from peer Rx queue
1351  *  zero - unbind current Rx queue from peer Tx queue
1352  *
1353  * @return
1354  *  Negative errno value on error, 0 on success.
1355  */
1356 __rte_internal
1357 int
1358 rte_eth_hairpin_queue_peer_unbind(uint16_t cur_port, uint16_t cur_queue,
1359                                   uint32_t direction);
1360
1361
1362 /*
1363  * Legacy ethdev API used internally by drivers.
1364  */
1365
1366 /**
1367  * Define all structures for Ethertype Filter type.
1368  */
1369
1370 #define RTE_ETHTYPE_FLAGS_MAC    0x0001 /**< If set, compare mac */
1371 #define RTE_ETHTYPE_FLAGS_DROP   0x0002 /**< If set, drop packet when match */
1372
1373 /**
1374  * A structure used to define the ethertype filter entry
1375  * to support RTE_ETH_FILTER_ETHERTYPE data representation.
1376  */
1377 struct rte_eth_ethertype_filter {
1378         struct rte_ether_addr mac_addr;   /**< Mac address to match. */
1379         uint16_t ether_type;          /**< Ether type to match */
1380         uint16_t flags;               /**< Flags from RTE_ETHTYPE_FLAGS_* */
1381         uint16_t queue;               /**< Queue assigned to when match*/
1382 };
1383
1384 /**
1385  * A structure used to define the TCP syn filter entry
1386  * to support RTE_ETH_FILTER_SYN data representation.
1387  */
1388 struct rte_eth_syn_filter {
1389         /** 1 - higher priority than other filters, 0 - lower priority. */
1390         uint8_t hig_pri;
1391         uint16_t queue;      /**< Queue assigned to when match */
1392 };
1393
1394 /**
1395  * filter type of tunneling packet
1396  */
1397 #define ETH_TUNNEL_FILTER_OMAC  0x01 /**< filter by outer MAC addr */
1398 #define ETH_TUNNEL_FILTER_OIP   0x02 /**< filter by outer IP Addr */
1399 #define ETH_TUNNEL_FILTER_TENID 0x04 /**< filter by tenant ID */
1400 #define ETH_TUNNEL_FILTER_IMAC  0x08 /**< filter by inner MAC addr */
1401 #define ETH_TUNNEL_FILTER_IVLAN 0x10 /**< filter by inner VLAN ID */
1402 #define ETH_TUNNEL_FILTER_IIP   0x20 /**< filter by inner IP addr */
1403
1404 #define RTE_TUNNEL_FILTER_IMAC_IVLAN (ETH_TUNNEL_FILTER_IMAC | \
1405                                         ETH_TUNNEL_FILTER_IVLAN)
1406 #define RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID (ETH_TUNNEL_FILTER_IMAC | \
1407                                         ETH_TUNNEL_FILTER_IVLAN | \
1408                                         ETH_TUNNEL_FILTER_TENID)
1409 #define RTE_TUNNEL_FILTER_IMAC_TENID (ETH_TUNNEL_FILTER_IMAC | \
1410                                         ETH_TUNNEL_FILTER_TENID)
1411 #define RTE_TUNNEL_FILTER_OMAC_TENID_IMAC (ETH_TUNNEL_FILTER_OMAC | \
1412                                         ETH_TUNNEL_FILTER_TENID | \
1413                                         ETH_TUNNEL_FILTER_IMAC)
1414
1415 /**
1416  *  Select IPv4 or IPv6 for tunnel filters.
1417  */
1418 enum rte_tunnel_iptype {
1419         RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4. */
1420         RTE_TUNNEL_IPTYPE_IPV6,     /**< IPv6. */
1421 };
1422
1423 /**
1424  * Tunneling Packet filter configuration.
1425  */
1426 struct rte_eth_tunnel_filter_conf {
1427         struct rte_ether_addr outer_mac;    /**< Outer MAC address to match. */
1428         struct rte_ether_addr inner_mac;    /**< Inner MAC address to match. */
1429         uint16_t inner_vlan;            /**< Inner VLAN to match. */
1430         enum rte_tunnel_iptype ip_type; /**< IP address type. */
1431         /**
1432          * Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
1433          * is set in filter_type, or inner destination IP address to match
1434          * if ETH_TUNNEL_FILTER_IIP is set in filter_type.
1435          */
1436         union {
1437                 uint32_t ipv4_addr;     /**< IPv4 address in big endian. */
1438                 uint32_t ipv6_addr[4];  /**< IPv6 address in big endian. */
1439         } ip_addr;
1440         /** Flags from ETH_TUNNEL_FILTER_XX - see above. */
1441         uint16_t filter_type;
1442         enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
1443         uint32_t tenant_id;     /**< Tenant ID to match. VNI, GRE key... */
1444         uint16_t queue_id;      /**< Queue assigned to if match. */
1445 };
1446
1447 #ifdef __cplusplus
1448 }
1449 #endif
1450
1451 #endif /* _RTE_ETHDEV_DRIVER_H_ */