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 {
135 struct hnae3_vector_info {
140 #define HNAE3_RING_TYPE_B 0
141 #define HNAE3_RING_TYPE_TX 0
142 #define HNAE3_RING_TYPE_RX 1
143 #define HNAE3_RING_GL_IDX_S 0
144 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
145 #define HNAE3_RING_GL_RX 0
146 #define HNAE3_RING_GL_TX 1
148 struct hnae3_ring_chain_node {
149 struct hnae3_ring_chain_node *next;
155 #define HNAE3_IS_TX_RING(node) \
156 (((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
158 struct hnae3_client_ops {
159 int (*init_instance)(struct hnae3_handle *handle);
160 void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
161 void (*link_status_change)(struct hnae3_handle *handle, bool state);
162 int (*setup_tc)(struct hnae3_handle *handle, u8 tc);
163 int (*reset_notify)(struct hnae3_handle *handle,
164 enum hnae3_reset_notify_type type);
167 #define HNAE3_CLIENT_NAME_LENGTH 16
168 struct hnae3_client {
169 char name[HNAE3_CLIENT_NAME_LENGTH];
171 enum hnae3_client_type type;
172 const struct hnae3_client_ops *ops;
173 struct list_head node;
176 struct hnae3_ae_dev {
177 struct pci_dev *pdev;
178 const struct hnae3_ae_ops *ops;
179 struct list_head node;
181 enum hnae3_dev_type dev_type;
182 enum hnae3_reset_type reset_type;
186 /* This struct defines the operation on the handle.
188 * init_ae_dev(): (mandatory)
189 * Get PF configure from pci_dev and initialize PF hardware
191 * Disable PF device and release PF resource
193 * Register client to ae_dev
194 * unregister_client()
195 * Unregister client from ae_dev
197 * Enable the hardware
199 * Disable the hardware
201 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for
203 * get_ksettings_an_result()
204 * Get negotiation status,speed and duplex
205 * update_speed_duplex_h()
206 * Update hardware speed and duplex
208 * Get media type of MAC
218 * get tx and rx of pause frame use
220 * set tx and rx of pause frame use
222 * set auto autonegotiation of pause frame use
224 * get auto autonegotiation of pause frame use
225 * get_coalesce_usecs()
226 * get usecs to delay a TX interrupt after a packet is sent
227 * get_rx_max_coalesced_frames()
228 * get Maximum number of packets to be sent before a TX interrupt.
229 * set_coalesce_usecs()
230 * set usecs to delay a TX interrupt after a packet is sent
231 * set_coalesce_frames()
232 * set Maximum number of packets to be sent before a TX interrupt.
238 * Add unicast addr to mac table
240 * Remove unicast addr from mac table
242 * Set multicast address
244 * Add multicast address to mac table
246 * Remove multicast address from mac table
248 * Update Old network device statistics
249 * get_ethtool_stats()
250 * Get ethtool network device statistics
252 * Get a set of strings that describe the requested objects
254 * Get number of strings that @get_strings will write
255 * update_led_status()
256 * Update the led status
262 * Get the len of the regs dump
265 * get_rss_indir_size()
266 * Get rss indirection table size
272 * Get tc size of handle
274 * Get vector number and vector information
276 * Put the vector in hdev
277 * map_ring_to_vector()
278 * Map rings to vector
279 * unmap_ring_from_vector()
280 * Unmap rings from vector
284 * Get firmware version
286 * Get media typr of phy
287 * enable_vlan_filter()
290 * Set vlan filter config of Ports
291 * set_vf_vlan_filter()
292 * Set vlan filter config of vf
293 * enable_hw_strip_rxvtag()
294 * Enable/disable hardware strip vlan tag of packets received
296 struct hnae3_ae_ops {
297 int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
298 void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
300 int (*init_client_instance)(struct hnae3_client *client,
301 struct hnae3_ae_dev *ae_dev);
302 void (*uninit_client_instance)(struct hnae3_client *client,
303 struct hnae3_ae_dev *ae_dev);
304 int (*start)(struct hnae3_handle *handle);
305 void (*stop)(struct hnae3_handle *handle);
306 int (*get_status)(struct hnae3_handle *handle);
307 void (*get_ksettings_an_result)(struct hnae3_handle *handle,
308 u8 *auto_neg, u32 *speed, u8 *duplex);
310 int (*update_speed_duplex_h)(struct hnae3_handle *handle);
311 int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
314 void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type);
315 void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
316 int (*set_loopback)(struct hnae3_handle *handle,
317 enum hnae3_loop loop_mode, bool en);
319 void (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
321 int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
323 void (*get_pauseparam)(struct hnae3_handle *handle,
324 u32 *auto_neg, u32 *rx_en, u32 *tx_en);
325 int (*set_pauseparam)(struct hnae3_handle *handle,
326 u32 auto_neg, u32 rx_en, u32 tx_en);
328 int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
329 int (*get_autoneg)(struct hnae3_handle *handle);
331 void (*get_coalesce_usecs)(struct hnae3_handle *handle,
332 u32 *tx_usecs, u32 *rx_usecs);
333 void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
334 u32 *tx_frames, u32 *rx_frames);
335 int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
336 int (*set_coalesce_frames)(struct hnae3_handle *handle,
337 u32 coalesce_frames);
338 void (*get_coalesce_range)(struct hnae3_handle *handle,
339 u32 *tx_frames_low, u32 *rx_frames_low,
340 u32 *tx_frames_high, u32 *rx_frames_high,
341 u32 *tx_usecs_low, u32 *rx_usecs_low,
342 u32 *tx_usecs_high, u32 *rx_usecs_high);
344 void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
345 int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
347 int (*do_ioctl)(struct hnae3_handle *handle,
348 struct ifreq *ifr, int cmd);
349 int (*add_uc_addr)(struct hnae3_handle *handle,
350 const unsigned char *addr);
351 int (*rm_uc_addr)(struct hnae3_handle *handle,
352 const unsigned char *addr);
353 int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
354 int (*add_mc_addr)(struct hnae3_handle *handle,
355 const unsigned char *addr);
356 int (*rm_mc_addr)(struct hnae3_handle *handle,
357 const unsigned char *addr);
358 void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
359 void (*update_stats)(struct hnae3_handle *handle,
360 struct net_device_stats *net_stats);
361 void (*get_stats)(struct hnae3_handle *handle, u64 *data);
363 void (*get_strings)(struct hnae3_handle *handle,
364 u32 stringset, u8 *data);
365 int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
367 void (*get_regs)(struct hnae3_handle *handle, u32 *version,
369 int (*get_regs_len)(struct hnae3_handle *handle);
371 u32 (*get_rss_key_size)(struct hnae3_handle *handle);
372 u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
373 int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
375 int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
376 const u8 *key, const u8 hfunc);
377 int (*set_rss_tuple)(struct hnae3_handle *handle,
378 struct ethtool_rxnfc *cmd);
379 int (*get_rss_tuple)(struct hnae3_handle *handle,
380 struct ethtool_rxnfc *cmd);
382 int (*get_tc_size)(struct hnae3_handle *handle);
384 int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
385 struct hnae3_vector_info *vector_info);
386 int (*put_vector)(struct hnae3_handle *handle, int vector_num);
387 int (*map_ring_to_vector)(struct hnae3_handle *handle,
389 struct hnae3_ring_chain_node *vr_chain);
390 int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
392 struct hnae3_ring_chain_node *vr_chain);
394 void (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
395 u32 (*get_fw_version)(struct hnae3_handle *handle);
396 void (*get_mdix_mode)(struct hnae3_handle *handle,
397 u8 *tp_mdix_ctrl, u8 *tp_mdix);
399 void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
400 int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
401 u16 vlan_id, bool is_kill);
402 int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
403 u16 vlan, u8 qos, __be16 proto);
404 int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
405 void (*reset_event)(struct pci_dev *pdev, struct hnae3_handle *handle);
406 void (*get_channels)(struct hnae3_handle *handle,
407 struct ethtool_channels *ch);
408 void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
409 u16 *alloc_tqps, u16 *max_rss_size);
410 int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num);
411 void (*get_flowctrl_adv)(struct hnae3_handle *handle,
413 int (*set_led_id)(struct hnae3_handle *handle,
414 enum ethtool_phys_id_state status);
415 void (*get_link_mode)(struct hnae3_handle *handle,
416 unsigned long *supported,
417 unsigned long *advertising);
418 int (*add_fd_entry)(struct hnae3_handle *handle,
419 struct ethtool_rxnfc *cmd);
420 int (*del_fd_entry)(struct hnae3_handle *handle,
421 struct ethtool_rxnfc *cmd);
422 void (*del_all_fd_entries)(struct hnae3_handle *handle,
424 int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
425 struct ethtool_rxnfc *cmd);
426 int (*get_fd_rule_info)(struct hnae3_handle *handle,
427 struct ethtool_rxnfc *cmd);
428 int (*get_fd_all_rules)(struct hnae3_handle *handle,
429 struct ethtool_rxnfc *cmd, u32 *rule_locs);
430 int (*restore_fd_rules)(struct hnae3_handle *handle);
431 void (*enable_fd)(struct hnae3_handle *handle, bool enable);
432 pci_ers_result_t (*process_hw_error)(struct hnae3_ae_dev *ae_dev);
435 struct hnae3_dcb_ops {
436 /* IEEE 802.1Qaz std */
437 int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
438 int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
439 int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
440 int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
442 /* DCBX configuration */
443 u8 (*getdcbx)(struct hnae3_handle *);
444 u8 (*setdcbx)(struct hnae3_handle *, u8);
446 int (*map_update)(struct hnae3_handle *);
447 int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
450 struct hnae3_ae_algo {
451 const struct hnae3_ae_ops *ops;
452 struct list_head node;
453 const struct pci_device_id *pdev_id_table;
456 #define HNAE3_INT_NAME_LEN (IFNAMSIZ + 16)
457 #define HNAE3_ITR_COUNTDOWN_START 100
459 struct hnae3_tc_info {
460 u16 tqp_offset; /* TQP offset from base TQP */
461 u16 tqp_count; /* Total TQPs */
462 u8 tc; /* TC index */
463 bool enable; /* If this TC is enable or not */
466 #define HNAE3_MAX_TC 8
467 #define HNAE3_MAX_USER_PRIO 8
468 struct hnae3_knic_private_info {
469 struct net_device *netdev; /* Set by KNIC client when init instance */
470 u16 rss_size; /* Allocated RSS queues */
474 u8 num_tc; /* Total number of enabled TCs */
475 u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
476 struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
478 u16 num_tqps; /* total number of TQPs in this handle */
479 struct hnae3_queue **tqp; /* array base of all TQPs in this instance */
480 const struct hnae3_dcb_ops *dcb_ops;
483 enum pkt_hash_types rss_type;
486 struct hnae3_roce_private_info {
487 struct net_device *netdev;
488 void __iomem *roce_io_base;
493 struct hnae3_unic_private_info {
494 struct net_device *netdev;
497 u16 num_tqps; /* total number of tqps in this handle */
498 struct hnae3_queue **tqp; /* array base of all TQPs of this instance */
501 #define HNAE3_SUPPORT_APP_LOOPBACK BIT(0)
502 #define HNAE3_SUPPORT_PHY_LOOPBACK BIT(1)
503 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK BIT(2)
504 #define HNAE3_SUPPORT_VF BIT(3)
505 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK BIT(4)
507 #define HNAE3_USER_UPE BIT(0) /* unicast promisc enabled by user */
508 #define HNAE3_USER_MPE BIT(1) /* mulitcast promisc enabled by user */
509 #define HNAE3_BPE BIT(2) /* broadcast promisc enable */
510 #define HNAE3_OVERFLOW_UPE BIT(3) /* unicast mac vlan overflow */
511 #define HNAE3_OVERFLOW_MPE BIT(4) /* multicast mac vlan overflow */
512 #define HNAE3_VLAN_FLTR BIT(5) /* enable vlan filter */
513 #define HNAE3_UPE (HNAE3_USER_UPE | HNAE3_OVERFLOW_UPE)
514 #define HNAE3_MPE (HNAE3_USER_MPE | HNAE3_OVERFLOW_MPE)
516 struct hnae3_handle {
517 struct hnae3_client *client;
518 struct pci_dev *pdev;
520 struct hnae3_ae_algo *ae_algo; /* the class who provides this handle */
521 u64 flags; /* Indicate the capabilities for this handle*/
523 unsigned long last_reset_time;
524 enum hnae3_reset_type reset_level;
527 struct net_device *netdev; /* first member */
528 struct hnae3_knic_private_info kinfo;
529 struct hnae3_unic_private_info uinfo;
530 struct hnae3_roce_private_info rinfo;
533 u32 numa_node_mask; /* for multi-chip support */
538 #define hnae3_set_field(origin, mask, shift, val) \
540 (origin) &= (~(mask)); \
541 (origin) |= ((val) << (shift)) & (mask); \
543 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
545 #define hnae3_set_bit(origin, shift, val) \
546 hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
547 #define hnae3_get_bit(origin, shift) \
548 hnae3_get_field((origin), (0x1 << (shift)), (shift))
550 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
551 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
553 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
554 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
556 void hnae3_unregister_client(struct hnae3_client *client);
557 int hnae3_register_client(struct hnae3_client *client);
559 void hnae3_set_client_init_flag(struct hnae3_client *client,
560 struct hnae3_ae_dev *ae_dev, int inited);