drivers/net/hns3/hns3_ethdev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018-2019 Hisilicon Limited.
   3  */
   4
   5 #ifndef _HNS3_ETHDEV_H_
   6 #define _HNS3_ETHDEV_H_
   7
   8 #include <sys/time.h>
   9 #include <rte_alarm.h>
  10 #include <rte_ethdev_driver.h>
  11
  12 #include "hns3_cmd.h"
  13 #include "hns3_mbx.h"
  14 #include "hns3_rss.h"
  15 #include "hns3_fdir.h"
  16 #include "hns3_stats.h"
  17
  18 /* Vendor ID */
  19 #define PCI_VENDOR_ID_HUAWEI                    0x19e5
  20
  21 /* Device IDs */
  22 #define HNS3_DEV_ID_GE                          0xA220
  23 #define HNS3_DEV_ID_25GE                        0xA221
  24 #define HNS3_DEV_ID_25GE_RDMA                   0xA222
  25 #define HNS3_DEV_ID_50GE_RDMA                   0xA224
  26 #define HNS3_DEV_ID_100G_RDMA_MACSEC            0xA226
  27 #define HNS3_DEV_ID_200G_RDMA                   0xA228
  28 #define HNS3_DEV_ID_100G_VF                     0xA22E
  29 #define HNS3_DEV_ID_100G_RDMA_PFC_VF            0xA22F
  30
  31 /* PCI Config offsets */
  32 #define HNS3_PCI_REVISION_ID                    0x08
  33 #define HNS3_PCI_REVISION_ID_LEN                1
  34
  35 #define PCI_REVISION_ID_HIP08_B                 0x21
  36 #define PCI_REVISION_ID_HIP09_A                 0x30
  37
  38 #define HNS3_PF_FUNC_ID                 0
  39 #define HNS3_1ST_VF_FUNC_ID             1
  40
  41 #define HNS3_SW_SHIFT_AND_DISCARD_MODE          0
  42 #define HNS3_HW_SHIFT_AND_DISCARD_MODE          1
  43
  44 #define HNS3_UC_MACADDR_NUM             128
  45 #define HNS3_VF_UC_MACADDR_NUM          48
  46 #define HNS3_MC_MACADDR_NUM             128
  47
  48 #define HNS3_MAX_BD_SIZE                65535
  49 #define HNS3_MAX_NON_TSO_BD_PER_PKT     8
  50 #define HNS3_MAX_TSO_BD_PER_PKT         63
  51 #define HNS3_MAX_FRAME_LEN              9728
  52 #define HNS3_VLAN_TAG_SIZE              4
  53 #define HNS3_DEFAULT_RX_BUF_LEN         2048
  54 #define HNS3_MAX_BD_PAYLEN              (1024 * 1024 - 1)
  55 #define HNS3_MAX_TSO_HDR_SIZE           512
  56 #define HNS3_MAX_TSO_HDR_BD_NUM         3
  57 #define HNS3_MAX_LRO_SIZE               64512
  58
  59 #define HNS3_ETH_OVERHEAD \
  60         (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + HNS3_VLAN_TAG_SIZE * 2)
  61 #define HNS3_PKTLEN_TO_MTU(pktlen)      ((pktlen) - HNS3_ETH_OVERHEAD)
  62 #define HNS3_MAX_MTU    (HNS3_MAX_FRAME_LEN - HNS3_ETH_OVERHEAD)
  63 #define HNS3_DEFAULT_MTU                1500UL
  64 #define HNS3_DEFAULT_FRAME_LEN          (HNS3_DEFAULT_MTU + HNS3_ETH_OVERHEAD)
  65 #define HNS3_HIP08_MIN_TX_PKT_LEN       33
  66 #define HNS3_HIP09_MIN_TX_PKT_LEN       9
  67
  68 #define HNS3_BITS_PER_BYTE      8
  69
  70 #define HNS3_4_TCS                      4
  71 #define HNS3_8_TCS                      8
  72
  73 #define HNS3_MAX_PF_NUM                 8
  74 #define HNS3_UMV_TBL_SIZE               3072
  75 #define HNS3_DEFAULT_UMV_SPACE_PER_PF \
  76         (HNS3_UMV_TBL_SIZE / HNS3_MAX_PF_NUM)
  77
  78 #define HNS3_PF_CFG_BLOCK_SIZE          32
  79 #define HNS3_PF_CFG_DESC_NUM \
  80         (HNS3_PF_CFG_BLOCK_SIZE / HNS3_CFG_RD_LEN_BYTES)
  81
  82 #define HNS3_DEFAULT_ENABLE_PFC_NUM     0
  83
  84 #define HNS3_INTR_UNREG_FAIL_RETRY_CNT  5
  85 #define HNS3_INTR_UNREG_FAIL_DELAY_MS   500
  86
  87 #define HNS3_QUIT_RESET_CNT             10
  88 #define HNS3_QUIT_RESET_DELAY_MS        100
  89
  90 #define HNS3_POLL_RESPONE_MS            1
  91
  92 #define HNS3_MAX_USER_PRIO              8
  93 #define HNS3_PG_NUM                     4
  94 enum hns3_fc_mode {
  95         HNS3_FC_NONE,
  96         HNS3_FC_RX_PAUSE,
  97         HNS3_FC_TX_PAUSE,
  98         HNS3_FC_FULL,
  99         HNS3_FC_DEFAULT
 100 };
 101
 102 #define HNS3_SCH_MODE_SP        0
 103 #define HNS3_SCH_MODE_DWRR      1
 104 struct hns3_pg_info {
 105         uint8_t pg_id;
 106         uint8_t pg_sch_mode;  /* 0: sp; 1: dwrr */
 107         uint8_t tc_bit_map;
 108         uint32_t bw_limit;
 109         uint8_t tc_dwrr[HNS3_MAX_TC_NUM];
 110 };
 111
 112 struct hns3_tc_info {
 113         uint8_t tc_id;
 114         uint8_t tc_sch_mode;  /* 0: sp; 1: dwrr */
 115         uint8_t pgid;
 116         uint32_t bw_limit;
 117         uint8_t up_to_tc_map; /* user priority maping on the TC */
 118 };
 119
 120 struct hns3_dcb_info {
 121         uint8_t num_tc;
 122         uint8_t num_pg;     /* It must be 1 if vNET-Base schd */
 123         uint8_t pg_dwrr[HNS3_PG_NUM];
 124         uint8_t prio_tc[HNS3_MAX_USER_PRIO];
 125         struct hns3_pg_info pg_info[HNS3_PG_NUM];
 126         struct hns3_tc_info tc_info[HNS3_MAX_TC_NUM];
 127         uint8_t hw_pfc_map; /* Allow for packet drop or not on this TC */
 128         uint8_t pfc_en; /* Pfc enabled or not for user priority */
 129 };
 130
 131 enum hns3_fc_status {
 132         HNS3_FC_STATUS_NONE,
 133         HNS3_FC_STATUS_MAC_PAUSE,
 134         HNS3_FC_STATUS_PFC,
 135 };
 136
 137 struct hns3_tc_queue_info {
 138         uint16_t tqp_offset;    /* TQP offset from base TQP */
 139         uint16_t tqp_count;     /* Total TQPs */
 140         uint8_t tc;             /* TC index */
 141         bool enable;            /* If this TC is enable or not */
 142 };
 143
 144 struct hns3_cfg {
 145         uint8_t vmdq_vport_num;
 146         uint8_t tc_num;
 147         uint16_t tqp_desc_num;
 148         uint16_t rx_buf_len;
 149         uint16_t rss_size_max;
 150         uint8_t phy_addr;
 151         uint8_t media_type;
 152         uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
 153         uint8_t default_speed;
 154         uint32_t numa_node_map;
 155         uint8_t speed_ability;
 156         uint16_t umv_space;
 157 };
 158
 159 /* mac media type */
 160 enum hns3_media_type {
 161         HNS3_MEDIA_TYPE_UNKNOWN,
 162         HNS3_MEDIA_TYPE_FIBER,
 163         HNS3_MEDIA_TYPE_COPPER,
 164         HNS3_MEDIA_TYPE_BACKPLANE,
 165         HNS3_MEDIA_TYPE_NONE,
 166 };
 167
 168 struct hns3_mac {
 169         uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
 170         bool default_addr_setted; /* whether default addr(mac_addr) is setted */
 171         uint8_t media_type;
 172         uint8_t phy_addr;
 173         uint8_t link_duplex  : 1; /* ETH_LINK_[HALF/FULL]_DUPLEX */
 174         uint8_t link_autoneg : 1; /* ETH_LINK_[AUTONEG/FIXED] */
 175         uint8_t link_status  : 1; /* ETH_LINK_[DOWN/UP] */
 176         uint32_t link_speed;      /* ETH_SPEED_NUM_ */
 177 };
 178
 179 struct hns3_fake_queue_data {
 180         void **rx_queues; /* Array of pointers to fake RX queues. */
 181         void **tx_queues; /* Array of pointers to fake TX queues. */
 182         uint16_t nb_fake_rx_queues; /* Number of fake RX queues. */
 183         uint16_t nb_fake_tx_queues; /* Number of fake TX queues. */
 184 };
 185
 186 #define HNS3_PORT_BASE_VLAN_DISABLE     0
 187 #define HNS3_PORT_BASE_VLAN_ENABLE      1
 188 struct hns3_port_base_vlan_config {
 189         uint16_t state;
 190         uint16_t pvid;
 191 };
 192
 193 /* Primary process maintains driver state in main thread.
 194  *
 195  * +---------------+
 196  * | UNINITIALIZED |<-----------+
 197  * +---------------+            |
 198  *      |.eth_dev_init          |.eth_dev_uninit
 199  *      V                       |
 200  * +---------------+------------+
 201  * |  INITIALIZED  |
 202  * +---------------+<-----------<---------------+
 203  *      |.dev_configure         |               |
 204  *      V                       |failed         |
 205  * +---------------+------------+               |
 206  * |  CONFIGURING  |                            |
 207  * +---------------+----+                       |
 208  *      |success        |                       |
 209  *      |               |               +---------------+
 210  *      |               |               |    CLOSING    |
 211  *      |               |               +---------------+
 212  *      |               |                       ^
 213  *      V               |.dev_configure         |
 214  * +---------------+----+                       |.dev_close
 215  * |  CONFIGURED   |----------------------------+
 216  * +---------------+<-----------+
 217  *      |.dev_start             |
 218  *      V                       |
 219  * +---------------+            |
 220  * |   STARTING    |------------^
 221  * +---------------+ failed     |
 222  *      |success                |
 223  *      |               +---------------+
 224  *      |               |   STOPPING    |
 225  *      |               +---------------+
 226  *      |                       ^
 227  *      V                       |.dev_stop
 228  * +---------------+------------+
 229  * |    STARTED    |
 230  * +---------------+
 231  */
 232 enum hns3_adapter_state {
 233         HNS3_NIC_UNINITIALIZED = 0,
 234         HNS3_NIC_INITIALIZED,
 235         HNS3_NIC_CONFIGURING,
 236         HNS3_NIC_CONFIGURED,
 237         HNS3_NIC_STARTING,
 238         HNS3_NIC_STARTED,
 239         HNS3_NIC_STOPPING,
 240         HNS3_NIC_CLOSING,
 241         HNS3_NIC_CLOSED,
 242         HNS3_NIC_REMOVED,
 243         HNS3_NIC_NSTATES
 244 };
 245
 246 /* Reset various stages, execute in order */
 247 enum hns3_reset_stage {
 248         /* Stop query services, stop transceiver, disable MAC */
 249         RESET_STAGE_DOWN,
 250         /* Clear reset completion flags, disable send command */
 251         RESET_STAGE_PREWAIT,
 252         /* Inform IMP to start resetting */
 253         RESET_STAGE_REQ_HW_RESET,
 254         /* Waiting for hardware reset to complete */
 255         RESET_STAGE_WAIT,
 256         /* Reinitialize hardware */
 257         RESET_STAGE_DEV_INIT,
 258         /* Restore user settings and enable MAC */
 259         RESET_STAGE_RESTORE,
 260         /* Restart query services, start transceiver */
 261         RESET_STAGE_DONE,
 262         /* Not in reset state */
 263         RESET_STAGE_NONE,
 264 };
 265
 266 enum hns3_reset_level {
 267         HNS3_NONE_RESET,
 268         HNS3_VF_FUNC_RESET, /* A VF function reset */
 269         /*
 270          * All VFs under a PF perform function reset.
 271          * Kernel PF driver use mailbox to inform DPDK VF to do reset, the value
 272          * of the reset level and the one defined in kernel driver should be
 273          * same.
 274          */
 275         HNS3_VF_PF_FUNC_RESET = 2,
 276         /*
 277          * All VFs under a PF perform FLR reset.
 278          * Kernel PF driver use mailbox to inform DPDK VF to do reset, the value
 279          * of the reset level and the one defined in kernel driver should be
 280          * same.
 281          *
 282          * According to the protocol of PCIe, FLR to a PF resets the PF state as
 283          * well as the SR-IOV extended capability including VF Enable which
 284          * means that VFs no longer exist.
 285          *
 286          * In PF FLR, the register state of VF is not reliable, VF's driver
 287          * should not access the registers of the VF device.
 288          */
 289         HNS3_VF_FULL_RESET = 3,
 290         HNS3_FLR_RESET,     /* A VF perform FLR reset */
 291         /* All VFs under the rootport perform a global or IMP reset */
 292         HNS3_VF_RESET,
 293         HNS3_FUNC_RESET,    /* A PF function reset */
 294         /* All PFs under the rootport perform a global reset */
 295         HNS3_GLOBAL_RESET,
 296         HNS3_IMP_RESET,     /* All PFs under the rootport perform a IMP reset */
 297         HNS3_MAX_RESET
 298 };
 299
 300 enum hns3_wait_result {
 301         HNS3_WAIT_UNKNOWN,
 302         HNS3_WAIT_REQUEST,
 303         HNS3_WAIT_SUCCESS,
 304         HNS3_WAIT_TIMEOUT
 305 };
 306
 307 #define HNS3_RESET_SYNC_US 100000
 308
 309 struct hns3_reset_stats {
 310         uint64_t request_cnt; /* Total request reset times */
 311         uint64_t global_cnt;  /* Total GLOBAL reset times */
 312         uint64_t imp_cnt;     /* Total IMP reset times */
 313         uint64_t exec_cnt;    /* Total reset executive times */
 314         uint64_t success_cnt; /* Total reset successful times */
 315         uint64_t fail_cnt;    /* Total reset failed times */
 316         uint64_t merge_cnt;   /* Total merged in high reset times */
 317 };
 318
 319 typedef bool (*check_completion_func)(struct hns3_hw *hw);
 320
 321 struct hns3_wait_data {
 322         void *hns;
 323         uint64_t end_ms;
 324         uint64_t interval;
 325         int16_t count;
 326         enum hns3_wait_result result;
 327         check_completion_func check_completion;
 328 };
 329
 330 struct hns3_reset_ops {
 331         void (*reset_service)(void *arg);
 332         int (*stop_service)(struct hns3_adapter *hns);
 333         int (*prepare_reset)(struct hns3_adapter *hns);
 334         int (*wait_hardware_ready)(struct hns3_adapter *hns);
 335         int (*reinit_dev)(struct hns3_adapter *hns);
 336         int (*restore_conf)(struct hns3_adapter *hns);
 337         int (*start_service)(struct hns3_adapter *hns);
 338 };
 339
 340 enum hns3_schedule {
 341         SCHEDULE_NONE,
 342         SCHEDULE_PENDING,
 343         SCHEDULE_REQUESTED,
 344         SCHEDULE_DEFERRED,
 345 };
 346
 347 struct hns3_reset_data {
 348         enum hns3_reset_stage stage;
 349         rte_atomic16_t schedule;
 350         /* Reset flag, covering the entire reset process */
 351         rte_atomic16_t resetting;
 352         /* Used to disable sending cmds during reset */
 353         rte_atomic16_t disable_cmd;
 354         /* The reset level being processed */
 355         enum hns3_reset_level level;
 356         /* Reset level set, each bit represents a reset level */
 357         uint64_t pending;
 358         /* Request reset level set, from interrupt or mailbox */
 359         uint64_t request;
 360         int attempts; /* Reset failure retry */
 361         int retries;  /* Timeout failure retry in reset_post */
 362         /*
 363          * At the time of global or IMP reset, the command cannot be sent to
 364          * stop the tx/rx queues. Tx/Rx queues may be access mbuf during the
 365          * reset process, so the mbuf is required to be released after the reset
 366          * is completed.The mbuf_deferred_free is used to mark whether mbuf
 367          * needs to be released.
 368          */
 369         bool mbuf_deferred_free;
 370         struct timeval start_time;
 371         struct hns3_reset_stats stats;
 372         const struct hns3_reset_ops *ops;
 373         struct hns3_wait_data *wait_data;
 374 };
 375
 376 #define HNS3_INTR_MAPPING_VEC_RSV_ONE           0
 377 #define HNS3_INTR_MAPPING_VEC_ALL               1
 378
 379 #define HNS3_INTR_COALESCE_NON_QL               0
 380 #define HNS3_INTR_COALESCE_QL                   1
 381
 382 #define HNS3_INTR_COALESCE_GL_UINT_2US          0
 383 #define HNS3_INTR_COALESCE_GL_UINT_1US          1
 384
 385 struct hns3_queue_intr {
 386         /*
 387          * interrupt mapping mode.
 388          * value range:
 389          *      HNS3_INTR_MAPPING_VEC_RSV_ONE/HNS3_INTR_MAPPING_VEC_ALL
 390          *
 391          *  - HNS3_INTR_MAPPING_VEC_RSV_ONE
 392          *     For some versions of hardware network engine, because of the
 393          *     hardware constraint, we need implement clearing the mapping
 394          *     relationship configurations by binding all queues to the last
 395          *     interrupt vector and reserving the last interrupt vector. This
 396          *     method results in a decrease of the maximum queues when upper
 397          *     applications call the rte_eth_dev_configure API function to
 398          *     enable Rx interrupt.
 399          *
 400          *  - HNS3_INTR_MAPPING_VEC_ALL
 401          *     PMD driver can map/unmmap all interrupt vectors with queues When
 402          *     Rx interrupt in enabled.
 403          */
 404         uint8_t mapping_mode;
 405         /*
 406          * interrupt coalesce mode.
 407          * value range:
 408          *      HNS3_INTR_COALESCE_NON_QL/HNS3_INTR_COALESCE_QL
 409          *
 410          *  - HNS3_INTR_COALESCE_NON_QL
 411          *     For some versions of hardware network engine, hardware doesn't
 412          *     support QL(quanity limiter) algorithm for interrupt coalesce
 413          *     of queue's interrupt.
 414          *
 415          *  - HNS3_INTR_COALESCE_QL
 416          *     In this mode, hardware support QL(quanity limiter) algorithm for
 417          *     interrupt coalesce of queue's interrupt.
 418          */
 419         uint8_t coalesce_mode;
 420         /*
 421          * The unit of GL(gap limiter) configuration for interrupt coalesce of
 422          * queue's interrupt.
 423          * value range:
 424          *      HNS3_INTR_COALESCE_GL_UINT_2US/HNS3_INTR_COALESCE_GL_UINT_1US
 425          */
 426         uint8_t gl_unit;
 427 };
 428
 429 #define HNS3_TSO_SW_CAL_PSEUDO_H_CSUM           0
 430 #define HNS3_TSO_HW_CAL_PSEUDO_H_CSUM           1
 431
 432 struct hns3_hw {
 433         struct rte_eth_dev_data *data;
 434         void *io_base;
 435         uint8_t revision;           /* PCI revision, low byte of class word */
 436         struct hns3_cmq cmq;
 437         struct hns3_mbx_resp_status mbx_resp; /* mailbox response */
 438         struct hns3_mbx_arq_ring arq;         /* mailbox async rx queue */
 439         pthread_t irq_thread_id;
 440         struct hns3_mac mac;
 441         unsigned int secondary_cnt; /* Number of secondary processes init'd. */
 442         struct hns3_tqp_stats tqp_stats;
 443         /* Include Mac stats | Rx stats | Tx stats */
 444         struct hns3_mac_stats mac_stats;
 445         uint32_t fw_version;
 446
 447         uint16_t num_msi;
 448         uint16_t total_tqps_num;    /* total task queue pairs of this PF */
 449         uint16_t tqps_num;          /* num task queue pairs of this function */
 450         uint16_t intr_tqps_num;     /* num queue pairs mapping interrupt */
 451         uint16_t rss_size_max;      /* HW defined max RSS task queue */
 452         uint16_t rx_buf_len;        /* hold min hardware rx buf len */
 453         uint16_t num_tx_desc;       /* desc num of per tx queue */
 454         uint16_t num_rx_desc;       /* desc num of per rx queue */
 455         uint32_t mng_entry_num;     /* number of manager table entry */
 456         uint32_t mac_entry_num;     /* number of mac-vlan table entry */
 457
 458         struct rte_ether_addr mc_addrs[HNS3_MC_MACADDR_NUM];
 459         int mc_addrs_num; /* Multicast mac addresses number */
 460
 461         /* The configuration info of RSS */
 462         struct hns3_rss_conf rss_info;
 463         bool rss_dis_flag; /* disable rss flag. true: disable, false: enable */
 464         uint16_t rss_ind_tbl_size;
 465         uint16_t rss_key_size;
 466
 467         uint8_t num_tc;             /* Total number of enabled TCs */
 468         uint8_t hw_tc_map;
 469         enum hns3_fc_mode current_mode;
 470         enum hns3_fc_mode requested_mode;
 471         struct hns3_dcb_info dcb_info;
 472         enum hns3_fc_status current_fc_status; /* current flow control status */
 473         struct hns3_tc_queue_info tc_queue[HNS3_MAX_TC_NUM];
 474         uint16_t used_rx_queues;
 475         uint16_t used_tx_queues;
 476
 477         /* Config max queue numbers between rx and tx queues from user */
 478         uint16_t cfg_max_queues;
 479         struct hns3_fake_queue_data fkq_data;     /* fake queue data */
 480         uint16_t alloc_rss_size;    /* RX queue number per TC */
 481         uint16_t tx_qnum_per_tc;    /* TX queue number per TC */
 482
 483         uint32_t capability;
 484         uint32_t max_tm_rate;
 485         /*
 486          * The minimum length of the packet supported by hardware in the Tx
 487          * direction.
 488          */
 489         uint32_t min_tx_pkt_len;
 490
 491         struct hns3_queue_intr intr;
 492         /*
 493          * tso mode.
 494          * value range:
 495          *      HNS3_TSO_SW_CAL_PSEUDO_H_CSUM/HNS3_TSO_HW_CAL_PSEUDO_H_CSUM
 496          *
 497          *  - HNS3_TSO_SW_CAL_PSEUDO_H_CSUM
 498          *     In this mode, because of the hardware constraint, network driver
 499          *     software need erase the L4 len value of the TCP pseudo header
 500          *     and recalculate the TCP pseudo header checksum of packets that
 501          *     need TSO.
 502          *
 503          *  - HNS3_TSO_HW_CAL_PSEUDO_H_CSUM
 504          *     In this mode, hardware support recalculate the TCP pseudo header
 505          *     checksum of packets that need TSO, so network driver software
 506          *     not need to recalculate it.
 507          */
 508         uint8_t tso_mode;
 509         /*
 510          * vlan mode.
 511          * value range:
 512          *      HNS3_SW_SHIFT_AND_DISCARD_MODE/HNS3_HW_SHFIT_AND_DISCARD_MODE
 513          *
 514          *  - HNS3_SW_SHIFT_AND_DISCARD_MODE
 515          *     For some versions of hardware network engine, because of the
 516          *     hardware limitation, PMD driver needs to detect the PVID status
 517          *     to work with haredware to implement PVID-related functions.
 518          *     For example, driver need discard the stripped PVID tag to ensure
 519          *     the PVID will not report to mbuf and shift the inserted VLAN tag
 520          *     to avoid port based VLAN covering it.
 521          *
 522          *  - HNS3_HW_SHIT_AND_DISCARD_MODE
 523          *     PMD driver does not need to process PVID-related functions in
 524          *     I/O process, Hardware will adjust the sequence between port based
 525          *     VLAN tag and BD VLAN tag automatically and VLAN tag stripped by
 526          *     PVID will be invisible to driver. And in this mode, hns3 is able
 527          *     to send a multi-layer VLAN packets when hw VLAN insert offload
 528          *     is enabled.
 529          */
 530         uint8_t vlan_mode;
 531         uint8_t max_non_tso_bd_num; /* max BD number of one non-TSO packet */
 532
 533         struct hns3_port_base_vlan_config port_base_vlan_cfg;
 534         /*
 535          * PMD setup and configuration is not thread safe. Since it is not
 536          * performance sensitive, it is better to guarantee thread-safety
 537          * and add device level lock. Adapter control operations which
 538          * change its state should acquire the lock.
 539          */
 540         rte_spinlock_t lock;
 541         enum hns3_adapter_state adapter_state;
 542         struct hns3_reset_data reset;
 543 };
 544
 545 #define HNS3_FLAG_TC_BASE_SCH_MODE              1
 546 #define HNS3_FLAG_VNET_BASE_SCH_MODE            2
 547
 548 struct hns3_err_msix_intr_stats {
 549         uint64_t mac_afifo_tnl_int_cnt;
 550         uint64_t ppu_mpf_abn_int_st2_msix_cnt;
 551         uint64_t ssu_port_based_pf_int_cnt;
 552         uint64_t ppp_pf_abnormal_int_cnt;
 553         uint64_t ppu_pf_abnormal_int_msix_cnt;
 554
 555         uint64_t imp_tcm_ecc_int_cnt;
 556         uint64_t cmdq_mem_ecc_int_cnt;
 557         uint64_t imp_rd_poison_int_cnt;
 558         uint64_t tqp_int_ecc_int_cnt;
 559         uint64_t msix_ecc_int_cnt;
 560         uint64_t ssu_ecc_multi_bit_int_0_cnt;
 561         uint64_t ssu_ecc_multi_bit_int_1_cnt;
 562         uint64_t ssu_common_ecc_int_cnt;
 563         uint64_t igu_int_cnt;
 564         uint64_t ppp_mpf_abnormal_int_st1_cnt;
 565         uint64_t ppp_mpf_abnormal_int_st3_cnt;
 566         uint64_t ppu_mpf_abnormal_int_st1_cnt;
 567         uint64_t ppu_mpf_abn_int_st2_ras_cnt;
 568         uint64_t ppu_mpf_abnormal_int_st3_cnt;
 569         uint64_t tm_sch_int_cnt;
 570         uint64_t qcn_fifo_int_cnt;
 571         uint64_t qcn_ecc_int_cnt;
 572         uint64_t ncsi_ecc_int_cnt;
 573         uint64_t ssu_port_based_err_int_cnt;
 574         uint64_t ssu_fifo_overflow_int_cnt;
 575         uint64_t ssu_ets_tcg_int_cnt;
 576         uint64_t igu_egu_tnl_int_cnt;
 577         uint64_t ppu_pf_abnormal_int_ras_cnt;
 578 };
 579
 580 /* vlan entry information. */
 581 struct hns3_user_vlan_table {
 582         LIST_ENTRY(hns3_user_vlan_table) next;
 583         bool hd_tbl_status;
 584         uint16_t vlan_id;
 585 };
 586
 587 /* Vlan tag configuration for RX direction */
 588 struct hns3_rx_vtag_cfg {
 589         bool rx_vlan_offload_en;    /* Whether enable rx vlan offload */
 590         bool strip_tag1_en;         /* Whether strip inner vlan tag */
 591         bool strip_tag2_en;         /* Whether strip outer vlan tag */
 592         /*
 593          * If strip_tag_en is enabled, this bit decide whether to map the vlan
 594          * tag to descriptor.
 595          */
 596         bool strip_tag1_discard_en;
 597         bool strip_tag2_discard_en;
 598         /*
 599          * If this bit is enabled, only map inner/outer priority to descriptor
 600          * and the vlan tag is always 0.
 601          */
 602         bool vlan1_vlan_prionly;
 603         bool vlan2_vlan_prionly;
 604 };
 605
 606 /* Vlan tag configuration for TX direction */
 607 struct hns3_tx_vtag_cfg {
 608         bool accept_tag1;           /* Whether accept tag1 packet from host */
 609         bool accept_untag1;         /* Whether accept untag1 packet from host */
 610         bool accept_tag2;
 611         bool accept_untag2;
 612         bool insert_tag1_en;        /* Whether insert outer vlan tag */
 613         bool insert_tag2_en;        /* Whether insert inner vlan tag */
 614         /*
 615          * In shift mode, hw will shift the sequence of port based VLAN and
 616          * BD VLAN.
 617          */
 618         bool tag_shift_mode_en;     /* hw shift vlan tag automatically */
 619         uint16_t default_tag1;      /* The default outer vlan tag to insert */
 620         uint16_t default_tag2;      /* The default inner vlan tag to insert */
 621 };
 622
 623 struct hns3_vtag_cfg {
 624         struct hns3_rx_vtag_cfg rx_vcfg;
 625         struct hns3_tx_vtag_cfg tx_vcfg;
 626 };
 627
 628 /* Request types for IPC. */
 629 enum hns3_mp_req_type {
 630         HNS3_MP_REQ_START_RXTX = 1,
 631         HNS3_MP_REQ_STOP_RXTX,
 632         HNS3_MP_REQ_MAX
 633 };
 634
 635 /* Pameters for IPC. */
 636 struct hns3_mp_param {
 637         enum hns3_mp_req_type type;
 638         int port_id;
 639         int result;
 640 };
 641
 642 /* Request timeout for IPC. */
 643 #define HNS3_MP_REQ_TIMEOUT_SEC 5
 644
 645 /* Key string for IPC. */
 646 #define HNS3_MP_NAME "net_hns3_mp"
 647
 648 #define HNS3_L2TBL_NUM  4
 649 #define HNS3_L3TBL_NUM  16
 650 #define HNS3_L4TBL_NUM  16
 651 #define HNS3_OL3TBL_NUM 16
 652 #define HNS3_OL4TBL_NUM 16
 653
 654 struct hns3_ptype_table {
 655         uint32_t l2table[HNS3_L2TBL_NUM];
 656         uint32_t l3table[HNS3_L3TBL_NUM];
 657         uint32_t l4table[HNS3_L4TBL_NUM];
 658         uint32_t inner_l2table[HNS3_L2TBL_NUM];
 659         uint32_t inner_l3table[HNS3_L3TBL_NUM];
 660         uint32_t inner_l4table[HNS3_L4TBL_NUM];
 661         uint32_t ol3table[HNS3_OL3TBL_NUM];
 662         uint32_t ol4table[HNS3_OL4TBL_NUM];
 663 };
 664
 665 #define HNS3_FIXED_MAX_TQP_NUM_MODE             0
 666 #define HNS3_FLEX_MAX_TQP_NUM_MODE              1
 667
 668 struct hns3_pf {
 669         struct hns3_adapter *adapter;
 670         bool is_main_pf;
 671         uint16_t func_num; /* num functions of this pf, include pf and vfs */
 672
 673         /*
 674          * tqp_config mode
 675          * tqp_config_mode value range:
 676          *      HNS3_FIXED_MAX_TQP_NUM_MODE,
 677          *      HNS3_FLEX_MAX_TQP_NUM_MODE
 678          *
 679          * - HNS3_FIXED_MAX_TQP_NUM_MODE
 680          *   There is a limitation on the number of pf interrupts available for
 681          *   on some versions of network engines. In this case, the maximum
 682          *   queue number of pf can not be greater than the interrupt number,
 683          *   such as pf of network engine with revision_id 0x21. So the maximum
 684          *   number of queues must be fixed.
 685          *
 686          * - HNS3_FLEX_MAX_TQP_NUM_MODE
 687          *   In this mode, the maximum queue number of pf has not any constraint
 688          *   and comes from the macro RTE_LIBRTE_HNS3_MAX_TQP_NUM_PER_PF
 689          *   in the config file. Users can modify the macro according to their
 690          *   own application scenarios, which is more flexible to use.
 691          */
 692         uint8_t tqp_config_mode;
 693
 694         uint32_t pkt_buf_size; /* Total pf buf size for tx/rx */
 695         uint32_t tx_buf_size; /* Tx buffer size for each TC */
 696         uint32_t dv_buf_size; /* Dv buffer size for each TC */
 697
 698         uint16_t mps; /* Max packet size */
 699
 700         uint8_t tx_sch_mode;
 701         uint8_t tc_max; /* max number of tc driver supported */
 702         uint8_t local_max_tc; /* max number of local tc */
 703         uint8_t pfc_max;
 704         uint8_t prio_tc[HNS3_MAX_USER_PRIO]; /* TC indexed by prio */
 705         uint16_t pause_time;
 706         bool support_fc_autoneg;       /* support FC autonegotiate */
 707
 708         uint16_t wanted_umv_size;
 709         uint16_t max_umv_size;
 710         uint16_t used_umv_size;
 711
 712         /* Statistics information for abnormal interrupt */
 713         struct hns3_err_msix_intr_stats abn_int_stats;
 714
 715         bool support_sfp_query;
 716         uint32_t fec_mode; /* current FEC mode for ethdev */
 717
 718         struct hns3_vtag_cfg vtag_config;
 719         LIST_HEAD(vlan_tbl, hns3_user_vlan_table) vlan_list;
 720
 721         struct hns3_fdir_info fdir; /* flow director info */
 722         LIST_HEAD(counters, hns3_flow_counter) flow_counters;
 723 };
 724
 725 struct hns3_vf {
 726         struct hns3_adapter *adapter;
 727 };
 728
 729 struct hns3_adapter {
 730         struct hns3_hw hw;
 731
 732         /* Specific for PF or VF */
 733         bool is_vf; /* false - PF, true - VF */
 734         union {
 735                 struct hns3_pf pf;
 736                 struct hns3_vf vf;
 737         };
 738
 739         bool rx_simple_allowed;
 740         bool rx_vec_allowed;
 741         bool tx_simple_allowed;
 742         bool tx_vec_allowed;
 743
 744         struct hns3_ptype_table ptype_tbl __rte_cache_min_aligned;
 745 };
 746
 747 #define HNS3_DEV_SUPPORT_DCB_B                  0x0
 748 #define HNS3_DEV_SUPPORT_COPPER_B               0x1
 749 #define HNS3_DEV_SUPPORT_UDP_GSO_B              0x2
 750 #define HNS3_DEV_SUPPORT_FD_QUEUE_REGION_B      0x3
 751 #define HNS3_DEV_SUPPORT_PTP_B                  0x4
 752 #define HNS3_DEV_SUPPORT_TX_PUSH_B              0x5
 753 #define HNS3_DEV_SUPPORT_INDEP_TXRX_B           0x6
 754 #define HNS3_DEV_SUPPORT_STASH_B                0x7
 755
 756 #define hns3_dev_dcb_supported(hw) \
 757         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_DCB_B)
 758
 759 /* Support copper media type */
 760 #define hns3_dev_copper_supported(hw) \
 761         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_COPPER_B)
 762
 763 /* Support UDP GSO offload */
 764 #define hns3_dev_udp_gso_supported(hw) \
 765         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_UDP_GSO_B)
 766
 767 /* Support the queue region action rule of flow directory */
 768 #define hns3_dev_fd_queue_region_supported(hw) \
 769         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_FD_QUEUE_REGION_B)
 770
 771 /* Support PTP timestamp offload */
 772 #define hns3_dev_ptp_supported(hw) \
 773         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_PTP_B)
 774
 775 #define hns3_dev_tx_push_supported(hw) \
 776         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_TX_PUSH_B)
 777
 778 /* Support to Independently enable/disable/reset Tx or Rx queues */
 779 #define hns3_dev_indep_txrx_supported(hw) \
 780         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_INDEP_TXRX_B)
 781
 782 #define hns3_dev_stash_supported(hw) \
 783         hns3_get_bit((hw)->capability, HNS3_DEV_SUPPORT_STASH_B)
 784
 785 #define HNS3_DEV_PRIVATE_TO_HW(adapter) \
 786         (&((struct hns3_adapter *)adapter)->hw)
 787 #define HNS3_DEV_PRIVATE_TO_ADAPTER(adapter) \
 788         ((struct hns3_adapter *)adapter)
 789 #define HNS3_DEV_PRIVATE_TO_PF(adapter) \
 790         (&((struct hns3_adapter *)adapter)->pf)
 791 #define HNS3VF_DEV_PRIVATE_TO_VF(adapter) \
 792         (&((struct hns3_adapter *)adapter)->vf)
 793 #define HNS3_DEV_HW_TO_ADAPTER(hw) \
 794         container_of(hw, struct hns3_adapter, hw)
 795
 796 #define hns3_set_field(origin, mask, shift, val) \
 797         do { \
 798                 (origin) &= (~(mask)); \
 799                 (origin) |= ((val) << (shift)) & (mask); \
 800         } while (0)
 801 #define hns3_get_field(origin, mask, shift) \
 802         (((origin) & (mask)) >> (shift))
 803 #define hns3_set_bit(origin, shift, val) \
 804         hns3_set_field((origin), (0x1UL << (shift)), (shift), (val))
 805 #define hns3_get_bit(origin, shift) \
 806         hns3_get_field((origin), (0x1UL << (shift)), (shift))
 807
 808 /*
 809  * upper_32_bits - return bits 32-63 of a number
 810  * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
 811  * the "right shift count >= width of type" warning when that quantity is
 812  * 32-bits.
 813  */
 814 #define upper_32_bits(n) ((uint32_t)(((n) >> 16) >> 16))
 815
 816 /* lower_32_bits - return bits 0-31 of a number */
 817 #define lower_32_bits(n) ((uint32_t)(n))
 818
 819 #define BIT(nr) (1UL << (nr))
 820
 821 #define BIT_ULL(x) (1ULL << (x))
 822
 823 #define BITS_PER_LONG   (__SIZEOF_LONG__ * 8)
 824 #define GENMASK(h, l) \
 825         (((~0UL) << (l)) & (~0UL >> (BITS_PER_LONG - 1 - (h))))
 826
 827 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
 828 #define rounddown(x, y) ((x) - ((x) % (y)))
 829
 830 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
 831
 832 /*
 833  * Because hardware always access register in little-endian mode based on hns3
 834  * network engine, so driver should also call rte_cpu_to_le_32 to convert data
 835  * in little-endian mode before writing register and call rte_le_to_cpu_32 to
 836  * convert data after reading from register.
 837  *
 838  * Here the driver encapsulates the data conversion operation in the register
 839  * read/write operation function as below:
 840  *   hns3_write_reg
 841  *   hns3_write_reg_opt
 842  *   hns3_read_reg
 843  * Therefore, when calling these functions, conversion is not required again.
 844  */
 845 static inline void hns3_write_reg(void *base, uint32_t reg, uint32_t value)
 846 {
 847         rte_write32(rte_cpu_to_le_32(value),
 848                     (volatile void *)((char *)base + reg));
 849 }
 850
 851 /*
 852  * The optimized function for writing registers used in the '.rx_pkt_burst' and
 853  * '.tx_pkt_burst' ops implementation function.
 854  */
 855 static inline void hns3_write_reg_opt(volatile void *addr, uint32_t value)
 856 {
 857         rte_io_wmb();
 858         rte_write32_relaxed(rte_cpu_to_le_32(value), addr);
 859 }
 860
 861 static inline uint32_t hns3_read_reg(void *base, uint32_t reg)
 862 {
 863         uint32_t read_val = rte_read32((volatile void *)((char *)base + reg));
 864         return rte_le_to_cpu_32(read_val);
 865 }
 866
 867 #define hns3_write_dev(a, reg, value) \
 868         hns3_write_reg((a)->io_base, (reg), (value))
 869
 870 #define hns3_read_dev(a, reg) \
 871         hns3_read_reg((a)->io_base, (reg))
 872
 873 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 874
 875 #define NEXT_ITEM_OF_ACTION(act, actions, index)                        \
 876         do {                                                            \
 877                 act = (actions) + (index);                              \
 878                 while (act->type == RTE_FLOW_ACTION_TYPE_VOID) {        \
 879                         (index)++;                                      \
 880                         act = actions + index;                          \
 881                 }                                                       \
 882         } while (0)
 883
 884 #define MSEC_PER_SEC              1000L
 885 #define USEC_PER_MSEC             1000L
 886
 887 static inline uint64_t
 888 get_timeofday_ms(void)
 889 {
 890         struct timeval tv;
 891
 892         (void)gettimeofday(&tv, NULL);
 893
 894         return (uint64_t)tv.tv_sec * MSEC_PER_SEC + tv.tv_usec / USEC_PER_MSEC;
 895 }
 896
 897 static inline uint64_t
 898 hns3_atomic_test_bit(unsigned int nr, volatile uint64_t *addr)
 899 {
 900         uint64_t res;
 901
 902         res = (__atomic_load_n(addr, __ATOMIC_RELAXED) & (1UL << nr)) != 0;
 903         return res;
 904 }
 905
 906 static inline void
 907 hns3_atomic_set_bit(unsigned int nr, volatile uint64_t *addr)
 908 {
 909         __atomic_fetch_or(addr, (1UL << nr), __ATOMIC_RELAXED);
 910 }
 911
 912 static inline void
 913 hns3_atomic_clear_bit(unsigned int nr, volatile uint64_t *addr)
 914 {
 915         __atomic_fetch_and(addr, ~(1UL << nr), __ATOMIC_RELAXED);
 916 }
 917
 918 static inline int64_t
 919 hns3_test_and_clear_bit(unsigned int nr, volatile uint64_t *addr)
 920 {
 921         uint64_t mask = (1UL << nr);
 922
 923         return __atomic_fetch_and(addr, ~mask, __ATOMIC_RELAXED) & mask;
 924 }
 925
 926 int hns3_buffer_alloc(struct hns3_hw *hw);
 927 int hns3_dev_filter_ctrl(struct rte_eth_dev *dev,
 928                          enum rte_filter_type filter_type,
 929                          enum rte_filter_op filter_op, void *arg);
 930 bool hns3_is_reset_pending(struct hns3_adapter *hns);
 931 bool hns3vf_is_reset_pending(struct hns3_adapter *hns);
 932 void hns3_update_link_status(struct hns3_hw *hw);
 933
 934 static inline bool
 935 is_reset_pending(struct hns3_adapter *hns)
 936 {
 937         bool ret;
 938         if (hns->is_vf)
 939                 ret = hns3vf_is_reset_pending(hns);
 940         else
 941                 ret = hns3_is_reset_pending(hns);
 942         return ret;
 943 }
 944
 945 static inline uint64_t
 946 hns3_txvlan_cap_get(struct hns3_hw *hw)
 947 {
 948         if (hw->port_base_vlan_cfg.state)
 949                 return DEV_TX_OFFLOAD_VLAN_INSERT;
 950         else
 951                 return DEV_TX_OFFLOAD_VLAN_INSERT | DEV_TX_OFFLOAD_QINQ_INSERT;
 952 }
 953
 954 #endif /* _HNS3_ETHDEV_H_ */