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