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