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