1 // SPDX-License-Identifier: GPL-2.0+
2 // Copyright (c) 2016-2017 Hisilicon Limited.
7 /* Names used in this framework:
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
13 * a tx or rx channel within a rbq
14 * ring description (desc):
15 * an element in the ring with packet information
17 * a memory region referred by desc with the full packet payload
19 * "num" means a static number set as a parameter, "count" mean a dynamic
20 * number set while running
21 * "cb" means control block
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>
33 #define HNAE3_MOD_VERSION "1.0"
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
46 #define HNAE3_CLASS_NAME_SIZE 16
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
55 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\
56 BIT(HNAE3_DEV_SUPPORT_ROCE_B))
58 #define hnae3_dev_roce_supported(hdev) \
59 hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
61 #define hnae3_dev_dcb_supported(hdev) \
62 hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
64 #define ring_ptr_move_fw(ring, p) \
65 ((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
66 #define ring_ptr_move_bw(ring, p) \
67 ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
77 void __iomem *io_base;
78 struct hnae3_ae_algo *ae_algo;
79 struct hnae3_handle *handle;
80 int tqp_index; /* index in a handle */
81 u32 buf_size; /* size for hnae_desc->addr, preset by AE */
82 u16 desc_num; /* total number of desc */
87 HNAE3_MAC_INTER_LOOP_MAC,
88 HNAE3_MAC_INTER_LOOP_SERDES,
89 HNAE3_MAC_INTER_LOOP_PHY,
93 enum hnae3_client_type {
105 enum hnae3_media_type {
106 HNAE3_MEDIA_TYPE_UNKNOWN,
107 HNAE3_MEDIA_TYPE_FIBER,
108 HNAE3_MEDIA_TYPE_COPPER,
109 HNAE3_MEDIA_TYPE_BACKPLANE,
112 enum hnae3_reset_notify_type {
119 enum hnae3_reset_type {
129 struct hnae3_vector_info {
134 #define HNAE3_RING_TYPE_B 0
135 #define HNAE3_RING_TYPE_TX 0
136 #define HNAE3_RING_TYPE_RX 1
137 #define HNAE3_RING_GL_IDX_S 0
138 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
139 #define HNAE3_RING_GL_RX 0
140 #define HNAE3_RING_GL_TX 1
142 struct hnae3_ring_chain_node {
143 struct hnae3_ring_chain_node *next;
149 #define HNAE3_IS_TX_RING(node) \
150 (((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
152 struct hnae3_client_ops {
153 int (*init_instance)(struct hnae3_handle *handle);
154 void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
155 void (*link_status_change)(struct hnae3_handle *handle, bool state);
156 int (*setup_tc)(struct hnae3_handle *handle, u8 tc);
157 int (*reset_notify)(struct hnae3_handle *handle,
158 enum hnae3_reset_notify_type type);
161 #define HNAE3_CLIENT_NAME_LENGTH 16
162 struct hnae3_client {
163 char name[HNAE3_CLIENT_NAME_LENGTH];
165 enum hnae3_client_type type;
166 const struct hnae3_client_ops *ops;
167 struct list_head node;
170 struct hnae3_ae_dev {
171 struct pci_dev *pdev;
172 const struct hnae3_ae_ops *ops;
173 struct list_head node;
175 enum hnae3_dev_type dev_type;
179 /* This struct defines the operation on the handle.
181 * init_ae_dev(): (mandatory)
182 * Get PF configure from pci_dev and initialize PF hardware
184 * Disable PF device and release PF resource
186 * Register client to ae_dev
187 * unregister_client()
188 * Unregister client from ae_dev
190 * Enable the hardware
192 * Disable the hardware
194 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for
196 * get_ksettings_an_result()
197 * Get negotiation status,speed and duplex
198 * update_speed_duplex_h()
199 * Update hardware speed and duplex
201 * Get media type of MAC
211 * get tx and rx of pause frame use
213 * set tx and rx of pause frame use
215 * set auto autonegotiation of pause frame use
217 * get auto autonegotiation of pause frame use
218 * get_coalesce_usecs()
219 * get usecs to delay a TX interrupt after a packet is sent
220 * get_rx_max_coalesced_frames()
221 * get Maximum number of packets to be sent before a TX interrupt.
222 * set_coalesce_usecs()
223 * set usecs to delay a TX interrupt after a packet is sent
224 * set_coalesce_frames()
225 * set Maximum number of packets to be sent before a TX interrupt.
231 * Add unicast addr to mac table
233 * Remove unicast addr from mac table
235 * Set multicast address
237 * Add multicast address to mac table
239 * Remove multicast address from mac table
241 * Update Old network device statistics
242 * get_ethtool_stats()
243 * Get ethtool network device statistics
245 * Get a set of strings that describe the requested objects
247 * Get number of strings that @get_strings will write
248 * update_led_status()
249 * Update the led status
255 * Get the len of the regs dump
258 * get_rss_indir_size()
259 * Get rss indirection table size
265 * Get tc size of handle
267 * Get vector number and vector information
269 * Put the vector in hdev
270 * map_ring_to_vector()
271 * Map rings to vector
272 * unmap_ring_from_vector()
273 * Unmap rings from vector
277 * Get firmware version
279 * Get media typr of phy
280 * enable_vlan_filter()
283 * Set vlan filter config of Ports
284 * set_vf_vlan_filter()
285 * Set vlan filter config of vf
286 * enable_hw_strip_rxvtag()
287 * Enable/disable hardware strip vlan tag of packets received
289 struct hnae3_ae_ops {
290 int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
291 void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
293 int (*init_client_instance)(struct hnae3_client *client,
294 struct hnae3_ae_dev *ae_dev);
295 void (*uninit_client_instance)(struct hnae3_client *client,
296 struct hnae3_ae_dev *ae_dev);
297 int (*start)(struct hnae3_handle *handle);
298 void (*stop)(struct hnae3_handle *handle);
299 int (*get_status)(struct hnae3_handle *handle);
300 void (*get_ksettings_an_result)(struct hnae3_handle *handle,
301 u8 *auto_neg, u32 *speed, u8 *duplex);
303 int (*update_speed_duplex_h)(struct hnae3_handle *handle);
304 int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
307 void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type);
308 void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
309 int (*set_loopback)(struct hnae3_handle *handle,
310 enum hnae3_loop loop_mode, bool en);
312 void (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
314 int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
316 void (*get_pauseparam)(struct hnae3_handle *handle,
317 u32 *auto_neg, u32 *rx_en, u32 *tx_en);
318 int (*set_pauseparam)(struct hnae3_handle *handle,
319 u32 auto_neg, u32 rx_en, u32 tx_en);
321 int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
322 int (*get_autoneg)(struct hnae3_handle *handle);
324 void (*get_coalesce_usecs)(struct hnae3_handle *handle,
325 u32 *tx_usecs, u32 *rx_usecs);
326 void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
327 u32 *tx_frames, u32 *rx_frames);
328 int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
329 int (*set_coalesce_frames)(struct hnae3_handle *handle,
330 u32 coalesce_frames);
331 void (*get_coalesce_range)(struct hnae3_handle *handle,
332 u32 *tx_frames_low, u32 *rx_frames_low,
333 u32 *tx_frames_high, u32 *rx_frames_high,
334 u32 *tx_usecs_low, u32 *rx_usecs_low,
335 u32 *tx_usecs_high, u32 *rx_usecs_high);
337 void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
338 int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
340 int (*add_uc_addr)(struct hnae3_handle *handle,
341 const unsigned char *addr);
342 int (*rm_uc_addr)(struct hnae3_handle *handle,
343 const unsigned char *addr);
344 int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
345 int (*add_mc_addr)(struct hnae3_handle *handle,
346 const unsigned char *addr);
347 int (*rm_mc_addr)(struct hnae3_handle *handle,
348 const unsigned char *addr);
349 int (*update_mta_status)(struct hnae3_handle *handle);
351 void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
352 void (*update_stats)(struct hnae3_handle *handle,
353 struct net_device_stats *net_stats);
354 void (*get_stats)(struct hnae3_handle *handle, u64 *data);
356 void (*get_strings)(struct hnae3_handle *handle,
357 u32 stringset, u8 *data);
358 int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
360 void (*get_regs)(struct hnae3_handle *handle, u32 *version,
362 int (*get_regs_len)(struct hnae3_handle *handle);
364 u32 (*get_rss_key_size)(struct hnae3_handle *handle);
365 u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
366 int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
368 int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
369 const u8 *key, const u8 hfunc);
370 int (*set_rss_tuple)(struct hnae3_handle *handle,
371 struct ethtool_rxnfc *cmd);
372 int (*get_rss_tuple)(struct hnae3_handle *handle,
373 struct ethtool_rxnfc *cmd);
375 int (*get_tc_size)(struct hnae3_handle *handle);
377 int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
378 struct hnae3_vector_info *vector_info);
379 int (*put_vector)(struct hnae3_handle *handle, int vector_num);
380 int (*map_ring_to_vector)(struct hnae3_handle *handle,
382 struct hnae3_ring_chain_node *vr_chain);
383 int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
385 struct hnae3_ring_chain_node *vr_chain);
387 void (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
388 u32 (*get_fw_version)(struct hnae3_handle *handle);
389 void (*get_mdix_mode)(struct hnae3_handle *handle,
390 u8 *tp_mdix_ctrl, u8 *tp_mdix);
392 void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
393 int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
394 u16 vlan_id, bool is_kill);
395 int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
396 u16 vlan, u8 qos, __be16 proto);
397 int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
398 void (*reset_event)(struct hnae3_handle *handle);
399 void (*get_channels)(struct hnae3_handle *handle,
400 struct ethtool_channels *ch);
401 void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
402 u16 *free_tqps, u16 *max_rss_size);
403 int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num);
404 void (*get_flowctrl_adv)(struct hnae3_handle *handle,
406 int (*set_led_id)(struct hnae3_handle *handle,
407 enum ethtool_phys_id_state status);
408 void (*get_link_mode)(struct hnae3_handle *handle,
409 unsigned long *supported,
410 unsigned long *advertising);
411 void (*get_port_type)(struct hnae3_handle *handle, u8 *port_type);
414 struct hnae3_dcb_ops {
415 /* IEEE 802.1Qaz std */
416 int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
417 int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
418 int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
419 int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
421 /* DCBX configuration */
422 u8 (*getdcbx)(struct hnae3_handle *);
423 u8 (*setdcbx)(struct hnae3_handle *, u8);
425 int (*map_update)(struct hnae3_handle *);
426 int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
429 struct hnae3_ae_algo {
430 const struct hnae3_ae_ops *ops;
431 struct list_head node;
432 const struct pci_device_id *pdev_id_table;
435 #define HNAE3_INT_NAME_LEN (IFNAMSIZ + 16)
436 #define HNAE3_ITR_COUNTDOWN_START 100
438 struct hnae3_tc_info {
439 u16 tqp_offset; /* TQP offset from base TQP */
440 u16 tqp_count; /* Total TQPs */
441 u8 tc; /* TC index */
442 bool enable; /* If this TC is enable or not */
445 #define HNAE3_MAX_TC 8
446 #define HNAE3_MAX_USER_PRIO 8
447 struct hnae3_knic_private_info {
448 struct net_device *netdev; /* Set by KNIC client when init instance */
449 u16 rss_size; /* Allocated RSS queues */
453 u8 num_tc; /* Total number of enabled TCs */
454 u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
455 struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
457 u16 num_tqps; /* total number of TQPs in this handle */
458 struct hnae3_queue **tqp; /* array base of all TQPs in this instance */
459 const struct hnae3_dcb_ops *dcb_ops;
464 struct hnae3_roce_private_info {
465 struct net_device *netdev;
466 void __iomem *roce_io_base;
471 struct hnae3_unic_private_info {
472 struct net_device *netdev;
475 u16 num_tqps; /* total number of tqps in this handle */
476 struct hnae3_queue **tqp; /* array base of all TQPs of this instance */
479 #define HNAE3_SUPPORT_MAC_LOOPBACK BIT(0)
480 #define HNAE3_SUPPORT_PHY_LOOPBACK BIT(1)
481 #define HNAE3_SUPPORT_SERDES_LOOPBACK BIT(2)
482 #define HNAE3_SUPPORT_VF BIT(3)
484 struct hnae3_handle {
485 struct hnae3_client *client;
486 struct pci_dev *pdev;
488 struct hnae3_ae_algo *ae_algo; /* the class who provides this handle */
489 u64 flags; /* Indicate the capabilities for this handle*/
491 unsigned long last_reset_time;
492 enum hnae3_reset_type reset_level;
495 struct net_device *netdev; /* first member */
496 struct hnae3_knic_private_info kinfo;
497 struct hnae3_unic_private_info uinfo;
498 struct hnae3_roce_private_info rinfo;
501 u32 numa_node_mask; /* for multi-chip support */
504 #define hnae3_set_field(origin, mask, shift, val) \
506 (origin) &= (~(mask)); \
507 (origin) |= ((val) << (shift)) & (mask); \
509 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
511 #define hnae3_set_bit(origin, shift, val) \
512 hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
513 #define hnae3_get_bit(origin, shift) \
514 hnae3_get_field((origin), (0x1 << (shift)), (shift))
516 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
517 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
519 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
520 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
522 void hnae3_unregister_client(struct hnae3_client *client);
523 int hnae3_register_client(struct hnae3_client *client);