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/dim.h>
8 #include <linux/if_vlan.h>
9 
10 #include "hnae3.h"
11 
12 enum hns3_nic_state {
13 	HNS3_NIC_STATE_TESTING,
14 	HNS3_NIC_STATE_RESETTING,
15 	HNS3_NIC_STATE_INITED,
16 	HNS3_NIC_STATE_DOWN,
17 	HNS3_NIC_STATE_DISABLED,
18 	HNS3_NIC_STATE_REMOVING,
19 	HNS3_NIC_STATE_SERVICE_INITED,
20 	HNS3_NIC_STATE_SERVICE_SCHED,
21 	HNS3_NIC_STATE2_RESET_REQUESTED,
22 	HNS3_NIC_STATE_HW_TX_CSUM_ENABLE,
23 	HNS3_NIC_STATE_RXD_ADV_LAYOUT_ENABLE,
24 	HNS3_NIC_STATE_MAX
25 };
26 
27 #define HNS3_RING_RX_RING_BASEADDR_L_REG	0x00000
28 #define HNS3_RING_RX_RING_BASEADDR_H_REG	0x00004
29 #define HNS3_RING_RX_RING_BD_NUM_REG		0x00008
30 #define HNS3_RING_RX_RING_BD_LEN_REG		0x0000C
31 #define HNS3_RING_RX_RING_TAIL_REG		0x00018
32 #define HNS3_RING_RX_RING_HEAD_REG		0x0001C
33 #define HNS3_RING_RX_RING_FBDNUM_REG		0x00020
34 #define HNS3_RING_RX_RING_PKTNUM_RECORD_REG	0x0002C
35 
36 #define HNS3_RING_TX_RING_BASEADDR_L_REG	0x00040
37 #define HNS3_RING_TX_RING_BASEADDR_H_REG	0x00044
38 #define HNS3_RING_TX_RING_BD_NUM_REG		0x00048
39 #define HNS3_RING_TX_RING_TC_REG		0x00050
40 #define HNS3_RING_TX_RING_TAIL_REG		0x00058
41 #define HNS3_RING_TX_RING_HEAD_REG		0x0005C
42 #define HNS3_RING_TX_RING_FBDNUM_REG		0x00060
43 #define HNS3_RING_TX_RING_OFFSET_REG		0x00064
44 #define HNS3_RING_TX_RING_EBDNUM_REG		0x00068
45 #define HNS3_RING_TX_RING_PKTNUM_RECORD_REG	0x0006C
46 #define HNS3_RING_TX_RING_EBD_OFFSET_REG	0x00070
47 #define HNS3_RING_TX_RING_BD_ERR_REG		0x00074
48 #define HNS3_RING_EN_REG			0x00090
49 #define HNS3_RING_RX_EN_REG			0x00098
50 #define HNS3_RING_TX_EN_REG			0x000D4
51 
52 #define HNS3_RX_HEAD_SIZE			256
53 
54 #define HNS3_TX_TIMEOUT (5 * HZ)
55 #define HNS3_RING_NAME_LEN			16
56 #define HNS3_BUFFER_SIZE_2048			2048
57 #define HNS3_RING_MAX_PENDING			32760
58 #define HNS3_RING_MIN_PENDING			72
59 #define HNS3_RING_BD_MULTIPLE			8
60 /* max frame size of mac */
61 #define HNS3_MAX_MTU(max_frm_size) \
62 	((max_frm_size) - (ETH_HLEN + ETH_FCS_LEN + 2 * VLAN_HLEN))
63 
64 #define HNS3_BD_SIZE_512_TYPE			0
65 #define HNS3_BD_SIZE_1024_TYPE			1
66 #define HNS3_BD_SIZE_2048_TYPE			2
67 #define HNS3_BD_SIZE_4096_TYPE			3
68 
69 #define HNS3_RX_FLAG_VLAN_PRESENT		0x1
70 #define HNS3_RX_FLAG_L3ID_IPV4			0x0
71 #define HNS3_RX_FLAG_L3ID_IPV6			0x1
72 #define HNS3_RX_FLAG_L4ID_UDP			0x0
73 #define HNS3_RX_FLAG_L4ID_TCP			0x1
74 
75 #define HNS3_RXD_DMAC_S				0
76 #define HNS3_RXD_DMAC_M				(0x3 << HNS3_RXD_DMAC_S)
77 #define HNS3_RXD_VLAN_S				2
78 #define HNS3_RXD_VLAN_M				(0x3 << HNS3_RXD_VLAN_S)
79 #define HNS3_RXD_L3ID_S				4
80 #define HNS3_RXD_L3ID_M				(0xf << HNS3_RXD_L3ID_S)
81 #define HNS3_RXD_L4ID_S				8
82 #define HNS3_RXD_L4ID_M				(0xf << HNS3_RXD_L4ID_S)
83 #define HNS3_RXD_FRAG_B				12
84 #define HNS3_RXD_STRP_TAGP_S			13
85 #define HNS3_RXD_STRP_TAGP_M			(0x3 << HNS3_RXD_STRP_TAGP_S)
86 
87 #define HNS3_RXD_L2E_B				16
88 #define HNS3_RXD_L3E_B				17
89 #define HNS3_RXD_L4E_B				18
90 #define HNS3_RXD_TRUNCAT_B			19
91 #define HNS3_RXD_HOI_B				20
92 #define HNS3_RXD_DOI_B				21
93 #define HNS3_RXD_OL3E_B				22
94 #define HNS3_RXD_OL4E_B				23
95 #define HNS3_RXD_GRO_COUNT_S			24
96 #define HNS3_RXD_GRO_COUNT_M			(0x3f << HNS3_RXD_GRO_COUNT_S)
97 #define HNS3_RXD_GRO_FIXID_B			30
98 #define HNS3_RXD_GRO_ECN_B			31
99 
100 #define HNS3_RXD_ODMAC_S			0
101 #define HNS3_RXD_ODMAC_M			(0x3 << HNS3_RXD_ODMAC_S)
102 #define HNS3_RXD_OVLAN_S			2
103 #define HNS3_RXD_OVLAN_M			(0x3 << HNS3_RXD_OVLAN_S)
104 #define HNS3_RXD_OL3ID_S			4
105 #define HNS3_RXD_OL3ID_M			(0xf << HNS3_RXD_OL3ID_S)
106 #define HNS3_RXD_OL4ID_S			8
107 #define HNS3_RXD_OL4ID_M			(0xf << HNS3_RXD_OL4ID_S)
108 #define HNS3_RXD_FBHI_S				12
109 #define HNS3_RXD_FBHI_M				(0x3 << HNS3_RXD_FBHI_S)
110 #define HNS3_RXD_FBLI_S				14
111 #define HNS3_RXD_FBLI_M				(0x3 << HNS3_RXD_FBLI_S)
112 
113 #define HNS3_RXD_PTYPE_S			4
114 #define HNS3_RXD_PTYPE_M			GENMASK(11, 4)
115 
116 #define HNS3_RXD_BDTYPE_S			0
117 #define HNS3_RXD_BDTYPE_M			(0xf << HNS3_RXD_BDTYPE_S)
118 #define HNS3_RXD_VLD_B				4
119 #define HNS3_RXD_UDP0_B				5
120 #define HNS3_RXD_EXTEND_B			7
121 #define HNS3_RXD_FE_B				8
122 #define HNS3_RXD_LUM_B				9
123 #define HNS3_RXD_CRCP_B				10
124 #define HNS3_RXD_L3L4P_B			11
125 #define HNS3_RXD_TSIDX_S			12
126 #define HNS3_RXD_TSIDX_M			(0x3 << HNS3_RXD_TSIDX_S)
127 #define HNS3_RXD_TS_VLD_B			14
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 	union {
242 		__le64 addr;
243 		__le16 csum;
244 		struct {
245 			__le32 ts_nsec;
246 			__le32 ts_sec;
247 		};
248 	};
249 	union {
250 		struct {
251 			__le16 vlan_tag;
252 			__le16 send_size;
253 			union {
254 				__le32 type_cs_vlan_tso_len;
255 				struct {
256 					__u8 type_cs_vlan_tso;
257 					__u8 l2_len;
258 					__u8 l3_len;
259 					__u8 l4_len;
260 				};
261 			};
262 			__le16 outer_vlan_tag;
263 			__le16 tv;
264 
265 		union {
266 			__le32 ol_type_vlan_len_msec;
267 			struct {
268 				__u8 ol_type_vlan_msec;
269 				__u8 ol2_len;
270 				__u8 ol3_len;
271 				__u8 ol4_len;
272 			};
273 		};
274 
275 			__le32 paylen_ol4cs;
276 			__le16 bdtp_fe_sc_vld_ra_ri;
277 			__le16 mss_hw_csum;
278 		} tx;
279 
280 		struct {
281 			__le32 l234_info;
282 			__le16 pkt_len;
283 			__le16 size;
284 
285 			__le32 rss_hash;
286 			__le16 fd_id;
287 			__le16 vlan_tag;
288 
289 			union {
290 				__le32 ol_info;
291 				struct {
292 					__le16 o_dm_vlan_id_fb;
293 					__le16 ot_vlan_tag;
294 				};
295 			};
296 
297 			__le32 bd_base_info;
298 		} rx;
299 	};
300 };
301 
302 struct hns3_desc_cb {
303 	dma_addr_t dma; /* dma address of this desc */
304 	void *buf;      /* cpu addr for a desc */
305 
306 	/* priv data for the desc, e.g. skb when use with ip stack */
307 	void *priv;
308 
309 	union {
310 		u32 page_offset;	/* for rx */
311 		u32 send_bytes;		/* for tx */
312 	};
313 
314 	u32 length;     /* length of the buffer */
315 
316 	u16 reuse_flag;
317 
318 	/* desc type, used by the ring user to mark the type of the priv data */
319 	u16 type;
320 	u16 pagecnt_bias;
321 };
322 
323 enum hns3_pkt_l3type {
324 	HNS3_L3_TYPE_IPV4,
325 	HNS3_L3_TYPE_IPV6,
326 	HNS3_L3_TYPE_ARP,
327 	HNS3_L3_TYPE_RARP,
328 	HNS3_L3_TYPE_IPV4_OPT,
329 	HNS3_L3_TYPE_IPV6_EXT,
330 	HNS3_L3_TYPE_LLDP,
331 	HNS3_L3_TYPE_BPDU,
332 	HNS3_L3_TYPE_MAC_PAUSE,
333 	HNS3_L3_TYPE_PFC_PAUSE,/* 0x9*/
334 
335 	/* reserved for 0xA~0xB */
336 
337 	HNS3_L3_TYPE_CNM = 0xc,
338 
339 	/* reserved for 0xD~0xE */
340 
341 	HNS3_L3_TYPE_PARSE_FAIL	= 0xf /* must be last */
342 };
343 
344 enum hns3_pkt_l4type {
345 	HNS3_L4_TYPE_UDP,
346 	HNS3_L4_TYPE_TCP,
347 	HNS3_L4_TYPE_GRE,
348 	HNS3_L4_TYPE_SCTP,
349 	HNS3_L4_TYPE_IGMP,
350 	HNS3_L4_TYPE_ICMP,
351 
352 	/* reserved for 0x6~0xE */
353 
354 	HNS3_L4_TYPE_PARSE_FAIL	= 0xf /* must be last */
355 };
356 
357 enum hns3_pkt_ol3type {
358 	HNS3_OL3_TYPE_IPV4 = 0,
359 	HNS3_OL3_TYPE_IPV6,
360 	/* reserved for 0x2~0x3 */
361 	HNS3_OL3_TYPE_IPV4_OPT = 4,
362 	HNS3_OL3_TYPE_IPV6_EXT,
363 
364 	/* reserved for 0x6~0xE */
365 
366 	HNS3_OL3_TYPE_PARSE_FAIL = 0xf	/* must be last */
367 };
368 
369 enum hns3_pkt_ol4type {
370 	HNS3_OL4_TYPE_NO_TUN,
371 	HNS3_OL4_TYPE_MAC_IN_UDP,
372 	HNS3_OL4_TYPE_NVGRE,
373 	HNS3_OL4_TYPE_UNKNOWN
374 };
375 
376 struct hns3_rx_ptype {
377 	u32 ptype:8;
378 	u32 csum_level:2;
379 	u32 ip_summed:2;
380 	u32 l3_type:4;
381 	u32 valid:1;
382 };
383 
384 struct ring_stats {
385 	u64 sw_err_cnt;
386 	u64 seg_pkt_cnt;
387 	union {
388 		struct {
389 			u64 tx_pkts;
390 			u64 tx_bytes;
391 			u64 tx_more;
392 			u64 restart_queue;
393 			u64 tx_busy;
394 			u64 tx_copy;
395 			u64 tx_vlan_err;
396 			u64 tx_l4_proto_err;
397 			u64 tx_l2l3l4_err;
398 			u64 tx_tso_err;
399 			u64 over_max_recursion;
400 			u64 hw_limitation;
401 		};
402 		struct {
403 			u64 rx_pkts;
404 			u64 rx_bytes;
405 			u64 rx_err_cnt;
406 			u64 reuse_pg_cnt;
407 			u64 err_pkt_len;
408 			u64 err_bd_num;
409 			u64 l2_err;
410 			u64 l3l4_csum_err;
411 			u64 csum_complete;
412 			u64 rx_multicast;
413 			u64 non_reuse_pg;
414 		};
415 		__le16 csum;
416 	};
417 };
418 
419 struct hns3_enet_ring {
420 	struct hns3_desc *desc; /* dma map address space */
421 	struct hns3_desc_cb *desc_cb;
422 	struct hns3_enet_ring *next;
423 	struct hns3_enet_tqp_vector *tqp_vector;
424 	struct hnae3_queue *tqp;
425 	int queue_index;
426 	struct device *dev; /* will be used for DMA mapping of descriptors */
427 
428 	/* statistic */
429 	struct ring_stats stats;
430 	struct u64_stats_sync syncp;
431 
432 	dma_addr_t desc_dma_addr;
433 	u32 buf_size;       /* size for hnae_desc->addr, preset by AE */
434 	u16 desc_num;       /* total number of desc */
435 	int next_to_use;    /* idx of next spare desc */
436 
437 	/* idx of lastest sent desc, the ring is empty when equal to
438 	 * next_to_use
439 	 */
440 	int next_to_clean;
441 	union {
442 		int last_to_use;	/* last idx used by xmit */
443 		u32 pull_len;		/* memcpy len for current rx packet */
444 	};
445 	u32 frag_num;
446 	void *va; /* first buffer address for current packet */
447 
448 	u32 flag;          /* ring attribute */
449 
450 	int pending_buf;
451 	struct sk_buff *skb;
452 	struct sk_buff *tail_skb;
453 } ____cacheline_internodealigned_in_smp;
454 
455 enum hns3_flow_level_range {
456 	HNS3_FLOW_LOW = 0,
457 	HNS3_FLOW_MID = 1,
458 	HNS3_FLOW_HIGH = 2,
459 	HNS3_FLOW_ULTRA = 3,
460 };
461 
462 #define HNS3_INT_GL_50K			0x0014
463 #define HNS3_INT_GL_20K			0x0032
464 #define HNS3_INT_GL_18K			0x0036
465 #define HNS3_INT_GL_8K			0x007C
466 
467 #define HNS3_INT_GL_1US			BIT(31)
468 
469 #define HNS3_INT_RL_MAX			0x00EC
470 #define HNS3_INT_RL_ENABLE_MASK		0x40
471 
472 #define HNS3_INT_QL_DEFAULT_CFG		0x20
473 
474 struct hns3_enet_coalesce {
475 	u16 int_gl;
476 	u16 int_ql;
477 	u16 int_ql_max;
478 	u8 adapt_enable:1;
479 	u8 ql_enable:1;
480 	u8 unit_1us:1;
481 	enum hns3_flow_level_range flow_level;
482 };
483 
484 struct hns3_enet_ring_group {
485 	/* array of pointers to rings */
486 	struct hns3_enet_ring *ring;
487 	u64 total_bytes;	/* total bytes processed this group */
488 	u64 total_packets;	/* total packets processed this group */
489 	u16 count;
490 	struct hns3_enet_coalesce coal;
491 	struct dim dim;
492 };
493 
494 struct hns3_enet_tqp_vector {
495 	struct hnae3_handle *handle;
496 	u8 __iomem *mask_addr;
497 	int vector_irq;
498 	int irq_init_flag;
499 
500 	u16 idx;		/* index in the TQP vector array per handle. */
501 
502 	struct napi_struct napi;
503 
504 	struct hns3_enet_ring_group rx_group;
505 	struct hns3_enet_ring_group tx_group;
506 
507 	cpumask_t affinity_mask;
508 	u16 num_tqps;	/* total number of tqps in TQP vector */
509 	struct irq_affinity_notify affinity_notify;
510 
511 	char name[HNAE3_INT_NAME_LEN];
512 
513 	u64 event_cnt;
514 } ____cacheline_internodealigned_in_smp;
515 
516 struct hns3_nic_priv {
517 	struct hnae3_handle *ae_handle;
518 	struct net_device *netdev;
519 	struct device *dev;
520 
521 	/**
522 	 * the cb for nic to manage the ring buffer, the first half of the
523 	 * array is for tx_ring and vice versa for the second half
524 	 */
525 	struct hns3_enet_ring *ring;
526 	struct hns3_enet_tqp_vector *tqp_vector;
527 	u16 vector_num;
528 	u8 max_non_tso_bd_num;
529 
530 	u64 tx_timeout_count;
531 
532 	unsigned long state;
533 
534 	struct hns3_enet_coalesce tx_coal;
535 	struct hns3_enet_coalesce rx_coal;
536 };
537 
538 union l3_hdr_info {
539 	struct iphdr *v4;
540 	struct ipv6hdr *v6;
541 	unsigned char *hdr;
542 };
543 
544 union l4_hdr_info {
545 	struct tcphdr *tcp;
546 	struct udphdr *udp;
547 	struct gre_base_hdr *gre;
548 	unsigned char *hdr;
549 };
550 
551 struct hns3_hw_error_info {
552 	enum hnae3_hw_error_type type;
553 	const char *msg;
554 };
555 
556 static inline int ring_space(struct hns3_enet_ring *ring)
557 {
558 	/* This smp_load_acquire() pairs with smp_store_release() in
559 	 * hns3_nic_reclaim_one_desc called by hns3_clean_tx_ring.
560 	 */
561 	int begin = smp_load_acquire(&ring->next_to_clean);
562 	int end = READ_ONCE(ring->next_to_use);
563 
564 	return ((end >= begin) ? (ring->desc_num - end + begin) :
565 			(begin - end)) - 1;
566 }
567 
568 static inline u32 hns3_read_reg(void __iomem *base, u32 reg)
569 {
570 	return readl(base + reg);
571 }
572 
573 static inline void hns3_write_reg(void __iomem *base, u32 reg, u32 value)
574 {
575 	u8 __iomem *reg_addr = READ_ONCE(base);
576 
577 	writel(value, reg_addr + reg);
578 }
579 
580 #define hns3_read_dev(a, reg) \
581 	hns3_read_reg((a)->io_base, reg)
582 
583 static inline bool hns3_nic_resetting(struct net_device *netdev)
584 {
585 	struct hns3_nic_priv *priv = netdev_priv(netdev);
586 
587 	return test_bit(HNS3_NIC_STATE_RESETTING, &priv->state);
588 }
589 
590 #define hns3_write_dev(a, reg, value) \
591 	hns3_write_reg((a)->io_base, reg, value)
592 
593 #define ring_to_dev(ring) ((ring)->dev)
594 
595 #define ring_to_netdev(ring)	((ring)->tqp_vector->napi.dev)
596 
597 #define ring_to_dma_dir(ring) (HNAE3_IS_TX_RING(ring) ? \
598 	DMA_TO_DEVICE : DMA_FROM_DEVICE)
599 
600 #define hns3_buf_size(_ring) ((_ring)->buf_size)
601 
602 static inline unsigned int hns3_page_order(struct hns3_enet_ring *ring)
603 {
604 #if (PAGE_SIZE < 8192)
605 	if (ring->buf_size > (PAGE_SIZE / 2))
606 		return 1;
607 #endif
608 	return 0;
609 }
610 
611 #define hns3_page_size(_ring) (PAGE_SIZE << hns3_page_order(_ring))
612 
613 /* iterator for handling rings in ring group */
614 #define hns3_for_each_ring(pos, head) \
615 	for (pos = (head).ring; (pos); pos = (pos)->next)
616 
617 #define hns3_get_handle(ndev) \
618 	(((struct hns3_nic_priv *)netdev_priv(ndev))->ae_handle)
619 
620 #define hns3_gl_usec_to_reg(int_gl) ((int_gl) >> 1)
621 #define hns3_gl_round_down(int_gl) round_down(int_gl, 2)
622 
623 #define hns3_rl_usec_to_reg(int_rl) ((int_rl) >> 2)
624 #define hns3_rl_round_down(int_rl) round_down(int_rl, 4)
625 
626 void hns3_ethtool_set_ops(struct net_device *netdev);
627 int hns3_set_channels(struct net_device *netdev,
628 		      struct ethtool_channels *ch);
629 
630 void hns3_clean_tx_ring(struct hns3_enet_ring *ring, int budget);
631 int hns3_init_all_ring(struct hns3_nic_priv *priv);
632 int hns3_nic_reset_all_ring(struct hnae3_handle *h);
633 void hns3_fini_ring(struct hns3_enet_ring *ring);
634 netdev_tx_t hns3_nic_net_xmit(struct sk_buff *skb, struct net_device *netdev);
635 bool hns3_is_phys_func(struct pci_dev *pdev);
636 int hns3_clean_rx_ring(
637 		struct hns3_enet_ring *ring, int budget,
638 		void (*rx_fn)(struct hns3_enet_ring *, struct sk_buff *));
639 
640 void hns3_set_vector_coalesce_rx_gl(struct hns3_enet_tqp_vector *tqp_vector,
641 				    u32 gl_value);
642 void hns3_set_vector_coalesce_tx_gl(struct hns3_enet_tqp_vector *tqp_vector,
643 				    u32 gl_value);
644 void hns3_set_vector_coalesce_rl(struct hns3_enet_tqp_vector *tqp_vector,
645 				 u32 rl_value);
646 void hns3_set_vector_coalesce_rx_ql(struct hns3_enet_tqp_vector *tqp_vector,
647 				    u32 ql_value);
648 void hns3_set_vector_coalesce_tx_ql(struct hns3_enet_tqp_vector *tqp_vector,
649 				    u32 ql_value);
650 
651 void hns3_request_update_promisc_mode(struct hnae3_handle *handle);
652 
653 #ifdef CONFIG_HNS3_DCB
654 void hns3_dcbnl_setup(struct hnae3_handle *handle);
655 #else
656 static inline void hns3_dcbnl_setup(struct hnae3_handle *handle) {}
657 #endif
658 
659 int hns3_dbg_init(struct hnae3_handle *handle);
660 void hns3_dbg_uninit(struct hnae3_handle *handle);
661 void hns3_dbg_register_debugfs(const char *debugfs_dir_name);
662 void hns3_dbg_unregister_debugfs(void);
663 void hns3_shinfo_pack(struct skb_shared_info *shinfo, __u32 *size);
664 u16 hns3_get_max_available_channels(struct hnae3_handle *h);
665 #endif
666