drivers/net/hns3/hns3_rxtx.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018-2019 Hisilicon Limited.
   3  */
   4
   5 #ifndef _HNS3_RXTX_H_
   6 #define _HNS3_RXTX_H_
   7
   8 #define HNS3_MIN_RING_DESC      64
   9 #define HNS3_MAX_RING_DESC      32768
  10 #define HNS3_DEFAULT_RING_DESC  1024
  11 #define HNS3_ALIGN_RING_DESC    32
  12 #define HNS3_RING_BASE_ALIGN    128
  13
  14 #define HNS3_512_BD_BUF_SIZE    512
  15 #define HNS3_1K_BD_BUF_SIZE     1024
  16 #define HNS3_2K_BD_BUF_SIZE     2048
  17 #define HNS3_4K_BD_BUF_SIZE     4096
  18
  19 #define HNS3_MIN_BD_BUF_SIZE    HNS3_512_BD_BUF_SIZE
  20 #define HNS3_MAX_BD_BUF_SIZE    HNS3_4K_BD_BUF_SIZE
  21
  22 #define HNS3_BD_SIZE_512_TYPE                   0
  23 #define HNS3_BD_SIZE_1024_TYPE                  1
  24 #define HNS3_BD_SIZE_2048_TYPE                  2
  25 #define HNS3_BD_SIZE_4096_TYPE                  3
  26
  27 #define HNS3_RX_FLAG_VLAN_PRESENT               0x1
  28 #define HNS3_RX_FLAG_L3ID_IPV4                  0x0
  29 #define HNS3_RX_FLAG_L3ID_IPV6                  0x1
  30 #define HNS3_RX_FLAG_L4ID_UDP                   0x0
  31 #define HNS3_RX_FLAG_L4ID_TCP                   0x1
  32
  33 #define HNS3_RXD_DMAC_S                         0
  34 #define HNS3_RXD_DMAC_M                         (0x3 << HNS3_RXD_DMAC_S)
  35 #define HNS3_RXD_VLAN_S                         2
  36 #define HNS3_RXD_VLAN_M                         (0x3 << HNS3_RXD_VLAN_S)
  37 #define HNS3_RXD_L3ID_S                         4
  38 #define HNS3_RXD_L3ID_M                         (0xf << HNS3_RXD_L3ID_S)
  39 #define HNS3_RXD_L4ID_S                         8
  40 #define HNS3_RXD_L4ID_M                         (0xf << HNS3_RXD_L4ID_S)
  41 #define HNS3_RXD_FRAG_B                         12
  42 #define HNS3_RXD_STRP_TAGP_S                    13
  43 #define HNS3_RXD_STRP_TAGP_M                    (0x3 << HNS3_RXD_STRP_TAGP_S)
  44
  45 #define HNS3_RXD_L2E_B                          16
  46 #define HNS3_RXD_L3E_B                          17
  47 #define HNS3_RXD_L4E_B                          18
  48 #define HNS3_RXD_TRUNCAT_B                      19
  49 #define HNS3_RXD_HOI_B                          20
  50 #define HNS3_RXD_DOI_B                          21
  51 #define HNS3_RXD_OL3E_B                         22
  52 #define HNS3_RXD_OL4E_B                         23
  53 #define HNS3_RXD_GRO_COUNT_S                    24
  54 #define HNS3_RXD_GRO_COUNT_M                    (0x3f << HNS3_RXD_GRO_COUNT_S)
  55 #define HNS3_RXD_GRO_FIXID_B                    30
  56 #define HNS3_RXD_GRO_ECN_B                      31
  57
  58 #define HNS3_RXD_ODMAC_S                        0
  59 #define HNS3_RXD_ODMAC_M                        (0x3 << HNS3_RXD_ODMAC_S)
  60 #define HNS3_RXD_OVLAN_S                        2
  61 #define HNS3_RXD_OVLAN_M                        (0x3 << HNS3_RXD_OVLAN_S)
  62 #define HNS3_RXD_OL3ID_S                        4
  63 #define HNS3_RXD_OL3ID_M                        (0xf << HNS3_RXD_OL3ID_S)
  64 #define HNS3_RXD_OL4ID_S                        8
  65 #define HNS3_RXD_OL4ID_M                        (0xf << HNS3_RXD_OL4ID_S)
  66 #define HNS3_RXD_FBHI_S                         12
  67 #define HNS3_RXD_FBHI_M                         (0x3 << HNS3_RXD_FBHI_S)
  68 #define HNS3_RXD_FBLI_S                         14
  69 #define HNS3_RXD_FBLI_M                         (0x3 << HNS3_RXD_FBLI_S)
  70
  71 #define HNS3_RXD_BDTYPE_S                       0
  72 #define HNS3_RXD_BDTYPE_M                       (0xf << HNS3_RXD_BDTYPE_S)
  73 #define HNS3_RXD_VLD_B                          4
  74 #define HNS3_RXD_UDP0_B                         5
  75 #define HNS3_RXD_EXTEND_B                       7
  76 #define HNS3_RXD_FE_B                           8
  77 #define HNS3_RXD_LUM_B                          9
  78 #define HNS3_RXD_CRCP_B                         10
  79 #define HNS3_RXD_L3L4P_B                        11
  80 #define HNS3_RXD_TSIND_S                        12
  81 #define HNS3_RXD_TSIND_M                        (0x7 << HNS3_RXD_TSIND_S)
  82 #define HNS3_RXD_LKBK_B                         15
  83 #define HNS3_RXD_GRO_SIZE_S                     16
  84 #define HNS3_RXD_GRO_SIZE_M                     (0x3fff << HNS3_RXD_GRO_SIZE_S)
  85
  86 #define HNS3_TXD_L3T_S                          0
  87 #define HNS3_TXD_L3T_M                          (0x3 << HNS3_TXD_L3T_S)
  88 #define HNS3_TXD_L4T_S                          2
  89 #define HNS3_TXD_L4T_M                          (0x3 << HNS3_TXD_L4T_S)
  90 #define HNS3_TXD_L3CS_B                         4
  91 #define HNS3_TXD_L4CS_B                         5
  92 #define HNS3_TXD_VLAN_B                         6
  93 #define HNS3_TXD_TSO_B                          7
  94
  95 #define HNS3_TXD_L2LEN_S                        8
  96 #define HNS3_TXD_L2LEN_M                        (0xff << HNS3_TXD_L2LEN_S)
  97 #define HNS3_TXD_L3LEN_S                        16
  98 #define HNS3_TXD_L3LEN_M                        (0xff << HNS3_TXD_L3LEN_S)
  99 #define HNS3_TXD_L4LEN_S                        24
 100 #define HNS3_TXD_L4LEN_M                        (0xffUL << HNS3_TXD_L4LEN_S)
 101
 102 #define HNS3_TXD_OL3T_S                         0
 103 #define HNS3_TXD_OL3T_M                         (0x3 << HNS3_TXD_OL3T_S)
 104 #define HNS3_TXD_OVLAN_B                        2
 105 #define HNS3_TXD_MACSEC_B                       3
 106 #define HNS3_TXD_TUNTYPE_S                      4
 107 #define HNS3_TXD_TUNTYPE_M                      (0xf << HNS3_TXD_TUNTYPE_S)
 108
 109 #define HNS3_TXD_BDTYPE_S                       0
 110 #define HNS3_TXD_BDTYPE_M                       (0xf << HNS3_TXD_BDTYPE_S)
 111 #define HNS3_TXD_FE_B                           4
 112 #define HNS3_TXD_SC_S                           5
 113 #define HNS3_TXD_SC_M                           (0x3 << HNS3_TXD_SC_S)
 114 #define HNS3_TXD_EXTEND_B                       7
 115 #define HNS3_TXD_VLD_B                          8
 116 #define HNS3_TXD_RI_B                           9
 117 #define HNS3_TXD_RA_B                           10
 118 #define HNS3_TXD_TSYN_B                         11
 119 #define HNS3_TXD_DECTTL_S                       12
 120 #define HNS3_TXD_DECTTL_M                       (0xf << HNS3_TXD_DECTTL_S)
 121
 122 #define HNS3_TXD_MSS_S                          0
 123 #define HNS3_TXD_MSS_M                          (0x3fff << HNS3_TXD_MSS_S)
 124
 125 #define HNS3_L2_LEN_UNIT                        1UL
 126 #define HNS3_L3_LEN_UNIT                        2UL
 127 #define HNS3_L4_LEN_UNIT                        2UL
 128
 129 enum hns3_pkt_l2t_type {
 130         HNS3_L2_TYPE_UNICAST,
 131         HNS3_L2_TYPE_MULTICAST,
 132         HNS3_L2_TYPE_BROADCAST,
 133         HNS3_L2_TYPE_INVALID,
 134 };
 135
 136 enum hns3_pkt_l3t_type {
 137         HNS3_L3T_NONE,
 138         HNS3_L3T_IPV6,
 139         HNS3_L3T_IPV4,
 140         HNS3_L3T_RESERVED
 141 };
 142
 143 enum hns3_pkt_l4t_type {
 144         HNS3_L4T_UNKNOWN,
 145         HNS3_L4T_TCP,
 146         HNS3_L4T_UDP,
 147         HNS3_L4T_SCTP
 148 };
 149
 150 enum hns3_pkt_ol3t_type {
 151         HNS3_OL3T_NONE,
 152         HNS3_OL3T_IPV6,
 153         HNS3_OL3T_IPV4_NO_CSUM,
 154         HNS3_OL3T_IPV4_CSUM
 155 };
 156
 157 enum hns3_pkt_tun_type {
 158         HNS3_TUN_NONE,
 159         HNS3_TUN_MAC_IN_UDP,
 160         HNS3_TUN_NVGRE,
 161         HNS3_TUN_OTHER
 162 };
 163
 164 /* hardware spec ring buffer format */
 165 struct hns3_desc {
 166         union {
 167                 uint64_t addr;
 168                 struct {
 169                         uint32_t addr0;
 170                         uint32_t addr1;
 171                 };
 172         };
 173         union {
 174                 struct {
 175                         uint16_t vlan_tag;
 176                         uint16_t send_size;
 177                         union {
 178                                 /*
 179                                  * L3T | L4T | L3CS | L4CS | VLAN | TSO |
 180                                  * L2_LEN
 181                                  */
 182                                 uint32_t type_cs_vlan_tso_len;
 183                                 struct {
 184                                         uint8_t type_cs_vlan_tso;
 185                                         uint8_t l2_len;
 186                                         uint8_t l3_len;
 187                                         uint8_t l4_len;
 188                                 };
 189                         };
 190                         uint16_t outer_vlan_tag;
 191                         uint16_t tv;
 192                         union {
 193                                 /* OL3T | OVALAN | MACSEC */
 194                                 uint32_t ol_type_vlan_len_msec;
 195                                 struct {
 196                                         uint8_t ol_type_vlan_msec;
 197                                         uint8_t ol2_len;
 198                                         uint8_t ol3_len;
 199                                         uint8_t ol4_len;
 200                                 };
 201                         };
 202
 203                         uint32_t paylen;
 204                         uint16_t tp_fe_sc_vld_ra_ri;
 205                         uint16_t mss;
 206                 } tx;
 207
 208                 struct {
 209                         uint32_t l234_info;
 210                         uint16_t pkt_len;
 211                         uint16_t size;
 212                         uint32_t rss_hash;
 213                         uint16_t fd_id;
 214                         uint16_t vlan_tag;
 215                         union {
 216                                 uint32_t ol_info;
 217                                 struct {
 218                                         uint16_t o_dm_vlan_id_fb;
 219                                         uint16_t ot_vlan_tag;
 220                                 };
 221                         };
 222                         uint32_t bd_base_info;
 223                 } rx;
 224         };
 225 } __rte_packed;
 226
 227 struct hns3_entry {
 228         struct rte_mbuf *mbuf;
 229 };
 230
 231 struct hns3_rx_queue {
 232         void *io_base;
 233         struct hns3_adapter *hns;
 234         struct rte_mempool *mb_pool;
 235         struct hns3_desc *rx_ring;
 236         uint64_t rx_ring_phys_addr; /* RX ring DMA address */
 237         const struct rte_memzone *mz;
 238         struct hns3_entry *sw_ring;
 239
 240         struct rte_mbuf *pkt_first_seg;
 241         struct rte_mbuf *pkt_last_seg;
 242
 243         uint16_t queue_id;
 244         uint16_t port_id;
 245         uint16_t nb_rx_desc;
 246         uint16_t nb_rx_hold;
 247         uint16_t rx_tail;
 248         uint16_t next_to_clean;
 249         uint16_t next_to_use;
 250         uint16_t rx_buf_len;
 251         uint16_t rx_free_thresh;
 252
 253         /*
 254          * port based vlan configuration state.
 255          * value range: HNS3_PORT_BASE_VLAN_DISABLE / HNS3_PORT_BASE_VLAN_ENABLE
 256          */
 257         uint16_t pvid_state;
 258
 259         bool rx_deferred_start; /* don't start this queue in dev start */
 260         bool configured;        /* indicate if rx queue has been configured */
 261
 262         uint64_t l2_errors;
 263         uint64_t pkt_len_errors;
 264         uint64_t l3_csum_erros;
 265         uint64_t l4_csum_erros;
 266         uint64_t ol3_csum_erros;
 267         uint64_t ol4_csum_erros;
 268 };
 269
 270 struct hns3_tx_queue {
 271         void *io_base;
 272         struct hns3_adapter *hns;
 273         struct hns3_desc *tx_ring;
 274         uint64_t tx_ring_phys_addr; /* TX ring DMA address */
 275         const struct rte_memzone *mz;
 276         struct hns3_entry *sw_ring;
 277
 278         uint16_t queue_id;
 279         uint16_t port_id;
 280         uint16_t nb_tx_desc;
 281         uint16_t next_to_clean;
 282         uint16_t next_to_use;
 283         uint16_t tx_bd_ready;
 284
 285         /*
 286          * port based vlan configuration state.
 287          * value range: HNS3_PORT_BASE_VLAN_DISABLE / HNS3_PORT_BASE_VLAN_ENABLE
 288          */
 289         uint16_t pvid_state;
 290
 291         bool tx_deferred_start; /* don't start this queue in dev start */
 292         bool configured;        /* indicate if tx queue has been configured */
 293
 294         /*
 295          * The following items are used for the abnormal errors statistics in
 296          * the Tx datapath. When upper level application calls the
 297          * rte_eth_tx_burst API function to send multiple packets at a time with
 298          * burst mode based on hns3 network engine, there are some abnormal
 299          * conditions that cause the driver to fail to operate the hardware to
 300          * send packets correctly.
 301          * Note: When using burst mode to call the rte_eth_tx_burst API function
 302          * to send multiple packets at a time. When the first abnormal error is
 303          * detected, add one to the relevant error statistics item, and then
 304          * exit the loop of sending multiple packets of the function. That is to
 305          * say, even if there are multiple packets in which abnormal errors may
 306          * be detected in the burst, the relevant error statistics in the driver
 307          * will only be increased by one.
 308          * The detail description of the Tx abnormal errors statistic items as
 309          * below:
 310          *  - over_length_pkt_cnt
 311          *     Total number of greater than HNS3_MAX_FRAME_LEN the driver
 312          *     supported.
 313          *
 314          * - exceed_limit_bd_pkt_cnt
 315          *     Total number of exceeding the hardware limited bd which process
 316          *     a packet needed bd numbers.
 317          *
 318          * - exceed_limit_bd_reassem_fail
 319          *     Total number of exceeding the hardware limited bd fail which
 320          *     process a packet needed bd numbers and reassemble fail.
 321          *
 322          * - unsupported_tunnel_pkt_cnt
 323          *     Total number of unsupported tunnel packet. The unsupported tunnel
 324          *     type: vxlan_gpe, gtp, ipip and MPLSINUDP, MPLSINUDP is a packet
 325          *     with MPLS-in-UDP RFC 7510 header.
 326          *
 327          * - queue_full_cnt
 328          *     Total count which the available bd numbers in current bd queue is
 329          *     less than the bd numbers with the pkt process needed.
 330          *
 331          * - pkt_padding_fail_cnt
 332          *     Total count which the packet length is less than minimum packet
 333          *     size HNS3_MIN_PKT_SIZE and fail to be appended with 0.
 334          */
 335         uint64_t over_length_pkt_cnt;
 336         uint64_t exceed_limit_bd_pkt_cnt;
 337         uint64_t exceed_limit_bd_reassem_fail;
 338         uint64_t unsupported_tunnel_pkt_cnt;
 339         uint64_t queue_full_cnt;
 340         uint64_t pkt_padding_fail_cnt;
 341 };
 342
 343 struct hns3_queue_info {
 344         const char *type;   /* point to queue memory name */
 345         const char *ring_name;  /* point to hardware ring name */
 346         uint16_t idx;
 347         uint16_t nb_desc;
 348         unsigned int socket_id;
 349 };
 350
 351 #define HNS3_TX_CKSUM_OFFLOAD_MASK ( \
 352         PKT_TX_OUTER_IPV6 | \
 353         PKT_TX_OUTER_IPV4 | \
 354         PKT_TX_OUTER_IP_CKSUM | \
 355         PKT_TX_IPV6 | \
 356         PKT_TX_IPV4 | \
 357         PKT_TX_IP_CKSUM | \
 358         PKT_TX_L4_MASK | \
 359         PKT_TX_TUNNEL_MASK)
 360
 361 enum hns3_cksum_status {
 362         HNS3_CKSUM_NONE = 0,
 363         HNS3_L3_CKSUM_ERR = 1,
 364         HNS3_L4_CKSUM_ERR = 2,
 365         HNS3_OUTER_L3_CKSUM_ERR = 4,
 366         HNS3_OUTER_L4_CKSUM_ERR = 8
 367 };
 368
 369 void hns3_dev_rx_queue_release(void *queue);
 370 void hns3_dev_tx_queue_release(void *queue);
 371 void hns3_free_all_queues(struct rte_eth_dev *dev);
 372 int hns3_reset_all_queues(struct hns3_adapter *hns);
 373 void hns3_dev_all_rx_queue_intr_enable(struct hns3_hw *hw, bool en);
 374 int hns3_dev_rx_queue_intr_enable(struct rte_eth_dev *dev, uint16_t queue_id);
 375 int hns3_dev_rx_queue_intr_disable(struct rte_eth_dev *dev, uint16_t queue_id);
 376 void hns3_enable_all_queues(struct hns3_hw *hw, bool en);
 377 int hns3_start_queues(struct hns3_adapter *hns, bool reset_queue);
 378 int hns3_stop_queues(struct hns3_adapter *hns, bool reset_queue);
 379 void hns3_dev_release_mbufs(struct hns3_adapter *hns);
 380 int hns3_rx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t nb_desc,
 381                         unsigned int socket, const struct rte_eth_rxconf *conf,
 382                         struct rte_mempool *mp);
 383 int hns3_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t nb_desc,
 384                         unsigned int socket, const struct rte_eth_txconf *conf);
 385 uint16_t hns3_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 386                         uint16_t nb_pkts);
 387 uint16_t hns3_prep_pkts(__rte_unused void *tx_queue, struct rte_mbuf **tx_pkts,
 388                         uint16_t nb_pkts);
 389 uint16_t hns3_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 390                         uint16_t nb_pkts);
 391 const uint32_t *hns3_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 392 void hns3_set_rxtx_function(struct rte_eth_dev *eth_dev);
 393 void hns3_set_queue_intr_gl(struct hns3_hw *hw, uint16_t queue_id,
 394                             uint8_t gl_idx, uint16_t gl_value);
 395 void hns3_set_queue_intr_rl(struct hns3_hw *hw, uint16_t queue_id,
 396                             uint16_t rl_value);
 397 int hns3_set_fake_rx_or_tx_queues(struct rte_eth_dev *dev, uint16_t nb_rx_q,
 398                                   uint16_t nb_tx_q);
 399 int hns3_config_gro(struct hns3_hw *hw, bool en);
 400 int hns3_restore_gro_conf(struct hns3_hw *hw);
 401 void hns3_update_all_queues_pvid_state(struct hns3_hw *hw);
 402
 403 #endif /* _HNS3_RXTX_H_ */