sfc_dp_tx.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (c) 2016-2018 Solarflare Communications Inc.
   4  * All rights reserved.
   5  *
   6  * This software was jointly developed between OKTET Labs (under contract
   7  * for Solarflare) and Solarflare Communications, Inc.
   8  */
   9
  10 #ifndef _SFC_DP_TX_H
  11 #define _SFC_DP_TX_H
  12
  13 #include <rte_ethdev.h>
  14
  15 #include "sfc_dp.h"
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif
  20
  21 /**
  22  * Generic transmit queue information used on data path.
  23  * It must be kept as small as it is possible since it is built into
  24  * the structure used on datapath.
  25  */
  26 struct sfc_dp_txq {
  27         struct sfc_dp_queue     dpq;
  28 };
  29
  30 /**
  31  * Datapath transmit queue creation information.
  32  *
  33  * The structure is used just to pass information from control path to
  34  * datapath. It could be just function arguments, but it would be hardly
  35  * readable.
  36  */
  37 struct sfc_dp_tx_qcreate_info {
  38         /** Maximum number of pushed Tx descriptors */
  39         unsigned int            max_fill_level;
  40         /** Minimum number of unused Tx descriptors to do reap */
  41         unsigned int            free_thresh;
  42         /** Transmit queue configuration flags */
  43         unsigned int            flags;
  44         /** Tx queue size */
  45         unsigned int            txq_entries;
  46         /** Maximum size of data in the DMA descriptor */
  47         uint16_t                dma_desc_size_max;
  48         /** DMA-mapped Tx descriptors ring */
  49         void                    *txq_hw_ring;
  50         /** Associated event queue size */
  51         unsigned int            evq_entries;
  52         /** Hardware event ring */
  53         void                    *evq_hw_ring;
  54         /** The queue index in hardware (required to push right doorbell) */
  55         unsigned int            hw_index;
  56         /** Virtual address of the memory-mapped BAR to push Tx doorbell */
  57         volatile void           *mem_bar;
  58 };
  59
  60 /**
  61  * Get Tx datapath specific device info.
  62  *
  63  * @param dev_info              Device info to be adjusted
  64  */
  65 typedef void (sfc_dp_tx_get_dev_info_t)(struct rte_eth_dev_info *dev_info);
  66
  67 /**
  68  * Get size of transmit and event queue rings by the number of Tx
  69  * descriptors.
  70  *
  71  * @param nb_tx_desc            Number of Tx descriptors
  72  * @param txq_entries           Location for number of Tx ring entries
  73  * @param evq_entries           Location for number of event ring entries
  74  * @param txq_max_fill_level    Location for maximum Tx ring fill level
  75  *
  76  * @return 0 or positive errno.
  77  */
  78 typedef int (sfc_dp_tx_qsize_up_rings_t)(uint16_t nb_tx_desc,
  79                                          unsigned int *txq_entries,
  80                                          unsigned int *evq_entries,
  81                                          unsigned int *txq_max_fill_level);
  82
  83 /**
  84  * Allocate and initialize datapath transmit queue.
  85  *
  86  * @param port_id       The port identifier
  87  * @param queue_id      The queue identifier
  88  * @param pci_addr      PCI function address
  89  * @param socket_id     Socket identifier to allocate memory
  90  * @param info          Tx queue details wrapped in structure
  91  * @param dp_txqp       Location for generic datapath transmit queue pointer
  92  *
  93  * @return 0 or positive errno.
  94  */
  95 typedef int (sfc_dp_tx_qcreate_t)(uint16_t port_id, uint16_t queue_id,
  96                                   const struct rte_pci_addr *pci_addr,
  97                                   int socket_id,
  98                                   const struct sfc_dp_tx_qcreate_info *info,
  99                                   struct sfc_dp_txq **dp_txqp);
 100
 101 /**
 102  * Free resources allocated for datapath transmit queue.
 103  */
 104 typedef void (sfc_dp_tx_qdestroy_t)(struct sfc_dp_txq *dp_txq);
 105
 106 /**
 107  * Transmit queue start callback.
 108  *
 109  * It handovers EvQ to the datapath.
 110  */
 111 typedef int (sfc_dp_tx_qstart_t)(struct sfc_dp_txq *dp_txq,
 112                                  unsigned int evq_read_ptr,
 113                                  unsigned int txq_desc_index);
 114
 115 /**
 116  * Transmit queue stop function called before the queue flush.
 117  *
 118  * It returns EvQ to the control path.
 119  */
 120 typedef void (sfc_dp_tx_qstop_t)(struct sfc_dp_txq *dp_txq,
 121                                  unsigned int *evq_read_ptr);
 122
 123 /**
 124  * Transmit event handler used during queue flush only.
 125  */
 126 typedef bool (sfc_dp_tx_qtx_ev_t)(struct sfc_dp_txq *dp_txq, unsigned int id);
 127
 128 /**
 129  * Transmit queue function called after the queue flush.
 130  */
 131 typedef void (sfc_dp_tx_qreap_t)(struct sfc_dp_txq *dp_txq);
 132
 133 /**
 134  * Check Tx descriptor status
 135  */
 136 typedef int (sfc_dp_tx_qdesc_status_t)(struct sfc_dp_txq *dp_txq,
 137                                        uint16_t offset);
 138
 139 /** Transmit datapath definition */
 140 struct sfc_dp_tx {
 141         struct sfc_dp                   dp;
 142
 143         unsigned int                    features;
 144 #define SFC_DP_TX_FEAT_VLAN_INSERT      0x1
 145 #define SFC_DP_TX_FEAT_TSO              0x2
 146 #define SFC_DP_TX_FEAT_MULTI_SEG        0x4
 147 #define SFC_DP_TX_FEAT_MULTI_PROCESS    0x8
 148 #define SFC_DP_TX_FEAT_MULTI_POOL       0x10
 149 #define SFC_DP_TX_FEAT_REFCNT           0x20
 150         sfc_dp_tx_get_dev_info_t        *get_dev_info;
 151         sfc_dp_tx_qsize_up_rings_t      *qsize_up_rings;
 152         sfc_dp_tx_qcreate_t             *qcreate;
 153         sfc_dp_tx_qdestroy_t            *qdestroy;
 154         sfc_dp_tx_qstart_t              *qstart;
 155         sfc_dp_tx_qstop_t               *qstop;
 156         sfc_dp_tx_qtx_ev_t              *qtx_ev;
 157         sfc_dp_tx_qreap_t               *qreap;
 158         sfc_dp_tx_qdesc_status_t        *qdesc_status;
 159         eth_tx_burst_t                  pkt_burst;
 160 };
 161
 162 static inline struct sfc_dp_tx *
 163 sfc_dp_find_tx_by_name(struct sfc_dp_list *head, const char *name)
 164 {
 165         struct sfc_dp *p = sfc_dp_find_by_name(head, SFC_DP_TX, name);
 166
 167         return (p == NULL) ? NULL : container_of(p, struct sfc_dp_tx, dp);
 168 }
 169
 170 static inline struct sfc_dp_tx *
 171 sfc_dp_find_tx_by_caps(struct sfc_dp_list *head, unsigned int avail_caps)
 172 {
 173         struct sfc_dp *p = sfc_dp_find_by_caps(head, SFC_DP_TX, avail_caps);
 174
 175         return (p == NULL) ? NULL : container_of(p, struct sfc_dp_tx, dp);
 176 }
 177
 178 extern struct sfc_dp_tx sfc_efx_tx;
 179 extern struct sfc_dp_tx sfc_ef10_tx;
 180 extern struct sfc_dp_tx sfc_ef10_simple_tx;
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif
 185 #endif /* _SFC_DP_TX_H */