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>
22 * Structure used to hold information about the callbacks to be called for a
25 struct rte_eth_rxtx_callback {
26 struct rte_eth_rxtx_callback *next;
28 rte_rx_callback_fn rx;
29 rte_tx_callback_fn tx;
36 * The generic data structure associated with each ethernet device.
38 * Pointers to burst-oriented packet receive and transmit functions are
39 * located at the beginning of the structure, along with the pointer to
40 * where all the data elements for the particular device are stored in shared
41 * memory. This split allows the function pointer and driver data to be per-
42 * process, while the actual configuration data for the device is shared.
45 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
46 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
47 eth_tx_prep_t tx_pkt_prepare;
48 /**< Pointer to PMD transmit prepare function. */
49 eth_rx_queue_count_t rx_queue_count;
50 /**< Get the number of used RX descriptors. */
51 eth_rx_descriptor_status_t rx_descriptor_status;
52 /**< Check the status of a Rx descriptor. */
53 eth_tx_descriptor_status_t tx_descriptor_status;
54 /**< Check the status of a Tx descriptor. */
57 * points to device data that is shared between
58 * primary and secondary processes.
60 struct rte_eth_dev_data *data;
61 void *process_private; /**< Pointer to per-process device data. */
62 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
63 struct rte_device *device; /**< Backing device */
64 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
65 /** User application callbacks for NIC interrupts */
66 struct rte_eth_dev_cb_list link_intr_cbs;
68 * User-supplied functions called from rx_burst to post-process
69 * received packets before passing them to the user
71 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
73 * User-supplied functions called from tx_burst to pre-process
74 * received packets before passing them to the driver for transmission.
76 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
77 enum rte_eth_dev_state state; /**< Flag indicating the port state */
78 void *security_ctx; /**< Context for security ops */
80 uint64_t reserved_64s[4]; /**< Reserved for future fields */
81 void *reserved_ptrs[4]; /**< Reserved for future fields */
82 } __rte_cache_aligned;
84 struct rte_eth_dev_sriov;
85 struct rte_eth_dev_owner;
89 * The data part, with no function pointers, associated with each ethernet
90 * device. This structure is safe to place in shared memory to be common
91 * among different processes in a multi-process configuration.
93 struct rte_eth_dev_data {
94 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
96 void **rx_queues; /**< Array of pointers to RX queues. */
97 void **tx_queues; /**< Array of pointers to TX queues. */
98 uint16_t nb_rx_queues; /**< Number of RX queues. */
99 uint16_t nb_tx_queues; /**< Number of TX queues. */
101 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
104 /**< PMD-specific private data.
105 * @see rte_eth_dev_release_port()
108 struct rte_eth_link dev_link; /**< Link-level information & status. */
109 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
110 uint16_t mtu; /**< Maximum Transmission Unit. */
111 uint32_t min_rx_buf_size;
112 /**< Common RX buffer size handled by all queues. */
114 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
115 struct rte_ether_addr *mac_addrs;
116 /**< Device Ethernet link address.
117 * @see rte_eth_dev_release_port()
119 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
120 /**< Bitmap associating MAC addresses to pools. */
121 struct rte_ether_addr *hash_mac_addrs;
122 /**< Device Ethernet MAC addresses of hash filtering.
123 * @see rte_eth_dev_release_port()
125 uint16_t port_id; /**< Device [external] port identifier. */
128 uint8_t promiscuous : 1,
129 /**< RX promiscuous mode ON(1) / OFF(0). */
131 /**< RX of scattered packets is ON(1) / OFF(0) */
133 /**< RX all multicast mode ON(1) / OFF(0). */
135 /**< Device state: STARTED(1) / STOPPED(0). */
137 /**< RX LRO is ON(1) / OFF(0) */
139 /**< Indicates whether the device is configured.
140 * CONFIGURED(1) / NOT CONFIGURED(0).
142 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
143 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
144 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
145 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
146 uint32_t dev_flags; /**< Capabilities. */
147 int numa_node; /**< NUMA node connection. */
148 struct rte_vlan_filter_conf vlan_filter_conf;
149 /**< VLAN filter configuration. */
150 struct rte_eth_dev_owner owner; /**< The port owner. */
151 uint16_t representor_id;
152 /**< Switch-specific identifier.
153 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
155 uint16_t backer_port_id;
156 /**< Port ID of the backing device.
157 * This device will be used to query representor
158 * info and calculate representor IDs.
159 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
162 pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
163 uint64_t reserved_64s[4]; /**< Reserved for future fields */
164 void *reserved_ptrs[4]; /**< Reserved for future fields */
165 } __rte_cache_aligned;
169 * The pool of *rte_eth_dev* structures. The size of the pool
170 * is configured at compile-time in the <rte_ethdev.c> file.
172 extern struct rte_eth_dev rte_eth_devices[];
174 /**< @internal Declaration of the hairpin peer queue information structure. */
175 struct rte_hairpin_peer_info;
178 * Definitions of all functions exported by an Ethernet driver through the
179 * generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
180 * structure associated with an Ethernet device.
183 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
184 /**< @internal Ethernet device configuration. */
186 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
187 /**< @internal Function used to start a configured Ethernet device. */
189 typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
190 /**< @internal Function used to stop a configured Ethernet device. */
192 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
193 /**< @internal Function used to link up a configured Ethernet device. */
195 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
196 /**< @internal Function used to link down a configured Ethernet device. */
198 typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
199 /**< @internal Function used to close a configured Ethernet device. */
201 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
202 /** <@internal Function used to reset a configured Ethernet device. */
204 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
205 /**< @internal Function used to detect an Ethernet device removal. */
209 * Function used to enable the Rx promiscuous mode of an Ethernet device.
212 * ethdev handle of port.
215 * Negative errno value on error, 0 on success.
218 * Success, promiscuous mode is enabled.
220 * Promiscuous mode is not supported.
223 * @retval -E_RTE_SECONDARY
224 * Function was called from a secondary process instance and not supported.
226 * Attempt to enable promiscuos mode failed because of timeout.
228 * Failed to enable promiscuous mode.
230 typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
234 * Function used to disable the Rx promiscuous mode of an Ethernet device.
237 * ethdev handle of port.
240 * Negative errno value on error, 0 on success.
243 * Success, promiscuous mode is disabled.
245 * Promiscuous mode disabling is not supported.
248 * @retval -E_RTE_SECONDARY
249 * Function was called from a secondary process instance and not supported.
251 * Attempt to disable promiscuos mode failed because of timeout.
253 * Failed to disable promiscuous mode.
255 typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
259 * Enable the receipt of all multicast packets by an Ethernet device.
262 * ethdev handle of port.
265 * Negative errno value on error, 0 on success.
268 * Success, all-multicast mode is enabled.
270 * All-multicast mode is not supported.
273 * @retval -E_RTE_SECONDARY
274 * Function was called from a secondary process instance and not supported.
276 * Attempt to enable all-multicast mode failed because of timeout.
278 * Failed to enable all-multicast mode.
280 typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
284 * Disable the receipt of all multicast packets by an Ethernet device.
287 * ethdev handle of port.
290 * Negative errno value on error, 0 on success.
293 * Success, all-multicast mode is disabled.
295 * All-multicast mode disabling is not supported.
298 * @retval -E_RTE_SECONDARY
299 * Function was called from a secondary process instance and not supported.
301 * Attempt to disable all-multicast mode failed because of timeout.
303 * Failed to disable all-multicast mode.
305 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
307 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
308 int wait_to_complete);
309 /**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
311 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
312 struct rte_eth_stats *igb_stats);
313 /**< @internal Get global I/O statistics of an Ethernet device. */
317 * Reset global I/O statistics of an Ethernet device to 0.
320 * ethdev handle of port.
323 * Negative errno value on error, 0 on success.
326 * Success, statistics has been reset.
328 * Resetting statistics is not supported.
330 * Resetting statistics is not valid.
332 * Not enough memory to get the stats.
334 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
336 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
337 struct rte_eth_xstat *stats, unsigned int n);
338 /**< @internal Get extended stats of an Ethernet device. */
342 * Get extended stats of an Ethernet device.
345 * ethdev handle of port.
347 * IDs array to retrieve specific statistics. Must not be NULL.
349 * A pointer to a table to be filled with device statistics values.
352 * Element count in @p ids and @p values.
355 * - A number of filled in stats.
356 * - A negative value on error.
358 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
365 * Reset extended stats of an Ethernet device.
368 * ethdev handle of port.
371 * Negative errno value on error, 0 on success.
374 * Success, statistics has been reset.
376 * Resetting statistics is not supported.
378 * Resetting statistics is not valid.
380 * Not enough memory to get the stats.
382 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
384 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
385 struct rte_eth_xstat_name *xstats_names, unsigned int size);
386 /**< @internal Get names of extended stats of an Ethernet device. */
390 * Get names of extended stats of an Ethernet device.
393 * ethdev handle of port.
395 * IDs array to retrieve specific statistics. Must not be NULL.
396 * @param xstats_names
397 * An rte_eth_xstat_name array of at least @p size elements to be filled.
400 * Element count in @p ids and @p xstats_names.
403 * - A number of filled in stats.
404 * - A negative value on error.
406 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
407 const uint64_t *ids, struct rte_eth_xstat_name *xstats_names,
410 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
414 /**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
416 typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
417 struct rte_eth_dev_info *dev_info);
418 /**< @internal Get specific information of an Ethernet device. */
420 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
421 /**< @internal Get supported ptypes of an Ethernet device. */
425 * Inform Ethernet device about reduced range of packet types to handle.
428 * The Ethernet device identifier.
430 * The ptype family that application is interested in should be bitwise OR of
431 * RTE_PTYPE_*_MASK or 0.
435 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
436 uint32_t ptype_mask);
438 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
440 /**< @internal Start rx and tx of a queue of an Ethernet device. */
442 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
444 /**< @internal Stop rx and tx of a queue of an Ethernet device. */
446 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
447 uint16_t rx_queue_id,
449 unsigned int socket_id,
450 const struct rte_eth_rxconf *rx_conf,
451 struct rte_mempool *mb_pool);
452 /**< @internal Set up a receive queue of an Ethernet device. */
454 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
455 uint16_t tx_queue_id,
457 unsigned int socket_id,
458 const struct rte_eth_txconf *tx_conf);
459 /**< @internal Setup a transmit queue of an Ethernet device. */
461 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
462 uint16_t rx_queue_id);
463 /**< @internal Enable interrupt of a receive queue of an Ethernet device. */
465 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
466 uint16_t rx_queue_id);
467 /**< @internal Disable interrupt of a receive queue of an Ethernet device. */
469 typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
471 /**< @internal Release memory resources allocated by given RX/TX queue. */
473 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
474 char *fw_version, size_t fw_size);
475 /**< @internal Get firmware information of an Ethernet device. */
477 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
478 /**< @internal Force mbufs to be from TX ring. */
480 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
481 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
483 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
484 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
486 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
487 uint16_t queue_id, struct rte_eth_burst_mode *mode);
489 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
490 /**< @internal Set MTU. */
492 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
495 /**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
497 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
498 enum rte_vlan_type type, uint16_t tpid);
499 /**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
501 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
502 /**< @internal set VLAN offload function by an Ethernet device. */
504 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
507 /**< @internal set port based TX VLAN insertion by an Ethernet device. */
509 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
510 uint16_t rx_queue_id,
512 /**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
514 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
515 struct rte_eth_fc_conf *fc_conf);
516 /**< @internal Get current flow control parameter on an Ethernet device */
518 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
519 struct rte_eth_fc_conf *fc_conf);
520 /**< @internal Setup flow control parameter on an Ethernet device */
522 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
523 struct rte_eth_pfc_conf *pfc_conf);
524 /**< @internal Setup priority flow control parameter on an Ethernet device */
526 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
527 struct rte_eth_rss_reta_entry64 *reta_conf,
529 /**< @internal Update RSS redirection table on an Ethernet device */
531 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
532 struct rte_eth_rss_reta_entry64 *reta_conf,
534 /**< @internal Query RSS redirection table on an Ethernet device */
536 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
537 struct rte_eth_rss_conf *rss_conf);
538 /**< @internal Update RSS hash configuration of an Ethernet device */
540 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
541 struct rte_eth_rss_conf *rss_conf);
542 /**< @internal Get current RSS hash configuration of an Ethernet device */
544 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
545 /**< @internal Turn on SW controllable LED on an Ethernet device */
547 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
548 /**< @internal Turn off SW controllable LED on an Ethernet device */
550 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
551 /**< @internal Remove MAC address from receive address register */
553 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
554 struct rte_ether_addr *mac_addr,
557 /**< @internal Set a MAC address into Receive Address Register */
559 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
560 struct rte_ether_addr *mac_addr);
561 /**< @internal Set a MAC address into Receive Address Register */
563 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
564 struct rte_ether_addr *mac_addr,
566 /**< @internal Set a Unicast Hash bitmap */
568 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
570 /**< @internal Set all Unicast Hash bitmap */
572 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
575 /**< @internal Set queue TX rate */
577 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
578 struct rte_eth_udp_tunnel *tunnel_udp);
579 /**< @internal Add tunneling UDP port */
581 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
582 struct rte_eth_udp_tunnel *tunnel_udp);
583 /**< @internal Delete tunneling UDP port */
585 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
586 struct rte_ether_addr *mc_addr_set,
587 uint32_t nb_mc_addr);
588 /**< @internal set the list of multicast addresses on an Ethernet device */
590 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
591 /**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
593 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
594 /**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
596 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
597 struct timespec *timestamp,
599 /**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
601 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
602 struct timespec *timestamp);
603 /**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
605 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
606 /**< @internal Function used to adjust the device clock */
608 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
609 struct timespec *timestamp);
610 /**< @internal Function used to get time from the device clock. */
612 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
613 const struct timespec *timestamp);
614 /**< @internal Function used to get time from the device clock */
616 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
617 uint64_t *timestamp);
618 /**< @internal Function used to get the current value of the device clock. */
620 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
621 struct rte_dev_reg_info *info);
622 /**< @internal Retrieve registers */
624 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
625 /**< @internal Retrieve eeprom size */
627 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
628 struct rte_dev_eeprom_info *info);
629 /**< @internal Retrieve eeprom data */
631 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
632 struct rte_dev_eeprom_info *info);
633 /**< @internal Program eeprom data */
635 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
636 struct rte_eth_dev_module_info *modinfo);
637 /**< @internal Retrieve type and size of plugin module eeprom */
639 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
640 struct rte_dev_eeprom_info *info);
641 /**< @internal Retrieve plugin module eeprom data */
646 * Get flow operations.
648 * If the flow API is not supported for the specified device,
649 * the driver can return NULL.
651 typedef int (*eth_flow_ops_get_t)(struct rte_eth_dev *dev,
652 const struct rte_flow_ops **ops);
654 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
655 /**< @internal Get Traffic Management (TM) operations on an Ethernet device */
657 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
658 /**< @internal Get Traffic Metering and Policing (MTR) operations */
660 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
661 struct rte_eth_dcb_info *dcb_info);
662 /**< @internal Get dcb information on an Ethernet device */
664 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
666 /**< @internal Test if a port supports specific mempool ops */
670 * Get the hairpin capabilities.
673 * ethdev handle of port.
675 * returns the hairpin capabilities from the device.
678 * Negative errno value on error, 0 on success.
681 * Success, hairpin is supported.
683 * Hairpin is not supported.
685 typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
686 struct rte_eth_hairpin_cap *cap);
690 * Setup RX hairpin queue.
693 * ethdev handle of port.
695 * the selected RX queue index.
697 * the requested number of descriptors for this queue. 0 - use PMD default.
699 * the RX hairpin configuration structure.
702 * Negative errno value on error, 0 on success.
705 * Success, hairpin is supported.
707 * Hairpin is not supported.
709 * One of the parameters is invalid.
711 * Unable to allocate resources.
713 typedef int (*eth_rx_hairpin_queue_setup_t)
714 (struct rte_eth_dev *dev, uint16_t rx_queue_id,
716 const struct rte_eth_hairpin_conf *conf);
720 * Setup TX hairpin queue.
723 * ethdev handle of port.
725 * the selected TX queue index.
727 * the requested number of descriptors for this queue. 0 - use PMD default.
729 * the TX hairpin configuration structure.
732 * Negative errno value on error, 0 on success.
735 * Success, hairpin is supported.
737 * Hairpin is not supported.
739 * One of the parameters is invalid.
741 * Unable to allocate resources.
743 typedef int (*eth_tx_hairpin_queue_setup_t)
744 (struct rte_eth_dev *dev, uint16_t tx_queue_id,
746 const struct rte_eth_hairpin_conf *hairpin_conf);
750 * Get Forward Error Correction(FEC) capability.
753 * ethdev handle of port.
754 * @param speed_fec_capa
755 * speed_fec_capa is out only with per-speed capabilities.
757 * a number of elements in an speed_fec_capa array.
760 * Negative errno value on error, positive value on success.
762 * @retval positive value
763 * A non-negative value lower or equal to num: success. The return value
764 * is the number of entries filled in the fec capa array.
765 * A non-negative value higher than num: error, the given fec capa array
766 * is too small. The return value corresponds to the num that should
767 * be given to succeed. The entries in the fec capa array are not valid
768 * and shall not be used by the caller.
770 * Operation is not supported.
774 * *num* or *speed_fec_capa* invalid.
776 typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
777 struct rte_eth_fec_capa *speed_fec_capa, unsigned int num);
781 * Get Forward Error Correction(FEC) mode.
784 * ethdev handle of port.
786 * a bitmask of enabled FEC modes. If AUTO bit is set, other
787 * bits specify FEC modes which may be negotiated. If AUTO
788 * bit is clear, specify FEC modes to be used (only one valid
789 * mode per speed may be set).
792 * Negative errno value on error, 0 on success.
795 * Success, get FEC success.
797 * Operation is not supported.
801 typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev,
806 * Set Forward Error Correction(FEC) mode.
809 * ethdev handle of port.
811 * bitmask of allowed FEC modes. It must be only one
812 * if AUTO is disabled. If AUTO is enabled, other
813 * bits specify FEC modes which may be negotiated.
816 * Negative errno value on error, 0 on success.
819 * Success, set FEC success.
821 * Operation is not supported.
823 * Unsupported FEC mode requested.
827 typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, uint32_t fec_capa);
831 * Get all hairpin Tx/Rx peer ports of the current device, if any.
834 * ethdev handle of port.
836 * array to save the ports list.
840 * value to decide the current to peer direction
841 * positive - used as Tx to get all peer Rx ports.
842 * zero - used as Rx to get all peer Tx ports.
845 * Negative errno value on error, 0 or positive on success.
848 * Success, no peer ports.
850 * Actual number of the peer ports.
852 * Get peer ports API is not supported.
854 * One of the parameters is invalid.
856 typedef int (*hairpin_get_peer_ports_t)(struct rte_eth_dev *dev,
857 uint16_t *peer_ports, size_t len,
862 * Bind all hairpin Tx queues of one port to the Rx queues of the peer port.
865 * ethdev handle of port.
870 * Negative errno value on error, 0 on success.
873 * Success, bind successfully.
875 * Bind API is not supported.
877 * One of the parameters is invalid.
879 * Device is not started.
881 typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
886 * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port.
889 * ethdev handle of port.
894 * Negative errno value on error, 0 on success.
897 * Success, unbind successfully.
899 * Bind API is not supported.
901 * One of the parameters is invalid.
903 * Device is already stopped.
905 typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
908 typedef int (*eth_hairpin_queue_peer_update_t)
909 (struct rte_eth_dev *dev, uint16_t peer_queue,
910 struct rte_hairpin_peer_info *current_info,
911 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
912 /**< @internal Update and fetch peer queue information. */
914 typedef int (*eth_hairpin_queue_peer_bind_t)
915 (struct rte_eth_dev *dev, uint16_t cur_queue,
916 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
917 /**< @internal Bind peer queue to the current queue with fetched information. */
919 typedef int (*eth_hairpin_queue_peer_unbind_t)
920 (struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
921 /**< @internal Unbind peer queue from the current queue. */
925 * Get address of memory location whose contents will change whenever there is
926 * new data to be received on an Rx queue.
929 * Ethdev queue pointer.
931 * The pointer to power-optimized monitoring condition structure.
933 * Negative errno value on error, 0 on success.
940 typedef int (*eth_get_monitor_addr_t)(void *rxq,
941 struct rte_power_monitor_cond *pmc);
945 * Get representor info to be able to calculate the unique representor ID.
947 * Caller should pass NULL as pointer of info to get number of entries,
948 * allocate info buffer according to returned entry number, then call
949 * again with buffer to get real info.
951 * To calculate the representor ID, caller should iterate each entry,
952 * match controller index, pf index, vf or sf start index and range,
953 * then calculate representor ID from offset to vf/sf start index.
954 * @see rte_eth_representor_id_get.
957 * Ethdev handle of port.
959 * Pointer to memory to save device representor info.
961 * Negative errno value on error, number of info entries otherwise.
964 typedef int (*eth_representor_info_get_t)(struct rte_eth_dev *dev,
965 struct rte_eth_representor_info *info);
969 * Negotiate the NIC's ability to deliver specific kinds of metadata to the PMD.
972 * Port (ethdev) handle
974 * @param[inout] features
975 * Feature selection buffer
978 * Negative errno value on error, zero otherwise
980 typedef int (*eth_rx_metadata_negotiate_t)(struct rte_eth_dev *dev,
984 * @internal A structure containing the functions exported by an Ethernet driver.
987 eth_dev_configure_t dev_configure; /**< Configure device. */
988 eth_dev_start_t dev_start; /**< Start device. */
989 eth_dev_stop_t dev_stop; /**< Stop device. */
990 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
991 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
992 eth_dev_close_t dev_close; /**< Close device. */
993 eth_dev_reset_t dev_reset; /**< Reset device. */
994 eth_link_update_t link_update; /**< Get device link state. */
995 eth_is_removed_t is_removed;
996 /**< Check if the device was physically removed. */
998 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
999 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
1000 eth_allmulticast_enable_t allmulticast_enable;/**< RX multicast ON. */
1001 eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
1002 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1003 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1004 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1005 eth_set_mc_addr_list_t set_mc_addr_list; /**< set list of mcast addrs. */
1006 mtu_set_t mtu_set; /**< Set MTU. */
1008 eth_stats_get_t stats_get; /**< Get generic device statistics. */
1009 eth_stats_reset_t stats_reset; /**< Reset generic device statistics. */
1010 eth_xstats_get_t xstats_get; /**< Get extended device statistics. */
1011 eth_xstats_reset_t xstats_reset; /**< Reset extended device statistics. */
1012 eth_xstats_get_names_t xstats_get_names;
1013 /**< Get names of extended statistics. */
1014 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1015 /**< Configure per queue stat counter mapping. */
1017 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1018 eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
1019 eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
1020 eth_burst_mode_get_t rx_burst_mode_get; /**< Get RX burst mode */
1021 eth_burst_mode_get_t tx_burst_mode_get; /**< Get TX burst mode */
1022 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1023 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1024 /**< Get packet types supported and identified by device. */
1025 eth_dev_ptypes_set_t dev_ptypes_set;
1026 /**< Inform Ethernet device about reduced range of packet types to handle. */
1028 vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */
1029 vlan_tpid_set_t vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
1030 vlan_strip_queue_set_t vlan_strip_queue_set; /**< VLAN Stripping on queue. */
1031 vlan_offload_set_t vlan_offload_set; /**< Set VLAN Offload. */
1032 vlan_pvid_set_t vlan_pvid_set; /**< Set port based TX VLAN insertion. */
1034 eth_queue_start_t rx_queue_start;/**< Start RX for a queue. */
1035 eth_queue_stop_t rx_queue_stop; /**< Stop RX for a queue. */
1036 eth_queue_start_t tx_queue_start;/**< Start TX for a queue. */
1037 eth_queue_stop_t tx_queue_stop; /**< Stop TX for a queue. */
1038 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue. */
1039 eth_queue_release_t rx_queue_release; /**< Release RX queue. */
1041 eth_rx_enable_intr_t rx_queue_intr_enable; /**< Enable Rx queue interrupt. */
1042 eth_rx_disable_intr_t rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
1043 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue. */
1044 eth_queue_release_t tx_queue_release; /**< Release TX queue. */
1045 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free tx ring mbufs */
1047 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1048 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1050 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1051 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1052 priority_flow_ctrl_set_t priority_flow_ctrl_set; /**< Setup priority flow control. */
1054 eth_uc_hash_table_set_t uc_hash_table_set; /**< Set Unicast Table Array. */
1055 eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
1057 eth_udp_tunnel_port_add_t udp_tunnel_port_add; /** Add UDP tunnel port. */
1058 eth_udp_tunnel_port_del_t udp_tunnel_port_del; /** Del UDP tunnel port. */
1060 eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
1062 rss_hash_update_t rss_hash_update; /** Configure RSS hash protocols. */
1063 rss_hash_conf_get_t rss_hash_conf_get; /** Get current RSS hash configuration. */
1064 reta_update_t reta_update; /** Update redirection table. */
1065 reta_query_t reta_query; /** Query redirection table. */
1067 eth_get_reg_t get_reg; /**< Get registers. */
1068 eth_get_eeprom_length_t get_eeprom_length; /**< Get eeprom length. */
1069 eth_get_eeprom_t get_eeprom; /**< Get eeprom data. */
1070 eth_set_eeprom_t set_eeprom; /**< Set eeprom. */
1072 eth_get_module_info_t get_module_info;
1073 /** Get plugin module eeprom attribute. */
1074 eth_get_module_eeprom_t get_module_eeprom;
1075 /** Get plugin module eeprom data. */
1077 eth_flow_ops_get_t flow_ops_get; /**< Get flow operations. */
1079 eth_get_dcb_info get_dcb_info; /** Get DCB information. */
1081 eth_timesync_enable_t timesync_enable;
1082 /** Turn IEEE1588/802.1AS timestamping on. */
1083 eth_timesync_disable_t timesync_disable;
1084 /** Turn IEEE1588/802.1AS timestamping off. */
1085 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1086 /** Read the IEEE1588/802.1AS RX timestamp. */
1087 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1088 /** Read the IEEE1588/802.1AS TX timestamp. */
1089 eth_timesync_adjust_time timesync_adjust_time; /** Adjust the device clock. */
1090 eth_timesync_read_time timesync_read_time; /** Get the device clock time. */
1091 eth_timesync_write_time timesync_write_time; /** Set the device clock time. */
1093 eth_read_clock read_clock;
1095 eth_xstats_get_by_id_t xstats_get_by_id;
1096 /**< Get extended device statistic values by ID. */
1097 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1098 /**< Get name of extended device statistics by ID. */
1100 eth_tm_ops_get_t tm_ops_get;
1101 /**< Get Traffic Management (TM) operations. */
1103 eth_mtr_ops_get_t mtr_ops_get;
1104 /**< Get Traffic Metering and Policing (MTR) operations. */
1106 eth_pool_ops_supported_t pool_ops_supported;
1107 /**< Test if a port supports specific mempool ops */
1109 eth_hairpin_cap_get_t hairpin_cap_get;
1110 /**< Returns the hairpin capabilities. */
1111 eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
1112 /**< Set up device RX hairpin queue. */
1113 eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
1114 /**< Set up device TX hairpin queue. */
1116 eth_fec_get_capability_t fec_get_capability;
1117 /**< Get Forward Error Correction(FEC) capability. */
1118 eth_fec_get_t fec_get;
1119 /**< Get Forward Error Correction(FEC) mode. */
1120 eth_fec_set_t fec_set;
1121 /**< Set Forward Error Correction(FEC) mode. */
1122 hairpin_get_peer_ports_t hairpin_get_peer_ports;
1123 /**< Get hairpin peer ports list. */
1124 eth_hairpin_bind_t hairpin_bind;
1125 /**< Bind all hairpin Tx queues of device to the peer port Rx queues. */
1126 eth_hairpin_unbind_t hairpin_unbind;
1127 /**< Unbind all hairpin Tx queues from the peer port Rx queues. */
1128 eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
1129 /**< Pass the current queue info and get the peer queue info. */
1130 eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
1131 /**< Set up the connection between the pair of hairpin queues. */
1132 eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
1133 /**< Disconnect the hairpin queues of a pair from each other. */
1135 eth_get_monitor_addr_t get_monitor_addr;
1136 /**< Get power monitoring condition for Rx queue. */
1138 eth_representor_info_get_t representor_info_get;
1139 /**< Get representor info. */
1142 * Negotiate the NIC's ability to deliver specific
1143 * kinds of metadata to the PMD.
1145 eth_rx_metadata_negotiate_t rx_metadata_negotiate;
1150 * Check if the selected Rx queue is hairpin queue.
1153 * Pointer to the selected device.
1155 * The selected queue.
1158 * - (1) if the queue is hairpin queue, 0 otherwise.
1161 int rte_eth_dev_is_rx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
1165 * Check if the selected Tx queue is hairpin queue.
1168 * Pointer to the selected device.
1170 * The selected queue.
1173 * - (1) if the queue is hairpin queue, 0 otherwise.
1176 int rte_eth_dev_is_tx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
1180 * Returns a ethdev slot specified by the unique identifier name.
1183 * The pointer to the Unique identifier name for each Ethernet device
1185 * - The pointer to the ethdev slot, on success. NULL on error
1188 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1192 * Allocates a new ethdev slot for an ethernet device and returns the pointer
1193 * to that slot for the driver to use.
1195 * @param name Unique identifier name for each Ethernet device
1197 * - Slot in the rte_dev_devices array for a new device;
1200 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1204 * Attach to the ethdev already initialized by the primary
1207 * @param name Ethernet device's name.
1209 * - Success: Slot in the rte_dev_devices array for attached
1211 * - Error: Null pointer.
1214 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1218 * Notify RTE_ETH_EVENT_DESTROY and release the specified ethdev port.
1220 * The following PMD-managed data fields will be freed:
1224 * If one of these fields should not be freed,
1225 * it must be reset to NULL by the PMD, typically in dev_close method.
1228 * Device to be detached.
1230 * - 0 on success, negative on error
1233 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1237 * Release device queues and clear its configuration to force the user
1238 * application to reconfigure it. It is for internal use only.
1241 * Pointer to struct rte_eth_dev.
1247 void rte_eth_dev_internal_reset(struct rte_eth_dev *dev);
1250 * @internal Executes all the user application registered callbacks for
1251 * the specific device. It is for DPDK internal user only. User
1252 * application should not call it directly.
1255 * Pointer to struct rte_eth_dev.
1257 * Eth device interrupt event type.
1259 * To pass data back to user application.
1260 * This allows the user application to decide if a particular function
1261 * is permitted or not.
1267 int rte_eth_dev_callback_process(struct rte_eth_dev *dev,
1268 enum rte_eth_event_type event, void *ret_param);
1272 * This is the last step of device probing.
1273 * It must be called after a port is allocated and initialized successfully.
1275 * The notification RTE_ETH_EVENT_NEW is sent to other entities
1276 * (libraries and applications).
1277 * The state is set as RTE_ETH_DEV_ATTACHED.
1283 void rte_eth_dev_probing_finish(struct rte_eth_dev *dev);
1286 * Create memzone for HW rings.
1287 * malloc can't be used as the physical address is needed.
1288 * If the memzone is already created, then this function returns a ptr
1292 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1294 * The name of the memory zone
1296 * The index of the queue to add to name
1298 * The sizeof of the memory area
1300 * Alignment for resulting memzone. Must be a power of 2.
1302 * The *socket_id* argument is the socket identifier in case of NUMA.
1305 const struct rte_memzone *
1306 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
1307 uint16_t queue_id, size_t size,
1308 unsigned align, int socket_id);
1311 * Free previously allocated memzone for HW rings.
1314 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1316 * The name of the memory zone
1318 * The index of the queue to add to name
1320 * Negative errno value on error, 0 on success.
1324 rte_eth_dma_zone_free(const struct rte_eth_dev *eth_dev, const char *name,
1329 * Atomically set the link status for the specific device.
1330 * It is for use by DPDK device driver use only.
1331 * User applications should not call it
1334 * Pointer to struct rte_eth_dev.
1336 * New link status value.
1338 * Same convention as eth_link_update operation.
1339 * 0 if link up status has changed
1340 * -1 if link up status was unchanged
1343 rte_eth_linkstatus_set(struct rte_eth_dev *dev,
1344 const struct rte_eth_link *new_link)
1346 uint64_t *dev_link = (uint64_t *)&(dev->data->dev_link);
1349 struct rte_eth_link link;
1352 RTE_BUILD_BUG_ON(sizeof(*new_link) != sizeof(uint64_t));
1354 orig.val64 = __atomic_exchange_n(dev_link, *(const uint64_t *)new_link,
1357 return (orig.link.link_status == new_link->link_status) ? -1 : 0;
1362 * Atomically get the link speed and status.
1365 * Pointer to struct rte_eth_dev.
1367 * link status value.
1370 rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
1371 struct rte_eth_link *link)
1373 uint64_t *src = (uint64_t *)&(dev->data->dev_link);
1374 uint64_t *dst = (uint64_t *)link;
1376 RTE_BUILD_BUG_ON(sizeof(*link) != sizeof(uint64_t));
1378 *dst = __atomic_load_n(src, __ATOMIC_SEQ_CST);
1382 * Allocate an unique switch domain identifier.
1384 * A pool of switch domain identifiers which can be allocated on request. This
1385 * will enabled devices which support the concept of switch domains to request
1386 * a switch domain id which is guaranteed to be unique from other devices
1387 * running in the same process.
1390 * switch domain identifier parameter to pass back to application
1393 * Negative errno value on error, 0 on success.
1397 rte_eth_switch_domain_alloc(uint16_t *domain_id);
1400 * Free switch domain.
1402 * Return a switch domain identifier to the pool of free identifiers after it is
1403 * no longer in use by device.
1406 * switch domain identifier to free
1409 * Negative errno value on error, 0 on success.
1413 rte_eth_switch_domain_free(uint16_t domain_id);
1416 * Generic Ethernet device arguments
1418 * One type of representor each structure.
1420 struct rte_eth_devargs {
1421 uint16_t mh_controllers[RTE_MAX_MULTI_HOST_CTRLS];
1422 /** controller/s number in case of multi-host */
1423 uint16_t nb_mh_controllers;
1424 /** number of controllers in multi-host controllers field */
1425 uint16_t ports[RTE_MAX_ETHPORTS];
1426 /** port/s number to enable on a multi-port single function */
1428 /** number of ports in ports field */
1429 uint16_t representor_ports[RTE_MAX_ETHPORTS];
1430 /** representor port/s identifier to enable on device */
1431 uint16_t nb_representor_ports;
1432 /** number of ports in representor port field */
1433 enum rte_eth_representor_type type; /* type of representor */
1437 * PMD helper function to get representor ID from location detail.
1439 * Get representor ID from controller, pf and (sf or vf).
1440 * The mapping is retrieved from rte_eth_representor_info_get().
1442 * For backward compatibility, if no representor info, direct
1443 * map legacy VF (no controller and pf).
1446 * Port ID of the backing device.
1450 * Controller ID, -1 if unspecified.
1452 * PF port ID, -1 if unspecified.
1453 * @param representor_port
1454 * VF or SF representor port number, -1 if unspecified.
1456 * Pointer to output representor ID.
1459 * Negative errno value on error, 0 on success.
1463 rte_eth_representor_id_get(uint16_t port_id,
1464 enum rte_eth_representor_type type,
1465 int controller, int pf, int representor_port,
1469 * PMD helper function to parse ethdev arguments
1473 * @param eth_devargs
1474 * parsed ethdev specific arguments.
1477 * Negative errno value on error, 0 on success.
1481 rte_eth_devargs_parse(const char *devargs, struct rte_eth_devargs *eth_devargs);
1484 typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
1485 typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
1486 void *bus_specific_init_params);
1489 * PMD helper function for the creation of a new ethdev ports.
1492 * rte_device handle.
1495 * @param priv_data_size
1496 * size of private data required for port.
1497 * @param bus_specific_init
1498 * port bus specific initialisation callback function
1499 * @param bus_init_params
1500 * port bus specific initialisation parameters
1501 * @param ethdev_init
1502 * device specific port initialization callback function
1503 * @param init_params
1504 * port initialisation parameters
1507 * Negative errno value on error, 0 on success.
1511 rte_eth_dev_create(struct rte_device *device, const char *name,
1512 size_t priv_data_size,
1513 ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
1514 ethdev_init_t ethdev_init, void *init_params);
1517 typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);
1520 * PMD helper function for cleaning up the resources of a ethdev port on it's
1524 * ethdev handle of port.
1525 * @param ethdev_uninit
1526 * device specific port un-initialise callback function
1529 * Negative errno value on error, 0 on success.
1533 rte_eth_dev_destroy(struct rte_eth_dev *ethdev, ethdev_uninit_t ethdev_uninit);
1537 * Pass the current hairpin queue HW and/or SW information to the peer queue
1538 * and fetch back the information of the peer queue.
1541 * Peer port identifier of the Ethernet device.
1543 * Peer queue index of the port.
1545 * Pointer to the current information structure.
1547 * Pointer to the peer information, output.
1549 * Direction to pass the information.
1550 * positive - pass Tx queue information and get peer Rx queue information
1551 * zero - pass Rx queue information and get peer Tx queue information
1554 * Negative errno value on error, 0 on success.
1558 rte_eth_hairpin_queue_peer_update(uint16_t peer_port, uint16_t peer_queue,
1559 struct rte_hairpin_peer_info *cur_info,
1560 struct rte_hairpin_peer_info *peer_info,
1561 uint32_t direction);
1565 * Configure current hairpin queue with the peer information fetched to create
1566 * the connection (bind) with peer queue in the specified direction.
1567 * This function might need to be called twice to fully create the connections.
1570 * Current port identifier of the Ethernet device.
1572 * Current queue index of the port.
1574 * Pointer to the peer information, input.
1576 * Direction to create the connection.
1577 * positive - bind current Tx queue to peer Rx queue
1578 * zero - bind current Rx queue to peer Tx queue
1581 * Negative errno value on error, 0 on success.
1585 rte_eth_hairpin_queue_peer_bind(uint16_t cur_port, uint16_t cur_queue,
1586 struct rte_hairpin_peer_info *peer_info,
1587 uint32_t direction);
1591 * Reset the current queue state and configuration to disconnect (unbind) it
1592 * from the peer queue.
1593 * This function might need to be called twice to disconnect each other.
1596 * Current port identifier of the Ethernet device.
1598 * Current queue index of the port.
1600 * Direction to destroy the connection.
1601 * positive - unbind current Tx queue from peer Rx queue
1602 * zero - unbind current Rx queue from peer Tx queue
1605 * Negative errno value on error, 0 on success.
1609 rte_eth_hairpin_queue_peer_unbind(uint16_t cur_port, uint16_t cur_queue,
1610 uint32_t direction);
1614 * Legacy ethdev API used internally by drivers.
1617 enum rte_filter_type {
1618 RTE_ETH_FILTER_NONE = 0,
1619 RTE_ETH_FILTER_ETHERTYPE,
1620 RTE_ETH_FILTER_FLEXIBLE,
1622 RTE_ETH_FILTER_NTUPLE,
1623 RTE_ETH_FILTER_TUNNEL,
1624 RTE_ETH_FILTER_FDIR,
1625 RTE_ETH_FILTER_HASH,
1626 RTE_ETH_FILTER_L2_TUNNEL,
1630 * Define all structures for Ethertype Filter type.
1633 #define RTE_ETHTYPE_FLAGS_MAC 0x0001 /**< If set, compare mac */
1634 #define RTE_ETHTYPE_FLAGS_DROP 0x0002 /**< If set, drop packet when match */
1637 * A structure used to define the ethertype filter entry
1638 * to support RTE_ETH_FILTER_ETHERTYPE data representation.
1640 struct rte_eth_ethertype_filter {
1641 struct rte_ether_addr mac_addr; /**< Mac address to match. */
1642 uint16_t ether_type; /**< Ether type to match */
1643 uint16_t flags; /**< Flags from RTE_ETHTYPE_FLAGS_* */
1644 uint16_t queue; /**< Queue assigned to when match*/
1648 * A structure used to define the TCP syn filter entry
1649 * to support RTE_ETH_FILTER_SYN data representation.
1651 struct rte_eth_syn_filter {
1652 /** 1 - higher priority than other filters, 0 - lower priority. */
1654 uint16_t queue; /**< Queue assigned to when match */
1658 * filter type of tunneling packet
1660 #define ETH_TUNNEL_FILTER_OMAC 0x01 /**< filter by outer MAC addr */
1661 #define ETH_TUNNEL_FILTER_OIP 0x02 /**< filter by outer IP Addr */
1662 #define ETH_TUNNEL_FILTER_TENID 0x04 /**< filter by tenant ID */
1663 #define ETH_TUNNEL_FILTER_IMAC 0x08 /**< filter by inner MAC addr */
1664 #define ETH_TUNNEL_FILTER_IVLAN 0x10 /**< filter by inner VLAN ID */
1665 #define ETH_TUNNEL_FILTER_IIP 0x20 /**< filter by inner IP addr */
1667 #define RTE_TUNNEL_FILTER_IMAC_IVLAN (ETH_TUNNEL_FILTER_IMAC | \
1668 ETH_TUNNEL_FILTER_IVLAN)
1669 #define RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID (ETH_TUNNEL_FILTER_IMAC | \
1670 ETH_TUNNEL_FILTER_IVLAN | \
1671 ETH_TUNNEL_FILTER_TENID)
1672 #define RTE_TUNNEL_FILTER_IMAC_TENID (ETH_TUNNEL_FILTER_IMAC | \
1673 ETH_TUNNEL_FILTER_TENID)
1674 #define RTE_TUNNEL_FILTER_OMAC_TENID_IMAC (ETH_TUNNEL_FILTER_OMAC | \
1675 ETH_TUNNEL_FILTER_TENID | \
1676 ETH_TUNNEL_FILTER_IMAC)
1679 * Select IPv4 or IPv6 for tunnel filters.
1681 enum rte_tunnel_iptype {
1682 RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4. */
1683 RTE_TUNNEL_IPTYPE_IPV6, /**< IPv6. */
1687 * Tunneling Packet filter configuration.
1689 struct rte_eth_tunnel_filter_conf {
1690 struct rte_ether_addr outer_mac; /**< Outer MAC address to match. */
1691 struct rte_ether_addr inner_mac; /**< Inner MAC address to match. */
1692 uint16_t inner_vlan; /**< Inner VLAN to match. */
1693 enum rte_tunnel_iptype ip_type; /**< IP address type. */
1695 * Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
1696 * is set in filter_type, or inner destination IP address to match
1697 * if ETH_TUNNEL_FILTER_IIP is set in filter_type.
1700 uint32_t ipv4_addr; /**< IPv4 address in big endian. */
1701 uint32_t ipv6_addr[4]; /**< IPv6 address in big endian. */
1703 /** Flags from ETH_TUNNEL_FILTER_XX - see above. */
1704 uint16_t filter_type;
1705 enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
1706 uint32_t tenant_id; /**< Tenant ID to match. VNI, GRE key... */
1707 uint16_t queue_id; /**< Queue assigned to if match. */
1710 #endif /* _RTE_ETHDEV_DRIVER_H_ */