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 */
88 HNAE3_LOOP_SERIAL_SERDES,
89 HNAE3_LOOP_PARALLEL_SERDES,
94 enum hnae3_client_type {
100 enum hnae3_dev_type {
106 enum hnae3_media_type {
107 HNAE3_MEDIA_TYPE_UNKNOWN,
108 HNAE3_MEDIA_TYPE_FIBER,
109 HNAE3_MEDIA_TYPE_COPPER,
110 HNAE3_MEDIA_TYPE_BACKPLANE,
111 HNAE3_MEDIA_TYPE_NONE,
114 enum hnae3_reset_notify_type {
121 enum hnae3_reset_type {
131 struct hnae3_vector_info {
136 #define HNAE3_RING_TYPE_B 0
137 #define HNAE3_RING_TYPE_TX 0
138 #define HNAE3_RING_TYPE_RX 1
139 #define HNAE3_RING_GL_IDX_S 0
140 #define HNAE3_RING_GL_IDX_M GENMASK(1, 0)
141 #define HNAE3_RING_GL_RX 0
142 #define HNAE3_RING_GL_TX 1
144 struct hnae3_ring_chain_node {
145 struct hnae3_ring_chain_node *next;
151 #define HNAE3_IS_TX_RING(node) \
152 (((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
154 struct hnae3_client_ops {
155 int (*init_instance)(struct hnae3_handle *handle);
156 void (*uninit_instance)(struct hnae3_handle *handle, bool reset);
157 void (*link_status_change)(struct hnae3_handle *handle, bool state);
158 int (*setup_tc)(struct hnae3_handle *handle, u8 tc);
159 int (*reset_notify)(struct hnae3_handle *handle,
160 enum hnae3_reset_notify_type type);
163 #define HNAE3_CLIENT_NAME_LENGTH 16
164 struct hnae3_client {
165 char name[HNAE3_CLIENT_NAME_LENGTH];
167 enum hnae3_client_type type;
168 const struct hnae3_client_ops *ops;
169 struct list_head node;
172 struct hnae3_ae_dev {
173 struct pci_dev *pdev;
174 const struct hnae3_ae_ops *ops;
175 struct list_head node;
177 enum hnae3_dev_type dev_type;
181 /* This struct defines the operation on the handle.
183 * init_ae_dev(): (mandatory)
184 * Get PF configure from pci_dev and initialize PF hardware
186 * Disable PF device and release PF resource
188 * Register client to ae_dev
189 * unregister_client()
190 * Unregister client from ae_dev
192 * Enable the hardware
194 * Disable the hardware
196 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for
198 * get_ksettings_an_result()
199 * Get negotiation status,speed and duplex
200 * update_speed_duplex_h()
201 * Update hardware speed and duplex
203 * Get media type of MAC
213 * get tx and rx of pause frame use
215 * set tx and rx of pause frame use
217 * set auto autonegotiation of pause frame use
219 * get auto autonegotiation of pause frame use
220 * get_coalesce_usecs()
221 * get usecs to delay a TX interrupt after a packet is sent
222 * get_rx_max_coalesced_frames()
223 * get Maximum number of packets to be sent before a TX interrupt.
224 * set_coalesce_usecs()
225 * set usecs to delay a TX interrupt after a packet is sent
226 * set_coalesce_frames()
227 * set Maximum number of packets to be sent before a TX interrupt.
233 * Add unicast addr to mac table
235 * Remove unicast addr from mac table
237 * Set multicast address
239 * Add multicast address to mac table
241 * Remove multicast address from mac table
243 * Update Old network device statistics
244 * get_ethtool_stats()
245 * Get ethtool network device statistics
247 * Get a set of strings that describe the requested objects
249 * Get number of strings that @get_strings will write
250 * update_led_status()
251 * Update the led status
257 * Get the len of the regs dump
260 * get_rss_indir_size()
261 * Get rss indirection table size
267 * Get tc size of handle
269 * Get vector number and vector information
271 * Put the vector in hdev
272 * map_ring_to_vector()
273 * Map rings to vector
274 * unmap_ring_from_vector()
275 * Unmap rings from vector
279 * Get firmware version
281 * Get media typr of phy
282 * enable_vlan_filter()
285 * Set vlan filter config of Ports
286 * set_vf_vlan_filter()
287 * Set vlan filter config of vf
288 * enable_hw_strip_rxvtag()
289 * Enable/disable hardware strip vlan tag of packets received
291 struct hnae3_ae_ops {
292 int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
293 void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
295 int (*init_client_instance)(struct hnae3_client *client,
296 struct hnae3_ae_dev *ae_dev);
297 void (*uninit_client_instance)(struct hnae3_client *client,
298 struct hnae3_ae_dev *ae_dev);
299 int (*start)(struct hnae3_handle *handle);
300 void (*stop)(struct hnae3_handle *handle);
301 int (*get_status)(struct hnae3_handle *handle);
302 void (*get_ksettings_an_result)(struct hnae3_handle *handle,
303 u8 *auto_neg, u32 *speed, u8 *duplex);
305 int (*update_speed_duplex_h)(struct hnae3_handle *handle);
306 int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
309 void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type);
310 void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
311 int (*set_loopback)(struct hnae3_handle *handle,
312 enum hnae3_loop loop_mode, bool en);
314 void (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
316 int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
318 void (*get_pauseparam)(struct hnae3_handle *handle,
319 u32 *auto_neg, u32 *rx_en, u32 *tx_en);
320 int (*set_pauseparam)(struct hnae3_handle *handle,
321 u32 auto_neg, u32 rx_en, u32 tx_en);
323 int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
324 int (*get_autoneg)(struct hnae3_handle *handle);
326 void (*get_coalesce_usecs)(struct hnae3_handle *handle,
327 u32 *tx_usecs, u32 *rx_usecs);
328 void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
329 u32 *tx_frames, u32 *rx_frames);
330 int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
331 int (*set_coalesce_frames)(struct hnae3_handle *handle,
332 u32 coalesce_frames);
333 void (*get_coalesce_range)(struct hnae3_handle *handle,
334 u32 *tx_frames_low, u32 *rx_frames_low,
335 u32 *tx_frames_high, u32 *rx_frames_high,
336 u32 *tx_usecs_low, u32 *rx_usecs_low,
337 u32 *tx_usecs_high, u32 *rx_usecs_high);
339 void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
340 int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
342 int (*do_ioctl)(struct hnae3_handle *handle,
343 struct ifreq *ifr, int cmd);
344 int (*add_uc_addr)(struct hnae3_handle *handle,
345 const unsigned char *addr);
346 int (*rm_uc_addr)(struct hnae3_handle *handle,
347 const unsigned char *addr);
348 int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
349 int (*add_mc_addr)(struct hnae3_handle *handle,
350 const unsigned char *addr);
351 int (*rm_mc_addr)(struct hnae3_handle *handle,
352 const unsigned char *addr);
353 int (*update_mta_status)(struct hnae3_handle *handle);
355 void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
356 void (*update_stats)(struct hnae3_handle *handle,
357 struct net_device_stats *net_stats);
358 void (*get_stats)(struct hnae3_handle *handle, u64 *data);
360 void (*get_strings)(struct hnae3_handle *handle,
361 u32 stringset, u8 *data);
362 int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
364 void (*get_regs)(struct hnae3_handle *handle, u32 *version,
366 int (*get_regs_len)(struct hnae3_handle *handle);
368 u32 (*get_rss_key_size)(struct hnae3_handle *handle);
369 u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
370 int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
372 int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
373 const u8 *key, const u8 hfunc);
374 int (*set_rss_tuple)(struct hnae3_handle *handle,
375 struct ethtool_rxnfc *cmd);
376 int (*get_rss_tuple)(struct hnae3_handle *handle,
377 struct ethtool_rxnfc *cmd);
379 int (*get_tc_size)(struct hnae3_handle *handle);
381 int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
382 struct hnae3_vector_info *vector_info);
383 int (*put_vector)(struct hnae3_handle *handle, int vector_num);
384 int (*map_ring_to_vector)(struct hnae3_handle *handle,
386 struct hnae3_ring_chain_node *vr_chain);
387 int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
389 struct hnae3_ring_chain_node *vr_chain);
391 void (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
392 u32 (*get_fw_version)(struct hnae3_handle *handle);
393 void (*get_mdix_mode)(struct hnae3_handle *handle,
394 u8 *tp_mdix_ctrl, u8 *tp_mdix);
396 void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
397 int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
398 u16 vlan_id, bool is_kill);
399 int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
400 u16 vlan, u8 qos, __be16 proto);
401 int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
402 void (*reset_event)(struct hnae3_handle *handle);
403 void (*get_channels)(struct hnae3_handle *handle,
404 struct ethtool_channels *ch);
405 void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
406 u16 *alloc_tqps, u16 *max_rss_size);
407 int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num);
408 void (*get_flowctrl_adv)(struct hnae3_handle *handle,
410 int (*set_led_id)(struct hnae3_handle *handle,
411 enum ethtool_phys_id_state status);
412 void (*get_link_mode)(struct hnae3_handle *handle,
413 unsigned long *supported,
414 unsigned long *advertising);
417 struct hnae3_dcb_ops {
418 /* IEEE 802.1Qaz std */
419 int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
420 int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
421 int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
422 int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
424 /* DCBX configuration */
425 u8 (*getdcbx)(struct hnae3_handle *);
426 u8 (*setdcbx)(struct hnae3_handle *, u8);
428 int (*map_update)(struct hnae3_handle *);
429 int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
432 struct hnae3_ae_algo {
433 const struct hnae3_ae_ops *ops;
434 struct list_head node;
435 const struct pci_device_id *pdev_id_table;
438 #define HNAE3_INT_NAME_LEN (IFNAMSIZ + 16)
439 #define HNAE3_ITR_COUNTDOWN_START 100
441 struct hnae3_tc_info {
442 u16 tqp_offset; /* TQP offset from base TQP */
443 u16 tqp_count; /* Total TQPs */
444 u8 tc; /* TC index */
445 bool enable; /* If this TC is enable or not */
448 #define HNAE3_MAX_TC 8
449 #define HNAE3_MAX_USER_PRIO 8
450 struct hnae3_knic_private_info {
451 struct net_device *netdev; /* Set by KNIC client when init instance */
452 u16 rss_size; /* Allocated RSS queues */
456 u8 num_tc; /* Total number of enabled TCs */
457 u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
458 struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
460 u16 num_tqps; /* total number of TQPs in this handle */
461 struct hnae3_queue **tqp; /* array base of all TQPs in this instance */
462 const struct hnae3_dcb_ops *dcb_ops;
467 struct hnae3_roce_private_info {
468 struct net_device *netdev;
469 void __iomem *roce_io_base;
474 struct hnae3_unic_private_info {
475 struct net_device *netdev;
478 u16 num_tqps; /* total number of tqps in this handle */
479 struct hnae3_queue **tqp; /* array base of all TQPs of this instance */
482 #define HNAE3_SUPPORT_APP_LOOPBACK BIT(0)
483 #define HNAE3_SUPPORT_PHY_LOOPBACK BIT(1)
484 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK BIT(2)
485 #define HNAE3_SUPPORT_VF BIT(3)
486 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK BIT(4)
488 struct hnae3_handle {
489 struct hnae3_client *client;
490 struct pci_dev *pdev;
492 struct hnae3_ae_algo *ae_algo; /* the class who provides this handle */
493 u64 flags; /* Indicate the capabilities for this handle*/
495 unsigned long last_reset_time;
496 enum hnae3_reset_type reset_level;
499 struct net_device *netdev; /* first member */
500 struct hnae3_knic_private_info kinfo;
501 struct hnae3_unic_private_info uinfo;
502 struct hnae3_roce_private_info rinfo;
505 u32 numa_node_mask; /* for multi-chip support */
508 #define hnae3_set_field(origin, mask, shift, val) \
510 (origin) &= (~(mask)); \
511 (origin) |= ((val) << (shift)) & (mask); \
513 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
515 #define hnae3_set_bit(origin, shift, val) \
516 hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
517 #define hnae3_get_bit(origin, shift) \
518 hnae3_get_field((origin), (0x1 << (shift)), (shift))
520 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
521 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
523 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
524 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
526 void hnae3_unregister_client(struct hnae3_client *client);
527 int hnae3_register_client(struct hnae3_client *client);
529 void hnae3_set_client_init_flag(struct hnae3_client *client,
530 struct hnae3_ae_dev *ae_dev, int inited);