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
54 #define HNAE3_DEV_SUPPORT_FD_B 0x6
56 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\
57 BIT(HNAE3_DEV_SUPPORT_ROCE_B))
59 #define hnae3_dev_roce_supported(hdev) \
60 hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
62 #define hnae3_dev_dcb_supported(hdev) \
63 hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
65 #define hnae3_dev_fd_supported(hdev) \
66 hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_FD_B)
68 #define ring_ptr_move_fw(ring, p) \
69 ((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
70 #define ring_ptr_move_bw(ring, p) \
71 ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
81 void __iomem *io_base;
82 struct hnae3_ae_algo *ae_algo;
83 struct hnae3_handle *handle;
84 int tqp_index; /* index in a handle */
85 u32 buf_size; /* size for hnae_desc->addr, preset by AE */
86 u16 desc_num; /* total number of desc */
92 HNAE3_LOOP_SERIAL_SERDES,
93 HNAE3_LOOP_PARALLEL_SERDES,
98 enum hnae3_client_type {
104 enum hnae3_dev_type {
110 enum hnae3_media_type {
111 HNAE3_MEDIA_TYPE_UNKNOWN,
112 HNAE3_MEDIA_TYPE_FIBER,
113 HNAE3_MEDIA_TYPE_COPPER,
114 HNAE3_MEDIA_TYPE_BACKPLANE,
115 HNAE3_MEDIA_TYPE_NONE,
118 enum hnae3_reset_notify_type {
125 enum hnae3_reset_type {
128 HNAE3_VF_PF_FUNC_RESET,
137 struct hnae3_vector_info {
142 #define HNAE3_RING_TYPE_B 0
143 #define HNAE3_RING_TYPE_TX 0
144 #define HNAE3_RING_TYPE_RX 1
145 #define HNAE3_RING_GL_IDX_S 0
146 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
147 #define HNAE3_RING_GL_RX 0
148 #define HNAE3_RING_GL_TX 1
150 struct hnae3_ring_chain_node {
151 struct hnae3_ring_chain_node *next;
157 #define HNAE3_IS_TX_RING(node) \
158 (((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
160 struct hnae3_client_ops {
161 int (*init_instance)(struct hnae3_handle *handle);
162 void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
163 void (*link_status_change)(struct hnae3_handle *handle, bool state);
164 int (*setup_tc)(struct hnae3_handle *handle, u8 tc);
165 int (*reset_notify)(struct hnae3_handle *handle,
166 enum hnae3_reset_notify_type type);
167 enum hnae3_reset_type (*process_hw_error)(struct hnae3_handle *handle);
170 #define HNAE3_CLIENT_NAME_LENGTH 16
171 struct hnae3_client {
172 char name[HNAE3_CLIENT_NAME_LENGTH];
174 enum hnae3_client_type type;
175 const struct hnae3_client_ops *ops;
176 struct list_head node;
179 struct hnae3_ae_dev {
180 struct pci_dev *pdev;
181 const struct hnae3_ae_ops *ops;
182 struct list_head node;
184 enum hnae3_dev_type dev_type;
185 enum hnae3_reset_type reset_type;
189 /* This struct defines the operation on the handle.
191 * init_ae_dev(): (mandatory)
192 * Get PF configure from pci_dev and initialize PF hardware
194 * Disable PF device and release PF resource
196 * Register client to ae_dev
197 * unregister_client()
198 * Unregister client from ae_dev
200 * Enable the hardware
202 * Disable the hardware
204 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for
206 * get_ksettings_an_result()
207 * Get negotiation status,speed and duplex
208 * update_speed_duplex_h()
209 * Update hardware speed and duplex
211 * Get media type of MAC
221 * get tx and rx of pause frame use
223 * set tx and rx of pause frame use
225 * set auto autonegotiation of pause frame use
227 * get auto autonegotiation of pause frame use
228 * get_coalesce_usecs()
229 * get usecs to delay a TX interrupt after a packet is sent
230 * get_rx_max_coalesced_frames()
231 * get Maximum number of packets to be sent before a TX interrupt.
232 * set_coalesce_usecs()
233 * set usecs to delay a TX interrupt after a packet is sent
234 * set_coalesce_frames()
235 * set Maximum number of packets to be sent before a TX interrupt.
241 * Add unicast addr to mac table
243 * Remove unicast addr from mac table
245 * Set multicast address
247 * Add multicast address to mac table
249 * Remove multicast address from mac table
251 * Update Old network device statistics
252 * get_ethtool_stats()
253 * Get ethtool network device statistics
255 * Get a set of strings that describe the requested objects
257 * Get number of strings that @get_strings will write
258 * update_led_status()
259 * Update the led status
265 * Get the len of the regs dump
268 * get_rss_indir_size()
269 * Get rss indirection table size
275 * Get tc size of handle
277 * Get vector number and vector information
279 * Put the vector in hdev
280 * map_ring_to_vector()
281 * Map rings to vector
282 * unmap_ring_from_vector()
283 * Unmap rings from vector
287 * Get firmware version
289 * Get media typr of phy
290 * enable_vlan_filter()
293 * Set vlan filter config of Ports
294 * set_vf_vlan_filter()
295 * Set vlan filter config of vf
296 * enable_hw_strip_rxvtag()
297 * Enable/disable hardware strip vlan tag of packets received
299 struct hnae3_ae_ops {
300 int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
301 void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
303 int (*init_client_instance)(struct hnae3_client *client,
304 struct hnae3_ae_dev *ae_dev);
305 void (*uninit_client_instance)(struct hnae3_client *client,
306 struct hnae3_ae_dev *ae_dev);
307 int (*start)(struct hnae3_handle *handle);
308 void (*stop)(struct hnae3_handle *handle);
309 int (*get_status)(struct hnae3_handle *handle);
310 void (*get_ksettings_an_result)(struct hnae3_handle *handle,
311 u8 *auto_neg, u32 *speed, u8 *duplex);
313 int (*update_speed_duplex_h)(struct hnae3_handle *handle);
314 int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
317 void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type);
318 void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
319 int (*set_loopback)(struct hnae3_handle *handle,
320 enum hnae3_loop loop_mode, bool en);
322 int (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
324 int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
326 void (*get_pauseparam)(struct hnae3_handle *handle,
327 u32 *auto_neg, u32 *rx_en, u32 *tx_en);
328 int (*set_pauseparam)(struct hnae3_handle *handle,
329 u32 auto_neg, u32 rx_en, u32 tx_en);
331 int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
332 int (*get_autoneg)(struct hnae3_handle *handle);
334 void (*get_coalesce_usecs)(struct hnae3_handle *handle,
335 u32 *tx_usecs, u32 *rx_usecs);
336 void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
337 u32 *tx_frames, u32 *rx_frames);
338 int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
339 int (*set_coalesce_frames)(struct hnae3_handle *handle,
340 u32 coalesce_frames);
341 void (*get_coalesce_range)(struct hnae3_handle *handle,
342 u32 *tx_frames_low, u32 *rx_frames_low,
343 u32 *tx_frames_high, u32 *rx_frames_high,
344 u32 *tx_usecs_low, u32 *rx_usecs_low,
345 u32 *tx_usecs_high, u32 *rx_usecs_high);
347 void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
348 int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
350 int (*do_ioctl)(struct hnae3_handle *handle,
351 struct ifreq *ifr, int cmd);
352 int (*add_uc_addr)(struct hnae3_handle *handle,
353 const unsigned char *addr);
354 int (*rm_uc_addr)(struct hnae3_handle *handle,
355 const unsigned char *addr);
356 int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
357 int (*add_mc_addr)(struct hnae3_handle *handle,
358 const unsigned char *addr);
359 int (*rm_mc_addr)(struct hnae3_handle *handle,
360 const unsigned char *addr);
361 void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
362 void (*update_stats)(struct hnae3_handle *handle,
363 struct net_device_stats *net_stats);
364 void (*get_stats)(struct hnae3_handle *handle, u64 *data);
366 void (*get_strings)(struct hnae3_handle *handle,
367 u32 stringset, u8 *data);
368 int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
370 void (*get_regs)(struct hnae3_handle *handle, u32 *version,
372 int (*get_regs_len)(struct hnae3_handle *handle);
374 u32 (*get_rss_key_size)(struct hnae3_handle *handle);
375 u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
376 int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
378 int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
379 const u8 *key, const u8 hfunc);
380 int (*set_rss_tuple)(struct hnae3_handle *handle,
381 struct ethtool_rxnfc *cmd);
382 int (*get_rss_tuple)(struct hnae3_handle *handle,
383 struct ethtool_rxnfc *cmd);
385 int (*get_tc_size)(struct hnae3_handle *handle);
387 int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
388 struct hnae3_vector_info *vector_info);
389 int (*put_vector)(struct hnae3_handle *handle, int vector_num);
390 int (*map_ring_to_vector)(struct hnae3_handle *handle,
392 struct hnae3_ring_chain_node *vr_chain);
393 int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
395 struct hnae3_ring_chain_node *vr_chain);
397 int (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
398 u32 (*get_fw_version)(struct hnae3_handle *handle);
399 void (*get_mdix_mode)(struct hnae3_handle *handle,
400 u8 *tp_mdix_ctrl, u8 *tp_mdix);
402 void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
403 int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
404 u16 vlan_id, bool is_kill);
405 int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
406 u16 vlan, u8 qos, __be16 proto);
407 int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
408 void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
409 void (*set_default_reset_request)(struct hnae3_ae_dev *ae_dev,
410 enum hnae3_reset_type rst_type);
411 void (*get_channels)(struct hnae3_handle *handle,
412 struct ethtool_channels *ch);
413 void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
414 u16 *alloc_tqps, u16 *max_rss_size);
415 int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num);
416 void (*get_flowctrl_adv)(struct hnae3_handle *handle,
418 int (*set_led_id)(struct hnae3_handle *handle,
419 enum ethtool_phys_id_state status);
420 void (*get_link_mode)(struct hnae3_handle *handle,
421 unsigned long *supported,
422 unsigned long *advertising);
423 int (*add_fd_entry)(struct hnae3_handle *handle,
424 struct ethtool_rxnfc *cmd);
425 int (*del_fd_entry)(struct hnae3_handle *handle,
426 struct ethtool_rxnfc *cmd);
427 void (*del_all_fd_entries)(struct hnae3_handle *handle,
429 int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
430 struct ethtool_rxnfc *cmd);
431 int (*get_fd_rule_info)(struct hnae3_handle *handle,
432 struct ethtool_rxnfc *cmd);
433 int (*get_fd_all_rules)(struct hnae3_handle *handle,
434 struct ethtool_rxnfc *cmd, u32 *rule_locs);
435 int (*restore_fd_rules)(struct hnae3_handle *handle);
436 void (*enable_fd)(struct hnae3_handle *handle, bool enable);
437 pci_ers_result_t (*process_hw_error)(struct hnae3_ae_dev *ae_dev);
438 bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
439 bool (*ae_dev_resetting)(struct hnae3_handle *handle);
440 unsigned long (*ae_dev_reset_cnt)(struct hnae3_handle *handle);
443 struct hnae3_dcb_ops {
444 /* IEEE 802.1Qaz std */
445 int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
446 int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
447 int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
448 int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
450 /* DCBX configuration */
451 u8 (*getdcbx)(struct hnae3_handle *);
452 u8 (*setdcbx)(struct hnae3_handle *, u8);
454 int (*map_update)(struct hnae3_handle *);
455 int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
458 struct hnae3_ae_algo {
459 const struct hnae3_ae_ops *ops;
460 struct list_head node;
461 const struct pci_device_id *pdev_id_table;
464 #define HNAE3_INT_NAME_LEN (IFNAMSIZ + 16)
465 #define HNAE3_ITR_COUNTDOWN_START 100
467 struct hnae3_tc_info {
468 u16 tqp_offset; /* TQP offset from base TQP */
469 u16 tqp_count; /* Total TQPs */
470 u8 tc; /* TC index */
471 bool enable; /* If this TC is enable or not */
474 #define HNAE3_MAX_TC 8
475 #define HNAE3_MAX_USER_PRIO 8
476 struct hnae3_knic_private_info {
477 struct net_device *netdev; /* Set by KNIC client when init instance */
478 u16 rss_size; /* Allocated RSS queues */
482 u8 num_tc; /* Total number of enabled TCs */
483 u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
484 struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
486 u16 num_tqps; /* total number of TQPs in this handle */
487 struct hnae3_queue **tqp; /* array base of all TQPs in this instance */
488 const struct hnae3_dcb_ops *dcb_ops;
491 enum pkt_hash_types rss_type;
494 struct hnae3_roce_private_info {
495 struct net_device *netdev;
496 void __iomem *roce_io_base;
500 /* The below attributes defined for RoCE client, hnae3 gives
501 * initial values to them, and RoCE client can modify and use
504 unsigned long reset_state;
505 unsigned long instance_state;
509 struct hnae3_unic_private_info {
510 struct net_device *netdev;
513 u16 num_tqps; /* total number of tqps in this handle */
514 struct hnae3_queue **tqp; /* array base of all TQPs of this instance */
517 #define HNAE3_SUPPORT_APP_LOOPBACK BIT(0)
518 #define HNAE3_SUPPORT_PHY_LOOPBACK BIT(1)
519 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK BIT(2)
520 #define HNAE3_SUPPORT_VF BIT(3)
521 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK BIT(4)
523 #define HNAE3_USER_UPE BIT(0) /* unicast promisc enabled by user */
524 #define HNAE3_USER_MPE BIT(1) /* mulitcast promisc enabled by user */
525 #define HNAE3_BPE BIT(2) /* broadcast promisc enable */
526 #define HNAE3_OVERFLOW_UPE BIT(3) /* unicast mac vlan overflow */
527 #define HNAE3_OVERFLOW_MPE BIT(4) /* multicast mac vlan overflow */
528 #define HNAE3_VLAN_FLTR BIT(5) /* enable vlan filter */
529 #define HNAE3_UPE (HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
530 #define HNAE3_MPE (HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)
532 struct hnae3_handle {
533 struct hnae3_client *client;
534 struct pci_dev *pdev;
536 struct hnae3_ae_algo *ae_algo; /* the class who provides this handle */
537 u64 flags; /* Indicate the capabilities for this handle*/
540 struct net_device *netdev; /* first member */
541 struct hnae3_knic_private_info kinfo;
542 struct hnae3_unic_private_info uinfo;
543 struct hnae3_roce_private_info rinfo;
546 u32 numa_node_mask; /* for multi-chip support */
551 #define hnae3_set_field(origin, mask, shift, val) \
553 (origin) &= (~(mask)); \
554 (origin) |= ((val) << (shift)) & (mask); \
556 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
558 #define hnae3_set_bit(origin, shift, val) \
559 hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
560 #define hnae3_get_bit(origin, shift) \
561 hnae3_get_field((origin), (0x1 << (shift)), (shift))
563 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
564 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
566 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
567 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
569 void hnae3_unregister_client(struct hnae3_client *client);
570 int hnae3_register_client(struct hnae3_client *client);
572 void hnae3_set_client_init_flag(struct hnae3_client *client,
573 struct hnae3_ae_dev *ae_dev, int inited);