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