net: hns3: Add support for rule add/delete for flow director
[linux-2.6-microblaze.git] / drivers / net / ethernet / hisilicon / hns3 / hnae3.h
1 // SPDX-License-Identifier: GPL-2.0+
2 // Copyright (c) 2016-2017 Hisilicon Limited.
3
4 #ifndef __HNAE3_H
5 #define __HNAE3_H
6
7 /* Names used in this framework:
8  *      ae handle (handle):
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
12  *      ring:
13  *        a tx or rx channel within a rbq
14  *      ring description (desc):
15  *        an element in the ring with packet information
16  *      buffer:
17  *        a memory region referred by desc with the full packet payload
18  *
19  * "num" means a static number set as a parameter, "count" mean a dynamic
20  *   number set while running
21  * "cb" means control block
22  */
23
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>
32
33 #define HNAE3_MOD_VERSION "1.0"
34
35 /* Device IDs */
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
45
46 #define HNAE3_CLASS_NAME_SIZE 16
47
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
55
56 #define HNAE3_DEV_SUPPORT_ROCE_DCB_BITS (BIT(HNAE3_DEV_SUPPORT_DCB_B) |\
57                 BIT(HNAE3_DEV_SUPPORT_ROCE_B))
58
59 #define hnae3_dev_roce_supported(hdev) \
60         hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_ROCE_B)
61
62 #define hnae3_dev_dcb_supported(hdev) \
63         hnae3_get_bit(hdev->ae_dev->flag, HNAE3_DEV_SUPPORT_DCB_B)
64
65 #define hnae3_dev_fd_supported(hdev) \
66         hnae3_get_bit((hdev)->ae_dev->flag, HNAE3_DEV_SUPPORT_FD_B)
67
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)
72
73 enum hns_desc_type {
74         DESC_TYPE_SKB,
75         DESC_TYPE_PAGE,
76 };
77
78 struct hnae3_handle;
79
80 struct hnae3_queue {
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 */
87 };
88
89 /*hnae3 loop mode*/
90 enum hnae3_loop {
91         HNAE3_LOOP_APP,
92         HNAE3_LOOP_SERIAL_SERDES,
93         HNAE3_LOOP_PARALLEL_SERDES,
94         HNAE3_LOOP_PHY,
95         HNAE3_LOOP_NONE,
96 };
97
98 enum hnae3_client_type {
99         HNAE3_CLIENT_KNIC,
100         HNAE3_CLIENT_UNIC,
101         HNAE3_CLIENT_ROCE,
102 };
103
104 enum hnae3_dev_type {
105         HNAE3_DEV_KNIC,
106         HNAE3_DEV_UNIC,
107 };
108
109 /* mac media 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,
116 };
117
118 enum hnae3_reset_notify_type {
119         HNAE3_UP_CLIENT,
120         HNAE3_DOWN_CLIENT,
121         HNAE3_INIT_CLIENT,
122         HNAE3_UNINIT_CLIENT,
123 };
124
125 enum hnae3_reset_type {
126         HNAE3_VF_RESET,
127         HNAE3_VF_FULL_RESET,
128         HNAE3_FUNC_RESET,
129         HNAE3_CORE_RESET,
130         HNAE3_GLOBAL_RESET,
131         HNAE3_IMP_RESET,
132         HNAE3_NONE_RESET,
133 };
134
135 struct hnae3_vector_info {
136         u8 __iomem *io_addr;
137         int vector;
138 };
139
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
147
148 struct hnae3_ring_chain_node {
149         struct hnae3_ring_chain_node *next;
150         u32 tqp_index;
151         u32 flag;
152         u32 int_gl_idx;
153 };
154
155 #define HNAE3_IS_TX_RING(node) \
156         (((node)->flag & (1 << HNAE3_RING_TYPE_B)) == HNAE3_RING_TYPE_TX)
157
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);
165 };
166
167 #define HNAE3_CLIENT_NAME_LENGTH 16
168 struct hnae3_client {
169         char name[HNAE3_CLIENT_NAME_LENGTH];
170         unsigned long state;
171         enum hnae3_client_type type;
172         const struct hnae3_client_ops *ops;
173         struct list_head node;
174 };
175
176 struct hnae3_ae_dev {
177         struct pci_dev *pdev;
178         const struct hnae3_ae_ops *ops;
179         struct list_head node;
180         u32 flag;
181         enum hnae3_dev_type dev_type;
182         void *priv;
183 };
184
185 /* This struct defines the operation on the handle.
186  *
187  * init_ae_dev(): (mandatory)
188  *   Get PF configure from pci_dev and initialize PF hardware
189  * uninit_ae_dev()
190  *   Disable PF device and release PF resource
191  * register_client
192  *   Register client to ae_dev
193  * unregister_client()
194  *   Unregister client from ae_dev
195  * start()
196  *   Enable the hardware
197  * stop()
198  *   Disable the hardware
199  * get_status()
200  *   Get the carrier state of the back channel of the handle, 1 for ok, 0 for
201  *   non-ok
202  * get_ksettings_an_result()
203  *   Get negotiation status,speed and duplex
204  * update_speed_duplex_h()
205  *   Update hardware speed and duplex
206  * get_media_type()
207  *   Get media type of MAC
208  * adjust_link()
209  *   Adjust link status
210  * set_loopback()
211  *   Set loopback
212  * set_promisc_mode
213  *   Set promisc mode
214  * set_mtu()
215  *   set mtu
216  * get_pauseparam()
217  *   get tx and rx of pause frame use
218  * set_pauseparam()
219  *   set tx and rx of pause frame use
220  * set_autoneg()
221  *   set auto autonegotiation of pause frame use
222  * get_autoneg()
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.
232  * get_mac_addr()
233  *   get mac address
234  * set_mac_addr()
235  *   set mac address
236  * add_uc_addr
237  *   Add unicast addr to mac table
238  * rm_uc_addr
239  *   Remove unicast addr from mac table
240  * set_mc_addr()
241  *   Set multicast address
242  * add_mc_addr
243  *   Add multicast address to mac table
244  * rm_mc_addr
245  *   Remove multicast address from mac table
246  * update_stats()
247  *   Update Old network device statistics
248  * get_ethtool_stats()
249  *   Get ethtool network device statistics
250  * get_strings()
251  *   Get a set of strings that describe the requested objects
252  * get_sset_count()
253  *   Get number of strings that @get_strings will write
254  * update_led_status()
255  *   Update the led status
256  * set_led_id()
257  *   Set led id
258  * get_regs()
259  *   Get regs dump
260  * get_regs_len()
261  *   Get the len of the regs dump
262  * get_rss_key_size()
263  *   Get rss key size
264  * get_rss_indir_size()
265  *   Get rss indirection table size
266  * get_rss()
267  *   Get rss table
268  * set_rss()
269  *   Set rss table
270  * get_tc_size()
271  *   Get tc size of handle
272  * get_vector()
273  *   Get vector number and vector information
274  * put_vector()
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
280  * reset_queue()
281  *   Reset queue
282  * get_fw_version()
283  *   Get firmware version
284  * get_mdix_mode()
285  *   Get media typr of phy
286  * enable_vlan_filter()
287  *   Enable vlan filter
288  * set_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
294  */
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);
298
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);
308
309         int (*update_speed_duplex_h)(struct hnae3_handle *handle);
310         int (*cfg_mac_speed_dup_h)(struct hnae3_handle *handle, int speed,
311                                    u8 duplex);
312
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);
317
318         void (*set_promisc_mode)(struct hnae3_handle *handle, bool en_uc_pmc,
319                                  bool en_mc_pmc);
320         int (*set_mtu)(struct hnae3_handle *handle, int new_mtu);
321
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);
326
327         int (*set_autoneg)(struct hnae3_handle *handle, bool enable);
328         int (*get_autoneg)(struct hnae3_handle *handle);
329
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);
342
343         void (*get_mac_addr)(struct hnae3_handle *handle, u8 *p);
344         int (*set_mac_addr)(struct hnae3_handle *handle, void *p,
345                             bool is_first);
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);
358
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);
363
364         void (*get_strings)(struct hnae3_handle *handle,
365                             u32 stringset, u8 *data);
366         int (*get_sset_count)(struct hnae3_handle *handle, int stringset);
367
368         void (*get_regs)(struct hnae3_handle *handle, u32 *version,
369                          void *data);
370         int (*get_regs_len)(struct hnae3_handle *handle);
371
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,
375                        u8 *hfunc);
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);
382
383         int (*get_tc_size)(struct hnae3_handle *handle);
384
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,
389                                   int vector_num,
390                                   struct hnae3_ring_chain_node *vr_chain);
391         int (*unmap_ring_from_vector)(struct hnae3_handle *handle,
392                                       int vector_num,
393                                       struct hnae3_ring_chain_node *vr_chain);
394
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);
399
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,
413                                  u32 *flowctrl_adv);
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 };
424
425 struct hnae3_dcb_ops {
426         /* IEEE 802.1Qaz std */
427         int (*ieee_getets)(struct hnae3_handle *, struct ieee_ets *);
428         int (*ieee_setets)(struct hnae3_handle *, struct ieee_ets *);
429         int (*ieee_getpfc)(struct hnae3_handle *, struct ieee_pfc *);
430         int (*ieee_setpfc)(struct hnae3_handle *, struct ieee_pfc *);
431
432         /* DCBX configuration */
433         u8   (*getdcbx)(struct hnae3_handle *);
434         u8   (*setdcbx)(struct hnae3_handle *, u8);
435
436         int (*map_update)(struct hnae3_handle *);
437         int (*setup_tc)(struct hnae3_handle *, u8, u8 *);
438 };
439
440 struct hnae3_ae_algo {
441         const struct hnae3_ae_ops *ops;
442         struct list_head node;
443         const struct pci_device_id *pdev_id_table;
444 };
445
446 #define HNAE3_INT_NAME_LEN        (IFNAMSIZ + 16)
447 #define HNAE3_ITR_COUNTDOWN_START 100
448
449 struct hnae3_tc_info {
450         u16     tqp_offset;     /* TQP offset from base TQP */
451         u16     tqp_count;      /* Total TQPs */
452         u8      tc;             /* TC index */
453         bool    enable;         /* If this TC is enable or not */
454 };
455
456 #define HNAE3_MAX_TC            8
457 #define HNAE3_MAX_USER_PRIO     8
458 struct hnae3_knic_private_info {
459         struct net_device *netdev; /* Set by KNIC client when init instance */
460         u16 rss_size;              /* Allocated RSS queues */
461         u16 rx_buf_len;
462         u16 num_desc;
463
464         u8 num_tc;                 /* Total number of enabled TCs */
465         u8 prio_tc[HNAE3_MAX_USER_PRIO];  /* TC indexed by prio */
466         struct hnae3_tc_info tc_info[HNAE3_MAX_TC]; /* Idx of array is HW TC */
467
468         u16 num_tqps;             /* total number of TQPs in this handle */
469         struct hnae3_queue **tqp;  /* array base of all TQPs in this instance */
470         const struct hnae3_dcb_ops *dcb_ops;
471
472         u16 int_rl_setting;
473 };
474
475 struct hnae3_roce_private_info {
476         struct net_device *netdev;
477         void __iomem *roce_io_base;
478         int base_vector;
479         int num_vectors;
480 };
481
482 struct hnae3_unic_private_info {
483         struct net_device *netdev;
484         u16 rx_buf_len;
485         u16 num_desc;
486         u16 num_tqps;   /* total number of tqps in this handle */
487         struct hnae3_queue **tqp;  /* array base of all TQPs of this instance */
488 };
489
490 #define HNAE3_SUPPORT_APP_LOOPBACK    BIT(0)
491 #define HNAE3_SUPPORT_PHY_LOOPBACK    BIT(1)
492 #define HNAE3_SUPPORT_SERDES_SERIAL_LOOPBACK    BIT(2)
493 #define HNAE3_SUPPORT_VF              BIT(3)
494 #define HNAE3_SUPPORT_SERDES_PARALLEL_LOOPBACK  BIT(4)
495
496 struct hnae3_handle {
497         struct hnae3_client *client;
498         struct pci_dev *pdev;
499         void *priv;
500         struct hnae3_ae_algo *ae_algo;  /* the class who provides this handle */
501         u64 flags; /* Indicate the capabilities for this handle*/
502
503         unsigned long last_reset_time;
504         enum hnae3_reset_type reset_level;
505
506         union {
507                 struct net_device *netdev; /* first member */
508                 struct hnae3_knic_private_info kinfo;
509                 struct hnae3_unic_private_info uinfo;
510                 struct hnae3_roce_private_info rinfo;
511         };
512
513         u32 numa_node_mask;     /* for multi-chip support */
514 };
515
516 #define hnae3_set_field(origin, mask, shift, val) \
517         do { \
518                 (origin) &= (~(mask)); \
519                 (origin) |= ((val) << (shift)) & (mask); \
520         } while (0)
521 #define hnae3_get_field(origin, mask, shift) (((origin) & (mask)) >> (shift))
522
523 #define hnae3_set_bit(origin, shift, val) \
524         hnae3_set_field((origin), (0x1 << (shift)), (shift), (val))
525 #define hnae3_get_bit(origin, shift) \
526         hnae3_get_field((origin), (0x1 << (shift)), (shift))
527
528 void hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);
529 void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);
530
531 void hnae3_unregister_ae_algo(struct hnae3_ae_algo *ae_algo);
532 void hnae3_register_ae_algo(struct hnae3_ae_algo *ae_algo);
533
534 void hnae3_unregister_client(struct hnae3_client *client);
535 int hnae3_register_client(struct hnae3_client *client);
536
537 void hnae3_set_client_init_flag(struct hnae3_client *client,
538                                 struct hnae3_ae_dev *ae_dev, int inited);
539 #endif