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