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