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