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