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