GNU Linux-libre 4.14.332-gnu1
[releases.git] / drivers / net / ethernet / cavium / thunder / nic.h
1 /*
2  * Copyright (C) 2015 Cavium, Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of version 2 of the GNU General Public License
6  * as published by the Free Software Foundation.
7  */
8
9 #ifndef NIC_H
10 #define NIC_H
11
12 #include <linux/netdevice.h>
13 #include <linux/interrupt.h>
14 #include <linux/pci.h>
15 #include "thunder_bgx.h"
16
17 /* PCI device IDs */
18 #define PCI_DEVICE_ID_THUNDER_NIC_PF            0xA01E
19 #define PCI_DEVICE_ID_THUNDER_PASS1_NIC_VF      0x0011
20 #define PCI_DEVICE_ID_THUNDER_NIC_VF            0xA034
21 #define PCI_DEVICE_ID_THUNDER_BGX               0xA026
22
23 /* Subsystem device IDs */
24 #define PCI_SUBSYS_DEVID_88XX_NIC_PF            0xA11E
25 #define PCI_SUBSYS_DEVID_81XX_NIC_PF            0xA21E
26 #define PCI_SUBSYS_DEVID_83XX_NIC_PF            0xA31E
27
28 #define PCI_SUBSYS_DEVID_88XX_PASS1_NIC_VF      0xA11E
29 #define PCI_SUBSYS_DEVID_88XX_NIC_VF            0xA134
30 #define PCI_SUBSYS_DEVID_81XX_NIC_VF            0xA234
31 #define PCI_SUBSYS_DEVID_83XX_NIC_VF            0xA334
32
33
34 /* PCI BAR nos */
35 #define PCI_CFG_REG_BAR_NUM             0
36 #define PCI_MSIX_REG_BAR_NUM            4
37
38 /* NIC SRIOV VF count */
39 #define MAX_NUM_VFS_SUPPORTED           128
40 #define DEFAULT_NUM_VF_ENABLED          8
41
42 #define NIC_TNS_BYPASS_MODE             0
43 #define NIC_TNS_MODE                    1
44
45 /* NIC priv flags */
46 #define NIC_SRIOV_ENABLED               BIT(0)
47
48 /* Min/Max packet size */
49 #define NIC_HW_MIN_FRS                  64
50 #define NIC_HW_MAX_FRS                  9190 /* Excluding L2 header and FCS */
51
52 /* Max pkinds */
53 #define NIC_MAX_PKIND                   16
54
55 /* Max when CPI_ALG is IP diffserv */
56 #define NIC_MAX_CPI_PER_LMAC            64
57
58 /* NIC VF Interrupts */
59 #define NICVF_INTR_CQ                   0
60 #define NICVF_INTR_SQ                   1
61 #define NICVF_INTR_RBDR                 2
62 #define NICVF_INTR_PKT_DROP             3
63 #define NICVF_INTR_TCP_TIMER            4
64 #define NICVF_INTR_MBOX                 5
65 #define NICVF_INTR_QS_ERR               6
66
67 #define NICVF_INTR_CQ_SHIFT             0
68 #define NICVF_INTR_SQ_SHIFT             8
69 #define NICVF_INTR_RBDR_SHIFT           16
70 #define NICVF_INTR_PKT_DROP_SHIFT       20
71 #define NICVF_INTR_TCP_TIMER_SHIFT      21
72 #define NICVF_INTR_MBOX_SHIFT           22
73 #define NICVF_INTR_QS_ERR_SHIFT         23
74
75 #define NICVF_INTR_CQ_MASK              (0xFF << NICVF_INTR_CQ_SHIFT)
76 #define NICVF_INTR_SQ_MASK              (0xFF << NICVF_INTR_SQ_SHIFT)
77 #define NICVF_INTR_RBDR_MASK            (0x03 << NICVF_INTR_RBDR_SHIFT)
78 #define NICVF_INTR_PKT_DROP_MASK        BIT(NICVF_INTR_PKT_DROP_SHIFT)
79 #define NICVF_INTR_TCP_TIMER_MASK       BIT(NICVF_INTR_TCP_TIMER_SHIFT)
80 #define NICVF_INTR_MBOX_MASK            BIT(NICVF_INTR_MBOX_SHIFT)
81 #define NICVF_INTR_QS_ERR_MASK          BIT(NICVF_INTR_QS_ERR_SHIFT)
82
83 /* MSI-X interrupts */
84 #define NIC_PF_MSIX_VECTORS             10
85 #define NIC_VF_MSIX_VECTORS             20
86
87 #define NIC_PF_INTR_ID_ECC0_SBE         0
88 #define NIC_PF_INTR_ID_ECC0_DBE         1
89 #define NIC_PF_INTR_ID_ECC1_SBE         2
90 #define NIC_PF_INTR_ID_ECC1_DBE         3
91 #define NIC_PF_INTR_ID_ECC2_SBE         4
92 #define NIC_PF_INTR_ID_ECC2_DBE         5
93 #define NIC_PF_INTR_ID_ECC3_SBE         6
94 #define NIC_PF_INTR_ID_ECC3_DBE         7
95 #define NIC_PF_INTR_ID_MBOX0            8
96 #define NIC_PF_INTR_ID_MBOX1            9
97
98 /* Minimum FIFO level before all packets for the CQ are dropped
99  *
100  * This value ensures that once a packet has been "accepted"
101  * for reception it will not get dropped due to non-availability
102  * of CQ descriptor. An errata in HW mandates this value to be
103  * atleast 0x100.
104  */
105 #define NICPF_CQM_MIN_DROP_LEVEL       0x100
106
107 /* Global timer for CQ timer thresh interrupts
108  * Calculated for SCLK of 700Mhz
109  * value written should be a 1/16th of what is expected
110  *
111  * 1 tick per 0.025usec
112  */
113 #define NICPF_CLK_PER_INT_TICK          1
114
115 /* Time to wait before we decide that a SQ is stuck.
116  *
117  * Since both pkt rx and tx notifications are done with same CQ,
118  * when packets are being received at very high rate (eg: L2 forwarding)
119  * then freeing transmitted skbs will be delayed and watchdog
120  * will kick in, resetting interface. Hence keeping this value high.
121  */
122 #define NICVF_TX_TIMEOUT                (50 * HZ)
123
124 struct nicvf_cq_poll {
125         struct  nicvf *nicvf;
126         u8      cq_idx;         /* Completion queue index */
127         struct  napi_struct napi;
128 };
129
130 #define NIC_MAX_RSS_HASH_BITS           8
131 #define NIC_MAX_RSS_IDR_TBL_SIZE        (1 << NIC_MAX_RSS_HASH_BITS)
132 #define RSS_HASH_KEY_SIZE               5 /* 320 bit key */
133
134 struct nicvf_rss_info {
135         bool enable;
136 #define RSS_L2_EXTENDED_HASH_ENA        BIT(0)
137 #define RSS_IP_HASH_ENA                 BIT(1)
138 #define RSS_TCP_HASH_ENA                BIT(2)
139 #define RSS_TCP_SYN_DIS                 BIT(3)
140 #define RSS_UDP_HASH_ENA                BIT(4)
141 #define RSS_L4_EXTENDED_HASH_ENA        BIT(5)
142 #define RSS_ROCE_ENA                    BIT(6)
143 #define RSS_L3_BI_DIRECTION_ENA         BIT(7)
144 #define RSS_L4_BI_DIRECTION_ENA         BIT(8)
145         u64 cfg;
146         u8  hash_bits;
147         u16 rss_size;
148         u8  ind_tbl[NIC_MAX_RSS_IDR_TBL_SIZE];
149         u64 key[RSS_HASH_KEY_SIZE];
150 } ____cacheline_aligned_in_smp;
151
152 struct nicvf_pfc {
153         u8    autoneg;
154         u8    fc_rx;
155         u8    fc_tx;
156 };
157
158 enum rx_stats_reg_offset {
159         RX_OCTS = 0x0,
160         RX_UCAST = 0x1,
161         RX_BCAST = 0x2,
162         RX_MCAST = 0x3,
163         RX_RED = 0x4,
164         RX_RED_OCTS = 0x5,
165         RX_ORUN = 0x6,
166         RX_ORUN_OCTS = 0x7,
167         RX_FCS = 0x8,
168         RX_L2ERR = 0x9,
169         RX_DRP_BCAST = 0xa,
170         RX_DRP_MCAST = 0xb,
171         RX_DRP_L3BCAST = 0xc,
172         RX_DRP_L3MCAST = 0xd,
173         RX_STATS_ENUM_LAST,
174 };
175
176 enum tx_stats_reg_offset {
177         TX_OCTS = 0x0,
178         TX_UCAST = 0x1,
179         TX_BCAST = 0x2,
180         TX_MCAST = 0x3,
181         TX_DROP = 0x4,
182         TX_STATS_ENUM_LAST,
183 };
184
185 struct nicvf_hw_stats {
186         u64 rx_bytes;
187         u64 rx_frames;
188         u64 rx_ucast_frames;
189         u64 rx_bcast_frames;
190         u64 rx_mcast_frames;
191         u64 rx_drops;
192         u64 rx_drop_red;
193         u64 rx_drop_red_bytes;
194         u64 rx_drop_overrun;
195         u64 rx_drop_overrun_bytes;
196         u64 rx_drop_bcast;
197         u64 rx_drop_mcast;
198         u64 rx_drop_l3_bcast;
199         u64 rx_drop_l3_mcast;
200         u64 rx_fcs_errors;
201         u64 rx_l2_errors;
202
203         u64 tx_bytes;
204         u64 tx_frames;
205         u64 tx_ucast_frames;
206         u64 tx_bcast_frames;
207         u64 tx_mcast_frames;
208         u64 tx_drops;
209 };
210
211 struct nicvf_drv_stats {
212         /* CQE Rx errs */
213         u64 rx_bgx_truncated_pkts;
214         u64 rx_jabber_errs;
215         u64 rx_fcs_errs;
216         u64 rx_bgx_errs;
217         u64 rx_prel2_errs;
218         u64 rx_l2_hdr_malformed;
219         u64 rx_oversize;
220         u64 rx_undersize;
221         u64 rx_l2_len_mismatch;
222         u64 rx_l2_pclp;
223         u64 rx_ip_ver_errs;
224         u64 rx_ip_csum_errs;
225         u64 rx_ip_hdr_malformed;
226         u64 rx_ip_payload_malformed;
227         u64 rx_ip_ttl_errs;
228         u64 rx_l3_pclp;
229         u64 rx_l4_malformed;
230         u64 rx_l4_csum_errs;
231         u64 rx_udp_len_errs;
232         u64 rx_l4_port_errs;
233         u64 rx_tcp_flag_errs;
234         u64 rx_tcp_offset_errs;
235         u64 rx_l4_pclp;
236         u64 rx_truncated_pkts;
237
238         /* CQE Tx errs */
239         u64 tx_desc_fault;
240         u64 tx_hdr_cons_err;
241         u64 tx_subdesc_err;
242         u64 tx_max_size_exceeded;
243         u64 tx_imm_size_oflow;
244         u64 tx_data_seq_err;
245         u64 tx_mem_seq_err;
246         u64 tx_lock_viol;
247         u64 tx_data_fault;
248         u64 tx_tstmp_conflict;
249         u64 tx_tstmp_timeout;
250         u64 tx_mem_fault;
251         u64 tx_csum_overlap;
252         u64 tx_csum_overflow;
253
254         /* driver debug stats */
255         u64 tx_tso;
256         u64 tx_timeout;
257         u64 txq_stop;
258         u64 txq_wake;
259
260         u64 rcv_buffer_alloc_failures;
261         u64 page_alloc;
262
263         struct u64_stats_sync   syncp;
264 };
265
266 struct nicvf {
267         struct nicvf            *pnicvf;
268         struct net_device       *netdev;
269         struct pci_dev          *pdev;
270         void __iomem            *reg_base;
271         struct bpf_prog         *xdp_prog;
272 #define MAX_QUEUES_PER_QSET                     8
273         struct queue_set        *qs;
274         void                    *iommu_domain;
275         u8                      vf_id;
276         u8                      sqs_id;
277         bool                    sqs_mode;
278         bool                    hw_tso;
279         bool                    t88;
280
281         /* Receive buffer alloc */
282         u32                     rb_page_offset;
283         u16                     rb_pageref;
284         bool                    rb_alloc_fail;
285         bool                    rb_work_scheduled;
286         struct page             *rb_page;
287         struct delayed_work     rbdr_work;
288         struct tasklet_struct   rbdr_task;
289
290         /* Secondary Qset */
291         u8                      sqs_count;
292 #define MAX_SQS_PER_VF_SINGLE_NODE              5
293 #define MAX_SQS_PER_VF                          11
294         struct nicvf            *snicvf[MAX_SQS_PER_VF];
295
296         /* Queue count */
297         u8                      rx_queues;
298         u8                      tx_queues;
299         u8                      xdp_tx_queues;
300         u8                      max_queues;
301
302         u8                      node;
303         u8                      cpi_alg;
304         bool                    link_up;
305         u8                      mac_type;
306         u8                      duplex;
307         u32                     speed;
308         bool                    tns_mode;
309         bool                    loopback_supported;
310         struct nicvf_rss_info   rss_info;
311         struct nicvf_pfc        pfc;
312         struct tasklet_struct   qs_err_task;
313         struct work_struct      reset_task;
314
315         /* Interrupt coalescing settings */
316         u32                     cq_coalesce_usecs;
317         u32                     msg_enable;
318
319         /* Stats */
320         struct nicvf_hw_stats   hw_stats;
321         struct nicvf_drv_stats  __percpu *drv_stats;
322         struct bgx_stats        bgx_stats;
323
324         /* Napi */
325         struct nicvf_cq_poll    *napi[8];
326
327         /* MSI-X  */
328         u8                      num_vec;
329         char                    irq_name[NIC_VF_MSIX_VECTORS][IFNAMSIZ + 15];
330         bool                    irq_allocated[NIC_VF_MSIX_VECTORS];
331         cpumask_var_t           affinity_mask[NIC_VF_MSIX_VECTORS];
332
333         /* VF <-> PF mailbox communication */
334         bool                    pf_acked;
335         bool                    pf_nacked;
336         bool                    set_mac_pending;
337 } ____cacheline_aligned_in_smp;
338
339 /* PF <--> VF Mailbox communication
340  * Eight 64bit registers are shared between PF and VF.
341  * Separate set for each VF.
342  * Writing '1' into last register mbx7 means end of message.
343  */
344
345 /* PF <--> VF mailbox communication */
346 #define NIC_PF_VF_MAILBOX_SIZE          2
347 #define NIC_MBOX_MSG_TIMEOUT            2000 /* ms */
348
349 /* Mailbox message types */
350 #define NIC_MBOX_MSG_READY              0x01    /* Is PF ready to rcv msgs */
351 #define NIC_MBOX_MSG_ACK                0x02    /* ACK the message received */
352 #define NIC_MBOX_MSG_NACK               0x03    /* NACK the message received */
353 #define NIC_MBOX_MSG_QS_CFG             0x04    /* Configure Qset */
354 #define NIC_MBOX_MSG_RQ_CFG             0x05    /* Configure receive queue */
355 #define NIC_MBOX_MSG_SQ_CFG             0x06    /* Configure Send queue */
356 #define NIC_MBOX_MSG_RQ_DROP_CFG        0x07    /* Configure receive queue */
357 #define NIC_MBOX_MSG_SET_MAC            0x08    /* Add MAC ID to DMAC filter */
358 #define NIC_MBOX_MSG_SET_MAX_FRS        0x09    /* Set max frame size */
359 #define NIC_MBOX_MSG_CPI_CFG            0x0A    /* Config CPI, RSSI */
360 #define NIC_MBOX_MSG_RSS_SIZE           0x0B    /* Get RSS indir_tbl size */
361 #define NIC_MBOX_MSG_RSS_CFG            0x0C    /* Config RSS table */
362 #define NIC_MBOX_MSG_RSS_CFG_CONT       0x0D    /* RSS config continuation */
363 #define NIC_MBOX_MSG_RQ_BP_CFG          0x0E    /* RQ backpressure config */
364 #define NIC_MBOX_MSG_RQ_SW_SYNC         0x0F    /* Flush inflight pkts to RQ */
365 #define NIC_MBOX_MSG_BGX_STATS          0x10    /* Get stats from BGX */
366 #define NIC_MBOX_MSG_BGX_LINK_CHANGE    0x11    /* BGX:LMAC link status */
367 #define NIC_MBOX_MSG_ALLOC_SQS          0x12    /* Allocate secondary Qset */
368 #define NIC_MBOX_MSG_NICVF_PTR          0x13    /* Send nicvf ptr to PF */
369 #define NIC_MBOX_MSG_PNICVF_PTR         0x14    /* Get primary qset nicvf ptr */
370 #define NIC_MBOX_MSG_SNICVF_PTR         0x15    /* Send sqet nicvf ptr to PVF */
371 #define NIC_MBOX_MSG_LOOPBACK           0x16    /* Set interface in loopback */
372 #define NIC_MBOX_MSG_RESET_STAT_COUNTER 0x17    /* Reset statistics counters */
373 #define NIC_MBOX_MSG_PFC                0x18    /* Pause frame control */
374 #define NIC_MBOX_MSG_CFG_DONE           0xF0    /* VF configuration done */
375 #define NIC_MBOX_MSG_SHUTDOWN           0xF1    /* VF is being shutdown */
376
377 struct nic_cfg_msg {
378         u8    msg;
379         u8    vf_id;
380         u8    node_id;
381         u8    tns_mode:1;
382         u8    sqs_mode:1;
383         u8    loopback_supported:1;
384         u8    mac_addr[ETH_ALEN];
385 };
386
387 /* Qset configuration */
388 struct qs_cfg_msg {
389         u8    msg;
390         u8    num;
391         u8    sqs_count;
392         u64   cfg;
393 };
394
395 /* Receive queue configuration */
396 struct rq_cfg_msg {
397         u8    msg;
398         u8    qs_num;
399         u8    rq_num;
400         u64   cfg;
401 };
402
403 /* Send queue configuration */
404 struct sq_cfg_msg {
405         u8    msg;
406         u8    qs_num;
407         u8    sq_num;
408         bool  sqs_mode;
409         u64   cfg;
410 };
411
412 /* Set VF's MAC address */
413 struct set_mac_msg {
414         u8    msg;
415         u8    vf_id;
416         u8    mac_addr[ETH_ALEN];
417 };
418
419 /* Set Maximum frame size */
420 struct set_frs_msg {
421         u8    msg;
422         u8    vf_id;
423         u16   max_frs;
424 };
425
426 /* Set CPI algorithm type */
427 struct cpi_cfg_msg {
428         u8    msg;
429         u8    vf_id;
430         u8    rq_cnt;
431         u8    cpi_alg;
432 };
433
434 /* Get RSS table size */
435 struct rss_sz_msg {
436         u8    msg;
437         u8    vf_id;
438         u16   ind_tbl_size;
439 };
440
441 /* Set RSS configuration */
442 struct rss_cfg_msg {
443         u8    msg;
444         u8    vf_id;
445         u8    hash_bits;
446         u8    tbl_len;
447         u8    tbl_offset;
448 #define RSS_IND_TBL_LEN_PER_MBX_MSG     8
449         u8    ind_tbl[RSS_IND_TBL_LEN_PER_MBX_MSG];
450 };
451
452 struct bgx_stats_msg {
453         u8    msg;
454         u8    vf_id;
455         u8    rx;
456         u8    idx;
457         u64   stats;
458 };
459
460 /* Physical interface link status */
461 struct bgx_link_status {
462         u8    msg;
463         u8    mac_type;
464         u8    link_up;
465         u8    duplex;
466         u32   speed;
467 };
468
469 /* Get Extra Qset IDs */
470 struct sqs_alloc {
471         u8    msg;
472         u8    vf_id;
473         u8    qs_count;
474 };
475
476 struct nicvf_ptr {
477         u8    msg;
478         u8    vf_id;
479         bool  sqs_mode;
480         u8    sqs_id;
481         u64   nicvf;
482 };
483
484 /* Set interface in loopback mode */
485 struct set_loopback {
486         u8    msg;
487         u8    vf_id;
488         bool  enable;
489 };
490
491 /* Reset statistics counters */
492 struct reset_stat_cfg {
493         u8    msg;
494         /* Bitmap to select NIC_PF_VNIC(vf_id)_RX_STAT(0..13) */
495         u16   rx_stat_mask;
496         /* Bitmap to select NIC_PF_VNIC(vf_id)_TX_STAT(0..4) */
497         u8    tx_stat_mask;
498         /* Bitmap to select NIC_PF_QS(0..127)_RQ(0..7)_STAT(0..1)
499          * bit14, bit15 NIC_PF_QS(vf_id)_RQ7_STAT(0..1)
500          * bit12, bit13 NIC_PF_QS(vf_id)_RQ6_STAT(0..1)
501          * ..
502          * bit2, bit3 NIC_PF_QS(vf_id)_RQ1_STAT(0..1)
503          * bit0, bit1 NIC_PF_QS(vf_id)_RQ0_STAT(0..1)
504          */
505         u16   rq_stat_mask;
506         /* Bitmap to select NIC_PF_QS(0..127)_SQ(0..7)_STAT(0..1)
507          * bit14, bit15 NIC_PF_QS(vf_id)_SQ7_STAT(0..1)
508          * bit12, bit13 NIC_PF_QS(vf_id)_SQ6_STAT(0..1)
509          * ..
510          * bit2, bit3 NIC_PF_QS(vf_id)_SQ1_STAT(0..1)
511          * bit0, bit1 NIC_PF_QS(vf_id)_SQ0_STAT(0..1)
512          */
513         u16   sq_stat_mask;
514 };
515
516 struct pfc {
517         u8    msg;
518         u8    get; /* Get or set PFC settings */
519         u8    autoneg;
520         u8    fc_rx;
521         u8    fc_tx;
522 };
523
524 /* 128 bit shared memory between PF and each VF */
525 union nic_mbx {
526         struct { u8 msg; }      msg;
527         struct nic_cfg_msg      nic_cfg;
528         struct qs_cfg_msg       qs;
529         struct rq_cfg_msg       rq;
530         struct sq_cfg_msg       sq;
531         struct set_mac_msg      mac;
532         struct set_frs_msg      frs;
533         struct cpi_cfg_msg      cpi_cfg;
534         struct rss_sz_msg       rss_size;
535         struct rss_cfg_msg      rss_cfg;
536         struct bgx_stats_msg    bgx_stats;
537         struct bgx_link_status  link_status;
538         struct sqs_alloc        sqs_alloc;
539         struct nicvf_ptr        nicvf;
540         struct set_loopback     lbk;
541         struct reset_stat_cfg   reset_stat;
542         struct pfc              pfc;
543 };
544
545 #define NIC_NODE_ID_MASK        0x03
546 #define NIC_NODE_ID_SHIFT       44
547
548 static inline int nic_get_node_id(struct pci_dev *pdev)
549 {
550         u64 addr = pci_resource_start(pdev, PCI_CFG_REG_BAR_NUM);
551         return ((addr >> NIC_NODE_ID_SHIFT) & NIC_NODE_ID_MASK);
552 }
553
554 static inline bool pass1_silicon(struct pci_dev *pdev)
555 {
556         return (pdev->revision < 8) &&
557                 (pdev->subsystem_device == PCI_SUBSYS_DEVID_88XX_NIC_PF);
558 }
559
560 static inline bool pass2_silicon(struct pci_dev *pdev)
561 {
562         return (pdev->revision >= 8) &&
563                 (pdev->subsystem_device == PCI_SUBSYS_DEVID_88XX_NIC_PF);
564 }
565
566 int nicvf_set_real_num_queues(struct net_device *netdev,
567                               int tx_queues, int rx_queues);
568 int nicvf_open(struct net_device *netdev);
569 int nicvf_stop(struct net_device *netdev);
570 int nicvf_send_msg_to_pf(struct nicvf *vf, union nic_mbx *mbx);
571 void nicvf_config_rss(struct nicvf *nic);
572 void nicvf_set_rss_key(struct nicvf *nic);
573 void nicvf_set_ethtool_ops(struct net_device *netdev);
574 void nicvf_update_stats(struct nicvf *nic);
575 void nicvf_update_lmac_stats(struct nicvf *nic);
576
577 #endif /* NIC_H */