lib/librte_ethdev/rte_ethdev_core.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_ETHDEV_CORE_H_
   6 #define _RTE_ETHDEV_CORE_H_
   7
   8 /**
   9  * @file
  10  *
  11  * RTE Ethernet Device internal header.
  12  *
  13  * This header contains internal data types. But they are still part of the
  14  * public API because they are used by inline functions in the published API.
  15  *
  16  * Applications should not use these directly.
  17  *
  18  */
  19
  20 struct rte_eth_dev_callback;
  21 /** @internal Structure to keep track of registered callbacks */
  22 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
  23
  24 /*
  25  * Definitions of all functions exported by an Ethernet driver through the
  26  * the generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
  27  * structure associated with an Ethernet device.
  28  */
  29 struct rte_eth_dev;
  30
  31 typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
  32 /**< @internal Ethernet device configuration. */
  33
  34 typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
  35 /**< @internal Function used to start a configured Ethernet device. */
  36
  37 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
  38 /**< @internal Function used to stop a configured Ethernet device. */
  39
  40 typedef int  (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
  41 /**< @internal Function used to link up a configured Ethernet device. */
  42
  43 typedef int  (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
  44 /**< @internal Function used to link down a configured Ethernet device. */
  45
  46 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
  47 /**< @internal Function used to close a configured Ethernet device. */
  48
  49 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
  50 /** <@internal Function used to reset a configured Ethernet device. */
  51
  52 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
  53 /**< @internal Function used to detect an Ethernet device removal. */
  54
  55 /**
  56  * @internal
  57  * Function used to enable the Rx promiscuous mode of an Ethernet device.
  58  *
  59  * @param dev
  60  *   ethdev handle of port.
  61  *
  62  * @return
  63  *   Negative errno value on error, 0 on success.
  64  *
  65  * @retval 0
  66  *   Success, promiscuous mode is enabled.
  67  * @retval -ENOTSUP
  68  *   Promiscuous mode is not supported.
  69  * @retval -ENODEV
  70  *   Device is gone.
  71  * @retval -E_RTE_SECONDARY
  72  *   Function was called from a secondary process instance and not supported.
  73  * @retval -ETIMEDOUT
  74  *   Attempt to enable promiscuos mode failed because of timeout.
  75  * @retval -EAGAIN
  76  *   Failed to enable promiscuous mode.
  77  */
  78 typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
  79
  80 /**
  81  * @internal
  82  * Function used to disable the Rx promiscuous mode of an Ethernet device.
  83  *
  84  * @param dev
  85  *   ethdev handle of port.
  86  *
  87  * @return
  88  *   Negative errno value on error, 0 on success.
  89  *
  90  * @retval 0
  91  *   Success, promiscuous mode is disabled.
  92  * @retval -ENOTSUP
  93  *   Promiscuous mode disabling is not supported.
  94  * @retval -ENODEV
  95  *   Device is gone.
  96  * @retval -E_RTE_SECONDARY
  97  *   Function was called from a secondary process instance and not supported.
  98  * @retval -ETIMEDOUT
  99  *   Attempt to disable promiscuos mode failed because of timeout.
 100  * @retval -EAGAIN
 101  *   Failed to disable promiscuous mode.
 102  */
 103 typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
 104
 105 /**
 106  * @internal
 107  * Enable the receipt of all multicast packets by an Ethernet device.
 108  *
 109  * @param dev
 110  *   ethdev handle of port.
 111  *
 112  * @return
 113  *   Negative errno value on error, 0 on success.
 114  *
 115  * @retval 0
 116  *   Success, all-multicast mode is enabled.
 117  * @retval -ENOTSUP
 118  *   All-multicast mode is not supported.
 119  * @retval -ENODEV
 120  *   Device is gone.
 121  * @retval -E_RTE_SECONDARY
 122  *   Function was called from a secondary process instance and not supported.
 123  * @retval -ETIMEDOUT
 124  *   Attempt to enable all-multicast mode failed because of timeout.
 125  * @retval -EAGAIN
 126  *   Failed to enable all-multicast mode.
 127  */
 128 typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
 129
 130 /**
 131  * @internal
 132  * Disable the receipt of all multicast packets by an Ethernet device.
 133  *
 134  * @param dev
 135  *   ethdev handle of port.
 136  *
 137  * @return
 138  *   Negative errno value on error, 0 on success.
 139  *
 140  * @retval 0
 141  *   Success, all-multicast mode is disabled.
 142  * @retval -ENOTSUP
 143  *   All-multicast mode disabling is not supported.
 144  * @retval -ENODEV
 145  *   Device is gone.
 146  * @retval -E_RTE_SECONDARY
 147  *   Function was called from a secondary process instance and not supported.
 148  * @retval -ETIMEDOUT
 149  *   Attempt to disable all-multicast mode failed because of timeout.
 150  * @retval -EAGAIN
 151  *   Failed to disable all-multicast mode.
 152  */
 153 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
 154
 155 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
 156                                 int wait_to_complete);
 157 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
 158
 159 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
 160                                 struct rte_eth_stats *igb_stats);
 161 /**< @internal Get global I/O statistics of an Ethernet device. */
 162
 163 /**
 164  * @internal
 165  * Reset global I/O statistics of an Ethernet device to 0.
 166  *
 167  * @param dev
 168  *   ethdev handle of port.
 169  *
 170  * @return
 171  *   Negative errno value on error, 0 on success.
 172  *
 173  * @retval 0
 174  *   Success, statistics has been reset.
 175  * @retval -ENOTSUP
 176  *   Resetting statistics is not supported.
 177  * @retval -EINVAL
 178  *   Resetting statistics is not valid.
 179  * @retval -ENOMEM
 180  *   Not enough memory to get the stats.
 181  */
 182 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
 183
 184 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
 185         struct rte_eth_xstat *stats, unsigned n);
 186 /**< @internal Get extended stats of an Ethernet device. */
 187
 188 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
 189                                       const uint64_t *ids,
 190                                       uint64_t *values,
 191                                       unsigned int n);
 192 /**< @internal Get extended stats of an Ethernet device. */
 193
 194 /**
 195  * @internal
 196  * Reset extended stats of an Ethernet device.
 197  *
 198  * @param dev
 199  *   ethdev handle of port.
 200  *
 201  * @return
 202  *   Negative errno value on error, 0 on success.
 203  *
 204  * @retval 0
 205  *   Success, statistics has been reset.
 206  * @retval -ENOTSUP
 207  *   Resetting statistics is not supported.
 208  * @retval -EINVAL
 209  *   Resetting statistics is not valid.
 210  * @retval -ENOMEM
 211  *   Not enough memory to get the stats.
 212  */
 213 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
 214
 215 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
 216         struct rte_eth_xstat_name *xstats_names, unsigned size);
 217 /**< @internal Get names of extended stats of an Ethernet device. */
 218
 219 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
 220         struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
 221         unsigned int size);
 222 /**< @internal Get names of extended stats of an Ethernet device. */
 223
 224 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
 225                                              uint16_t queue_id,
 226                                              uint8_t stat_idx,
 227                                              uint8_t is_rx);
 228 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
 229
 230 typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
 231                                    struct rte_eth_dev_info *dev_info);
 232 /**< @internal Get specific information of an Ethernet device. */
 233
 234 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
 235 /**< @internal Get supported ptypes of an Ethernet device. */
 236
 237 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
 238                                     uint16_t queue_id);
 239 /**< @internal Start rx and tx of a queue of an Ethernet device. */
 240
 241 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
 242                                     uint16_t queue_id);
 243 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
 244
 245 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
 246                                     uint16_t rx_queue_id,
 247                                     uint16_t nb_rx_desc,
 248                                     unsigned int socket_id,
 249                                     const struct rte_eth_rxconf *rx_conf,
 250                                     struct rte_mempool *mb_pool);
 251 /**< @internal Set up a receive queue of an Ethernet device. */
 252
 253 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
 254                                     uint16_t tx_queue_id,
 255                                     uint16_t nb_tx_desc,
 256                                     unsigned int socket_id,
 257                                     const struct rte_eth_txconf *tx_conf);
 258 /**< @internal Setup a transmit queue of an Ethernet device. */
 259
 260 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
 261                                     uint16_t rx_queue_id);
 262 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
 263
 264 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
 265                                     uint16_t rx_queue_id);
 266 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
 267
 268 typedef void (*eth_queue_release_t)(void *queue);
 269 /**< @internal Release memory resources allocated by given RX/TX queue. */
 270
 271 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
 272                                          uint16_t rx_queue_id);
 273 /**< @internal Get number of used descriptors on a receive queue. */
 274
 275 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
 276 /**< @internal Check DD bit of specific RX descriptor */
 277
 278 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
 279 /**< @internal Check the status of a Rx descriptor */
 280
 281 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
 282 /**< @internal Check the status of a Tx descriptor */
 283
 284 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
 285                                      char *fw_version, size_t fw_size);
 286 /**< @internal Get firmware information of an Ethernet device. */
 287
 288 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
 289 /**< @internal Force mbufs to be from TX ring. */
 290
 291 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
 292         uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
 293
 294 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
 295         uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
 296
 297 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
 298 /**< @internal Set MTU. */
 299
 300 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
 301                                   uint16_t vlan_id,
 302                                   int on);
 303 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
 304
 305 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
 306                                enum rte_vlan_type type, uint16_t tpid);
 307 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
 308
 309 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
 310 /**< @internal set VLAN offload function by an Ethernet device. */
 311
 312 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
 313                                uint16_t vlan_id,
 314                                int on);
 315 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
 316
 317 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
 318                                   uint16_t rx_queue_id,
 319                                   int on);
 320 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
 321
 322 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
 323                                    struct rte_mbuf **rx_pkts,
 324                                    uint16_t nb_pkts);
 325 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
 326
 327 typedef uint16_t (*eth_tx_burst_t)(void *txq,
 328                                    struct rte_mbuf **tx_pkts,
 329                                    uint16_t nb_pkts);
 330 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
 331
 332 typedef uint16_t (*eth_tx_prep_t)(void *txq,
 333                                    struct rte_mbuf **tx_pkts,
 334                                    uint16_t nb_pkts);
 335 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
 336
 337 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
 338                                struct rte_eth_fc_conf *fc_conf);
 339 /**< @internal Get current flow control parameter on an Ethernet device */
 340
 341 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
 342                                struct rte_eth_fc_conf *fc_conf);
 343 /**< @internal Setup flow control parameter on an Ethernet device */
 344
 345 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
 346                                 struct rte_eth_pfc_conf *pfc_conf);
 347 /**< @internal Setup priority flow control parameter on an Ethernet device */
 348
 349 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
 350                              struct rte_eth_rss_reta_entry64 *reta_conf,
 351                              uint16_t reta_size);
 352 /**< @internal Update RSS redirection table on an Ethernet device */
 353
 354 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
 355                             struct rte_eth_rss_reta_entry64 *reta_conf,
 356                             uint16_t reta_size);
 357 /**< @internal Query RSS redirection table on an Ethernet device */
 358
 359 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
 360                                  struct rte_eth_rss_conf *rss_conf);
 361 /**< @internal Update RSS hash configuration of an Ethernet device */
 362
 363 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
 364                                    struct rte_eth_rss_conf *rss_conf);
 365 /**< @internal Get current RSS hash configuration of an Ethernet device */
 366
 367 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
 368 /**< @internal Turn on SW controllable LED on an Ethernet device */
 369
 370 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
 371 /**< @internal Turn off SW controllable LED on an Ethernet device */
 372
 373 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
 374 /**< @internal Remove MAC address from receive address register */
 375
 376 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
 377                                   struct rte_ether_addr *mac_addr,
 378                                   uint32_t index,
 379                                   uint32_t vmdq);
 380 /**< @internal Set a MAC address into Receive Address Address Register */
 381
 382 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
 383                                   struct rte_ether_addr *mac_addr);
 384 /**< @internal Set a MAC address into Receive Address Address Register */
 385
 386 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
 387                                   struct rte_ether_addr *mac_addr,
 388                                   uint8_t on);
 389 /**< @internal Set a Unicast Hash bitmap */
 390
 391 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
 392                                   uint8_t on);
 393 /**< @internal Set all Unicast Hash bitmap */
 394
 395 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
 396                                 uint16_t queue_idx,
 397                                 uint16_t tx_rate);
 398 /**< @internal Set queue TX rate */
 399
 400 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
 401                                   struct rte_eth_mirror_conf *mirror_conf,
 402                                   uint8_t rule_id,
 403                                   uint8_t on);
 404 /**< @internal Add a traffic mirroring rule on an Ethernet device */
 405
 406 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
 407                                   uint8_t rule_id);
 408 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
 409
 410 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
 411                                          struct rte_eth_udp_tunnel *tunnel_udp);
 412 /**< @internal Add tunneling UDP port */
 413
 414 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
 415                                          struct rte_eth_udp_tunnel *tunnel_udp);
 416 /**< @internal Delete tunneling UDP port */
 417
 418 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
 419                                       struct rte_ether_addr *mc_addr_set,
 420                                       uint32_t nb_mc_addr);
 421 /**< @internal set the list of multicast addresses on an Ethernet device */
 422
 423 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
 424 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
 425
 426 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
 427 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
 428
 429 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
 430                                                 struct timespec *timestamp,
 431                                                 uint32_t flags);
 432 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
 433
 434 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
 435                                                 struct timespec *timestamp);
 436 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
 437
 438 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
 439 /**< @internal Function used to adjust the device clock */
 440
 441 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
 442                                       struct timespec *timestamp);
 443 /**< @internal Function used to get time from the device clock. */
 444
 445 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
 446                                        const struct timespec *timestamp);
 447 /**< @internal Function used to get time from the device clock */
 448
 449 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
 450                                       uint64_t *timestamp);
 451 /**< @internal Function used to get the current value of the device clock. */
 452
 453 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
 454                                 struct rte_dev_reg_info *info);
 455 /**< @internal Retrieve registers  */
 456
 457 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
 458 /**< @internal Retrieve eeprom size  */
 459
 460 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
 461                                 struct rte_dev_eeprom_info *info);
 462 /**< @internal Retrieve eeprom data  */
 463
 464 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
 465                                 struct rte_dev_eeprom_info *info);
 466 /**< @internal Program eeprom data  */
 467
 468 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
 469                                      struct rte_eth_dev_module_info *modinfo);
 470 /**< @internal Retrieve type and size of plugin module eeprom */
 471
 472 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
 473                                        struct rte_dev_eeprom_info *info);
 474 /**< @internal Retrieve plugin module eeprom data */
 475
 476 typedef int (*eth_l2_tunnel_eth_type_conf_t)
 477         (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
 478 /**< @internal config l2 tunnel ether type */
 479
 480 typedef int (*eth_l2_tunnel_offload_set_t)
 481         (struct rte_eth_dev *dev,
 482          struct rte_eth_l2_tunnel_conf *l2_tunnel,
 483          uint32_t mask,
 484          uint8_t en);
 485 /**< @internal enable/disable the l2 tunnel offload functions */
 486
 487
 488 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
 489                                  enum rte_filter_type filter_type,
 490                                  enum rte_filter_op filter_op,
 491                                  void *arg);
 492 /**< @internal Take operations to assigned filter type on an Ethernet device */
 493
 494 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 495 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
 496
 497 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 498 /**< @internal Get Traffic Metering and Policing (MTR) operations */
 499
 500 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
 501                                  struct rte_eth_dcb_info *dcb_info);
 502 /**< @internal Get dcb information on an Ethernet device */
 503
 504 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
 505                                                 const char *pool);
 506 /**< @internal Test if a port supports specific mempool ops */
 507
 508 /**
 509  * @internal A structure containing the functions exported by an Ethernet driver.
 510  */
 511 struct eth_dev_ops {
 512         eth_dev_configure_t        dev_configure; /**< Configure device. */
 513         eth_dev_start_t            dev_start;     /**< Start device. */
 514         eth_dev_stop_t             dev_stop;      /**< Stop device. */
 515         eth_dev_set_link_up_t      dev_set_link_up;   /**< Device link up. */
 516         eth_dev_set_link_down_t    dev_set_link_down; /**< Device link down. */
 517         eth_dev_close_t            dev_close;     /**< Close device. */
 518         eth_dev_reset_t            dev_reset;     /**< Reset device. */
 519         eth_link_update_t          link_update;   /**< Get device link state. */
 520         eth_is_removed_t           is_removed;
 521         /**< Check if the device was physically removed. */
 522
 523         eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
 524         eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
 525         eth_allmulticast_enable_t  allmulticast_enable;/**< RX multicast ON. */
 526         eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
 527         eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address. */
 528         eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address. */
 529         eth_mac_addr_set_t         mac_addr_set;  /**< Set a MAC address. */
 530         eth_set_mc_addr_list_t     set_mc_addr_list; /**< set list of mcast addrs. */
 531         mtu_set_t                  mtu_set;       /**< Set MTU. */
 532
 533         eth_stats_get_t            stats_get;     /**< Get generic device statistics. */
 534         eth_stats_reset_t          stats_reset;   /**< Reset generic device statistics. */
 535         eth_xstats_get_t           xstats_get;    /**< Get extended device statistics. */
 536         eth_xstats_reset_t         xstats_reset;  /**< Reset extended device statistics. */
 537         eth_xstats_get_names_t     xstats_get_names;
 538         /**< Get names of extended statistics. */
 539         eth_queue_stats_mapping_set_t queue_stats_mapping_set;
 540         /**< Configure per queue stat counter mapping. */
 541
 542         eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
 543         eth_rxq_info_get_t         rxq_info_get; /**< retrieve RX queue information. */
 544         eth_txq_info_get_t         txq_info_get; /**< retrieve TX queue information. */
 545         eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
 546         eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
 547         /**< Get packet types supported and identified by device. */
 548
 549         vlan_filter_set_t          vlan_filter_set; /**< Filter VLAN Setup. */
 550         vlan_tpid_set_t            vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
 551         vlan_strip_queue_set_t     vlan_strip_queue_set; /**< VLAN Stripping on queue. */
 552         vlan_offload_set_t         vlan_offload_set; /**< Set VLAN Offload. */
 553         vlan_pvid_set_t            vlan_pvid_set; /**< Set port based TX VLAN insertion. */
 554
 555         eth_queue_start_t          rx_queue_start;/**< Start RX for a queue. */
 556         eth_queue_stop_t           rx_queue_stop; /**< Stop RX for a queue. */
 557         eth_queue_start_t          tx_queue_start;/**< Start TX for a queue. */
 558         eth_queue_stop_t           tx_queue_stop; /**< Stop TX for a queue. */
 559         eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue. */
 560         eth_queue_release_t        rx_queue_release; /**< Release RX queue. */
 561         eth_rx_queue_count_t       rx_queue_count;
 562         /**< Get the number of used RX descriptors. */
 563         eth_rx_descriptor_done_t   rx_descriptor_done; /**< Check rxd DD bit. */
 564         eth_rx_descriptor_status_t rx_descriptor_status;
 565         /**< Check the status of a Rx descriptor. */
 566         eth_tx_descriptor_status_t tx_descriptor_status;
 567         /**< Check the status of a Tx descriptor. */
 568         eth_rx_enable_intr_t       rx_queue_intr_enable;  /**< Enable Rx queue interrupt. */
 569         eth_rx_disable_intr_t      rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
 570         eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue. */
 571         eth_queue_release_t        tx_queue_release; /**< Release TX queue. */
 572         eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free tx ring mbufs */
 573
 574         eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
 575         eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
 576
 577         flow_ctrl_get_t            flow_ctrl_get; /**< Get flow control. */
 578         flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control. */
 579         priority_flow_ctrl_set_t   priority_flow_ctrl_set; /**< Setup priority flow control. */
 580
 581         eth_uc_hash_table_set_t    uc_hash_table_set; /**< Set Unicast Table Array. */
 582         eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
 583
 584         eth_mirror_rule_set_t      mirror_rule_set; /**< Add a traffic mirror rule. */
 585         eth_mirror_rule_reset_t    mirror_rule_reset; /**< reset a traffic mirror rule. */
 586
 587         eth_udp_tunnel_port_add_t  udp_tunnel_port_add; /** Add UDP tunnel port. */
 588         eth_udp_tunnel_port_del_t  udp_tunnel_port_del; /** Del UDP tunnel port. */
 589         eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
 590         /** Config ether type of l2 tunnel. */
 591         eth_l2_tunnel_offload_set_t   l2_tunnel_offload_set;
 592         /** Enable/disable l2 tunnel offload functions. */
 593
 594         eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
 595
 596         rss_hash_update_t          rss_hash_update; /** Configure RSS hash protocols. */
 597         rss_hash_conf_get_t        rss_hash_conf_get; /** Get current RSS hash configuration. */
 598         reta_update_t              reta_update;   /** Update redirection table. */
 599         reta_query_t               reta_query;    /** Query redirection table. */
 600
 601         eth_get_reg_t              get_reg;           /**< Get registers. */
 602         eth_get_eeprom_length_t    get_eeprom_length; /**< Get eeprom length. */
 603         eth_get_eeprom_t           get_eeprom;        /**< Get eeprom data. */
 604         eth_set_eeprom_t           set_eeprom;        /**< Set eeprom. */
 605
 606         eth_get_module_info_t      get_module_info;
 607         /** Get plugin module eeprom attribute. */
 608         eth_get_module_eeprom_t    get_module_eeprom;
 609         /** Get plugin module eeprom data. */
 610
 611         eth_filter_ctrl_t          filter_ctrl; /**< common filter control. */
 612
 613         eth_get_dcb_info           get_dcb_info; /** Get DCB information. */
 614
 615         eth_timesync_enable_t      timesync_enable;
 616         /** Turn IEEE1588/802.1AS timestamping on. */
 617         eth_timesync_disable_t     timesync_disable;
 618         /** Turn IEEE1588/802.1AS timestamping off. */
 619         eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
 620         /** Read the IEEE1588/802.1AS RX timestamp. */
 621         eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
 622         /** Read the IEEE1588/802.1AS TX timestamp. */
 623         eth_timesync_adjust_time   timesync_adjust_time; /** Adjust the device clock. */
 624         eth_timesync_read_time     timesync_read_time; /** Get the device clock time. */
 625         eth_timesync_write_time    timesync_write_time; /** Set the device clock time. */
 626
 627         eth_read_clock             read_clock;
 628
 629         eth_xstats_get_by_id_t     xstats_get_by_id;
 630         /**< Get extended device statistic values by ID. */
 631         eth_xstats_get_names_by_id_t xstats_get_names_by_id;
 632         /**< Get name of extended device statistics by ID. */
 633
 634         eth_tm_ops_get_t tm_ops_get;
 635         /**< Get Traffic Management (TM) operations. */
 636
 637         eth_mtr_ops_get_t mtr_ops_get;
 638         /**< Get Traffic Metering and Policing (MTR) operations. */
 639
 640         eth_pool_ops_supported_t pool_ops_supported;
 641         /**< Test if a port supports specific mempool ops */
 642 };
 643
 644 /**
 645  * @internal
 646  * Structure used to hold information about the callbacks to be called for a
 647  * queue on RX and TX.
 648  */
 649 struct rte_eth_rxtx_callback {
 650         struct rte_eth_rxtx_callback *next;
 651         union{
 652                 rte_rx_callback_fn rx;
 653                 rte_tx_callback_fn tx;
 654         } fn;
 655         void *param;
 656 };
 657
 658 /**
 659  * @internal
 660  * The generic data structure associated with each ethernet device.
 661  *
 662  * Pointers to burst-oriented packet receive and transmit functions are
 663  * located at the beginning of the structure, along with the pointer to
 664  * where all the data elements for the particular device are stored in shared
 665  * memory. This split allows the function pointer and driver data to be per-
 666  * process, while the actual configuration data for the device is shared.
 667  */
 668 struct rte_eth_dev {
 669         eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 670         eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
 671         eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
 672         /**
 673          * Next two fields are per-device data but *data is shared between
 674          * primary and secondary processes and *process_private is per-process
 675          * private. The second one is managed by PMDs if necessary.
 676          */
 677         struct rte_eth_dev_data *data;  /**< Pointer to device data. */
 678         void *process_private; /**< Pointer to per-process device data. */
 679         const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
 680         struct rte_device *device; /**< Backing device */
 681         struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
 682         /** User application callbacks for NIC interrupts */
 683         struct rte_eth_dev_cb_list link_intr_cbs;
 684         /**
 685          * User-supplied functions called from rx_burst to post-process
 686          * received packets before passing them to the user
 687          */
 688         struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 689         /**
 690          * User-supplied functions called from tx_burst to pre-process
 691          * received packets before passing them to the driver for transmission.
 692          */
 693         struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 694         enum rte_eth_dev_state state; /**< Flag indicating the port state */
 695         void *security_ctx; /**< Context for security ops */
 696 } __rte_cache_aligned;
 697
 698 struct rte_eth_dev_sriov;
 699 struct rte_eth_dev_owner;
 700
 701 /**
 702  * @internal
 703  * The data part, with no function pointers, associated with each ethernet device.
 704  *
 705  * This structure is safe to place in shared memory to be common among different
 706  * processes in a multi-process configuration.
 707  */
 708 struct rte_eth_dev_data {
 709         char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 710
 711         void **rx_queues; /**< Array of pointers to RX queues. */
 712         void **tx_queues; /**< Array of pointers to TX queues. */
 713         uint16_t nb_rx_queues; /**< Number of RX queues. */
 714         uint16_t nb_tx_queues; /**< Number of TX queues. */
 715
 716         struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 717
 718         void *dev_private;
 719                         /**< PMD-specific private data.
 720                          *   @see rte_eth_dev_release_port()
 721                          */
 722
 723         struct rte_eth_link dev_link;   /**< Link-level information & status. */
 724         struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 725         uint16_t mtu;                   /**< Maximum Transmission Unit. */
 726         uint32_t min_rx_buf_size;
 727                         /**< Common RX buffer size handled by all queues. */
 728
 729         uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
 730         struct rte_ether_addr *mac_addrs;
 731                         /**< Device Ethernet link address.
 732                          *   @see rte_eth_dev_release_port()
 733                          */
 734         uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
 735                         /**< Bitmap associating MAC addresses to pools. */
 736         struct rte_ether_addr *hash_mac_addrs;
 737                         /**< Device Ethernet MAC addresses of hash filtering.
 738                          *   @see rte_eth_dev_release_port()
 739                          */
 740         uint16_t port_id;           /**< Device [external] port identifier. */
 741
 742         __extension__
 743         uint8_t promiscuous   : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
 744                 scattered_rx : 1,  /**< RX of scattered packets is ON(1) / OFF(0) */
 745                 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
 746                 dev_started : 1,   /**< Device state: STARTED(1) / STOPPED(0). */
 747                 lro         : 1;   /**< RX LRO is ON(1) / OFF(0) */
 748         uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 749                         /**< Queues state: STARTED(1) / STOPPED(0). */
 750         uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 751                         /**< Queues state: STARTED(1) / STOPPED(0). */
 752         uint32_t dev_flags;             /**< Capabilities. */
 753         enum rte_kernel_driver kdrv;    /**< Kernel driver passthrough. */
 754         int numa_node;                  /**< NUMA node connection. */
 755         struct rte_vlan_filter_conf vlan_filter_conf;
 756                         /**< VLAN filter configuration. */
 757         struct rte_eth_dev_owner owner; /**< The port owner. */
 758         uint16_t representor_id;
 759                         /**< Switch-specific identifier.
 760                          *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
 761                          */
 762 } __rte_cache_aligned;
 763
 764 /**
 765  * @internal
 766  * The pool of *rte_eth_dev* structures. The size of the pool
 767  * is configured at compile-time in the <rte_ethdev.c> file.
 768  */
 769 extern struct rte_eth_dev rte_eth_devices[];
 770
 771 #endif /* _RTE_ETHDEV_CORE_H_ */