drivers/net/iavf/iavf.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Intel Corporation
   3  */
   4
   5 #ifndef _IAVF_ETHDEV_H_
   6 #define _IAVF_ETHDEV_H_
   7
   8 #include <rte_kvargs.h>
   9 #include <iavf_prototype.h>
  10 #include <iavf_adminq_cmd.h>
  11 #include <iavf_type.h>
  12
  13 #include "iavf_log.h"
  14
  15 #define IAVF_AQ_LEN               32
  16 #define IAVF_AQ_BUF_SZ            4096
  17 #define IAVF_RESET_WAIT_CNT       50
  18 #define IAVF_BUF_SIZE_MIN         1024
  19 #define IAVF_FRAME_SIZE_MAX       9728
  20 #define IAVF_QUEUE_BASE_ADDR_UNIT 128
  21
  22 #define IAVF_MAX_NUM_QUEUES       16
  23
  24 #define IAVF_NUM_MACADDR_MAX      64
  25
  26 #define IAVF_DEFAULT_RX_PTHRESH      8
  27 #define IAVF_DEFAULT_RX_HTHRESH      8
  28 #define IAVF_DEFAULT_RX_WTHRESH      0
  29
  30 #define IAVF_DEFAULT_RX_FREE_THRESH  32
  31
  32 #define IAVF_DEFAULT_TX_PTHRESH      32
  33 #define IAVF_DEFAULT_TX_HTHRESH      0
  34 #define IAVF_DEFAULT_TX_WTHRESH      0
  35
  36 #define IAVF_DEFAULT_TX_FREE_THRESH  32
  37 #define IAVF_DEFAULT_TX_RS_THRESH 32
  38
  39 #define IAVF_BASIC_OFFLOAD_CAPS  ( \
  40         VF_BASE_MODE_OFFLOADS | \
  41         VIRTCHNL_VF_OFFLOAD_WB_ON_ITR | \
  42         VIRTCHNL_VF_OFFLOAD_RX_POLLING)
  43
  44 #define IAVF_RSS_OFFLOAD_ALL ( \
  45         ETH_RSS_FRAG_IPV4 |         \
  46         ETH_RSS_NONFRAG_IPV4_TCP |  \
  47         ETH_RSS_NONFRAG_IPV4_UDP |  \
  48         ETH_RSS_NONFRAG_IPV4_SCTP | \
  49         ETH_RSS_NONFRAG_IPV4_OTHER)
  50
  51 #define IAVF_MISC_VEC_ID                RTE_INTR_VEC_ZERO_OFFSET
  52 #define IAVF_RX_VEC_START               RTE_INTR_VEC_RXTX_OFFSET
  53
  54 /* Default queue interrupt throttling time in microseconds */
  55 #define IAVF_ITR_INDEX_DEFAULT          0
  56 #define IAVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
  57 #define IAVF_QUEUE_ITR_INTERVAL_MAX     8160 /* 8160 us */
  58
  59 /* The overhead from MTU to max frame size.
  60  * Considering QinQ packet, the VLAN tag needs to be counted twice.
  61  */
  62 #define IAVF_VLAN_TAG_SIZE               4
  63 #define IAVF_ETH_OVERHEAD \
  64         (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + IAVF_VLAN_TAG_SIZE * 2)
  65
  66 #define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
  67 #define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
  68 #define IAVF_48_BIT_MASK  RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
  69
  70 struct iavf_adapter;
  71 struct iavf_rx_queue;
  72 struct iavf_tx_queue;
  73
  74 /* Structure that defines a VSI, associated with a adapter. */
  75 struct iavf_vsi {
  76         struct iavf_adapter *adapter; /* Backreference to associated adapter */
  77         uint16_t vsi_id;
  78         uint16_t nb_qps;         /* Number of queue pairs VSI can occupy */
  79         uint16_t nb_used_qps;    /* Number of queue pairs VSI uses */
  80         uint16_t max_macaddrs;   /* Maximum number of MAC addresses */
  81         uint16_t base_vector;
  82         uint16_t msix_intr;      /* The MSIX interrupt binds to VSI */
  83         struct virtchnl_eth_stats eth_stats_offset;
  84 };
  85
  86 /* TODO: is that correct to assume the max number to be 16 ?*/
  87 #define IAVF_MAX_MSIX_VECTORS   16
  88
  89 /* Structure to store private data specific for VF instance. */
  90 struct iavf_info {
  91         uint16_t num_queue_pairs;
  92         uint16_t max_pkt_len; /* Maximum packet length */
  93         uint16_t mac_num;     /* Number of MAC addresses */
  94         bool promisc_unicast_enabled;
  95         bool promisc_multicast_enabled;
  96
  97         struct virtchnl_version_info virtchnl_version;
  98         struct virtchnl_vf_resource *vf_res; /* VF resource */
  99         struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
 100
 101         volatile enum virtchnl_ops pend_cmd; /* pending command not finished */
 102         uint32_t cmd_retval; /* return value of the cmd response from PF */
 103         uint8_t *aq_resp; /* buffer to store the adminq response from PF */
 104
 105         /* Event from pf */
 106         bool dev_closed;
 107         bool link_up;
 108         uint32_t link_speed;
 109
 110         struct iavf_vsi vsi;
 111         bool vf_reset;
 112         uint64_t flags;
 113
 114         uint8_t *rss_lut;
 115         uint8_t *rss_key;
 116         uint16_t nb_msix;   /* number of MSI-X interrupts on Rx */
 117         uint16_t msix_base; /* msix vector base from */
 118         /* queue bitmask for each vector */
 119         uint16_t rxq_map[IAVF_MAX_MSIX_VECTORS];
 120 };
 121
 122 #define IAVF_MAX_PKT_TYPE 256
 123
 124 /* Structure to store private data for each VF instance. */
 125 struct iavf_adapter {
 126         struct iavf_hw hw;
 127         struct rte_eth_dev *eth_dev;
 128         struct iavf_info vf;
 129
 130         bool rx_bulk_alloc_allowed;
 131         /* For vector PMD */
 132         bool rx_vec_allowed;
 133         bool tx_vec_allowed;
 134         bool stopped;
 135 };
 136
 137 /* IAVF_DEV_PRIVATE_TO */
 138 #define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
 139         ((struct iavf_adapter *)adapter)
 140 #define IAVF_DEV_PRIVATE_TO_VF(adapter) \
 141         (&((struct iavf_adapter *)adapter)->vf)
 142 #define IAVF_DEV_PRIVATE_TO_HW(adapter) \
 143         (&((struct iavf_adapter *)adapter)->hw)
 144
 145 /* IAVF_VSI_TO */
 146 #define IAVF_VSI_TO_HW(vsi) \
 147         (&(((struct iavf_vsi *)vsi)->adapter->hw))
 148 #define IAVF_VSI_TO_VF(vsi) \
 149         (&(((struct iavf_vsi *)vsi)->adapter->vf))
 150 #define IAVF_VSI_TO_ETH_DEV(vsi) \
 151         (((struct iavf_vsi *)vsi)->adapter->eth_dev)
 152
 153 static inline void
 154 iavf_init_adminq_parameter(struct iavf_hw *hw)
 155 {
 156         hw->aq.num_arq_entries = IAVF_AQ_LEN;
 157         hw->aq.num_asq_entries = IAVF_AQ_LEN;
 158         hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
 159         hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
 160 }
 161
 162 static inline uint16_t
 163 iavf_calc_itr_interval(int16_t interval)
 164 {
 165         if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
 166                 interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
 167
 168         /* Convert to hardware count, as writing each 1 represents 2 us */
 169         return interval / 2;
 170 }
 171
 172 /* structure used for sending and checking response of virtchnl ops */
 173 struct iavf_cmd_info {
 174         enum virtchnl_ops ops;
 175         uint8_t *in_args;       /* buffer for sending */
 176         uint32_t in_args_size;  /* buffer size for sending */
 177         uint8_t *out_buffer;    /* buffer for response */
 178         uint32_t out_size;      /* buffer size for response */
 179 };
 180
 181 /* notify current command done. Only call in case execute
 182  * _atomic_set_cmd successfully.
 183  */
 184 static inline void
 185 _notify_cmd(struct iavf_info *vf, uint32_t msg_ret)
 186 {
 187         vf->cmd_retval = msg_ret;
 188         rte_wmb();
 189         vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
 190 }
 191
 192 /* clear current command. Only call in case execute
 193  * _atomic_set_cmd successfully.
 194  */
 195 static inline void
 196 _clear_cmd(struct iavf_info *vf)
 197 {
 198         rte_wmb();
 199         vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
 200         vf->cmd_retval = VIRTCHNL_STATUS_SUCCESS;
 201 }
 202
 203 /* Check there is pending cmd in execution. If none, set new command. */
 204 static inline int
 205 _atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
 206 {
 207         int ret = rte_atomic32_cmpset(&vf->pend_cmd, VIRTCHNL_OP_UNKNOWN, ops);
 208
 209         if (!ret)
 210                 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
 211
 212         return !ret;
 213 }
 214
 215 int iavf_check_api_version(struct iavf_adapter *adapter);
 216 int iavf_get_vf_resource(struct iavf_adapter *adapter);
 217 void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
 218 int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
 219 int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
 220 int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
 221                      bool rx, bool on);
 222 int iavf_enable_queues(struct iavf_adapter *adapter);
 223 int iavf_disable_queues(struct iavf_adapter *adapter);
 224 int iavf_configure_rss_lut(struct iavf_adapter *adapter);
 225 int iavf_configure_rss_key(struct iavf_adapter *adapter);
 226 int iavf_configure_queues(struct iavf_adapter *adapter);
 227 int iavf_config_irq_map(struct iavf_adapter *adapter);
 228 void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
 229 int iavf_dev_link_update(struct rte_eth_dev *dev,
 230                         __rte_unused int wait_to_complete);
 231 int iavf_query_stats(struct iavf_adapter *adapter,
 232                     struct virtchnl_eth_stats **pstats);
 233 int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
 234                        bool enable_multicast);
 235 int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
 236                          struct rte_ether_addr *addr, bool add);
 237 int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
 238 #endif /* _IAVF_ETHDEV_H_ */