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