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