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