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