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_DFLT         16
  23 #define IAVF_MAX_NUM_QUEUES_LV           256
  24 #define IAVF_CFG_Q_NUM_PER_BUF           32
  25 #define IAVF_IRQ_MAP_NUM_PER_BUF         128
  26
  27 #define IAVF_NUM_MACADDR_MAX      64
  28
  29 #define IAVF_DEFAULT_RX_PTHRESH      8
  30 #define IAVF_DEFAULT_RX_HTHRESH      8
  31 #define IAVF_DEFAULT_RX_WTHRESH      0
  32
  33 #define IAVF_DEFAULT_RX_FREE_THRESH  32
  34
  35 #define IAVF_DEFAULT_TX_PTHRESH      32
  36 #define IAVF_DEFAULT_TX_HTHRESH      0
  37 #define IAVF_DEFAULT_TX_WTHRESH      0
  38
  39 #define IAVF_DEFAULT_TX_FREE_THRESH  32
  40 #define IAVF_DEFAULT_TX_RS_THRESH 32
  41
  42 #define IAVF_BASIC_OFFLOAD_CAPS  ( \
  43         VF_BASE_MODE_OFFLOADS | \
  44         VIRTCHNL_VF_OFFLOAD_WB_ON_ITR | \
  45         VIRTCHNL_VF_OFFLOAD_RX_POLLING)
  46
  47 #define IAVF_RSS_OFFLOAD_ALL ( \
  48         ETH_RSS_FRAG_IPV4 |         \
  49         ETH_RSS_NONFRAG_IPV4_TCP |  \
  50         ETH_RSS_NONFRAG_IPV4_UDP |  \
  51         ETH_RSS_NONFRAG_IPV4_SCTP | \
  52         ETH_RSS_NONFRAG_IPV4_OTHER)
  53
  54 #define IAVF_MISC_VEC_ID                RTE_INTR_VEC_ZERO_OFFSET
  55 #define IAVF_RX_VEC_START               RTE_INTR_VEC_RXTX_OFFSET
  56
  57 /* Default queue interrupt throttling time in microseconds */
  58 #define IAVF_ITR_INDEX_DEFAULT          0
  59 #define IAVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
  60 #define IAVF_QUEUE_ITR_INTERVAL_MAX     8160 /* 8160 us */
  61
  62 /* The overhead from MTU to max frame size.
  63  * Considering QinQ packet, the VLAN tag needs to be counted twice.
  64  */
  65 #define IAVF_VLAN_TAG_SIZE               4
  66 #define IAVF_ETH_OVERHEAD \
  67         (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + IAVF_VLAN_TAG_SIZE * 2)
  68
  69 #define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
  70 #define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
  71 #define IAVF_48_BIT_MASK  RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
  72
  73 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_MASK  0x03
  74 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_FD_ID 0x01
  75
  76 struct iavf_adapter;
  77 struct iavf_rx_queue;
  78 struct iavf_tx_queue;
  79
  80 /* Structure that defines a VSI, associated with a adapter. */
  81 struct iavf_vsi {
  82         struct iavf_adapter *adapter; /* Backreference to associated adapter */
  83         uint16_t vsi_id;
  84         uint16_t nb_qps;         /* Number of queue pairs VSI can occupy */
  85         uint16_t nb_used_qps;    /* Number of queue pairs VSI uses */
  86         uint16_t max_macaddrs;   /* Maximum number of MAC addresses */
  87         uint16_t base_vector;
  88         uint16_t msix_intr;      /* The MSIX interrupt binds to VSI */
  89         struct virtchnl_eth_stats eth_stats_offset;
  90 };
  91
  92 struct rte_flow;
  93 TAILQ_HEAD(iavf_flow_list, rte_flow);
  94
  95 struct iavf_flow_parser_node;
  96 TAILQ_HEAD(iavf_parser_list, iavf_flow_parser_node);
  97
  98 struct iavf_fdir_conf {
  99         struct virtchnl_fdir_add add_fltr;
 100         struct virtchnl_fdir_del del_fltr;
 101         uint64_t input_set;
 102         uint32_t flow_id;
 103         uint32_t mark_flag;
 104 };
 105
 106 struct iavf_fdir_info {
 107         struct iavf_fdir_conf conf;
 108 };
 109
 110 struct iavf_qv_map {
 111         uint16_t queue_id;
 112         uint16_t vector_id;
 113 };
 114
 115 /* Message type read in admin queue from PF */
 116 enum iavf_aq_result {
 117         IAVF_MSG_ERR = -1, /* Meet error when accessing admin queue */
 118         IAVF_MSG_NON,      /* Read nothing from admin queue */
 119         IAVF_MSG_SYS,      /* Read system msg from admin queue */
 120         IAVF_MSG_CMD,      /* Read async command result */
 121 };
 122
 123 /* Structure to store private data specific for VF instance. */
 124 struct iavf_info {
 125         uint16_t num_queue_pairs;
 126         uint16_t max_pkt_len; /* Maximum packet length */
 127         uint16_t mac_num;     /* Number of MAC addresses */
 128         bool promisc_unicast_enabled;
 129         bool promisc_multicast_enabled;
 130
 131         struct virtchnl_version_info virtchnl_version;
 132         struct virtchnl_vf_resource *vf_res; /* VF resource */
 133         struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
 134         uint64_t supported_rxdid;
 135
 136         volatile enum virtchnl_ops pend_cmd; /* pending command not finished */
 137         uint32_t cmd_retval; /* return value of the cmd response from PF */
 138         uint8_t *aq_resp; /* buffer to store the adminq response from PF */
 139
 140         /* Event from pf */
 141         bool dev_closed;
 142         bool link_up;
 143         uint32_t link_speed;
 144
 145         /* Multicast addrs */
 146         struct rte_ether_addr mc_addrs[IAVF_NUM_MACADDR_MAX];
 147         uint16_t mc_addrs_num;   /* Multicast mac addresses number */
 148
 149         struct iavf_vsi vsi;
 150         bool vf_reset;  /* true for VF reset pending, false for no VF reset */
 151         uint64_t flags;
 152
 153         uint8_t *rss_lut;
 154         uint8_t *rss_key;
 155         uint16_t nb_msix;   /* number of MSI-X interrupts on Rx */
 156         uint16_t msix_base; /* msix vector base from */
 157         uint16_t max_rss_qregion; /* max RSS queue region supported by PF */
 158         struct iavf_qv_map *qv_map; /* queue vector mapping */
 159         struct iavf_flow_list flow_list;
 160         rte_spinlock_t flow_ops_lock;
 161         struct iavf_parser_list rss_parser_list;
 162         struct iavf_parser_list dist_parser_list;
 163
 164         struct iavf_fdir_info fdir; /* flow director info */
 165         /* indicate large VF support enabled or not */
 166         bool lv_enabled;
 167 };
 168
 169 #define IAVF_MAX_PKT_TYPE 1024
 170
 171 /* Structure to store private data for each VF instance. */
 172 struct iavf_adapter {
 173         struct iavf_hw hw;
 174         struct rte_eth_dev *eth_dev;
 175         struct iavf_info vf;
 176
 177         bool rx_bulk_alloc_allowed;
 178         /* For vector PMD */
 179         bool rx_vec_allowed;
 180         bool tx_vec_allowed;
 181         const uint32_t *ptype_tbl;
 182         bool stopped;
 183         uint16_t fdir_ref_cnt;
 184 };
 185
 186 /* IAVF_DEV_PRIVATE_TO */
 187 #define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
 188         ((struct iavf_adapter *)adapter)
 189 #define IAVF_DEV_PRIVATE_TO_VF(adapter) \
 190         (&((struct iavf_adapter *)adapter)->vf)
 191 #define IAVF_DEV_PRIVATE_TO_HW(adapter) \
 192         (&((struct iavf_adapter *)adapter)->hw)
 193
 194 /* IAVF_VSI_TO */
 195 #define IAVF_VSI_TO_HW(vsi) \
 196         (&(((struct iavf_vsi *)vsi)->adapter->hw))
 197 #define IAVF_VSI_TO_VF(vsi) \
 198         (&(((struct iavf_vsi *)vsi)->adapter->vf))
 199 #define IAVF_VSI_TO_ETH_DEV(vsi) \
 200         (((struct iavf_vsi *)vsi)->adapter->eth_dev)
 201
 202 static inline void
 203 iavf_init_adminq_parameter(struct iavf_hw *hw)
 204 {
 205         hw->aq.num_arq_entries = IAVF_AQ_LEN;
 206         hw->aq.num_asq_entries = IAVF_AQ_LEN;
 207         hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
 208         hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
 209 }
 210
 211 static inline uint16_t
 212 iavf_calc_itr_interval(int16_t interval)
 213 {
 214         if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
 215                 interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
 216
 217         /* Convert to hardware count, as writing each 1 represents 2 us */
 218         return interval / 2;
 219 }
 220
 221 /* structure used for sending and checking response of virtchnl ops */
 222 struct iavf_cmd_info {
 223         enum virtchnl_ops ops;
 224         uint8_t *in_args;       /* buffer for sending */
 225         uint32_t in_args_size;  /* buffer size for sending */
 226         uint8_t *out_buffer;    /* buffer for response */
 227         uint32_t out_size;      /* buffer size for response */
 228 };
 229
 230 /* notify current command done. Only call in case execute
 231  * _atomic_set_cmd successfully.
 232  */
 233 static inline void
 234 _notify_cmd(struct iavf_info *vf, uint32_t msg_ret)
 235 {
 236         vf->cmd_retval = msg_ret;
 237         rte_wmb();
 238         vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
 239 }
 240
 241 /* clear current command. Only call in case execute
 242  * _atomic_set_cmd successfully.
 243  */
 244 static inline void
 245 _clear_cmd(struct iavf_info *vf)
 246 {
 247         rte_wmb();
 248         vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
 249         vf->cmd_retval = VIRTCHNL_STATUS_SUCCESS;
 250 }
 251
 252 /* Check there is pending cmd in execution. If none, set new command. */
 253 static inline int
 254 _atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
 255 {
 256         int ret = rte_atomic32_cmpset(&vf->pend_cmd, VIRTCHNL_OP_UNKNOWN, ops);
 257
 258         if (!ret)
 259                 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
 260
 261         return !ret;
 262 }
 263
 264 int iavf_check_api_version(struct iavf_adapter *adapter);
 265 int iavf_get_vf_resource(struct iavf_adapter *adapter);
 266 void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
 267 int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
 268 int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
 269 int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
 270                      bool rx, bool on);
 271 int iavf_enable_queues(struct iavf_adapter *adapter);
 272 int iavf_disable_queues(struct iavf_adapter *adapter);
 273 int iavf_configure_rss_lut(struct iavf_adapter *adapter);
 274 int iavf_configure_rss_key(struct iavf_adapter *adapter);
 275 int iavf_configure_queues(struct iavf_adapter *adapter,
 276                         uint16_t num_queue_pairs, uint16_t index);
 277 int iavf_get_supported_rxdid(struct iavf_adapter *adapter);
 278 int iavf_config_irq_map(struct iavf_adapter *adapter);
 279 int iavf_config_irq_map_lv(struct iavf_adapter *adapter, uint16_t num,
 280                         uint16_t index);
 281 void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
 282 int iavf_dev_link_update(struct rte_eth_dev *dev,
 283                         __rte_unused int wait_to_complete);
 284 int iavf_query_stats(struct iavf_adapter *adapter,
 285                     struct virtchnl_eth_stats **pstats);
 286 int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
 287                        bool enable_multicast);
 288 int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
 289                          struct rte_ether_addr *addr, bool add);
 290 int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
 291 int iavf_fdir_add(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
 292 int iavf_fdir_del(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
 293 int iavf_fdir_check(struct iavf_adapter *adapter,
 294                 struct iavf_fdir_conf *filter);
 295 int iavf_add_del_rss_cfg(struct iavf_adapter *adapter,
 296                          struct virtchnl_rss_cfg *rss_cfg, bool add);
 297 int iavf_add_del_mc_addr_list(struct iavf_adapter *adapter,
 298                         struct rte_ether_addr *mc_addrs,
 299                         uint32_t mc_addrs_num, bool add);
 300 int iavf_request_queues(struct iavf_adapter *adapter, uint16_t num);
 301 int iavf_get_max_rss_queue_region(struct iavf_adapter *adapter);
 302 #endif /* _IAVF_ETHDEV_H_ */