1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _RTE_ETHDEV_CORE_H_
6 #define _RTE_ETHDEV_CORE_H_
13 * RTE Ethernet Device internal header.
15 * This header contains internal data types. But they are still part of the
16 * public API because they are used by inline functions in the published API.
18 * Applications should not use these directly.
22 struct rte_eth_dev_callback;
23 /** @internal Structure to keep track of registered callbacks */
24 TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
28 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
29 struct rte_mbuf **rx_pkts,
31 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
33 typedef uint16_t (*eth_tx_burst_t)(void *txq,
34 struct rte_mbuf **tx_pkts,
36 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
38 typedef uint16_t (*eth_tx_prep_t)(void *txq,
39 struct rte_mbuf **tx_pkts,
41 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
44 typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
45 uint16_t rx_queue_id);
46 /**< @internal Get number of used descriptors on a receive queue. */
48 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
49 /**< @internal Check DD bit of specific RX descriptor */
51 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
52 /**< @internal Check the status of a Rx descriptor */
54 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
55 /**< @internal Check the status of a Tx descriptor */
60 * Structure used to hold information about the callbacks to be called for a
63 struct rte_eth_rxtx_callback {
64 struct rte_eth_rxtx_callback *next;
66 rte_rx_callback_fn rx;
67 rte_tx_callback_fn tx;
74 * The generic data structure associated with each ethernet device.
76 * Pointers to burst-oriented packet receive and transmit functions are
77 * located at the beginning of the structure, along with the pointer to
78 * where all the data elements for the particular device are stored in shared
79 * memory. This split allows the function pointer and driver data to be per-
80 * process, while the actual configuration data for the device is shared.
83 eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
84 eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
85 eth_tx_prep_t tx_pkt_prepare; /**< Pointer to PMD transmit prepare function. */
87 eth_rx_queue_count_t rx_queue_count; /**< Get the number of used RX descriptors. */
88 eth_rx_descriptor_done_t rx_descriptor_done; /**< Check rxd DD bit. */
89 eth_rx_descriptor_status_t rx_descriptor_status; /**< Check the status of a Rx descriptor. */
90 eth_tx_descriptor_status_t tx_descriptor_status; /**< Check the status of a Tx descriptor. */
93 * Next two fields are per-device data but *data is shared between
94 * primary and secondary processes and *process_private is per-process
95 * private. The second one is managed by PMDs if necessary.
97 struct rte_eth_dev_data *data; /**< Pointer to device data. */
98 void *process_private; /**< Pointer to per-process device data. */
99 const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
100 struct rte_device *device; /**< Backing device */
101 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
102 /** User application callbacks for NIC interrupts */
103 struct rte_eth_dev_cb_list link_intr_cbs;
105 * User-supplied functions called from rx_burst to post-process
106 * received packets before passing them to the user
108 struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
110 * User-supplied functions called from tx_burst to pre-process
111 * received packets before passing them to the driver for transmission.
113 struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
114 enum rte_eth_dev_state state; /**< Flag indicating the port state */
115 void *security_ctx; /**< Context for security ops */
117 uint64_t reserved_64s[4]; /**< Reserved for future fields */
118 void *reserved_ptrs[4]; /**< Reserved for future fields */
119 } __rte_cache_aligned;
121 struct rte_eth_dev_sriov;
122 struct rte_eth_dev_owner;
126 * The data part, with no function pointers, associated with each ethernet device.
128 * This structure is safe to place in shared memory to be common among different
129 * processes in a multi-process configuration.
131 struct rte_eth_dev_data {
132 char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
134 void **rx_queues; /**< Array of pointers to RX queues. */
135 void **tx_queues; /**< Array of pointers to TX queues. */
136 uint16_t nb_rx_queues; /**< Number of RX queues. */
137 uint16_t nb_tx_queues; /**< Number of TX queues. */
139 struct rte_eth_dev_sriov sriov; /**< SRIOV data */
142 /**< PMD-specific private data.
143 * @see rte_eth_dev_release_port()
146 struct rte_eth_link dev_link; /**< Link-level information & status. */
147 struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
148 uint16_t mtu; /**< Maximum Transmission Unit. */
149 uint32_t min_rx_buf_size;
150 /**< Common RX buffer size handled by all queues. */
152 uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
153 struct rte_ether_addr *mac_addrs;
154 /**< Device Ethernet link address.
155 * @see rte_eth_dev_release_port()
157 uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
158 /**< Bitmap associating MAC addresses to pools. */
159 struct rte_ether_addr *hash_mac_addrs;
160 /**< Device Ethernet MAC addresses of hash filtering.
161 * @see rte_eth_dev_release_port()
163 uint16_t port_id; /**< Device [external] port identifier. */
166 uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
167 scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
168 all_multicast : 1, /**< RX all multicast mode ON(1) / OFF(0). */
169 dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
170 lro : 1, /**< RX LRO is ON(1) / OFF(0) */
172 /**< Indicates whether the device is configured.
173 * CONFIGURED(1) / NOT CONFIGURED(0).
175 uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
176 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
177 uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
178 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
179 uint32_t dev_flags; /**< Capabilities. */
180 int numa_node; /**< NUMA node connection. */
181 struct rte_vlan_filter_conf vlan_filter_conf;
182 /**< VLAN filter configuration. */
183 struct rte_eth_dev_owner owner; /**< The port owner. */
184 uint16_t representor_id;
185 /**< Switch-specific identifier.
186 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
189 pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
190 uint64_t reserved_64s[4]; /**< Reserved for future fields */
191 void *reserved_ptrs[4]; /**< Reserved for future fields */
192 } __rte_cache_aligned;
196 * The pool of *rte_eth_dev* structures. The size of the pool
197 * is configured at compile-time in the <rte_ethdev.c> file.
199 extern struct rte_eth_dev rte_eth_devices[];
201 #endif /* _RTE_ETHDEV_CORE_H_ */