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 /** Pointer to PMD transmit prepare function */
48 eth_tx_prep_t tx_pkt_prepare;
49 /** Get the number of used Rx descriptors */
50 eth_rx_queue_count_t rx_queue_count;
51 /** Check the status of a Rx descriptor */
52 eth_rx_descriptor_status_t rx_descriptor_status;
53 /** Check the status of a Tx descriptor */
54 eth_tx_descriptor_status_t tx_descriptor_status;
57 * Device data that is shared between primary and secondary processes
59 struct rte_eth_dev_data *data;
60 void *process_private; /**< Pointer to per-process device data. */
61 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
62 struct rte_device *device; /**< Backing device */
63 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
64 /** User application callbacks for NIC interrupts */
65 struct rte_eth_dev_cb_list link_intr_cbs;
67 * User-supplied functions called from rx_burst to post-process
68 * received packets before passing them to the user
70 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
72 * User-supplied functions called from tx_burst to pre-process
73 * received packets before passing them to the driver for transmission.
75 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
76 enum rte_eth_dev_state state; /**< Flag indicating the port state */
77 void *security_ctx; /**< Context for security ops */
78 } __rte_cache_aligned;
80 struct rte_eth_dev_sriov;
81 struct rte_eth_dev_owner;
85 * The data part, with no function pointers, associated with each Ethernet
86 * device. This structure is safe to place in shared memory to be common
87 * among different processes in a multi-process configuration.
89 struct rte_eth_dev_data {
90 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
92 void **rx_queues; /**< Array of pointers to Rx queues. */
93 void **tx_queues; /**< Array of pointers to Tx queues. */
94 uint16_t nb_rx_queues; /**< Number of Rx queues. */
95 uint16_t nb_tx_queues; /**< Number of Tx queues. */
97 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
99 /** PMD-specific private data. @see rte_eth_dev_release_port() */
102 struct rte_eth_link dev_link; /**< Link-level information & status. */
103 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
104 uint16_t mtu; /**< Maximum Transmission Unit. */
105 /** Common Rx buffer size handled by all queues */
106 uint32_t min_rx_buf_size;
108 uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures */
109 /** Device Ethernet link address. @see rte_eth_dev_release_port() */
110 struct rte_ether_addr *mac_addrs;
111 /** Bitmap associating MAC addresses to pools */
112 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
114 * Device Ethernet MAC addresses of hash filtering.
115 * @see rte_eth_dev_release_port()
117 struct rte_ether_addr *hash_mac_addrs;
118 uint16_t port_id; /**< Device [external] port identifier. */
121 uint8_t /** Rx promiscuous mode ON(1) / OFF(0) */
123 /** Rx of scattered packets is ON(1) / OFF(0) */
125 /** Rx all multicast mode ON(1) / OFF(0) */
127 /** Device state: STARTED(1) / STOPPED(0) */
129 /** Rx LRO is ON(1) / OFF(0) */
132 * Indicates whether the device is configured:
133 * CONFIGURED(1) / NOT CONFIGURED(0)
136 /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
137 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
138 /** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
139 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
140 uint32_t dev_flags; /**< Capabilities. */
141 int numa_node; /**< NUMA node connection. */
142 /** VLAN filter configuration */
143 struct rte_vlan_filter_conf vlan_filter_conf;
144 struct rte_eth_dev_owner owner; /**< The port owner. */
146 * Switch-specific identifier.
147 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
149 uint16_t representor_id;
151 * Port ID of the backing device.
152 * This device will be used to query representor info and calculate
153 * representor IDs. Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
155 uint16_t backer_port_id;
157 pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
158 } __rte_cache_aligned;
162 * The pool of *rte_eth_dev* structures. The size of the pool
163 * is configured at compile-time in the <rte_ethdev.c> file.
165 extern struct rte_eth_dev rte_eth_devices[];
167 /** @internal Declaration of the hairpin peer queue information structure. */
168 struct rte_hairpin_peer_info;
171 * Definitions of all functions exported by an Ethernet driver through the
172 * generic structure of type *eth_dev_ops* supplied in the *rte_eth_dev*
173 * structure associated with an Ethernet device.
176 /** @internal Ethernet device configuration. */
177 typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev);
179 /** @internal Function used to start a configured Ethernet device. */
180 typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev);
182 /** @internal Function used to stop a configured Ethernet device. */
183 typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
185 /** @internal Function used to link up a configured Ethernet device. */
186 typedef int (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
188 /** @internal Function used to link down a configured Ethernet device. */
189 typedef int (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
191 /** @internal Function used to close a configured Ethernet device. */
192 typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
194 /** @internal Function used to reset a configured Ethernet device. */
195 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
197 /** @internal Function used to detect an Ethernet device removal. */
198 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
202 * Function used to enable the Rx promiscuous mode of an Ethernet device.
205 * ethdev handle of port.
208 * Negative errno value on error, 0 on success.
211 * Success, promiscuous mode is enabled.
213 * Promiscuous mode is not supported.
216 * @retval -E_RTE_SECONDARY
217 * Function was called from a secondary process instance and not supported.
219 * Attempt to enable promiscuos mode failed because of timeout.
221 * Failed to enable promiscuous mode.
223 typedef int (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev);
227 * Function used to disable the Rx promiscuous mode of an Ethernet device.
230 * ethdev handle of port.
233 * Negative errno value on error, 0 on success.
236 * Success, promiscuous mode is disabled.
238 * Promiscuous mode disabling is not supported.
241 * @retval -E_RTE_SECONDARY
242 * Function was called from a secondary process instance and not supported.
244 * Attempt to disable promiscuos mode failed because of timeout.
246 * Failed to disable promiscuous mode.
248 typedef int (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev);
252 * Enable the receipt of all multicast packets by an Ethernet device.
255 * ethdev handle of port.
258 * Negative errno value on error, 0 on success.
261 * Success, all-multicast mode is enabled.
263 * All-multicast mode is not supported.
266 * @retval -E_RTE_SECONDARY
267 * Function was called from a secondary process instance and not supported.
269 * Attempt to enable all-multicast mode failed because of timeout.
271 * Failed to enable all-multicast mode.
273 typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
277 * Disable the receipt of all multicast packets by an Ethernet device.
280 * ethdev handle of port.
283 * Negative errno value on error, 0 on success.
286 * Success, all-multicast mode is disabled.
288 * All-multicast mode disabling is not supported.
291 * @retval -E_RTE_SECONDARY
292 * Function was called from a secondary process instance and not supported.
294 * Attempt to disable all-multicast mode failed because of timeout.
296 * Failed to disable all-multicast mode.
298 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
302 * Get link speed, duplex mode and state (up/down) of an Ethernet device.
304 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
305 int wait_to_complete);
307 /** @internal Get global I/O statistics of an Ethernet device. */
308 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
309 struct rte_eth_stats *igb_stats);
313 * Reset global I/O statistics of an Ethernet device to 0.
316 * ethdev handle of port.
319 * Negative errno value on error, 0 on success.
322 * Success, statistics has been reset.
324 * Resetting statistics is not supported.
326 * Resetting statistics is not valid.
328 * Not enough memory to get the stats.
330 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
332 /** @internal Get extended stats of an Ethernet device. */
333 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
334 struct rte_eth_xstat *stats, unsigned int n);
338 * Get extended stats of an Ethernet device.
341 * ethdev handle of port.
343 * IDs array to retrieve specific statistics. Must not be NULL.
345 * A pointer to a table to be filled with device statistics values.
348 * Element count in @p ids and @p values.
351 * - A number of filled in stats.
352 * - A negative value on error.
354 typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
361 * Reset extended stats of an Ethernet device.
364 * ethdev handle of port.
367 * Negative errno value on error, 0 on success.
370 * Success, statistics has been reset.
372 * Resetting statistics is not supported.
374 * Resetting statistics is not valid.
376 * Not enough memory to get the stats.
378 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
380 /** @internal Get names of extended stats of an Ethernet device. */
381 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
382 struct rte_eth_xstat_name *xstats_names, unsigned int size);
386 * Get names of extended stats of an Ethernet device.
389 * ethdev handle of port.
391 * IDs array to retrieve specific statistics. Must not be NULL.
392 * @param xstats_names
393 * An rte_eth_xstat_name array of at least @p size elements to be filled.
396 * Element count in @p ids and @p xstats_names.
399 * - A number of filled in stats.
400 * - A negative value on error.
402 typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
403 const uint64_t *ids, struct rte_eth_xstat_name *xstats_names,
408 * Set a queue statistics mapping for a Tx/Rx queue of an Ethernet device.
410 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
415 /** @internal Get specific information 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);
419 /** @internal Get supported ptypes of an Ethernet device. */
420 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
424 * Inform Ethernet device about reduced range of packet types to handle.
427 * The Ethernet device identifier.
429 * The ptype family that application is interested in should be bitwise OR of
430 * RTE_PTYPE_*_MASK or 0.
434 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
435 uint32_t ptype_mask);
437 /** @internal Start Rx and Tx of a queue of an Ethernet device. */
438 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
441 /** @internal Stop Rx and Tx of a queue of an Ethernet device. */
442 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
445 /** @internal Set up a receive 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);
453 /** @internal Setup a transmit 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);
460 /** @internal Enable interrupt of a receive queue of an Ethernet device. */
461 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
462 uint16_t rx_queue_id);
464 /** @internal Disable 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);
468 /** @internal Release memory resources allocated by given Rx/Tx queue. */
469 typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
472 /** @internal Get firmware information of an Ethernet device. */
473 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
474 char *fw_version, size_t fw_size);
476 /** @internal Force mbufs to be from Tx ring. */
477 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
479 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
480 uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
482 typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
483 uint16_t tx_queue_id, struct rte_eth_txq_info *qinfo);
485 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
486 uint16_t queue_id, struct rte_eth_burst_mode *mode);
488 /** @internal Set MTU. */
489 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
491 /** @internal Filtering of a VLAN Tag Identifier by an Ethernet device. */
492 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
496 /** @internal Set the outer/inner VLAN-TPID 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);
500 /** @internal Set VLAN offload function by an Ethernet device. */
501 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
503 /** @internal Set port based Tx VLAN insertion by an Ethernet device. */
504 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
508 /** @internal VLAN stripping enable/disable by an queue of Ethernet device. */
509 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
510 uint16_t rx_queue_id,
513 /** @internal Get current flow control parameter on an Ethernet device. */
514 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
515 struct rte_eth_fc_conf *fc_conf);
517 /** @internal Setup 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);
521 /** @internal Setup priority 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);
525 /** @internal Update RSS redirection table on an Ethernet device. */
526 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
527 struct rte_eth_rss_reta_entry64 *reta_conf,
530 /** @internal Query 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,
535 /** @internal Update RSS hash configuration of an Ethernet device. */
536 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
537 struct rte_eth_rss_conf *rss_conf);
539 /** @internal Get current 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);
543 /** @internal Turn on SW controllable LED on an Ethernet device. */
544 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
546 /** @internal Turn off SW controllable LED on an Ethernet device. */
547 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
549 /** @internal Remove MAC address from receive address register. */
550 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
552 /** @internal Set a MAC address into Receive Address Register. */
553 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
554 struct rte_ether_addr *mac_addr,
558 /** @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);
562 /** @internal Set a Unicast Hash bitmap. */
563 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
564 struct rte_ether_addr *mac_addr,
567 /** @internal Set all Unicast Hash bitmap. */
568 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
571 /** @internal Set queue Tx rate. */
572 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
576 /** @internal Add tunneling UDP port. */
577 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
578 struct rte_eth_udp_tunnel *tunnel_udp);
580 /** @internal Delete 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);
584 /** @internal set the list of multicast addresses on an Ethernet device. */
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);
589 /** @internal Function used to enable IEEE1588/802.1AS timestamping. */
590 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
592 /** @internal Function used to disable IEEE1588/802.1AS timestamping. */
593 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
595 /** @internal Function used to read an Rx IEEE1588/802.1AS timestamp. */
596 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
597 struct timespec *timestamp,
600 /** @internal Function used to read a Tx IEEE1588/802.1AS timestamp. */
601 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
602 struct timespec *timestamp);
604 /** @internal Function used to adjust the device clock. */
605 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
607 /** @internal Function used to get time from the device clock. */
608 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
609 struct timespec *timestamp);
611 /** @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);
615 /** @internal Function used to get the current value of the device clock. */
616 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
617 uint64_t *timestamp);
619 /** @internal Retrieve registers. */
620 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
621 struct rte_dev_reg_info *info);
623 /** @internal Retrieve EEPROM size. */
624 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
626 /** @internal Retrieve EEPROM data. */
627 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
628 struct rte_dev_eeprom_info *info);
630 /** @internal Program EEPROM data. */
631 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
632 struct rte_dev_eeprom_info *info);
634 /** @internal Retrieve type and size of plugin module EEPROM. */
635 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
636 struct rte_eth_dev_module_info *modinfo);
638 /** @internal Retrieve plugin module EEPROM data. */
639 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
640 struct rte_dev_eeprom_info *info);
645 * Get flow operations.
647 * If the flow API is not supported for the specified device,
648 * the driver can return NULL.
650 typedef int (*eth_flow_ops_get_t)(struct rte_eth_dev *dev,
651 const struct rte_flow_ops **ops);
653 /** @internal Get Traffic Management (TM) operations on an Ethernet device. */
654 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
656 /** @internal Get Traffic Metering and Policing (MTR) operations. */
657 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
659 /** @internal Get DCB information on an Ethernet device. */
660 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
661 struct rte_eth_dcb_info *dcb_info);
663 /** @internal Test if a port supports specific mempool ops. */
664 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
669 * Get the hairpin capabilities.
672 * ethdev handle of port.
674 * returns the hairpin capabilities from the device.
677 * Negative errno value on error, 0 on success.
680 * Success, hairpin is supported.
682 * Hairpin is not supported.
684 typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
685 struct rte_eth_hairpin_cap *cap);
689 * Setup Rx hairpin queue.
692 * ethdev handle of port.
694 * the selected Rx queue index.
696 * the requested number of descriptors for this queue. 0 - use PMD default.
698 * the Rx hairpin configuration structure.
701 * Negative errno value on error, 0 on success.
704 * Success, hairpin is supported.
706 * Hairpin is not supported.
708 * One of the parameters is invalid.
710 * Unable to allocate resources.
712 typedef int (*eth_rx_hairpin_queue_setup_t)
713 (struct rte_eth_dev *dev, uint16_t rx_queue_id,
715 const struct rte_eth_hairpin_conf *conf);
719 * Setup Tx hairpin queue.
722 * ethdev handle of port.
724 * the selected Tx queue index.
726 * the requested number of descriptors for this queue. 0 - use PMD default.
728 * the Tx hairpin configuration structure.
731 * Negative errno value on error, 0 on success.
734 * Success, hairpin is supported.
736 * Hairpin is not supported.
738 * One of the parameters is invalid.
740 * Unable to allocate resources.
742 typedef int (*eth_tx_hairpin_queue_setup_t)
743 (struct rte_eth_dev *dev, uint16_t tx_queue_id,
745 const struct rte_eth_hairpin_conf *hairpin_conf);
749 * Get Forward Error Correction(FEC) capability.
752 * ethdev handle of port.
753 * @param speed_fec_capa
754 * speed_fec_capa is out only with per-speed capabilities.
756 * a number of elements in an speed_fec_capa array.
759 * Negative errno value on error, positive value on success.
761 * @retval positive value
762 * A non-negative value lower or equal to num: success. The return value
763 * is the number of entries filled in the fec capa array.
764 * A non-negative value higher than num: error, the given fec capa array
765 * is too small. The return value corresponds to the num that should
766 * be given to succeed. The entries in the fec capa array are not valid
767 * and shall not be used by the caller.
769 * Operation is not supported.
773 * *num* or *speed_fec_capa* invalid.
775 typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
776 struct rte_eth_fec_capa *speed_fec_capa, unsigned int num);
780 * Get Forward Error Correction(FEC) mode.
783 * ethdev handle of port.
785 * a bitmask of enabled FEC modes. If AUTO bit is set, other
786 * bits specify FEC modes which may be negotiated. If AUTO
787 * bit is clear, specify FEC modes to be used (only one valid
788 * mode per speed may be set).
791 * Negative errno value on error, 0 on success.
794 * Success, get FEC success.
796 * Operation is not supported.
800 typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev,
805 * Set Forward Error Correction(FEC) mode.
808 * ethdev handle of port.
810 * bitmask of allowed FEC modes. It must be only one
811 * if AUTO is disabled. If AUTO is enabled, other
812 * bits specify FEC modes which may be negotiated.
815 * Negative errno value on error, 0 on success.
818 * Success, set FEC success.
820 * Operation is not supported.
822 * Unsupported FEC mode requested.
826 typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, uint32_t fec_capa);
830 * Get all hairpin Tx/Rx peer ports of the current device, if any.
833 * ethdev handle of port.
835 * array to save the ports list.
839 * value to decide the current to peer direction
840 * positive - used as Tx to get all peer Rx ports.
841 * zero - used as Rx to get all peer Tx ports.
844 * Negative errno value on error, 0 or positive on success.
847 * Success, no peer ports.
849 * Actual number of the peer ports.
851 * Get peer ports API is not supported.
853 * One of the parameters is invalid.
855 typedef int (*hairpin_get_peer_ports_t)(struct rte_eth_dev *dev,
856 uint16_t *peer_ports, size_t len,
861 * Bind all hairpin Tx queues of one port to the Rx queues of the peer port.
864 * ethdev handle of port.
869 * Negative errno value on error, 0 on success.
872 * Success, bind successfully.
874 * Bind API is not supported.
876 * One of the parameters is invalid.
878 * Device is not started.
880 typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
885 * Unbind all hairpin Tx queues of one port from the Rx queues of the peer port.
888 * ethdev handle of port.
893 * Negative errno value on error, 0 on success.
896 * Success, unbind successfully.
898 * Bind API is not supported.
900 * One of the parameters is invalid.
902 * Device is already stopped.
904 typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
907 /** @internal Update and fetch peer queue information. */
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);
913 /** @internal Bind peer queue to the current queue with fetched 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);
918 /** @internal Unbind peer queue from the current queue. */
919 typedef int (*eth_hairpin_queue_peer_unbind_t)
920 (struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
924 * Get address of memory location whose contents will change whenever there is
925 * new data to be received on an Rx queue.
928 * Ethdev queue pointer.
930 * The pointer to power-optimized monitoring condition structure.
932 * Negative errno value on error, 0 on success.
939 typedef int (*eth_get_monitor_addr_t)(void *rxq,
940 struct rte_power_monitor_cond *pmc);
944 * Get representor info to be able to calculate the unique representor ID.
946 * Caller should pass NULL as pointer of info to get number of entries,
947 * allocate info buffer according to returned entry number, then call
948 * again with buffer to get real info.
950 * To calculate the representor ID, caller should iterate each entry,
951 * match controller index, pf index, vf or sf start index and range,
952 * then calculate representor ID from offset to vf/sf start index.
953 * @see rte_eth_representor_id_get.
956 * Ethdev handle of port.
958 * Pointer to memory to save device representor info.
960 * Negative errno value on error, number of info entries otherwise.
963 typedef int (*eth_representor_info_get_t)(struct rte_eth_dev *dev,
964 struct rte_eth_representor_info *info);
968 * Negotiate the NIC's ability to deliver specific kinds of metadata to the PMD.
971 * Port (ethdev) handle
973 * @param[inout] features
974 * Feature selection buffer
977 * Negative errno value on error, zero otherwise
979 typedef int (*eth_rx_metadata_negotiate_t)(struct rte_eth_dev *dev,
983 * @internal A structure containing the functions exported by an Ethernet driver.
986 eth_dev_configure_t dev_configure; /**< Configure device. */
987 eth_dev_start_t dev_start; /**< Start device. */
988 eth_dev_stop_t dev_stop; /**< Stop device. */
989 eth_dev_set_link_up_t dev_set_link_up; /**< Device link up. */
990 eth_dev_set_link_down_t dev_set_link_down; /**< Device link down. */
991 eth_dev_close_t dev_close; /**< Close device. */
992 eth_dev_reset_t dev_reset; /**< Reset device. */
993 eth_link_update_t link_update; /**< Get device link state. */
994 /** Check if the device was physically removed */
995 eth_is_removed_t is_removed;
997 eth_promiscuous_enable_t promiscuous_enable; /**< Promiscuous ON. */
998 eth_promiscuous_disable_t promiscuous_disable;/**< Promiscuous OFF. */
999 eth_allmulticast_enable_t allmulticast_enable;/**< Rx multicast ON. */
1000 eth_allmulticast_disable_t allmulticast_disable;/**< Rx multicast OFF. */
1001 eth_mac_addr_remove_t mac_addr_remove; /**< Remove MAC address. */
1002 eth_mac_addr_add_t mac_addr_add; /**< Add a MAC address. */
1003 eth_mac_addr_set_t mac_addr_set; /**< Set a MAC address. */
1004 /** Set list of multicast addresses */
1005 eth_set_mc_addr_list_t set_mc_addr_list;
1006 mtu_set_t mtu_set; /**< Set MTU. */
1008 /** Get generic device statistics */
1009 eth_stats_get_t stats_get;
1010 /** Reset generic device statistics */
1011 eth_stats_reset_t stats_reset;
1012 /** Get extended device statistics */
1013 eth_xstats_get_t xstats_get;
1014 /** Reset extended device statistics */
1015 eth_xstats_reset_t xstats_reset;
1016 /** Get names of extended statistics */
1017 eth_xstats_get_names_t xstats_get_names;
1018 /** Configure per queue stat counter mapping */
1019 eth_queue_stats_mapping_set_t queue_stats_mapping_set;
1021 eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
1022 /** Retrieve Rx queue information */
1023 eth_rxq_info_get_t rxq_info_get;
1024 /** Retrieve Tx queue information */
1025 eth_txq_info_get_t txq_info_get;
1026 eth_burst_mode_get_t rx_burst_mode_get; /**< Get Rx burst mode */
1027 eth_burst_mode_get_t tx_burst_mode_get; /**< Get Tx burst mode */
1028 eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
1030 /** Get packet types supported and identified by device */
1031 eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
1033 * Inform Ethernet device about reduced range of packet types to
1036 eth_dev_ptypes_set_t dev_ptypes_set;
1038 /** Filter VLAN Setup */
1039 vlan_filter_set_t vlan_filter_set;
1040 /** Outer/Inner VLAN TPID Setup */
1041 vlan_tpid_set_t vlan_tpid_set;
1042 /** VLAN Stripping on queue */
1043 vlan_strip_queue_set_t vlan_strip_queue_set;
1044 /** Set VLAN Offload */
1045 vlan_offload_set_t vlan_offload_set;
1046 /** Set port based Tx VLAN insertion */
1047 vlan_pvid_set_t vlan_pvid_set;
1049 eth_queue_start_t rx_queue_start;/**< Start Rx for a queue. */
1050 eth_queue_stop_t rx_queue_stop; /**< Stop Rx for a queue. */
1051 eth_queue_start_t tx_queue_start;/**< Start Tx for a queue. */
1052 eth_queue_stop_t tx_queue_stop; /**< Stop Tx for a queue. */
1053 eth_rx_queue_setup_t rx_queue_setup;/**< Set up device Rx queue. */
1054 eth_queue_release_t rx_queue_release; /**< Release Rx queue. */
1056 /** Enable Rx queue interrupt */
1057 eth_rx_enable_intr_t rx_queue_intr_enable;
1058 /** Disable Rx queue interrupt */
1059 eth_rx_disable_intr_t rx_queue_intr_disable;
1061 eth_tx_queue_setup_t tx_queue_setup;/**< Set up device Tx queue */
1062 eth_queue_release_t tx_queue_release; /**< Release Tx queue */
1063 eth_tx_done_cleanup_t tx_done_cleanup;/**< Free Tx ring mbufs */
1065 eth_dev_led_on_t dev_led_on; /**< Turn on LED. */
1066 eth_dev_led_off_t dev_led_off; /**< Turn off LED. */
1068 flow_ctrl_get_t flow_ctrl_get; /**< Get flow control. */
1069 flow_ctrl_set_t flow_ctrl_set; /**< Setup flow control. */
1070 /** Setup priority flow control */
1071 priority_flow_ctrl_set_t priority_flow_ctrl_set;
1073 /** Set Unicast Table Array */
1074 eth_uc_hash_table_set_t uc_hash_table_set;
1075 /** Set Unicast hash bitmap */
1076 eth_uc_all_hash_table_set_t uc_all_hash_table_set;
1078 /** Add UDP tunnel port */
1079 eth_udp_tunnel_port_add_t udp_tunnel_port_add;
1080 /** Delete UDP tunnel port */
1081 eth_udp_tunnel_port_del_t udp_tunnel_port_del;
1083 /** Set queue rate limit */
1084 eth_set_queue_rate_limit_t set_queue_rate_limit;
1086 /** Configure RSS hash protocols and hashing key */
1087 rss_hash_update_t rss_hash_update;
1088 /** Get current RSS hash configuration */
1089 rss_hash_conf_get_t rss_hash_conf_get;
1090 /** Update redirection table */
1091 reta_update_t reta_update;
1092 /** Query redirection table */
1093 reta_query_t reta_query;
1095 eth_get_reg_t get_reg; /**< Get registers. */
1096 eth_get_eeprom_length_t get_eeprom_length; /**< Get EEPROM length. */
1097 eth_get_eeprom_t get_eeprom; /**< Get EEPROM data. */
1098 eth_set_eeprom_t set_eeprom; /**< Set EEPROM. */
1100 /** Get plugin module EEPROM attribute */
1101 eth_get_module_info_t get_module_info;
1102 /** Get plugin module EEPROM data */
1103 eth_get_module_eeprom_t get_module_eeprom;
1105 eth_flow_ops_get_t flow_ops_get; /**< Get flow operations. */
1107 eth_get_dcb_info get_dcb_info; /**< Get DCB information */
1109 /** Turn IEEE1588/802.1AS timestamping on */
1110 eth_timesync_enable_t timesync_enable;
1111 /** Turn IEEE1588/802.1AS timestamping off */
1112 eth_timesync_disable_t timesync_disable;
1113 /** Read the IEEE1588/802.1AS Rx timestamp */
1114 eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
1115 /** Read the IEEE1588/802.1AS Tx timestamp */
1116 eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
1117 /** Adjust the device clock */
1118 eth_timesync_adjust_time timesync_adjust_time;
1119 /** Get the device clock time */
1120 eth_timesync_read_time timesync_read_time;
1121 /** Set the device clock time */
1122 eth_timesync_write_time timesync_write_time;
1124 eth_read_clock read_clock;
1126 /** Get extended device statistic values by ID */
1127 eth_xstats_get_by_id_t xstats_get_by_id;
1128 /** Get name of extended device statistics by ID */
1129 eth_xstats_get_names_by_id_t xstats_get_names_by_id;
1131 /** Get Traffic Management (TM) operations */
1132 eth_tm_ops_get_t tm_ops_get;
1134 /** Get Traffic Metering and Policing (MTR) operations */
1135 eth_mtr_ops_get_t mtr_ops_get;
1137 /** Test if a port supports specific mempool ops */
1138 eth_pool_ops_supported_t pool_ops_supported;
1140 /** Returns the hairpin capabilities */
1141 eth_hairpin_cap_get_t hairpin_cap_get;
1142 /** Set up device Rx hairpin queue */
1143 eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
1144 /** Set up device Tx hairpin queue */
1145 eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
1147 /** Get Forward Error Correction(FEC) capability */
1148 eth_fec_get_capability_t fec_get_capability;
1149 /** Get Forward Error Correction(FEC) mode */
1150 eth_fec_get_t fec_get;
1151 /** Set Forward Error Correction(FEC) mode */
1152 eth_fec_set_t fec_set;
1154 /** Get hairpin peer ports list */
1155 hairpin_get_peer_ports_t hairpin_get_peer_ports;
1156 /** Bind all hairpin Tx queues of device to the peer port Rx queues */
1157 eth_hairpin_bind_t hairpin_bind;
1158 /** Unbind all hairpin Tx queues from the peer port Rx queues */
1159 eth_hairpin_unbind_t hairpin_unbind;
1160 /** Pass the current queue info and get the peer queue info */
1161 eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
1162 /** Set up the connection between the pair of hairpin queues */
1163 eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
1164 /** Disconnect the hairpin queues of a pair from each other */
1165 eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
1167 /** Get power monitoring condition for Rx queue */
1168 eth_get_monitor_addr_t get_monitor_addr;
1170 /** Get representor info */
1171 eth_representor_info_get_t representor_info_get;
1174 * Negotiate the NIC's ability to deliver specific
1175 * kinds of metadata to the PMD.
1177 eth_rx_metadata_negotiate_t rx_metadata_negotiate;
1182 * Check if the selected Rx queue is hairpin queue.
1185 * Pointer to the selected device.
1187 * The selected queue.
1190 * - (1) if the queue is hairpin queue, 0 otherwise.
1193 int rte_eth_dev_is_rx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
1197 * Check if the selected Tx queue is hairpin queue.
1200 * Pointer to the selected device.
1202 * The selected queue.
1205 * - (1) if the queue is hairpin queue, 0 otherwise.
1208 int rte_eth_dev_is_tx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);
1212 * Returns a ethdev slot specified by the unique identifier name.
1215 * The pointer to the Unique identifier name for each Ethernet device
1217 * - The pointer to the ethdev slot, on success. NULL on error
1220 struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
1224 * Allocates a new ethdev slot for an Ethernet device and returns the pointer
1225 * to that slot for the driver to use.
1227 * @param name Unique identifier name for each Ethernet device
1229 * - Slot in the rte_dev_devices array for a new device;
1232 struct rte_eth_dev *rte_eth_dev_allocate(const char *name);
1236 * Attach to the ethdev already initialized by the primary
1239 * @param name Ethernet device's name.
1241 * - Success: Slot in the rte_dev_devices array for attached
1243 * - Error: Null pointer.
1246 struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);
1250 * Notify RTE_ETH_EVENT_DESTROY and release the specified ethdev port.
1252 * The following PMD-managed data fields will be freed:
1256 * If one of these fields should not be freed,
1257 * it must be reset to NULL by the PMD, typically in dev_close method.
1260 * Device to be detached.
1262 * - 0 on success, negative on error
1265 int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);
1269 * Release device queues and clear its configuration to force the user
1270 * application to reconfigure it. It is for internal use only.
1273 * Pointer to struct rte_eth_dev.
1279 void rte_eth_dev_internal_reset(struct rte_eth_dev *dev);
1282 * @internal Executes all the user application registered callbacks for
1283 * the specific device. It is for DPDK internal user only. User
1284 * application should not call it directly.
1287 * Pointer to struct rte_eth_dev.
1289 * Eth device interrupt event type.
1291 * To pass data back to user application.
1292 * This allows the user application to decide if a particular function
1293 * is permitted or not.
1299 int rte_eth_dev_callback_process(struct rte_eth_dev *dev,
1300 enum rte_eth_event_type event, void *ret_param);
1304 * This is the last step of device probing.
1305 * It must be called after a port is allocated and initialized successfully.
1307 * The notification RTE_ETH_EVENT_NEW is sent to other entities
1308 * (libraries and applications).
1309 * The state is set as RTE_ETH_DEV_ATTACHED.
1315 void rte_eth_dev_probing_finish(struct rte_eth_dev *dev);
1318 * Create memzone for HW rings.
1319 * malloc can't be used as the physical address is needed.
1320 * If the memzone is already created, then this function returns a ptr
1324 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1326 * The name of the memory zone
1328 * The index of the queue to add to name
1330 * The sizeof of the memory area
1332 * Alignment for resulting memzone. Must be a power of 2.
1334 * The *socket_id* argument is the socket identifier in case of NUMA.
1337 const struct rte_memzone *
1338 rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
1339 uint16_t queue_id, size_t size,
1340 unsigned align, int socket_id);
1343 * Free previously allocated memzone for HW rings.
1346 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure
1348 * The name of the memory zone
1350 * The index of the queue to add to name
1352 * Negative errno value on error, 0 on success.
1356 rte_eth_dma_zone_free(const struct rte_eth_dev *eth_dev, const char *name,
1361 * Atomically set the link status for the specific device.
1362 * It is for use by DPDK device driver use only.
1363 * User applications should not call it
1366 * Pointer to struct rte_eth_dev.
1368 * New link status value.
1370 * Same convention as eth_link_update operation.
1371 * 0 if link up status has changed
1372 * -1 if link up status was unchanged
1375 rte_eth_linkstatus_set(struct rte_eth_dev *dev,
1376 const struct rte_eth_link *new_link)
1378 uint64_t *dev_link = (uint64_t *)&(dev->data->dev_link);
1381 struct rte_eth_link link;
1384 RTE_BUILD_BUG_ON(sizeof(*new_link) != sizeof(uint64_t));
1386 orig.val64 = __atomic_exchange_n(dev_link, *(const uint64_t *)new_link,
1389 return (orig.link.link_status == new_link->link_status) ? -1 : 0;
1394 * Atomically get the link speed and status.
1397 * Pointer to struct rte_eth_dev.
1399 * link status value.
1402 rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
1403 struct rte_eth_link *link)
1405 uint64_t *src = (uint64_t *)&(dev->data->dev_link);
1406 uint64_t *dst = (uint64_t *)link;
1408 RTE_BUILD_BUG_ON(sizeof(*link) != sizeof(uint64_t));
1410 *dst = __atomic_load_n(src, __ATOMIC_SEQ_CST);
1414 * Allocate an unique switch domain identifier.
1416 * A pool of switch domain identifiers which can be allocated on request. This
1417 * will enabled devices which support the concept of switch domains to request
1418 * a switch domain ID which is guaranteed to be unique from other devices
1419 * running in the same process.
1422 * switch domain identifier parameter to pass back to application
1425 * Negative errno value on error, 0 on success.
1429 rte_eth_switch_domain_alloc(uint16_t *domain_id);
1432 * Free switch domain.
1434 * Return a switch domain identifier to the pool of free identifiers after it is
1435 * no longer in use by device.
1438 * switch domain identifier to free
1441 * Negative errno value on error, 0 on success.
1445 rte_eth_switch_domain_free(uint16_t domain_id);
1448 * Generic Ethernet device arguments
1450 * One type of representor each structure.
1452 struct rte_eth_devargs {
1453 uint16_t mh_controllers[RTE_MAX_MULTI_HOST_CTRLS];
1454 /** controller/s number in case of multi-host */
1455 uint16_t nb_mh_controllers;
1456 /** number of controllers in multi-host controllers field */
1457 uint16_t ports[RTE_MAX_ETHPORTS];
1458 /** port/s number to enable on a multi-port single function */
1460 /** number of ports in ports field */
1461 uint16_t representor_ports[RTE_MAX_ETHPORTS];
1462 /** representor port/s identifier to enable on device */
1463 uint16_t nb_representor_ports;
1464 /** number of ports in representor port field */
1465 enum rte_eth_representor_type type; /* type of representor */
1469 * PMD helper function to get representor ID from location detail.
1471 * Get representor ID from controller, pf and (sf or vf).
1472 * The mapping is retrieved from rte_eth_representor_info_get().
1474 * For backward compatibility, if no representor info, direct
1475 * map legacy VF (no controller and pf).
1478 * Port ID of the backing device.
1482 * Controller ID, -1 if unspecified.
1484 * PF port ID, -1 if unspecified.
1485 * @param representor_port
1486 * VF or SF representor port number, -1 if unspecified.
1488 * Pointer to output representor ID.
1491 * Negative errno value on error, 0 on success.
1495 rte_eth_representor_id_get(uint16_t port_id,
1496 enum rte_eth_representor_type type,
1497 int controller, int pf, int representor_port,
1501 * PMD helper function to parse ethdev arguments
1505 * @param eth_devargs
1506 * parsed ethdev specific arguments.
1509 * Negative errno value on error, 0 on success.
1513 rte_eth_devargs_parse(const char *devargs, struct rte_eth_devargs *eth_devargs);
1516 typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
1517 typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
1518 void *bus_specific_init_params);
1521 * PMD helper function for the creation of a new ethdev ports.
1524 * rte_device handle.
1527 * @param priv_data_size
1528 * size of private data required for port.
1529 * @param bus_specific_init
1530 * port bus specific initialisation callback function
1531 * @param bus_init_params
1532 * port bus specific initialisation parameters
1533 * @param ethdev_init
1534 * device specific port initialization callback function
1535 * @param init_params
1536 * port initialisation parameters
1539 * Negative errno value on error, 0 on success.
1543 rte_eth_dev_create(struct rte_device *device, const char *name,
1544 size_t priv_data_size,
1545 ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
1546 ethdev_init_t ethdev_init, void *init_params);
1549 typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);
1552 * PMD helper function for cleaning up the resources of a ethdev port on it's
1556 * ethdev handle of port.
1557 * @param ethdev_uninit
1558 * device specific port un-initialise callback function
1561 * Negative errno value on error, 0 on success.
1565 rte_eth_dev_destroy(struct rte_eth_dev *ethdev, ethdev_uninit_t ethdev_uninit);
1569 * Pass the current hairpin queue HW and/or SW information to the peer queue
1570 * and fetch back the information of the peer queue.
1573 * Peer port identifier of the Ethernet device.
1575 * Peer queue index of the port.
1577 * Pointer to the current information structure.
1579 * Pointer to the peer information, output.
1581 * Direction to pass the information.
1582 * positive - pass Tx queue information and get peer Rx queue information
1583 * zero - pass Rx queue information and get peer Tx queue information
1586 * Negative errno value on error, 0 on success.
1590 rte_eth_hairpin_queue_peer_update(uint16_t peer_port, uint16_t peer_queue,
1591 struct rte_hairpin_peer_info *cur_info,
1592 struct rte_hairpin_peer_info *peer_info,
1593 uint32_t direction);
1597 * Configure current hairpin queue with the peer information fetched to create
1598 * the connection (bind) with peer queue in the specified direction.
1599 * This function might need to be called twice to fully create the connections.
1602 * Current port identifier of the Ethernet device.
1604 * Current queue index of the port.
1606 * Pointer to the peer information, input.
1608 * Direction to create the connection.
1609 * positive - bind current Tx queue to peer Rx queue
1610 * zero - bind current Rx queue to peer Tx queue
1613 * Negative errno value on error, 0 on success.
1617 rte_eth_hairpin_queue_peer_bind(uint16_t cur_port, uint16_t cur_queue,
1618 struct rte_hairpin_peer_info *peer_info,
1619 uint32_t direction);
1623 * Reset the current queue state and configuration to disconnect (unbind) it
1624 * from the peer queue.
1625 * This function might need to be called twice to disconnect each other.
1628 * Current port identifier of the Ethernet device.
1630 * Current queue index of the port.
1632 * Direction to destroy the connection.
1633 * positive - unbind current Tx queue from peer Rx queue
1634 * zero - unbind current Rx queue from peer Tx queue
1637 * Negative errno value on error, 0 on success.
1641 rte_eth_hairpin_queue_peer_unbind(uint16_t cur_port, uint16_t cur_queue,
1642 uint32_t direction);
1646 * Legacy ethdev API used internally by drivers.
1649 enum rte_filter_type {
1650 RTE_ETH_FILTER_NONE = 0,
1651 RTE_ETH_FILTER_ETHERTYPE,
1652 RTE_ETH_FILTER_FLEXIBLE,
1654 RTE_ETH_FILTER_NTUPLE,
1655 RTE_ETH_FILTER_TUNNEL,
1656 RTE_ETH_FILTER_FDIR,
1657 RTE_ETH_FILTER_HASH,
1658 RTE_ETH_FILTER_L2_TUNNEL,
1662 * Define all structures for Ethertype Filter type.
1665 #define RTE_ETHTYPE_FLAGS_MAC 0x0001 /**< If set, compare mac */
1666 #define RTE_ETHTYPE_FLAGS_DROP 0x0002 /**< If set, drop packet when match */
1669 * A structure used to define the ethertype filter entry
1670 * to support RTE_ETH_FILTER_ETHERTYPE data representation.
1672 struct rte_eth_ethertype_filter {
1673 struct rte_ether_addr mac_addr; /**< Mac address to match. */
1674 uint16_t ether_type; /**< Ether type to match */
1675 uint16_t flags; /**< Flags from RTE_ETHTYPE_FLAGS_* */
1676 uint16_t queue; /**< Queue assigned to when match*/
1680 * A structure used to define the TCP syn filter entry
1681 * to support RTE_ETH_FILTER_SYN data representation.
1683 struct rte_eth_syn_filter {
1684 /** 1 - higher priority than other filters, 0 - lower priority. */
1686 uint16_t queue; /**< Queue assigned to when match */
1690 * filter type of tunneling packet
1692 #define ETH_TUNNEL_FILTER_OMAC 0x01 /**< filter by outer MAC addr */
1693 #define ETH_TUNNEL_FILTER_OIP 0x02 /**< filter by outer IP Addr */
1694 #define ETH_TUNNEL_FILTER_TENID 0x04 /**< filter by tenant ID */
1695 #define ETH_TUNNEL_FILTER_IMAC 0x08 /**< filter by inner MAC addr */
1696 #define ETH_TUNNEL_FILTER_IVLAN 0x10 /**< filter by inner VLAN ID */
1697 #define ETH_TUNNEL_FILTER_IIP 0x20 /**< filter by inner IP addr */
1699 #define RTE_TUNNEL_FILTER_IMAC_IVLAN (ETH_TUNNEL_FILTER_IMAC | \
1700 ETH_TUNNEL_FILTER_IVLAN)
1701 #define RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID (ETH_TUNNEL_FILTER_IMAC | \
1702 ETH_TUNNEL_FILTER_IVLAN | \
1703 ETH_TUNNEL_FILTER_TENID)
1704 #define RTE_TUNNEL_FILTER_IMAC_TENID (ETH_TUNNEL_FILTER_IMAC | \
1705 ETH_TUNNEL_FILTER_TENID)
1706 #define RTE_TUNNEL_FILTER_OMAC_TENID_IMAC (ETH_TUNNEL_FILTER_OMAC | \
1707 ETH_TUNNEL_FILTER_TENID | \
1708 ETH_TUNNEL_FILTER_IMAC)
1711 * Select IPv4 or IPv6 for tunnel filters.
1713 enum rte_tunnel_iptype {
1714 RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4. */
1715 RTE_TUNNEL_IPTYPE_IPV6, /**< IPv6. */
1719 * Tunneling Packet filter configuration.
1721 struct rte_eth_tunnel_filter_conf {
1722 struct rte_ether_addr outer_mac; /**< Outer MAC address to match. */
1723 struct rte_ether_addr inner_mac; /**< Inner MAC address to match. */
1724 uint16_t inner_vlan; /**< Inner VLAN to match. */
1725 enum rte_tunnel_iptype ip_type; /**< IP address type. */
1727 * Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
1728 * is set in filter_type, or inner destination IP address to match
1729 * if ETH_TUNNEL_FILTER_IIP is set in filter_type.
1732 uint32_t ipv4_addr; /**< IPv4 address in big endian. */
1733 uint32_t ipv6_addr[4]; /**< IPv6 address in big endian. */
1735 /** Flags from ETH_TUNNEL_FILTER_XX - see above. */
1736 uint16_t filter_type;
1737 enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
1738 uint32_t tenant_id; /**< Tenant ID to match. VNI, GRE key... */
1739 uint16_t queue_id; /**< Queue assigned to if match. */
1742 #endif /* _RTE_ETHDEV_DRIVER_H_ */