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 <sys/queue.h>
   9
  10 #include <rte_kvargs.h>
  11 #include <rte_tm_driver.h>
  12
  13 #include <iavf_prototype.h>
  14 #include <iavf_adminq_cmd.h>
  15 #include <iavf_type.h>
  16
  17 #include "iavf_log.h"
  18
  19 #define IAVF_AQ_LEN               32
  20 #define IAVF_AQ_BUF_SZ            4096
  21 #define IAVF_RESET_WAIT_CNT       50
  22 #define IAVF_BUF_SIZE_MIN         1024
  23 #define IAVF_FRAME_SIZE_MAX       9728
  24 #define IAVF_QUEUE_BASE_ADDR_UNIT 128
  25
  26 #define IAVF_MAX_NUM_QUEUES_DFLT         16
  27 #define IAVF_MAX_NUM_QUEUES_LV           256
  28 #define IAVF_CFG_Q_NUM_PER_BUF           32
  29 #define IAVF_IRQ_MAP_NUM_PER_BUF         128
  30 #define IAVF_RXTX_QUEUE_CHUNKS_NUM       2
  31
  32 #define IAVF_NUM_MACADDR_MAX      64
  33
  34 #define IAVF_DEV_WATCHDOG_PERIOD     0
  35
  36 #define IAVF_DEFAULT_RX_PTHRESH      8
  37 #define IAVF_DEFAULT_RX_HTHRESH      8
  38 #define IAVF_DEFAULT_RX_WTHRESH      0
  39
  40 #define IAVF_DEFAULT_RX_FREE_THRESH  32
  41
  42 #define IAVF_DEFAULT_TX_PTHRESH      32
  43 #define IAVF_DEFAULT_TX_HTHRESH      0
  44 #define IAVF_DEFAULT_TX_WTHRESH      0
  45
  46 #define IAVF_DEFAULT_TX_FREE_THRESH  32
  47 #define IAVF_DEFAULT_TX_RS_THRESH 32
  48
  49 #define IAVF_BASIC_OFFLOAD_CAPS  ( \
  50         VF_BASE_MODE_OFFLOADS | \
  51         VIRTCHNL_VF_OFFLOAD_WB_ON_ITR | \
  52         VIRTCHNL_VF_OFFLOAD_RX_POLLING)
  53
  54 #define IAVF_RSS_OFFLOAD_ALL ( \
  55         RTE_ETH_RSS_IPV4 | \
  56         RTE_ETH_RSS_FRAG_IPV4 |         \
  57         RTE_ETH_RSS_NONFRAG_IPV4_TCP |  \
  58         RTE_ETH_RSS_NONFRAG_IPV4_UDP |  \
  59         RTE_ETH_RSS_NONFRAG_IPV4_SCTP | \
  60         RTE_ETH_RSS_NONFRAG_IPV4_OTHER | \
  61         RTE_ETH_RSS_IPV6 | \
  62         RTE_ETH_RSS_FRAG_IPV6 | \
  63         RTE_ETH_RSS_NONFRAG_IPV6_TCP | \
  64         RTE_ETH_RSS_NONFRAG_IPV6_UDP | \
  65         RTE_ETH_RSS_NONFRAG_IPV6_SCTP | \
  66         RTE_ETH_RSS_NONFRAG_IPV6_OTHER)
  67
  68 #define IAVF_MISC_VEC_ID                RTE_INTR_VEC_ZERO_OFFSET
  69 #define IAVF_RX_VEC_START               RTE_INTR_VEC_RXTX_OFFSET
  70
  71 /* Default queue interrupt throttling time in microseconds */
  72 #define IAVF_ITR_INDEX_DEFAULT          0
  73 #define IAVF_QUEUE_ITR_INTERVAL_DEFAULT 32 /* 32 us */
  74 #define IAVF_QUEUE_ITR_INTERVAL_MAX     8160 /* 8160 us */
  75
  76 #define IAVF_ALARM_INTERVAL 50000 /* us */
  77
  78 /* The overhead from MTU to max frame size.
  79  * Considering QinQ packet, the VLAN tag needs to be counted twice.
  80  */
  81 #define IAVF_ETH_OVERHEAD \
  82         (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + RTE_VLAN_HLEN * 2)
  83 #define IAVF_ETH_MAX_LEN (RTE_ETHER_MTU + IAVF_ETH_OVERHEAD)
  84
  85 #define IAVF_32_BIT_WIDTH (CHAR_BIT * 4)
  86 #define IAVF_48_BIT_WIDTH (CHAR_BIT * 6)
  87 #define IAVF_48_BIT_MASK  RTE_LEN2MASK(IAVF_48_BIT_WIDTH, uint64_t)
  88
  89 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_MASK  0x03
  90 #define IAVF_RX_DESC_EXT_STATUS_FLEXBH_FD_ID 0x01
  91
  92 #define IAVF_BITS_PER_BYTE 8
  93
  94 #define IAVF_VLAN_TAG_PCP_OFFSET 13
  95
  96 struct iavf_adapter;
  97 struct iavf_rx_queue;
  98 struct iavf_tx_queue;
  99
 100
 101 struct iavf_ipsec_crypto_stats {
 102         uint64_t icount;
 103         uint64_t ibytes;
 104         struct {
 105                 uint64_t count;
 106                 uint64_t sad_miss;
 107                 uint64_t not_processed;
 108                 uint64_t icv_check;
 109                 uint64_t ipsec_length;
 110                 uint64_t misc;
 111         } ierrors;
 112 };
 113
 114 struct iavf_eth_xstats {
 115         struct virtchnl_eth_stats eth_stats;
 116         struct iavf_ipsec_crypto_stats ips_stats;
 117 };
 118
 119 /* Structure that defines a VSI, associated with a adapter. */
 120 struct iavf_vsi {
 121         struct iavf_adapter *adapter; /* Backreference to associated adapter */
 122         uint16_t vsi_id;
 123         uint16_t nb_qps;         /* Number of queue pairs VSI can occupy */
 124         uint16_t nb_used_qps;    /* Number of queue pairs VSI uses */
 125         uint16_t max_macaddrs;   /* Maximum number of MAC addresses */
 126         uint16_t base_vector;
 127         uint16_t msix_intr;      /* The MSIX interrupt binds to VSI */
 128         struct iavf_eth_xstats eth_stats_offset;
 129 };
 130
 131 struct rte_flow;
 132 TAILQ_HEAD(iavf_flow_list, rte_flow);
 133
 134 struct iavf_flow_parser_node;
 135 TAILQ_HEAD(iavf_parser_list, iavf_flow_parser_node);
 136
 137 struct iavf_fdir_conf {
 138         struct virtchnl_fdir_add add_fltr;
 139         struct virtchnl_fdir_del del_fltr;
 140         uint64_t input_set;
 141         uint32_t flow_id;
 142         uint32_t mark_flag;
 143 };
 144
 145 struct iavf_fdir_info {
 146         struct iavf_fdir_conf conf;
 147 };
 148
 149 struct iavf_qv_map {
 150         uint16_t queue_id;
 151         uint16_t vector_id;
 152 };
 153
 154 /* Message type read in admin queue from PF */
 155 enum iavf_aq_result {
 156         IAVF_MSG_ERR = -1, /* Meet error when accessing admin queue */
 157         IAVF_MSG_NON,      /* Read nothing from admin queue */
 158         IAVF_MSG_SYS,      /* Read system msg from admin queue */
 159         IAVF_MSG_CMD,      /* Read async command result */
 160 };
 161
 162 /* Struct to store Traffic Manager node configuration. */
 163 struct iavf_tm_node {
 164         TAILQ_ENTRY(iavf_tm_node) node;
 165         uint32_t id;
 166         uint32_t tc;
 167         uint32_t priority;
 168         uint32_t weight;
 169         uint32_t reference_count;
 170         struct iavf_tm_node *parent;
 171         struct rte_tm_node_params params;
 172 };
 173
 174 TAILQ_HEAD(iavf_tm_node_list, iavf_tm_node);
 175
 176 /* node type of Traffic Manager */
 177 enum iavf_tm_node_type {
 178         IAVF_TM_NODE_TYPE_PORT,
 179         IAVF_TM_NODE_TYPE_TC,
 180         IAVF_TM_NODE_TYPE_QUEUE,
 181         IAVF_TM_NODE_TYPE_MAX,
 182 };
 183
 184 /* Struct to store all the Traffic Manager configuration. */
 185 struct iavf_tm_conf {
 186         struct iavf_tm_node *root; /* root node - vf vsi */
 187         struct iavf_tm_node_list tc_list; /* node list for all the TCs */
 188         struct iavf_tm_node_list queue_list; /* node list for all the queues */
 189         uint32_t nb_tc_node;
 190         uint32_t nb_queue_node;
 191         bool committed;
 192 };
 193
 194 /* Struct to store queue TC mapping. Queue is continuous in one TC */
 195 struct iavf_qtc_map {
 196         uint8_t tc;
 197         uint16_t start_queue_id;
 198         uint16_t queue_count;
 199 };
 200
 201 /* Structure to store private data specific for VF instance. */
 202 struct iavf_info {
 203         uint16_t num_queue_pairs;
 204         uint16_t max_pkt_len; /* Maximum packet length */
 205         uint16_t mac_num;     /* Number of MAC addresses */
 206         bool promisc_unicast_enabled;
 207         bool promisc_multicast_enabled;
 208
 209         struct virtchnl_version_info virtchnl_version;
 210         struct virtchnl_vf_resource *vf_res; /* VF resource */
 211         struct virtchnl_vsi_resource *vsi_res; /* LAN VSI */
 212         struct virtchnl_vlan_caps vlan_v2_caps;
 213         uint64_t supported_rxdid;
 214         uint8_t *proto_xtr; /* proto xtr type for all queues */
 215         volatile enum virtchnl_ops pend_cmd; /* pending command not finished */
 216         uint32_t pend_cmd_count;
 217         int cmd_retval; /* return value of the cmd response from PF */
 218         uint8_t *aq_resp; /* buffer to store the adminq response from PF */
 219
 220         /** iAVF watchdog enable */
 221         bool watchdog_enabled;
 222
 223         /* Event from pf */
 224         bool dev_closed;
 225         bool link_up;
 226         uint32_t link_speed;
 227
 228         /* Multicast addrs */
 229         struct rte_ether_addr mc_addrs[IAVF_NUM_MACADDR_MAX];
 230         uint16_t mc_addrs_num;   /* Multicast mac addresses number */
 231
 232         struct iavf_vsi vsi;
 233         bool vf_reset;  /* true for VF reset pending, false for no VF reset */
 234         uint64_t flags;
 235
 236         uint8_t *rss_lut;
 237         uint8_t *rss_key;
 238         uint64_t rss_hf;
 239         uint16_t nb_msix;   /* number of MSI-X interrupts on Rx */
 240         uint16_t msix_base; /* msix vector base from */
 241         uint16_t max_rss_qregion; /* max RSS queue region supported by PF */
 242         struct iavf_qv_map *qv_map; /* queue vector mapping */
 243         struct iavf_flow_list flow_list;
 244         rte_spinlock_t flow_ops_lock;
 245         struct iavf_parser_list rss_parser_list;
 246         struct iavf_parser_list dist_parser_list;
 247         struct iavf_parser_list ipsec_crypto_parser_list;
 248
 249         struct iavf_fdir_info fdir; /* flow director info */
 250         /* indicate large VF support enabled or not */
 251         bool lv_enabled;
 252
 253         struct virtchnl_qos_cap_list *qos_cap;
 254         struct iavf_qtc_map *qtc_map;
 255         struct iavf_tm_conf tm_conf;
 256
 257         struct rte_eth_dev *eth_dev;
 258 };
 259
 260 #define IAVF_MAX_PKT_TYPE 1024
 261
 262 #define IAVF_MAX_QUEUE_NUM  2048
 263
 264 enum iavf_proto_xtr_type {
 265         IAVF_PROTO_XTR_NONE,
 266         IAVF_PROTO_XTR_VLAN,
 267         IAVF_PROTO_XTR_IPV4,
 268         IAVF_PROTO_XTR_IPV6,
 269         IAVF_PROTO_XTR_IPV6_FLOW,
 270         IAVF_PROTO_XTR_TCP,
 271         IAVF_PROTO_XTR_IP_OFFSET,
 272         IAVF_PROTO_XTR_IPSEC_CRYPTO_SAID,
 273         IAVF_PROTO_XTR_MAX,
 274 };
 275
 276 /**
 277  * Cache devargs parse result.
 278  */
 279 struct iavf_devargs {
 280         uint8_t proto_xtr_dflt;
 281         uint8_t proto_xtr[IAVF_MAX_QUEUE_NUM];
 282 };
 283
 284 struct iavf_security_ctx;
 285
 286 /* Structure to store private data for each VF instance. */
 287 struct iavf_adapter {
 288         struct iavf_hw hw;
 289         struct rte_eth_dev_data *dev_data;
 290         struct iavf_info vf;
 291         struct iavf_security_ctx *security_ctx;
 292
 293         bool rx_bulk_alloc_allowed;
 294         /* For vector PMD */
 295         bool rx_vec_allowed;
 296         bool tx_vec_allowed;
 297         uint32_t ptype_tbl[IAVF_MAX_PKT_TYPE] __rte_cache_min_aligned;
 298         bool stopped;
 299         uint16_t fdir_ref_cnt;
 300         struct iavf_devargs devargs;
 301 };
 302
 303 /* IAVF_DEV_PRIVATE_TO */
 304 #define IAVF_DEV_PRIVATE_TO_ADAPTER(adapter) \
 305         ((struct iavf_adapter *)adapter)
 306 #define IAVF_DEV_PRIVATE_TO_VF(adapter) \
 307         (&((struct iavf_adapter *)adapter)->vf)
 308 #define IAVF_DEV_PRIVATE_TO_HW(adapter) \
 309         (&((struct iavf_adapter *)adapter)->hw)
 310 #define IAVF_DEV_PRIVATE_TO_IAVF_SECURITY_CTX(adapter) \
 311         (((struct iavf_adapter *)adapter)->security_ctx)
 312
 313 /* IAVF_VSI_TO */
 314 #define IAVF_VSI_TO_HW(vsi) \
 315         (&(((struct iavf_vsi *)vsi)->adapter->hw))
 316 #define IAVF_VSI_TO_VF(vsi) \
 317         (&(((struct iavf_vsi *)vsi)->adapter->vf))
 318
 319 static inline void
 320 iavf_init_adminq_parameter(struct iavf_hw *hw)
 321 {
 322         hw->aq.num_arq_entries = IAVF_AQ_LEN;
 323         hw->aq.num_asq_entries = IAVF_AQ_LEN;
 324         hw->aq.arq_buf_size = IAVF_AQ_BUF_SZ;
 325         hw->aq.asq_buf_size = IAVF_AQ_BUF_SZ;
 326 }
 327
 328 static inline uint16_t
 329 iavf_calc_itr_interval(int16_t interval)
 330 {
 331         if (interval < 0 || interval > IAVF_QUEUE_ITR_INTERVAL_MAX)
 332                 interval = IAVF_QUEUE_ITR_INTERVAL_DEFAULT;
 333
 334         /* Convert to hardware count, as writing each 1 represents 2 us */
 335         return interval / 2;
 336 }
 337
 338 /* structure used for sending and checking response of virtchnl ops */
 339 struct iavf_cmd_info {
 340         enum virtchnl_ops ops;
 341         uint8_t *in_args;       /* buffer for sending */
 342         uint32_t in_args_size;  /* buffer size for sending */
 343         uint8_t *out_buffer;    /* buffer for response */
 344         uint32_t out_size;      /* buffer size for response */
 345 };
 346
 347 /* notify current command done. Only call in case execute
 348  * _atomic_set_cmd successfully.
 349  */
 350 static inline void
 351 _notify_cmd(struct iavf_info *vf, int msg_ret)
 352 {
 353         vf->cmd_retval = msg_ret;
 354         rte_wmb();
 355         vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
 356 }
 357
 358 /* clear current command. Only call in case execute
 359  * _atomic_set_cmd successfully.
 360  */
 361 static inline void
 362 _clear_cmd(struct iavf_info *vf)
 363 {
 364         rte_wmb();
 365         vf->pend_cmd = VIRTCHNL_OP_UNKNOWN;
 366         vf->cmd_retval = VIRTCHNL_STATUS_SUCCESS;
 367 }
 368
 369 /* Check there is pending cmd in execution. If none, set new command. */
 370 static inline int
 371 _atomic_set_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
 372 {
 373         enum virtchnl_ops op_unk = VIRTCHNL_OP_UNKNOWN;
 374         int ret = __atomic_compare_exchange(&vf->pend_cmd, &op_unk, &ops,
 375                         0, __ATOMIC_ACQUIRE, __ATOMIC_ACQUIRE);
 376
 377         if (!ret)
 378                 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
 379
 380         __atomic_store_n(&vf->pend_cmd_count, 1, __ATOMIC_RELAXED);
 381
 382         return !ret;
 383 }
 384
 385 /* Check there is pending cmd in execution. If none, set new command. */
 386 static inline int
 387 _atomic_set_async_response_cmd(struct iavf_info *vf, enum virtchnl_ops ops)
 388 {
 389         enum virtchnl_ops op_unk = VIRTCHNL_OP_UNKNOWN;
 390         int ret = __atomic_compare_exchange(&vf->pend_cmd, &op_unk, &ops,
 391                         0, __ATOMIC_ACQUIRE, __ATOMIC_ACQUIRE);
 392
 393         if (!ret)
 394                 PMD_DRV_LOG(ERR, "There is incomplete cmd %d", vf->pend_cmd);
 395
 396         __atomic_store_n(&vf->pend_cmd_count, 2, __ATOMIC_RELAXED);
 397
 398         return !ret;
 399 }
 400 int iavf_check_api_version(struct iavf_adapter *adapter);
 401 int iavf_get_vf_resource(struct iavf_adapter *adapter);
 402 void iavf_handle_virtchnl_msg(struct rte_eth_dev *dev);
 403 int iavf_enable_vlan_strip(struct iavf_adapter *adapter);
 404 int iavf_disable_vlan_strip(struct iavf_adapter *adapter);
 405 int iavf_switch_queue(struct iavf_adapter *adapter, uint16_t qid,
 406                      bool rx, bool on);
 407 int iavf_switch_queue_lv(struct iavf_adapter *adapter, uint16_t qid,
 408                      bool rx, bool on);
 409 int iavf_enable_queues(struct iavf_adapter *adapter);
 410 int iavf_enable_queues_lv(struct iavf_adapter *adapter);
 411 int iavf_disable_queues(struct iavf_adapter *adapter);
 412 int iavf_disable_queues_lv(struct iavf_adapter *adapter);
 413 int iavf_configure_rss_lut(struct iavf_adapter *adapter);
 414 int iavf_configure_rss_key(struct iavf_adapter *adapter);
 415 int iavf_configure_queues(struct iavf_adapter *adapter,
 416                         uint16_t num_queue_pairs, uint16_t index);
 417 int iavf_get_supported_rxdid(struct iavf_adapter *adapter);
 418 int iavf_config_vlan_strip_v2(struct iavf_adapter *adapter, bool enable);
 419 int iavf_config_vlan_insert_v2(struct iavf_adapter *adapter, bool enable);
 420 int iavf_add_del_vlan_v2(struct iavf_adapter *adapter, uint16_t vlanid,
 421                          bool add);
 422 int iavf_get_vlan_offload_caps_v2(struct iavf_adapter *adapter);
 423 int iavf_config_irq_map(struct iavf_adapter *adapter);
 424 int iavf_config_irq_map_lv(struct iavf_adapter *adapter, uint16_t num,
 425                         uint16_t index);
 426 void iavf_add_del_all_mac_addr(struct iavf_adapter *adapter, bool add);
 427 int iavf_dev_link_update(struct rte_eth_dev *dev,
 428                         __rte_unused int wait_to_complete);
 429 void iavf_dev_alarm_handler(void *param);
 430 int iavf_query_stats(struct iavf_adapter *adapter,
 431                     struct virtchnl_eth_stats **pstats);
 432 int iavf_config_promisc(struct iavf_adapter *adapter, bool enable_unicast,
 433                        bool enable_multicast);
 434 int iavf_add_del_eth_addr(struct iavf_adapter *adapter,
 435                          struct rte_ether_addr *addr, bool add, uint8_t type);
 436 int iavf_add_del_vlan(struct iavf_adapter *adapter, uint16_t vlanid, bool add);
 437 int iavf_fdir_add(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
 438 int iavf_fdir_del(struct iavf_adapter *adapter, struct iavf_fdir_conf *filter);
 439 int iavf_fdir_check(struct iavf_adapter *adapter,
 440                 struct iavf_fdir_conf *filter);
 441 int iavf_add_del_rss_cfg(struct iavf_adapter *adapter,
 442                          struct virtchnl_rss_cfg *rss_cfg, bool add);
 443 int iavf_get_hena_caps(struct iavf_adapter *adapter, uint64_t *caps);
 444 int iavf_set_hena(struct iavf_adapter *adapter, uint64_t hena);
 445 int iavf_rss_hash_set(struct iavf_adapter *ad, uint64_t rss_hf, bool add);
 446 int iavf_add_del_mc_addr_list(struct iavf_adapter *adapter,
 447                         struct rte_ether_addr *mc_addrs,
 448                         uint32_t mc_addrs_num, bool add);
 449 int iavf_request_queues(struct rte_eth_dev *dev, uint16_t num);
 450 int iavf_get_max_rss_queue_region(struct iavf_adapter *adapter);
 451 int iavf_get_qos_cap(struct iavf_adapter *adapter);
 452 int iavf_set_q_tc_map(struct rte_eth_dev *dev,
 453                         struct virtchnl_queue_tc_mapping *q_tc_mapping,
 454                         uint16_t size);
 455 void iavf_tm_conf_init(struct rte_eth_dev *dev);
 456 void iavf_tm_conf_uninit(struct rte_eth_dev *dev);
 457 int iavf_ipsec_crypto_request(struct iavf_adapter *adapter,
 458                 uint8_t *msg, size_t msg_len,
 459                 uint8_t *resp_msg, size_t resp_msg_len);
 460 extern const struct rte_tm_ops iavf_tm_ops;
 461 #endif /* _IAVF_ETHDEV_H_ */