lib/librte_ethdev/rte_ethdev_core.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_ETHDEV_CORE_H_
   6 #define _RTE_ETHDEV_CORE_H_
   7
   8 #include <pthread.h>
   9
  10 /**
  11  * @file
  12  *
  13  * RTE Ethernet Device internal header.
  14  *
  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.
  17  *
  18  * Applications should not use these directly.
  19  *
  20  */
  21
  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);
  25
  26 struct rte_eth_dev;
  27
  28 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
  29                                    struct rte_mbuf **rx_pkts,
  30                                    uint16_t nb_pkts);
  31 /**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
  32
  33 typedef uint16_t (*eth_tx_burst_t)(void *txq,
  34                                    struct rte_mbuf **tx_pkts,
  35                                    uint16_t nb_pkts);
  36 /**< @internal Send output packets on a transmit queue of an Ethernet device. */
  37
  38 typedef uint16_t (*eth_tx_prep_t)(void *txq,
  39                                    struct rte_mbuf **tx_pkts,
  40                                    uint16_t nb_pkts);
  41 /**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
  42
  43
  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. */
  47
  48 typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
  49 /**< @internal Check DD bit of specific RX descriptor */
  50
  51 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
  52 /**< @internal Check the status of a Rx descriptor */
  53
  54 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
  55 /**< @internal Check the status of a Tx descriptor */
  56
  57
  58 /**
  59  * @internal
  60  * Structure used to hold information about the callbacks to be called for a
  61  * queue on RX and TX.
  62  */
  63 struct rte_eth_rxtx_callback {
  64         struct rte_eth_rxtx_callback *next;
  65         union{
  66                 rte_rx_callback_fn rx;
  67                 rte_tx_callback_fn tx;
  68         } fn;
  69         void *param;
  70 };
  71
  72 /**
  73  * @internal
  74  * The generic data structure associated with each ethernet device.
  75  *
  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.
  81  */
  82 struct rte_eth_dev {
  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. */
  86
  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. */
  91
  92         /**
  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.
  96          */
  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;
 104         /**
 105          * User-supplied functions called from rx_burst to post-process
 106          * received packets before passing them to the user
 107          */
 108         struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 109         /**
 110          * User-supplied functions called from tx_burst to pre-process
 111          * received packets before passing them to the driver for transmission.
 112          */
 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 */
 116
 117         uint64_t reserved_64s[4]; /**< Reserved for future fields */
 118         void *reserved_ptrs[4];   /**< Reserved for future fields */
 119 } __rte_cache_aligned;
 120
 121 struct rte_eth_dev_sriov;
 122 struct rte_eth_dev_owner;
 123
 124 /**
 125  * @internal
 126  * The data part, with no function pointers, associated with each ethernet device.
 127  *
 128  * This structure is safe to place in shared memory to be common among different
 129  * processes in a multi-process configuration.
 130  */
 131 struct rte_eth_dev_data {
 132         char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 133
 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. */
 138
 139         struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 140
 141         void *dev_private;
 142                         /**< PMD-specific private data.
 143                          *   @see rte_eth_dev_release_port()
 144                          */
 145
 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. */
 151
 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()
 156                          */
 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()
 162                          */
 163         uint16_t port_id;           /**< Device [external] port identifier. */
 164
 165         __extension__
 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) */
 171         uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 172                 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 173         uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 174                 /**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 175         uint32_t dev_flags;             /**< Capabilities. */
 176         int numa_node;                  /**< NUMA node connection. */
 177         struct rte_vlan_filter_conf vlan_filter_conf;
 178                         /**< VLAN filter configuration. */
 179         struct rte_eth_dev_owner owner; /**< The port owner. */
 180         uint16_t representor_id;
 181                         /**< Switch-specific identifier.
 182                          *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
 183                          */
 184
 185         pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
 186         uint64_t reserved_64s[4]; /**< Reserved for future fields */
 187         void *reserved_ptrs[4];   /**< Reserved for future fields */
 188 } __rte_cache_aligned;
 189
 190 /**
 191  * @internal
 192  * The pool of *rte_eth_dev* structures. The size of the pool
 193  * is configured at compile-time in the <rte_ethdev.c> file.
 194  */
 195 extern struct rte_eth_dev rte_eth_devices[];
 196
 197 #endif /* _RTE_ETHDEV_CORE_H_ */