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_
15 * RTE Ethernet Device PMD API
17 * These APIs for the use from Ethernet drivers, user applications shouldn't
22 #include <rte_ethdev.h>
26 * Structure used to hold information about the callbacks to be called for a
29 struct rte_eth_rxtx_callback {
30 struct rte_eth_rxtx_callback *next;
32 rte_rx_callback_fn rx;
33 rte_tx_callback_fn tx;
40 * The generic data structure associated with each Ethernet device.
42 * Pointers to burst-oriented packet receive and transmit functions are
43 * located at the beginning of the structure, along with the pointer to
44 * where all the data elements for the particular device are stored in shared
45 * memory. This split allows the function pointer and driver data to be per-
46 * process, while the actual configuration data for the device is shared.
49 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function */
50 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function */
52 /** Pointer to PMD transmit prepare function */
53 eth_tx_prep_t tx_pkt_prepare;
54 /** Get the number of used Rx descriptors */
55 eth_rx_queue_count_t rx_queue_count;
56 /** Check the status of a Rx descriptor */
57 eth_rx_descriptor_status_t rx_descriptor_status;
58 /** Check the status of a Tx descriptor */
59 eth_tx_descriptor_status_t tx_descriptor_status;
62 * Device data that is shared between primary and secondary processes
64 struct rte_eth_dev_data *data;
65 void *process_private; /**< Pointer to per-process device data */
66 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
67 struct rte_device *device; /**< Backing device */
68 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
70 /** User application callbacks for NIC interrupts */
71 struct rte_eth_dev_cb_list link_intr_cbs;
73 * User-supplied functions called from rx_burst to post-process
74 * received packets before passing them to the user
76 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
78 * User-supplied functions called from tx_burst to pre-process
79 * received packets before passing them to the driver for transmission
81 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
83 enum rte_eth_dev_state state; /**< Flag indicating the port state */
84 void *security_ctx; /**< Context for security ops */
85 } __rte_cache_aligned;
87 struct rte_eth_dev_sriov;
88 struct rte_eth_dev_owner;
92 * The data part, with no function pointers, associated with each Ethernet
93 * device. This structure is safe to place in shared memory to be common
94 * among different processes in a multi-process configuration.
96 struct rte_eth_dev_data {
97 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
99 void **rx_queues; /**< Array of pointers to Rx queues */
100 void **tx_queues; /**< Array of pointers to Tx queues */
101 uint16_t nb_rx_queues; /**< Number of Rx queues */
102 uint16_t nb_tx_queues; /**< Number of Tx queues */
104 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
106 /** PMD-specific private data. @see rte_eth_dev_release_port() */
109 struct rte_eth_link dev_link; /**< Link-level information & status */
110 struct rte_eth_conf dev_conf; /**< Configuration applied to device */
111 uint16_t mtu; /**< Maximum Transmission Unit */
113 /** Common Rx buffer size handled by all queues */
114 uint32_t min_rx_buf_size;
116 uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures */
118 /** Device Ethernet link address. @see rte_eth_dev_release_port() */
119 struct rte_ether_addr *mac_addrs;
120 /** Bitmap associating MAC addresses to pools */
121 uint64_t mac_pool_sel[RTE_ETH_NUM_RECEIVE_MAC_ADDR];
123 * Device Ethernet MAC addresses of hash filtering.
124 * @see rte_eth_dev_release_port()
126 struct rte_ether_addr *hash_mac_addrs;
128 uint16_t port_id; /**< Device [external] port identifier */
131 uint8_t /** Rx promiscuous mode ON(1) / OFF(0) */
133 /** Rx of scattered packets is ON(1) / OFF(0) */
135 /** Rx all multicast mode ON(1) / OFF(0) */
137 /** Device state: STARTED(1) / STOPPED(0) */
139 /** Rx LRO is ON(1) / OFF(0) */
142 * Indicates whether the device is configured:
143 * CONFIGURED(1) / NOT CONFIGURED(0)
147 /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
148 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
149 /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
150 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
152 uint32_t dev_flags; /**< Capabilities */
153 int numa_node; /**< NUMA node connection */
155 /** VLAN filter configuration */
156 struct rte_vlan_filter_conf vlan_filter_conf;
158 struct rte_eth_dev_owner owner; /**< The port owner */
161 * Switch-specific identifier.
162 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
164 uint16_t representor_id;
166 * Port ID of the backing device.
167 * This device will be used to query representor info and calculate
168 * representor IDs. Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
170 uint16_t backer_port_id;
172 pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex */
173 } __rte_cache_aligned;
177 * The pool of *rte_eth_dev* structures. The size of the pool
178 * is configured at compile-time in the <rte_ethdev.c> file.
180 extern struct rte_eth_dev rte_eth_devices[];
182 /** @internal Declaration of the hairpin peer queue information structure. */
183 struct rte_hairpin_peer_info;
186 * Definitions of all functions exported by an Ethernet driver through the
187 * generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
188 * structure associated with an Ethernet device.
191 /** @internal Ethernet device configuration. */
192 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
194 /** @internal Function used to start a configured Ethernet device. */
195 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
197 /** @internal Function used to stop a configured Ethernet device. */
198 typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
200 /** @internal Function used to link up a configured Ethernet device. */
201 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
203 /** @internal Function used to link down a configured Ethernet device. */
204 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
206 /** @internal Function used to close a configured Ethernet device. */
207 typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
209 /** @internal Function used to reset a configured Ethernet device. */
210 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
212 /** @internal Function used to detect an Ethernet device removal. */
213 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
217 * Function used to enable the Rx promiscuous mode of an Ethernet device.
220 * ethdev handle of port.
223 * Negative errno value on error, 0 on success.
226 * Success, promiscuous mode is enabled.
228 * Promiscuous mode is not supported.
231 * @retval -E_RTE_SECONDARY
232 * Function was called from a secondary process instance and not supported.
234 * Attempt to enable promiscuous mode failed because of timeout.
236 * Failed to enable promiscuous mode.
238 typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
242 * Function used to disable the Rx promiscuous mode of an Ethernet device.
245 * ethdev handle of port.
248 * Negative errno value on error, 0 on success.
251 * Success, promiscuous mode is disabled.
253 * Promiscuous mode disabling is not supported.
256 * @retval -E_RTE_SECONDARY
257 * Function was called from a secondary process instance and not supported.
259 * Attempt to disable promiscuous mode failed because of timeout.
261 * Failed to disable promiscuous mode.
263 typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
267 * Enable the receipt of all multicast packets by an Ethernet device.
270 * ethdev handle of port.
273 * Negative errno value on error, 0 on success.
276 * Success, all-multicast mode is enabled.
278 * All-multicast mode is not supported.
281 * @retval -E_RTE_SECONDARY
282 * Function was called from a secondary process instance and not supported.
284 * Attempt to enable all-multicast mode failed because of timeout.
286 * Failed to enable all-multicast mode.
288 typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
292 * Disable the receipt of all multicast packets by an Ethernet device.
295 * ethdev handle of port.
298 * Negative errno value on error, 0 on success.
301 * Success, all-multicast mode is disabled.
303 * All-multicast mode disabling is not supported.
306 * @retval -E_RTE_SECONDARY
307 * Function was called from a secondary process instance and not supported.
309 * Attempt to disable all-multicast mode failed because of timeout.
311 * Failed to disable all-multicast mode.
313 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
317 * Get link speed, duplex mode and state (up/down) of an Ethernet device.
319 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
320 int wait_to_complete);
322 /** @internal Get global I/O statistics of an Ethernet device. */
323 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
324 struct rte_eth_stats *igb_stats);
328 * Reset global I/O statistics of an Ethernet device to 0.
331 * ethdev handle of port.
334 * Negative errno value on error, 0 on success.
337 * Success, statistics has been reset.
339 * Resetting statistics is not supported.
341 * Resetting statistics is not valid.
343 * Not enough memory to get the stats.
345 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
347 /** @internal Get extended stats of an Ethernet device. */
348 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
349 struct rte_eth_xstat *stats, unsigned int n);
353 * Get extended stats of an Ethernet device.
356 * ethdev handle of port.
358 * IDs array to retrieve specific statistics. Must not be NULL.
360 * A pointer to a table to be filled with device statistics values.
363 * Element count in @p ids and @p values.
366 * - A number of filled in stats.
367 * - A negative value on error.
369 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
376 * Reset extended stats of an Ethernet device.
379 * ethdev handle of port.
382 * Negative errno value on error, 0 on success.
385 * Success, statistics has been reset.
387 * Resetting statistics is not supported.
389 * Resetting statistics is not valid.
391 * Not enough memory to get the stats.
393 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
395 /** @internal Get names of extended stats of an Ethernet device. */
396 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
397 struct rte_eth_xstat_name *xstats_names, unsigned int size);
401 * Get names of extended stats of an Ethernet device.
404 * ethdev handle of port.
406 * IDs array to retrieve specific statistics. Must not be NULL.
407 * @param xstats_names
408 * An rte_eth_xstat_name array of at least @p size elements to be filled.
411 * Element count in @p ids and @p xstats_names.
414 * - A number of filled in stats.
415 * - A negative value on error.
417 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
418 const uint64_t *ids, struct rte_eth_xstat_name *xstats_names,
423 * Set a queue statistics mapping for a Tx/Rx queue of an Ethernet device.
425 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
430 /** @internal Get specific information of an Ethernet device. */
431 typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
432 struct rte_eth_dev_info *dev_info);
434 /** @internal Get supported ptypes of an Ethernet device. */
435 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
439 * Inform Ethernet device about reduced range of packet types to handle.
442 * The Ethernet device identifier.
444 * The ptype family that application is interested in should be bitwise OR of
445 * RTE_PTYPE_*_MASK or 0.
449 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
450 uint32_t ptype_mask);
452 /** @internal Start Rx and Tx of a queue of an Ethernet device. */
453 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
456 /** @internal Stop Rx and Tx of a queue of an Ethernet device. */
457 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
460 /** @internal Set up a receive queue of an Ethernet device. */
461 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
462 uint16_t rx_queue_id,
464 unsigned int socket_id,
465 const struct rte_eth_rxconf *rx_conf,
466 struct rte_mempool *mb_pool);
468 /** @internal Setup a transmit queue of an Ethernet device. */
469 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
470 uint16_t tx_queue_id,
472 unsigned int socket_id,
473 const struct rte_eth_txconf *tx_conf);
475 /** @internal Enable interrupt of a receive queue of an Ethernet device. */
476 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
477 uint16_t rx_queue_id);
479 /** @internal Disable interrupt of a receive queue of an Ethernet device. */
480 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
481 uint16_t rx_queue_id);
483 /** @internal Release memory resources allocated by given Rx/Tx queue. */
484 typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
487 /** @internal Get firmware information of an Ethernet device. */
488 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
489 char *fw_version, size_t fw_size);
491 /** @internal Force mbufs to be from Tx ring. */
492 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
494 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
495 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
497 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
498 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
500 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
501 uint16_t queue_id, struct rte_eth_burst_mode *mode);
503 /** @internal Set MTU. */
504 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
506 /** @internal Filtering of a VLAN Tag Identifier by an Ethernet device. */
507 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
511 /** @internal Set the outer/inner VLAN-TPID by an Ethernet device. */
512 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
513 enum rte_vlan_type type, uint16_t tpid);
515 /** @internal Set VLAN offload function by an Ethernet device. */
516 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
518 /** @internal Set port based Tx VLAN insertion by an Ethernet device. */
519 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
523 /** @internal VLAN stripping enable/disable by an queue of Ethernet device. */
524 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
525 uint16_t rx_queue_id,
528 /** @internal Get current flow control parameter on an Ethernet device. */
529 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
530 struct rte_eth_fc_conf *fc_conf);
532 /** @internal Setup flow control parameter on an Ethernet device. */
533 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
534 struct rte_eth_fc_conf *fc_conf);
536 /** @internal Setup priority flow control parameter on an Ethernet device. */
537 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
538 struct rte_eth_pfc_conf *pfc_conf);
540 /** @internal Get info for queue based PFC on an Ethernet device. */
541 typedef int (*priority_flow_ctrl_queue_info_get_t)(struct rte_eth_dev *dev,
542 struct rte_eth_pfc_queue_info *pfc_queue_info);
543 /** @internal Configure queue based PFC parameter on an Ethernet device. */
544 typedef int (*priority_flow_ctrl_queue_config_t)(struct rte_eth_dev *dev,
545 struct rte_eth_pfc_queue_conf *pfc_queue_conf);
547 /** @internal Update RSS redirection table on an Ethernet device. */
548 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
549 struct rte_eth_rss_reta_entry64 *reta_conf,
552 /** @internal Query RSS redirection table on an Ethernet device. */
553 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
554 struct rte_eth_rss_reta_entry64 *reta_conf,
557 /** @internal Update RSS hash configuration of an Ethernet device. */
558 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
559 struct rte_eth_rss_conf *rss_conf);
561 /** @internal Get current RSS hash configuration of an Ethernet device. */
562 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
563 struct rte_eth_rss_conf *rss_conf);
565 /** @internal Turn on SW controllable LED on an Ethernet device. */
566 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
568 /** @internal Turn off SW controllable LED on an Ethernet device. */
569 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
571 /** @internal Remove MAC address from receive address register. */
572 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
574 /** @internal Set a MAC address into Receive Address Register. */
575 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
576 struct rte_ether_addr *mac_addr,
580 /** @internal Set a MAC address into Receive Address Register. */
581 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
582 struct rte_ether_addr *mac_addr);
584 /** @internal Set a Unicast Hash bitmap. */
585 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
586 struct rte_ether_addr *mac_addr,
589 /** @internal Set all Unicast Hash bitmap. */
590 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
593 /** @internal Set queue Tx rate. */
594 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
598 /** @internal Add tunneling UDP port. */
599 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
600 struct rte_eth_udp_tunnel *tunnel_udp);
602 /** @internal Delete tunneling UDP port. */
603 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
604 struct rte_eth_udp_tunnel *tunnel_udp);
606 /** @internal set the list of multicast addresses on an Ethernet device. */
607 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
608 struct rte_ether_addr *mc_addr_set,
609 uint32_t nb_mc_addr);
611 /** @internal Function used to enable IEEE1588/802.1AS timestamping. */
612 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
614 /** @internal Function used to disable IEEE1588/802.1AS timestamping. */
615 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
617 /** @internal Function used to read an Rx IEEE1588/802.1AS timestamp. */
618 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
619 struct timespec *timestamp,
622 /** @internal Function used to read a Tx IEEE1588/802.1AS timestamp. */
623 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
624 struct timespec *timestamp);
626 /** @internal Function used to adjust the device clock. */
627 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
629 /** @internal Function used to get time from the device clock. */
630 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
631 struct timespec *timestamp);
633 /** @internal Function used to get time from the device clock. */
634 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
635 const struct timespec *timestamp);
637 /** @internal Function used to get the current value of the device clock. */
638 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
639 uint64_t *timestamp);
641 /** @internal Retrieve registers. */
642 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
643 struct rte_dev_reg_info *info);
645 /** @internal Retrieve EEPROM size. */
646 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
648 /** @internal Retrieve EEPROM data. */
649 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
650 struct rte_dev_eeprom_info *info);
652 /** @internal Program EEPROM data. */
653 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
654 struct rte_dev_eeprom_info *info);
656 /** @internal Retrieve type and size of plugin module EEPROM. */
657 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
658 struct rte_eth_dev_module_info *modinfo);
660 /** @internal Retrieve plugin module EEPROM data. */
661 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
662 struct rte_dev_eeprom_info *info);
667 * Get flow operations.
669 * If the flow API is not supported for the specified device,
670 * the driver can return NULL.
672 typedef int (*eth_flow_ops_get_t)(struct rte_eth_dev *dev,
673 const struct rte_flow_ops **ops);
675 /** @internal Get Traffic Management (TM) operations on an Ethernet device. */
676 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
678 /** @internal Get Traffic Metering and Policing (MTR) operations. */
679 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
681 /** @internal Get DCB information on an Ethernet device. */
682 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
683 struct rte_eth_dcb_info *dcb_info);
685 /** @internal Test if a port supports specific mempool ops. */
686 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
691 * Get the hairpin capabilities.
694 * ethdev handle of port.
696 * returns the hairpin capabilities from the device.
699 * Negative errno value on error, 0 on success.
702 * Success, hairpin is supported.
704 * Hairpin is not supported.
706 typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
707 struct rte_eth_hairpin_cap *cap);
711 * Setup Rx hairpin queue.
714 * ethdev handle of port.
716 * the selected Rx queue index.
718 * the requested number of descriptors for this queue. 0 - use PMD default.
720 * the Rx hairpin configuration structure.
723 * Negative errno value on error, 0 on success.
726 * Success, hairpin is supported.
728 * Hairpin is not supported.
730 * One of the parameters is invalid.
732 * Unable to allocate resources.
734 typedef int (*eth_rx_hairpin_queue_setup_t)
735 (struct rte_eth_dev *dev, uint16_t rx_queue_id,
737 const struct rte_eth_hairpin_conf *conf);
741 * Setup Tx hairpin queue.
744 * ethdev handle of port.
746 * the selected Tx queue index.
748 * the requested number of descriptors for this queue. 0 - use PMD default.
750 * the Tx hairpin configuration structure.
753 * Negative errno value on error, 0 on success.
756 * Success, hairpin is supported.
758 * Hairpin is not supported.
760 * One of the parameters is invalid.
762 * Unable to allocate resources.
764 typedef int (*eth_tx_hairpin_queue_setup_t)
765 (struct rte_eth_dev *dev, uint16_t tx_queue_id,
767 const struct rte_eth_hairpin_conf *hairpin_conf);
771 * Get Forward Error Correction(FEC) capability.
774 * ethdev handle of port.
775 * @param speed_fec_capa
776 * speed_fec_capa is out only with per-speed capabilities.
778 * a number of elements in an speed_fec_capa array.
781 * Negative errno value on error, positive value on success.
783 * @retval positive value
784 * A non-negative value lower or equal to num: success. The return value
785 * is the number of entries filled in the fec capa array.
786 * A non-negative value higher than num: error, the given fec capa array
787 * is too small. The return value corresponds to the num that should
788 * be given to succeed. The entries in the fec capa array are not valid
789 * and shall not be used by the caller.
791 * Operation is not supported.
795 * *num* or *speed_fec_capa* invalid.
797 typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
798 struct rte_eth_fec_capa *speed_fec_capa, unsigned int num);
802 * Get Forward Error Correction(FEC) mode.
805 * ethdev handle of port.
807 * a bitmask of enabled FEC modes. If AUTO bit is set, other
808 * bits specify FEC modes which may be negotiated. If AUTO
809 * bit is clear, specify FEC modes to be used (only one valid
810 * mode per speed may be set).
813 * Negative errno value on error, 0 on success.
816 * Success, get FEC success.
818 * Operation is not supported.
822 typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev,
827 * Set Forward Error Correction(FEC) mode.
830 * ethdev handle of port.
832 * bitmask of allowed FEC modes. It must be only one
833 * if AUTO is disabled. If AUTO is enabled, other
834 * bits specify FEC modes which may be negotiated.
837 * Negative errno value on error, 0 on success.
840 * Success, set FEC success.
842 * Operation is not supported.
844 * Unsupported FEC mode requested.
848 typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, uint32_t fec_capa);
852 * Get all hairpin Tx/Rx peer ports of the current device, if any.
855 * ethdev handle of port.
857 * array to save the ports list.
861 * value to decide the current to peer direction
862 * positive - used as Tx to get all peer Rx ports.
863 * zero - used as Rx to get all peer Tx ports.
866 * Negative errno value on error, 0 or positive on success.
869 * Success, no peer ports.
871 * Actual number of the peer ports.
873 * Get peer ports API is not supported.
875 * One of the parameters is invalid.
877 typedef int (*hairpin_get_peer_ports_t)(struct rte_eth_dev *dev,
878 uint16_t *peer_ports, size_t len,
883 * Bind all hairpin Tx queues of one port to the Rx queues of the peer port.
886 * ethdev handle of port.
891 * Negative errno value on error, 0 on success.
894 * Success, bind successfully.
896 * Bind API is not supported.
898 * One of the parameters is invalid.
900 * Device is not started.
902 typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
907 * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port.
910 * ethdev handle of port.
915 * Negative errno value on error, 0 on success.
918 * Success, unbind successfully.
920 * Bind API is not supported.
922 * One of the parameters is invalid.
924 * Device is already stopped.
926 typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
929 /** @internal Update and fetch peer queue information. */
930 typedef int (*eth_hairpin_queue_peer_update_t)
931 (struct rte_eth_dev *dev, uint16_t peer_queue,
932 struct rte_hairpin_peer_info *current_info,
933 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
935 /** @internal Bind peer queue to the current queue with fetched information. */
936 typedef int (*eth_hairpin_queue_peer_bind_t)
937 (struct rte_eth_dev *dev, uint16_t cur_queue,
938 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
940 /** @internal Unbind peer queue from the current queue. */
941 typedef int (*eth_hairpin_queue_peer_unbind_t)
942 (struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
946 * Get address of memory location whose contents will change whenever there is
947 * new data to be received on an Rx queue.
950 * Ethdev queue pointer.
952 * The pointer to power-optimized monitoring condition structure.
954 * Negative errno value on error, 0 on success.
961 typedef int (*eth_get_monitor_addr_t)(void *rxq,
962 struct rte_power_monitor_cond *pmc);
966 * Get representor info to be able to calculate the unique representor ID.
968 * Caller should pass NULL as pointer of info to get number of entries,
969 * allocate info buffer according to returned entry number, then call
970 * again with buffer to get real info.
972 * To calculate the representor ID, caller should iterate each entry,
973 * match controller index, pf index, vf or sf start index and range,
974 * then calculate representor ID from offset to vf/sf start index.
975 * @see rte_eth_representor_id_get.
978 * Ethdev handle of port.
980 * Pointer to memory to save device representor info.
982 * Negative errno value on error, number of info entries otherwise.
985 typedef int (*eth_representor_info_get_t)(struct rte_eth_dev *dev,
986 struct rte_eth_representor_info *info);
990 * Negotiate the NIC's ability to deliver specific kinds of metadata to the PMD.
993 * Port (ethdev) handle
995 * @param[inout] features
996 * Feature selection buffer
999 * Negative errno value on error, zero otherwise
1001 typedef int (*eth_rx_metadata_negotiate_t)(struct rte_eth_dev *dev,
1002 uint64_t *features);
1006 * Get IP reassembly offload capability of a PMD.
1009 * Port (ethdev) handle
1012 * IP reassembly capability supported by the PMD
1015 * Negative errno value on error, zero otherwise
1017 typedef int (*eth_ip_reassembly_capability_get_t)(struct rte_eth_dev *dev,
1018 struct rte_eth_ip_reassembly_params *capa);
1022 * Get IP reassembly offload configuration parameters set in PMD.
1025 * Port (ethdev) handle
1028 * Configuration parameters for IP reassembly.
1031 * Negative errno value on error, zero otherwise
1033 typedef int (*eth_ip_reassembly_conf_get_t)(struct rte_eth_dev *dev,
1034 struct rte_eth_ip_reassembly_params *conf);
1038 * Set configuration parameters for enabling IP reassembly offload in hardware.
1041 * Port (ethdev) handle
1044 * Configuration parameters for IP reassembly.
1047 * Negative errno value on error, zero otherwise
1049 typedef int (*eth_ip_reassembly_conf_set_t)(struct rte_eth_dev *dev,
1050 const struct rte_eth_ip_reassembly_params *conf);
1054 * Dump private info from device to a file.
1057 * Port (ethdev) handle.
1059 * A pointer to a file for output.
1062 * Negative value on error, 0 on success.
1069 typedef int (*eth_dev_priv_dump_t)(struct rte_eth_dev *dev, FILE *file);
1072 * @internal A structure containing the functions exported by an Ethernet driver.
1074 struct eth_dev_ops {
1075 eth_dev_configure_t dev_configure; /**< Configure device */
1076 eth_dev_start_t dev_start; /**< Start device */
1077 eth_dev_stop_t dev_stop; /**< Stop device */
1078 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up */
1079 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down */
1080 eth_dev_close_t dev_close; /**< Close device */
1081 eth_dev_reset_t dev_reset; /**< Reset device */
1082 eth_link_update_t link_update; /**< Get device link state */
1083 /** Check if the device was physically removed */
1084 eth_is_removed_t is_removed;
1086 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON */
1087 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF */
1088 eth_allmulticast_enable_t allmulticast_enable;/**< Rx multicast ON */
1089 eth_allmulticast_disable_t allmulticast_disable;/**< Rx multicast OFF */
1090 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address */
1091 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address */
1092 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address */
1093 /** Set list of multicast addresses */
1094 eth_set_mc_addr_list_t set_mc_addr_list;
1095 mtu_set_t mtu_set; /**< Set MTU */
1097 /** Get generic device statistics */
1098 eth_stats_get_t stats_get;
1099 /** Reset generic device statistics */
1100 eth_stats_reset_t stats_reset;
1101 /** Get extended device statistics */
1102 eth_xstats_get_t xstats_get;
1103 /** Reset extended device statistics */
1104 eth_xstats_reset_t xstats_reset;
1105 /** Get names of extended statistics */
1106 eth_xstats_get_names_t xstats_get_names;
1107 /** Configure per queue stat counter mapping */
1108 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1110 eth_dev_infos_get_t dev_infos_get; /**< Get device info */
1111 /** Retrieve Rx queue information */
1112 eth_rxq_info_get_t rxq_info_get;
1113 /** Retrieve Tx queue information */
1114 eth_txq_info_get_t txq_info_get;
1115 eth_burst_mode_get_t rx_burst_mode_get; /**< Get Rx burst mode */
1116 eth_burst_mode_get_t tx_burst_mode_get; /**< Get Tx burst mode */
1117 eth_fw_version_get_t fw_version_get; /**< Get firmware version */
1119 /** Get packet types supported and identified by device */
1120 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1122 * Inform Ethernet device about reduced range of packet types to
1125 eth_dev_ptypes_set_t dev_ptypes_set;
1127 /** Filter VLAN Setup */
1128 vlan_filter_set_t vlan_filter_set;
1129 /** Outer/Inner VLAN TPID Setup */
1130 vlan_tpid_set_t vlan_tpid_set;
1131 /** VLAN Stripping on queue */
1132 vlan_strip_queue_set_t vlan_strip_queue_set;
1133 /** Set VLAN Offload */
1134 vlan_offload_set_t vlan_offload_set;
1135 /** Set port based Tx VLAN insertion */
1136 vlan_pvid_set_t vlan_pvid_set;
1138 eth_queue_start_t rx_queue_start;/**< Start Rx for a queue */
1139 eth_queue_stop_t rx_queue_stop; /**< Stop Rx for a queue */
1140 eth_queue_start_t tx_queue_start;/**< Start Tx for a queue */
1141 eth_queue_stop_t tx_queue_stop; /**< Stop Tx for a queue */
1142 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device Rx queue */
1143 eth_queue_release_t rx_queue_release; /**< Release Rx queue */
1145 /** Enable Rx queue interrupt */
1146 eth_rx_enable_intr_t rx_queue_intr_enable;
1147 /** Disable Rx queue interrupt */
1148 eth_rx_disable_intr_t rx_queue_intr_disable;
1150 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device Tx queue */
1151 eth_queue_release_t tx_queue_release; /**< Release Tx queue */
1152 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free Tx ring mbufs */
1154 eth_dev_led_on_t dev_led_on; /**< Turn on LED */
1155 eth_dev_led_off_t dev_led_off; /**< Turn off LED */
1157 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control */
1158 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control */
1159 /** Setup priority flow control */
1160 priority_flow_ctrl_set_t priority_flow_ctrl_set;
1161 /** Priority flow control queue info get */
1162 priority_flow_ctrl_queue_info_get_t priority_flow_ctrl_queue_info_get;
1163 /** Priority flow control queue configure */
1164 priority_flow_ctrl_queue_config_t priority_flow_ctrl_queue_config;
1166 /** Set Unicast Table Array */
1167 eth_uc_hash_table_set_t uc_hash_table_set;
1168 /** Set Unicast hash bitmap */
1169 eth_uc_all_hash_table_set_t uc_all_hash_table_set;
1171 /** Add UDP tunnel port */
1172 eth_udp_tunnel_port_add_t udp_tunnel_port_add;
1173 /** Delete UDP tunnel port */
1174 eth_udp_tunnel_port_del_t udp_tunnel_port_del;
1176 /** Set queue rate limit */
1177 eth_set_queue_rate_limit_t set_queue_rate_limit;
1179 /** Configure RSS hash protocols and hashing key */
1180 rss_hash_update_t rss_hash_update;
1181 /** Get current RSS hash configuration */
1182 rss_hash_conf_get_t rss_hash_conf_get;
1183 /** Update redirection table */
1184 reta_update_t reta_update;
1185 /** Query redirection table */
1186 reta_query_t reta_query;
1188 eth_get_reg_t get_reg; /**< Get registers */
1189 eth_get_eeprom_length_t get_eeprom_length; /**< Get EEPROM length */
1190 eth_get_eeprom_t get_eeprom; /**< Get EEPROM data */
1191 eth_set_eeprom_t set_eeprom; /**< Set EEPROM */
1193 /** Get plugin module EEPROM attribute */
1194 eth_get_module_info_t get_module_info;
1195 /** Get plugin module EEPROM data */
1196 eth_get_module_eeprom_t get_module_eeprom;
1198 eth_flow_ops_get_t flow_ops_get; /**< Get flow operations */
1200 eth_get_dcb_info get_dcb_info; /**< Get DCB information */
1202 /** Turn IEEE1588/802.1AS timestamping on */
1203 eth_timesync_enable_t timesync_enable;
1204 /** Turn IEEE1588/802.1AS timestamping off */
1205 eth_timesync_disable_t timesync_disable;
1206 /** Read the IEEE1588/802.1AS Rx timestamp */
1207 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1208 /** Read the IEEE1588/802.1AS Tx timestamp */
1209 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1210 /** Adjust the device clock */
1211 eth_timesync_adjust_time timesync_adjust_time;
1212 /** Get the device clock time */
1213 eth_timesync_read_time timesync_read_time;
1214 /** Set the device clock time */
1215 eth_timesync_write_time timesync_write_time;
1217 eth_read_clock read_clock;
1219 /** Get extended device statistic values by ID */
1220 eth_xstats_get_by_id_t xstats_get_by_id;
1221 /** Get name of extended device statistics by ID */
1222 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1224 /** Get Traffic Management (TM) operations */
1225 eth_tm_ops_get_t tm_ops_get;
1227 /** Get Traffic Metering and Policing (MTR) operations */
1228 eth_mtr_ops_get_t mtr_ops_get;
1230 /** Test if a port supports specific mempool ops */
1231 eth_pool_ops_supported_t pool_ops_supported;
1233 /** Returns the hairpin capabilities */
1234 eth_hairpin_cap_get_t hairpin_cap_get;
1235 /** Set up device Rx hairpin queue */
1236 eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
1237 /** Set up device Tx hairpin queue */
1238 eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
1240 /** Get Forward Error Correction(FEC) capability */
1241 eth_fec_get_capability_t fec_get_capability;
1242 /** Get Forward Error Correction(FEC) mode */
1243 eth_fec_get_t fec_get;
1244 /** Set Forward Error Correction(FEC) mode */
1245 eth_fec_set_t fec_set;
1247 /** Get hairpin peer ports list */
1248 hairpin_get_peer_ports_t hairpin_get_peer_ports;
1249 /** Bind all hairpin Tx queues of device to the peer port Rx queues */
1250 eth_hairpin_bind_t hairpin_bind;
1251 /** Unbind all hairpin Tx queues from the peer port Rx queues */
1252 eth_hairpin_unbind_t hairpin_unbind;
1253 /** Pass the current queue info and get the peer queue info */
1254 eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
1255 /** Set up the connection between the pair of hairpin queues */
1256 eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
1257 /** Disconnect the hairpin queues of a pair from each other */
1258 eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
1260 /** Get power monitoring condition for Rx queue */
1261 eth_get_monitor_addr_t get_monitor_addr;
1263 /** Get representor info */
1264 eth_representor_info_get_t representor_info_get;
1267 * Negotiate the NIC's ability to deliver specific
1268 * kinds of metadata to the PMD
1270 eth_rx_metadata_negotiate_t rx_metadata_negotiate;
1272 /** Get IP reassembly capability */
1273 eth_ip_reassembly_capability_get_t ip_reassembly_capability_get;
1274 /** Get IP reassembly configuration */
1275 eth_ip_reassembly_conf_get_t ip_reassembly_conf_get;
1276 /** Set IP reassembly configuration */
1277 eth_ip_reassembly_conf_set_t ip_reassembly_conf_set;
1279 /** Dump private info from device */
1280 eth_dev_priv_dump_t eth_dev_priv_dump;
1285 * Check if the selected Rx queue is hairpin queue.
1288 * Pointer to the selected device.
1290 * The selected queue.
1293 * - (1) if the queue is hairpin queue, 0 otherwise.
1296 int rte_eth_dev_is_rx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
1300 * Check if the selected Tx queue is hairpin queue.
1303 * Pointer to the selected device.
1305 * The selected queue.
1308 * - (1) if the queue is hairpin queue, 0 otherwise.
1311 int rte_eth_dev_is_tx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
1315 * Returns a ethdev slot specified by the unique identifier name.
1318 * The pointer to the Unique identifier name for each Ethernet device
1320 * - The pointer to the ethdev slot, on success. NULL on error
1323 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1327 * Allocates a new ethdev slot for an Ethernet device and returns the pointer
1328 * to that slot for the driver to use.
1330 * @param name Unique identifier name for each Ethernet device
1332 * - Slot in the rte_dev_devices array for a new device;
1335 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1339 * Attach to the ethdev already initialized by the primary
1342 * @param name Ethernet device's name.
1344 * - Success: Slot in the rte_dev_devices array for attached
1346 * - Error: Null pointer.
1349 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1353 * Notify RTE_ETH_EVENT_DESTROY and release the specified ethdev port.
1355 * The following PMD-managed data fields will be freed:
1359 * If one of these fields should not be freed,
1360 * it must be reset to NULL by the PMD, typically in dev_close method.
1363 * Device to be detached.
1365 * - 0 on success, negative on error
1368 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1372 * Release device queues and clear its configuration to force the user
1373 * application to reconfigure it. It is for internal use only.
1376 * Pointer to struct rte_eth_dev.
1382 void rte_eth_dev_internal_reset(struct rte_eth_dev *dev);
1385 * @internal Executes all the user application registered callbacks for
1386 * the specific device. It is for DPDK internal user only. User
1387 * application should not call it directly.
1390 * Pointer to struct rte_eth_dev.
1392 * Eth device interrupt event type.
1394 * To pass data back to user application.
1395 * This allows the user application to decide if a particular function
1396 * is permitted or not.
1402 int rte_eth_dev_callback_process(struct rte_eth_dev *dev,
1403 enum rte_eth_event_type event, void *ret_param);
1407 * This is the last step of device probing.
1408 * It must be called after a port is allocated and initialized successfully.
1410 * The notification RTE_ETH_EVENT_NEW is sent to other entities
1411 * (libraries and applications).
1412 * The state is set as RTE_ETH_DEV_ATTACHED.
1418 void rte_eth_dev_probing_finish(struct rte_eth_dev *dev);
1421 * Create memzone for HW rings.
1422 * malloc can't be used as the physical address is needed.
1423 * If the memzone is already created, then this function returns a ptr
1427 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1429 * The name of the memory zone
1431 * The index of the queue to add to name
1433 * The sizeof of the memory area
1435 * Alignment for resulting memzone. Must be a power of 2.
1437 * The *socket_id* argument is the socket identifier in case of NUMA.
1440 const struct rte_memzone *
1441 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
1442 uint16_t queue_id, size_t size,
1443 unsigned align, int socket_id);
1446 * Free previously allocated memzone for HW rings.
1449 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1451 * The name of the memory zone
1453 * The index of the queue to add to name
1455 * Negative errno value on error, 0 on success.
1459 rte_eth_dma_zone_free(const struct rte_eth_dev *eth_dev, const char *name,
1464 * Atomically set the link status for the specific device.
1465 * It is for use by DPDK device driver use only.
1466 * User applications should not call it
1469 * Pointer to struct rte_eth_dev.
1471 * New link status value.
1473 * Same convention as eth_link_update operation.
1474 * 0 if link up status has changed
1475 * -1 if link up status was unchanged
1478 rte_eth_linkstatus_set(struct rte_eth_dev *dev,
1479 const struct rte_eth_link *new_link)
1481 uint64_t *dev_link = (uint64_t *)&(dev->data->dev_link);
1484 struct rte_eth_link link;
1487 RTE_BUILD_BUG_ON(sizeof(*new_link) != sizeof(uint64_t));
1489 orig.val64 = __atomic_exchange_n(dev_link, *(const uint64_t *)new_link,
1492 return (orig.link.link_status == new_link->link_status) ? -1 : 0;
1497 * Atomically get the link speed and status.
1500 * Pointer to struct rte_eth_dev.
1502 * link status value.
1505 rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
1506 struct rte_eth_link *link)
1508 uint64_t *src = (uint64_t *)&(dev->data->dev_link);
1509 uint64_t *dst = (uint64_t *)link;
1511 RTE_BUILD_BUG_ON(sizeof(*link) != sizeof(uint64_t));
1513 *dst = __atomic_load_n(src, __ATOMIC_SEQ_CST);
1518 * Dummy DPDK callback for Rx/Tx packet burst.
1521 * Pointer to Rx/Tx queue
1525 * Number of packets in packet array
1529 rte_eth_pkt_burst_dummy(void *queue __rte_unused,
1530 struct rte_mbuf **pkts __rte_unused,
1531 uint16_t nb_pkts __rte_unused);
1534 * Allocate an unique switch domain identifier.
1536 * A pool of switch domain identifiers which can be allocated on request. This
1537 * will enabled devices which support the concept of switch domains to request
1538 * a switch domain ID which is guaranteed to be unique from other devices
1539 * running in the same process.
1542 * switch domain identifier parameter to pass back to application
1545 * Negative errno value on error, 0 on success.
1549 rte_eth_switch_domain_alloc(uint16_t *domain_id);
1552 * Free switch domain.
1554 * Return a switch domain identifier to the pool of free identifiers after it is
1555 * no longer in use by device.
1558 * switch domain identifier to free
1561 * Negative errno value on error, 0 on success.
1565 rte_eth_switch_domain_free(uint16_t domain_id);
1568 * Generic Ethernet device arguments
1570 * One type of representor each structure.
1572 struct rte_eth_devargs {
1573 uint16_t mh_controllers[RTE_MAX_MULTI_HOST_CTRLS];
1574 /** controller/s number in case of multi-host */
1575 uint16_t nb_mh_controllers;
1576 /** number of controllers in multi-host controllers field */
1577 uint16_t ports[RTE_MAX_ETHPORTS];
1578 /** port/s number to enable on a multi-port single function */
1580 /** number of ports in ports field */
1581 uint16_t representor_ports[RTE_MAX_ETHPORTS];
1582 /** representor port/s identifier to enable on device */
1583 uint16_t nb_representor_ports;
1584 /** number of ports in representor port field */
1585 enum rte_eth_representor_type type; /* type of representor */
1589 * PMD helper function to get representor ID from location detail.
1591 * Get representor ID from controller, pf and (sf or vf).
1592 * The mapping is retrieved from rte_eth_representor_info_get().
1594 * For backward compatibility, if no representor info, direct
1595 * map legacy VF (no controller and pf).
1598 * Port ID of the backing device.
1602 * Controller ID, -1 if unspecified.
1604 * PF port ID, -1 if unspecified.
1605 * @param representor_port
1606 * VF or SF representor port number, -1 if unspecified.
1608 * Pointer to output representor ID.
1611 * Negative errno value on error, 0 on success.
1615 rte_eth_representor_id_get(uint16_t port_id,
1616 enum rte_eth_representor_type type,
1617 int controller, int pf, int representor_port,
1621 * PMD helper function to parse ethdev arguments
1625 * @param eth_devargs
1626 * parsed ethdev specific arguments.
1629 * Negative errno value on error, 0 on success.
1633 rte_eth_devargs_parse(const char *devargs, struct rte_eth_devargs *eth_devargs);
1636 typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
1637 typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
1638 void *bus_specific_init_params);
1641 * PMD helper function for the creation of a new ethdev ports.
1644 * rte_device handle.
1647 * @param priv_data_size
1648 * size of private data required for port.
1649 * @param bus_specific_init
1650 * port bus specific initialisation callback function
1651 * @param bus_init_params
1652 * port bus specific initialisation parameters
1653 * @param ethdev_init
1654 * device specific port initialization callback function
1655 * @param init_params
1656 * port initialisation parameters
1659 * Negative errno value on error, 0 on success.
1663 rte_eth_dev_create(struct rte_device *device, const char *name,
1664 size_t priv_data_size,
1665 ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
1666 ethdev_init_t ethdev_init, void *init_params);
1669 typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);
1672 * PMD helper function for cleaning up the resources of a ethdev port on it's
1676 * ethdev handle of port.
1677 * @param ethdev_uninit
1678 * device specific port un-initialise callback function
1681 * Negative errno value on error, 0 on success.
1685 rte_eth_dev_destroy(struct rte_eth_dev *ethdev, ethdev_uninit_t ethdev_uninit);
1689 * Pass the current hairpin queue HW and/or SW information to the peer queue
1690 * and fetch back the information of the peer queue.
1693 * Peer port identifier of the Ethernet device.
1695 * Peer queue index of the port.
1697 * Pointer to the current information structure.
1699 * Pointer to the peer information, output.
1701 * Direction to pass the information.
1702 * positive - pass Tx queue information and get peer Rx queue information
1703 * zero - pass Rx queue information and get peer Tx queue information
1706 * Negative errno value on error, 0 on success.
1710 rte_eth_hairpin_queue_peer_update(uint16_t peer_port, uint16_t peer_queue,
1711 struct rte_hairpin_peer_info *cur_info,
1712 struct rte_hairpin_peer_info *peer_info,
1713 uint32_t direction);
1717 * Configure current hairpin queue with the peer information fetched to create
1718 * the connection (bind) with peer queue in the specified direction.
1719 * This function might need to be called twice to fully create the connections.
1722 * Current port identifier of the Ethernet device.
1724 * Current queue index of the port.
1726 * Pointer to the peer information, input.
1728 * Direction to create the connection.
1729 * positive - bind current Tx queue to peer Rx queue
1730 * zero - bind current Rx queue to peer Tx queue
1733 * Negative errno value on error, 0 on success.
1737 rte_eth_hairpin_queue_peer_bind(uint16_t cur_port, uint16_t cur_queue,
1738 struct rte_hairpin_peer_info *peer_info,
1739 uint32_t direction);
1743 * Get rte_eth_dev from device name. The device name should be specified
1745 * - PCIe address (Domain:Bus:Device.Function), for example 0000:2:00.0
1746 * - SoC device name, for example fsl-gmac0
1747 * - vdev dpdk name, for example net_[pcap0|null0|tap0]
1750 * PCI address or name of the device
1752 * - rte_eth_dev if successful
1757 rte_eth_dev_get_by_name(const char *name);
1761 * Reset the current queue state and configuration to disconnect (unbind) it
1762 * from the peer queue.
1763 * This function might need to be called twice to disconnect each other.
1766 * Current port identifier of the Ethernet device.
1768 * Current queue index of the port.
1770 * Direction to destroy the connection.
1771 * positive - unbind current Tx queue from peer Rx queue
1772 * zero - unbind current Rx queue from peer Tx queue
1775 * Negative errno value on error, 0 on success.
1779 rte_eth_hairpin_queue_peer_unbind(uint16_t cur_port, uint16_t cur_queue,
1780 uint32_t direction);
1784 * Register mbuf dynamic field and flag for IP reassembly incomplete case.
1788 rte_eth_ip_reassembly_dynfield_register(int *field_offset, int *flag);
1792 * Legacy ethdev API used internally by drivers.
1795 enum rte_filter_type {
1796 RTE_ETH_FILTER_NONE = 0,
1797 RTE_ETH_FILTER_ETHERTYPE,
1798 RTE_ETH_FILTER_FLEXIBLE,
1800 RTE_ETH_FILTER_NTUPLE,
1801 RTE_ETH_FILTER_TUNNEL,
1802 RTE_ETH_FILTER_FDIR,
1803 RTE_ETH_FILTER_HASH,
1804 RTE_ETH_FILTER_L2_TUNNEL,
1808 * Define all structures for Ethertype Filter type.
1811 #define RTE_ETHTYPE_FLAGS_MAC 0x0001 /**< If set, compare mac */
1812 #define RTE_ETHTYPE_FLAGS_DROP 0x0002 /**< If set, drop packet when match */
1815 * A structure used to define the ethertype filter entry
1816 * to support RTE_ETH_FILTER_ETHERTYPE data representation.
1818 struct rte_eth_ethertype_filter {
1819 struct rte_ether_addr mac_addr; /**< Mac address to match */
1820 uint16_t ether_type; /**< Ether type to match */
1821 uint16_t flags; /**< Flags from RTE_ETHTYPE_FLAGS_* */
1822 uint16_t queue; /**< Queue assigned to when match */
1826 * A structure used to define the TCP syn filter entry
1827 * to support RTE_ETH_FILTER_SYN data representation.
1829 struct rte_eth_syn_filter {
1830 /** 1 - higher priority than other filters, 0 - lower priority */
1832 uint16_t queue; /**< Queue assigned to when match */
1836 * filter type of tunneling packet
1838 #define RTE_ETH_TUNNEL_FILTER_OMAC 0x01 /**< filter by outer MAC addr */
1839 #define RTE_ETH_TUNNEL_FILTER_OIP 0x02 /**< filter by outer IP Addr */
1840 #define RTE_ETH_TUNNEL_FILTER_TENID 0x04 /**< filter by tenant ID */
1841 #define RTE_ETH_TUNNEL_FILTER_IMAC 0x08 /**< filter by inner MAC addr */
1842 #define RTE_ETH_TUNNEL_FILTER_IVLAN 0x10 /**< filter by inner VLAN ID */
1843 #define RTE_ETH_TUNNEL_FILTER_IIP 0x20 /**< filter by inner IP addr */
1845 #define RTE_ETH_TUNNEL_FILTER_IMAC_IVLAN (RTE_ETH_TUNNEL_FILTER_IMAC | \
1846 RTE_ETH_TUNNEL_FILTER_IVLAN)
1847 #define RTE_ETH_TUNNEL_FILTER_IMAC_IVLAN_TENID (RTE_ETH_TUNNEL_FILTER_IMAC | \
1848 RTE_ETH_TUNNEL_FILTER_IVLAN | \
1849 RTE_ETH_TUNNEL_FILTER_TENID)
1850 #define RTE_ETH_TUNNEL_FILTER_IMAC_TENID (RTE_ETH_TUNNEL_FILTER_IMAC | \
1851 RTE_ETH_TUNNEL_FILTER_TENID)
1852 #define RTE_ETH_TUNNEL_FILTER_OMAC_TENID_IMAC (RTE_ETH_TUNNEL_FILTER_OMAC | \
1853 RTE_ETH_TUNNEL_FILTER_TENID | \
1854 RTE_ETH_TUNNEL_FILTER_IMAC)
1857 * Select IPv4 or IPv6 for tunnel filters.
1859 enum rte_tunnel_iptype {
1860 RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4 */
1861 RTE_TUNNEL_IPTYPE_IPV6, /**< IPv6 */
1865 * Tunneling Packet filter configuration.
1867 struct rte_eth_tunnel_filter_conf {
1868 struct rte_ether_addr outer_mac; /**< Outer MAC address to match */
1869 struct rte_ether_addr inner_mac; /**< Inner MAC address to match */
1870 uint16_t inner_vlan; /**< Inner VLAN to match */
1871 enum rte_tunnel_iptype ip_type; /**< IP address type */
1873 * Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
1874 * is set in filter_type, or inner destination IP address to match
1875 * if ETH_TUNNEL_FILTER_IIP is set in filter_type.
1878 uint32_t ipv4_addr; /**< IPv4 address in big endian */
1879 uint32_t ipv6_addr[4]; /**< IPv6 address in big endian */
1881 /** Flags from ETH_TUNNEL_FILTER_XX - see above */
1882 uint16_t filter_type;
1883 enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type */
1884 uint32_t tenant_id; /**< Tenant ID to match: VNI, GRE key... */
1885 uint16_t queue_id; /**< Queue assigned to if match */
1892 #endif /* _RTE_ETHDEV_DRIVER_H_ */