xref: /linux/drivers/net/ethernet/hisilicon/hns3/hnae3.h (revision d0f482bb06f9447d44d2cae0386a0bd768c3cc16)
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/ethtool.h>
29 #include <linux/module.h>
30 #include <linux/netdevice.h>
31 #include <linux/pci.h>
32 #include <linux/pkt_sched.h>
33 #include <linux/types.h>
34 #include <net/pkt_cls.h>
35 
36 #define HNAE3_MOD_VERSION "1.0"
37 
38 #define HNAE3_MIN_VECTOR_NUM	2 /* first one for misc, another for IO */
39 
40 /* Device version */
41 #define HNAE3_DEVICE_VERSION_V1   0x00020
42 #define HNAE3_DEVICE_VERSION_V2   0x00021
43 #define HNAE3_DEVICE_VERSION_V3   0x00030
44 
45 #define HNAE3_PCI_REVISION_BIT_SIZE		8
46 
47 /* Device IDs */
48 #define HNAE3_DEV_ID_GE				0xA220
49 #define HNAE3_DEV_ID_25GE			0xA221
50 #define HNAE3_DEV_ID_25GE_RDMA			0xA222
51 #define HNAE3_DEV_ID_25GE_RDMA_MACSEC		0xA223
52 #define HNAE3_DEV_ID_50GE_RDMA			0xA224
53 #define HNAE3_DEV_ID_50GE_RDMA_MACSEC		0xA225
54 #define HNAE3_DEV_ID_100G_RDMA_MACSEC		0xA226
55 #define HNAE3_DEV_ID_200G_RDMA			0xA228
56 #define HNAE3_DEV_ID_VF				0xA22E
57 #define HNAE3_DEV_ID_RDMA_DCB_PFC_VF		0xA22F
58 
59 #define HNAE3_CLASS_NAME_SIZE 16
60 
61 #define HNAE3_DEV_INITED_B			0x0
62 #define HNAE3_DEV_SUPPORT_ROCE_B		0x1
63 #define HNAE3_DEV_SUPPORT_DCB_B			0x2
64 #define HNAE3_KNIC_CLIENT_INITED_B		0x3
65 #define HNAE3_UNIC_CLIENT_INITED_B		0x4
66 #define HNAE3_ROCE_CLIENT_INITED_B		0x5
67 
68 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\
69 		BIT(HNAE3_DEV_SUPPORT_ROCE_B))
70 
71 #define hnae3_dev_roce_supported(hdev) \
72 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
73 
74 #define hnae3_dev_dcb_supported(hdev) \
75 	hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
76 
77 enum HNAE3_DEV_CAP_BITS {
78 	HNAE3_DEV_SUPPORT_FD_B,
79 	HNAE3_DEV_SUPPORT_GRO_B,
80 	HNAE3_DEV_SUPPORT_FEC_B,
81 	HNAE3_DEV_SUPPORT_UDP_GSO_B,
82 	HNAE3_DEV_SUPPORT_QB_B,
83 	HNAE3_DEV_SUPPORT_FD_FORWARD_TC_B,
84 	HNAE3_DEV_SUPPORT_PTP_B,
85 	HNAE3_DEV_SUPPORT_INT_QL_B,
86 	HNAE3_DEV_SUPPORT_HW_TX_CSUM_B,
87 	HNAE3_DEV_SUPPORT_TX_PUSH_B,
88 	HNAE3_DEV_SUPPORT_PHY_IMP_B,
89 	HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B,
90 	HNAE3_DEV_SUPPORT_HW_PAD_B,
91 	HNAE3_DEV_SUPPORT_STASH_B,
92 	HNAE3_DEV_SUPPORT_UDP_TUNNEL_CSUM_B,
93 	HNAE3_DEV_SUPPORT_PAUSE_B,
94 	HNAE3_DEV_SUPPORT_RAS_IMP_B,
95 	HNAE3_DEV_SUPPORT_RXD_ADV_LAYOUT_B,
96 	HNAE3_DEV_SUPPORT_PORT_VLAN_BYPASS_B,
97 	HNAE3_DEV_SUPPORT_VLAN_FLTR_MDF_B,
98 };
99 
100 #define hnae3_dev_fd_supported(hdev) \
101 	test_bit(HNAE3_DEV_SUPPORT_FD_B, (hdev)->ae_dev->caps)
102 
103 #define hnae3_dev_gro_supported(hdev) \
104 	test_bit(HNAE3_DEV_SUPPORT_GRO_B, (hdev)->ae_dev->caps)
105 
106 #define hnae3_dev_fec_supported(hdev) \
107 	test_bit(HNAE3_DEV_SUPPORT_FEC_B, (hdev)->ae_dev->caps)
108 
109 #define hnae3_dev_udp_gso_supported(hdev) \
110 	test_bit(HNAE3_DEV_SUPPORT_UDP_GSO_B, (hdev)->ae_dev->caps)
111 
112 #define hnae3_dev_qb_supported(hdev) \
113 	test_bit(HNAE3_DEV_SUPPORT_QB_B, (hdev)->ae_dev->caps)
114 
115 #define hnae3_dev_fd_forward_tc_supported(hdev) \
116 	test_bit(HNAE3_DEV_SUPPORT_FD_FORWARD_TC_B, (hdev)->ae_dev->caps)
117 
118 #define hnae3_dev_ptp_supported(hdev) \
119 	test_bit(HNAE3_DEV_SUPPORT_PTP_B, (hdev)->ae_dev->caps)
120 
121 #define hnae3_dev_int_ql_supported(hdev) \
122 	test_bit(HNAE3_DEV_SUPPORT_INT_QL_B, (hdev)->ae_dev->caps)
123 
124 #define hnae3_dev_hw_csum_supported(hdev) \
125 	test_bit(HNAE3_DEV_SUPPORT_HW_TX_CSUM_B, (hdev)->ae_dev->caps)
126 
127 #define hnae3_dev_tx_push_supported(hdev) \
128 	test_bit(HNAE3_DEV_SUPPORT_TX_PUSH_B, (hdev)->ae_dev->caps)
129 
130 #define hnae3_dev_phy_imp_supported(hdev) \
131 	test_bit(HNAE3_DEV_SUPPORT_PHY_IMP_B, (hdev)->ae_dev->caps)
132 
133 #define hnae3_dev_ras_imp_supported(hdev) \
134 	test_bit(HNAE3_DEV_SUPPORT_RAS_IMP_B, (hdev)->ae_dev->caps)
135 
136 #define hnae3_dev_tqp_txrx_indep_supported(hdev) \
137 	test_bit(HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B, (hdev)->ae_dev->caps)
138 
139 #define hnae3_dev_hw_pad_supported(hdev) \
140 	test_bit(HNAE3_DEV_SUPPORT_HW_PAD_B, (hdev)->ae_dev->caps)
141 
142 #define hnae3_dev_stash_supported(hdev) \
143 	test_bit(HNAE3_DEV_SUPPORT_STASH_B, (hdev)->ae_dev->caps)
144 
145 #define hnae3_dev_pause_supported(hdev) \
146 	test_bit(HNAE3_DEV_SUPPORT_PAUSE_B, (hdev)->ae_dev->caps)
147 
148 #define hnae3_ae_dev_tqp_txrx_indep_supported(ae_dev) \
149 	test_bit(HNAE3_DEV_SUPPORT_TQP_TXRX_INDEP_B, (ae_dev)->caps)
150 
151 #define hnae3_ae_dev_rxd_adv_layout_supported(ae_dev) \
152 	test_bit(HNAE3_DEV_SUPPORT_RXD_ADV_LAYOUT_B, (ae_dev)->caps)
153 
154 enum HNAE3_PF_CAP_BITS {
155 	HNAE3_PF_SUPPORT_VLAN_FLTR_MDF_B = 0,
156 };
157 #define ring_ptr_move_fw(ring, p) \
158 	((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
159 #define ring_ptr_move_bw(ring, p) \
160 	((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
161 
162 struct hnae3_handle;
163 
164 struct hnae3_queue {
165 	void __iomem *io_base;
166 	struct hnae3_ae_algo *ae_algo;
167 	struct hnae3_handle *handle;
168 	int tqp_index;		/* index in a handle */
169 	u32 buf_size;		/* size for hnae_desc->addr, preset by AE */
170 	u16 tx_desc_num;	/* total number of tx desc */
171 	u16 rx_desc_num;	/* total number of rx desc */
172 };
173 
174 struct hns3_mac_stats {
175 	u64 tx_pause_cnt;
176 	u64 rx_pause_cnt;
177 };
178 
179 /* hnae3 loop mode */
180 enum hnae3_loop {
181 	HNAE3_LOOP_APP,
182 	HNAE3_LOOP_SERIAL_SERDES,
183 	HNAE3_LOOP_PARALLEL_SERDES,
184 	HNAE3_LOOP_PHY,
185 	HNAE3_LOOP_NONE,
186 };
187 
188 enum hnae3_client_type {
189 	HNAE3_CLIENT_KNIC,
190 	HNAE3_CLIENT_ROCE,
191 };
192 
193 /* mac media type */
194 enum hnae3_media_type {
195 	HNAE3_MEDIA_TYPE_UNKNOWN,
196 	HNAE3_MEDIA_TYPE_FIBER,
197 	HNAE3_MEDIA_TYPE_COPPER,
198 	HNAE3_MEDIA_TYPE_BACKPLANE,
199 	HNAE3_MEDIA_TYPE_NONE,
200 };
201 
202 /* must be consistent with definition in firmware */
203 enum hnae3_module_type {
204 	HNAE3_MODULE_TYPE_UNKNOWN	= 0x00,
205 	HNAE3_MODULE_TYPE_FIBRE_LR	= 0x01,
206 	HNAE3_MODULE_TYPE_FIBRE_SR	= 0x02,
207 	HNAE3_MODULE_TYPE_AOC		= 0x03,
208 	HNAE3_MODULE_TYPE_CR		= 0x04,
209 	HNAE3_MODULE_TYPE_KR		= 0x05,
210 	HNAE3_MODULE_TYPE_TP		= 0x06,
211 };
212 
213 enum hnae3_fec_mode {
214 	HNAE3_FEC_AUTO = 0,
215 	HNAE3_FEC_BASER,
216 	HNAE3_FEC_RS,
217 	HNAE3_FEC_USER_DEF,
218 };
219 
220 enum hnae3_reset_notify_type {
221 	HNAE3_UP_CLIENT,
222 	HNAE3_DOWN_CLIENT,
223 	HNAE3_INIT_CLIENT,
224 	HNAE3_UNINIT_CLIENT,
225 };
226 
227 enum hnae3_hw_error_type {
228 	HNAE3_PPU_POISON_ERROR,
229 	HNAE3_CMDQ_ECC_ERROR,
230 	HNAE3_IMP_RD_POISON_ERROR,
231 	HNAE3_ROCEE_AXI_RESP_ERROR,
232 };
233 
234 enum hnae3_reset_type {
235 	HNAE3_VF_RESET,
236 	HNAE3_VF_FUNC_RESET,
237 	HNAE3_VF_PF_FUNC_RESET,
238 	HNAE3_VF_FULL_RESET,
239 	HNAE3_FLR_RESET,
240 	HNAE3_FUNC_RESET,
241 	HNAE3_GLOBAL_RESET,
242 	HNAE3_IMP_RESET,
243 	HNAE3_NONE_RESET,
244 	HNAE3_MAX_RESET,
245 };
246 
247 enum hnae3_port_base_vlan_state {
248 	HNAE3_PORT_BASE_VLAN_DISABLE,
249 	HNAE3_PORT_BASE_VLAN_ENABLE,
250 	HNAE3_PORT_BASE_VLAN_MODIFY,
251 	HNAE3_PORT_BASE_VLAN_NOCHANGE,
252 };
253 
254 enum hnae3_dbg_cmd {
255 	HNAE3_DBG_CMD_TM_NODES,
256 	HNAE3_DBG_CMD_TM_PRI,
257 	HNAE3_DBG_CMD_TM_QSET,
258 	HNAE3_DBG_CMD_TM_MAP,
259 	HNAE3_DBG_CMD_TM_PG,
260 	HNAE3_DBG_CMD_TM_PORT,
261 	HNAE3_DBG_CMD_TC_SCH_INFO,
262 	HNAE3_DBG_CMD_QOS_PAUSE_CFG,
263 	HNAE3_DBG_CMD_QOS_PRI_MAP,
264 	HNAE3_DBG_CMD_QOS_BUF_CFG,
265 	HNAE3_DBG_CMD_DEV_INFO,
266 	HNAE3_DBG_CMD_TX_BD,
267 	HNAE3_DBG_CMD_RX_BD,
268 	HNAE3_DBG_CMD_MAC_UC,
269 	HNAE3_DBG_CMD_MAC_MC,
270 	HNAE3_DBG_CMD_MNG_TBL,
271 	HNAE3_DBG_CMD_LOOPBACK,
272 	HNAE3_DBG_CMD_PTP_INFO,
273 	HNAE3_DBG_CMD_INTERRUPT_INFO,
274 	HNAE3_DBG_CMD_RESET_INFO,
275 	HNAE3_DBG_CMD_IMP_INFO,
276 	HNAE3_DBG_CMD_NCL_CONFIG,
277 	HNAE3_DBG_CMD_REG_BIOS_COMMON,
278 	HNAE3_DBG_CMD_REG_SSU,
279 	HNAE3_DBG_CMD_REG_IGU_EGU,
280 	HNAE3_DBG_CMD_REG_RPU,
281 	HNAE3_DBG_CMD_REG_NCSI,
282 	HNAE3_DBG_CMD_REG_RTC,
283 	HNAE3_DBG_CMD_REG_PPP,
284 	HNAE3_DBG_CMD_REG_RCB,
285 	HNAE3_DBG_CMD_REG_TQP,
286 	HNAE3_DBG_CMD_REG_MAC,
287 	HNAE3_DBG_CMD_REG_DCB,
288 	HNAE3_DBG_CMD_VLAN_CONFIG,
289 	HNAE3_DBG_CMD_QUEUE_MAP,
290 	HNAE3_DBG_CMD_RX_QUEUE_INFO,
291 	HNAE3_DBG_CMD_TX_QUEUE_INFO,
292 	HNAE3_DBG_CMD_FD_TCAM,
293 	HNAE3_DBG_CMD_MAC_TNL_STATUS,
294 	HNAE3_DBG_CMD_SERV_INFO,
295 	HNAE3_DBG_CMD_UNKNOWN,
296 };
297 
298 struct hnae3_vector_info {
299 	u8 __iomem *io_addr;
300 	int vector;
301 };
302 
303 #define HNAE3_RING_TYPE_B 0
304 #define HNAE3_RING_TYPE_TX 0
305 #define HNAE3_RING_TYPE_RX 1
306 #define HNAE3_RING_GL_IDX_S 0
307 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
308 #define HNAE3_RING_GL_RX 0
309 #define HNAE3_RING_GL_TX 1
310 
311 #define HNAE3_FW_VERSION_BYTE3_SHIFT	24
312 #define HNAE3_FW_VERSION_BYTE3_MASK	GENMASK(31, 24)
313 #define HNAE3_FW_VERSION_BYTE2_SHIFT	16
314 #define HNAE3_FW_VERSION_BYTE2_MASK	GENMASK(23, 16)
315 #define HNAE3_FW_VERSION_BYTE1_SHIFT	8
316 #define HNAE3_FW_VERSION_BYTE1_MASK	GENMASK(15, 8)
317 #define HNAE3_FW_VERSION_BYTE0_SHIFT	0
318 #define HNAE3_FW_VERSION_BYTE0_MASK	GENMASK(7, 0)
319 
320 struct hnae3_ring_chain_node {
321 	struct hnae3_ring_chain_node *next;
322 	u32 tqp_index;
323 	u32 flag;
324 	u32 int_gl_idx;
325 };
326 
327 #define HNAE3_IS_TX_RING(node) \
328 	(((node)->flag & 1 << HNAE3_RING_TYPE_B) == HNAE3_RING_TYPE_TX)
329 
330 /* device specification info from firmware */
331 struct hnae3_dev_specs {
332 	u32 mac_entry_num; /* number of mac-vlan table entry */
333 	u32 mng_entry_num; /* number of manager table entry */
334 	u32 max_tm_rate;
335 	u16 rss_ind_tbl_size;
336 	u16 rss_key_size;
337 	u16 int_ql_max; /* max value of interrupt coalesce based on INT_QL */
338 	u16 max_int_gl; /* max value of interrupt coalesce based on INT_GL */
339 	u8 max_non_tso_bd_num; /* max BD number of one non-TSO packet */
340 	u16 max_frm_size;
341 	u16 max_qset_num;
342 };
343 
344 struct hnae3_client_ops {
345 	int (*init_instance)(struct hnae3_handle *handle);
346 	void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
347 	void (*link_status_change)(struct hnae3_handle *handle, bool state);
348 	int (*reset_notify)(struct hnae3_handle *handle,
349 			    enum hnae3_reset_notify_type type);
350 	void (*process_hw_error)(struct hnae3_handle *handle,
351 				 enum hnae3_hw_error_type);
352 };
353 
354 #define HNAE3_CLIENT_NAME_LENGTH 16
355 struct hnae3_client {
356 	char name[HNAE3_CLIENT_NAME_LENGTH];
357 	unsigned long state;
358 	enum hnae3_client_type type;
359 	const struct hnae3_client_ops *ops;
360 	struct list_head node;
361 };
362 
363 #define HNAE3_DEV_CAPS_MAX_NUM	96
364 struct hnae3_ae_dev {
365 	struct pci_dev *pdev;
366 	const struct hnae3_ae_ops *ops;
367 	struct list_head node;
368 	u32 flag;
369 	unsigned long hw_err_reset_req;
370 	struct hnae3_dev_specs dev_specs;
371 	u32 dev_version;
372 	unsigned long caps[BITS_TO_LONGS(HNAE3_DEV_CAPS_MAX_NUM)];
373 	void *priv;
374 };
375 
376 /* This struct defines the operation on the handle.
377  *
378  * init_ae_dev(): (mandatory)
379  *   Get PF configure from pci_dev and initialize PF hardware
380  * uninit_ae_dev()
381  *   Disable PF device and release PF resource
382  * register_client
383  *   Register client to ae_dev
384  * unregister_client()
385  *   Unregister client from ae_dev
386  * start()
387  *   Enable the hardware
388  * stop()
389  *   Disable the hardware
390  * start_client()
391  *   Inform the hclge that client has been started
392  * stop_client()
393  *   Inform the hclge that client has been stopped
394  * get_status()
395  *   Get the carrier state of the back channel of the handle, 1 for ok, 0 for
396  *   non-ok
397  * get_ksettings_an_result()
398  *   Get negotiation status,speed and duplex
399  * get_media_type()
400  *   Get media type of MAC
401  * check_port_speed()
402  *   Check target speed whether is supported
403  * adjust_link()
404  *   Adjust link status
405  * set_loopback()
406  *   Set loopback
407  * set_promisc_mode
408  *   Set promisc mode
409  * request_update_promisc_mode
410  *   request to hclge(vf) to update promisc mode
411  * set_mtu()
412  *   set mtu
413  * get_pauseparam()
414  *   get tx and rx of pause frame use
415  * set_pauseparam()
416  *   set tx and rx of pause frame use
417  * set_autoneg()
418  *   set auto autonegotiation of pause frame use
419  * get_autoneg()
420  *   get auto autonegotiation of pause frame use
421  * restart_autoneg()
422  *   restart autonegotiation
423  * halt_autoneg()
424  *   halt/resume autonegotiation when autonegotiation on
425  * get_coalesce_usecs()
426  *   get usecs to delay a TX interrupt after a packet is sent
427  * get_rx_max_coalesced_frames()
428  *   get Maximum number of packets to be sent before a TX interrupt.
429  * set_coalesce_usecs()
430  *   set usecs to delay a TX interrupt after a packet is sent
431  * set_coalesce_frames()
432  *   set Maximum number of packets to be sent before a TX interrupt.
433  * get_mac_addr()
434  *   get mac address
435  * set_mac_addr()
436  *   set mac address
437  * add_uc_addr
438  *   Add unicast addr to mac table
439  * rm_uc_addr
440  *   Remove unicast addr from mac table
441  * set_mc_addr()
442  *   Set multicast address
443  * add_mc_addr
444  *   Add multicast address to mac table
445  * rm_mc_addr
446  *   Remove multicast address from mac table
447  * update_stats()
448  *   Update Old network device statistics
449  * get_mac_stats()
450  *   get mac pause statistics including tx_cnt and rx_cnt
451  * get_ethtool_stats()
452  *   Get ethtool network device statistics
453  * get_strings()
454  *   Get a set of strings that describe the requested objects
455  * get_sset_count()
456  *   Get number of strings that @get_strings will write
457  * update_led_status()
458  *   Update the led status
459  * set_led_id()
460  *   Set led id
461  * get_regs()
462  *   Get regs dump
463  * get_regs_len()
464  *   Get the len of the regs dump
465  * get_rss_key_size()
466  *   Get rss key size
467  * get_rss()
468  *   Get rss table
469  * set_rss()
470  *   Set rss table
471  * get_tc_size()
472  *   Get tc size of handle
473  * get_vector()
474  *   Get vector number and vector information
475  * put_vector()
476  *   Put the vector in hdev
477  * map_ring_to_vector()
478  *   Map rings to vector
479  * unmap_ring_from_vector()
480  *   Unmap rings from vector
481  * reset_queue()
482  *   Reset queue
483  * get_fw_version()
484  *   Get firmware version
485  * get_mdix_mode()
486  *   Get media typr of phy
487  * enable_vlan_filter()
488  *   Enable vlan filter
489  * set_vlan_filter()
490  *   Set vlan filter config of Ports
491  * set_vf_vlan_filter()
492  *   Set vlan filter config of vf
493  * enable_hw_strip_rxvtag()
494  *   Enable/disable hardware strip vlan tag of packets received
495  * set_gro_en
496  *   Enable/disable HW GRO
497  * add_arfs_entry
498  *   Check the 5-tuples of flow, and create flow director rule
499  * get_vf_config
500  *   Get the VF configuration setting by the host
501  * set_vf_link_state
502  *   Set VF link status
503  * set_vf_spoofchk
504  *   Enable/disable spoof check for specified vf
505  * set_vf_trust
506  *   Enable/disable trust for specified vf, if the vf being trusted, then
507  *   it can enable promisc mode
508  * set_vf_rate
509  *   Set the max tx rate of specified vf.
510  * set_vf_mac
511  *   Configure the default MAC for specified VF
512  * get_module_eeprom
513  *   Get the optical module eeprom info.
514  * add_cls_flower
515  *   Add clsflower rule
516  * del_cls_flower
517  *   Delete clsflower rule
518  * cls_flower_active
519  *   Check if any cls flower rule exist
520  * dbg_read_cmd
521  *   Execute debugfs read command.
522  * set_tx_hwts_info
523  *   Save information for 1588 tx packet
524  * get_rx_hwts
525  *   Get 1588 rx hwstamp
526  * get_ts_info
527  *   Get phc info
528  */
529 struct hnae3_ae_ops {
530 	int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
531 	void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
532 	void (*reset_prepare)(struct hnae3_ae_dev *ae_dev,
533 			      enum hnae3_reset_type rst_type);
534 	void (*reset_done)(struct hnae3_ae_dev *ae_dev);
535 	int (*init_client_instance)(struct hnae3_client *client,
536 				    struct hnae3_ae_dev *ae_dev);
537 	void (*uninit_client_instance)(struct hnae3_client *client,
538 				       struct hnae3_ae_dev *ae_dev);
539 	int (*start)(struct hnae3_handle *handle);
540 	void (*stop)(struct hnae3_handle *handle);
541 	int (*client_start)(struct hnae3_handle *handle);
542 	void (*client_stop)(struct hnae3_handle *handle);
543 	int (*get_status)(struct hnae3_handle *handle);
544 	void (*get_ksettings_an_result)(struct hnae3_handle *handle,
545 					u8 *auto_neg, u32 *speed, u8 *duplex);
546 
547 	int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
548 				   u8 duplex);
549 
550 	void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type,
551 			       u8 *module_type);
552 	int (*check_port_speed)(struct hnae3_handle *handle, u32 speed);
553 	void (*get_fec)(struct hnae3_handle *handle, u8 *fec_ability,
554 			u8 *fec_mode);
555 	int (*set_fec)(struct hnae3_handle *handle, u32 fec_mode);
556 	void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
557 	int (*set_loopback)(struct hnae3_handle *handle,
558 			    enum hnae3_loop loop_mode, bool en);
559 
560 	int (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
561 				bool en_mc_pmc);
562 	void (*request_update_promisc_mode)(struct hnae3_handle *handle);
563 	int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
564 
565 	void (*get_pauseparam)(struct hnae3_handle *handle,
566 			       u32 *auto_neg, u32 *rx_en, u32 *tx_en);
567 	int (*set_pauseparam)(struct hnae3_handle *handle,
568 			      u32 auto_neg, u32 rx_en, u32 tx_en);
569 
570 	int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
571 	int (*get_autoneg)(struct hnae3_handle *handle);
572 	int (*restart_autoneg)(struct hnae3_handle *handle);
573 	int (*halt_autoneg)(struct hnae3_handle *handle, bool halt);
574 
575 	void (*get_coalesce_usecs)(struct hnae3_handle *handle,
576 				   u32 *tx_usecs, u32 *rx_usecs);
577 	void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
578 					    u32 *tx_frames, u32 *rx_frames);
579 	int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
580 	int (*set_coalesce_frames)(struct hnae3_handle *handle,
581 				   u32 coalesce_frames);
582 	void (*get_coalesce_range)(struct hnae3_handle *handle,
583 				   u32 *tx_frames_low, u32 *rx_frames_low,
584 				   u32 *tx_frames_high, u32 *rx_frames_high,
585 				   u32 *tx_usecs_low, u32 *rx_usecs_low,
586 				   u32 *tx_usecs_high, u32 *rx_usecs_high);
587 
588 	void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
589 	int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
590 			    bool is_first);
591 	int (*do_ioctl)(struct hnae3_handle *handle,
592 			struct ifreq *ifr, int cmd);
593 	int (*add_uc_addr)(struct hnae3_handle *handle,
594 			   const unsigned char *addr);
595 	int (*rm_uc_addr)(struct hnae3_handle *handle,
596 			  const unsigned char *addr);
597 	int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
598 	int (*add_mc_addr)(struct hnae3_handle *handle,
599 			   const unsigned char *addr);
600 	int (*rm_mc_addr)(struct hnae3_handle *handle,
601 			  const unsigned char *addr);
602 	void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
603 	void (*update_stats)(struct hnae3_handle *handle,
604 			     struct net_device_stats *net_stats);
605 	void (*get_stats)(struct hnae3_handle *handle, u64 *data);
606 	void (*get_mac_stats)(struct hnae3_handle *handle,
607 			      struct hns3_mac_stats *mac_stats);
608 	void (*get_strings)(struct hnae3_handle *handle,
609 			    u32 stringset, u8 *data);
610 	int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
611 
612 	void (*get_regs)(struct hnae3_handle *handle, u32 *version,
613 			 void *data);
614 	int (*get_regs_len)(struct hnae3_handle *handle);
615 
616 	u32 (*get_rss_key_size)(struct hnae3_handle *handle);
617 	int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
618 		       u8 *hfunc);
619 	int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
620 		       const u8 *key, const u8 hfunc);
621 	int (*set_rss_tuple)(struct hnae3_handle *handle,
622 			     struct ethtool_rxnfc *cmd);
623 	int (*get_rss_tuple)(struct hnae3_handle *handle,
624 			     struct ethtool_rxnfc *cmd);
625 
626 	int (*get_tc_size)(struct hnae3_handle *handle);
627 
628 	int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
629 			  struct hnae3_vector_info *vector_info);
630 	int (*put_vector)(struct hnae3_handle *handle, int vector_num);
631 	int (*map_ring_to_vector)(struct hnae3_handle *handle,
632 				  int vector_num,
633 				  struct hnae3_ring_chain_node *vr_chain);
634 	int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
635 				      int vector_num,
636 				      struct hnae3_ring_chain_node *vr_chain);
637 
638 	int (*reset_queue)(struct hnae3_handle *handle);
639 	u32 (*get_fw_version)(struct hnae3_handle *handle);
640 	void (*get_mdix_mode)(struct hnae3_handle *handle,
641 			      u8 *tp_mdix_ctrl, u8 *tp_mdix);
642 
643 	int (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
644 	int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
645 			       u16 vlan_id, bool is_kill);
646 	int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
647 				  u16 vlan, u8 qos, __be16 proto);
648 	int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
649 	void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
650 	enum hnae3_reset_type (*get_reset_level)(struct hnae3_ae_dev *ae_dev,
651 						 unsigned long *addr);
652 	void (*set_default_reset_request)(struct hnae3_ae_dev *ae_dev,
653 					  enum hnae3_reset_type rst_type);
654 	void (*get_channels)(struct hnae3_handle *handle,
655 			     struct ethtool_channels *ch);
656 	void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
657 				      u16 *alloc_tqps, u16 *max_rss_size);
658 	int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num,
659 			    bool rxfh_configured);
660 	void (*get_flowctrl_adv)(struct hnae3_handle *handle,
661 				 u32 *flowctrl_adv);
662 	int (*set_led_id)(struct hnae3_handle *handle,
663 			  enum ethtool_phys_id_state status);
664 	void (*get_link_mode)(struct hnae3_handle *handle,
665 			      unsigned long *supported,
666 			      unsigned long *advertising);
667 	int (*add_fd_entry)(struct hnae3_handle *handle,
668 			    struct ethtool_rxnfc *cmd);
669 	int (*del_fd_entry)(struct hnae3_handle *handle,
670 			    struct ethtool_rxnfc *cmd);
671 	int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
672 			       struct ethtool_rxnfc *cmd);
673 	int (*get_fd_rule_info)(struct hnae3_handle *handle,
674 				struct ethtool_rxnfc *cmd);
675 	int (*get_fd_all_rules)(struct hnae3_handle *handle,
676 				struct ethtool_rxnfc *cmd, u32 *rule_locs);
677 	void (*enable_fd)(struct hnae3_handle *handle, bool enable);
678 	int (*add_arfs_entry)(struct hnae3_handle *handle, u16 queue_id,
679 			      u16 flow_id, struct flow_keys *fkeys);
680 	int (*dbg_read_cmd)(struct hnae3_handle *handle, enum hnae3_dbg_cmd cmd,
681 			    char *buf, int len);
682 	pci_ers_result_t (*handle_hw_ras_error)(struct hnae3_ae_dev *ae_dev);
683 	bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
684 	bool (*ae_dev_resetting)(struct hnae3_handle *handle);
685 	unsigned long (*ae_dev_reset_cnt)(struct hnae3_handle *handle);
686 	int (*set_gro_en)(struct hnae3_handle *handle, bool enable);
687 	u16 (*get_global_queue_id)(struct hnae3_handle *handle, u16 queue_id);
688 	void (*set_timer_task)(struct hnae3_handle *handle, bool enable);
689 	int (*mac_connect_phy)(struct hnae3_handle *handle);
690 	void (*mac_disconnect_phy)(struct hnae3_handle *handle);
691 	int (*get_vf_config)(struct hnae3_handle *handle, int vf,
692 			     struct ifla_vf_info *ivf);
693 	int (*set_vf_link_state)(struct hnae3_handle *handle, int vf,
694 				 int link_state);
695 	int (*set_vf_spoofchk)(struct hnae3_handle *handle, int vf,
696 			       bool enable);
697 	int (*set_vf_trust)(struct hnae3_handle *handle, int vf, bool enable);
698 	int (*set_vf_rate)(struct hnae3_handle *handle, int vf,
699 			   int min_tx_rate, int max_tx_rate, bool force);
700 	int (*set_vf_mac)(struct hnae3_handle *handle, int vf, u8 *p);
701 	int (*get_module_eeprom)(struct hnae3_handle *handle, u32 offset,
702 				 u32 len, u8 *data);
703 	bool (*get_cmdq_stat)(struct hnae3_handle *handle);
704 	int (*add_cls_flower)(struct hnae3_handle *handle,
705 			      struct flow_cls_offload *cls_flower, int tc);
706 	int (*del_cls_flower)(struct hnae3_handle *handle,
707 			      struct flow_cls_offload *cls_flower);
708 	bool (*cls_flower_active)(struct hnae3_handle *handle);
709 	int (*get_phy_link_ksettings)(struct hnae3_handle *handle,
710 				      struct ethtool_link_ksettings *cmd);
711 	int (*set_phy_link_ksettings)(struct hnae3_handle *handle,
712 				      const struct ethtool_link_ksettings *cmd);
713 	bool (*set_tx_hwts_info)(struct hnae3_handle *handle,
714 				 struct sk_buff *skb);
715 	void (*get_rx_hwts)(struct hnae3_handle *handle, struct sk_buff *skb,
716 			    u32 nsec, u32 sec);
717 	int (*get_ts_info)(struct hnae3_handle *handle,
718 			   struct ethtool_ts_info *info);
719 };
720 
721 struct hnae3_dcb_ops {
722 	/* IEEE 802.1Qaz std */
723 	int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
724 	int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
725 	int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
726 	int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
727 
728 	/* DCBX configuration */
729 	u8   (*getdcbx)(struct hnae3_handle *);
730 	u8   (*setdcbx)(struct hnae3_handle *, u8);
731 
732 	int (*setup_tc)(struct hnae3_handle *handle,
733 			struct tc_mqprio_qopt_offload *mqprio_qopt);
734 };
735 
736 struct hnae3_ae_algo {
737 	const struct hnae3_ae_ops *ops;
738 	struct list_head node;
739 	const struct pci_device_id *pdev_id_table;
740 };
741 
742 #define HNAE3_INT_NAME_LEN        32
743 #define HNAE3_ITR_COUNTDOWN_START 100
744 
745 #define HNAE3_MAX_TC		8
746 #define HNAE3_MAX_USER_PRIO	8
747 struct hnae3_tc_info {
748 	u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
749 	u16 tqp_count[HNAE3_MAX_TC];
750 	u16 tqp_offset[HNAE3_MAX_TC];
751 	unsigned long tc_en; /* bitmap of TC enabled */
752 	u8 num_tc; /* Total number of enabled TCs */
753 	bool mqprio_active;
754 };
755 
756 struct hnae3_knic_private_info {
757 	struct net_device *netdev; /* Set by KNIC client when init instance */
758 	u16 rss_size;		   /* Allocated RSS queues */
759 	u16 req_rss_size;
760 	u16 rx_buf_len;
761 	u16 num_tx_desc;
762 	u16 num_rx_desc;
763 	u32 tx_spare_buf_size;
764 
765 	struct hnae3_tc_info tc_info;
766 
767 	u16 num_tqps;		  /* total number of TQPs in this handle */
768 	struct hnae3_queue **tqp;  /* array base of all TQPs in this instance */
769 	const struct hnae3_dcb_ops *dcb_ops;
770 
771 	u16 int_rl_setting;
772 	enum pkt_hash_types rss_type;
773 };
774 
775 struct hnae3_roce_private_info {
776 	struct net_device *netdev;
777 	void __iomem *roce_io_base;
778 	void __iomem *roce_mem_base;
779 	int base_vector;
780 	int num_vectors;
781 
782 	/* The below attributes defined for RoCE client, hnae3 gives
783 	 * initial values to them, and RoCE client can modify and use
784 	 * them.
785 	 */
786 	unsigned long reset_state;
787 	unsigned long instance_state;
788 	unsigned long state;
789 };
790 
791 #define HNAE3_SUPPORT_APP_LOOPBACK    BIT(0)
792 #define HNAE3_SUPPORT_PHY_LOOPBACK    BIT(1)
793 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK	BIT(2)
794 #define HNAE3_SUPPORT_VF	      BIT(3)
795 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK	BIT(4)
796 
797 #define HNAE3_USER_UPE		BIT(0)	/* unicast promisc enabled by user */
798 #define HNAE3_USER_MPE		BIT(1)	/* mulitcast promisc enabled by user */
799 #define HNAE3_BPE		BIT(2)	/* broadcast promisc enable */
800 #define HNAE3_OVERFLOW_UPE	BIT(3)	/* unicast mac vlan overflow */
801 #define HNAE3_OVERFLOW_MPE	BIT(4)	/* multicast mac vlan overflow */
802 #define HNAE3_UPE		(HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
803 #define HNAE3_MPE		(HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)
804 
805 enum hnae3_pflag {
806 	HNAE3_PFLAG_LIMIT_PROMISC,
807 	HNAE3_PFLAG_MAX
808 };
809 
810 struct hnae3_handle {
811 	struct hnae3_client *client;
812 	struct pci_dev *pdev;
813 	void *priv;
814 	struct hnae3_ae_algo *ae_algo;  /* the class who provides this handle */
815 	u64 flags; /* Indicate the capabilities for this handle */
816 
817 	union {
818 		struct net_device *netdev; /* first member */
819 		struct hnae3_knic_private_info kinfo;
820 		struct hnae3_roce_private_info rinfo;
821 	};
822 
823 	u32 numa_node_mask;	/* for multi-chip support */
824 
825 	enum hnae3_port_base_vlan_state port_base_vlan_state;
826 
827 	u8 netdev_flags;
828 	struct dentry *hnae3_dbgfs;
829 
830 	/* Network interface message level enabled bits */
831 	u32 msg_enable;
832 
833 	unsigned long supported_pflags;
834 	unsigned long priv_flags;
835 };
836 
837 #define hnae3_set_field(origin, mask, shift, val) \
838 	do { \
839 		(origin) &= (~(mask)); \
840 		(origin) |= ((val) << (shift)) & (mask); \
841 	} while (0)
842 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
843 
844 #define hnae3_set_bit(origin, shift, val) \
845 	hnae3_set_field(origin, 0x1 << (shift), shift, val)
846 #define hnae3_get_bit(origin, shift) \
847 	hnae3_get_field(origin, 0x1 << (shift), shift)
848 
849 int hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
850 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
851 
852 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
853 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
854 
855 void hnae3_unregister_client(struct hnae3_client *client);
856 int hnae3_register_client(struct hnae3_client *client);
857 
858 void hnae3_set_client_init_flag(struct hnae3_client *client,
859 				struct hnae3_ae_dev *ae_dev,
860 				unsigned int inited);
861 #endif
862