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/module.h>
29 #include <linux/netdevice.h>
30 #include <linux/pci.h>
31 #include <linux/types.h>
32 
33 #define HNAE3_MOD_VERSION "1.0"
34 
35 #define HNAE3_MIN_VECTOR_NUM	2 /* first one for misc, another for IO */
36 
37 /* Device IDs */
38 #define HNAE3_DEV_ID_GE				0xA220
39 #define HNAE3_DEV_ID_25GE			0xA221
40 #define HNAE3_DEV_ID_25GE_RDMA			0xA222
41 #define HNAE3_DEV_ID_25GE_RDMA_MACSEC		0xA223
42 #define HNAE3_DEV_ID_50GE_RDMA			0xA224
43 #define HNAE3_DEV_ID_50GE_RDMA_MACSEC		0xA225
44 #define HNAE3_DEV_ID_100G_RDMA_MACSEC		0xA226
45 #define HNAE3_DEV_ID_100G_VF			0xA22E
46 #define HNAE3_DEV_ID_100G_RDMA_DCB_PFC_VF	0xA22F
47 
48 #define HNAE3_CLASS_NAME_SIZE 16
49 
50 #define HNAE3_DEV_INITED_B			0x0
51 #define HNAE3_DEV_SUPPORT_ROCE_B		0x1
52 #define HNAE3_DEV_SUPPORT_DCB_B			0x2
53 #define HNAE3_KNIC_CLIENT_INITED_B		0x3
54 #define HNAE3_UNIC_CLIENT_INITED_B		0x4
55 #define HNAE3_ROCE_CLIENT_INITED_B		0x5
56 #define HNAE3_DEV_SUPPORT_FD_B			0x6
57 #define HNAE3_DEV_SUPPORT_GRO_B			0x7
58 
59 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\
60 		BIT(HNAE3_DEV_SUPPORT_ROCE_B))
61 
62 #define hnae3_dev_roce_supported(hdev) \
63 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
64 
65 #define hnae3_dev_dcb_supported(hdev) \
66 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
67 
68 #define hnae3_dev_fd_supported(hdev) \
69 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_FD_B)
70 
71 #define hnae3_dev_gro_supported(hdev) \
72 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_GRO_B)
73 
74 #define ring_ptr_move_fw(ring, p) \
75 	((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
76 #define ring_ptr_move_bw(ring, p) \
77 	((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
78 
79 enum hns_desc_type {
80 	DESC_TYPE_SKB,
81 	DESC_TYPE_FRAGLIST_SKB,
82 	DESC_TYPE_PAGE,
83 };
84 
85 struct hnae3_handle;
86 
87 struct hnae3_queue {
88 	void __iomem *io_base;
89 	struct hnae3_ae_algo *ae_algo;
90 	struct hnae3_handle *handle;
91 	int tqp_index;		/* index in a handle */
92 	u32 buf_size;		/* size for hnae_desc->addr, preset by AE */
93 	u16 tx_desc_num;	/* total number of tx desc */
94 	u16 rx_desc_num;	/* total number of rx desc */
95 };
96 
97 struct hns3_mac_stats {
98 	u64 tx_pause_cnt;
99 	u64 rx_pause_cnt;
100 };
101 
102 /* hnae3 loop mode */
103 enum hnae3_loop {
104 	HNAE3_LOOP_APP,
105 	HNAE3_LOOP_SERIAL_SERDES,
106 	HNAE3_LOOP_PARALLEL_SERDES,
107 	HNAE3_LOOP_PHY,
108 	HNAE3_LOOP_NONE,
109 };
110 
111 enum hnae3_client_type {
112 	HNAE3_CLIENT_KNIC,
113 	HNAE3_CLIENT_ROCE,
114 };
115 
116 /* mac media type */
117 enum hnae3_media_type {
118 	HNAE3_MEDIA_TYPE_UNKNOWN,
119 	HNAE3_MEDIA_TYPE_FIBER,
120 	HNAE3_MEDIA_TYPE_COPPER,
121 	HNAE3_MEDIA_TYPE_BACKPLANE,
122 	HNAE3_MEDIA_TYPE_NONE,
123 };
124 
125 /* must be consistent with definition in firmware */
126 enum hnae3_module_type {
127 	HNAE3_MODULE_TYPE_UNKNOWN	= 0x00,
128 	HNAE3_MODULE_TYPE_FIBRE_LR	= 0x01,
129 	HNAE3_MODULE_TYPE_FIBRE_SR	= 0x02,
130 	HNAE3_MODULE_TYPE_AOC		= 0x03,
131 	HNAE3_MODULE_TYPE_CR		= 0x04,
132 	HNAE3_MODULE_TYPE_KR		= 0x05,
133 	HNAE3_MODULE_TYPE_TP		= 0x06,
134 };
135 
136 enum hnae3_fec_mode {
137 	HNAE3_FEC_AUTO = 0,
138 	HNAE3_FEC_BASER,
139 	HNAE3_FEC_RS,
140 	HNAE3_FEC_USER_DEF,
141 };
142 
143 enum hnae3_reset_notify_type {
144 	HNAE3_UP_CLIENT,
145 	HNAE3_DOWN_CLIENT,
146 	HNAE3_INIT_CLIENT,
147 	HNAE3_UNINIT_CLIENT,
148 	HNAE3_RESTORE_CLIENT,
149 };
150 
151 enum hnae3_hw_error_type {
152 	HNAE3_PPU_POISON_ERROR,
153 	HNAE3_CMDQ_ECC_ERROR,
154 	HNAE3_IMP_RD_POISON_ERROR,
155 };
156 
157 enum hnae3_reset_type {
158 	HNAE3_VF_RESET,
159 	HNAE3_VF_FUNC_RESET,
160 	HNAE3_VF_PF_FUNC_RESET,
161 	HNAE3_VF_FULL_RESET,
162 	HNAE3_FLR_RESET,
163 	HNAE3_FUNC_RESET,
164 	HNAE3_GLOBAL_RESET,
165 	HNAE3_IMP_RESET,
166 	HNAE3_UNKNOWN_RESET,
167 	HNAE3_NONE_RESET,
168 	HNAE3_MAX_RESET,
169 };
170 
171 enum hnae3_port_base_vlan_state {
172 	HNAE3_PORT_BASE_VLAN_DISABLE,
173 	HNAE3_PORT_BASE_VLAN_ENABLE,
174 	HNAE3_PORT_BASE_VLAN_MODIFY,
175 	HNAE3_PORT_BASE_VLAN_NOCHANGE,
176 };
177 
178 struct hnae3_vector_info {
179 	u8 __iomem *io_addr;
180 	int vector;
181 };
182 
183 #define HNAE3_RING_TYPE_B 0
184 #define HNAE3_RING_TYPE_TX 0
185 #define HNAE3_RING_TYPE_RX 1
186 #define HNAE3_RING_GL_IDX_S 0
187 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
188 #define HNAE3_RING_GL_RX 0
189 #define HNAE3_RING_GL_TX 1
190 
191 #define HNAE3_FW_VERSION_BYTE3_SHIFT	24
192 #define HNAE3_FW_VERSION_BYTE3_MASK	GENMASK(31, 24)
193 #define HNAE3_FW_VERSION_BYTE2_SHIFT	16
194 #define HNAE3_FW_VERSION_BYTE2_MASK	GENMASK(23, 16)
195 #define HNAE3_FW_VERSION_BYTE1_SHIFT	8
196 #define HNAE3_FW_VERSION_BYTE1_MASK	GENMASK(15, 8)
197 #define HNAE3_FW_VERSION_BYTE0_SHIFT	0
198 #define HNAE3_FW_VERSION_BYTE0_MASK	GENMASK(7, 0)
199 
200 struct hnae3_ring_chain_node {
201 	struct hnae3_ring_chain_node *next;
202 	u32 tqp_index;
203 	u32 flag;
204 	u32 int_gl_idx;
205 };
206 
207 #define HNAE3_IS_TX_RING(node) \
208 	(((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
209 
210 struct hnae3_client_ops {
211 	int (*init_instance)(struct hnae3_handle *handle);
212 	void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
213 	void (*link_status_change)(struct hnae3_handle *handle, bool state);
214 	int (*setup_tc)(struct hnae3_handle *handle, u8 tc);
215 	int (*reset_notify)(struct hnae3_handle *handle,
216 			    enum hnae3_reset_notify_type type);
217 	void (*process_hw_error)(struct hnae3_handle *handle,
218 				 enum hnae3_hw_error_type);
219 };
220 
221 #define HNAE3_CLIENT_NAME_LENGTH 16
222 struct hnae3_client {
223 	char name[HNAE3_CLIENT_NAME_LENGTH];
224 	unsigned long state;
225 	enum hnae3_client_type type;
226 	const struct hnae3_client_ops *ops;
227 	struct list_head node;
228 };
229 
230 struct hnae3_ae_dev {
231 	struct pci_dev *pdev;
232 	const struct hnae3_ae_ops *ops;
233 	struct list_head node;
234 	u32 flag;
235 	unsigned long hw_err_reset_req;
236 	enum hnae3_reset_type reset_type;
237 	void *priv;
238 };
239 
240 /* This struct defines the operation on the handle.
241  *
242  * init_ae_dev(): (mandatory)
243  *   Get PF configure from pci_dev and initialize PF hardware
244  * uninit_ae_dev()
245  *   Disable PF device and release PF resource
246  * register_client
247  *   Register client to ae_dev
248  * unregister_client()
249  *   Unregister client from ae_dev
250  * start()
251  *   Enable the hardware
252  * stop()
253  *   Disable the hardware
254  * start_client()
255  *   Inform the hclge that client has been started
256  * stop_client()
257  *   Inform the hclge that client has been stopped
258  * get_status()
259  *   Get the carrier state of the back channel of the handle, 1 for ok, 0 for
260  *   non-ok
261  * get_ksettings_an_result()
262  *   Get negotiation status,speed and duplex
263  * get_media_type()
264  *   Get media type of MAC
265  * check_port_speed()
266  *   Check target speed whether is supported
267  * adjust_link()
268  *   Adjust link status
269  * set_loopback()
270  *   Set loopback
271  * set_promisc_mode
272  *   Set promisc mode
273  * set_mtu()
274  *   set mtu
275  * get_pauseparam()
276  *   get tx and rx of pause frame use
277  * set_pauseparam()
278  *   set tx and rx of pause frame use
279  * set_autoneg()
280  *   set auto autonegotiation of pause frame use
281  * get_autoneg()
282  *   get auto autonegotiation of pause frame use
283  * restart_autoneg()
284  *   restart autonegotiation
285  * halt_autoneg()
286  *   halt/resume autonegotiation when autonegotiation on
287  * get_coalesce_usecs()
288  *   get usecs to delay a TX interrupt after a packet is sent
289  * get_rx_max_coalesced_frames()
290  *   get Maximum number of packets to be sent before a TX interrupt.
291  * set_coalesce_usecs()
292  *   set usecs to delay a TX interrupt after a packet is sent
293  * set_coalesce_frames()
294  *   set Maximum number of packets to be sent before a TX interrupt.
295  * get_mac_addr()
296  *   get mac address
297  * set_mac_addr()
298  *   set mac address
299  * add_uc_addr
300  *   Add unicast addr to mac table
301  * rm_uc_addr
302  *   Remove unicast addr from mac table
303  * set_mc_addr()
304  *   Set multicast address
305  * add_mc_addr
306  *   Add multicast address to mac table
307  * rm_mc_addr
308  *   Remove multicast address from mac table
309  * update_stats()
310  *   Update Old network device statistics
311  * get_mac_stats()
312  *   get mac pause statistics including tx_cnt and rx_cnt
313  * get_ethtool_stats()
314  *   Get ethtool network device statistics
315  * get_strings()
316  *   Get a set of strings that describe the requested objects
317  * get_sset_count()
318  *   Get number of strings that @get_strings will write
319  * update_led_status()
320  *   Update the led status
321  * set_led_id()
322  *   Set led id
323  * get_regs()
324  *   Get regs dump
325  * get_regs_len()
326  *   Get the len of the regs dump
327  * get_rss_key_size()
328  *   Get rss key size
329  * get_rss_indir_size()
330  *   Get rss indirection table size
331  * get_rss()
332  *   Get rss table
333  * set_rss()
334  *   Set rss table
335  * get_tc_size()
336  *   Get tc size of handle
337  * get_vector()
338  *   Get vector number and vector information
339  * put_vector()
340  *   Put the vector in hdev
341  * map_ring_to_vector()
342  *   Map rings to vector
343  * unmap_ring_from_vector()
344  *   Unmap rings from vector
345  * reset_queue()
346  *   Reset queue
347  * get_fw_version()
348  *   Get firmware version
349  * get_mdix_mode()
350  *   Get media typr of phy
351  * enable_vlan_filter()
352  *   Enable vlan filter
353  * set_vlan_filter()
354  *   Set vlan filter config of Ports
355  * set_vf_vlan_filter()
356  *   Set vlan filter config of vf
357  * restore_vlan_table()
358  *   Restore vlan filter entries after reset
359  * enable_hw_strip_rxvtag()
360  *   Enable/disable hardware strip vlan tag of packets received
361  * set_gro_en
362  *   Enable/disable HW GRO
363  * add_arfs_entry
364  *   Check the 5-tuples of flow, and create flow director rule
365  * get_vf_config
366  *   Get the VF configuration setting by the host
367  * set_vf_link_state
368  *   Set VF link status
369  * set_vf_spoofchk
370  *   Enable/disable spoof check for specified vf
371  * set_vf_trust
372  *   Enable/disable trust for specified vf, if the vf being trusted, then
373  *   it can enable promisc mode
374  * set_vf_rate
375  *   Set the max tx rate of specified vf.
376  * set_vf_mac
377  *   Configure the default MAC for specified VF
378  */
379 struct hnae3_ae_ops {
380 	int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
381 	void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
382 	void (*flr_prepare)(struct hnae3_ae_dev *ae_dev);
383 	void (*flr_done)(struct hnae3_ae_dev *ae_dev);
384 	int (*init_client_instance)(struct hnae3_client *client,
385 				    struct hnae3_ae_dev *ae_dev);
386 	void (*uninit_client_instance)(struct hnae3_client *client,
387 				       struct hnae3_ae_dev *ae_dev);
388 	int (*start)(struct hnae3_handle *handle);
389 	void (*stop)(struct hnae3_handle *handle);
390 	int (*client_start)(struct hnae3_handle *handle);
391 	void (*client_stop)(struct hnae3_handle *handle);
392 	int (*get_status)(struct hnae3_handle *handle);
393 	void (*get_ksettings_an_result)(struct hnae3_handle *handle,
394 					u8 *auto_neg, u32 *speed, u8 *duplex);
395 
396 	int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
397 				   u8 duplex);
398 
399 	void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type,
400 			       u8 *module_type);
401 	int (*check_port_speed)(struct hnae3_handle *handle, u32 speed);
402 	void (*get_fec)(struct hnae3_handle *handle, u8 *fec_ability,
403 			u8 *fec_mode);
404 	int (*set_fec)(struct hnae3_handle *handle, u32 fec_mode);
405 	void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
406 	int (*set_loopback)(struct hnae3_handle *handle,
407 			    enum hnae3_loop loop_mode, bool en);
408 
409 	int (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
410 				bool en_mc_pmc);
411 	int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
412 
413 	void (*get_pauseparam)(struct hnae3_handle *handle,
414 			       u32 *auto_neg, u32 *rx_en, u32 *tx_en);
415 	int (*set_pauseparam)(struct hnae3_handle *handle,
416 			      u32 auto_neg, u32 rx_en, u32 tx_en);
417 
418 	int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
419 	int (*get_autoneg)(struct hnae3_handle *handle);
420 	int (*restart_autoneg)(struct hnae3_handle *handle);
421 	int (*halt_autoneg)(struct hnae3_handle *handle, bool halt);
422 
423 	void (*get_coalesce_usecs)(struct hnae3_handle *handle,
424 				   u32 *tx_usecs, u32 *rx_usecs);
425 	void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
426 					    u32 *tx_frames, u32 *rx_frames);
427 	int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
428 	int (*set_coalesce_frames)(struct hnae3_handle *handle,
429 				   u32 coalesce_frames);
430 	void (*get_coalesce_range)(struct hnae3_handle *handle,
431 				   u32 *tx_frames_low, u32 *rx_frames_low,
432 				   u32 *tx_frames_high, u32 *rx_frames_high,
433 				   u32 *tx_usecs_low, u32 *rx_usecs_low,
434 				   u32 *tx_usecs_high, u32 *rx_usecs_high);
435 
436 	void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
437 	int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
438 			    bool is_first);
439 	int (*do_ioctl)(struct hnae3_handle *handle,
440 			struct ifreq *ifr, int cmd);
441 	int (*add_uc_addr)(struct hnae3_handle *handle,
442 			   const unsigned char *addr);
443 	int (*rm_uc_addr)(struct hnae3_handle *handle,
444 			  const unsigned char *addr);
445 	int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
446 	int (*add_mc_addr)(struct hnae3_handle *handle,
447 			   const unsigned char *addr);
448 	int (*rm_mc_addr)(struct hnae3_handle *handle,
449 			  const unsigned char *addr);
450 	void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
451 	void (*update_stats)(struct hnae3_handle *handle,
452 			     struct net_device_stats *net_stats);
453 	void (*get_stats)(struct hnae3_handle *handle, u64 *data);
454 	void (*get_mac_stats)(struct hnae3_handle *handle,
455 			      struct hns3_mac_stats *mac_stats);
456 	void (*get_strings)(struct hnae3_handle *handle,
457 			    u32 stringset, u8 *data);
458 	int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
459 
460 	void (*get_regs)(struct hnae3_handle *handle, u32 *version,
461 			 void *data);
462 	int (*get_regs_len)(struct hnae3_handle *handle);
463 
464 	u32 (*get_rss_key_size)(struct hnae3_handle *handle);
465 	u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
466 	int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
467 		       u8 *hfunc);
468 	int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
469 		       const u8 *key, const u8 hfunc);
470 	int (*set_rss_tuple)(struct hnae3_handle *handle,
471 			     struct ethtool_rxnfc *cmd);
472 	int (*get_rss_tuple)(struct hnae3_handle *handle,
473 			     struct ethtool_rxnfc *cmd);
474 
475 	int (*get_tc_size)(struct hnae3_handle *handle);
476 
477 	int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
478 			  struct hnae3_vector_info *vector_info);
479 	int (*put_vector)(struct hnae3_handle *handle, int vector_num);
480 	int (*map_ring_to_vector)(struct hnae3_handle *handle,
481 				  int vector_num,
482 				  struct hnae3_ring_chain_node *vr_chain);
483 	int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
484 				      int vector_num,
485 				      struct hnae3_ring_chain_node *vr_chain);
486 
487 	int (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
488 	u32 (*get_fw_version)(struct hnae3_handle *handle);
489 	void (*get_mdix_mode)(struct hnae3_handle *handle,
490 			      u8 *tp_mdix_ctrl, u8 *tp_mdix);
491 
492 	void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
493 	int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
494 			       u16 vlan_id, bool is_kill);
495 	int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
496 				  u16 vlan, u8 qos, __be16 proto);
497 	int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
498 	void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
499 	enum hnae3_reset_type (*get_reset_level)(struct hnae3_ae_dev *ae_dev,
500 						 unsigned long *addr);
501 	void (*set_default_reset_request)(struct hnae3_ae_dev *ae_dev,
502 					  enum hnae3_reset_type rst_type);
503 	void (*get_channels)(struct hnae3_handle *handle,
504 			     struct ethtool_channels *ch);
505 	void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
506 				      u16 *alloc_tqps, u16 *max_rss_size);
507 	int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num,
508 			    bool rxfh_configured);
509 	void (*get_flowctrl_adv)(struct hnae3_handle *handle,
510 				 u32 *flowctrl_adv);
511 	int (*set_led_id)(struct hnae3_handle *handle,
512 			  enum ethtool_phys_id_state status);
513 	void (*get_link_mode)(struct hnae3_handle *handle,
514 			      unsigned long *supported,
515 			      unsigned long *advertising);
516 	int (*add_fd_entry)(struct hnae3_handle *handle,
517 			    struct ethtool_rxnfc *cmd);
518 	int (*del_fd_entry)(struct hnae3_handle *handle,
519 			    struct ethtool_rxnfc *cmd);
520 	void (*del_all_fd_entries)(struct hnae3_handle *handle,
521 				   bool clear_list);
522 	int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
523 			       struct ethtool_rxnfc *cmd);
524 	int (*get_fd_rule_info)(struct hnae3_handle *handle,
525 				struct ethtool_rxnfc *cmd);
526 	int (*get_fd_all_rules)(struct hnae3_handle *handle,
527 				struct ethtool_rxnfc *cmd, u32 *rule_locs);
528 	int (*restore_fd_rules)(struct hnae3_handle *handle);
529 	void (*enable_fd)(struct hnae3_handle *handle, bool enable);
530 	int (*add_arfs_entry)(struct hnae3_handle *handle, u16 queue_id,
531 			      u16 flow_id, struct flow_keys *fkeys);
532 	int (*dbg_run_cmd)(struct hnae3_handle *handle, const char *cmd_buf);
533 	pci_ers_result_t (*handle_hw_ras_error)(struct hnae3_ae_dev *ae_dev);
534 	bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
535 	bool (*ae_dev_resetting)(struct hnae3_handle *handle);
536 	unsigned long (*ae_dev_reset_cnt)(struct hnae3_handle *handle);
537 	int (*set_gro_en)(struct hnae3_handle *handle, bool enable);
538 	u16 (*get_global_queue_id)(struct hnae3_handle *handle, u16 queue_id);
539 	void (*set_timer_task)(struct hnae3_handle *handle, bool enable);
540 	int (*mac_connect_phy)(struct hnae3_handle *handle);
541 	void (*mac_disconnect_phy)(struct hnae3_handle *handle);
542 	void (*restore_vlan_table)(struct hnae3_handle *handle);
543 	int (*get_vf_config)(struct hnae3_handle *handle, int vf,
544 			     struct ifla_vf_info *ivf);
545 	int (*set_vf_link_state)(struct hnae3_handle *handle, int vf,
546 				 int link_state);
547 	int (*set_vf_spoofchk)(struct hnae3_handle *handle, int vf,
548 			       bool enable);
549 	int (*set_vf_trust)(struct hnae3_handle *handle, int vf, bool enable);
550 	int (*set_vf_rate)(struct hnae3_handle *handle, int vf,
551 			   int min_tx_rate, int max_tx_rate, bool force);
552 	int (*set_vf_mac)(struct hnae3_handle *handle, int vf, u8 *p);
553 };
554 
555 struct hnae3_dcb_ops {
556 	/* IEEE 802.1Qaz std */
557 	int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
558 	int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
559 	int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
560 	int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
561 
562 	/* DCBX configuration */
563 	u8   (*getdcbx)(struct hnae3_handle *);
564 	u8   (*setdcbx)(struct hnae3_handle *, u8);
565 
566 	int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
567 };
568 
569 struct hnae3_ae_algo {
570 	const struct hnae3_ae_ops *ops;
571 	struct list_head node;
572 	const struct pci_device_id *pdev_id_table;
573 };
574 
575 #define HNAE3_INT_NAME_LEN        32
576 #define HNAE3_ITR_COUNTDOWN_START 100
577 
578 struct hnae3_tc_info {
579 	u16	tqp_offset;	/* TQP offset from base TQP */
580 	u16	tqp_count;	/* Total TQPs */
581 	u8	tc;		/* TC index */
582 	bool	enable;		/* If this TC is enable or not */
583 };
584 
585 #define HNAE3_MAX_TC		8
586 #define HNAE3_MAX_USER_PRIO	8
587 struct hnae3_knic_private_info {
588 	struct net_device *netdev; /* Set by KNIC client when init instance */
589 	u16 rss_size;		   /* Allocated RSS queues */
590 	u16 req_rss_size;
591 	u16 rx_buf_len;
592 	u16 num_tx_desc;
593 	u16 num_rx_desc;
594 
595 	u8 num_tc;		   /* Total number of enabled TCs */
596 	u8 prio_tc[HNAE3_MAX_USER_PRIO];  /* TC indexed by prio */
597 	struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
598 
599 	u16 num_tqps;		  /* total number of TQPs in this handle */
600 	struct hnae3_queue **tqp;  /* array base of all TQPs in this instance */
601 	const struct hnae3_dcb_ops *dcb_ops;
602 
603 	u16 int_rl_setting;
604 	enum pkt_hash_types rss_type;
605 };
606 
607 struct hnae3_roce_private_info {
608 	struct net_device *netdev;
609 	void __iomem *roce_io_base;
610 	int base_vector;
611 	int num_vectors;
612 
613 	/* The below attributes defined for RoCE client, hnae3 gives
614 	 * initial values to them, and RoCE client can modify and use
615 	 * them.
616 	 */
617 	unsigned long reset_state;
618 	unsigned long instance_state;
619 	unsigned long state;
620 };
621 
622 struct hnae3_unic_private_info {
623 	struct net_device *netdev;
624 	u16 rx_buf_len;
625 	u16 num_tx_desc;
626 	u16 num_rx_desc;
627 
628 	u16 num_tqps;	/* total number of tqps in this handle */
629 	struct hnae3_queue **tqp;  /* array base of all TQPs of this instance */
630 };
631 
632 #define HNAE3_SUPPORT_APP_LOOPBACK    BIT(0)
633 #define HNAE3_SUPPORT_PHY_LOOPBACK    BIT(1)
634 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK	BIT(2)
635 #define HNAE3_SUPPORT_VF	      BIT(3)
636 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK	BIT(4)
637 
638 #define HNAE3_USER_UPE		BIT(0)	/* unicast promisc enabled by user */
639 #define HNAE3_USER_MPE		BIT(1)	/* mulitcast promisc enabled by user */
640 #define HNAE3_BPE		BIT(2)	/* broadcast promisc enable */
641 #define HNAE3_OVERFLOW_UPE	BIT(3)	/* unicast mac vlan overflow */
642 #define HNAE3_OVERFLOW_MPE	BIT(4)	/* multicast mac vlan overflow */
643 #define HNAE3_VLAN_FLTR		BIT(5)	/* enable vlan filter */
644 #define HNAE3_UPE		(HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
645 #define HNAE3_MPE		(HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)
646 
647 struct hnae3_handle {
648 	struct hnae3_client *client;
649 	struct pci_dev *pdev;
650 	void *priv;
651 	struct hnae3_ae_algo *ae_algo;  /* the class who provides this handle */
652 	u64 flags; /* Indicate the capabilities for this handle */
653 
654 	union {
655 		struct net_device *netdev; /* first member */
656 		struct hnae3_knic_private_info kinfo;
657 		struct hnae3_unic_private_info uinfo;
658 		struct hnae3_roce_private_info rinfo;
659 	};
660 
661 	u32 numa_node_mask;	/* for multi-chip support */
662 
663 	enum hnae3_port_base_vlan_state port_base_vlan_state;
664 
665 	u8 netdev_flags;
666 	struct dentry *hnae3_dbgfs;
667 
668 	/* Network interface message level enabled bits */
669 	u32 msg_enable;
670 };
671 
672 #define hnae3_set_field(origin, mask, shift, val) \
673 	do { \
674 		(origin) &= (~(mask)); \
675 		(origin) |= ((val) << (shift)) & (mask); \
676 	} while (0)
677 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
678 
679 #define hnae3_set_bit(origin, shift, val) \
680 	hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
681 #define hnae3_get_bit(origin, shift) \
682 	hnae3_get_field((origin), (0x1 << (shift)), (shift))
683 
684 int hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
685 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
686 
687 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
688 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
689 
690 void hnae3_unregister_client(struct hnae3_client *client);
691 int hnae3_register_client(struct hnae3_client *client);
692 
693 void hnae3_set_client_init_flag(struct hnae3_client *client,
694 				struct hnae3_ae_dev *ae_dev,
695 				unsigned int inited);
696 #endif
697