drivers/net/ethernet/hisilicon/hns3/hns3_enet.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 // Copyright (c) 2016-2017 Hisilicon Limited.
   3
   4 #ifndef __HNS3_ENET_H
   5 #define __HNS3_ENET_H
   6
   7 #include <linux/if_vlan.h>
   8
   9 #include "hnae3.h"
  10
  11 enum hns3_nic_state {
  12         HNS3_NIC_STATE_TESTING,
  13         HNS3_NIC_STATE_RESETTING,
  14         HNS3_NIC_STATE_INITED,
  15         HNS3_NIC_STATE_DOWN,
  16         HNS3_NIC_STATE_DISABLED,
  17         HNS3_NIC_STATE_REMOVING,
  18         HNS3_NIC_STATE_SERVICE_INITED,
  19         HNS3_NIC_STATE_SERVICE_SCHED,
  20         HNS3_NIC_STATE2_RESET_REQUESTED,
  21         HNS3_NIC_STATE_HW_TX_CSUM_ENABLE,
  22         HNS3_NIC_STATE_MAX
  23 };
  24
  25 #define HNS3_RING_RX_RING_BASEADDR_L_REG        0x00000
  26 #define HNS3_RING_RX_RING_BASEADDR_H_REG        0x00004
  27 #define HNS3_RING_RX_RING_BD_NUM_REG            0x00008
  28 #define HNS3_RING_RX_RING_BD_LEN_REG            0x0000C
  29 #define HNS3_RING_RX_RING_TAIL_REG              0x00018
  30 #define HNS3_RING_RX_RING_HEAD_REG              0x0001C
  31 #define HNS3_RING_RX_RING_FBDNUM_REG            0x00020
  32 #define HNS3_RING_RX_RING_PKTNUM_RECORD_REG     0x0002C
  33
  34 #define HNS3_RING_TX_RING_BASEADDR_L_REG        0x00040
  35 #define HNS3_RING_TX_RING_BASEADDR_H_REG        0x00044
  36 #define HNS3_RING_TX_RING_BD_NUM_REG            0x00048
  37 #define HNS3_RING_TX_RING_TC_REG                0x00050
  38 #define HNS3_RING_TX_RING_TAIL_REG              0x00058
  39 #define HNS3_RING_TX_RING_HEAD_REG              0x0005C
  40 #define HNS3_RING_TX_RING_FBDNUM_REG            0x00060
  41 #define HNS3_RING_TX_RING_OFFSET_REG            0x00064
  42 #define HNS3_RING_TX_RING_EBDNUM_REG            0x00068
  43 #define HNS3_RING_TX_RING_PKTNUM_RECORD_REG     0x0006C
  44 #define HNS3_RING_TX_RING_EBD_OFFSET_REG        0x00070
  45 #define HNS3_RING_TX_RING_BD_ERR_REG            0x00074
  46 #define HNS3_RING_EN_REG                        0x00090
  47 #define HNS3_RING_RX_EN_REG                     0x00098
  48 #define HNS3_RING_TX_EN_REG                     0x000D4
  49
  50 #define HNS3_RX_HEAD_SIZE                       256
  51
  52 #define HNS3_TX_TIMEOUT (5 * HZ)
  53 #define HNS3_RING_NAME_LEN                      16
  54 #define HNS3_BUFFER_SIZE_2048                   2048
  55 #define HNS3_RING_MAX_PENDING                   32760
  56 #define HNS3_RING_MIN_PENDING                   72
  57 #define HNS3_RING_BD_MULTIPLE                   8
  58 /* max frame size of mac */
  59 #define HNS3_MAX_MTU(max_frm_size) \
  60         ((max_frm_size) - (ETH_HLEN + ETH_FCS_LEN + 2 * VLAN_HLEN))
  61
  62 #define HNS3_BD_SIZE_512_TYPE                   0
  63 #define HNS3_BD_SIZE_1024_TYPE                  1
  64 #define HNS3_BD_SIZE_2048_TYPE                  2
  65 #define HNS3_BD_SIZE_4096_TYPE                  3
  66
  67 #define HNS3_RX_FLAG_VLAN_PRESENT               0x1
  68 #define HNS3_RX_FLAG_L3ID_IPV4                  0x0
  69 #define HNS3_RX_FLAG_L3ID_IPV6                  0x1
  70 #define HNS3_RX_FLAG_L4ID_UDP                   0x0
  71 #define HNS3_RX_FLAG_L4ID_TCP                   0x1
  72
  73 #define HNS3_RXD_DMAC_S                         0
  74 #define HNS3_RXD_DMAC_M                         (0x3 << HNS3_RXD_DMAC_S)
  75 #define HNS3_RXD_VLAN_S                         2
  76 #define HNS3_RXD_VLAN_M                         (0x3 << HNS3_RXD_VLAN_S)
  77 #define HNS3_RXD_L3ID_S                         4
  78 #define HNS3_RXD_L3ID_M                         (0xf << HNS3_RXD_L3ID_S)
  79 #define HNS3_RXD_L4ID_S                         8
  80 #define HNS3_RXD_L4ID_M                         (0xf << HNS3_RXD_L4ID_S)
  81 #define HNS3_RXD_FRAG_B                         12
  82 #define HNS3_RXD_STRP_TAGP_S                    13
  83 #define HNS3_RXD_STRP_TAGP_M                    (0x3 << HNS3_RXD_STRP_TAGP_S)
  84
  85 #define HNS3_RXD_L2_CSUM_B                      15
  86 #define HNS3_RXD_L2_CSUM_L_S                    4
  87 #define HNS3_RXD_L2_CSUM_L_M                    (0xff << HNS3_RXD_L2_CSUM_L_S)
  88 #define HNS3_RXD_L2_CSUM_H_S                    24
  89 #define HNS3_RXD_L2_CSUM_H_M                    (0xff << HNS3_RXD_L2_CSUM_H_S)
  90
  91 #define HNS3_RXD_L2E_B                          16
  92 #define HNS3_RXD_L3E_B                          17
  93 #define HNS3_RXD_L4E_B                          18
  94 #define HNS3_RXD_TRUNCAT_B                      19
  95 #define HNS3_RXD_HOI_B                          20
  96 #define HNS3_RXD_DOI_B                          21
  97 #define HNS3_RXD_OL3E_B                         22
  98 #define HNS3_RXD_OL4E_B                         23
  99 #define HNS3_RXD_GRO_COUNT_S                    24
 100 #define HNS3_RXD_GRO_COUNT_M                    (0x3f << HNS3_RXD_GRO_COUNT_S)
 101 #define HNS3_RXD_GRO_FIXID_B                    30
 102 #define HNS3_RXD_GRO_ECN_B                      31
 103
 104 #define HNS3_RXD_ODMAC_S                        0
 105 #define HNS3_RXD_ODMAC_M                        (0x3 << HNS3_RXD_ODMAC_S)
 106 #define HNS3_RXD_OVLAN_S                        2
 107 #define HNS3_RXD_OVLAN_M                        (0x3 << HNS3_RXD_OVLAN_S)
 108 #define HNS3_RXD_OL3ID_S                        4
 109 #define HNS3_RXD_OL3ID_M                        (0xf << HNS3_RXD_OL3ID_S)
 110 #define HNS3_RXD_OL4ID_S                        8
 111 #define HNS3_RXD_OL4ID_M                        (0xf << HNS3_RXD_OL4ID_S)
 112 #define HNS3_RXD_FBHI_S                         12
 113 #define HNS3_RXD_FBHI_M                         (0x3 << HNS3_RXD_FBHI_S)
 114 #define HNS3_RXD_FBLI_S                         14
 115 #define HNS3_RXD_FBLI_M                         (0x3 << HNS3_RXD_FBLI_S)
 116
 117 #define HNS3_RXD_BDTYPE_S                       0
 118 #define HNS3_RXD_BDTYPE_M                       (0xf << HNS3_RXD_BDTYPE_S)
 119 #define HNS3_RXD_VLD_B                          4
 120 #define HNS3_RXD_UDP0_B                         5
 121 #define HNS3_RXD_EXTEND_B                       7
 122 #define HNS3_RXD_FE_B                           8
 123 #define HNS3_RXD_LUM_B                          9
 124 #define HNS3_RXD_CRCP_B                         10
 125 #define HNS3_RXD_L3L4P_B                        11
 126 #define HNS3_RXD_TSIND_S                        12
 127 #define HNS3_RXD_TSIND_M                        (0x7 << HNS3_RXD_TSIND_S)
 128 #define HNS3_RXD_LKBK_B                         15
 129 #define HNS3_RXD_GRO_SIZE_S                     16
 130 #define HNS3_RXD_GRO_SIZE_M                     (0x3fff << HNS3_RXD_GRO_SIZE_S)
 131
 132 #define HNS3_TXD_L3T_S                          0
 133 #define HNS3_TXD_L3T_M                          (0x3 << HNS3_TXD_L3T_S)
 134 #define HNS3_TXD_L4T_S                          2
 135 #define HNS3_TXD_L4T_M                          (0x3 << HNS3_TXD_L4T_S)
 136 #define HNS3_TXD_L3CS_B                         4
 137 #define HNS3_TXD_L4CS_B                         5
 138 #define HNS3_TXD_VLAN_B                         6
 139 #define HNS3_TXD_TSO_B                          7
 140
 141 #define HNS3_TXD_L2LEN_S                        8
 142 #define HNS3_TXD_L2LEN_M                        (0xff << HNS3_TXD_L2LEN_S)
 143 #define HNS3_TXD_L3LEN_S                        16
 144 #define HNS3_TXD_L3LEN_M                        (0xff << HNS3_TXD_L3LEN_S)
 145 #define HNS3_TXD_L4LEN_S                        24
 146 #define HNS3_TXD_L4LEN_M                        (0xff << HNS3_TXD_L4LEN_S)
 147
 148 #define HNS3_TXD_CSUM_START_S           8
 149 #define HNS3_TXD_CSUM_START_M           (0xffff << HNS3_TXD_CSUM_START_S)
 150
 151 #define HNS3_TXD_OL3T_S                         0
 152 #define HNS3_TXD_OL3T_M                         (0x3 << HNS3_TXD_OL3T_S)
 153 #define HNS3_TXD_OVLAN_B                        2
 154 #define HNS3_TXD_MACSEC_B                       3
 155 #define HNS3_TXD_TUNTYPE_S                      4
 156 #define HNS3_TXD_TUNTYPE_M                      (0xf << HNS3_TXD_TUNTYPE_S)
 157
 158 #define HNS3_TXD_CSUM_OFFSET_S          8
 159 #define HNS3_TXD_CSUM_OFFSET_M          (0xffff << HNS3_TXD_CSUM_OFFSET_S)
 160
 161 #define HNS3_TXD_BDTYPE_S                       0
 162 #define HNS3_TXD_BDTYPE_M                       (0xf << HNS3_TXD_BDTYPE_S)
 163 #define HNS3_TXD_FE_B                           4
 164 #define HNS3_TXD_SC_S                           5
 165 #define HNS3_TXD_SC_M                           (0x3 << HNS3_TXD_SC_S)
 166 #define HNS3_TXD_EXTEND_B                       7
 167 #define HNS3_TXD_VLD_B                          8
 168 #define HNS3_TXD_RI_B                           9
 169 #define HNS3_TXD_RA_B                           10
 170 #define HNS3_TXD_TSYN_B                         11
 171 #define HNS3_TXD_DECTTL_S                       12
 172 #define HNS3_TXD_DECTTL_M                       (0xf << HNS3_TXD_DECTTL_S)
 173
 174 #define HNS3_TXD_OL4CS_B                        22
 175
 176 #define HNS3_TXD_MSS_S                          0
 177 #define HNS3_TXD_MSS_M                          (0x3fff << HNS3_TXD_MSS_S)
 178 #define HNS3_TXD_HW_CS_B                        14
 179
 180 #define HNS3_VECTOR_TX_IRQ                      BIT_ULL(0)
 181 #define HNS3_VECTOR_RX_IRQ                      BIT_ULL(1)
 182
 183 #define HNS3_VECTOR_NOT_INITED                  0
 184 #define HNS3_VECTOR_INITED                      1
 185
 186 #define HNS3_MAX_BD_SIZE                        65535
 187 #define HNS3_MAX_TSO_BD_NUM                     63U
 188 #define HNS3_MAX_TSO_SIZE \
 189         (HNS3_MAX_BD_SIZE * HNS3_MAX_TSO_BD_NUM)
 190
 191 #define HNS3_MAX_NON_TSO_SIZE(max_non_tso_bd_num) \
 192         (HNS3_MAX_BD_SIZE * (max_non_tso_bd_num))
 193
 194 #define HNS3_VECTOR_GL0_OFFSET                  0x100
 195 #define HNS3_VECTOR_GL1_OFFSET                  0x200
 196 #define HNS3_VECTOR_GL2_OFFSET                  0x300
 197 #define HNS3_VECTOR_RL_OFFSET                   0x900
 198 #define HNS3_VECTOR_RL_EN_B                     6
 199 #define HNS3_VECTOR_TX_QL_OFFSET                0xe00
 200 #define HNS3_VECTOR_RX_QL_OFFSET                0xf00
 201
 202 #define HNS3_RING_EN_B                          0
 203
 204 enum hns3_pkt_l2t_type {
 205         HNS3_L2_TYPE_UNICAST,
 206         HNS3_L2_TYPE_MULTICAST,
 207         HNS3_L2_TYPE_BROADCAST,
 208         HNS3_L2_TYPE_INVALID,
 209 };
 210
 211 enum hns3_pkt_l3t_type {
 212         HNS3_L3T_NONE,
 213         HNS3_L3T_IPV6,
 214         HNS3_L3T_IPV4,
 215         HNS3_L3T_RESERVED
 216 };
 217
 218 enum hns3_pkt_l4t_type {
 219         HNS3_L4T_UNKNOWN,
 220         HNS3_L4T_TCP,
 221         HNS3_L4T_UDP,
 222         HNS3_L4T_SCTP
 223 };
 224
 225 enum hns3_pkt_ol3t_type {
 226         HNS3_OL3T_NONE,
 227         HNS3_OL3T_IPV6,
 228         HNS3_OL3T_IPV4_NO_CSUM,
 229         HNS3_OL3T_IPV4_CSUM
 230 };
 231
 232 enum hns3_pkt_tun_type {
 233         HNS3_TUN_NONE,
 234         HNS3_TUN_MAC_IN_UDP,
 235         HNS3_TUN_NVGRE,
 236         HNS3_TUN_OTHER
 237 };
 238
 239 /* hardware spec ring buffer format */
 240 struct __packed hns3_desc {
 241         __le64 addr;
 242         union {
 243                 struct {
 244                         __le16 vlan_tag;
 245                         __le16 send_size;
 246                         union {
 247                                 __le32 type_cs_vlan_tso_len;
 248                                 struct {
 249                                         __u8 type_cs_vlan_tso;
 250                                         __u8 l2_len;
 251                                         __u8 l3_len;
 252                                         __u8 l4_len;
 253                                 };
 254                         };
 255                         __le16 outer_vlan_tag;
 256                         __le16 tv;
 257
 258                 union {
 259                         __le32 ol_type_vlan_len_msec;
 260                         struct {
 261                                 __u8 ol_type_vlan_msec;
 262                                 __u8 ol2_len;
 263                                 __u8 ol3_len;
 264                                 __u8 ol4_len;
 265                         };
 266                 };
 267
 268                         __le32 paylen_ol4cs;
 269                         __le16 bdtp_fe_sc_vld_ra_ri;
 270                         __le16 mss_hw_csum;
 271                 } tx;
 272
 273                 struct {
 274                         __le32 l234_info;
 275                         __le16 pkt_len;
 276                         __le16 size;
 277
 278                         __le32 rss_hash;
 279                         __le16 fd_id;
 280                         __le16 vlan_tag;
 281
 282                         union {
 283                                 __le32 ol_info;
 284                                 struct {
 285                                         __le16 o_dm_vlan_id_fb;
 286                                         __le16 ot_vlan_tag;
 287                                 };
 288                         };
 289
 290                         __le32 bd_base_info;
 291                 } rx;
 292         };
 293 };
 294
 295 struct hns3_desc_cb {
 296         dma_addr_t dma; /* dma address of this desc */
 297         void *buf;      /* cpu addr for a desc */
 298
 299         /* priv data for the desc, e.g. skb when use with ip stack */
 300         void *priv;
 301         u32 page_offset;
 302         u32 length;     /* length of the buffer */
 303
 304         u16 reuse_flag;
 305
 306         /* desc type, used by the ring user to mark the type of the priv data */
 307         u16 type;
 308         u16 pagecnt_bias;
 309 };
 310
 311 enum hns3_pkt_l3type {
 312         HNS3_L3_TYPE_IPV4,
 313         HNS3_L3_TYPE_IPV6,
 314         HNS3_L3_TYPE_ARP,
 315         HNS3_L3_TYPE_RARP,
 316         HNS3_L3_TYPE_IPV4_OPT,
 317         HNS3_L3_TYPE_IPV6_EXT,
 318         HNS3_L3_TYPE_LLDP,
 319         HNS3_L3_TYPE_BPDU,
 320         HNS3_L3_TYPE_MAC_PAUSE,
 321         HNS3_L3_TYPE_PFC_PAUSE,/* 0x9*/
 322
 323         /* reserved for 0xA~0xB */
 324
 325         HNS3_L3_TYPE_CNM = 0xc,
 326
 327         /* reserved for 0xD~0xE */
 328
 329         HNS3_L3_TYPE_PARSE_FAIL = 0xf /* must be last */
 330 };
 331
 332 enum hns3_pkt_l4type {
 333         HNS3_L4_TYPE_UDP,
 334         HNS3_L4_TYPE_TCP,
 335         HNS3_L4_TYPE_GRE,
 336         HNS3_L4_TYPE_SCTP,
 337         HNS3_L4_TYPE_IGMP,
 338         HNS3_L4_TYPE_ICMP,
 339
 340         /* reserved for 0x6~0xE */
 341
 342         HNS3_L4_TYPE_PARSE_FAIL = 0xf /* must be last */
 343 };
 344
 345 enum hns3_pkt_ol3type {
 346         HNS3_OL3_TYPE_IPV4 = 0,
 347         HNS3_OL3_TYPE_IPV6,
 348         /* reserved for 0x2~0x3 */
 349         HNS3_OL3_TYPE_IPV4_OPT = 4,
 350         HNS3_OL3_TYPE_IPV6_EXT,
 351
 352         /* reserved for 0x6~0xE */
 353
 354         HNS3_OL3_TYPE_PARSE_FAIL = 0xf  /* must be last */
 355 };
 356
 357 enum hns3_pkt_ol4type {
 358         HNS3_OL4_TYPE_NO_TUN,
 359         HNS3_OL4_TYPE_MAC_IN_UDP,
 360         HNS3_OL4_TYPE_NVGRE,
 361         HNS3_OL4_TYPE_UNKNOWN
 362 };
 363
 364 struct ring_stats {
 365         u64 sw_err_cnt;
 366         u64 seg_pkt_cnt;
 367         union {
 368                 struct {
 369                         u64 tx_pkts;
 370                         u64 tx_bytes;
 371                         u64 tx_more;
 372                         u64 restart_queue;
 373                         u64 tx_busy;
 374                         u64 tx_copy;
 375                         u64 tx_vlan_err;
 376                         u64 tx_l4_proto_err;
 377                         u64 tx_l2l3l4_err;
 378                         u64 tx_tso_err;
 379                 };
 380                 struct {
 381                         u64 rx_pkts;
 382                         u64 rx_bytes;
 383                         u64 rx_err_cnt;
 384                         u64 reuse_pg_cnt;
 385                         u64 err_pkt_len;
 386                         u64 err_bd_num;
 387                         u64 l2_err;
 388                         u64 l3l4_csum_err;
 389                         u64 csum_complete;
 390                         u64 rx_multicast;
 391                         u64 non_reuse_pg;
 392                 };
 393         };
 394 };
 395
 396 struct hns3_enet_ring {
 397         struct hns3_desc *desc; /* dma map address space */
 398         struct hns3_desc_cb *desc_cb;
 399         struct hns3_enet_ring *next;
 400         struct hns3_enet_tqp_vector *tqp_vector;
 401         struct hnae3_queue *tqp;
 402         int queue_index;
 403         struct device *dev; /* will be used for DMA mapping of descriptors */
 404
 405         /* statistic */
 406         struct ring_stats stats;
 407         struct u64_stats_sync syncp;
 408
 409         dma_addr_t desc_dma_addr;
 410         u32 buf_size;       /* size for hnae_desc->addr, preset by AE */
 411         u16 desc_num;       /* total number of desc */
 412         int next_to_use;    /* idx of next spare desc */
 413
 414         /* idx of lastest sent desc, the ring is empty when equal to
 415          * next_to_use
 416          */
 417         int next_to_clean;
 418         union {
 419                 int last_to_use;        /* last idx used by xmit */
 420                 u32 pull_len;           /* memcpy len for current rx packet */
 421         };
 422         u32 frag_num;
 423         void *va; /* first buffer address for current packet */
 424
 425         u32 flag;          /* ring attribute */
 426
 427         int pending_buf;
 428         struct sk_buff *skb;
 429         struct sk_buff *tail_skb;
 430 } ____cacheline_internodealigned_in_smp;
 431
 432 enum hns3_flow_level_range {
 433         HNS3_FLOW_LOW = 0,
 434         HNS3_FLOW_MID = 1,
 435         HNS3_FLOW_HIGH = 2,
 436         HNS3_FLOW_ULTRA = 3,
 437 };
 438
 439 #define HNS3_INT_GL_50K                 0x0014
 440 #define HNS3_INT_GL_20K                 0x0032
 441 #define HNS3_INT_GL_18K                 0x0036
 442 #define HNS3_INT_GL_8K                  0x007C
 443
 444 #define HNS3_INT_GL_1US                 BIT(31)
 445
 446 #define HNS3_INT_RL_MAX                 0x00EC
 447 #define HNS3_INT_RL_ENABLE_MASK         0x40
 448
 449 #define HNS3_INT_QL_DEFAULT_CFG         0x20
 450
 451 struct hns3_enet_coalesce {
 452         u16 int_gl;
 453         u16 int_ql;
 454         u16 int_ql_max;
 455         u8 adapt_enable:1;
 456         u8 ql_enable:1;
 457         u8 unit_1us:1;
 458         enum hns3_flow_level_range flow_level;
 459 };
 460
 461 struct hns3_enet_ring_group {
 462         /* array of pointers to rings */
 463         struct hns3_enet_ring *ring;
 464         u64 total_bytes;        /* total bytes processed this group */
 465         u64 total_packets;      /* total packets processed this group */
 466         u16 count;
 467         struct hns3_enet_coalesce coal;
 468 };
 469
 470 struct hns3_enet_tqp_vector {
 471         struct hnae3_handle *handle;
 472         u8 __iomem *mask_addr;
 473         int vector_irq;
 474         int irq_init_flag;
 475
 476         u16 idx;                /* index in the TQP vector array per handle. */
 477
 478         struct napi_struct napi;
 479
 480         struct hns3_enet_ring_group rx_group;
 481         struct hns3_enet_ring_group tx_group;
 482
 483         cpumask_t affinity_mask;
 484         u16 num_tqps;   /* total number of tqps in TQP vector */
 485         struct irq_affinity_notify affinity_notify;
 486
 487         char name[HNAE3_INT_NAME_LEN];
 488
 489         unsigned long last_jiffies;
 490 } ____cacheline_internodealigned_in_smp;
 491
 492 struct hns3_nic_priv {
 493         struct hnae3_handle *ae_handle;
 494         struct net_device *netdev;
 495         struct device *dev;
 496
 497         /**
 498          * the cb for nic to manage the ring buffer, the first half of the
 499          * array is for tx_ring and vice versa for the second half
 500          */
 501         struct hns3_enet_ring *ring;
 502         struct hns3_enet_tqp_vector *tqp_vector;
 503         u16 vector_num;
 504         u8 max_non_tso_bd_num;
 505
 506         u64 tx_timeout_count;
 507
 508         unsigned long state;
 509
 510         struct hns3_enet_coalesce tx_coal;
 511         struct hns3_enet_coalesce rx_coal;
 512 };
 513
 514 union l3_hdr_info {
 515         struct iphdr *v4;
 516         struct ipv6hdr *v6;
 517         unsigned char *hdr;
 518 };
 519
 520 union l4_hdr_info {
 521         struct tcphdr *tcp;
 522         struct udphdr *udp;
 523         struct gre_base_hdr *gre;
 524         unsigned char *hdr;
 525 };
 526
 527 struct hns3_hw_error_info {
 528         enum hnae3_hw_error_type type;
 529         const char *msg;
 530 };
 531
 532 static inline int ring_space(struct hns3_enet_ring *ring)
 533 {
 534         /* This smp_load_acquire() pairs with smp_store_release() in
 535          * hns3_nic_reclaim_one_desc called by hns3_clean_tx_ring.
 536          */
 537         int begin = smp_load_acquire(&ring->next_to_clean);
 538         int end = READ_ONCE(ring->next_to_use);
 539
 540         return ((end >= begin) ? (ring->desc_num - end + begin) :
 541                         (begin - end)) - 1;
 542 }
 543
 544 static inline u32 hns3_read_reg(void __iomem *base, u32 reg)
 545 {
 546         return readl(base + reg);
 547 }
 548
 549 static inline void hns3_write_reg(void __iomem *base, u32 reg, u32 value)
 550 {
 551         u8 __iomem *reg_addr = READ_ONCE(base);
 552
 553         writel(value, reg_addr + reg);
 554 }
 555
 556 #define hns3_read_dev(a, reg) \
 557         hns3_read_reg((a)->io_base, reg)
 558
 559 static inline bool hns3_nic_resetting(struct net_device *netdev)
 560 {
 561         struct hns3_nic_priv *priv = netdev_priv(netdev);
 562
 563         return test_bit(HNS3_NIC_STATE_RESETTING, &priv->state);
 564 }
 565
 566 #define hns3_write_dev(a, reg, value) \
 567         hns3_write_reg((a)->io_base, reg, value)
 568
 569 #define ring_to_dev(ring) ((ring)->dev)
 570
 571 #define ring_to_netdev(ring)    ((ring)->tqp_vector->napi.dev)
 572
 573 #define ring_to_dma_dir(ring) (HNAE3_IS_TX_RING(ring) ? \
 574         DMA_TO_DEVICE : DMA_FROM_DEVICE)
 575
 576 #define hns3_buf_size(_ring) ((_ring)->buf_size)
 577
 578 static inline unsigned int hns3_page_order(struct hns3_enet_ring *ring)
 579 {
 580 #if (PAGE_SIZE < 8192)
 581         if (ring->buf_size > (PAGE_SIZE / 2))
 582                 return 1;
 583 #endif
 584         return 0;
 585 }
 586
 587 #define hns3_page_size(_ring) (PAGE_SIZE << hns3_page_order(_ring))
 588
 589 /* iterator for handling rings in ring group */
 590 #define hns3_for_each_ring(pos, head) \
 591         for (pos = (head).ring; (pos); pos = (pos)->next)
 592
 593 #define hns3_get_handle(ndev) \
 594         (((struct hns3_nic_priv *)netdev_priv(ndev))->ae_handle)
 595
 596 #define hns3_gl_usec_to_reg(int_gl) ((int_gl) >> 1)
 597 #define hns3_gl_round_down(int_gl) round_down(int_gl, 2)
 598
 599 #define hns3_rl_usec_to_reg(int_rl) ((int_rl) >> 2)
 600 #define hns3_rl_round_down(int_rl) round_down(int_rl, 4)
 601
 602 void hns3_ethtool_set_ops(struct net_device *netdev);
 603 int hns3_set_channels(struct net_device *netdev,
 604                       struct ethtool_channels *ch);
 605
 606 void hns3_clean_tx_ring(struct hns3_enet_ring *ring, int budget);
 607 int hns3_init_all_ring(struct hns3_nic_priv *priv);
 608 int hns3_nic_reset_all_ring(struct hnae3_handle *h);
 609 void hns3_fini_ring(struct hns3_enet_ring *ring);
 610 netdev_tx_t hns3_nic_net_xmit(struct sk_buff *skb, struct net_device *netdev);
 611 bool hns3_is_phys_func(struct pci_dev *pdev);
 612 int hns3_clean_rx_ring(
 613                 struct hns3_enet_ring *ring, int budget,
 614                 void (*rx_fn)(struct hns3_enet_ring *, struct sk_buff *));
 615
 616 void hns3_set_vector_coalesce_rx_gl(struct hns3_enet_tqp_vector *tqp_vector,
 617                                     u32 gl_value);
 618 void hns3_set_vector_coalesce_tx_gl(struct hns3_enet_tqp_vector *tqp_vector,
 619                                     u32 gl_value);
 620 void hns3_set_vector_coalesce_rl(struct hns3_enet_tqp_vector *tqp_vector,
 621                                  u32 rl_value);
 622 void hns3_set_vector_coalesce_rx_ql(struct hns3_enet_tqp_vector *tqp_vector,
 623                                     u32 ql_value);
 624 void hns3_set_vector_coalesce_tx_ql(struct hns3_enet_tqp_vector *tqp_vector,
 625                                     u32 ql_value);
 626
 627 void hns3_enable_vlan_filter(struct net_device *netdev, bool enable);
 628 void hns3_request_update_promisc_mode(struct hnae3_handle *handle);
 629
 630 #ifdef CONFIG_HNS3_DCB
 631 void hns3_dcbnl_setup(struct hnae3_handle *handle);
 632 #else
 633 static inline void hns3_dcbnl_setup(struct hnae3_handle *handle) {}
 634 #endif
 635
 636 void hns3_dbg_init(struct hnae3_handle *handle);
 637 void hns3_dbg_uninit(struct hnae3_handle *handle);
 638 void hns3_dbg_register_debugfs(const char *debugfs_dir_name);
 639 void hns3_dbg_unregister_debugfs(void);
 640 void hns3_shinfo_pack(struct skb_shared_info *shinfo, __u32 *size);
 641 #endif