1 /* SPDX-License-Identifier: GPL-2.0+ */
2 // Copyright (c) 2016-2017 Hisilicon Limited.
3 
4 #ifndef __HNAE3_H
5 #define __HNAE3_H
6 
7 /* Names used in this framework:
8  *      ae handle (handle):
9  *        a set of queues provided by AE
10  *      ring buffer queue (rbq):
11  *        the channel between upper layer and the AE, can do tx and rx
12  *      ring:
13  *        a tx or rx channel within a rbq
14  *      ring description (desc):
15  *        an element in the ring with packet information
16  *      buffer:
17  *        a memory region referred by desc with the full packet payload
18  *
19  * "num" means a static number set as a parameter, "count" mean a dynamic
20  *   number set while running
21  * "cb" means control block
22  */
23 
24 #include <linux/acpi.h>
25 #include <linux/dcbnl.h>
26 #include <linux/delay.h>
27 #include <linux/device.h>
28 #include <linux/ethtool.h>
29 #include <linux/module.h>
30 #include <linux/netdevice.h>
31 #include <linux/pci.h>
32 #include <linux/pkt_sched.h>
33 #include <linux/types.h>
34 #include <net/pkt_cls.h>
35 
36 #define HNAE3_MOD_VERSION "1.0"
37 
38 #define HNAE3_MIN_VECTOR_NUM	2 /* first one for misc, another for IO */
39 
40 /* Device version */
41 #define HNAE3_DEVICE_VERSION_V1   0x00020
42 #define HNAE3_DEVICE_VERSION_V2   0x00021
43 #define HNAE3_DEVICE_VERSION_V3   0x00030
44 
45 #define HNAE3_PCI_REVISION_BIT_SIZE		8
46 
47 /* Device IDs */
48 #define HNAE3_DEV_ID_GE				0xA220
49 #define HNAE3_DEV_ID_25GE			0xA221
50 #define HNAE3_DEV_ID_25GE_RDMA			0xA222
51 #define HNAE3_DEV_ID_25GE_RDMA_MACSEC		0xA223
52 #define HNAE3_DEV_ID_50GE_RDMA			0xA224
53 #define HNAE3_DEV_ID_50GE_RDMA_MACSEC		0xA225
54 #define HNAE3_DEV_ID_100G_RDMA_MACSEC		0xA226
55 #define HNAE3_DEV_ID_200G_RDMA			0xA228
56 #define HNAE3_DEV_ID_VF				0xA22E
57 #define HNAE3_DEV_ID_RDMA_DCB_PFC_VF		0xA22F
58 
59 #define HNAE3_CLASS_NAME_SIZE 16
60 
61 #define HNAE3_DEV_INITED_B			0x0
62 #define HNAE3_DEV_SUPPORT_ROCE_B		0x1
63 #define HNAE3_DEV_SUPPORT_DCB_B			0x2
64 #define HNAE3_KNIC_CLIENT_INITED_B		0x3
65 #define HNAE3_UNIC_CLIENT_INITED_B		0x4
66 #define HNAE3_ROCE_CLIENT_INITED_B		0x5
67 
68 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) | \
69 		BIT(HNAE3_DEV_SUPPORT_ROCE_B))
70 
71 #define hnae3_dev_roce_supported(hdev) \
72 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
73 
74 #define hnae3_dev_dcb_supported(hdev) \
75 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
76 
77 enum HNAE3_DEV_CAP_BITS {
78 	HNAE3_DEV_SUPPORT_FD_B,
79 	HNAE3_DEV_SUPPORT_GRO_B,
80 	HNAE3_DEV_SUPPORT_FEC_B,
81 	HNAE3_DEV_SUPPORT_UDP_GSO_B,
82 	HNAE3_DEV_SUPPORT_QB_B,
83 	HNAE3_DEV_SUPPORT_FD_FORWARD_TC_B,
84 	HNAE3_DEV_SUPPORT_PTP_B,
85 	HNAE3_DEV_SUPPORT_INT_QL_B,
86 	HNAE3_DEV_SUPPORT_HW_TX_CSUM_B,
87 	HNAE3_DEV_SUPPORT_TX_PUSH_B,
88 	HNAE3_DEV_SUPPORT_PHY_IMP_B,
89 	HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B,
90 	HNAE3_DEV_SUPPORT_HW_PAD_B,
91 	HNAE3_DEV_SUPPORT_STASH_B,
92 	HNAE3_DEV_SUPPORT_UDP_TUNNEL_CSUM_B,
93 	HNAE3_DEV_SUPPORT_PAUSE_B,
94 	HNAE3_DEV_SUPPORT_RAS_IMP_B,
95 	HNAE3_DEV_SUPPORT_RXD_ADV_LAYOUT_B,
96 	HNAE3_DEV_SUPPORT_PORT_VLAN_BYPASS_B,
97 	HNAE3_DEV_SUPPORT_VLAN_FLTR_MDF_B,
98 	HNAE3_DEV_SUPPORT_MC_MAC_MNG_B,
99 	HNAE3_DEV_SUPPORT_CQ_B,
100 	HNAE3_DEV_SUPPORT_FEC_STATS_B,
101 	HNAE3_DEV_SUPPORT_LANE_NUM_B,
102 };
103 
104 #define hnae3_ae_dev_fd_supported(ae_dev) \
105 		test_bit(HNAE3_DEV_SUPPORT_FD_B, (ae_dev)->caps)
106 
107 #define hnae3_ae_dev_gro_supported(ae_dev) \
108 		test_bit(HNAE3_DEV_SUPPORT_GRO_B, (ae_dev)->caps)
109 
110 #define hnae3_dev_fec_supported(hdev) \
111 	test_bit(HNAE3_DEV_SUPPORT_FEC_B, (hdev)->ae_dev->caps)
112 
113 #define hnae3_dev_udp_gso_supported(hdev) \
114 	test_bit(HNAE3_DEV_SUPPORT_UDP_GSO_B, (hdev)->ae_dev->caps)
115 
116 #define hnae3_dev_qb_supported(hdev) \
117 	test_bit(HNAE3_DEV_SUPPORT_QB_B, (hdev)->ae_dev->caps)
118 
119 #define hnae3_dev_fd_forward_tc_supported(hdev) \
120 	test_bit(HNAE3_DEV_SUPPORT_FD_FORWARD_TC_B, (hdev)->ae_dev->caps)
121 
122 #define hnae3_dev_ptp_supported(hdev) \
123 	test_bit(HNAE3_DEV_SUPPORT_PTP_B, (hdev)->ae_dev->caps)
124 
125 #define hnae3_dev_int_ql_supported(hdev) \
126 	test_bit(HNAE3_DEV_SUPPORT_INT_QL_B, (hdev)->ae_dev->caps)
127 
128 #define hnae3_dev_hw_csum_supported(hdev) \
129 	test_bit(HNAE3_DEV_SUPPORT_HW_TX_CSUM_B, (hdev)->ae_dev->caps)
130 
131 #define hnae3_dev_tx_push_supported(hdev) \
132 	test_bit(HNAE3_DEV_SUPPORT_TX_PUSH_B, (hdev)->ae_dev->caps)
133 
134 #define hnae3_dev_phy_imp_supported(hdev) \
135 	test_bit(HNAE3_DEV_SUPPORT_PHY_IMP_B, (hdev)->ae_dev->caps)
136 
137 #define hnae3_dev_ras_imp_supported(hdev) \
138 	test_bit(HNAE3_DEV_SUPPORT_RAS_IMP_B, (hdev)->ae_dev->caps)
139 
140 #define hnae3_dev_tqp_txrx_indep_supported(hdev) \
141 	test_bit(HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B, (hdev)->ae_dev->caps)
142 
143 #define hnae3_dev_hw_pad_supported(hdev) \
144 	test_bit(HNAE3_DEV_SUPPORT_HW_PAD_B, (hdev)->ae_dev->caps)
145 
146 #define hnae3_dev_stash_supported(hdev) \
147 	test_bit(HNAE3_DEV_SUPPORT_STASH_B, (hdev)->ae_dev->caps)
148 
149 #define hnae3_dev_pause_supported(hdev) \
150 	test_bit(HNAE3_DEV_SUPPORT_PAUSE_B, (hdev)->ae_dev->caps)
151 
152 #define hnae3_ae_dev_tqp_txrx_indep_supported(ae_dev) \
153 	test_bit(HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B, (ae_dev)->caps)
154 
155 #define hnae3_ae_dev_rxd_adv_layout_supported(ae_dev) \
156 	test_bit(HNAE3_DEV_SUPPORT_RXD_ADV_LAYOUT_B, (ae_dev)->caps)
157 
158 #define hnae3_ae_dev_mc_mac_mng_supported(ae_dev) \
159 	test_bit(HNAE3_DEV_SUPPORT_MC_MAC_MNG_B, (ae_dev)->caps)
160 
161 #define hnae3_ae_dev_cq_supported(ae_dev) \
162 	test_bit(HNAE3_DEV_SUPPORT_CQ_B, (ae_dev)->caps)
163 
164 #define hnae3_ae_dev_fec_stats_supported(ae_dev) \
165 	test_bit(HNAE3_DEV_SUPPORT_FEC_STATS_B, (ae_dev)->caps)
166 
167 #define hnae3_ae_dev_lane_num_supported(ae_dev) \
168 	test_bit(HNAE3_DEV_SUPPORT_LANE_NUM_B, (ae_dev)->caps)
169 
170 enum HNAE3_PF_CAP_BITS {
171 	HNAE3_PF_SUPPORT_VLAN_FLTR_MDF_B = 0,
172 };
173 #define ring_ptr_move_fw(ring, p) \
174 	((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
175 #define ring_ptr_move_bw(ring, p) \
176 	((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
177 
178 struct hnae3_handle;
179 
180 struct hnae3_queue {
181 	void __iomem *io_base;
182 	void __iomem *mem_base;
183 	struct hnae3_ae_algo *ae_algo;
184 	struct hnae3_handle *handle;
185 	int tqp_index;		/* index in a handle */
186 	u32 buf_size;		/* size for hnae_desc->addr, preset by AE */
187 	u16 tx_desc_num;	/* total number of tx desc */
188 	u16 rx_desc_num;	/* total number of rx desc */
189 };
190 
191 struct hns3_mac_stats {
192 	u64 tx_pause_cnt;
193 	u64 rx_pause_cnt;
194 };
195 
196 /* hnae3 loop mode */
197 enum hnae3_loop {
198 	HNAE3_LOOP_APP,
199 	HNAE3_LOOP_SERIAL_SERDES,
200 	HNAE3_LOOP_PARALLEL_SERDES,
201 	HNAE3_LOOP_PHY,
202 	HNAE3_LOOP_NONE,
203 };
204 
205 enum hnae3_client_type {
206 	HNAE3_CLIENT_KNIC,
207 	HNAE3_CLIENT_ROCE,
208 };
209 
210 /* mac media type */
211 enum hnae3_media_type {
212 	HNAE3_MEDIA_TYPE_UNKNOWN,
213 	HNAE3_MEDIA_TYPE_FIBER,
214 	HNAE3_MEDIA_TYPE_COPPER,
215 	HNAE3_MEDIA_TYPE_BACKPLANE,
216 	HNAE3_MEDIA_TYPE_NONE,
217 };
218 
219 /* must be consistent with definition in firmware */
220 enum hnae3_module_type {
221 	HNAE3_MODULE_TYPE_UNKNOWN	= 0x00,
222 	HNAE3_MODULE_TYPE_FIBRE_LR	= 0x01,
223 	HNAE3_MODULE_TYPE_FIBRE_SR	= 0x02,
224 	HNAE3_MODULE_TYPE_AOC		= 0x03,
225 	HNAE3_MODULE_TYPE_CR		= 0x04,
226 	HNAE3_MODULE_TYPE_KR		= 0x05,
227 	HNAE3_MODULE_TYPE_TP		= 0x06,
228 };
229 
230 enum hnae3_fec_mode {
231 	HNAE3_FEC_AUTO = 0,
232 	HNAE3_FEC_BASER,
233 	HNAE3_FEC_RS,
234 	HNAE3_FEC_LLRS,
235 	HNAE3_FEC_NONE,
236 	HNAE3_FEC_USER_DEF,
237 };
238 
239 enum hnae3_reset_notify_type {
240 	HNAE3_UP_CLIENT,
241 	HNAE3_DOWN_CLIENT,
242 	HNAE3_INIT_CLIENT,
243 	HNAE3_UNINIT_CLIENT,
244 };
245 
246 enum hnae3_hw_error_type {
247 	HNAE3_PPU_POISON_ERROR,
248 	HNAE3_CMDQ_ECC_ERROR,
249 	HNAE3_IMP_RD_POISON_ERROR,
250 	HNAE3_ROCEE_AXI_RESP_ERROR,
251 };
252 
253 enum hnae3_reset_type {
254 	HNAE3_VF_RESET,
255 	HNAE3_VF_FUNC_RESET,
256 	HNAE3_VF_PF_FUNC_RESET,
257 	HNAE3_VF_FULL_RESET,
258 	HNAE3_FLR_RESET,
259 	HNAE3_FUNC_RESET,
260 	HNAE3_GLOBAL_RESET,
261 	HNAE3_IMP_RESET,
262 	HNAE3_NONE_RESET,
263 	HNAE3_MAX_RESET,
264 };
265 
266 enum hnae3_port_base_vlan_state {
267 	HNAE3_PORT_BASE_VLAN_DISABLE,
268 	HNAE3_PORT_BASE_VLAN_ENABLE,
269 	HNAE3_PORT_BASE_VLAN_MODIFY,
270 	HNAE3_PORT_BASE_VLAN_NOCHANGE,
271 };
272 
273 enum hnae3_dbg_cmd {
274 	HNAE3_DBG_CMD_TM_NODES,
275 	HNAE3_DBG_CMD_TM_PRI,
276 	HNAE3_DBG_CMD_TM_QSET,
277 	HNAE3_DBG_CMD_TM_MAP,
278 	HNAE3_DBG_CMD_TM_PG,
279 	HNAE3_DBG_CMD_TM_PORT,
280 	HNAE3_DBG_CMD_TC_SCH_INFO,
281 	HNAE3_DBG_CMD_QOS_PAUSE_CFG,
282 	HNAE3_DBG_CMD_QOS_PRI_MAP,
283 	HNAE3_DBG_CMD_QOS_DSCP_MAP,
284 	HNAE3_DBG_CMD_QOS_BUF_CFG,
285 	HNAE3_DBG_CMD_DEV_INFO,
286 	HNAE3_DBG_CMD_TX_BD,
287 	HNAE3_DBG_CMD_RX_BD,
288 	HNAE3_DBG_CMD_MAC_UC,
289 	HNAE3_DBG_CMD_MAC_MC,
290 	HNAE3_DBG_CMD_MNG_TBL,
291 	HNAE3_DBG_CMD_LOOPBACK,
292 	HNAE3_DBG_CMD_PTP_INFO,
293 	HNAE3_DBG_CMD_INTERRUPT_INFO,
294 	HNAE3_DBG_CMD_RESET_INFO,
295 	HNAE3_DBG_CMD_IMP_INFO,
296 	HNAE3_DBG_CMD_NCL_CONFIG,
297 	HNAE3_DBG_CMD_REG_BIOS_COMMON,
298 	HNAE3_DBG_CMD_REG_SSU,
299 	HNAE3_DBG_CMD_REG_IGU_EGU,
300 	HNAE3_DBG_CMD_REG_RPU,
301 	HNAE3_DBG_CMD_REG_NCSI,
302 	HNAE3_DBG_CMD_REG_RTC,
303 	HNAE3_DBG_CMD_REG_PPP,
304 	HNAE3_DBG_CMD_REG_RCB,
305 	HNAE3_DBG_CMD_REG_TQP,
306 	HNAE3_DBG_CMD_REG_MAC,
307 	HNAE3_DBG_CMD_REG_DCB,
308 	HNAE3_DBG_CMD_VLAN_CONFIG,
309 	HNAE3_DBG_CMD_QUEUE_MAP,
310 	HNAE3_DBG_CMD_RX_QUEUE_INFO,
311 	HNAE3_DBG_CMD_TX_QUEUE_INFO,
312 	HNAE3_DBG_CMD_FD_TCAM,
313 	HNAE3_DBG_CMD_FD_COUNTER,
314 	HNAE3_DBG_CMD_MAC_TNL_STATUS,
315 	HNAE3_DBG_CMD_SERV_INFO,
316 	HNAE3_DBG_CMD_UMV_INFO,
317 	HNAE3_DBG_CMD_PAGE_POOL_INFO,
318 	HNAE3_DBG_CMD_COAL_INFO,
319 	HNAE3_DBG_CMD_UNKNOWN,
320 };
321 
322 enum hnae3_tc_map_mode {
323 	HNAE3_TC_MAP_MODE_PRIO,
324 	HNAE3_TC_MAP_MODE_DSCP,
325 };
326 
327 struct hnae3_vector_info {
328 	u8 __iomem *io_addr;
329 	int vector;
330 };
331 
332 #define HNAE3_RING_TYPE_B 0
333 #define HNAE3_RING_TYPE_TX 0
334 #define HNAE3_RING_TYPE_RX 1
335 #define HNAE3_RING_GL_IDX_S 0
336 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
337 #define HNAE3_RING_GL_RX 0
338 #define HNAE3_RING_GL_TX 1
339 
340 #define HNAE3_FW_VERSION_BYTE3_SHIFT	24
341 #define HNAE3_FW_VERSION_BYTE3_MASK	GENMASK(31, 24)
342 #define HNAE3_FW_VERSION_BYTE2_SHIFT	16
343 #define HNAE3_FW_VERSION_BYTE2_MASK	GENMASK(23, 16)
344 #define HNAE3_FW_VERSION_BYTE1_SHIFT	8
345 #define HNAE3_FW_VERSION_BYTE1_MASK	GENMASK(15, 8)
346 #define HNAE3_FW_VERSION_BYTE0_SHIFT	0
347 #define HNAE3_FW_VERSION_BYTE0_MASK	GENMASK(7, 0)
348 
349 struct hnae3_ring_chain_node {
350 	struct hnae3_ring_chain_node *next;
351 	u32 tqp_index;
352 	u32 flag;
353 	u32 int_gl_idx;
354 };
355 
356 #define HNAE3_IS_TX_RING(node) \
357 	(((node)->flag & 1 << HNAE3_RING_TYPE_B) == HNAE3_RING_TYPE_TX)
358 
359 /* device specification info from firmware */
360 struct hnae3_dev_specs {
361 	u32 mac_entry_num; /* number of mac-vlan table entry */
362 	u32 mng_entry_num; /* number of manager table entry */
363 	u32 max_tm_rate;
364 	u16 rss_ind_tbl_size;
365 	u16 rss_key_size;
366 	u16 int_ql_max; /* max value of interrupt coalesce based on INT_QL */
367 	u16 max_int_gl; /* max value of interrupt coalesce based on INT_GL */
368 	u8 max_non_tso_bd_num; /* max BD number of one non-TSO packet */
369 	u16 max_frm_size;
370 	u16 max_qset_num;
371 	u16 umv_size;
372 	u16 mc_mac_size;
373 	u32 mac_stats_num;
374 };
375 
376 struct hnae3_client_ops {
377 	int (*init_instance)(struct hnae3_handle *handle);
378 	void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
379 	void (*link_status_change)(struct hnae3_handle *handle, bool state);
380 	int (*reset_notify)(struct hnae3_handle *handle,
381 			    enum hnae3_reset_notify_type type);
382 	void (*process_hw_error)(struct hnae3_handle *handle,
383 				 enum hnae3_hw_error_type);
384 };
385 
386 #define HNAE3_CLIENT_NAME_LENGTH 16
387 struct hnae3_client {
388 	char name[HNAE3_CLIENT_NAME_LENGTH];
389 	unsigned long state;
390 	enum hnae3_client_type type;
391 	const struct hnae3_client_ops *ops;
392 	struct list_head node;
393 };
394 
395 #define HNAE3_DEV_CAPS_MAX_NUM	96
396 struct hnae3_ae_dev {
397 	struct pci_dev *pdev;
398 	const struct hnae3_ae_ops *ops;
399 	struct list_head node;
400 	u32 flag;
401 	unsigned long hw_err_reset_req;
402 	struct hnae3_dev_specs dev_specs;
403 	u32 dev_version;
404 	unsigned long caps[BITS_TO_LONGS(HNAE3_DEV_CAPS_MAX_NUM)];
405 	void *priv;
406 };
407 
408 /* This struct defines the operation on the handle.
409  *
410  * init_ae_dev(): (mandatory)
411  *   Get PF configure from pci_dev and initialize PF hardware
412  * uninit_ae_dev()
413  *   Disable PF device and release PF resource
414  * register_client
415  *   Register client to ae_dev
416  * unregister_client()
417  *   Unregister client from ae_dev
418  * start()
419  *   Enable the hardware
420  * stop()
421  *   Disable the hardware
422  * start_client()
423  *   Inform the hclge that client has been started
424  * stop_client()
425  *   Inform the hclge that client has been stopped
426  * get_status()
427  *   Get the carrier state of the back channel of the handle, 1 for ok, 0 for
428  *   non-ok
429  * get_ksettings_an_result()
430  *   Get negotiation status,speed and duplex
431  * get_media_type()
432  *   Get media type of MAC
433  * check_port_speed()
434  *   Check target speed whether is supported
435  * adjust_link()
436  *   Adjust link status
437  * set_loopback()
438  *   Set loopback
439  * set_promisc_mode
440  *   Set promisc mode
441  * request_update_promisc_mode
442  *   request to hclge(vf) to update promisc mode
443  * set_mtu()
444  *   set mtu
445  * get_pauseparam()
446  *   get tx and rx of pause frame use
447  * set_pauseparam()
448  *   set tx and rx of pause frame use
449  * set_autoneg()
450  *   set auto autonegotiation of pause frame use
451  * get_autoneg()
452  *   get auto autonegotiation of pause frame use
453  * restart_autoneg()
454  *   restart autonegotiation
455  * halt_autoneg()
456  *   halt/resume autonegotiation when autonegotiation on
457  * get_coalesce_usecs()
458  *   get usecs to delay a TX interrupt after a packet is sent
459  * get_rx_max_coalesced_frames()
460  *   get Maximum number of packets to be sent before a TX interrupt.
461  * set_coalesce_usecs()
462  *   set usecs to delay a TX interrupt after a packet is sent
463  * set_coalesce_frames()
464  *   set Maximum number of packets to be sent before a TX interrupt.
465  * get_mac_addr()
466  *   get mac address
467  * set_mac_addr()
468  *   set mac address
469  * add_uc_addr
470  *   Add unicast addr to mac table
471  * rm_uc_addr
472  *   Remove unicast addr from mac table
473  * set_mc_addr()
474  *   Set multicast address
475  * add_mc_addr
476  *   Add multicast address to mac table
477  * rm_mc_addr
478  *   Remove multicast address from mac table
479  * update_stats()
480  *   Update Old network device statistics
481  * get_mac_stats()
482  *   get mac pause statistics including tx_cnt and rx_cnt
483  * get_ethtool_stats()
484  *   Get ethtool network device statistics
485  * get_strings()
486  *   Get a set of strings that describe the requested objects
487  * get_sset_count()
488  *   Get number of strings that @get_strings will write
489  * update_led_status()
490  *   Update the led status
491  * set_led_id()
492  *   Set led id
493  * get_regs()
494  *   Get regs dump
495  * get_regs_len()
496  *   Get the len of the regs dump
497  * get_rss_key_size()
498  *   Get rss key size
499  * get_rss()
500  *   Get rss table
501  * set_rss()
502  *   Set rss table
503  * get_tc_size()
504  *   Get tc size of handle
505  * get_vector()
506  *   Get vector number and vector information
507  * put_vector()
508  *   Put the vector in hdev
509  * map_ring_to_vector()
510  *   Map rings to vector
511  * unmap_ring_from_vector()
512  *   Unmap rings from vector
513  * reset_queue()
514  *   Reset queue
515  * get_fw_version()
516  *   Get firmware version
517  * get_mdix_mode()
518  *   Get media typr of phy
519  * enable_vlan_filter()
520  *   Enable vlan filter
521  * set_vlan_filter()
522  *   Set vlan filter config of Ports
523  * set_vf_vlan_filter()
524  *   Set vlan filter config of vf
525  * enable_hw_strip_rxvtag()
526  *   Enable/disable hardware strip vlan tag of packets received
527  * set_gro_en
528  *   Enable/disable HW GRO
529  * add_arfs_entry
530  *   Check the 5-tuples of flow, and create flow director rule
531  * get_vf_config
532  *   Get the VF configuration setting by the host
533  * set_vf_link_state
534  *   Set VF link status
535  * set_vf_spoofchk
536  *   Enable/disable spoof check for specified vf
537  * set_vf_trust
538  *   Enable/disable trust for specified vf, if the vf being trusted, then
539  *   it can enable promisc mode
540  * set_vf_rate
541  *   Set the max tx rate of specified vf.
542  * set_vf_mac
543  *   Configure the default MAC for specified VF
544  * get_module_eeprom
545  *   Get the optical module eeprom info.
546  * add_cls_flower
547  *   Add clsflower rule
548  * del_cls_flower
549  *   Delete clsflower rule
550  * cls_flower_active
551  *   Check if any cls flower rule exist
552  * dbg_read_cmd
553  *   Execute debugfs read command.
554  * set_tx_hwts_info
555  *   Save information for 1588 tx packet
556  * get_rx_hwts
557  *   Get 1588 rx hwstamp
558  * get_ts_info
559  *   Get phc info
560  * clean_vf_config
561  *   Clean residual vf info after disable sriov
562  */
563 struct hnae3_ae_ops {
564 	int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
565 	void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
566 	void (*reset_prepare)(struct hnae3_ae_dev *ae_dev,
567 			      enum hnae3_reset_type rst_type);
568 	void (*reset_done)(struct hnae3_ae_dev *ae_dev);
569 	int (*init_client_instance)(struct hnae3_client *client,
570 				    struct hnae3_ae_dev *ae_dev);
571 	void (*uninit_client_instance)(struct hnae3_client *client,
572 				       struct hnae3_ae_dev *ae_dev);
573 	int (*start)(struct hnae3_handle *handle);
574 	void (*stop)(struct hnae3_handle *handle);
575 	int (*client_start)(struct hnae3_handle *handle);
576 	void (*client_stop)(struct hnae3_handle *handle);
577 	int (*get_status)(struct hnae3_handle *handle);
578 	void (*get_ksettings_an_result)(struct hnae3_handle *handle,
579 					u8 *auto_neg, u32 *speed, u8 *duplex,
580 					u32 *lane_num);
581 
582 	int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
583 				   u8 duplex, u8 lane_num);
584 
585 	void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type,
586 			       u8 *module_type);
587 	int (*check_port_speed)(struct hnae3_handle *handle, u32 speed);
588 	void (*get_fec_stats)(struct hnae3_handle *handle,
589 			      struct ethtool_fec_stats *fec_stats);
590 	void (*get_fec)(struct hnae3_handle *handle, u8 *fec_ability,
591 			u8 *fec_mode);
592 	int (*set_fec)(struct hnae3_handle *handle, u32 fec_mode);
593 	void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
594 	int (*set_loopback)(struct hnae3_handle *handle,
595 			    enum hnae3_loop loop_mode, bool en);
596 
597 	int (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
598 				bool en_mc_pmc);
599 	void (*request_update_promisc_mode)(struct hnae3_handle *handle);
600 	int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
601 
602 	void (*get_pauseparam)(struct hnae3_handle *handle,
603 			       u32 *auto_neg, u32 *rx_en, u32 *tx_en);
604 	int (*set_pauseparam)(struct hnae3_handle *handle,
605 			      u32 auto_neg, u32 rx_en, u32 tx_en);
606 
607 	int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
608 	int (*get_autoneg)(struct hnae3_handle *handle);
609 	int (*restart_autoneg)(struct hnae3_handle *handle);
610 	int (*halt_autoneg)(struct hnae3_handle *handle, bool halt);
611 
612 	void (*get_coalesce_usecs)(struct hnae3_handle *handle,
613 				   u32 *tx_usecs, u32 *rx_usecs);
614 	void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
615 					    u32 *tx_frames, u32 *rx_frames);
616 	int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
617 	int (*set_coalesce_frames)(struct hnae3_handle *handle,
618 				   u32 coalesce_frames);
619 	void (*get_coalesce_range)(struct hnae3_handle *handle,
620 				   u32 *tx_frames_low, u32 *rx_frames_low,
621 				   u32 *tx_frames_high, u32 *rx_frames_high,
622 				   u32 *tx_usecs_low, u32 *rx_usecs_low,
623 				   u32 *tx_usecs_high, u32 *rx_usecs_high);
624 
625 	void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
626 	int (*set_mac_addr)(struct hnae3_handle *handle, const void *p,
627 			    bool is_first);
628 	int (*do_ioctl)(struct hnae3_handle *handle,
629 			struct ifreq *ifr, int cmd);
630 	int (*add_uc_addr)(struct hnae3_handle *handle,
631 			   const unsigned char *addr);
632 	int (*rm_uc_addr)(struct hnae3_handle *handle,
633 			  const unsigned char *addr);
634 	int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
635 	int (*add_mc_addr)(struct hnae3_handle *handle,
636 			   const unsigned char *addr);
637 	int (*rm_mc_addr)(struct hnae3_handle *handle,
638 			  const unsigned char *addr);
639 	void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
640 	void (*update_stats)(struct hnae3_handle *handle,
641 			     struct net_device_stats *net_stats);
642 	void (*get_stats)(struct hnae3_handle *handle, u64 *data);
643 	void (*get_mac_stats)(struct hnae3_handle *handle,
644 			      struct hns3_mac_stats *mac_stats);
645 	void (*get_strings)(struct hnae3_handle *handle,
646 			    u32 stringset, u8 *data);
647 	int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
648 
649 	void (*get_regs)(struct hnae3_handle *handle, u32 *version,
650 			 void *data);
651 	int (*get_regs_len)(struct hnae3_handle *handle);
652 
653 	u32 (*get_rss_key_size)(struct hnae3_handle *handle);
654 	int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
655 		       u8 *hfunc);
656 	int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
657 		       const u8 *key, const u8 hfunc);
658 	int (*set_rss_tuple)(struct hnae3_handle *handle,
659 			     struct ethtool_rxnfc *cmd);
660 	int (*get_rss_tuple)(struct hnae3_handle *handle,
661 			     struct ethtool_rxnfc *cmd);
662 
663 	int (*get_tc_size)(struct hnae3_handle *handle);
664 
665 	int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
666 			  struct hnae3_vector_info *vector_info);
667 	int (*put_vector)(struct hnae3_handle *handle, int vector_num);
668 	int (*map_ring_to_vector)(struct hnae3_handle *handle,
669 				  int vector_num,
670 				  struct hnae3_ring_chain_node *vr_chain);
671 	int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
672 				      int vector_num,
673 				      struct hnae3_ring_chain_node *vr_chain);
674 
675 	int (*reset_queue)(struct hnae3_handle *handle);
676 	u32 (*get_fw_version)(struct hnae3_handle *handle);
677 	void (*get_mdix_mode)(struct hnae3_handle *handle,
678 			      u8 *tp_mdix_ctrl, u8 *tp_mdix);
679 
680 	int (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
681 	int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
682 			       u16 vlan_id, bool is_kill);
683 	int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
684 				  u16 vlan, u8 qos, __be16 proto);
685 	int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
686 	void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
687 	enum hnae3_reset_type (*get_reset_level)(struct hnae3_ae_dev *ae_dev,
688 						 unsigned long *addr);
689 	void (*set_default_reset_request)(struct hnae3_ae_dev *ae_dev,
690 					  enum hnae3_reset_type rst_type);
691 	void (*get_channels)(struct hnae3_handle *handle,
692 			     struct ethtool_channels *ch);
693 	void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
694 				      u16 *alloc_tqps, u16 *max_rss_size);
695 	int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num,
696 			    bool rxfh_configured);
697 	void (*get_flowctrl_adv)(struct hnae3_handle *handle,
698 				 u32 *flowctrl_adv);
699 	int (*set_led_id)(struct hnae3_handle *handle,
700 			  enum ethtool_phys_id_state status);
701 	void (*get_link_mode)(struct hnae3_handle *handle,
702 			      unsigned long *supported,
703 			      unsigned long *advertising);
704 	int (*add_fd_entry)(struct hnae3_handle *handle,
705 			    struct ethtool_rxnfc *cmd);
706 	int (*del_fd_entry)(struct hnae3_handle *handle,
707 			    struct ethtool_rxnfc *cmd);
708 	int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
709 			       struct ethtool_rxnfc *cmd);
710 	int (*get_fd_rule_info)(struct hnae3_handle *handle,
711 				struct ethtool_rxnfc *cmd);
712 	int (*get_fd_all_rules)(struct hnae3_handle *handle,
713 				struct ethtool_rxnfc *cmd, u32 *rule_locs);
714 	void (*enable_fd)(struct hnae3_handle *handle, bool enable);
715 	int (*add_arfs_entry)(struct hnae3_handle *handle, u16 queue_id,
716 			      u16 flow_id, struct flow_keys *fkeys);
717 	int (*dbg_read_cmd)(struct hnae3_handle *handle, enum hnae3_dbg_cmd cmd,
718 			    char *buf, int len);
719 	pci_ers_result_t (*handle_hw_ras_error)(struct hnae3_ae_dev *ae_dev);
720 	bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
721 	bool (*ae_dev_resetting)(struct hnae3_handle *handle);
722 	unsigned long (*ae_dev_reset_cnt)(struct hnae3_handle *handle);
723 	int (*set_gro_en)(struct hnae3_handle *handle, bool enable);
724 	u16 (*get_global_queue_id)(struct hnae3_handle *handle, u16 queue_id);
725 	void (*set_timer_task)(struct hnae3_handle *handle, bool enable);
726 	int (*mac_connect_phy)(struct hnae3_handle *handle);
727 	void (*mac_disconnect_phy)(struct hnae3_handle *handle);
728 	int (*get_vf_config)(struct hnae3_handle *handle, int vf,
729 			     struct ifla_vf_info *ivf);
730 	int (*set_vf_link_state)(struct hnae3_handle *handle, int vf,
731 				 int link_state);
732 	int (*set_vf_spoofchk)(struct hnae3_handle *handle, int vf,
733 			       bool enable);
734 	int (*set_vf_trust)(struct hnae3_handle *handle, int vf, bool enable);
735 	int (*set_vf_rate)(struct hnae3_handle *handle, int vf,
736 			   int min_tx_rate, int max_tx_rate, bool force);
737 	int (*set_vf_mac)(struct hnae3_handle *handle, int vf, u8 *p);
738 	int (*get_module_eeprom)(struct hnae3_handle *handle, u32 offset,
739 				 u32 len, u8 *data);
740 	bool (*get_cmdq_stat)(struct hnae3_handle *handle);
741 	int (*add_cls_flower)(struct hnae3_handle *handle,
742 			      struct flow_cls_offload *cls_flower, int tc);
743 	int (*del_cls_flower)(struct hnae3_handle *handle,
744 			      struct flow_cls_offload *cls_flower);
745 	bool (*cls_flower_active)(struct hnae3_handle *handle);
746 	int (*get_phy_link_ksettings)(struct hnae3_handle *handle,
747 				      struct ethtool_link_ksettings *cmd);
748 	int (*set_phy_link_ksettings)(struct hnae3_handle *handle,
749 				      const struct ethtool_link_ksettings *cmd);
750 	bool (*set_tx_hwts_info)(struct hnae3_handle *handle,
751 				 struct sk_buff *skb);
752 	void (*get_rx_hwts)(struct hnae3_handle *handle, struct sk_buff *skb,
753 			    u32 nsec, u32 sec);
754 	int (*get_ts_info)(struct hnae3_handle *handle,
755 			   struct ethtool_ts_info *info);
756 	int (*get_link_diagnosis_info)(struct hnae3_handle *handle,
757 				       u32 *status_code);
758 	void (*clean_vf_config)(struct hnae3_ae_dev *ae_dev, int num_vfs);
759 	int (*get_dscp_prio)(struct hnae3_handle *handle, u8 dscp,
760 			     u8 *tc_map_mode, u8 *priority);
761 };
762 
763 struct hnae3_dcb_ops {
764 	/* IEEE 802.1Qaz std */
765 	int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
766 	int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
767 	int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
768 	int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
769 	int (*ieee_setapp)(struct hnae3_handle *h, struct dcb_app *app);
770 	int (*ieee_delapp)(struct hnae3_handle *h, struct dcb_app *app);
771 
772 	/* DCBX configuration */
773 	u8   (*getdcbx)(struct hnae3_handle *);
774 	u8   (*setdcbx)(struct hnae3_handle *, u8);
775 
776 	int (*setup_tc)(struct hnae3_handle *handle,
777 			struct tc_mqprio_qopt_offload *mqprio_qopt);
778 };
779 
780 struct hnae3_ae_algo {
781 	const struct hnae3_ae_ops *ops;
782 	struct list_head node;
783 	const struct pci_device_id *pdev_id_table;
784 };
785 
786 #define HNAE3_INT_NAME_LEN        32
787 #define HNAE3_ITR_COUNTDOWN_START 100
788 
789 #define HNAE3_MAX_TC		8
790 #define HNAE3_MAX_USER_PRIO	8
791 struct hnae3_tc_info {
792 	u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
793 	u16 tqp_count[HNAE3_MAX_TC];
794 	u16 tqp_offset[HNAE3_MAX_TC];
795 	u8 max_tc; /* Total number of TCs */
796 	u8 num_tc; /* Total number of enabled TCs */
797 	bool mqprio_active;
798 };
799 
800 struct hnae3_knic_private_info {
801 	struct net_device *netdev; /* Set by KNIC client when init instance */
802 	u16 rss_size;		   /* Allocated RSS queues */
803 	u16 req_rss_size;
804 	u16 rx_buf_len;
805 	u16 num_tx_desc;
806 	u16 num_rx_desc;
807 	u32 tx_spare_buf_size;
808 
809 	struct hnae3_tc_info tc_info;
810 	u8 tc_map_mode;
811 
812 	u16 num_tqps;		  /* total number of TQPs in this handle */
813 	struct hnae3_queue **tqp;  /* array base of all TQPs in this instance */
814 	const struct hnae3_dcb_ops *dcb_ops;
815 
816 	u16 int_rl_setting;
817 	enum pkt_hash_types rss_type;
818 	void __iomem *io_base;
819 };
820 
821 struct hnae3_roce_private_info {
822 	struct net_device *netdev;
823 	void __iomem *roce_io_base;
824 	void __iomem *roce_mem_base;
825 	int base_vector;
826 	int num_vectors;
827 
828 	/* The below attributes defined for RoCE client, hnae3 gives
829 	 * initial values to them, and RoCE client can modify and use
830 	 * them.
831 	 */
832 	unsigned long reset_state;
833 	unsigned long instance_state;
834 	unsigned long state;
835 };
836 
837 #define HNAE3_SUPPORT_APP_LOOPBACK    BIT(0)
838 #define HNAE3_SUPPORT_PHY_LOOPBACK    BIT(1)
839 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK	BIT(2)
840 #define HNAE3_SUPPORT_VF	      BIT(3)
841 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK	BIT(4)
842 
843 #define HNAE3_USER_UPE		BIT(0)	/* unicast promisc enabled by user */
844 #define HNAE3_USER_MPE		BIT(1)	/* mulitcast promisc enabled by user */
845 #define HNAE3_BPE		BIT(2)	/* broadcast promisc enable */
846 #define HNAE3_OVERFLOW_UPE	BIT(3)	/* unicast mac vlan overflow */
847 #define HNAE3_OVERFLOW_MPE	BIT(4)	/* multicast mac vlan overflow */
848 #define HNAE3_UPE		(HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
849 #define HNAE3_MPE		(HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)
850 
851 enum hnae3_pflag {
852 	HNAE3_PFLAG_LIMIT_PROMISC,
853 	HNAE3_PFLAG_MAX
854 };
855 
856 struct hnae3_handle {
857 	struct hnae3_client *client;
858 	struct pci_dev *pdev;
859 	void *priv;
860 	struct hnae3_ae_algo *ae_algo;  /* the class who provides this handle */
861 	u64 flags; /* Indicate the capabilities for this handle */
862 
863 	union {
864 		struct net_device *netdev; /* first member */
865 		struct hnae3_knic_private_info kinfo;
866 		struct hnae3_roce_private_info rinfo;
867 	};
868 
869 	u32 numa_node_mask;	/* for multi-chip support */
870 
871 	enum hnae3_port_base_vlan_state port_base_vlan_state;
872 
873 	u8 netdev_flags;
874 	struct dentry *hnae3_dbgfs;
875 	/* protects concurrent contention between debugfs commands */
876 	struct mutex dbgfs_lock;
877 	char **dbgfs_buf;
878 
879 	/* Network interface message level enabled bits */
880 	u32 msg_enable;
881 
882 	unsigned long supported_pflags;
883 	unsigned long priv_flags;
884 };
885 
886 #define hnae3_set_field(origin, mask, shift, val) \
887 	do { \
888 		(origin) &= (~(mask)); \
889 		(origin) |= ((val) << (shift)) & (mask); \
890 	} while (0)
891 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
892 
893 #define hnae3_set_bit(origin, shift, val) \
894 	hnae3_set_field(origin, 0x1 << (shift), shift, val)
895 #define hnae3_get_bit(origin, shift) \
896 	hnae3_get_field(origin, 0x1 << (shift), shift)
897 
898 #define HNAE3_FORMAT_MAC_ADDR_LEN	18
899 #define HNAE3_FORMAT_MAC_ADDR_OFFSET_0	0
900 #define HNAE3_FORMAT_MAC_ADDR_OFFSET_4	4
901 #define HNAE3_FORMAT_MAC_ADDR_OFFSET_5	5
902 
903 static inline void hnae3_format_mac_addr(char *format_mac_addr,
904 					 const u8 *mac_addr)
905 {
906 	snprintf(format_mac_addr, HNAE3_FORMAT_MAC_ADDR_LEN, "%02x:**:**:**:%02x:%02x",
907 		 mac_addr[HNAE3_FORMAT_MAC_ADDR_OFFSET_0],
908 		 mac_addr[HNAE3_FORMAT_MAC_ADDR_OFFSET_4],
909 		 mac_addr[HNAE3_FORMAT_MAC_ADDR_OFFSET_5]);
910 }
911 
912 int hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
913 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
914 
915 void hnae3_unregister_ae_algo_prepare(struct hnae3_ae_algo *ae_algo);
916 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
917 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
918 
919 void hnae3_unregister_client(struct hnae3_client *client);
920 int hnae3_register_client(struct hnae3_client *client);
921 
922 void hnae3_set_client_init_flag(struct hnae3_client *client,
923 				struct hnae3_ae_dev *ae_dev,
924 				unsigned int inited);
925 #endif
926