drivers/net/hns3/hns3_rxtx.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018-2021 HiSilicon Limited.
   3  */
   4
   5 #ifndef _HNS3_RXTX_H_
   6 #define _HNS3_RXTX_H_
   7
   8 #include <stdint.h>
   9 #include <rte_mbuf_core.h>
  10
  11 #define HNS3_MIN_RING_DESC      64
  12 #define HNS3_MAX_RING_DESC      32768
  13 #define HNS3_DEFAULT_RING_DESC  1024
  14 #define HNS3_ALIGN_RING_DESC    32
  15 #define HNS3_RING_BASE_ALIGN    128
  16 #define HNS3_BULK_ALLOC_MBUF_NUM        32
  17
  18 #define HNS3_DEFAULT_RX_FREE_THRESH     32
  19 #define HNS3_DEFAULT_TX_FREE_THRESH     32
  20 #define HNS3_DEFAULT_TX_RS_THRESH       32
  21 #define HNS3_TX_FAST_FREE_AHEAD         64
  22
  23 #define HNS3_DEFAULT_RX_BURST           32
  24 #if (HNS3_DEFAULT_RX_BURST > 64)
  25 #error "PMD HNS3: HNS3_DEFAULT_RX_BURST must <= 64\n"
  26 #endif
  27 #define HNS3_DEFAULT_DESCS_PER_LOOP     4
  28 #define HNS3_SVE_DEFAULT_DESCS_PER_LOOP 8
  29 #if (HNS3_DEFAULT_DESCS_PER_LOOP > HNS3_SVE_DEFAULT_DESCS_PER_LOOP)
  30 #define HNS3_VECTOR_RX_OFFSET_TABLE_LEN HNS3_DEFAULT_DESCS_PER_LOOP
  31 #else
  32 #define HNS3_VECTOR_RX_OFFSET_TABLE_LEN HNS3_SVE_DEFAULT_DESCS_PER_LOOP
  33 #endif
  34 #define HNS3_DEFAULT_RXQ_REARM_THRESH   64
  35 #define HNS3_UINT8_BIT                  8
  36 #define HNS3_UINT16_BIT                 16
  37 #define HNS3_UINT32_BIT                 32
  38
  39 #define HNS3_512_BD_BUF_SIZE    512
  40 #define HNS3_1K_BD_BUF_SIZE     1024
  41 #define HNS3_2K_BD_BUF_SIZE     2048
  42 #define HNS3_4K_BD_BUF_SIZE     4096
  43
  44 #define HNS3_MIN_BD_BUF_SIZE    HNS3_512_BD_BUF_SIZE
  45 #define HNS3_MAX_BD_BUF_SIZE    HNS3_4K_BD_BUF_SIZE
  46
  47 #define HNS3_BD_SIZE_512_TYPE                   0
  48 #define HNS3_BD_SIZE_1024_TYPE                  1
  49 #define HNS3_BD_SIZE_2048_TYPE                  2
  50 #define HNS3_BD_SIZE_4096_TYPE                  3
  51
  52 #define HNS3_RX_FLAG_VLAN_PRESENT               0x1
  53 #define HNS3_RX_FLAG_L3ID_IPV4                  0x0
  54 #define HNS3_RX_FLAG_L3ID_IPV6                  0x1
  55 #define HNS3_RX_FLAG_L4ID_UDP                   0x0
  56 #define HNS3_RX_FLAG_L4ID_TCP                   0x1
  57
  58 #define HNS3_RXD_DMAC_S                         0
  59 #define HNS3_RXD_DMAC_M                         (0x3 << HNS3_RXD_DMAC_S)
  60 #define HNS3_RXD_VLAN_S                         2
  61 #define HNS3_RXD_VLAN_M                         (0x3 << HNS3_RXD_VLAN_S)
  62 #define HNS3_RXD_L3ID_S                         4
  63 #define HNS3_RXD_L3ID_M                         (0xf << HNS3_RXD_L3ID_S)
  64 #define HNS3_RXD_L4ID_S                         8
  65 #define HNS3_RXD_L4ID_M                         (0xf << HNS3_RXD_L4ID_S)
  66 #define HNS3_RXD_FRAG_B                         12
  67 #define HNS3_RXD_STRP_TAGP_S                    13
  68 #define HNS3_RXD_STRP_TAGP_M                    (0x3 << HNS3_RXD_STRP_TAGP_S)
  69
  70 #define HNS3_RXD_L2E_B                          16
  71 #define HNS3_RXD_L3E_B                          17
  72 #define HNS3_RXD_L4E_B                          18
  73 #define HNS3_RXD_TRUNCATE_B                     19
  74 #define HNS3_RXD_HOI_B                          20
  75 #define HNS3_RXD_DOI_B                          21
  76 #define HNS3_RXD_OL3E_B                         22
  77 #define HNS3_RXD_OL4E_B                         23
  78 #define HNS3_RXD_GRO_COUNT_S                    24
  79 #define HNS3_RXD_GRO_COUNT_M                    (0x3f << HNS3_RXD_GRO_COUNT_S)
  80 #define HNS3_RXD_GRO_FIXID_B                    30
  81 #define HNS3_RXD_GRO_ECN_B                      31
  82
  83 #define HNS3_RXD_ODMAC_S                        0
  84 #define HNS3_RXD_ODMAC_M                        (0x3 << HNS3_RXD_ODMAC_S)
  85 #define HNS3_RXD_OVLAN_S                        2
  86 #define HNS3_RXD_OVLAN_M                        (0x3 << HNS3_RXD_OVLAN_S)
  87 #define HNS3_RXD_OL3ID_S                        4
  88 #define HNS3_RXD_OL3ID_M                        (0xf << HNS3_RXD_OL3ID_S)
  89 #define HNS3_RXD_OL4ID_S                        8
  90 #define HNS3_RXD_OL4ID_M                        (0xf << HNS3_RXD_OL4ID_S)
  91 #define HNS3_RXD_PTYPE_S                        4
  92 #define HNS3_RXD_PTYPE_M                        (0xff << HNS3_RXD_PTYPE_S)
  93 #define HNS3_RXD_FBHI_S                         12
  94 #define HNS3_RXD_FBHI_M                         (0x3 << HNS3_RXD_FBHI_S)
  95 #define HNS3_RXD_FBLI_S                         14
  96 #define HNS3_RXD_FBLI_M                         (0x3 << HNS3_RXD_FBLI_S)
  97
  98 #define HNS3_RXD_BDTYPE_S                       0
  99 #define HNS3_RXD_BDTYPE_M                       (0xf << HNS3_RXD_BDTYPE_S)
 100 #define HNS3_RXD_VLD_B                          4
 101 #define HNS3_RXD_UDP0_B                         5
 102 #define HNS3_RXD_EXTEND_B                       7
 103 #define HNS3_RXD_FE_B                           8
 104 #define HNS3_RXD_LUM_B                          9
 105 #define HNS3_RXD_CRCP_B                         10
 106 #define HNS3_RXD_L3L4P_B                        11
 107
 108 #define HNS3_RXD_TS_VLD_B                       14
 109 #define HNS3_RXD_LKBK_B                         15
 110 #define HNS3_RXD_GRO_SIZE_S                     16
 111 #define HNS3_RXD_GRO_SIZE_M                     (0x3fff << HNS3_RXD_GRO_SIZE_S)
 112
 113 #define HNS3_TXD_L3T_S                          0
 114 #define HNS3_TXD_L3T_M                          (0x3 << HNS3_TXD_L3T_S)
 115 #define HNS3_TXD_L4T_S                          2
 116 #define HNS3_TXD_L4T_M                          (0x3 << HNS3_TXD_L4T_S)
 117 #define HNS3_TXD_L3CS_B                         4
 118 #define HNS3_TXD_L4CS_B                         5
 119 #define HNS3_TXD_VLAN_B                         6
 120 #define HNS3_TXD_TSO_B                          7
 121
 122 #define HNS3_TXD_L2LEN_S                        8
 123 #define HNS3_TXD_L2LEN_M                        (0xff << HNS3_TXD_L2LEN_S)
 124 #define HNS3_TXD_L3LEN_S                        16
 125 #define HNS3_TXD_L3LEN_M                        (0xff << HNS3_TXD_L3LEN_S)
 126 #define HNS3_TXD_L4LEN_S                        24
 127 #define HNS3_TXD_L4LEN_M                        (0xffUL << HNS3_TXD_L4LEN_S)
 128
 129 #define HNS3_TXD_OL3T_S                         0
 130 #define HNS3_TXD_OL3T_M                         (0x3 << HNS3_TXD_OL3T_S)
 131 #define HNS3_TXD_OVLAN_B                        2
 132 #define HNS3_TXD_MACSEC_B                       3
 133 #define HNS3_TXD_TUNTYPE_S                      4
 134 #define HNS3_TXD_TUNTYPE_M                      (0xf << HNS3_TXD_TUNTYPE_S)
 135
 136 #define HNS3_TXD_BDTYPE_S                       0
 137 #define HNS3_TXD_BDTYPE_M                       (0xf << HNS3_TXD_BDTYPE_S)
 138 #define HNS3_TXD_FE_B                           4
 139 #define HNS3_TXD_SC_S                           5
 140 #define HNS3_TXD_SC_M                           (0x3 << HNS3_TXD_SC_S)
 141 #define HNS3_TXD_EXTEND_B                       7
 142 #define HNS3_TXD_VLD_B                          8
 143 #define HNS3_TXD_RI_B                           9
 144 #define HNS3_TXD_RA_B                           10
 145 #define HNS3_TXD_TSYN_B                         11
 146 #define HNS3_TXD_DECTTL_S                       12
 147 #define HNS3_TXD_DECTTL_M                       (0xf << HNS3_TXD_DECTTL_S)
 148
 149 #define HNS3_TXD_MSS_S                          0
 150 #define HNS3_TXD_MSS_M                          (0x3fff << HNS3_TXD_MSS_S)
 151
 152 #define HNS3_TXD_OL4CS_B                        22
 153 #define HNS3_L2_LEN_UNIT                        1UL
 154 #define HNS3_L3_LEN_UNIT                        2UL
 155 #define HNS3_L4_LEN_UNIT                        2UL
 156
 157 #define HNS3_TXD_DEFAULT_BDTYPE         0
 158 #define HNS3_TXD_VLD_CMD                (0x1 << HNS3_TXD_VLD_B)
 159 #define HNS3_TXD_FE_CMD                 (0x1 << HNS3_TXD_FE_B)
 160 #define HNS3_TXD_DEFAULT_VLD_FE_BDTYPE          \
 161                 (HNS3_TXD_VLD_CMD | HNS3_TXD_FE_CMD | HNS3_TXD_DEFAULT_BDTYPE)
 162 #define HNS3_TXD_SEND_SIZE_SHIFT        16
 163
 164 enum hns3_pkt_l2t_type {
 165         HNS3_L2_TYPE_UNICAST,
 166         HNS3_L2_TYPE_MULTICAST,
 167         HNS3_L2_TYPE_BROADCAST,
 168         HNS3_L2_TYPE_INVALID,
 169 };
 170
 171 enum hns3_pkt_l3t_type {
 172         HNS3_L3T_NONE,
 173         HNS3_L3T_IPV6,
 174         HNS3_L3T_IPV4,
 175         HNS3_L3T_RESERVED
 176 };
 177
 178 enum hns3_pkt_l4t_type {
 179         HNS3_L4T_UNKNOWN,
 180         HNS3_L4T_TCP,
 181         HNS3_L4T_UDP,
 182         HNS3_L4T_SCTP
 183 };
 184
 185 enum hns3_pkt_ol3t_type {
 186         HNS3_OL3T_NONE,
 187         HNS3_OL3T_IPV6,
 188         HNS3_OL3T_IPV4_NO_CSUM,
 189         HNS3_OL3T_IPV4_CSUM
 190 };
 191
 192 enum hns3_pkt_tun_type {
 193         HNS3_TUN_NONE,
 194         HNS3_TUN_MAC_IN_UDP,
 195         HNS3_TUN_NVGRE,
 196         HNS3_TUN_OTHER
 197 };
 198
 199 /* hardware spec ring buffer format */
 200 struct hns3_desc {
 201         union {
 202                 uint64_t addr;
 203                 uint64_t timestamp;
 204
 205                 struct {
 206                         uint32_t addr0;
 207                         uint32_t addr1;
 208                 };
 209         };
 210         union {
 211                 struct {
 212                         uint16_t vlan_tag;
 213                         uint16_t send_size;
 214                         union {
 215                                 /*
 216                                  * L3T | L4T | L3CS | L4CS | VLAN | TSO |
 217                                  * L2_LEN
 218                                  */
 219                                 uint32_t type_cs_vlan_tso_len;
 220                                 struct {
 221                                         uint8_t type_cs_vlan_tso;
 222                                         uint8_t l2_len;
 223                                         uint8_t l3_len;
 224                                         uint8_t l4_len;
 225                                 };
 226                         };
 227                         uint16_t outer_vlan_tag;
 228                         uint16_t tv;
 229                         union {
 230                                 /* OL3T | OVALAN | MACSEC */
 231                                 uint32_t ol_type_vlan_len_msec;
 232                                 struct {
 233                                         uint8_t ol_type_vlan_msec;
 234                                         uint8_t ol2_len;
 235                                         uint8_t ol3_len;
 236                                         uint8_t ol4_len;
 237                                 };
 238                         };
 239
 240                         uint32_t paylen_fd_dop_ol4cs;
 241                         uint16_t tp_fe_sc_vld_ra_ri;
 242                         uint16_t mss;
 243                 } tx;
 244
 245                 struct {
 246                         uint32_t l234_info;
 247                         uint16_t pkt_len;
 248                         uint16_t size;
 249                         uint32_t rss_hash;
 250                         uint16_t fd_id;
 251                         uint16_t vlan_tag;
 252                         union {
 253                                 uint32_t ol_info;
 254                                 struct {
 255                                         uint16_t o_dm_vlan_id_fb;
 256                                         uint16_t ot_vlan_tag;
 257                                 };
 258                         };
 259                         union {
 260                                 uint32_t bd_base_info;
 261                                 struct {
 262                                         uint16_t bdtype_vld_udp0;
 263                                         uint16_t fe_lum_crcp_l3l4p;
 264                                 };
 265                         };
 266                 } rx;
 267         };
 268 } __rte_packed;
 269
 270 struct hns3_entry {
 271         struct rte_mbuf *mbuf;
 272 };
 273
 274 struct hns3_rx_basic_stats {
 275         uint64_t packets;
 276         uint64_t bytes;
 277         uint64_t errors;
 278 };
 279
 280 struct hns3_rx_dfx_stats {
 281         uint64_t l3_csum_errors;
 282         uint64_t l4_csum_errors;
 283         uint64_t ol3_csum_errors;
 284         uint64_t ol4_csum_errors;
 285 };
 286
 287 struct hns3_rx_bd_errors_stats {
 288         uint64_t l2_errors;
 289         uint64_t pkt_len_errors;
 290 };
 291
 292 struct hns3_rx_queue {
 293         void *io_base;
 294         volatile void *io_head_reg;
 295         struct hns3_adapter *hns;
 296         struct hns3_ptype_table *ptype_tbl;
 297         struct rte_mempool *mb_pool;
 298         struct hns3_desc *rx_ring;
 299         uint64_t rx_ring_phys_addr; /* RX ring DMA address */
 300         const struct rte_memzone *mz;
 301         struct hns3_entry *sw_ring;
 302         struct rte_mbuf *pkt_first_seg;
 303         struct rte_mbuf *pkt_last_seg;
 304
 305         uint16_t queue_id;
 306         uint16_t port_id;
 307         uint16_t nb_rx_desc;
 308         uint16_t rx_buf_len;
 309         /*
 310          * threshold for the number of BDs waited to passed to hardware. If the
 311          * number exceeds the threshold, driver will pass these BDs to hardware.
 312          */
 313         uint16_t rx_free_thresh;
 314         uint16_t next_to_use;    /* index of next BD to be polled */
 315         uint16_t rx_free_hold;   /* num of BDs waited to passed to hardware */
 316         uint16_t rx_rearm_start; /* index of BD that driver re-arming from */
 317         uint16_t rx_rearm_nb;    /* number of remaining BDs to be re-armed */
 318
 319         /* 4 if DEV_RX_OFFLOAD_KEEP_CRC offload set, 0 otherwise */
 320         uint8_t crc_len;
 321
 322         bool rx_deferred_start; /* don't start this queue in dev start */
 323         bool configured;        /* indicate if rx queue has been configured */
 324         /*
 325          * Indicate whether ignore the outer VLAN field in the Rx BD reported
 326          * by the Hardware. Because the outer VLAN is the PVID if the PVID is
 327          * set for some version of hardware network engine whose vlan mode is
 328          * HNS3_SW_SHIFT_AND_DISCARD_MODE, such as kunpeng 920. And this VLAN
 329          * should not be transitted to the upper-layer application. For hardware
 330          * network engine whose vlan mode is HNS3_HW_SHIFT_AND_DISCARD_MODE,
 331          * such as kunpeng 930, PVID will not be reported to the BDs. So, PMD
 332          * driver does not need to perform PVID-related operation in Rx. At this
 333          * point, the pvid_sw_discard_en will be false.
 334          */
 335         bool pvid_sw_discard_en;
 336         bool ptype_en;          /* indicate if the ptype field enabled */
 337         bool enabled;           /* indicate if Rx queue has been enabled */
 338
 339         struct hns3_rx_basic_stats basic_stats;
 340         /* DFX statistics that driver does not need to discard packets */
 341         struct hns3_rx_dfx_stats dfx_stats;
 342         /* Error statistics that driver needs to discard packets */
 343         struct hns3_rx_bd_errors_stats err_stats;
 344
 345         struct rte_mbuf *bulk_mbuf[HNS3_BULK_ALLOC_MBUF_NUM];
 346         uint16_t bulk_mbuf_num;
 347
 348         /* offset_table: used for vector, to solve execute re-order problem */
 349         uint8_t offset_table[HNS3_VECTOR_RX_OFFSET_TABLE_LEN + 1];
 350         uint64_t mbuf_initializer; /* value to init mbufs used with vector rx */
 351         struct rte_mbuf fake_mbuf; /* fake mbuf used with vector rx */
 352 };
 353
 354 struct hns3_tx_basic_stats {
 355         uint64_t packets;
 356         uint64_t bytes;
 357 };
 358
 359 /*
 360  * The following items are used for the abnormal errors statistics in
 361  * the Tx datapath. When upper level application calls the
 362  * rte_eth_tx_burst API function to send multiple packets at a time with
 363  * burst mode based on hns3 network engine, there are some abnormal
 364  * conditions that cause the driver to fail to operate the hardware to
 365  * send packets correctly.
 366  * Note: When using burst mode to call the rte_eth_tx_burst API function
 367  * to send multiple packets at a time. When the first abnormal error is
 368  * detected, add one to the relevant error statistics item, and then
 369  * exit the loop of sending multiple packets of the function. That is to
 370  * say, even if there are multiple packets in which abnormal errors may
 371  * be detected in the burst, the relevant error statistics in the driver
 372  * will only be increased by one.
 373  * The detail description of the Tx abnormal errors statistic items as
 374  * below:
 375  *  - over_length_pkt_cnt
 376  *     Total number of greater than HNS3_MAX_FRAME_LEN the driver
 377  *     supported.
 378  *
 379  * - exceed_limit_bd_pkt_cnt
 380  *     Total number of exceeding the hardware limited bd which process
 381  *     a packet needed bd numbers.
 382  *
 383  * - exceed_limit_bd_reassem_fail
 384  *     Total number of exceeding the hardware limited bd fail which
 385  *     process a packet needed bd numbers and reassemble fail.
 386  *
 387  * - unsupported_tunnel_pkt_cnt
 388  *     Total number of unsupported tunnel packet. The unsupported tunnel
 389  *     type: vxlan_gpe, gtp, ipip and MPLSINUDP, MPLSINUDP is a packet
 390  *     with MPLS-in-UDP RFC 7510 header.
 391  *
 392  * - queue_full_cnt
 393  *     Total count which the available bd numbers in current bd queue is
 394  *     less than the bd numbers with the pkt process needed.
 395  *
 396  * - pkt_padding_fail_cnt
 397  *     Total count which the packet length is less than minimum packet
 398  *     length(struct hns3_tx_queue::min_tx_pkt_len) supported by
 399  *     hardware in Tx direction and fail to be appended with 0.
 400  */
 401 struct hns3_tx_dfx_stats {
 402         uint64_t over_length_pkt_cnt;
 403         uint64_t exceed_limit_bd_pkt_cnt;
 404         uint64_t exceed_limit_bd_reassem_fail;
 405         uint64_t unsupported_tunnel_pkt_cnt;
 406         uint64_t queue_full_cnt;
 407         uint64_t pkt_padding_fail_cnt;
 408 };
 409
 410 struct hns3_tx_queue {
 411         void *io_base;
 412         volatile void *io_tail_reg;
 413         struct hns3_adapter *hns;
 414         struct hns3_desc *tx_ring;
 415         uint64_t tx_ring_phys_addr; /* TX ring DMA address */
 416         const struct rte_memzone *mz;
 417         struct hns3_entry *sw_ring;
 418
 419         uint16_t queue_id;
 420         uint16_t port_id;
 421         uint16_t nb_tx_desc;
 422         /*
 423          * index of next BD whose corresponding rte_mbuf can be released by
 424          * driver.
 425          */
 426         uint16_t next_to_clean;
 427         /* index of next BD to be filled by driver to send packet */
 428         uint16_t next_to_use;
 429         /* num of remaining BDs ready to be filled by driver to send packet */
 430         uint16_t tx_bd_ready;
 431
 432         /* threshold for free tx buffer if available BDs less than this value */
 433         uint16_t tx_free_thresh;
 434
 435         /*
 436          * For better performance in tx datapath, releasing mbuf in batches is
 437          * required.
 438          * Only checking the VLD bit of the last descriptor in a batch of the
 439          * thresh descriptors does not mean that these descriptors are all sent
 440          * by hardware successfully. So we need to check that the VLD bits of
 441          * all descriptors are cleared. and then free all mbufs in the batch.
 442          * - tx_rs_thresh
 443          *   Number of mbufs released at a time.
 444          *
 445          * - free
 446          *   Tx mbuf free array used for preserving temporarily address of mbuf
 447          *   released back to mempool, when releasing mbuf in batches.
 448          */
 449         uint16_t tx_rs_thresh;
 450         struct rte_mbuf **free;
 451
 452         /*
 453          * tso mode.
 454          * value range:
 455          *      HNS3_TSO_SW_CAL_PSEUDO_H_CSUM/HNS3_TSO_HW_CAL_PSEUDO_H_CSUM
 456          *
 457          *  - HNS3_TSO_SW_CAL_PSEUDO_H_CSUM
 458          *     In this mode, because of the hardware constraint, network driver
 459          *     software need erase the L4 len value of the TCP pseudo header
 460          *     and recalculate the TCP pseudo header checksum of packets that
 461          *     need TSO.
 462          *
 463          *  - HNS3_TSO_HW_CAL_PSEUDO_H_CSUM
 464          *     In this mode, hardware support recalculate the TCP pseudo header
 465          *     checksum of packets that need TSO, so network driver software
 466          *     not need to recalculate it.
 467          */
 468         uint8_t tso_mode;
 469         /*
 470          * udp checksum mode.
 471          * value range:
 472          *      HNS3_SPECIAL_PORT_HW_CKSUM_MODE/HNS3_SPECIAL_PORT_SW_CKSUM_MODE
 473          *
 474          *  - HNS3_SPECIAL_PORT_SW_CKSUM_MODE
 475          *     In this mode, HW can not do checksum for special UDP port like
 476          *     4789, 4790, 6081 for non-tunnel UDP packets and UDP tunnel
 477          *     packets without the PKT_TX_TUNEL_MASK in the mbuf. So, PMD need
 478          *     do the checksum for these packets to avoid a checksum error.
 479          *
 480          *  - HNS3_SPECIAL_PORT_HW_CKSUM_MODE
 481          *     In this mode, HW does not have the preceding problems and can
 482          *     directly calculate the checksum of these UDP packets.
 483          */
 484         uint8_t udp_cksum_mode;
 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         uint8_t max_non_tso_bd_num; /* max BD number of one non-TSO packet */
 492         bool tx_deferred_start; /* don't start this queue in dev start */
 493         bool configured;        /* indicate if tx queue has been configured */
 494         /*
 495          * Indicate whether add the vlan_tci of the mbuf to the inner VLAN field
 496          * of Tx BD. Because the outer VLAN will always be the PVID when the
 497          * PVID is set and for some version of hardware network engine whose
 498          * vlan mode is HNS3_SW_SHIFT_AND_DISCARD_MODE, such as kunpeng 920, the
 499          * PVID will overwrite the outer VLAN field of Tx BD. For the hardware
 500          * network engine whose vlan mode is HNS3_HW_SHIFT_AND_DISCARD_MODE,
 501          * such as kunpeng 930, if the PVID is set, the hardware will shift the
 502          * VLAN field automatically. So, PMD driver does not need to do
 503          * PVID-related operations in Tx. And pvid_sw_shift_en will be false at
 504          * this point.
 505          */
 506         bool pvid_sw_shift_en;
 507         bool enabled;           /* indicate if Tx queue has been enabled */
 508
 509         struct hns3_tx_basic_stats basic_stats;
 510         struct hns3_tx_dfx_stats dfx_stats;
 511 };
 512
 513 #define HNS3_GET_TX_QUEUE_PEND_BD_NUM(txq) \
 514                 ((txq)->nb_tx_desc - 1 - (txq)->tx_bd_ready)
 515
 516 struct hns3_queue_info {
 517         const char *type;   /* point to queue memory name */
 518         const char *ring_name;  /* point to hardware ring name */
 519         uint16_t idx;
 520         uint16_t nb_desc;
 521         unsigned int socket_id;
 522 };
 523
 524 #define HNS3_TX_CKSUM_OFFLOAD_MASK ( \
 525         PKT_TX_OUTER_UDP_CKSUM | \
 526         PKT_TX_OUTER_IP_CKSUM | \
 527         PKT_TX_IP_CKSUM | \
 528         PKT_TX_TCP_SEG | \
 529         PKT_TX_L4_MASK)
 530
 531 enum hns3_cksum_status {
 532         HNS3_CKSUM_NONE = 0,
 533         HNS3_L3_CKSUM_ERR = 1,
 534         HNS3_L4_CKSUM_ERR = 2,
 535         HNS3_OUTER_L3_CKSUM_ERR = 4,
 536         HNS3_OUTER_L4_CKSUM_ERR = 8
 537 };
 538
 539 extern uint64_t hns3_timestamp_rx_dynflag;
 540 extern int hns3_timestamp_dynfield_offset;
 541
 542 static inline int
 543 hns3_handle_bdinfo(struct hns3_rx_queue *rxq, struct rte_mbuf *rxm,
 544                    uint32_t bd_base_info, uint32_t l234_info,
 545                    uint32_t *cksum_err)
 546 {
 547 #define L2E_TRUNC_ERR_FLAG      (BIT(HNS3_RXD_L2E_B) | \
 548                                  BIT(HNS3_RXD_TRUNCATE_B))
 549 #define CHECKSUM_ERR_FLAG       (BIT(HNS3_RXD_L3E_B) | \
 550                                  BIT(HNS3_RXD_L4E_B) | \
 551                                  BIT(HNS3_RXD_OL3E_B) | \
 552                                  BIT(HNS3_RXD_OL4E_B))
 553
 554         uint32_t tmp = 0;
 555
 556         /*
 557          * If packet len bigger than mtu when recv with no-scattered algorithm,
 558          * the first n bd will without FE bit, we need process this sisution.
 559          * Note: we don't need add statistic counter because latest BD which
 560          *       with FE bit will mark HNS3_RXD_L2E_B bit.
 561          */
 562         if (unlikely((bd_base_info & BIT(HNS3_RXD_FE_B)) == 0))
 563                 return -EINVAL;
 564
 565         if (unlikely((l234_info & L2E_TRUNC_ERR_FLAG) || rxm->pkt_len == 0)) {
 566                 if (l234_info & BIT(HNS3_RXD_L2E_B))
 567                         rxq->err_stats.l2_errors++;
 568                 else
 569                         rxq->err_stats.pkt_len_errors++;
 570                 return -EINVAL;
 571         }
 572
 573         if (bd_base_info & BIT(HNS3_RXD_L3L4P_B)) {
 574                 if (likely((l234_info & CHECKSUM_ERR_FLAG) == 0)) {
 575                         *cksum_err = 0;
 576                         return 0;
 577                 }
 578
 579                 if (unlikely(l234_info & BIT(HNS3_RXD_L3E_B))) {
 580                         rxm->ol_flags |= PKT_RX_IP_CKSUM_BAD;
 581                         rxq->dfx_stats.l3_csum_errors++;
 582                         tmp |= HNS3_L3_CKSUM_ERR;
 583                 }
 584
 585                 if (unlikely(l234_info & BIT(HNS3_RXD_L4E_B))) {
 586                         rxm->ol_flags |= PKT_RX_L4_CKSUM_BAD;
 587                         rxq->dfx_stats.l4_csum_errors++;
 588                         tmp |= HNS3_L4_CKSUM_ERR;
 589                 }
 590
 591                 if (unlikely(l234_info & BIT(HNS3_RXD_OL3E_B))) {
 592                         rxq->dfx_stats.ol3_csum_errors++;
 593                         tmp |= HNS3_OUTER_L3_CKSUM_ERR;
 594                 }
 595
 596                 if (unlikely(l234_info & BIT(HNS3_RXD_OL4E_B))) {
 597                         rxm->ol_flags |= PKT_RX_OUTER_L4_CKSUM_BAD;
 598                         rxq->dfx_stats.ol4_csum_errors++;
 599                         tmp |= HNS3_OUTER_L4_CKSUM_ERR;
 600                 }
 601         }
 602         *cksum_err = tmp;
 603
 604         return 0;
 605 }
 606
 607 static inline void
 608 hns3_rx_set_cksum_flag(struct rte_mbuf *rxm, const uint64_t packet_type,
 609                        const uint32_t cksum_err)
 610 {
 611         if (unlikely((packet_type & RTE_PTYPE_TUNNEL_MASK))) {
 612                 if (likely(packet_type & RTE_PTYPE_INNER_L3_MASK) &&
 613                     (cksum_err & HNS3_L3_CKSUM_ERR) == 0)
 614                         rxm->ol_flags |= PKT_RX_IP_CKSUM_GOOD;
 615                 if (likely(packet_type & RTE_PTYPE_INNER_L4_MASK) &&
 616                     (cksum_err & HNS3_L4_CKSUM_ERR) == 0)
 617                         rxm->ol_flags |= PKT_RX_L4_CKSUM_GOOD;
 618                 if (likely(packet_type & RTE_PTYPE_L4_MASK) &&
 619                     (cksum_err & HNS3_OUTER_L4_CKSUM_ERR) == 0)
 620                         rxm->ol_flags |= PKT_RX_OUTER_L4_CKSUM_GOOD;
 621         } else {
 622                 if (likely(packet_type & RTE_PTYPE_L3_MASK) &&
 623                     (cksum_err & HNS3_L3_CKSUM_ERR) == 0)
 624                         rxm->ol_flags |= PKT_RX_IP_CKSUM_GOOD;
 625                 if (likely(packet_type & RTE_PTYPE_L4_MASK) &&
 626                     (cksum_err & HNS3_L4_CKSUM_ERR) == 0)
 627                         rxm->ol_flags |= PKT_RX_L4_CKSUM_GOOD;
 628         }
 629 }
 630
 631 static inline uint32_t
 632 hns3_rx_calc_ptype(struct hns3_rx_queue *rxq, const uint32_t l234_info,
 633                    const uint32_t ol_info)
 634 {
 635         const struct hns3_ptype_table * const ptype_tbl = rxq->ptype_tbl;
 636         uint32_t ol3id, ol4id;
 637         uint32_t l3id, l4id;
 638         uint32_t ptype;
 639
 640         if (rxq->ptype_en) {
 641                 ptype = hns3_get_field(ol_info, HNS3_RXD_PTYPE_M,
 642                                        HNS3_RXD_PTYPE_S);
 643                 return ptype_tbl->ptype[ptype];
 644         }
 645
 646         ol4id = hns3_get_field(ol_info, HNS3_RXD_OL4ID_M, HNS3_RXD_OL4ID_S);
 647         ol3id = hns3_get_field(ol_info, HNS3_RXD_OL3ID_M, HNS3_RXD_OL3ID_S);
 648         l3id = hns3_get_field(l234_info, HNS3_RXD_L3ID_M, HNS3_RXD_L3ID_S);
 649         l4id = hns3_get_field(l234_info, HNS3_RXD_L4ID_M, HNS3_RXD_L4ID_S);
 650
 651         if (unlikely(ptype_tbl->ol4table[ol4id]))
 652                 return ptype_tbl->inner_l3table[l3id] |
 653                         ptype_tbl->inner_l4table[l4id] |
 654                         ptype_tbl->ol3table[ol3id] |
 655                         ptype_tbl->ol4table[ol4id];
 656         else
 657                 return ptype_tbl->l3table[l3id] | ptype_tbl->l4table[l4id];
 658 }
 659
 660 void hns3_dev_rx_queue_release(void *queue);
 661 void hns3_dev_tx_queue_release(void *queue);
 662 void hns3_free_all_queues(struct rte_eth_dev *dev);
 663 int hns3_reset_all_tqps(struct hns3_adapter *hns);
 664 void hns3_dev_all_rx_queue_intr_enable(struct hns3_hw *hw, bool en);
 665 int hns3_dev_rx_queue_intr_enable(struct rte_eth_dev *dev, uint16_t queue_id);
 666 int hns3_dev_rx_queue_intr_disable(struct rte_eth_dev *dev, uint16_t queue_id);
 667 void hns3_enable_all_queues(struct hns3_hw *hw, bool en);
 668 int hns3_init_queues(struct hns3_adapter *hns, bool reset_queue);
 669 void hns3_start_tqps(struct hns3_hw *hw);
 670 void hns3_stop_tqps(struct hns3_hw *hw);
 671 int hns3_rxq_iterate(struct rte_eth_dev *dev,
 672                  int (*callback)(struct hns3_rx_queue *, void *), void *arg);
 673 void hns3_dev_release_mbufs(struct hns3_adapter *hns);
 674 int hns3_rx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t nb_desc,
 675                         unsigned int socket, const struct rte_eth_rxconf *conf,
 676                         struct rte_mempool *mp);
 677 int hns3_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t nb_desc,
 678                         unsigned int socket, const struct rte_eth_txconf *conf);
 679 uint32_t hns3_rx_queue_count(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 680 int hns3_dev_rx_queue_start(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 681 int hns3_dev_rx_queue_stop(struct rte_eth_dev *dev, uint16_t rx_queue_id);
 682 int hns3_dev_tx_queue_start(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 683 int hns3_dev_tx_queue_stop(struct rte_eth_dev *dev, uint16_t tx_queue_id);
 684 uint16_t hns3_recv_pkts_simple(void *rx_queue, struct rte_mbuf **rx_pkts,
 685                                 uint16_t nb_pkts);
 686 uint16_t hns3_recv_scattered_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 687                                   uint16_t nb_pkts);
 688 uint16_t hns3_recv_pkts_vec(void *rx_queue, struct rte_mbuf **rx_pkts,
 689                             uint16_t nb_pkts);
 690 uint16_t hns3_recv_pkts_vec_sve(void *rx_queue, struct rte_mbuf **rx_pkts,
 691                                 uint16_t nb_pkts);
 692 int hns3_rx_burst_mode_get(struct rte_eth_dev *dev,
 693                            __rte_unused uint16_t queue_id,
 694                            struct rte_eth_burst_mode *mode);
 695 int hns3_rx_check_vec_support(struct rte_eth_dev *dev);
 696 uint16_t hns3_prep_pkts(__rte_unused void *tx_queue, struct rte_mbuf **tx_pkts,
 697                         uint16_t nb_pkts);
 698 uint16_t hns3_xmit_pkts_simple(void *tx_queue, struct rte_mbuf **tx_pkts,
 699                                uint16_t nb_pkts);
 700 uint16_t hns3_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 701                         uint16_t nb_pkts);
 702 uint16_t hns3_xmit_pkts_vec(void *tx_queue, struct rte_mbuf **tx_pkts,
 703                                                         uint16_t nb_pkts);
 704 uint16_t hns3_xmit_pkts_vec_sve(void *tx_queue, struct rte_mbuf **tx_pkts,
 705                                 uint16_t nb_pkts);
 706 int hns3_tx_burst_mode_get(struct rte_eth_dev *dev,
 707                            __rte_unused uint16_t queue_id,
 708                            struct rte_eth_burst_mode *mode);
 709 const uint32_t *hns3_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 710 void hns3_init_rx_ptype_tble(struct rte_eth_dev *dev);
 711 void hns3_set_rxtx_function(struct rte_eth_dev *eth_dev);
 712 uint32_t hns3_get_tqp_intr_reg_offset(uint16_t tqp_intr_id);
 713 void hns3_set_queue_intr_gl(struct hns3_hw *hw, uint16_t queue_id,
 714                             uint8_t gl_idx, uint16_t gl_value);
 715 void hns3_set_queue_intr_rl(struct hns3_hw *hw, uint16_t queue_id,
 716                             uint16_t rl_value);
 717 void hns3_set_queue_intr_ql(struct hns3_hw *hw, uint16_t queue_id,
 718                             uint16_t ql_value);
 719 int hns3_set_fake_rx_or_tx_queues(struct rte_eth_dev *dev, uint16_t nb_rx_q,
 720                                   uint16_t nb_tx_q);
 721 int hns3_config_gro(struct hns3_hw *hw, bool en);
 722 int hns3_restore_gro_conf(struct hns3_hw *hw);
 723 void hns3_update_all_queues_pvid_proc_en(struct hns3_hw *hw);
 724 void hns3_rx_scattered_reset(struct rte_eth_dev *dev);
 725 void hns3_rx_scattered_calc(struct rte_eth_dev *dev);
 726 int hns3_rx_check_vec_support(struct rte_eth_dev *dev);
 727 int hns3_tx_check_vec_support(struct rte_eth_dev *dev);
 728 void hns3_rxq_vec_setup(struct hns3_rx_queue *rxq);
 729 void hns3_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
 730                        struct rte_eth_rxq_info *qinfo);
 731 void hns3_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
 732                        struct rte_eth_txq_info *qinfo);
 733 uint32_t hns3_get_tqp_reg_offset(uint16_t idx);
 734 int hns3_start_all_txqs(struct rte_eth_dev *dev);
 735 int hns3_start_all_rxqs(struct rte_eth_dev *dev);
 736 void hns3_stop_all_txqs(struct rte_eth_dev *dev);
 737 void hns3_restore_tqp_enable_state(struct hns3_hw *hw);
 738 int hns3_tx_done_cleanup(void *txq, uint32_t free_cnt);
 739 void hns3_enable_rxd_adv_layout(struct hns3_hw *hw);
 740 int hns3_dev_rx_descriptor_status(void *rx_queue, uint16_t offset);
 741 int hns3_dev_tx_descriptor_status(void *tx_queue, uint16_t offset);
 742
 743 #endif /* _HNS3_RXTX_H_ */