1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _RTE_ETHDEV_DRIVER_H_
6 #define _RTE_ETHDEV_DRIVER_H_
11 * RTE Ethernet Device PMD API
13 * These APIs for the use from Ethernet drivers, user applications shouldn't
18 #include <rte_ethdev.h>
24 /**< @internal Declaration of the hairpin peer queue information structure. */
25 struct rte_hairpin_peer_info;
28 * Definitions of all functions exported by an Ethernet driver through the
29 * generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
30 * structure associated with an Ethernet device.
33 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
34 /**< @internal Ethernet device configuration. */
36 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
37 /**< @internal Function used to start a configured Ethernet device. */
39 typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
40 /**< @internal Function used to stop a configured Ethernet device. */
42 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
43 /**< @internal Function used to link up a configured Ethernet device. */
45 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
46 /**< @internal Function used to link down a configured Ethernet device. */
48 typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
49 /**< @internal Function used to close a configured Ethernet device. */
51 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
52 /** <@internal Function used to reset a configured Ethernet device. */
54 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
55 /**< @internal Function used to detect an Ethernet device removal. */
59 * Function used to enable the Rx promiscuous mode of an Ethernet device.
62 * ethdev handle of port.
65 * Negative errno value on error, 0 on success.
68 * Success, promiscuous mode is enabled.
70 * Promiscuous mode is not supported.
73 * @retval -E_RTE_SECONDARY
74 * Function was called from a secondary process instance and not supported.
76 * Attempt to enable promiscuos mode failed because of timeout.
78 * Failed to enable promiscuous mode.
80 typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
84 * Function used to disable the Rx promiscuous mode of an Ethernet device.
87 * ethdev handle of port.
90 * Negative errno value on error, 0 on success.
93 * Success, promiscuous mode is disabled.
95 * Promiscuous mode disabling is not supported.
98 * @retval -E_RTE_SECONDARY
99 * Function was called from a secondary process instance and not supported.
101 * Attempt to disable promiscuos mode failed because of timeout.
103 * Failed to disable promiscuous mode.
105 typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
109 * Enable the receipt of all multicast packets by an Ethernet device.
112 * ethdev handle of port.
115 * Negative errno value on error, 0 on success.
118 * Success, all-multicast mode is enabled.
120 * All-multicast mode is not supported.
123 * @retval -E_RTE_SECONDARY
124 * Function was called from a secondary process instance and not supported.
126 * Attempt to enable all-multicast mode failed because of timeout.
128 * Failed to enable all-multicast mode.
130 typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
134 * Disable the receipt of all multicast packets by an Ethernet device.
137 * ethdev handle of port.
140 * Negative errno value on error, 0 on success.
143 * Success, all-multicast mode is disabled.
145 * All-multicast mode disabling is not supported.
148 * @retval -E_RTE_SECONDARY
149 * Function was called from a secondary process instance and not supported.
151 * Attempt to disable all-multicast mode failed because of timeout.
153 * Failed to disable all-multicast mode.
155 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
157 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
158 int wait_to_complete);
159 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
161 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
162 struct rte_eth_stats *igb_stats);
163 /**< @internal Get global I/O statistics of an Ethernet device. */
167 * Reset global I/O statistics of an Ethernet device to 0.
170 * ethdev handle of port.
173 * Negative errno value on error, 0 on success.
176 * Success, statistics has been reset.
178 * Resetting statistics is not supported.
180 * Resetting statistics is not valid.
182 * Not enough memory to get the stats.
184 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
186 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
187 struct rte_eth_xstat *stats, unsigned int n);
188 /**< @internal Get extended stats of an Ethernet device. */
190 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
194 /**< @internal Get extended stats of an Ethernet device. */
198 * Reset extended stats of an Ethernet device.
201 * ethdev handle of port.
204 * Negative errno value on error, 0 on success.
207 * Success, statistics has been reset.
209 * Resetting statistics is not supported.
211 * Resetting statistics is not valid.
213 * Not enough memory to get the stats.
215 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
217 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
218 struct rte_eth_xstat_name *xstats_names, unsigned int size);
219 /**< @internal Get names of extended stats of an Ethernet device. */
221 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
222 struct rte_eth_xstat_name *xstats_names, const uint64_t *ids,
224 /**< @internal Get names of extended stats of an Ethernet device. */
226 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
230 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
232 typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
233 struct rte_eth_dev_info *dev_info);
234 /**< @internal Get specific information of an Ethernet device. */
236 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
237 /**< @internal Get supported ptypes of an Ethernet device. */
241 * Inform Ethernet device about reduced range of packet types to handle.
244 * The Ethernet device identifier.
246 * The ptype family that application is interested in should be bitwise OR of
247 * RTE_PTYPE_*_MASK or 0.
251 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
252 uint32_t ptype_mask);
254 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
256 /**< @internal Start rx and tx of a queue of an Ethernet device. */
258 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
260 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
262 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
263 uint16_t rx_queue_id,
265 unsigned int socket_id,
266 const struct rte_eth_rxconf *rx_conf,
267 struct rte_mempool *mb_pool);
268 /**< @internal Set up a receive queue of an Ethernet device. */
270 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
271 uint16_t tx_queue_id,
273 unsigned int socket_id,
274 const struct rte_eth_txconf *tx_conf);
275 /**< @internal Setup a transmit queue of an Ethernet device. */
277 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
278 uint16_t rx_queue_id);
279 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
281 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
282 uint16_t rx_queue_id);
283 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
285 typedef void (*eth_queue_release_t)(void *queue);
286 /**< @internal Release memory resources allocated by given RX/TX queue. */
288 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
289 char *fw_version, size_t fw_size);
290 /**< @internal Get firmware information of an Ethernet device. */
292 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
293 /**< @internal Force mbufs to be from TX ring. */
295 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
296 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
298 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
299 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
301 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
302 uint16_t queue_id, struct rte_eth_burst_mode *mode);
304 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
305 /**< @internal Set MTU. */
307 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
310 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
312 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
313 enum rte_vlan_type type, uint16_t tpid);
314 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
316 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
317 /**< @internal set VLAN offload function by an Ethernet device. */
319 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
322 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
324 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
325 uint16_t rx_queue_id,
327 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
329 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
330 struct rte_eth_fc_conf *fc_conf);
331 /**< @internal Get current flow control parameter on an Ethernet device */
333 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
334 struct rte_eth_fc_conf *fc_conf);
335 /**< @internal Setup flow control parameter on an Ethernet device */
337 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
338 struct rte_eth_pfc_conf *pfc_conf);
339 /**< @internal Setup priority flow control parameter on an Ethernet device */
341 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
342 struct rte_eth_rss_reta_entry64 *reta_conf,
344 /**< @internal Update RSS redirection table on an Ethernet device */
346 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
347 struct rte_eth_rss_reta_entry64 *reta_conf,
349 /**< @internal Query RSS redirection table on an Ethernet device */
351 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
352 struct rte_eth_rss_conf *rss_conf);
353 /**< @internal Update RSS hash configuration of an Ethernet device */
355 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
356 struct rte_eth_rss_conf *rss_conf);
357 /**< @internal Get current RSS hash configuration of an Ethernet device */
359 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
360 /**< @internal Turn on SW controllable LED on an Ethernet device */
362 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
363 /**< @internal Turn off SW controllable LED on an Ethernet device */
365 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
366 /**< @internal Remove MAC address from receive address register */
368 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
369 struct rte_ether_addr *mac_addr,
372 /**< @internal Set a MAC address into Receive Address Register */
374 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
375 struct rte_ether_addr *mac_addr);
376 /**< @internal Set a MAC address into Receive Address Register */
378 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
379 struct rte_ether_addr *mac_addr,
381 /**< @internal Set a Unicast Hash bitmap */
383 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
385 /**< @internal Set all Unicast Hash bitmap */
387 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
390 /**< @internal Set queue TX rate */
392 typedef int (*eth_mirror_rule_set_t)(struct rte_eth_dev *dev,
393 struct rte_eth_mirror_conf *mirror_conf,
396 /**< @internal Add a traffic mirroring rule on an Ethernet device */
398 typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
400 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
402 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
403 struct rte_eth_udp_tunnel *tunnel_udp);
404 /**< @internal Add tunneling UDP port */
406 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
407 struct rte_eth_udp_tunnel *tunnel_udp);
408 /**< @internal Delete tunneling UDP port */
410 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
411 struct rte_ether_addr *mc_addr_set,
412 uint32_t nb_mc_addr);
413 /**< @internal set the list of multicast addresses on an Ethernet device */
415 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
416 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
418 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
419 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
421 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
422 struct timespec *timestamp,
424 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
426 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
427 struct timespec *timestamp);
428 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
430 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
431 /**< @internal Function used to adjust the device clock */
433 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
434 struct timespec *timestamp);
435 /**< @internal Function used to get time from the device clock. */
437 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
438 const struct timespec *timestamp);
439 /**< @internal Function used to get time from the device clock */
441 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
442 uint64_t *timestamp);
443 /**< @internal Function used to get the current value of the device clock. */
445 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
446 struct rte_dev_reg_info *info);
447 /**< @internal Retrieve registers */
449 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
450 /**< @internal Retrieve eeprom size */
452 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
453 struct rte_dev_eeprom_info *info);
454 /**< @internal Retrieve eeprom data */
456 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
457 struct rte_dev_eeprom_info *info);
458 /**< @internal Program eeprom data */
460 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
461 struct rte_eth_dev_module_info *modinfo);
462 /**< @internal Retrieve type and size of plugin module eeprom */
464 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
465 struct rte_dev_eeprom_info *info);
466 /**< @internal Retrieve plugin module eeprom data */
468 typedef int (*eth_l2_tunnel_eth_type_conf_t)
469 (struct rte_eth_dev *dev, struct rte_eth_l2_tunnel_conf *l2_tunnel);
470 /**< @internal config l2 tunnel ether type */
472 typedef int (*eth_l2_tunnel_offload_set_t)
473 (struct rte_eth_dev *dev,
474 struct rte_eth_l2_tunnel_conf *l2_tunnel,
477 /**< @internal enable/disable the l2 tunnel offload functions */
480 typedef int (*eth_filter_ctrl_t)(struct rte_eth_dev *dev,
481 enum rte_filter_type filter_type,
482 enum rte_filter_op filter_op,
484 /**< @internal Take operations to assigned filter type on an Ethernet device */
486 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
487 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
489 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
490 /**< @internal Get Traffic Metering and Policing (MTR) operations */
492 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
493 struct rte_eth_dcb_info *dcb_info);
494 /**< @internal Get dcb information on an Ethernet device */
496 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
498 /**< @internal Test if a port supports specific mempool ops */
502 * Get the hairpin capabilities.
505 * ethdev handle of port.
507 * returns the hairpin capabilities from the device.
510 * Negative errno value on error, 0 on success.
513 * Success, hairpin is supported.
515 * Hairpin is not supported.
517 typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
518 struct rte_eth_hairpin_cap *cap);
522 * Setup RX hairpin queue.
525 * ethdev handle of port.
527 * the selected RX queue index.
529 * the requested number of descriptors for this queue. 0 - use PMD default.
531 * the RX hairpin configuration structure.
534 * Negative errno value on error, 0 on success.
537 * Success, hairpin is supported.
539 * Hairpin is not supported.
541 * One of the parameters is invalid.
543 * Unable to allocate resources.
545 typedef int (*eth_rx_hairpin_queue_setup_t)
546 (struct rte_eth_dev *dev, uint16_t rx_queue_id,
548 const struct rte_eth_hairpin_conf *conf);
552 * Setup TX hairpin queue.
555 * ethdev handle of port.
557 * the selected TX queue index.
559 * the requested number of descriptors for this queue. 0 - use PMD default.
561 * the TX hairpin configuration structure.
564 * Negative errno value on error, 0 on success.
567 * Success, hairpin is supported.
569 * Hairpin is not supported.
571 * One of the parameters is invalid.
573 * Unable to allocate resources.
575 typedef int (*eth_tx_hairpin_queue_setup_t)
576 (struct rte_eth_dev *dev, uint16_t tx_queue_id,
578 const struct rte_eth_hairpin_conf *hairpin_conf);
582 * Get Forward Error Correction(FEC) capability.
585 * ethdev handle of port.
586 * @param speed_fec_capa
587 * speed_fec_capa is out only with per-speed capabilities.
589 * a number of elements in an speed_fec_capa array.
592 * Negative errno value on error, positive value on success.
594 * @retval positive value
595 * A non-negative value lower or equal to num: success. The return value
596 * is the number of entries filled in the fec capa array.
597 * A non-negative value higher than num: error, the given fec capa array
598 * is too small. The return value corresponds to the num that should
599 * be given to succeed. The entries in the fec capa array are not valid
600 * and shall not be used by the caller.
602 * Operation is not supported.
606 * *num* or *speed_fec_capa* invalid.
608 typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
609 struct rte_eth_fec_capa *speed_fec_capa, unsigned int num);
613 * Get Forward Error Correction(FEC) mode.
616 * ethdev handle of port.
618 * a bitmask of enabled FEC modes. If AUTO bit is set, other
619 * bits specify FEC modes which may be negotiated. If AUTO
620 * bit is clear, specify FEC modes to be used (only one valid
621 * mode per speed may be set).
624 * Negative errno value on error, 0 on success.
627 * Success, get FEC success.
629 * Operation is not supported.
633 typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev,
638 * Set Forward Error Correction(FEC) mode.
641 * ethdev handle of port.
643 * bitmask of allowed FEC modes. It must be only one
644 * if AUTO is disabled. If AUTO is enabled, other
645 * bits specify FEC modes which may be negotiated.
648 * Negative errno value on error, 0 on success.
651 * Success, set FEC success.
653 * Operation is not supported.
655 * Unsupported FEC mode requested.
659 typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, uint32_t fec_capa);
663 * Get all hairpin Tx/Rx peer ports of the current device, if any.
666 * ethdev handle of port.
668 * array to save the ports list.
672 * value to decide the current to peer direction
673 * positive - used as Tx to get all peer Rx ports.
674 * zero - used as Rx to get all peer Tx ports.
677 * Negative errno value on error, 0 or positive on success.
680 * Success, no peer ports.
682 * Actual number of the peer ports.
684 * Get peer ports API is not supported.
686 * One of the parameters is invalid.
688 typedef int (*hairpin_get_peer_ports_t)(struct rte_eth_dev *dev,
689 uint16_t *peer_ports, size_t len,
694 * Bind all hairpin Tx queues of one port to the Rx queues of the peer port.
697 * ethdev handle of port.
702 * Negative errno value on error, 0 on success.
705 * Success, bind successfully.
707 * Bind API is not supported.
709 * One of the parameters is invalid.
711 * Device is not started.
713 typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
718 * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port.
721 * ethdev handle of port.
726 * Negative errno value on error, 0 on success.
729 * Success, unbind successfully.
731 * Bind API is not supported.
733 * One of the parameters is invalid.
735 * Device is already stopped.
737 typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
740 typedef int (*eth_hairpin_queue_peer_update_t)
741 (struct rte_eth_dev *dev, uint16_t peer_queue,
742 struct rte_hairpin_peer_info *current_info,
743 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
744 /**< @internal Update and fetch peer queue information. */
746 typedef int (*eth_hairpin_queue_peer_bind_t)
747 (struct rte_eth_dev *dev, uint16_t cur_queue,
748 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
749 /**< @internal Bind peer queue to the current queue with fetched information. */
751 typedef int (*eth_hairpin_queue_peer_unbind_t)
752 (struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
753 /**< @internal Unbind peer queue from the current queue. */
756 * @internal A structure containing the functions exported by an Ethernet driver.
759 eth_dev_configure_t dev_configure; /**< Configure device. */
760 eth_dev_start_t dev_start; /**< Start device. */
761 eth_dev_stop_t dev_stop; /**< Stop device. */
762 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
763 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
764 eth_dev_close_t dev_close; /**< Close device. */
765 eth_dev_reset_t dev_reset; /**< Reset device. */
766 eth_link_update_t link_update; /**< Get device link state. */
767 eth_is_removed_t is_removed;
768 /**< Check if the device was physically removed. */
770 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
771 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
772 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
773 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
774 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
775 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
776 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
777 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
778 mtu_set_t mtu_set; /**< Set MTU. */
780 eth_stats_get_t stats_get; /**< Get generic device statistics. */
781 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
782 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
783 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
784 eth_xstats_get_names_t xstats_get_names;
785 /**< Get names of extended statistics. */
786 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
787 /**< Configure per queue stat counter mapping. */
789 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
790 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
791 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
792 eth_burst_mode_get_t rx_burst_mode_get; /**< Get RX burst mode */
793 eth_burst_mode_get_t tx_burst_mode_get; /**< Get TX burst mode */
794 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
795 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
796 /**< Get packet types supported and identified by device. */
797 eth_dev_ptypes_set_t dev_ptypes_set;
798 /**< Inform Ethernet device about reduced range of packet types to handle. */
800 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
801 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
802 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
803 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
804 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
806 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
807 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
808 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
809 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
810 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
811 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
813 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
814 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
815 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
816 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
817 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
819 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
820 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
822 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
823 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
824 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
826 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
827 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
829 eth_mirror_rule_set_t mirror_rule_set; /**< Add a traffic mirror rule. */
830 eth_mirror_rule_reset_t mirror_rule_reset; /**< reset a traffic mirror rule. */
832 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
833 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
834 eth_l2_tunnel_eth_type_conf_t l2_tunnel_eth_type_conf;
835 /** Config ether type of l2 tunnel. */
836 eth_l2_tunnel_offload_set_t l2_tunnel_offload_set;
837 /** Enable/disable l2 tunnel offload functions. */
839 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
841 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
842 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
843 reta_update_t reta_update; /** Update redirection table. */
844 reta_query_t reta_query; /** Query redirection table. */
846 eth_get_reg_t get_reg; /**< Get registers. */
847 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
848 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
849 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
851 eth_get_module_info_t get_module_info;
852 /** Get plugin module eeprom attribute. */
853 eth_get_module_eeprom_t get_module_eeprom;
854 /** Get plugin module eeprom data. */
856 eth_filter_ctrl_t filter_ctrl; /**< common filter control. */
858 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
860 eth_timesync_enable_t timesync_enable;
861 /** Turn IEEE1588/802.1AS timestamping on. */
862 eth_timesync_disable_t timesync_disable;
863 /** Turn IEEE1588/802.1AS timestamping off. */
864 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
865 /** Read the IEEE1588/802.1AS RX timestamp. */
866 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
867 /** Read the IEEE1588/802.1AS TX timestamp. */
868 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
869 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
870 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
872 eth_read_clock read_clock;
874 eth_xstats_get_by_id_t xstats_get_by_id;
875 /**< Get extended device statistic values by ID. */
876 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
877 /**< Get name of extended device statistics by ID. */
879 eth_tm_ops_get_t tm_ops_get;
880 /**< Get Traffic Management (TM) operations. */
882 eth_mtr_ops_get_t mtr_ops_get;
883 /**< Get Traffic Metering and Policing (MTR) operations. */
885 eth_pool_ops_supported_t pool_ops_supported;
886 /**< Test if a port supports specific mempool ops */
888 eth_hairpin_cap_get_t hairpin_cap_get;
889 /**< Returns the hairpin capabilities. */
890 eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
891 /**< Set up device RX hairpin queue. */
892 eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
893 /**< Set up device TX hairpin queue. */
895 eth_fec_get_capability_t fec_get_capability;
896 /**< Get Forward Error Correction(FEC) capability. */
897 eth_fec_get_t fec_get;
898 /**< Get Forward Error Correction(FEC) mode. */
899 eth_fec_set_t fec_set;
900 /**< Set Forward Error Correction(FEC) mode. */
901 hairpin_get_peer_ports_t hairpin_get_peer_ports;
902 /**< Get hairpin peer ports list. */
903 eth_hairpin_bind_t hairpin_bind;
904 /**< Bind all hairpin Tx queues of device to the peer port Rx queues. */
905 eth_hairpin_unbind_t hairpin_unbind;
906 /**< Unbind all hairpin Tx queues from the peer port Rx queues. */
907 eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
908 /**< Pass the current queue info and get the peer queue info. */
909 eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
910 /**< Set up the connection between the pair of hairpin queues. */
911 eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
912 /**< Disconnect the hairpin queues of a pair from each other. */
918 #define RTE_ETH_QUEUE_STATE_STOPPED 0
919 #define RTE_ETH_QUEUE_STATE_STARTED 1
920 #define RTE_ETH_QUEUE_STATE_HAIRPIN 2
924 * Check if the selected Rx queue is hairpin queue.
927 * Pointer to the selected device.
929 * The selected queue.
932 * - (1) if the queue is hairpin queue, 0 otherwise.
935 int rte_eth_dev_is_rx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
939 * Check if the selected Tx queue is hairpin queue.
942 * Pointer to the selected device.
944 * The selected queue.
947 * - (1) if the queue is hairpin queue, 0 otherwise.
950 int rte_eth_dev_is_tx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
954 * Returns a ethdev slot specified by the unique identifier name.
957 * The pointer to the Unique identifier name for each Ethernet device
959 * - The pointer to the ethdev slot, on success. NULL on error
962 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
966 * Allocates a new ethdev slot for an ethernet device and returns the pointer
967 * to that slot for the driver to use.
969 * @param name Unique identifier name for each Ethernet device
971 * - Slot in the rte_dev_devices array for a new device;
974 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
978 * Attach to the ethdev already initialized by the primary
981 * @param name Ethernet device's name.
983 * - Success: Slot in the rte_dev_devices array for attached
985 * - Error: Null pointer.
988 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
992 * Notify RTE_ETH_EVENT_DESTROY and release the specified ethdev port.
994 * The following PMD-managed data fields will be freed:
998 * If one of these fields should not be freed,
999 * it must be reset to NULL by the PMD, typically in dev_close method.
1002 * Device to be detached.
1004 * - 0 on success, negative on error
1007 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1011 * Release device queues and clear its configuration to force the user
1012 * application to reconfigure it. It is for internal use only.
1015 * Pointer to struct rte_eth_dev.
1021 void rte_eth_dev_internal_reset(struct rte_eth_dev *dev);
1024 * @internal Executes all the user application registered callbacks for
1025 * the specific device. It is for DPDK internal user only. User
1026 * application should not call it directly.
1029 * Pointer to struct rte_eth_dev.
1031 * Eth device interrupt event type.
1033 * To pass data back to user application.
1034 * This allows the user application to decide if a particular function
1035 * is permitted or not.
1041 int rte_eth_dev_callback_process(struct rte_eth_dev *dev,
1042 enum rte_eth_event_type event, void *ret_param);
1046 * This is the last step of device probing.
1047 * It must be called after a port is allocated and initialized successfully.
1049 * The notification RTE_ETH_EVENT_NEW is sent to other entities
1050 * (libraries and applications).
1051 * The state is set as RTE_ETH_DEV_ATTACHED.
1057 void rte_eth_dev_probing_finish(struct rte_eth_dev *dev);
1060 * Create memzone for HW rings.
1061 * malloc can't be used as the physical address is needed.
1062 * If the memzone is already created, then this function returns a ptr
1066 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1068 * The name of the memory zone
1070 * The index of the queue to add to name
1072 * The sizeof of the memory area
1074 * Alignment for resulting memzone. Must be a power of 2.
1076 * The *socket_id* argument is the socket identifier in case of NUMA.
1079 const struct rte_memzone *
1080 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
1081 uint16_t queue_id, size_t size,
1082 unsigned align, int socket_id);
1085 * Free previously allocated memzone for HW rings.
1088 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1090 * The name of the memory zone
1092 * The index of the queue to add to name
1094 * Negative errno value on error, 0 on success.
1098 rte_eth_dma_zone_free(const struct rte_eth_dev *eth_dev, const char *name,
1103 * Atomically set the link status for the specific device.
1104 * It is for use by DPDK device driver use only.
1105 * User applications should not call it
1108 * Pointer to struct rte_eth_dev.
1110 * New link status value.
1112 * Same convention as eth_link_update operation.
1113 * 0 if link up status has changed
1114 * -1 if link up status was unchanged
1117 rte_eth_linkstatus_set(struct rte_eth_dev *dev,
1118 const struct rte_eth_link *new_link)
1120 uint64_t *dev_link = (uint64_t *)&(dev->data->dev_link);
1123 struct rte_eth_link link;
1126 RTE_BUILD_BUG_ON(sizeof(*new_link) != sizeof(uint64_t));
1128 orig.val64 = __atomic_exchange_n(dev_link, *(const uint64_t *)new_link,
1131 return (orig.link.link_status == new_link->link_status) ? -1 : 0;
1136 * Atomically get the link speed and status.
1139 * Pointer to struct rte_eth_dev.
1141 * link status value.
1144 rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
1145 struct rte_eth_link *link)
1147 uint64_t *src = (uint64_t *)&(dev->data->dev_link);
1148 uint64_t *dst = (uint64_t *)link;
1150 RTE_BUILD_BUG_ON(sizeof(*link) != sizeof(uint64_t));
1152 *dst = __atomic_load_n(src, __ATOMIC_SEQ_CST);
1156 * Allocate an unique switch domain identifier.
1158 * A pool of switch domain identifiers which can be allocated on request. This
1159 * will enabled devices which support the concept of switch domains to request
1160 * a switch domain id which is guaranteed to be unique from other devices
1161 * running in the same process.
1164 * switch domain identifier parameter to pass back to application
1167 * Negative errno value on error, 0 on success.
1171 rte_eth_switch_domain_alloc(uint16_t *domain_id);
1174 * Free switch domain.
1176 * Return a switch domain identifier to the pool of free identifiers after it is
1177 * no longer in use by device.
1180 * switch domain identifier to free
1183 * Negative errno value on error, 0 on success.
1187 rte_eth_switch_domain_free(uint16_t domain_id);
1189 /** Generic Ethernet device arguments */
1190 struct rte_eth_devargs {
1191 uint16_t ports[RTE_MAX_ETHPORTS];
1192 /** port/s number to enable on a multi-port single function */
1194 /** number of ports in ports field */
1195 uint16_t representor_ports[RTE_MAX_ETHPORTS];
1196 /** representor port/s identifier to enable on device */
1197 uint16_t nb_representor_ports;
1198 /** number of ports in representor port field */
1202 * PMD helper function to parse ethdev arguments
1206 * @param eth_devargs
1207 * parsed ethdev specific arguments.
1210 * Negative errno value on error, 0 on success.
1214 rte_eth_devargs_parse(const char *devargs, struct rte_eth_devargs *eth_devargs);
1217 typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
1218 typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
1219 void *bus_specific_init_params);
1222 * PMD helper function for the creation of a new ethdev ports.
1225 * rte_device handle.
1228 * @param priv_data_size
1229 * size of private data required for port.
1230 * @param bus_specific_init
1231 * port bus specific initialisation callback function
1232 * @param bus_init_params
1233 * port bus specific initialisation parameters
1234 * @param ethdev_init
1235 * device specific port initialization callback function
1236 * @param init_params
1237 * port initialisation parameters
1240 * Negative errno value on error, 0 on success.
1244 rte_eth_dev_create(struct rte_device *device, const char *name,
1245 size_t priv_data_size,
1246 ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
1247 ethdev_init_t ethdev_init, void *init_params);
1250 typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);
1253 * PMD helper function for cleaning up the resources of a ethdev port on it's
1257 * ethdev handle of port.
1258 * @param ethdev_uninit
1259 * device specific port un-initialise callback function
1262 * Negative errno value on error, 0 on success.
1266 rte_eth_dev_destroy(struct rte_eth_dev *ethdev, ethdev_uninit_t ethdev_uninit);
1270 * Pass the current hairpin queue HW and/or SW information to the peer queue
1271 * and fetch back the information of the peer queue.
1274 * Peer port identifier of the Ethernet device.
1276 * Peer queue index of the port.
1278 * Pointer to the current information structure.
1280 * Pointer to the peer information, output.
1282 * Direction to pass the information.
1283 * positive - pass Tx queue information and get peer Rx queue information
1284 * zero - pass Rx queue information and get peer Tx queue information
1287 * Negative errno value on error, 0 on success.
1291 rte_eth_hairpin_queue_peer_update(uint16_t peer_port, uint16_t peer_queue,
1292 struct rte_hairpin_peer_info *cur_info,
1293 struct rte_hairpin_peer_info *peer_info,
1294 uint32_t direction);
1298 * Configure current hairpin queue with the peer information fetched to create
1299 * the connection (bind) with peer queue in the specified direction.
1300 * This function might need to be called twice to fully create the connections.
1303 * Current port identifier of the Ethernet device.
1305 * Current queue index of the port.
1307 * Pointer to the peer information, input.
1309 * Direction to create the connection.
1310 * positive - bind current Tx queue to peer Rx queue
1311 * zero - bind current Rx queue to peer Tx queue
1314 * Negative errno value on error, 0 on success.
1318 rte_eth_hairpin_queue_peer_bind(uint16_t cur_port, uint16_t cur_queue,
1319 struct rte_hairpin_peer_info *peer_info,
1320 uint32_t direction);
1324 * Reset the current queue state and configuration to disconnect (unbind) it
1325 * from the peer queue.
1326 * This function might need to be called twice to disconnect each other.
1329 * Current port identifier of the Ethernet device.
1331 * Current queue index of the port.
1333 * Direction to destroy the connection.
1334 * positive - unbind current Tx queue from peer Rx queue
1335 * zero - unbind current Rx queue from peer Tx queue
1338 * Negative errno value on error, 0 on success.
1342 rte_eth_hairpin_queue_peer_unbind(uint16_t cur_port, uint16_t cur_queue,
1343 uint32_t direction);
1349 #endif /* _RTE_ETHDEV_DRIVER_H_ */