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