1/*
2 * Copyright (c) 2014 Broadcom Corporation
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 */
8
9#ifndef __BCMGENET_H__
10#define __BCMGENET_H__
11
12#include <linux/skbuff.h>
13#include <linux/netdevice.h>
14#include <linux/spinlock.h>
15#include <linux/clk.h>
16#include <linux/mii.h>
17#include <linux/if_vlan.h>
18#include <linux/phy.h>
19
20/* total number of Buffer Descriptors, same for Rx/Tx */
21#define TOTAL_DESC				256
22
23/* which ring is descriptor based */
24#define DESC_INDEX				16
25
26/* Body(1500) + EH_SIZE(14) + VLANTAG(4) + BRCMTAG(6) + FCS(4) = 1528.
27 * 1536 is multiple of 256 bytes
28 */
29#define ENET_BRCM_TAG_LEN	6
30#define ENET_PAD		8
31#define ENET_MAX_MTU_SIZE	(ETH_DATA_LEN + ETH_HLEN + VLAN_HLEN + \
32				 ENET_BRCM_TAG_LEN + ETH_FCS_LEN + ENET_PAD)
33#define DMA_MAX_BURST_LENGTH    0x10
34
35/* misc. configuration */
36#define CLEAR_ALL_HFB			0xFF
37#define DMA_FC_THRESH_HI		(TOTAL_DESC >> 4)
38#define DMA_FC_THRESH_LO		5
39
40/* 64B receive/transmit status block */
41struct status_64 {
42	u32	length_status;		/* length and peripheral status */
43	u32	ext_status;		/* Extended status*/
44	u32	rx_csum;		/* partial rx checksum */
45	u32	unused1[9];		/* unused */
46	u32	tx_csum_info;		/* Tx checksum info. */
47	u32	unused2[3];		/* unused */
48};
49
50/* Rx status bits */
51#define STATUS_RX_EXT_MASK		0x1FFFFF
52#define STATUS_RX_CSUM_MASK		0xFFFF
53#define STATUS_RX_CSUM_OK		0x10000
54#define STATUS_RX_CSUM_FR		0x20000
55#define STATUS_RX_PROTO_TCP		0
56#define STATUS_RX_PROTO_UDP		1
57#define STATUS_RX_PROTO_ICMP		2
58#define STATUS_RX_PROTO_OTHER		3
59#define STATUS_RX_PROTO_MASK		3
60#define STATUS_RX_PROTO_SHIFT		18
61#define STATUS_FILTER_INDEX_MASK	0xFFFF
62/* Tx status bits */
63#define STATUS_TX_CSUM_START_MASK	0X7FFF
64#define STATUS_TX_CSUM_START_SHIFT	16
65#define STATUS_TX_CSUM_PROTO_UDP	0x8000
66#define STATUS_TX_CSUM_OFFSET_MASK	0x7FFF
67#define STATUS_TX_CSUM_LV		0x80000000
68
69/* DMA Descriptor */
70#define DMA_DESC_LENGTH_STATUS	0x00	/* in bytes of data in buffer */
71#define DMA_DESC_ADDRESS_LO	0x04	/* lower bits of PA */
72#define DMA_DESC_ADDRESS_HI	0x08	/* upper 32 bits of PA, GENETv4+ */
73
74/* Rx/Tx common counter group */
75struct bcmgenet_pkt_counters {
76	u32	cnt_64;		/* RO Received/Transmited 64 bytes packet */
77	u32	cnt_127;	/* RO Rx/Tx 127 bytes packet */
78	u32	cnt_255;	/* RO Rx/Tx 65-255 bytes packet */
79	u32	cnt_511;	/* RO Rx/Tx 256-511 bytes packet */
80	u32	cnt_1023;	/* RO Rx/Tx 512-1023 bytes packet */
81	u32	cnt_1518;	/* RO Rx/Tx 1024-1518 bytes packet */
82	u32	cnt_mgv;	/* RO Rx/Tx 1519-1522 good VLAN packet */
83	u32	cnt_2047;	/* RO Rx/Tx 1522-2047 bytes packet*/
84	u32	cnt_4095;	/* RO Rx/Tx 2048-4095 bytes packet*/
85	u32	cnt_9216;	/* RO Rx/Tx 4096-9216 bytes packet*/
86};
87
88/* RSV, Receive Status Vector */
89struct bcmgenet_rx_counters {
90	struct  bcmgenet_pkt_counters pkt_cnt;
91	u32	pkt;		/* RO (0x428) Received pkt count*/
92	u32	bytes;		/* RO Received byte count */
93	u32	mca;		/* RO # of Received multicast pkt */
94	u32	bca;		/* RO # of Receive broadcast pkt */
95	u32	fcs;		/* RO # of Received FCS error  */
96	u32	cf;		/* RO # of Received control frame pkt*/
97	u32	pf;		/* RO # of Received pause frame pkt */
98	u32	uo;		/* RO # of unknown op code pkt */
99	u32	aln;		/* RO # of alignment error count */
100	u32	flr;		/* RO # of frame length out of range count */
101	u32	cde;		/* RO # of code error pkt */
102	u32	fcr;		/* RO # of carrier sense error pkt */
103	u32	ovr;		/* RO # of oversize pkt*/
104	u32	jbr;		/* RO # of jabber count */
105	u32	mtue;		/* RO # of MTU error pkt*/
106	u32	pok;		/* RO # of Received good pkt */
107	u32	uc;		/* RO # of unicast pkt */
108	u32	ppp;		/* RO # of PPP pkt */
109	u32	rcrc;		/* RO (0x470),# of CRC match pkt */
110};
111
112/* TSV, Transmit Status Vector */
113struct bcmgenet_tx_counters {
114	struct bcmgenet_pkt_counters pkt_cnt;
115	u32	pkts;		/* RO (0x4a8) Transmited pkt */
116	u32	mca;		/* RO # of xmited multicast pkt */
117	u32	bca;		/* RO # of xmited broadcast pkt */
118	u32	pf;		/* RO # of xmited pause frame count */
119	u32	cf;		/* RO # of xmited control frame count */
120	u32	fcs;		/* RO # of xmited FCS error count */
121	u32	ovr;		/* RO # of xmited oversize pkt */
122	u32	drf;		/* RO # of xmited deferral pkt */
123	u32	edf;		/* RO # of xmited Excessive deferral pkt*/
124	u32	scl;		/* RO # of xmited single collision pkt */
125	u32	mcl;		/* RO # of xmited multiple collision pkt*/
126	u32	lcl;		/* RO # of xmited late collision pkt */
127	u32	ecl;		/* RO # of xmited excessive collision pkt*/
128	u32	frg;		/* RO # of xmited fragments pkt*/
129	u32	ncl;		/* RO # of xmited total collision count */
130	u32	jbr;		/* RO # of xmited jabber count*/
131	u32	bytes;		/* RO # of xmited byte count */
132	u32	pok;		/* RO # of xmited good pkt */
133	u32	uc;		/* RO (0x0x4f0)# of xmited unitcast pkt */
134};
135
136struct bcmgenet_mib_counters {
137	struct bcmgenet_rx_counters rx;
138	struct bcmgenet_tx_counters tx;
139	u32	rx_runt_cnt;
140	u32	rx_runt_fcs;
141	u32	rx_runt_fcs_align;
142	u32	rx_runt_bytes;
143	u32	rbuf_ovflow_cnt;
144	u32	rbuf_err_cnt;
145	u32	mdf_err_cnt;
146};
147
148#define UMAC_HD_BKP_CTRL		0x004
149#define	 HD_FC_EN			(1 << 0)
150#define  HD_FC_BKOFF_OK			(1 << 1)
151#define  IPG_CONFIG_RX_SHIFT		2
152#define  IPG_CONFIG_RX_MASK		0x1F
153
154#define UMAC_CMD			0x008
155#define  CMD_TX_EN			(1 << 0)
156#define  CMD_RX_EN			(1 << 1)
157#define  UMAC_SPEED_10			0
158#define  UMAC_SPEED_100			1
159#define  UMAC_SPEED_1000		2
160#define  UMAC_SPEED_2500		3
161#define  CMD_SPEED_SHIFT		2
162#define  CMD_SPEED_MASK			3
163#define  CMD_PROMISC			(1 << 4)
164#define  CMD_PAD_EN			(1 << 5)
165#define  CMD_CRC_FWD			(1 << 6)
166#define  CMD_PAUSE_FWD			(1 << 7)
167#define  CMD_RX_PAUSE_IGNORE		(1 << 8)
168#define  CMD_TX_ADDR_INS		(1 << 9)
169#define  CMD_HD_EN			(1 << 10)
170#define  CMD_SW_RESET			(1 << 13)
171#define  CMD_LCL_LOOP_EN		(1 << 15)
172#define  CMD_AUTO_CONFIG		(1 << 22)
173#define  CMD_CNTL_FRM_EN		(1 << 23)
174#define  CMD_NO_LEN_CHK			(1 << 24)
175#define  CMD_RMT_LOOP_EN		(1 << 25)
176#define  CMD_PRBL_EN			(1 << 27)
177#define  CMD_TX_PAUSE_IGNORE		(1 << 28)
178#define  CMD_TX_RX_EN			(1 << 29)
179#define  CMD_RUNT_FILTER_DIS		(1 << 30)
180
181#define UMAC_MAC0			0x00C
182#define UMAC_MAC1			0x010
183#define UMAC_MAX_FRAME_LEN		0x014
184
185#define UMAC_TX_FLUSH			0x334
186
187#define UMAC_MIB_START			0x400
188
189#define UMAC_MDIO_CMD			0x614
190#define  MDIO_START_BUSY		(1 << 29)
191#define  MDIO_READ_FAIL			(1 << 28)
192#define  MDIO_RD			(2 << 26)
193#define  MDIO_WR			(1 << 26)
194#define  MDIO_PMD_SHIFT			21
195#define  MDIO_PMD_MASK			0x1F
196#define  MDIO_REG_SHIFT			16
197#define  MDIO_REG_MASK			0x1F
198
199#define UMAC_RBUF_OVFL_CNT		0x61C
200
201#define UMAC_MPD_CTRL			0x620
202#define  MPD_EN				(1 << 0)
203#define  MPD_PW_EN			(1 << 27)
204#define  MPD_MSEQ_LEN_SHIFT		16
205#define  MPD_MSEQ_LEN_MASK		0xFF
206
207#define UMAC_MPD_PW_MS			0x624
208#define UMAC_MPD_PW_LS			0x628
209#define UMAC_RBUF_ERR_CNT		0x634
210#define UMAC_MDF_ERR_CNT		0x638
211#define UMAC_MDF_CTRL			0x650
212#define UMAC_MDF_ADDR			0x654
213#define UMAC_MIB_CTRL			0x580
214#define  MIB_RESET_RX			(1 << 0)
215#define  MIB_RESET_RUNT			(1 << 1)
216#define  MIB_RESET_TX			(1 << 2)
217
218#define RBUF_CTRL			0x00
219#define  RBUF_64B_EN			(1 << 0)
220#define  RBUF_ALIGN_2B			(1 << 1)
221#define  RBUF_BAD_DIS			(1 << 2)
222
223#define RBUF_STATUS			0x0C
224#define  RBUF_STATUS_WOL		(1 << 0)
225#define  RBUF_STATUS_MPD_INTR_ACTIVE	(1 << 1)
226#define  RBUF_STATUS_ACPI_INTR_ACTIVE	(1 << 2)
227
228#define RBUF_CHK_CTRL			0x14
229#define  RBUF_RXCHK_EN			(1 << 0)
230#define  RBUF_SKIP_FCS			(1 << 4)
231
232#define RBUF_TBUF_SIZE_CTRL		0xb4
233
234#define RBUF_HFB_CTRL_V1		0x38
235#define  RBUF_HFB_FILTER_EN_SHIFT	16
236#define  RBUF_HFB_FILTER_EN_MASK	0xffff0000
237#define  RBUF_HFB_EN			(1 << 0)
238#define  RBUF_HFB_256B			(1 << 1)
239#define  RBUF_ACPI_EN			(1 << 2)
240
241#define RBUF_HFB_LEN_V1			0x3C
242#define  RBUF_FLTR_LEN_MASK		0xFF
243#define  RBUF_FLTR_LEN_SHIFT		8
244
245#define TBUF_CTRL			0x00
246#define TBUF_BP_MC			0x0C
247
248#define TBUF_CTRL_V1			0x80
249#define TBUF_BP_MC_V1			0xA0
250
251#define HFB_CTRL			0x00
252#define HFB_FLT_ENABLE_V3PLUS		0x04
253#define HFB_FLT_LEN_V2			0x04
254#define HFB_FLT_LEN_V3PLUS		0x1C
255
256/* uniMac intrl2 registers */
257#define INTRL2_CPU_STAT			0x00
258#define INTRL2_CPU_SET			0x04
259#define INTRL2_CPU_CLEAR		0x08
260#define INTRL2_CPU_MASK_STATUS		0x0C
261#define INTRL2_CPU_MASK_SET		0x10
262#define INTRL2_CPU_MASK_CLEAR		0x14
263
264/* INTRL2 instance 0 definitions */
265#define UMAC_IRQ_SCB			(1 << 0)
266#define UMAC_IRQ_EPHY			(1 << 1)
267#define UMAC_IRQ_PHY_DET_R		(1 << 2)
268#define UMAC_IRQ_PHY_DET_F		(1 << 3)
269#define UMAC_IRQ_LINK_UP		(1 << 4)
270#define UMAC_IRQ_LINK_DOWN		(1 << 5)
271#define UMAC_IRQ_UMAC			(1 << 6)
272#define UMAC_IRQ_UMAC_TSV		(1 << 7)
273#define UMAC_IRQ_TBUF_UNDERRUN		(1 << 8)
274#define UMAC_IRQ_RBUF_OVERFLOW		(1 << 9)
275#define UMAC_IRQ_HFB_SM			(1 << 10)
276#define UMAC_IRQ_HFB_MM			(1 << 11)
277#define UMAC_IRQ_MPD_R			(1 << 12)
278#define UMAC_IRQ_RXDMA_MBDONE		(1 << 13)
279#define UMAC_IRQ_RXDMA_PDONE		(1 << 14)
280#define UMAC_IRQ_RXDMA_BDONE		(1 << 15)
281#define UMAC_IRQ_TXDMA_MBDONE		(1 << 16)
282#define UMAC_IRQ_TXDMA_PDONE		(1 << 17)
283#define UMAC_IRQ_TXDMA_BDONE		(1 << 18)
284/* Only valid for GENETv3+ */
285#define UMAC_IRQ_MDIO_DONE		(1 << 23)
286#define UMAC_IRQ_MDIO_ERROR		(1 << 24)
287
288/* Register block offsets */
289#define GENET_SYS_OFF			0x0000
290#define GENET_GR_BRIDGE_OFF		0x0040
291#define GENET_EXT_OFF			0x0080
292#define GENET_INTRL2_0_OFF		0x0200
293#define GENET_INTRL2_1_OFF		0x0240
294#define GENET_RBUF_OFF			0x0300
295#define GENET_UMAC_OFF			0x0800
296
297/* SYS block offsets and register definitions */
298#define SYS_REV_CTRL			0x00
299#define SYS_PORT_CTRL			0x04
300#define  PORT_MODE_INT_EPHY		0
301#define  PORT_MODE_INT_GPHY		1
302#define  PORT_MODE_EXT_EPHY		2
303#define  PORT_MODE_EXT_GPHY		3
304#define  PORT_MODE_EXT_RVMII_25		(4 | BIT(4))
305#define  PORT_MODE_EXT_RVMII_50		4
306#define  LED_ACT_SOURCE_MAC		(1 << 9)
307
308#define SYS_RBUF_FLUSH_CTRL		0x08
309#define SYS_TBUF_FLUSH_CTRL		0x0C
310#define RBUF_FLUSH_CTRL_V1		0x04
311
312/* Ext block register offsets and definitions */
313#define EXT_EXT_PWR_MGMT		0x00
314#define  EXT_PWR_DOWN_BIAS		(1 << 0)
315#define  EXT_PWR_DOWN_DLL		(1 << 1)
316#define  EXT_PWR_DOWN_PHY		(1 << 2)
317#define  EXT_PWR_DN_EN_LD		(1 << 3)
318#define  EXT_ENERGY_DET			(1 << 4)
319#define  EXT_IDDQ_FROM_PHY		(1 << 5)
320#define  EXT_PHY_RESET			(1 << 8)
321#define  EXT_ENERGY_DET_MASK		(1 << 12)
322
323#define EXT_RGMII_OOB_CTRL		0x0C
324#define  RGMII_LINK			(1 << 4)
325#define  OOB_DISABLE			(1 << 5)
326#define  RGMII_MODE_EN			(1 << 6)
327#define  ID_MODE_DIS			(1 << 16)
328
329#define EXT_GPHY_CTRL			0x1C
330#define  EXT_CFG_IDDQ_BIAS		(1 << 0)
331#define  EXT_CFG_PWR_DOWN		(1 << 1)
332#define  EXT_GPHY_RESET			(1 << 5)
333
334/* DMA rings size */
335#define DMA_RING_SIZE			(0x40)
336#define DMA_RINGS_SIZE			(DMA_RING_SIZE * (DESC_INDEX + 1))
337
338/* DMA registers common definitions */
339#define DMA_RW_POINTER_MASK		0x1FF
340#define DMA_P_INDEX_DISCARD_CNT_MASK	0xFFFF
341#define DMA_P_INDEX_DISCARD_CNT_SHIFT	16
342#define DMA_BUFFER_DONE_CNT_MASK	0xFFFF
343#define DMA_BUFFER_DONE_CNT_SHIFT	16
344#define DMA_P_INDEX_MASK		0xFFFF
345#define DMA_C_INDEX_MASK		0xFFFF
346
347/* DMA ring size register */
348#define DMA_RING_SIZE_MASK		0xFFFF
349#define DMA_RING_SIZE_SHIFT		16
350#define DMA_RING_BUFFER_SIZE_MASK	0xFFFF
351
352/* DMA interrupt threshold register */
353#define DMA_INTR_THRESHOLD_MASK		0x00FF
354
355/* DMA XON/XOFF register */
356#define DMA_XON_THREHOLD_MASK		0xFFFF
357#define DMA_XOFF_THRESHOLD_MASK		0xFFFF
358#define DMA_XOFF_THRESHOLD_SHIFT	16
359
360/* DMA flow period register */
361#define DMA_FLOW_PERIOD_MASK		0xFFFF
362#define DMA_MAX_PKT_SIZE_MASK		0xFFFF
363#define DMA_MAX_PKT_SIZE_SHIFT		16
364
365
366/* DMA control register */
367#define DMA_EN				(1 << 0)
368#define DMA_RING_BUF_EN_SHIFT		0x01
369#define DMA_RING_BUF_EN_MASK		0xFFFF
370#define DMA_TSB_SWAP_EN			(1 << 20)
371
372/* DMA status register */
373#define DMA_DISABLED			(1 << 0)
374#define DMA_DESC_RAM_INIT_BUSY		(1 << 1)
375
376/* DMA SCB burst size register */
377#define DMA_SCB_BURST_SIZE_MASK		0x1F
378
379/* DMA activity vector register */
380#define DMA_ACTIVITY_VECTOR_MASK	0x1FFFF
381
382/* DMA backpressure mask register */
383#define DMA_BACKPRESSURE_MASK		0x1FFFF
384#define DMA_PFC_ENABLE			(1 << 31)
385
386/* DMA backpressure status register */
387#define DMA_BACKPRESSURE_STATUS_MASK	0x1FFFF
388
389/* DMA override register */
390#define DMA_LITTLE_ENDIAN_MODE		(1 << 0)
391#define DMA_REGISTER_MODE		(1 << 1)
392
393/* DMA timeout register */
394#define DMA_TIMEOUT_MASK		0xFFFF
395#define DMA_TIMEOUT_VAL			5000	/* micro seconds */
396
397/* TDMA rate limiting control register */
398#define DMA_RATE_LIMIT_EN_MASK		0xFFFF
399
400/* TDMA arbitration control register */
401#define DMA_ARBITER_MODE_MASK		0x03
402#define DMA_RING_BUF_PRIORITY_MASK	0x1F
403#define DMA_RING_BUF_PRIORITY_SHIFT	5
404#define DMA_PRIO_REG_INDEX(q)		((q) / 6)
405#define DMA_PRIO_REG_SHIFT(q)		(((q) % 6) * DMA_RING_BUF_PRIORITY_SHIFT)
406#define DMA_RATE_ADJ_MASK		0xFF
407
408/* Tx/Rx Dma Descriptor common bits*/
409#define DMA_BUFLENGTH_MASK		0x0fff
410#define DMA_BUFLENGTH_SHIFT		16
411#define DMA_OWN				0x8000
412#define DMA_EOP				0x4000
413#define DMA_SOP				0x2000
414#define DMA_WRAP			0x1000
415/* Tx specific Dma descriptor bits */
416#define DMA_TX_UNDERRUN			0x0200
417#define DMA_TX_APPEND_CRC		0x0040
418#define DMA_TX_OW_CRC			0x0020
419#define DMA_TX_DO_CSUM			0x0010
420#define DMA_TX_QTAG_SHIFT		7
421
422/* Rx Specific Dma descriptor bits */
423#define DMA_RX_CHK_V3PLUS		0x8000
424#define DMA_RX_CHK_V12			0x1000
425#define DMA_RX_BRDCAST			0x0040
426#define DMA_RX_MULT			0x0020
427#define DMA_RX_LG			0x0010
428#define DMA_RX_NO			0x0008
429#define DMA_RX_RXER			0x0004
430#define DMA_RX_CRC_ERROR		0x0002
431#define DMA_RX_OV			0x0001
432#define DMA_RX_FI_MASK			0x001F
433#define DMA_RX_FI_SHIFT			0x0007
434#define DMA_DESC_ALLOC_MASK		0x00FF
435
436#define DMA_ARBITER_RR			0x00
437#define DMA_ARBITER_WRR			0x01
438#define DMA_ARBITER_SP			0x02
439
440struct enet_cb {
441	struct sk_buff      *skb;
442	void __iomem *bd_addr;
443	DEFINE_DMA_UNMAP_ADDR(dma_addr);
444	DEFINE_DMA_UNMAP_LEN(dma_len);
445};
446
447/* power management mode */
448enum bcmgenet_power_mode {
449	GENET_POWER_CABLE_SENSE = 0,
450	GENET_POWER_PASSIVE,
451	GENET_POWER_WOL_MAGIC,
452};
453
454struct bcmgenet_priv;
455
456/* We support both runtime GENET detection and compile-time
457 * to optimize code-paths for a given hardware
458 */
459enum bcmgenet_version {
460	GENET_V1 = 1,
461	GENET_V2,
462	GENET_V3,
463	GENET_V4
464};
465
466#define GENET_IS_V1(p)	((p)->version == GENET_V1)
467#define GENET_IS_V2(p)	((p)->version == GENET_V2)
468#define GENET_IS_V3(p)	((p)->version == GENET_V3)
469#define GENET_IS_V4(p)	((p)->version == GENET_V4)
470
471/* Hardware flags */
472#define GENET_HAS_40BITS	(1 << 0)
473#define GENET_HAS_EXT		(1 << 1)
474#define GENET_HAS_MDIO_INTR	(1 << 2)
475
476/* BCMGENET hardware parameters, keep this structure nicely aligned
477 * since it is going to be used in hot paths
478 */
479struct bcmgenet_hw_params {
480	u8		tx_queues;
481	u8		rx_queues;
482	u8		bds_cnt;
483	u8		bp_in_en_shift;
484	u32		bp_in_mask;
485	u8		hfb_filter_cnt;
486	u8		qtag_mask;
487	u16		tbuf_offset;
488	u32		hfb_offset;
489	u32		hfb_reg_offset;
490	u32		rdma_offset;
491	u32		tdma_offset;
492	u32		words_per_bd;
493	u32		flags;
494};
495
496struct bcmgenet_tx_ring {
497	spinlock_t	lock;		/* ring lock */
498	unsigned int	index;		/* ring index */
499	unsigned int	queue;		/* queue index */
500	struct enet_cb	*cbs;		/* tx ring buffer control block*/
501	unsigned int	size;		/* size of each tx ring */
502	unsigned int	c_index;	/* last consumer index of each ring*/
503	unsigned int	free_bds;	/* # of free bds for each ring */
504	unsigned int	write_ptr;	/* Tx ring write pointer SW copy */
505	unsigned int	prod_index;	/* Tx ring producer index SW copy */
506	unsigned int	cb_ptr;		/* Tx ring initial CB ptr */
507	unsigned int	end_ptr;	/* Tx ring end CB ptr */
508	void (*int_enable)(struct bcmgenet_priv *priv,
509			   struct bcmgenet_tx_ring *);
510	void (*int_disable)(struct bcmgenet_priv *priv,
511			    struct bcmgenet_tx_ring *);
512};
513
514/* device context */
515struct bcmgenet_priv {
516	void __iomem *base;
517	enum bcmgenet_version version;
518	struct net_device *dev;
519	u32 int0_mask;
520	u32 int1_mask;
521
522	/* NAPI for descriptor based rx */
523	struct napi_struct napi ____cacheline_aligned;
524
525	/* transmit variables */
526	void __iomem *tx_bds;
527	struct enet_cb *tx_cbs;
528	unsigned int num_tx_bds;
529
530	struct bcmgenet_tx_ring tx_rings[DESC_INDEX + 1];
531
532	/* receive variables */
533	void __iomem *rx_bds;
534	void __iomem *rx_bd_assign_ptr;
535	int rx_bd_assign_index;
536	struct enet_cb *rx_cbs;
537	unsigned int num_rx_bds;
538	unsigned int rx_buf_len;
539	unsigned int rx_read_ptr;
540	unsigned int rx_c_index;
541
542	/* other misc variables */
543	struct bcmgenet_hw_params *hw_params;
544
545	/* MDIO bus variables */
546	wait_queue_head_t wq;
547	struct phy_device *phydev;
548	struct device_node *phy_dn;
549	struct mii_bus *mii_bus;
550	u16 gphy_rev;
551
552	/* PHY device variables */
553	int old_link;
554	int old_speed;
555	int old_duplex;
556	int old_pause;
557	phy_interface_t phy_interface;
558	int phy_addr;
559	int ext_phy;
560
561	/* Interrupt variables */
562	struct work_struct bcmgenet_irq_work;
563	int irq0;
564	int irq1;
565	unsigned int irq0_stat;
566	unsigned int irq1_stat;
567	int wol_irq;
568	bool wol_irq_disabled;
569
570	/* HW descriptors/checksum variables */
571	bool desc_64b_en;
572	bool desc_rxchk_en;
573	bool crc_fwd_en;
574
575	unsigned int dma_rx_chk_bit;
576
577	u32 msg_enable;
578
579	struct clk *clk;
580	struct platform_device *pdev;
581
582	/* WOL */
583	struct clk *clk_wol;
584	u32 wolopts;
585
586	struct bcmgenet_mib_counters mib;
587};
588
589#define GENET_IO_MACRO(name, offset)					\
590static inline u32 bcmgenet_##name##_readl(struct bcmgenet_priv *priv,	\
591					u32 off)			\
592{									\
593	return __raw_readl(priv->base + offset + off);			\
594}									\
595static inline void bcmgenet_##name##_writel(struct bcmgenet_priv *priv,	\
596					u32 val, u32 off)		\
597{									\
598	__raw_writel(val, priv->base + offset + off);			\
599}
600
601GENET_IO_MACRO(ext, GENET_EXT_OFF);
602GENET_IO_MACRO(umac, GENET_UMAC_OFF);
603GENET_IO_MACRO(sys, GENET_SYS_OFF);
604
605/* interrupt l2 registers accessors */
606GENET_IO_MACRO(intrl2_0, GENET_INTRL2_0_OFF);
607GENET_IO_MACRO(intrl2_1, GENET_INTRL2_1_OFF);
608
609/* HFB register accessors  */
610GENET_IO_MACRO(hfb, priv->hw_params->hfb_offset);
611
612/* GENET v2+ HFB control and filter len helpers */
613GENET_IO_MACRO(hfb_reg, priv->hw_params->hfb_reg_offset);
614
615/* RBUF register accessors */
616GENET_IO_MACRO(rbuf, GENET_RBUF_OFF);
617
618/* MDIO routines */
619int bcmgenet_mii_init(struct net_device *dev);
620int bcmgenet_mii_config(struct net_device *dev, bool init);
621void bcmgenet_mii_exit(struct net_device *dev);
622void bcmgenet_mii_reset(struct net_device *dev);
623void bcmgenet_mii_setup(struct net_device *dev);
624
625/* Wake-on-LAN routines */
626void bcmgenet_get_wol(struct net_device *dev, struct ethtool_wolinfo *wol);
627int bcmgenet_set_wol(struct net_device *dev, struct ethtool_wolinfo *wol);
628int bcmgenet_wol_power_down_cfg(struct bcmgenet_priv *priv,
629				enum bcmgenet_power_mode mode);
630void bcmgenet_wol_power_up_cfg(struct bcmgenet_priv *priv,
631			       enum bcmgenet_power_mode mode);
632
633#endif /* __BCMGENET_H__ */
634