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;
185 /* This struct defines the operation on the handle.
187 * init_ae_dev(): (mandatory)
188 * Get PF configure from pci_dev and initialize PF hardware
190 * Disable PF device and release PF resource
192 * Register client to ae_dev
193 * unregister_client()
194 * Unregister client from ae_dev
196 * Enable the hardware
198 * Disable the hardware
200 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for
202 * get_ksettings_an_result()
203 * Get negotiation status,speed and duplex
204 * update_speed_duplex_h()
205 * Update hardware speed and duplex
207 * Get media type of MAC
217 * get tx and rx of pause frame use
219 * set tx and rx of pause frame use
221 * set auto autonegotiation of pause frame use
223 * get auto autonegotiation of pause frame use
224 * get_coalesce_usecs()
225 * get usecs to delay a TX interrupt after a packet is sent
226 * get_rx_max_coalesced_frames()
227 * get Maximum number of packets to be sent before a TX interrupt.
228 * set_coalesce_usecs()
229 * set usecs to delay a TX interrupt after a packet is sent
230 * set_coalesce_frames()
231 * set Maximum number of packets to be sent before a TX interrupt.
237 * Add unicast addr to mac table
239 * Remove unicast addr from mac table
241 * Set multicast address
243 * Add multicast address to mac table
245 * Remove multicast address from mac table
247 * Update Old network device statistics
248 * get_ethtool_stats()
249 * Get ethtool network device statistics
251 * Get a set of strings that describe the requested objects
253 * Get number of strings that @get_strings will write
254 * update_led_status()
255 * Update the led status
261 * Get the len of the regs dump
264 * get_rss_indir_size()
265 * Get rss indirection table size
271 * Get tc size of handle
273 * Get vector number and vector information
275 * Put the vector in hdev
276 * map_ring_to_vector()
277 * Map rings to vector
278 * unmap_ring_from_vector()
279 * Unmap rings from vector
283 * Get firmware version
285 * Get media typr of phy
286 * enable_vlan_filter()
289 * Set vlan filter config of Ports
290 * set_vf_vlan_filter()
291 * Set vlan filter config of vf
292 * enable_hw_strip_rxvtag()
293 * Enable/disable hardware strip vlan tag of packets received
295 struct hnae3_ae_ops {
296 int (*init_ae_dev)(struct hnae3_ae_dev *ae_dev);
297 void (*uninit_ae_dev)(struct hnae3_ae_dev *ae_dev);
299 int (*init_client_instance)(struct hnae3_client *client,
300 struct hnae3_ae_dev *ae_dev);
301 void (*uninit_client_instance)(struct hnae3_client *client,
302 struct hnae3_ae_dev *ae_dev);
303 int (*start)(struct hnae3_handle *handle);
304 void (*stop)(struct hnae3_handle *handle);
305 int (*get_status)(struct hnae3_handle *handle);
306 void (*get_ksettings_an_result)(struct hnae3_handle *handle,
307 u8 *auto_neg, u32 *speed, u8 *duplex);
309 int (*update_speed_duplex_h)(struct hnae3_handle *handle);
310 int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
313 void (*get_media_type)(struct hnae3_handle *handle, u8 *media_type);
314 void (*adjust_link)(struct hnae3_handle *handle, int speed, int duplex);
315 int (*set_loopback)(struct hnae3_handle *handle,
316 enum hnae3_loop loop_mode, bool en);
318 void (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
320 int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
322 void (*get_pauseparam)(struct hnae3_handle *handle,
323 u32 *auto_neg, u32 *rx_en, u32 *tx_en);
324 int (*set_pauseparam)(struct hnae3_handle *handle,
325 u32 auto_neg, u32 rx_en, u32 tx_en);
327 int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
328 int (*get_autoneg)(struct hnae3_handle *handle);
330 void (*get_coalesce_usecs)(struct hnae3_handle *handle,
331 u32 *tx_usecs, u32 *rx_usecs);
332 void (*get_rx_max_coalesced_frames)(struct hnae3_handle *handle,
333 u32 *tx_frames, u32 *rx_frames);
334 int (*set_coalesce_usecs)(struct hnae3_handle *handle, u32 timeout);
335 int (*set_coalesce_frames)(struct hnae3_handle *handle,
336 u32 coalesce_frames);
337 void (*get_coalesce_range)(struct hnae3_handle *handle,
338 u32 *tx_frames_low, u32 *rx_frames_low,
339 u32 *tx_frames_high, u32 *rx_frames_high,
340 u32 *tx_usecs_low, u32 *rx_usecs_low,
341 u32 *tx_usecs_high, u32 *rx_usecs_high);
343 void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
344 int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
346 int (*do_ioctl)(struct hnae3_handle *handle,
347 struct ifreq *ifr, int cmd);
348 int (*add_uc_addr)(struct hnae3_handle *handle,
349 const unsigned char *addr);
350 int (*rm_uc_addr)(struct hnae3_handle *handle,
351 const unsigned char *addr);
352 int (*set_mc_addr)(struct hnae3_handle *handle, void *addr);
353 int (*add_mc_addr)(struct hnae3_handle *handle,
354 const unsigned char *addr);
355 int (*rm_mc_addr)(struct hnae3_handle *handle,
356 const unsigned char *addr);
357 int (*update_mta_status)(struct hnae3_handle *handle);
359 void (*set_tso_stats)(struct hnae3_handle *handle, int enable);
360 void (*update_stats)(struct hnae3_handle *handle,
361 struct net_device_stats *net_stats);
362 void (*get_stats)(struct hnae3_handle *handle, u64 *data);
364 void (*get_strings)(struct hnae3_handle *handle,
365 u32 stringset, u8 *data);
366 int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
368 void (*get_regs)(struct hnae3_handle *handle, u32 *version,
370 int (*get_regs_len)(struct hnae3_handle *handle);
372 u32 (*get_rss_key_size)(struct hnae3_handle *handle);
373 u32 (*get_rss_indir_size)(struct hnae3_handle *handle);
374 int (*get_rss)(struct hnae3_handle *handle, u32 *indir, u8 *key,
376 int (*set_rss)(struct hnae3_handle *handle, const u32 *indir,
377 const u8 *key, const u8 hfunc);
378 int (*set_rss_tuple)(struct hnae3_handle *handle,
379 struct ethtool_rxnfc *cmd);
380 int (*get_rss_tuple)(struct hnae3_handle *handle,
381 struct ethtool_rxnfc *cmd);
383 int (*get_tc_size)(struct hnae3_handle *handle);
385 int (*get_vector)(struct hnae3_handle *handle, u16 vector_num,
386 struct hnae3_vector_info *vector_info);
387 int (*put_vector)(struct hnae3_handle *handle, int vector_num);
388 int (*map_ring_to_vector)(struct hnae3_handle *handle,
390 struct hnae3_ring_chain_node *vr_chain);
391 int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
393 struct hnae3_ring_chain_node *vr_chain);
395 void (*reset_queue)(struct hnae3_handle *handle, u16 queue_id);
396 u32 (*get_fw_version)(struct hnae3_handle *handle);
397 void (*get_mdix_mode)(struct hnae3_handle *handle,
398 u8 *tp_mdix_ctrl, u8 *tp_mdix);
400 void (*enable_vlan_filter)(struct hnae3_handle *handle, bool enable);
401 int (*set_vlan_filter)(struct hnae3_handle *handle, __be16 proto,
402 u16 vlan_id, bool is_kill);
403 int (*set_vf_vlan_filter)(struct hnae3_handle *handle, int vfid,
404 u16 vlan, u8 qos, __be16 proto);
405 int (*enable_hw_strip_rxvtag)(struct hnae3_handle *handle, bool enable);
406 void (*reset_event)(struct hnae3_handle *handle);
407 void (*get_channels)(struct hnae3_handle *handle,
408 struct ethtool_channels *ch);
409 void (*get_tqps_and_rss_info)(struct hnae3_handle *h,
410 u16 *alloc_tqps, u16 *max_rss_size);
411 int (*set_channels)(struct hnae3_handle *handle, u32 new_tqps_num);
412 void (*get_flowctrl_adv)(struct hnae3_handle *handle,
414 int (*set_led_id)(struct hnae3_handle *handle,
415 enum ethtool_phys_id_state status);
416 void (*get_link_mode)(struct hnae3_handle *handle,
417 unsigned long *supported,
418 unsigned long *advertising);
419 int (*add_fd_entry)(struct hnae3_handle *handle,
420 struct ethtool_rxnfc *cmd);
421 int (*del_fd_entry)(struct hnae3_handle *handle,
422 struct ethtool_rxnfc *cmd);
423 int (*get_fd_rule_cnt)(struct hnae3_handle *handle,
424 struct ethtool_rxnfc *cmd);
425 int (*get_fd_rule_info)(struct hnae3_handle *handle,
426 struct ethtool_rxnfc *cmd);
427 int (*get_fd_all_rules)(struct hnae3_handle *handle,
428 struct ethtool_rxnfc *cmd, u32 *rule_locs);
431 struct hnae3_dcb_ops {
432 /* IEEE 802.1Qaz std */
433 int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
434 int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
435 int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
436 int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
438 /* DCBX configuration */
439 u8 (*getdcbx)(struct hnae3_handle *);
440 u8 (*setdcbx)(struct hnae3_handle *, u8);
442 int (*map_update)(struct hnae3_handle *);
443 int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
446 struct hnae3_ae_algo {
447 const struct hnae3_ae_ops *ops;
448 struct list_head node;
449 const struct pci_device_id *pdev_id_table;
452 #define HNAE3_INT_NAME_LEN (IFNAMSIZ + 16)
453 #define HNAE3_ITR_COUNTDOWN_START 100
455 struct hnae3_tc_info {
456 u16 tqp_offset; /* TQP offset from base TQP */
457 u16 tqp_count; /* Total TQPs */
458 u8 tc; /* TC index */
459 bool enable; /* If this TC is enable or not */
462 #define HNAE3_MAX_TC 8
463 #define HNAE3_MAX_USER_PRIO 8
464 struct hnae3_knic_private_info {
465 struct net_device *netdev; /* Set by KNIC client when init instance */
466 u16 rss_size; /* Allocated RSS queues */
470 u8 num_tc; /* Total number of enabled TCs */
471 u8 prio_tc[HNAE3_MAX_USER_PRIO]; /* TC indexed by prio */
472 struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
474 u16 num_tqps; /* total number of TQPs in this handle */
475 struct hnae3_queue **tqp; /* array base of all TQPs in this instance */
476 const struct hnae3_dcb_ops *dcb_ops;
481 struct hnae3_roce_private_info {
482 struct net_device *netdev;
483 void __iomem *roce_io_base;
488 struct hnae3_unic_private_info {
489 struct net_device *netdev;
492 u16 num_tqps; /* total number of tqps in this handle */
493 struct hnae3_queue **tqp; /* array base of all TQPs of this instance */
496 #define HNAE3_SUPPORT_APP_LOOPBACK BIT(0)
497 #define HNAE3_SUPPORT_PHY_LOOPBACK BIT(1)
498 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK BIT(2)
499 #define HNAE3_SUPPORT_VF BIT(3)
500 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK BIT(4)
502 struct hnae3_handle {
503 struct hnae3_client *client;
504 struct pci_dev *pdev;
506 struct hnae3_ae_algo *ae_algo; /* the class who provides this handle */
507 u64 flags; /* Indicate the capabilities for this handle*/
509 unsigned long last_reset_time;
510 enum hnae3_reset_type reset_level;
513 struct net_device *netdev; /* first member */
514 struct hnae3_knic_private_info kinfo;
515 struct hnae3_unic_private_info uinfo;
516 struct hnae3_roce_private_info rinfo;
519 u32 numa_node_mask; /* for multi-chip support */
522 #define hnae3_set_field(origin, mask, shift, val) \
524 (origin) &= (~(mask)); \
525 (origin) |= ((val) << (shift)) & (mask); \
527 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
529 #define hnae3_set_bit(origin, shift, val) \
530 hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
531 #define hnae3_get_bit(origin, shift) \
532 hnae3_get_field((origin), (0x1 << (shift)), (shift))
534 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
535 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
537 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
538 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
540 void hnae3_unregister_client(struct hnae3_client *client);
541 int hnae3_register_client(struct hnae3_client *client);
543 void hnae3_set_client_init_flag(struct hnae3_client *client,
544 struct hnae3_ae_dev *ae_dev, int inited);