2 * Copyright (c) 2014-2015 Hisilicon Limited.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
13 /* Names used in this framework:
15 * a set of queues provided by AE
16 * ring buffer queue (rbq):
17 * the channel between upper layer and the AE, can do tx and rx
19 * a tx or rx channel within a rbq
20 * ring description (desc):
21 * an element in the ring with packet information
23 * a memory region referred by desc with the full packet payload
25 * "num" means a static number set as a parameter, "count" mean a dynamic
26 * number set while running
27 * "cb" means control block
30 #include <linux/acpi.h>
31 #include <linux/delay.h>
32 #include <linux/device.h>
33 #include <linux/module.h>
34 #include <linux/netdevice.h>
35 #include <linux/notifier.h>
36 #include <linux/phy.h>
37 #include <linux/types.h>
39 #define HNAE_DRIVER_VERSION "2.0"
40 #define HNAE_DRIVER_NAME "hns"
41 #define HNAE_COPYRIGHT "Copyright(c) 2015 Huawei Corporation."
42 #define HNAE_DRIVER_STRING "Hisilicon Network Subsystem Driver"
43 #define HNAE_DEFAULT_DEVICE_DESCR "Hisilicon Network Subsystem"
48 #define assert(expr) \
51 pr_err("Assertion failed! %s, %s, %s, line %d\n", \
52 #expr, __FILE__, __func__, __LINE__); \
65 #define AE_VERSION_1 ('6' << 16 | '6' << 8 | '0')
66 #define AE_VERSION_2 ('1' << 24 | '6' << 16 | '1' << 8 | '0')
67 #define AE_IS_VER1(ver) ((ver) == AE_VERSION_1)
68 #define AE_NAME_SIZE 16
70 #define BD_SIZE_2048_MAX_MTU 6000
72 /* some said the RX and TX RCB format should not be the same in the future. But
73 * it is the same now...
75 #define RCB_REG_BASEADDR_L 0x00 /* P660 support only 32bit accessing */
76 #define RCB_REG_BASEADDR_H 0x04
77 #define RCB_REG_BD_NUM 0x08
78 #define RCB_REG_BD_LEN 0x0C
79 #define RCB_REG_PKTLINE 0x10
80 #define RCB_REG_TAIL 0x18
81 #define RCB_REG_HEAD 0x1C
82 #define RCB_REG_FBDNUM 0x20
83 #define RCB_REG_OFFSET 0x24 /* pkt num to be handled */
84 #define RCB_REG_PKTNUM_RECORD 0x2C /* total pkt received */
86 #define HNS_RX_HEAD_SIZE 256
88 #define HNAE_AE_REGISTER 0x1
90 #define RCB_RING_NAME_LEN (IFNAMSIZ + 4)
92 #define HNAE_LOWEST_LATENCY_COAL_PARAM 30
93 #define HNAE_LOW_LATENCY_COAL_PARAM 80
94 #define HNAE_BULK_LATENCY_COAL_PARAM 150
103 #define HNS_RX_FLAG_VLAN_PRESENT 0x1
104 #define HNS_RX_FLAG_L3ID_IPV4 0x0
105 #define HNS_RX_FLAG_L3ID_IPV6 0x1
106 #define HNS_RX_FLAG_L4ID_UDP 0x0
107 #define HNS_RX_FLAG_L4ID_TCP 0x1
108 #define HNS_RX_FLAG_L4ID_SCTP 0x3
110 #define HNS_TXD_ASID_S 0
111 #define HNS_TXD_ASID_M (0xff << HNS_TXD_ASID_S)
112 #define HNS_TXD_BUFNUM_S 8
113 #define HNS_TXD_BUFNUM_M (0x3 << HNS_TXD_BUFNUM_S)
114 #define HNS_TXD_PORTID_S 10
115 #define HNS_TXD_PORTID_M (0x7 << HNS_TXD_PORTID_S)
117 #define HNS_TXD_RA_B 8
118 #define HNS_TXD_RI_B 9
119 #define HNS_TXD_L4CS_B 10
120 #define HNS_TXD_L3CS_B 11
121 #define HNS_TXD_FE_B 12
122 #define HNS_TXD_VLD_B 13
123 #define HNS_TXD_IPOFFSET_S 14
124 #define HNS_TXD_IPOFFSET_M (0xff << HNS_TXD_IPOFFSET_S)
126 #define HNS_RXD_IPOFFSET_S 0
127 #define HNS_RXD_IPOFFSET_M (0xff << HNS_TXD_IPOFFSET_S)
128 #define HNS_RXD_BUFNUM_S 8
129 #define HNS_RXD_BUFNUM_M (0x3 << HNS_RXD_BUFNUM_S)
130 #define HNS_RXD_PORTID_S 10
131 #define HNS_RXD_PORTID_M (0x7 << HNS_RXD_PORTID_S)
132 #define HNS_RXD_DMAC_S 13
133 #define HNS_RXD_DMAC_M (0x3 << HNS_RXD_DMAC_S)
134 #define HNS_RXD_VLAN_S 15
135 #define HNS_RXD_VLAN_M (0x3 << HNS_RXD_VLAN_S)
136 #define HNS_RXD_L3ID_S 17
137 #define HNS_RXD_L3ID_M (0xf << HNS_RXD_L3ID_S)
138 #define HNS_RXD_L4ID_S 21
139 #define HNS_RXD_L4ID_M (0xf << HNS_RXD_L4ID_S)
140 #define HNS_RXD_FE_B 25
141 #define HNS_RXD_FRAG_B 26
142 #define HNS_RXD_VLD_B 27
143 #define HNS_RXD_L2E_B 28
144 #define HNS_RXD_L3E_B 29
145 #define HNS_RXD_L4E_B 30
146 #define HNS_RXD_DROP_B 31
148 #define HNS_RXD_VLANID_S 8
149 #define HNS_RXD_VLANID_M (0xfff << HNS_RXD_VLANID_S)
150 #define HNS_RXD_CFI_B 20
151 #define HNS_RXD_PRI_S 21
152 #define HNS_RXD_PRI_M (0x7 << HNS_RXD_PRI_S)
153 #define HNS_RXD_ASID_S 24
154 #define HNS_RXD_ASID_M (0xff << HNS_RXD_ASID_S)
156 #define HNSV2_TXD_BUFNUM_S 0
157 #define HNSV2_TXD_BUFNUM_M (0x7 << HNSV2_TXD_BUFNUM_S)
158 #define HNSV2_TXD_PORTID_S 4
159 #define HNSV2_TXD_PORTID_M (0X7 << HNSV2_TXD_PORTID_S)
160 #define HNSV2_TXD_RI_B 1
161 #define HNSV2_TXD_L4CS_B 2
162 #define HNSV2_TXD_L3CS_B 3
163 #define HNSV2_TXD_FE_B 4
164 #define HNSV2_TXD_VLD_B 5
166 #define HNSV2_TXD_TSE_B 0
167 #define HNSV2_TXD_VLAN_EN_B 1
168 #define HNSV2_TXD_SNAP_B 2
169 #define HNSV2_TXD_IPV6_B 3
170 #define HNSV2_TXD_SCTP_B 4
172 /* hardware spec ring buffer format */
173 struct __packed hnae_desc {
178 __le16 asid_bufnum_pid;
183 __le32 flag_ipoffset;
186 __u8 ra_ri_cs_fe_vld;
188 __u8 tse_vlan_snap_v6_sctp_nth;
201 __le32 ipoff_bnum_pid_flag;
205 __le32 vlan_pri_asid;
212 __le32 reserved_1[2];
217 struct hnae_desc_cb {
218 dma_addr_t dma; /* dma address of this desc */
219 void *buf; /* cpu addr for a desc */
221 /* priv data for the desc, e.g. skb when use with ip stack*/
224 u32 length; /* length of the buffer */
228 /* desc type, used by the ring user to mark the type of the priv data */
232 #define setflags(flags, bits) ((flags) |= (bits))
233 #define unsetflags(flags, bits) ((flags) &= ~(bits))
235 /* hnae_ring->flags fields */
236 #define RINGF_DIR 0x1 /* TX or RX ring, set if TX */
237 #define is_tx_ring(ring) ((ring)->flags & RINGF_DIR)
238 #define is_rx_ring(ring) (!is_tx_ring(ring))
239 #define ring_to_dma_dir(ring) (is_tx_ring(ring) ? \
240 DMA_TO_DEVICE : DMA_FROM_DEVICE)
271 u8 __iomem *io_base; /* base io address for the ring */
272 struct hnae_desc *desc; /* dma map address space */
273 struct hnae_desc_cb *desc_cb;
274 struct hnae_queue *q;
276 char ring_name[RCB_RING_NAME_LEN];
279 struct ring_stats stats;
281 /* ring lock for poll one */
284 dma_addr_t desc_dma_addr;
285 u32 buf_size; /* size for hnae_desc->addr, preset by AE */
286 u16 desc_num; /* total number of desc */
287 u16 max_desc_num_per_pkt;
288 u16 max_raw_data_sz_per_desc;
290 int next_to_use; /* idx of next spare desc */
292 /* idx of lastest sent desc, the ring is empty when equal to
297 int flags; /* ring attribute */
300 /* total rx bytes after last rx rate calucated */
301 u64 coal_last_rx_bytes;
302 unsigned long coal_last_jiffies;
304 u32 coal_rx_rate; /* rx rate in MB */
307 #define ring_ptr_move_fw(ring, p) \
308 ((ring)->p = ((ring)->p + 1) % (ring)->desc_num)
309 #define ring_ptr_move_bw(ring, p) \
310 ((ring)->p = ((ring)->p - 1 + (ring)->desc_num) % (ring)->desc_num)
317 #define assert_is_ring_idx(ring, idx) \
318 assert((idx) >= 0 && (idx) < (ring)->desc_num)
320 /* the distance between [begin, end) in a ring buffer
321 * note: there is a unuse slot between the begin and the end
323 static inline int ring_dist(struct hnae_ring *ring, int begin, int end)
325 assert_is_ring_idx(ring, begin);
326 assert_is_ring_idx(ring, end);
328 return (end - begin + ring->desc_num) % ring->desc_num;
331 static inline int ring_space(struct hnae_ring *ring)
333 return ring->desc_num -
334 ring_dist(ring, ring->next_to_clean, ring->next_to_use) - 1;
337 static inline int is_ring_empty(struct hnae_ring *ring)
339 assert_is_ring_idx(ring, ring->next_to_use);
340 assert_is_ring_idx(ring, ring->next_to_clean);
342 return ring->next_to_use == ring->next_to_clean;
345 #define hnae_buf_size(_ring) ((_ring)->buf_size)
346 #define hnae_page_order(_ring) (get_order(hnae_buf_size(_ring)))
347 #define hnae_page_size(_ring) (PAGE_SIZE << hnae_page_order(_ring))
351 /* allocate and dma map space for hnae desc */
352 struct hnae_buf_ops {
353 int (*alloc_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb);
354 void (*free_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb);
355 int (*map_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb);
356 void (*unmap_buffer)(struct hnae_ring *ring, struct hnae_desc_cb *cb);
360 void __iomem *io_base;
361 phys_addr_t phy_base;
362 struct hnae_ae_dev *dev; /* the device who use this queue */
363 struct hnae_ring rx_ring ____cacheline_internodealigned_in_smp;
364 struct hnae_ring tx_ring ____cacheline_internodealigned_in_smp;
365 struct hnae_handle *handle;
370 MAC_INTERNALLOOP_MAC = 0,
371 MAC_INTERNALLOOP_SERDES,
372 MAC_INTERNALLOOP_PHY,
378 enum hnae_port_type {
379 HNAE_PORT_SERVICE = 0,
384 enum hnae_media_type {
385 HNAE_MEDIA_TYPE_UNKNOWN = 0,
386 HNAE_MEDIA_TYPE_FIBER,
387 HNAE_MEDIA_TYPE_COPPER,
388 HNAE_MEDIA_TYPE_BACKPLANE,
391 /* This struct defines the operation on the handle.
393 * get_handle(): (mandatory)
394 * Get a handle from AE according to its name and options.
395 * the AE driver should manage the space used by handle and its queues while
396 * the HNAE framework will allocate desc and desc_cb for all rings in the
399 * Release the handle.
401 * Enable the hardware, include all queues
403 * Disable the hardware
404 * set_opts(): (mandatory)
405 * Set options to the AE
406 * get_opts(): (mandatory)
407 * Get options from the AE
409 * Get the carrier state of the back channel of the handle, 1 for ok, 0 for
411 * toggle_ring_irq(): (mandatory)
412 * Set the ring irq to be enabled(0) or disable(1)
413 * toggle_queue_status(): (mandatory)
414 * Set the queue to be enabled(1) or disable(0), this will not change the
420 * get_ring_bdnum_limit()
421 * get ring bd number limit
423 * get tx and rx of pause frame use
425 * set auto autonegotiation of pause frame use
427 * get auto autonegotiation of pause frame use
429 * set tx and rx of pause frame use
430 * get_coalesce_usecs()
431 * get usecs to delay a TX interrupt after a packet is sent
432 * get_rx_max_coalesced_frames()
433 * get Maximum number of packets to be sent before a TX interrupt.
434 * set_coalesce_usecs()
435 * set usecs to delay a TX interrupt after a packet is sent
436 * set_coalesce_frames()
437 * set Maximum number of packets to be sent before a TX interrupt.
439 * get RX/TX ring number
441 * get RX/TX ring maximum number
447 * clear mcast tcam table
453 * remove ucast address
457 * update Old network device statistics
458 * get_ethtool_stats()
459 * get ethtool network device statistics
461 * get a set of strings that describe the requested objects
463 * get number of strings that @get_strings will write
464 * update_led_status()
465 * update the led status
471 * get the len of the regs dump
474 struct hnae_handle *(*get_handle)(struct hnae_ae_dev *dev,
476 void (*put_handle)(struct hnae_handle *handle);
477 void (*init_queue)(struct hnae_queue *q);
478 void (*fini_queue)(struct hnae_queue *q);
479 int (*start)(struct hnae_handle *handle);
480 void (*stop)(struct hnae_handle *handle);
481 void (*reset)(struct hnae_handle *handle);
482 int (*set_opts)(struct hnae_handle *handle, int type, void *opts);
483 int (*get_opts)(struct hnae_handle *handle, int type, void **opts);
484 int (*get_status)(struct hnae_handle *handle);
485 int (*get_info)(struct hnae_handle *handle,
486 u8 *auto_neg, u16 *speed, u8 *duplex);
487 void (*toggle_ring_irq)(struct hnae_ring *ring, u32 val);
488 void (*adjust_link)(struct hnae_handle *handle, int speed, int duplex);
489 int (*set_loopback)(struct hnae_handle *handle,
490 enum hnae_loop loop_mode, int en);
491 void (*get_ring_bdnum_limit)(struct hnae_queue *queue,
493 void (*get_pauseparam)(struct hnae_handle *handle,
494 u32 *auto_neg, u32 *rx_en, u32 *tx_en);
495 int (*set_autoneg)(struct hnae_handle *handle, u8 enable);
496 int (*get_autoneg)(struct hnae_handle *handle);
497 int (*set_pauseparam)(struct hnae_handle *handle,
498 u32 auto_neg, u32 rx_en, u32 tx_en);
499 void (*get_coalesce_usecs)(struct hnae_handle *handle,
500 u32 *tx_usecs, u32 *rx_usecs);
501 void (*get_max_coalesced_frames)(struct hnae_handle *handle,
502 u32 *tx_frames, u32 *rx_frames);
503 int (*set_coalesce_usecs)(struct hnae_handle *handle, u32 timeout);
504 int (*set_coalesce_frames)(struct hnae_handle *handle,
505 u32 tx_frames, u32 rx_frames);
506 void (*get_coalesce_range)(struct hnae_handle *handle,
507 u32 *tx_frames_low, u32 *rx_frames_low,
508 u32 *tx_frames_high, u32 *rx_frames_high,
509 u32 *tx_usecs_low, u32 *rx_usecs_low,
510 u32 *tx_usecs_high, u32 *rx_usecs_high);
511 void (*set_promisc_mode)(struct hnae_handle *handle, u32 en);
512 int (*get_mac_addr)(struct hnae_handle *handle, void **p);
513 int (*set_mac_addr)(struct hnae_handle *handle, void *p);
514 int (*add_uc_addr)(struct hnae_handle *handle,
515 const unsigned char *addr);
516 int (*rm_uc_addr)(struct hnae_handle *handle,
517 const unsigned char *addr);
518 int (*clr_mc_addr)(struct hnae_handle *handle);
519 int (*set_mc_addr)(struct hnae_handle *handle, void *addr);
520 int (*set_mtu)(struct hnae_handle *handle, int new_mtu);
521 void (*set_tso_stats)(struct hnae_handle *handle, int enable);
522 void (*update_stats)(struct hnae_handle *handle,
523 struct net_device_stats *net_stats);
524 void (*get_stats)(struct hnae_handle *handle, u64 *data);
525 void (*get_strings)(struct hnae_handle *handle,
526 u32 stringset, u8 *data);
527 int (*get_sset_count)(struct hnae_handle *handle, int stringset);
528 void (*update_led_status)(struct hnae_handle *handle);
529 int (*set_led_id)(struct hnae_handle *handle,
530 enum hnae_led_state status);
531 void (*get_regs)(struct hnae_handle *handle, void *data);
532 int (*get_regs_len)(struct hnae_handle *handle);
533 u32 (*get_rss_key_size)(struct hnae_handle *handle);
534 u32 (*get_rss_indir_size)(struct hnae_handle *handle);
535 int (*get_rss)(struct hnae_handle *handle, u32 *indir, u8 *key,
537 int (*set_rss)(struct hnae_handle *handle, const u32 *indir,
538 const u8 *key, const u8 hfunc);
542 struct device cls_dev; /* the class dev */
543 struct device *dev; /* the presented dev */
544 struct hnae_ae_ops *ops;
545 struct list_head node;
546 struct module *owner; /* the module who provides this dev */
548 char name[AE_NAME_SIZE];
549 struct list_head handle_list;
550 spinlock_t lock; /* lock to protect the handle_list */
554 struct device *owner_dev; /* the device which make use of this handle */
555 struct hnae_ae_dev *dev; /* the device who provides this handle */
556 struct phy_device *phy_dev;
557 phy_interface_t phy_if;
561 unsigned long coal_last_jiffies;
562 u32 coal_param; /* self adapt coalesce param */
563 /* the ring index of last ring that set coal param */
566 u32 dport_id; /* v2 tx bd should fill the dport_id */
568 enum hnae_port_type port_type;
569 enum hnae_media_type media_type;
570 struct list_head node; /* list to hnae_ae_dev->handle_list */
571 struct hnae_buf_ops *bops; /* operation for the buffer */
572 struct hnae_queue **qs; /* array base of all queues */
575 #define ring_to_dev(ring) ((ring)->q->dev->dev)
577 struct hnae_handle *hnae_get_handle(struct device *owner_dev,
578 const struct fwnode_handle *fwnode,
580 struct hnae_buf_ops *bops);
582 void hnae_put_handle(struct hnae_handle *handle);
583 int hnae_ae_register(struct hnae_ae_dev *dev, struct module *owner);
584 void hnae_ae_unregister(struct hnae_ae_dev *dev);
586 int hnae_register_notifier(struct notifier_block *nb);
587 void hnae_unregister_notifier(struct notifier_block *nb);
588 int hnae_reinit_handle(struct hnae_handle *handle);
590 #define hnae_queue_xmit(q, buf_num) writel_relaxed(buf_num, \
591 (q)->tx_ring.io_base + RCB_REG_TAIL)
597 static inline int hnae_reserve_buffer_map(struct hnae_ring *ring,
598 struct hnae_desc_cb *cb)
600 struct hnae_buf_ops *bops = ring->q->handle->bops;
603 ret = bops->alloc_buffer(ring, cb);
607 ret = bops->map_buffer(ring, cb);
614 bops->free_buffer(ring, cb);
619 static inline int hnae_alloc_buffer_attach(struct hnae_ring *ring, int i)
621 int ret = hnae_reserve_buffer_map(ring, &ring->desc_cb[i]);
626 ring->desc[i].addr = cpu_to_le64(ring->desc_cb[i].dma);
631 static inline void hnae_buffer_detach(struct hnae_ring *ring, int i)
633 ring->q->handle->bops->unmap_buffer(ring, &ring->desc_cb[i]);
634 ring->desc[i].addr = 0;
637 static inline void hnae_free_buffer_detach(struct hnae_ring *ring, int i)
639 struct hnae_buf_ops *bops = ring->q->handle->bops;
640 struct hnae_desc_cb *cb = &ring->desc_cb[i];
642 if (!ring->desc_cb[i].dma)
645 hnae_buffer_detach(ring, i);
646 bops->free_buffer(ring, cb);
649 /* detach a in-used buffer and replace with a reserved one */
650 static inline void hnae_replace_buffer(struct hnae_ring *ring, int i,
651 struct hnae_desc_cb *res_cb)
653 struct hnae_buf_ops *bops = ring->q->handle->bops;
655 bops->unmap_buffer(ring, &ring->desc_cb[i]);
656 ring->desc_cb[i] = *res_cb;
657 ring->desc[i].addr = cpu_to_le64(ring->desc_cb[i].dma);
658 ring->desc[i].rx.ipoff_bnum_pid_flag = 0;
661 static inline void hnae_reuse_buffer(struct hnae_ring *ring, int i)
663 ring->desc_cb[i].reuse_flag = 0;
664 ring->desc[i].addr = cpu_to_le64(ring->desc_cb[i].dma
665 + ring->desc_cb[i].page_offset);
666 ring->desc[i].rx.ipoff_bnum_pid_flag = 0;
669 /* when reinit buffer size, we should reinit buffer description */
670 static inline void hnae_reinit_all_ring_desc(struct hnae_handle *h)
673 struct hnae_ring *ring;
675 for (i = 0; i < h->q_num; i++) {
676 ring = &h->qs[i]->rx_ring;
677 for (j = 0; j < ring->desc_num; j++)
678 ring->desc[j].addr = cpu_to_le64(ring->desc_cb[j].dma);
681 wmb(); /* commit all data before submit */
684 /* when reinit buffer size, we should reinit page offset */
685 static inline void hnae_reinit_all_ring_page_off(struct hnae_handle *h)
688 struct hnae_ring *ring;
690 for (i = 0; i < h->q_num; i++) {
691 ring = &h->qs[i]->rx_ring;
692 for (j = 0; j < ring->desc_num; j++) {
693 ring->desc_cb[j].page_offset = 0;
694 if (ring->desc[j].addr !=
695 cpu_to_le64(ring->desc_cb[j].dma))
697 cpu_to_le64(ring->desc_cb[j].dma);
701 wmb(); /* commit all data before submit */
704 #define hnae_set_field(origin, mask, shift, val) \
706 (origin) &= (~(mask)); \
707 (origin) |= ((val) << (shift)) & (mask); \
710 #define hnae_set_bit(origin, shift, val) \
711 hnae_set_field((origin), (0x1 << (shift)), (shift), (val))
713 #define hnae_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
715 #define hnae_get_bit(origin, shift) \
716 hnae_get_field((origin), (0x1 << (shift)), (shift))