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