1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _RTE_ETHDEV_CORE_H_
6 #define _RTE_ETHDEV_CORE_H_
11 * RTE Ethernet Device internal header.
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.
16 * Applications should not use these directly.
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);
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.
31 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
32 /**< @internal Ethernet device configuration. */
34 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
35 /**< @internal Function used to start a configured Ethernet device. */
37 typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev);
38 /**< @internal Function used to stop a configured Ethernet device. */
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. */
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. */
46 typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev);
47 /**< @internal Function used to close a configured Ethernet device. */
49 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
50 /** <@internal Function used to reset a configured Ethernet device. */
52 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
53 /**< @internal Function used to detect an Ethernet device removal. */
57 * Function used to enable the Rx promiscuous mode of an Ethernet device.
60 * ethdev handle of port.
63 * Negative errno value on error, 0 on success.
66 * Success, promiscuous mode is enabled.
68 * Promiscuous mode is not supported.
71 * @retval -E_RTE_SECONDARY
72 * Function was called from a secondary process instance and not supported.
74 * Attempt to enable promiscuos mode failed because of timeout.
76 * Failed to enable promiscuous mode.
78 typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
82 * Function used to disable the Rx promiscuous mode of an Ethernet device.
85 * ethdev handle of port.
88 * Negative errno value on error, 0 on success.
91 * Success, promiscuous mode is disabled.
93 * Promiscuous mode disabling is not supported.
96 * @retval -E_RTE_SECONDARY
97 * Function was called from a secondary process instance and not supported.
99 * Attempt to disable promiscuos mode failed because of timeout.
101 * Failed to disable promiscuous mode.
103 typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
107 * Enable the receipt of all multicast packets by an Ethernet device.
110 * ethdev handle of port.
113 * Negative errno value on error, 0 on success.
116 * Success, all-multicast mode is enabled.
118 * All-multicast mode is not supported.
121 * @retval -E_RTE_SECONDARY
122 * Function was called from a secondary process instance and not supported.
124 * Attempt to enable all-multicast mode failed because of timeout.
126 * Failed to enable all-multicast mode.
128 typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
132 * Disable the receipt of all multicast packets by an Ethernet device.
135 * ethdev handle of port.
138 * Negative errno value on error, 0 on success.
141 * Success, all-multicast mode is disabled.
143 * All-multicast mode disabling is not supported.
146 * @retval -E_RTE_SECONDARY
147 * Function was called from a secondary process instance and not supported.
149 * Attempt to disable all-multicast mode failed because of timeout.
151 * Failed to disable all-multicast mode.
153 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
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. */
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. */
165 * Reset global I/O statistics of an Ethernet device to 0.
168 * ethdev handle of port.
171 * Negative errno value on error, 0 on success.
174 * Success, statistics has been reset.
176 * Resetting statistics is not supported.
178 * Resetting statistics is not valid.
180 * Not enough memory to get the stats.
182 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
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. */
188 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
192 /**< @internal Get extended stats of an Ethernet device. */
196 * Reset extended stats of an Ethernet device.
199 * ethdev handle of port.
202 * Negative errno value on error, 0 on success.
205 * Success, statistics has been reset.
207 * Resetting statistics is not supported.
209 * Resetting statistics is not valid.
211 * Not enough memory to get the stats.
213 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
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. */
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,
222 /**< @internal Get names of extended stats of an Ethernet device. */
224 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
228 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
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. */
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. */
239 * Inform Ethernet device about reduced range of packet types to handle.
242 * The Ethernet device identifier.
244 * The ptype family that application is interested in should be bitwise OR of
245 * RTE_PTYPE_*_MASK or 0.
249 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
250 uint32_t ptype_mask);
252 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
254 /**< @internal Start rx and tx of a queue of an Ethernet device. */
256 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
258 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
260 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
261 uint16_t rx_queue_id,
263 unsigned int socket_id,
264 const struct rte_eth_rxconf *rx_conf,
265 struct rte_mempool *mb_pool);
266 /**< @internal Set up a receive queue of an Ethernet device. */
268 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
269 uint16_t tx_queue_id,
271 unsigned int socket_id,
272 const struct rte_eth_txconf *tx_conf);
273 /**< @internal Setup a transmit queue of an Ethernet device. */
275 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
276 uint16_t rx_queue_id);
277 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
279 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
280 uint16_t rx_queue_id);
281 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
283 typedef void (*eth_queue_release_t)(void *queue);
284 /**< @internal Release memory resources allocated by given RX/TX queue. */
286 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
287 uint16_t rx_queue_id);
288 /**< @internal Get number of used descriptors on a receive queue. */
290 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
291 /**< @internal Check DD bit of specific RX descriptor */
293 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
294 /**< @internal Check the status of a Rx descriptor */
296 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
297 /**< @internal Check the status of a Tx descriptor */
299 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
300 char *fw_version, size_t fw_size);
301 /**< @internal Get firmware information of an Ethernet device. */
303 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
304 /**< @internal Force mbufs to be from TX ring. */
306 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
307 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
309 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
310 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
312 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
313 uint16_t queue_id, struct rte_eth_burst_mode *mode);
315 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
316 /**< @internal Set MTU. */
318 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
321 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
323 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
324 enum rte_vlan_type type, uint16_t tpid);
325 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
327 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
328 /**< @internal set VLAN offload function by an Ethernet device. */
330 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
333 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
335 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
336 uint16_t rx_queue_id,
338 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
340 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
341 struct rte_mbuf **rx_pkts,
343 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
345 typedef uint16_t (*eth_tx_burst_t)(void *txq,
346 struct rte_mbuf **tx_pkts,
348 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
350 typedef uint16_t (*eth_tx_prep_t)(void *txq,
351 struct rte_mbuf **tx_pkts,
353 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
355 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
356 struct rte_eth_fc_conf *fc_conf);
357 /**< @internal Get current flow control parameter on an Ethernet device */
359 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
360 struct rte_eth_fc_conf *fc_conf);
361 /**< @internal Setup flow control parameter on an Ethernet device */
363 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
364 struct rte_eth_pfc_conf *pfc_conf);
365 /**< @internal Setup priority flow control parameter on an Ethernet device */
367 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
368 struct rte_eth_rss_reta_entry64 *reta_conf,
370 /**< @internal Update RSS redirection table on an Ethernet device */
372 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
373 struct rte_eth_rss_reta_entry64 *reta_conf,
375 /**< @internal Query RSS redirection table on an Ethernet device */
377 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
378 struct rte_eth_rss_conf *rss_conf);
379 /**< @internal Update RSS hash configuration of an Ethernet device */
381 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
382 struct rte_eth_rss_conf *rss_conf);
383 /**< @internal Get current RSS hash configuration of an Ethernet device */
385 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
386 /**< @internal Turn on SW controllable LED on an Ethernet device */
388 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
389 /**< @internal Turn off SW controllable LED on an Ethernet device */
391 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
392 /**< @internal Remove MAC address from receive address register */
394 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
395 struct rte_ether_addr *mac_addr,
398 /**< @internal Set a MAC address into Receive Address Address Register */
400 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
401 struct rte_ether_addr *mac_addr);
402 /**< @internal Set a MAC address into Receive Address Address Register */
404 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
405 struct rte_ether_addr *mac_addr,
407 /**< @internal Set a Unicast Hash bitmap */
409 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
411 /**< @internal Set all Unicast Hash bitmap */
413 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
416 /**< @internal Set queue TX rate */
418 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
419 struct rte_eth_mirror_conf *mirror_conf,
422 /**< @internal Add a traffic mirroring rule on an Ethernet device */
424 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
426 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
428 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
429 struct rte_eth_udp_tunnel *tunnel_udp);
430 /**< @internal Add tunneling UDP port */
432 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
433 struct rte_eth_udp_tunnel *tunnel_udp);
434 /**< @internal Delete tunneling UDP port */
436 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
437 struct rte_ether_addr *mc_addr_set,
438 uint32_t nb_mc_addr);
439 /**< @internal set the list of multicast addresses on an Ethernet device */
441 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
442 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
444 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
445 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
447 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
448 struct timespec *timestamp,
450 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
452 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
453 struct timespec *timestamp);
454 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
456 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
457 /**< @internal Function used to adjust the device clock */
459 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
460 struct timespec *timestamp);
461 /**< @internal Function used to get time from the device clock. */
463 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
464 const struct timespec *timestamp);
465 /**< @internal Function used to get time from the device clock */
467 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
468 uint64_t *timestamp);
469 /**< @internal Function used to get the current value of the device clock. */
471 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
472 struct rte_dev_reg_info *info);
473 /**< @internal Retrieve registers */
475 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
476 /**< @internal Retrieve eeprom size */
478 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
479 struct rte_dev_eeprom_info *info);
480 /**< @internal Retrieve eeprom data */
482 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
483 struct rte_dev_eeprom_info *info);
484 /**< @internal Program eeprom data */
486 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
487 struct rte_eth_dev_module_info *modinfo);
488 /**< @internal Retrieve type and size of plugin module eeprom */
490 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
491 struct rte_dev_eeprom_info *info);
492 /**< @internal Retrieve plugin module eeprom data */
494 typedef int (*eth_l2_tunnel_eth_type_conf_t)
495 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
496 /**< @internal config l2 tunnel ether type */
498 typedef int (*eth_l2_tunnel_offload_set_t)
499 (struct rte_eth_dev *dev,
500 struct rte_eth_l2_tunnel_conf *l2_tunnel,
503 /**< @internal enable/disable the l2 tunnel offload functions */
506 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
507 enum rte_filter_type filter_type,
508 enum rte_filter_op filter_op,
510 /**< @internal Take operations to assigned filter type on an Ethernet device */
512 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
513 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
515 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
516 /**< @internal Get Traffic Metering and Policing (MTR) operations */
518 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
519 struct rte_eth_dcb_info *dcb_info);
520 /**< @internal Get dcb information on an Ethernet device */
522 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
524 /**< @internal Test if a port supports specific mempool ops */
528 * Get the hairpin capabilities.
531 * ethdev handle of port.
533 * returns the hairpin capabilities from the device.
536 * Negative errno value on error, 0 on success.
539 * Success, hairpin is supported.
541 * Hairpin is not supported.
543 typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
544 struct rte_eth_hairpin_cap *cap);
548 * Setup RX hairpin queue.
551 * ethdev handle of port.
553 * the selected RX queue index.
555 * the requested number of descriptors for this queue. 0 - use PMD default.
557 * the RX hairpin configuration structure.
560 * Negative errno value on error, 0 on success.
563 * Success, hairpin is supported.
565 * Hairpin is not supported.
567 * One of the parameters is invalid.
569 * Unable to allocate resources.
571 typedef int (*eth_rx_hairpin_queue_setup_t)
572 (struct rte_eth_dev *dev, uint16_t rx_queue_id,
574 const struct rte_eth_hairpin_conf *conf);
578 * Setup TX hairpin queue.
581 * ethdev handle of port.
583 * the selected TX queue index.
585 * the requested number of descriptors for this queue. 0 - use PMD default.
587 * the TX hairpin configuration structure.
590 * Negative errno value on error, 0 on success.
593 * Success, hairpin is supported.
595 * Hairpin is not supported.
597 * One of the parameters is invalid.
599 * Unable to allocate resources.
601 typedef int (*eth_tx_hairpin_queue_setup_t)
602 (struct rte_eth_dev *dev, uint16_t tx_queue_id,
604 const struct rte_eth_hairpin_conf *hairpin_conf);
607 * @internal A structure containing the functions exported by an Ethernet driver.
610 eth_dev_configure_t dev_configure; /**< Configure device. */
611 eth_dev_start_t dev_start; /**< Start device. */
612 eth_dev_stop_t dev_stop; /**< Stop device. */
613 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
614 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
615 eth_dev_close_t dev_close; /**< Close device. */
616 eth_dev_reset_t dev_reset; /**< Reset device. */
617 eth_link_update_t link_update; /**< Get device link state. */
618 eth_is_removed_t is_removed;
619 /**< Check if the device was physically removed. */
621 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
622 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
623 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
624 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
625 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
626 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
627 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
628 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
629 mtu_set_t mtu_set; /**< Set MTU. */
631 eth_stats_get_t stats_get; /**< Get generic device statistics. */
632 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
633 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
634 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
635 eth_xstats_get_names_t xstats_get_names;
636 /**< Get names of extended statistics. */
637 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
638 /**< Configure per queue stat counter mapping. */
640 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
641 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
642 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
643 eth_burst_mode_get_t rx_burst_mode_get; /**< Get RX burst mode */
644 eth_burst_mode_get_t tx_burst_mode_get; /**< Get TX burst mode */
645 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
646 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
647 /**< Get packet types supported and identified by device. */
648 eth_dev_ptypes_set_t dev_ptypes_set;
649 /**< Inform Ethernet device about reduced range of packet types to handle. */
651 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
652 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
653 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
654 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
655 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
657 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
658 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
659 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
660 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
661 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
662 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
663 eth_rx_queue_count_t rx_queue_count;
664 /**< Get the number of used RX descriptors. */
665 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
666 eth_rx_descriptor_status_t rx_descriptor_status;
667 /**< Check the status of a Rx descriptor. */
668 eth_tx_descriptor_status_t tx_descriptor_status;
669 /**< Check the status of a Tx descriptor. */
670 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
671 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
672 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
673 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
674 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
676 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
677 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
679 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
680 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
681 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
683 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
684 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
686 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
687 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
689 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
690 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
691 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
692 /** Config ether type of l2 tunnel. */
693 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
694 /** Enable/disable l2 tunnel offload functions. */
696 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
698 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
699 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
700 reta_update_t reta_update; /** Update redirection table. */
701 reta_query_t reta_query; /** Query redirection table. */
703 eth_get_reg_t get_reg; /**< Get registers. */
704 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
705 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
706 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
708 eth_get_module_info_t get_module_info;
709 /** Get plugin module eeprom attribute. */
710 eth_get_module_eeprom_t get_module_eeprom;
711 /** Get plugin module eeprom data. */
713 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
715 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
717 eth_timesync_enable_t timesync_enable;
718 /** Turn IEEE1588/802.1AS timestamping on. */
719 eth_timesync_disable_t timesync_disable;
720 /** Turn IEEE1588/802.1AS timestamping off. */
721 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
722 /** Read the IEEE1588/802.1AS RX timestamp. */
723 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
724 /** Read the IEEE1588/802.1AS TX timestamp. */
725 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
726 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
727 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
729 eth_read_clock read_clock;
731 eth_xstats_get_by_id_t xstats_get_by_id;
732 /**< Get extended device statistic values by ID. */
733 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
734 /**< Get name of extended device statistics by ID. */
736 eth_tm_ops_get_t tm_ops_get;
737 /**< Get Traffic Management (TM) operations. */
739 eth_mtr_ops_get_t mtr_ops_get;
740 /**< Get Traffic Metering and Policing (MTR) operations. */
742 eth_pool_ops_supported_t pool_ops_supported;
743 /**< Test if a port supports specific mempool ops */
745 eth_hairpin_cap_get_t hairpin_cap_get;
746 /**< Returns the hairpin capabilities. */
747 eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
748 /**< Set up device RX hairpin queue. */
749 eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
750 /**< Set up device TX hairpin queue. */
755 * Structure used to hold information about the callbacks to be called for a
756 * queue on RX and TX.
758 struct rte_eth_rxtx_callback {
759 struct rte_eth_rxtx_callback *next;
761 rte_rx_callback_fn rx;
762 rte_tx_callback_fn tx;
769 * The generic data structure associated with each ethernet device.
771 * Pointers to burst-oriented packet receive and transmit functions are
772 * located at the beginning of the structure, along with the pointer to
773 * where all the data elements for the particular device are stored in shared
774 * memory. This split allows the function pointer and driver data to be per-
775 * process, while the actual configuration data for the device is shared.
778 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
779 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
780 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
782 * Next two fields are per-device data but *data is shared between
783 * primary and secondary processes and *process_private is per-process
784 * private. The second one is managed by PMDs if necessary.
786 struct rte_eth_dev_data *data; /**< Pointer to device data. */
787 void *process_private; /**< Pointer to per-process device data. */
788 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
789 struct rte_device *device; /**< Backing device */
790 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
791 /** User application callbacks for NIC interrupts */
792 struct rte_eth_dev_cb_list link_intr_cbs;
794 * User-supplied functions called from rx_burst to post-process
795 * received packets before passing them to the user
797 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
799 * User-supplied functions called from tx_burst to pre-process
800 * received packets before passing them to the driver for transmission.
802 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
803 enum rte_eth_dev_state state; /**< Flag indicating the port state */
804 void *security_ctx; /**< Context for security ops */
806 uint64_t reserved_64s[4]; /**< Reserved for future fields */
807 void *reserved_ptrs[4]; /**< Reserved for future fields */
808 } __rte_cache_aligned;
810 struct rte_eth_dev_sriov;
811 struct rte_eth_dev_owner;
815 * The data part, with no function pointers, associated with each ethernet device.
817 * This structure is safe to place in shared memory to be common among different
818 * processes in a multi-process configuration.
820 struct rte_eth_dev_data {
821 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
823 void **rx_queues; /**< Array of pointers to RX queues. */
824 void **tx_queues; /**< Array of pointers to TX queues. */
825 uint16_t nb_rx_queues; /**< Number of RX queues. */
826 uint16_t nb_tx_queues; /**< Number of TX queues. */
828 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
831 /**< PMD-specific private data.
832 * @see rte_eth_dev_release_port()
835 struct rte_eth_link dev_link; /**< Link-level information & status. */
836 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
837 uint16_t mtu; /**< Maximum Transmission Unit. */
838 uint32_t min_rx_buf_size;
839 /**< Common RX buffer size handled by all queues. */
841 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
842 struct rte_ether_addr *mac_addrs;
843 /**< Device Ethernet link address.
844 * @see rte_eth_dev_release_port()
846 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
847 /**< Bitmap associating MAC addresses to pools. */
848 struct rte_ether_addr *hash_mac_addrs;
849 /**< Device Ethernet MAC addresses of hash filtering.
850 * @see rte_eth_dev_release_port()
852 uint16_t port_id; /**< Device [external] port identifier. */
855 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
856 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
857 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
858 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
859 lro : 1; /**< RX LRO is ON(1) / OFF(0) */
860 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
861 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
862 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
863 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
864 uint32_t dev_flags; /**< Capabilities. */
865 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough. */
866 int numa_node; /**< NUMA node connection. */
867 struct rte_vlan_filter_conf vlan_filter_conf;
868 /**< VLAN filter configuration. */
869 struct rte_eth_dev_owner owner; /**< The port owner. */
870 uint16_t representor_id;
871 /**< Switch-specific identifier.
872 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
875 uint64_t reserved_64s[4]; /**< Reserved for future fields */
876 void *reserved_ptrs[4]; /**< Reserved for future fields */
877 } __rte_cache_aligned;
881 * The pool of *rte_eth_dev* structures. The size of the pool
882 * is configured at compile-time in the <rte_ethdev.c> file.
884 extern struct rte_eth_dev rte_eth_devices[];
886 #endif /* _RTE_ETHDEV_CORE_H_ */