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