]> git.ipfire.org Git - thirdparty/linux.git/blob - drivers/net/ethernet/cavium/thunder/nic.h
ASoC: sirf: Added blank line after declarations
[thirdparty/linux.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 rcv_buffer_alloc_failures;
256 u64 tx_tso;
257 u64 tx_timeout;
258 u64 txq_stop;
259 u64 txq_wake;
260
261 struct u64_stats_sync syncp;
262 };
263
264 struct nicvf {
265 struct nicvf *pnicvf;
266 struct net_device *netdev;
267 struct pci_dev *pdev;
268 void __iomem *reg_base;
269 #define MAX_QUEUES_PER_QSET 8
270 struct queue_set *qs;
271 struct nicvf_cq_poll *napi[8];
272 u8 vf_id;
273 u8 sqs_id;
274 bool sqs_mode;
275 bool hw_tso;
276 bool t88;
277
278 /* Receive buffer alloc */
279 u32 rb_page_offset;
280 u16 rb_pageref;
281 bool rb_alloc_fail;
282 bool rb_work_scheduled;
283 struct page *rb_page;
284 struct delayed_work rbdr_work;
285 struct tasklet_struct rbdr_task;
286
287 /* Secondary Qset */
288 u8 sqs_count;
289 #define MAX_SQS_PER_VF_SINGLE_NODE 5
290 #define MAX_SQS_PER_VF 11
291 struct nicvf *snicvf[MAX_SQS_PER_VF];
292
293 /* Queue count */
294 u8 rx_queues;
295 u8 tx_queues;
296 u8 max_queues;
297
298 u8 node;
299 u8 cpi_alg;
300 bool link_up;
301 u8 mac_type;
302 u8 duplex;
303 u32 speed;
304 bool tns_mode;
305 bool loopback_supported;
306 struct nicvf_rss_info rss_info;
307 struct nicvf_pfc pfc;
308 struct tasklet_struct qs_err_task;
309 struct work_struct reset_task;
310
311 /* Interrupt coalescing settings */
312 u32 cq_coalesce_usecs;
313 u32 msg_enable;
314
315 /* Stats */
316 struct nicvf_hw_stats hw_stats;
317 struct nicvf_drv_stats __percpu *drv_stats;
318 struct bgx_stats bgx_stats;
319
320 /* MSI-X */
321 bool msix_enabled;
322 u8 num_vec;
323 struct msix_entry msix_entries[NIC_VF_MSIX_VECTORS];
324 char irq_name[NIC_VF_MSIX_VECTORS][IFNAMSIZ + 15];
325 bool irq_allocated[NIC_VF_MSIX_VECTORS];
326 cpumask_var_t affinity_mask[NIC_VF_MSIX_VECTORS];
327
328 /* VF <-> PF mailbox communication */
329 bool pf_acked;
330 bool pf_nacked;
331 bool set_mac_pending;
332 } ____cacheline_aligned_in_smp;
333
334 /* PF <--> VF Mailbox communication
335 * Eight 64bit registers are shared between PF and VF.
336 * Separate set for each VF.
337 * Writing '1' into last register mbx7 means end of message.
338 */
339
340 /* PF <--> VF mailbox communication */
341 #define NIC_PF_VF_MAILBOX_SIZE 2
342 #define NIC_MBOX_MSG_TIMEOUT 2000 /* ms */
343
344 /* Mailbox message types */
345 #define NIC_MBOX_MSG_READY 0x01 /* Is PF ready to rcv msgs */
346 #define NIC_MBOX_MSG_ACK 0x02 /* ACK the message received */
347 #define NIC_MBOX_MSG_NACK 0x03 /* NACK the message received */
348 #define NIC_MBOX_MSG_QS_CFG 0x04 /* Configure Qset */
349 #define NIC_MBOX_MSG_RQ_CFG 0x05 /* Configure receive queue */
350 #define NIC_MBOX_MSG_SQ_CFG 0x06 /* Configure Send queue */
351 #define NIC_MBOX_MSG_RQ_DROP_CFG 0x07 /* Configure receive queue */
352 #define NIC_MBOX_MSG_SET_MAC 0x08 /* Add MAC ID to DMAC filter */
353 #define NIC_MBOX_MSG_SET_MAX_FRS 0x09 /* Set max frame size */
354 #define NIC_MBOX_MSG_CPI_CFG 0x0A /* Config CPI, RSSI */
355 #define NIC_MBOX_MSG_RSS_SIZE 0x0B /* Get RSS indir_tbl size */
356 #define NIC_MBOX_MSG_RSS_CFG 0x0C /* Config RSS table */
357 #define NIC_MBOX_MSG_RSS_CFG_CONT 0x0D /* RSS config continuation */
358 #define NIC_MBOX_MSG_RQ_BP_CFG 0x0E /* RQ backpressure config */
359 #define NIC_MBOX_MSG_RQ_SW_SYNC 0x0F /* Flush inflight pkts to RQ */
360 #define NIC_MBOX_MSG_BGX_STATS 0x10 /* Get stats from BGX */
361 #define NIC_MBOX_MSG_BGX_LINK_CHANGE 0x11 /* BGX:LMAC link status */
362 #define NIC_MBOX_MSG_ALLOC_SQS 0x12 /* Allocate secondary Qset */
363 #define NIC_MBOX_MSG_NICVF_PTR 0x13 /* Send nicvf ptr to PF */
364 #define NIC_MBOX_MSG_PNICVF_PTR 0x14 /* Get primary qset nicvf ptr */
365 #define NIC_MBOX_MSG_SNICVF_PTR 0x15 /* Send sqet nicvf ptr to PVF */
366 #define NIC_MBOX_MSG_LOOPBACK 0x16 /* Set interface in loopback */
367 #define NIC_MBOX_MSG_RESET_STAT_COUNTER 0x17 /* Reset statistics counters */
368 #define NIC_MBOX_MSG_PFC 0x18 /* Pause frame control */
369 #define NIC_MBOX_MSG_CFG_DONE 0xF0 /* VF configuration done */
370 #define NIC_MBOX_MSG_SHUTDOWN 0xF1 /* VF is being shutdown */
371
372 struct nic_cfg_msg {
373 u8 msg;
374 u8 vf_id;
375 u8 node_id;
376 u8 tns_mode:1;
377 u8 sqs_mode:1;
378 u8 loopback_supported:1;
379 u8 mac_addr[ETH_ALEN];
380 };
381
382 /* Qset configuration */
383 struct qs_cfg_msg {
384 u8 msg;
385 u8 num;
386 u8 sqs_count;
387 u64 cfg;
388 };
389
390 /* Receive queue configuration */
391 struct rq_cfg_msg {
392 u8 msg;
393 u8 qs_num;
394 u8 rq_num;
395 u64 cfg;
396 };
397
398 /* Send queue configuration */
399 struct sq_cfg_msg {
400 u8 msg;
401 u8 qs_num;
402 u8 sq_num;
403 bool sqs_mode;
404 u64 cfg;
405 };
406
407 /* Set VF's MAC address */
408 struct set_mac_msg {
409 u8 msg;
410 u8 vf_id;
411 u8 mac_addr[ETH_ALEN];
412 };
413
414 /* Set Maximum frame size */
415 struct set_frs_msg {
416 u8 msg;
417 u8 vf_id;
418 u16 max_frs;
419 };
420
421 /* Set CPI algorithm type */
422 struct cpi_cfg_msg {
423 u8 msg;
424 u8 vf_id;
425 u8 rq_cnt;
426 u8 cpi_alg;
427 };
428
429 /* Get RSS table size */
430 struct rss_sz_msg {
431 u8 msg;
432 u8 vf_id;
433 u16 ind_tbl_size;
434 };
435
436 /* Set RSS configuration */
437 struct rss_cfg_msg {
438 u8 msg;
439 u8 vf_id;
440 u8 hash_bits;
441 u8 tbl_len;
442 u8 tbl_offset;
443 #define RSS_IND_TBL_LEN_PER_MBX_MSG 8
444 u8 ind_tbl[RSS_IND_TBL_LEN_PER_MBX_MSG];
445 };
446
447 struct bgx_stats_msg {
448 u8 msg;
449 u8 vf_id;
450 u8 rx;
451 u8 idx;
452 u64 stats;
453 };
454
455 /* Physical interface link status */
456 struct bgx_link_status {
457 u8 msg;
458 u8 mac_type;
459 u8 link_up;
460 u8 duplex;
461 u32 speed;
462 };
463
464 /* Get Extra Qset IDs */
465 struct sqs_alloc {
466 u8 msg;
467 u8 vf_id;
468 u8 qs_count;
469 };
470
471 struct nicvf_ptr {
472 u8 msg;
473 u8 vf_id;
474 bool sqs_mode;
475 u8 sqs_id;
476 u64 nicvf;
477 };
478
479 /* Set interface in loopback mode */
480 struct set_loopback {
481 u8 msg;
482 u8 vf_id;
483 bool enable;
484 };
485
486 /* Reset statistics counters */
487 struct reset_stat_cfg {
488 u8 msg;
489 /* Bitmap to select NIC_PF_VNIC(vf_id)_RX_STAT(0..13) */
490 u16 rx_stat_mask;
491 /* Bitmap to select NIC_PF_VNIC(vf_id)_TX_STAT(0..4) */
492 u8 tx_stat_mask;
493 /* Bitmap to select NIC_PF_QS(0..127)_RQ(0..7)_STAT(0..1)
494 * bit14, bit15 NIC_PF_QS(vf_id)_RQ7_STAT(0..1)
495 * bit12, bit13 NIC_PF_QS(vf_id)_RQ6_STAT(0..1)
496 * ..
497 * bit2, bit3 NIC_PF_QS(vf_id)_RQ1_STAT(0..1)
498 * bit0, bit1 NIC_PF_QS(vf_id)_RQ0_STAT(0..1)
499 */
500 u16 rq_stat_mask;
501 /* Bitmap to select NIC_PF_QS(0..127)_SQ(0..7)_STAT(0..1)
502 * bit14, bit15 NIC_PF_QS(vf_id)_SQ7_STAT(0..1)
503 * bit12, bit13 NIC_PF_QS(vf_id)_SQ6_STAT(0..1)
504 * ..
505 * bit2, bit3 NIC_PF_QS(vf_id)_SQ1_STAT(0..1)
506 * bit0, bit1 NIC_PF_QS(vf_id)_SQ0_STAT(0..1)
507 */
508 u16 sq_stat_mask;
509 };
510
511 struct pfc {
512 u8 msg;
513 u8 get; /* Get or set PFC settings */
514 u8 autoneg;
515 u8 fc_rx;
516 u8 fc_tx;
517 };
518
519 /* 128 bit shared memory between PF and each VF */
520 union nic_mbx {
521 struct { u8 msg; } msg;
522 struct nic_cfg_msg nic_cfg;
523 struct qs_cfg_msg qs;
524 struct rq_cfg_msg rq;
525 struct sq_cfg_msg sq;
526 struct set_mac_msg mac;
527 struct set_frs_msg frs;
528 struct cpi_cfg_msg cpi_cfg;
529 struct rss_sz_msg rss_size;
530 struct rss_cfg_msg rss_cfg;
531 struct bgx_stats_msg bgx_stats;
532 struct bgx_link_status link_status;
533 struct sqs_alloc sqs_alloc;
534 struct nicvf_ptr nicvf;
535 struct set_loopback lbk;
536 struct reset_stat_cfg reset_stat;
537 struct pfc pfc;
538 };
539
540 #define NIC_NODE_ID_MASK 0x03
541 #define NIC_NODE_ID_SHIFT 44
542
543 static inline int nic_get_node_id(struct pci_dev *pdev)
544 {
545 u64 addr = pci_resource_start(pdev, PCI_CFG_REG_BAR_NUM);
546 return ((addr >> NIC_NODE_ID_SHIFT) & NIC_NODE_ID_MASK);
547 }
548
549 static inline bool pass1_silicon(struct pci_dev *pdev)
550 {
551 return (pdev->revision < 8) &&
552 (pdev->subsystem_device == PCI_SUBSYS_DEVID_88XX_NIC_PF);
553 }
554
555 static inline bool pass2_silicon(struct pci_dev *pdev)
556 {
557 return (pdev->revision >= 8) &&
558 (pdev->subsystem_device == PCI_SUBSYS_DEVID_88XX_NIC_PF);
559 }
560
561 int nicvf_set_real_num_queues(struct net_device *netdev,
562 int tx_queues, int rx_queues);
563 int nicvf_open(struct net_device *netdev);
564 int nicvf_stop(struct net_device *netdev);
565 int nicvf_send_msg_to_pf(struct nicvf *vf, union nic_mbx *mbx);
566 void nicvf_config_rss(struct nicvf *nic);
567 void nicvf_set_rss_key(struct nicvf *nic);
568 void nicvf_set_ethtool_ops(struct net_device *netdev);
569 void nicvf_update_stats(struct nicvf *nic);
570 void nicvf_update_lmac_stats(struct nicvf *nic);
571
572 #endif /* NIC_H */