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