]> git.ipfire.org Git - people/ms/linux.git/blame - drivers/net/ethernet/cadence/macb.h
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[people/ms/linux.git] / drivers / net / ethernet / cadence / macb.h
CommitLineData
89e5785f
HS
1/*
2 * Atmel MACB Ethernet Controller driver
3 *
4 * Copyright (C) 2004-2006 Atmel Corporation
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
10#ifndef _MACB_H
11#define _MACB_H
12
d1d1b53d 13#define MACB_GREGS_NBR 16
7c39994f 14#define MACB_GREGS_VERSION 2
02c958dd 15#define MACB_MAX_QUEUES 8
d1d1b53d 16
89e5785f 17/* MACB register offsets */
6f79eed8
XH
18#define MACB_NCR 0x0000 /* Network Control */
19#define MACB_NCFGR 0x0004 /* Network Config */
20#define MACB_NSR 0x0008 /* Network Status */
21#define MACB_TAR 0x000c /* AT91RM9200 only */
22#define MACB_TCR 0x0010 /* AT91RM9200 only */
23#define MACB_TSR 0x0014 /* Transmit Status */
24#define MACB_RBQP 0x0018 /* RX Q Base Address */
25#define MACB_TBQP 0x001c /* TX Q Base Address */
26#define MACB_RSR 0x0020 /* Receive Status */
27#define MACB_ISR 0x0024 /* Interrupt Status */
28#define MACB_IER 0x0028 /* Interrupt Enable */
29#define MACB_IDR 0x002c /* Interrupt Disable */
30#define MACB_IMR 0x0030 /* Interrupt Mask */
31#define MACB_MAN 0x0034 /* PHY Maintenance */
32#define MACB_PTR 0x0038
33#define MACB_PFR 0x003c
34#define MACB_FTO 0x0040
35#define MACB_SCF 0x0044
36#define MACB_MCF 0x0048
37#define MACB_FRO 0x004c
38#define MACB_FCSE 0x0050
39#define MACB_ALE 0x0054
40#define MACB_DTF 0x0058
41#define MACB_LCOL 0x005c
42#define MACB_EXCOL 0x0060
43#define MACB_TUND 0x0064
44#define MACB_CSE 0x0068
45#define MACB_RRE 0x006c
46#define MACB_ROVR 0x0070
47#define MACB_RSE 0x0074
48#define MACB_ELE 0x0078
49#define MACB_RJA 0x007c
50#define MACB_USF 0x0080
51#define MACB_STE 0x0084
52#define MACB_RLE 0x0088
53#define MACB_TPF 0x008c
54#define MACB_HRB 0x0090
55#define MACB_HRT 0x0094
56#define MACB_SA1B 0x0098
57#define MACB_SA1T 0x009c
58#define MACB_SA2B 0x00a0
59#define MACB_SA2T 0x00a4
60#define MACB_SA3B 0x00a8
61#define MACB_SA3T 0x00ac
62#define MACB_SA4B 0x00b0
63#define MACB_SA4T 0x00b4
64#define MACB_TID 0x00b8
65#define MACB_TPQ 0x00bc
66#define MACB_USRIO 0x00c0
67#define MACB_WOL 0x00c4
68#define MACB_MID 0x00fc
f75ba50b
JI
69
70/* GEM register offsets. */
6f79eed8
XH
71#define GEM_NCFGR 0x0004 /* Network Config */
72#define GEM_USRIO 0x000c /* User IO */
73#define GEM_DMACFG 0x0010 /* DMA Configuration */
98b5a0f4 74#define GEM_JML 0x0048 /* Jumbo Max Length */
6f79eed8
XH
75#define GEM_HRB 0x0080 /* Hash Bottom */
76#define GEM_HRT 0x0084 /* Hash Top */
77#define GEM_SA1B 0x0088 /* Specific1 Bottom */
78#define GEM_SA1T 0x008C /* Specific1 Top */
79#define GEM_SA2B 0x0090 /* Specific2 Bottom */
80#define GEM_SA2T 0x0094 /* Specific2 Top */
81#define GEM_SA3B 0x0098 /* Specific3 Bottom */
82#define GEM_SA3T 0x009C /* Specific3 Top */
83#define GEM_SA4B 0x00A0 /* Specific4 Bottom */
84#define GEM_SA4T 0x00A4 /* Specific4 Top */
85#define GEM_OTX 0x0100 /* Octets transmitted */
86#define GEM_OCTTXL 0x0100 /* Octets transmitted [31:0] */
87#define GEM_OCTTXH 0x0104 /* Octets transmitted [47:32] */
88#define GEM_TXCNT 0x0108 /* Frames Transmitted counter */
89#define GEM_TXBCCNT 0x010c /* Broadcast Frames counter */
90#define GEM_TXMCCNT 0x0110 /* Multicast Frames counter */
91#define GEM_TXPAUSECNT 0x0114 /* Pause Frames Transmitted Counter */
92#define GEM_TX64CNT 0x0118 /* 64 byte Frames TX counter */
93#define GEM_TX65CNT 0x011c /* 65-127 byte Frames TX counter */
94#define GEM_TX128CNT 0x0120 /* 128-255 byte Frames TX counter */
95#define GEM_TX256CNT 0x0124 /* 256-511 byte Frames TX counter */
96#define GEM_TX512CNT 0x0128 /* 512-1023 byte Frames TX counter */
97#define GEM_TX1024CNT 0x012c /* 1024-1518 byte Frames TX counter */
98#define GEM_TX1519CNT 0x0130 /* 1519+ byte Frames TX counter */
99#define GEM_TXURUNCNT 0x0134 /* TX under run error counter */
100#define GEM_SNGLCOLLCNT 0x0138 /* Single Collision Frame Counter */
101#define GEM_MULTICOLLCNT 0x013c /* Multiple Collision Frame Counter */
102#define GEM_EXCESSCOLLCNT 0x0140 /* Excessive Collision Frame Counter */
103#define GEM_LATECOLLCNT 0x0144 /* Late Collision Frame Counter */
104#define GEM_TXDEFERCNT 0x0148 /* Deferred Transmission Frame Counter */
105#define GEM_TXCSENSECNT 0x014c /* Carrier Sense Error Counter */
106#define GEM_ORX 0x0150 /* Octets received */
107#define GEM_OCTRXL 0x0150 /* Octets received [31:0] */
108#define GEM_OCTRXH 0x0154 /* Octets received [47:32] */
109#define GEM_RXCNT 0x0158 /* Frames Received Counter */
110#define GEM_RXBROADCNT 0x015c /* Broadcast Frames Received Counter */
111#define GEM_RXMULTICNT 0x0160 /* Multicast Frames Received Counter */
112#define GEM_RXPAUSECNT 0x0164 /* Pause Frames Received Counter */
113#define GEM_RX64CNT 0x0168 /* 64 byte Frames RX Counter */
114#define GEM_RX65CNT 0x016c /* 65-127 byte Frames RX Counter */
115#define GEM_RX128CNT 0x0170 /* 128-255 byte Frames RX Counter */
116#define GEM_RX256CNT 0x0174 /* 256-511 byte Frames RX Counter */
117#define GEM_RX512CNT 0x0178 /* 512-1023 byte Frames RX Counter */
118#define GEM_RX1024CNT 0x017c /* 1024-1518 byte Frames RX Counter */
119#define GEM_RX1519CNT 0x0180 /* 1519+ byte Frames RX Counter */
120#define GEM_RXUNDRCNT 0x0184 /* Undersize Frames Received Counter */
121#define GEM_RXOVRCNT 0x0188 /* Oversize Frames Received Counter */
122#define GEM_RXJABCNT 0x018c /* Jabbers Received Counter */
123#define GEM_RXFCSCNT 0x0190 /* Frame Check Sequence Error Counter */
124#define GEM_RXLENGTHCNT 0x0194 /* Length Field Error Counter */
125#define GEM_RXSYMBCNT 0x0198 /* Symbol Error Counter */
126#define GEM_RXALIGNCNT 0x019c /* Alignment Error Counter */
127#define GEM_RXRESERRCNT 0x01a0 /* Receive Resource Error Counter */
128#define GEM_RXORCNT 0x01a4 /* Receive Overrun Counter */
129#define GEM_RXIPCCNT 0x01a8 /* IP header Checksum Error Counter */
130#define GEM_RXTCPCCNT 0x01ac /* TCP Checksum Error Counter */
131#define GEM_RXUDPCCNT 0x01b0 /* UDP Checksum Error Counter */
132#define GEM_DCFG1 0x0280 /* Design Config 1 */
133#define GEM_DCFG2 0x0284 /* Design Config 2 */
134#define GEM_DCFG3 0x0288 /* Design Config 3 */
135#define GEM_DCFG4 0x028c /* Design Config 4 */
136#define GEM_DCFG5 0x0290 /* Design Config 5 */
137#define GEM_DCFG6 0x0294 /* Design Config 6 */
138#define GEM_DCFG7 0x0298 /* Design Config 7 */
139
140#define GEM_ISR(hw_q) (0x0400 + ((hw_q) << 2))
141#define GEM_TBQP(hw_q) (0x0440 + ((hw_q) << 2))
142#define GEM_RBQP(hw_q) (0x0480 + ((hw_q) << 2))
143#define GEM_IER(hw_q) (0x0600 + ((hw_q) << 2))
144#define GEM_IDR(hw_q) (0x0620 + ((hw_q) << 2))
145#define GEM_IMR(hw_q) (0x0640 + ((hw_q) << 2))
02c958dd 146
89e5785f 147/* Bitfields in NCR */
6f79eed8
XH
148#define MACB_LB_OFFSET 0 /* reserved */
149#define MACB_LB_SIZE 1
150#define MACB_LLB_OFFSET 1 /* Loop back local */
151#define MACB_LLB_SIZE 1
152#define MACB_RE_OFFSET 2 /* Receive enable */
153#define MACB_RE_SIZE 1
154#define MACB_TE_OFFSET 3 /* Transmit enable */
155#define MACB_TE_SIZE 1
156#define MACB_MPE_OFFSET 4 /* Management port enable */
157#define MACB_MPE_SIZE 1
158#define MACB_CLRSTAT_OFFSET 5 /* Clear stats regs */
159#define MACB_CLRSTAT_SIZE 1
160#define MACB_INCSTAT_OFFSET 6 /* Incremental stats regs */
161#define MACB_INCSTAT_SIZE 1
162#define MACB_WESTAT_OFFSET 7 /* Write enable stats regs */
163#define MACB_WESTAT_SIZE 1
164#define MACB_BP_OFFSET 8 /* Back pressure */
165#define MACB_BP_SIZE 1
166#define MACB_TSTART_OFFSET 9 /* Start transmission */
167#define MACB_TSTART_SIZE 1
168#define MACB_THALT_OFFSET 10 /* Transmit halt */
169#define MACB_THALT_SIZE 1
170#define MACB_NCR_TPF_OFFSET 11 /* Transmit pause frame */
171#define MACB_NCR_TPF_SIZE 1
172#define MACB_TZQ_OFFSET 12 /* Transmit zero quantum pause frame */
173#define MACB_TZQ_SIZE 1
89e5785f
HS
174
175/* Bitfields in NCFGR */
6f79eed8
XH
176#define MACB_SPD_OFFSET 0 /* Speed */
177#define MACB_SPD_SIZE 1
178#define MACB_FD_OFFSET 1 /* Full duplex */
179#define MACB_FD_SIZE 1
180#define MACB_BIT_RATE_OFFSET 2 /* Discard non-VLAN frames */
181#define MACB_BIT_RATE_SIZE 1
182#define MACB_JFRAME_OFFSET 3 /* reserved */
183#define MACB_JFRAME_SIZE 1
184#define MACB_CAF_OFFSET 4 /* Copy all frames */
185#define MACB_CAF_SIZE 1
186#define MACB_NBC_OFFSET 5 /* No broadcast */
187#define MACB_NBC_SIZE 1
188#define MACB_NCFGR_MTI_OFFSET 6 /* Multicast hash enable */
189#define MACB_NCFGR_MTI_SIZE 1
190#define MACB_UNI_OFFSET 7 /* Unicast hash enable */
191#define MACB_UNI_SIZE 1
192#define MACB_BIG_OFFSET 8 /* Receive 1536 byte frames */
193#define MACB_BIG_SIZE 1
194#define MACB_EAE_OFFSET 9 /* External address match enable */
195#define MACB_EAE_SIZE 1
196#define MACB_CLK_OFFSET 10
197#define MACB_CLK_SIZE 2
198#define MACB_RTY_OFFSET 12 /* Retry test */
199#define MACB_RTY_SIZE 1
200#define MACB_PAE_OFFSET 13 /* Pause enable */
201#define MACB_PAE_SIZE 1
202#define MACB_RM9200_RMII_OFFSET 13 /* AT91RM9200 only */
203#define MACB_RM9200_RMII_SIZE 1 /* AT91RM9200 only */
204#define MACB_RBOF_OFFSET 14 /* Receive buffer offset */
205#define MACB_RBOF_SIZE 2
206#define MACB_RLCE_OFFSET 16 /* Length field error frame discard */
207#define MACB_RLCE_SIZE 1
208#define MACB_DRFCS_OFFSET 17 /* FCS remove */
209#define MACB_DRFCS_SIZE 1
210#define MACB_EFRHD_OFFSET 18
211#define MACB_EFRHD_SIZE 1
212#define MACB_IRXFCS_OFFSET 19
213#define MACB_IRXFCS_SIZE 1
89e5785f 214
70c9f3d4 215/* GEM specific NCFGR bitfields. */
6f79eed8
XH
216#define GEM_GBE_OFFSET 10 /* Gigabit mode enable */
217#define GEM_GBE_SIZE 1
022be25c
PCK
218#define GEM_PCSSEL_OFFSET 11
219#define GEM_PCSSEL_SIZE 1
6f79eed8
XH
220#define GEM_CLK_OFFSET 18 /* MDC clock division */
221#define GEM_CLK_SIZE 3
222#define GEM_DBW_OFFSET 21 /* Data bus width */
223#define GEM_DBW_SIZE 2
224#define GEM_RXCOEN_OFFSET 24
225#define GEM_RXCOEN_SIZE 1
022be25c
PCK
226#define GEM_SGMIIEN_OFFSET 27
227#define GEM_SGMIIEN_SIZE 1
228
757a03c6
JI
229
230/* Constants for data bus width. */
6f79eed8
XH
231#define GEM_DBW32 0 /* 32 bit AMBA AHB data bus width */
232#define GEM_DBW64 1 /* 64 bit AMBA AHB data bus width */
233#define GEM_DBW128 2 /* 128 bit AMBA AHB data bus width */
757a03c6 234
0116da4f 235/* Bitfields in DMACFG. */
6f79eed8
XH
236#define GEM_FBLDO_OFFSET 0 /* fixed burst length for DMA */
237#define GEM_FBLDO_SIZE 5
a50dad35 238#define GEM_ENDIA_DESC_OFFSET 6 /* endian swap mode for management descriptor access */
ea373041 239#define GEM_ENDIA_DESC_SIZE 1
a50dad35 240#define GEM_ENDIA_PKT_OFFSET 7 /* endian swap mode for packet data access */
ea373041 241#define GEM_ENDIA_PKT_SIZE 1
6f79eed8
XH
242#define GEM_RXBMS_OFFSET 8 /* RX packet buffer memory size select */
243#define GEM_RXBMS_SIZE 2
244#define GEM_TXPBMS_OFFSET 10 /* TX packet buffer memory size select */
245#define GEM_TXPBMS_SIZE 1
246#define GEM_TXCOEN_OFFSET 11 /* TX IP/TCP/UDP checksum gen offload */
247#define GEM_TXCOEN_SIZE 1
248#define GEM_RXBS_OFFSET 16 /* DMA receive buffer size */
249#define GEM_RXBS_SIZE 8
250#define GEM_DDRP_OFFSET 24 /* disc_when_no_ahb */
251#define GEM_DDRP_SIZE 1
b3e3bd71 252
0116da4f 253
89e5785f 254/* Bitfields in NSR */
6f79eed8
XH
255#define MACB_NSR_LINK_OFFSET 0 /* pcs_link_state */
256#define MACB_NSR_LINK_SIZE 1
257#define MACB_MDIO_OFFSET 1 /* status of the mdio_in pin */
258#define MACB_MDIO_SIZE 1
259#define MACB_IDLE_OFFSET 2 /* The PHY management logic is idle */
260#define MACB_IDLE_SIZE 1
89e5785f
HS
261
262/* Bitfields in TSR */
6f79eed8
XH
263#define MACB_UBR_OFFSET 0 /* Used bit read */
264#define MACB_UBR_SIZE 1
265#define MACB_COL_OFFSET 1 /* Collision occurred */
266#define MACB_COL_SIZE 1
267#define MACB_TSR_RLE_OFFSET 2 /* Retry limit exceeded */
268#define MACB_TSR_RLE_SIZE 1
269#define MACB_TGO_OFFSET 3 /* Transmit go */
270#define MACB_TGO_SIZE 1
271#define MACB_BEX_OFFSET 4 /* TX frame corruption due to AHB error */
272#define MACB_BEX_SIZE 1
273#define MACB_RM9200_BNQ_OFFSET 4 /* AT91RM9200 only */
274#define MACB_RM9200_BNQ_SIZE 1 /* AT91RM9200 only */
275#define MACB_COMP_OFFSET 5 /* Trnasmit complete */
276#define MACB_COMP_SIZE 1
277#define MACB_UND_OFFSET 6 /* Trnasmit under run */
278#define MACB_UND_SIZE 1
89e5785f
HS
279
280/* Bitfields in RSR */
6f79eed8
XH
281#define MACB_BNA_OFFSET 0 /* Buffer not available */
282#define MACB_BNA_SIZE 1
283#define MACB_REC_OFFSET 1 /* Frame received */
284#define MACB_REC_SIZE 1
285#define MACB_OVR_OFFSET 2 /* Receive overrun */
286#define MACB_OVR_SIZE 1
89e5785f
HS
287
288/* Bitfields in ISR/IER/IDR/IMR */
6f79eed8
XH
289#define MACB_MFD_OFFSET 0 /* Management frame sent */
290#define MACB_MFD_SIZE 1
291#define MACB_RCOMP_OFFSET 1 /* Receive complete */
292#define MACB_RCOMP_SIZE 1
293#define MACB_RXUBR_OFFSET 2 /* RX used bit read */
294#define MACB_RXUBR_SIZE 1
295#define MACB_TXUBR_OFFSET 3 /* TX used bit read */
296#define MACB_TXUBR_SIZE 1
297#define MACB_ISR_TUND_OFFSET 4 /* Enable TX buffer under run interrupt */
298#define MACB_ISR_TUND_SIZE 1
299#define MACB_ISR_RLE_OFFSET 5 /* EN retry exceeded/late coll interrupt */
300#define MACB_ISR_RLE_SIZE 1
301#define MACB_TXERR_OFFSET 6 /* EN TX frame corrupt from error interrupt */
302#define MACB_TXERR_SIZE 1
303#define MACB_TCOMP_OFFSET 7 /* Enable transmit complete interrupt */
304#define MACB_TCOMP_SIZE 1
305#define MACB_ISR_LINK_OFFSET 9 /* Enable link change interrupt */
306#define MACB_ISR_LINK_SIZE 1
307#define MACB_ISR_ROVR_OFFSET 10 /* Enable receive overrun interrupt */
308#define MACB_ISR_ROVR_SIZE 1
309#define MACB_HRESP_OFFSET 11 /* Enable hrsep not OK interrupt */
310#define MACB_HRESP_SIZE 1
311#define MACB_PFR_OFFSET 12 /* Enable pause frame w/ quantum interrupt */
312#define MACB_PFR_SIZE 1
313#define MACB_PTZ_OFFSET 13 /* Enable pause time zero interrupt */
314#define MACB_PTZ_SIZE 1
89e5785f
HS
315
316/* Bitfields in MAN */
6f79eed8
XH
317#define MACB_DATA_OFFSET 0 /* data */
318#define MACB_DATA_SIZE 16
319#define MACB_CODE_OFFSET 16 /* Must be written to 10 */
320#define MACB_CODE_SIZE 2
321#define MACB_REGA_OFFSET 18 /* Register address */
322#define MACB_REGA_SIZE 5
323#define MACB_PHYA_OFFSET 23 /* PHY address */
324#define MACB_PHYA_SIZE 5
325#define MACB_RW_OFFSET 28 /* Operation. 10 is read. 01 is write. */
326#define MACB_RW_SIZE 2
327#define MACB_SOF_OFFSET 30 /* Must be written to 1 for Clause 22 */
328#define MACB_SOF_SIZE 2
89e5785f 329
0cc8674f 330/* Bitfields in USRIO (AVR32) */
89e5785f
HS
331#define MACB_MII_OFFSET 0
332#define MACB_MII_SIZE 1
333#define MACB_EAM_OFFSET 1
334#define MACB_EAM_SIZE 1
335#define MACB_TX_PAUSE_OFFSET 2
336#define MACB_TX_PAUSE_SIZE 1
337#define MACB_TX_PAUSE_ZERO_OFFSET 3
338#define MACB_TX_PAUSE_ZERO_SIZE 1
339
0cc8674f
AV
340/* Bitfields in USRIO (AT91) */
341#define MACB_RMII_OFFSET 0
342#define MACB_RMII_SIZE 1
5c2fa0f6 343#define GEM_RGMII_OFFSET 0 /* GEM gigabit mode */
140b7552 344#define GEM_RGMII_SIZE 1
0cc8674f
AV
345#define MACB_CLKEN_OFFSET 1
346#define MACB_CLKEN_SIZE 1
347
89e5785f
HS
348/* Bitfields in WOL */
349#define MACB_IP_OFFSET 0
350#define MACB_IP_SIZE 16
351#define MACB_MAG_OFFSET 16
352#define MACB_MAG_SIZE 1
353#define MACB_ARP_OFFSET 17
354#define MACB_ARP_SIZE 1
355#define MACB_SA1_OFFSET 18
356#define MACB_SA1_SIZE 1
357#define MACB_WOL_MTI_OFFSET 19
358#define MACB_WOL_MTI_SIZE 1
359
f75ba50b
JI
360/* Bitfields in MID */
361#define MACB_IDNUM_OFFSET 16
d941bebf 362#define MACB_IDNUM_SIZE 12
f75ba50b
JI
363#define MACB_REV_OFFSET 0
364#define MACB_REV_SIZE 16
365
757a03c6 366/* Bitfields in DCFG1. */
581df9e1
NF
367#define GEM_IRQCOR_OFFSET 23
368#define GEM_IRQCOR_SIZE 1
757a03c6
JI
369#define GEM_DBWDEF_OFFSET 25
370#define GEM_DBWDEF_SIZE 3
371
e175587f
NF
372/* Bitfields in DCFG2. */
373#define GEM_RX_PKT_BUFF_OFFSET 20
374#define GEM_RX_PKT_BUFF_SIZE 1
375#define GEM_TX_PKT_BUFF_OFFSET 21
376#define GEM_TX_PKT_BUFF_SIZE 1
377
89e5785f
HS
378/* Constants for CLK */
379#define MACB_CLK_DIV8 0
380#define MACB_CLK_DIV16 1
381#define MACB_CLK_DIV32 2
382#define MACB_CLK_DIV64 3
383
70c9f3d4
JI
384/* GEM specific constants for CLK. */
385#define GEM_CLK_DIV8 0
386#define GEM_CLK_DIV16 1
387#define GEM_CLK_DIV32 2
388#define GEM_CLK_DIV48 3
389#define GEM_CLK_DIV64 4
390#define GEM_CLK_DIV96 5
391
89e5785f
HS
392/* Constants for MAN register */
393#define MACB_MAN_SOF 1
394#define MACB_MAN_WRITE 1
395#define MACB_MAN_READ 2
396#define MACB_MAN_CODE 2
397
581df9e1 398/* Capability mask bits */
e175587f 399#define MACB_CAPS_ISR_CLEAR_ON_WRITE 0x00000001
a8487489
BB
400#define MACB_CAPS_USRIO_HAS_CLKEN 0x00000002
401#define MACB_CAPS_USRIO_DEFAULT_IS_MII 0x00000004
222ca8e0 402#define MACB_CAPS_NO_GIGABIT_HALF 0x00000008
e175587f
NF
403#define MACB_CAPS_FIFO_MODE 0x10000000
404#define MACB_CAPS_GIGABIT_MODE_AVAILABLE 0x20000000
a4c35ed3 405#define MACB_CAPS_SG_DISABLED 0x40000000
e175587f 406#define MACB_CAPS_MACB_IS_GEM 0x80000000
9ece39ab 407#define MACB_CAPS_JUMBO 0x00000010
581df9e1 408
89e5785f
HS
409/* Bit manipulation macros */
410#define MACB_BIT(name) \
411 (1 << MACB_##name##_OFFSET)
412#define MACB_BF(name,value) \
413 (((value) & ((1 << MACB_##name##_SIZE) - 1)) \
414 << MACB_##name##_OFFSET)
415#define MACB_BFEXT(name,value)\
416 (((value) >> MACB_##name##_OFFSET) \
417 & ((1 << MACB_##name##_SIZE) - 1))
418#define MACB_BFINS(name,value,old) \
419 (((old) & ~(((1 << MACB_##name##_SIZE) - 1) \
420 << MACB_##name##_OFFSET)) \
421 | MACB_BF(name,value))
422
f75ba50b
JI
423#define GEM_BIT(name) \
424 (1 << GEM_##name##_OFFSET)
425#define GEM_BF(name, value) \
426 (((value) & ((1 << GEM_##name##_SIZE) - 1)) \
427 << GEM_##name##_OFFSET)
428#define GEM_BFEXT(name, value)\
429 (((value) >> GEM_##name##_OFFSET) \
430 & ((1 << GEM_##name##_SIZE) - 1))
431#define GEM_BFINS(name, value, old) \
432 (((old) & ~(((1 << GEM_##name##_SIZE) - 1) \
433 << GEM_##name##_OFFSET)) \
434 | GEM_BF(name, value))
435
89e5785f 436/* Register access macros */
7a6e0706
DM
437#define macb_readl(port, reg) (port)->macb_reg_readl((port), MACB_##reg)
438#define macb_writel(port, reg, value) (port)->macb_reg_writel((port), MACB_##reg, (value))
439#define gem_readl(port, reg) (port)->macb_reg_readl((port), GEM_##reg)
440#define gem_writel(port, reg, value) (port)->macb_reg_writel((port), GEM_##reg, (value))
441#define queue_readl(queue, reg) (queue)->bp->macb_reg_readl((queue)->bp, (queue)->reg)
442#define queue_writel(queue, reg, value) (queue)->bp->macb_reg_writel((queue)->bp, (queue)->reg, (value))
f75ba50b 443
6f79eed8 444/* Conditional GEM/MACB macros. These perform the operation to the correct
f75ba50b
JI
445 * register dependent on whether the device is a GEM or a MACB. For registers
446 * and bitfields that are common across both devices, use macb_{read,write}l
447 * to avoid the cost of the conditional.
448 */
449#define macb_or_gem_writel(__bp, __reg, __value) \
450 ({ \
451 if (macb_is_gem((__bp))) \
452 gem_writel((__bp), __reg, __value); \
453 else \
454 macb_writel((__bp), __reg, __value); \
455 })
456
457#define macb_or_gem_readl(__bp, __reg) \
458 ({ \
459 u32 __v; \
460 if (macb_is_gem((__bp))) \
461 __v = gem_readl((__bp), __reg); \
462 else \
463 __v = macb_readl((__bp), __reg); \
464 __v; \
465 })
89e5785f 466
6f79eed8 467/* struct macb_dma_desc - Hardware DMA descriptor
55054a16
HS
468 * @addr: DMA address of data buffer
469 * @ctrl: Control and status bits
470 */
471struct macb_dma_desc {
89e5785f
HS
472 u32 addr;
473 u32 ctrl;
474};
475
476/* DMA descriptor bitfields */
477#define MACB_RX_USED_OFFSET 0
478#define MACB_RX_USED_SIZE 1
479#define MACB_RX_WRAP_OFFSET 1
480#define MACB_RX_WRAP_SIZE 1
481#define MACB_RX_WADDR_OFFSET 2
482#define MACB_RX_WADDR_SIZE 30
483
484#define MACB_RX_FRMLEN_OFFSET 0
485#define MACB_RX_FRMLEN_SIZE 12
486#define MACB_RX_OFFSET_OFFSET 12
487#define MACB_RX_OFFSET_SIZE 2
488#define MACB_RX_SOF_OFFSET 14
489#define MACB_RX_SOF_SIZE 1
490#define MACB_RX_EOF_OFFSET 15
491#define MACB_RX_EOF_SIZE 1
492#define MACB_RX_CFI_OFFSET 16
493#define MACB_RX_CFI_SIZE 1
494#define MACB_RX_VLAN_PRI_OFFSET 17
495#define MACB_RX_VLAN_PRI_SIZE 3
496#define MACB_RX_PRI_TAG_OFFSET 20
497#define MACB_RX_PRI_TAG_SIZE 1
498#define MACB_RX_VLAN_TAG_OFFSET 21
499#define MACB_RX_VLAN_TAG_SIZE 1
500#define MACB_RX_TYPEID_MATCH_OFFSET 22
501#define MACB_RX_TYPEID_MATCH_SIZE 1
502#define MACB_RX_SA4_MATCH_OFFSET 23
503#define MACB_RX_SA4_MATCH_SIZE 1
504#define MACB_RX_SA3_MATCH_OFFSET 24
505#define MACB_RX_SA3_MATCH_SIZE 1
506#define MACB_RX_SA2_MATCH_OFFSET 25
507#define MACB_RX_SA2_MATCH_SIZE 1
508#define MACB_RX_SA1_MATCH_OFFSET 26
509#define MACB_RX_SA1_MATCH_SIZE 1
510#define MACB_RX_EXT_MATCH_OFFSET 28
511#define MACB_RX_EXT_MATCH_SIZE 1
512#define MACB_RX_UHASH_MATCH_OFFSET 29
513#define MACB_RX_UHASH_MATCH_SIZE 1
514#define MACB_RX_MHASH_MATCH_OFFSET 30
515#define MACB_RX_MHASH_MATCH_SIZE 1
516#define MACB_RX_BROADCAST_OFFSET 31
517#define MACB_RX_BROADCAST_SIZE 1
518
98b5a0f4
HK
519#define MACB_RX_FRMLEN_MASK 0xFFF
520#define MACB_RX_JFRMLEN_MASK 0x3FFF
521
924ec53c
CP
522/* RX checksum offload disabled: bit 24 clear in NCFGR */
523#define GEM_RX_TYPEID_MATCH_OFFSET 22
524#define GEM_RX_TYPEID_MATCH_SIZE 2
525
526/* RX checksum offload enabled: bit 24 set in NCFGR */
527#define GEM_RX_CSUM_OFFSET 22
528#define GEM_RX_CSUM_SIZE 2
529
89e5785f
HS
530#define MACB_TX_FRMLEN_OFFSET 0
531#define MACB_TX_FRMLEN_SIZE 11
532#define MACB_TX_LAST_OFFSET 15
533#define MACB_TX_LAST_SIZE 1
534#define MACB_TX_NOCRC_OFFSET 16
535#define MACB_TX_NOCRC_SIZE 1
536#define MACB_TX_BUF_EXHAUSTED_OFFSET 27
537#define MACB_TX_BUF_EXHAUSTED_SIZE 1
538#define MACB_TX_UNDERRUN_OFFSET 28
539#define MACB_TX_UNDERRUN_SIZE 1
540#define MACB_TX_ERROR_OFFSET 29
541#define MACB_TX_ERROR_SIZE 1
542#define MACB_TX_WRAP_OFFSET 30
543#define MACB_TX_WRAP_SIZE 1
544#define MACB_TX_USED_OFFSET 31
545#define MACB_TX_USED_SIZE 1
546
a4c35ed3
CP
547#define GEM_TX_FRMLEN_OFFSET 0
548#define GEM_TX_FRMLEN_SIZE 14
549
924ec53c
CP
550/* Buffer descriptor constants */
551#define GEM_RX_CSUM_NONE 0
552#define GEM_RX_CSUM_IP_ONLY 1
553#define GEM_RX_CSUM_IP_TCP 2
554#define GEM_RX_CSUM_IP_UDP 3
555
556/* limit RX checksum offload to TCP and UDP packets */
557#define GEM_RX_CSUM_CHECKED_MASK 2
558
6f79eed8 559/* struct macb_tx_skb - data about an skb which is being transmitted
a4c35ed3
CP
560 * @skb: skb currently being transmitted, only set for the last buffer
561 * of the frame
562 * @mapping: DMA address of the skb's fragment buffer
563 * @size: size of the DMA mapped buffer
564 * @mapped_as_page: true when buffer was mapped with skb_frag_dma_map(),
565 * false when buffer was mapped with dma_map_single()
55054a16
HS
566 */
567struct macb_tx_skb {
89e5785f
HS
568 struct sk_buff *skb;
569 dma_addr_t mapping;
a4c35ed3
CP
570 size_t size;
571 bool mapped_as_page;
89e5785f
HS
572};
573
6f79eed8 574/* Hardware-collected statistics. Used when updating the network
89e5785f
HS
575 * device stats by a periodic timer.
576 */
577struct macb_stats {
578 u32 rx_pause_frames;
579 u32 tx_ok;
580 u32 tx_single_cols;
581 u32 tx_multiple_cols;
582 u32 rx_ok;
583 u32 rx_fcs_errors;
584 u32 rx_align_errors;
585 u32 tx_deferred;
586 u32 tx_late_cols;
587 u32 tx_excessive_cols;
588 u32 tx_underruns;
589 u32 tx_carrier_errors;
590 u32 rx_resource_errors;
591 u32 rx_overruns;
592 u32 rx_symbol_errors;
593 u32 rx_oversize_pkts;
594 u32 rx_jabbers;
595 u32 rx_undersize_pkts;
596 u32 sqe_test_errors;
597 u32 rx_length_mismatch;
598 u32 tx_pause_frames;
599};
600
a494ed8e
JI
601struct gem_stats {
602 u32 tx_octets_31_0;
603 u32 tx_octets_47_32;
604 u32 tx_frames;
605 u32 tx_broadcast_frames;
606 u32 tx_multicast_frames;
607 u32 tx_pause_frames;
608 u32 tx_64_byte_frames;
609 u32 tx_65_127_byte_frames;
610 u32 tx_128_255_byte_frames;
611 u32 tx_256_511_byte_frames;
612 u32 tx_512_1023_byte_frames;
613 u32 tx_1024_1518_byte_frames;
614 u32 tx_greater_than_1518_byte_frames;
615 u32 tx_underrun;
616 u32 tx_single_collision_frames;
617 u32 tx_multiple_collision_frames;
618 u32 tx_excessive_collisions;
619 u32 tx_late_collisions;
620 u32 tx_deferred_frames;
621 u32 tx_carrier_sense_errors;
622 u32 rx_octets_31_0;
623 u32 rx_octets_47_32;
624 u32 rx_frames;
625 u32 rx_broadcast_frames;
626 u32 rx_multicast_frames;
627 u32 rx_pause_frames;
628 u32 rx_64_byte_frames;
629 u32 rx_65_127_byte_frames;
630 u32 rx_128_255_byte_frames;
631 u32 rx_256_511_byte_frames;
632 u32 rx_512_1023_byte_frames;
633 u32 rx_1024_1518_byte_frames;
634 u32 rx_greater_than_1518_byte_frames;
635 u32 rx_undersized_frames;
636 u32 rx_oversize_frames;
637 u32 rx_jabbers;
638 u32 rx_frame_check_sequence_errors;
639 u32 rx_length_field_frame_errors;
640 u32 rx_symbol_errors;
641 u32 rx_alignment_errors;
642 u32 rx_resource_errors;
643 u32 rx_overruns;
644 u32 rx_ip_header_checksum_errors;
645 u32 rx_tcp_checksum_errors;
646 u32 rx_udp_checksum_errors;
647};
648
3ff13f1c
XH
649/* Describes the name and offset of an individual statistic register, as
650 * returned by `ethtool -S`. Also describes which net_device_stats statistics
651 * this register should contribute to.
652 */
653struct gem_statistic {
654 char stat_string[ETH_GSTRING_LEN];
655 int offset;
656 u32 stat_bits;
657};
658
659/* Bitfield defs for net_device_stat statistics */
660#define GEM_NDS_RXERR_OFFSET 0
661#define GEM_NDS_RXLENERR_OFFSET 1
662#define GEM_NDS_RXOVERERR_OFFSET 2
663#define GEM_NDS_RXCRCERR_OFFSET 3
664#define GEM_NDS_RXFRAMEERR_OFFSET 4
665#define GEM_NDS_RXFIFOERR_OFFSET 5
666#define GEM_NDS_TXERR_OFFSET 6
667#define GEM_NDS_TXABORTEDERR_OFFSET 7
668#define GEM_NDS_TXCARRIERERR_OFFSET 8
669#define GEM_NDS_TXFIFOERR_OFFSET 9
670#define GEM_NDS_COLLISIONS_OFFSET 10
671
672#define GEM_STAT_TITLE(name, title) GEM_STAT_TITLE_BITS(name, title, 0)
673#define GEM_STAT_TITLE_BITS(name, title, bits) { \
674 .stat_string = title, \
675 .offset = GEM_##name, \
676 .stat_bits = bits \
677}
678
679/* list of gem statistic registers. The names MUST match the
680 * corresponding GEM_* definitions.
681 */
682static const struct gem_statistic gem_statistics[] = {
683 GEM_STAT_TITLE(OCTTXL, "tx_octets"), /* OCTTXH combined with OCTTXL */
684 GEM_STAT_TITLE(TXCNT, "tx_frames"),
685 GEM_STAT_TITLE(TXBCCNT, "tx_broadcast_frames"),
686 GEM_STAT_TITLE(TXMCCNT, "tx_multicast_frames"),
687 GEM_STAT_TITLE(TXPAUSECNT, "tx_pause_frames"),
688 GEM_STAT_TITLE(TX64CNT, "tx_64_byte_frames"),
689 GEM_STAT_TITLE(TX65CNT, "tx_65_127_byte_frames"),
690 GEM_STAT_TITLE(TX128CNT, "tx_128_255_byte_frames"),
691 GEM_STAT_TITLE(TX256CNT, "tx_256_511_byte_frames"),
692 GEM_STAT_TITLE(TX512CNT, "tx_512_1023_byte_frames"),
693 GEM_STAT_TITLE(TX1024CNT, "tx_1024_1518_byte_frames"),
694 GEM_STAT_TITLE(TX1519CNT, "tx_greater_than_1518_byte_frames"),
695 GEM_STAT_TITLE_BITS(TXURUNCNT, "tx_underrun",
696 GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_TXFIFOERR)),
697 GEM_STAT_TITLE_BITS(SNGLCOLLCNT, "tx_single_collision_frames",
698 GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
699 GEM_STAT_TITLE_BITS(MULTICOLLCNT, "tx_multiple_collision_frames",
700 GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
701 GEM_STAT_TITLE_BITS(EXCESSCOLLCNT, "tx_excessive_collisions",
702 GEM_BIT(NDS_TXERR)|
703 GEM_BIT(NDS_TXABORTEDERR)|
704 GEM_BIT(NDS_COLLISIONS)),
705 GEM_STAT_TITLE_BITS(LATECOLLCNT, "tx_late_collisions",
706 GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
707 GEM_STAT_TITLE(TXDEFERCNT, "tx_deferred_frames"),
708 GEM_STAT_TITLE_BITS(TXCSENSECNT, "tx_carrier_sense_errors",
709 GEM_BIT(NDS_TXERR)|GEM_BIT(NDS_COLLISIONS)),
710 GEM_STAT_TITLE(OCTRXL, "rx_octets"), /* OCTRXH combined with OCTRXL */
711 GEM_STAT_TITLE(RXCNT, "rx_frames"),
712 GEM_STAT_TITLE(RXBROADCNT, "rx_broadcast_frames"),
713 GEM_STAT_TITLE(RXMULTICNT, "rx_multicast_frames"),
714 GEM_STAT_TITLE(RXPAUSECNT, "rx_pause_frames"),
715 GEM_STAT_TITLE(RX64CNT, "rx_64_byte_frames"),
716 GEM_STAT_TITLE(RX65CNT, "rx_65_127_byte_frames"),
717 GEM_STAT_TITLE(RX128CNT, "rx_128_255_byte_frames"),
718 GEM_STAT_TITLE(RX256CNT, "rx_256_511_byte_frames"),
719 GEM_STAT_TITLE(RX512CNT, "rx_512_1023_byte_frames"),
720 GEM_STAT_TITLE(RX1024CNT, "rx_1024_1518_byte_frames"),
721 GEM_STAT_TITLE(RX1519CNT, "rx_greater_than_1518_byte_frames"),
722 GEM_STAT_TITLE_BITS(RXUNDRCNT, "rx_undersized_frames",
723 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXLENERR)),
724 GEM_STAT_TITLE_BITS(RXOVRCNT, "rx_oversize_frames",
725 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXLENERR)),
726 GEM_STAT_TITLE_BITS(RXJABCNT, "rx_jabbers",
727 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXLENERR)),
728 GEM_STAT_TITLE_BITS(RXFCSCNT, "rx_frame_check_sequence_errors",
729 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXCRCERR)),
730 GEM_STAT_TITLE_BITS(RXLENGTHCNT, "rx_length_field_frame_errors",
731 GEM_BIT(NDS_RXERR)),
732 GEM_STAT_TITLE_BITS(RXSYMBCNT, "rx_symbol_errors",
733 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXFRAMEERR)),
734 GEM_STAT_TITLE_BITS(RXALIGNCNT, "rx_alignment_errors",
735 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXOVERERR)),
736 GEM_STAT_TITLE_BITS(RXRESERRCNT, "rx_resource_errors",
737 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXOVERERR)),
738 GEM_STAT_TITLE_BITS(RXORCNT, "rx_overruns",
739 GEM_BIT(NDS_RXERR)|GEM_BIT(NDS_RXFIFOERR)),
740 GEM_STAT_TITLE_BITS(RXIPCCNT, "rx_ip_header_checksum_errors",
741 GEM_BIT(NDS_RXERR)),
742 GEM_STAT_TITLE_BITS(RXTCPCCNT, "rx_tcp_checksum_errors",
743 GEM_BIT(NDS_RXERR)),
744 GEM_STAT_TITLE_BITS(RXUDPCCNT, "rx_udp_checksum_errors",
745 GEM_BIT(NDS_RXERR)),
746};
747
748#define GEM_STATS_LEN ARRAY_SIZE(gem_statistics)
749
4df95131
NF
750struct macb;
751
752struct macb_or_gem_ops {
753 int (*mog_alloc_rx_buffers)(struct macb *bp);
754 void (*mog_free_rx_buffers)(struct macb *bp);
755 void (*mog_init_rings)(struct macb *bp);
756 int (*mog_rx)(struct macb *bp, int budget);
757};
758
e175587f
NF
759struct macb_config {
760 u32 caps;
761 unsigned int dma_burst_length;
c69618b3
NF
762 int (*clk_init)(struct platform_device *pdev, struct clk **pclk,
763 struct clk **hclk, struct clk **tx_clk);
421d9df0 764 int (*init)(struct platform_device *pdev);
98b5a0f4 765 int jumbo_max_len;
e175587f
NF
766};
767
02c958dd
CP
768struct macb_queue {
769 struct macb *bp;
770 int irq;
771
772 unsigned int ISR;
773 unsigned int IER;
774 unsigned int IDR;
775 unsigned int IMR;
776 unsigned int TBQP;
777
778 unsigned int tx_head, tx_tail;
779 struct macb_dma_desc *tx_ring;
780 struct macb_tx_skb *tx_skb;
781 dma_addr_t tx_ring_dma;
782 struct work_struct tx_error_task;
783};
784
89e5785f
HS
785struct macb {
786 void __iomem *regs;
f2ce8a9e
AS
787 bool native_io;
788
789 /* hardware IO accessors */
7a6e0706
DM
790 u32 (*macb_reg_readl)(struct macb *bp, int offset);
791 void (*macb_reg_writel)(struct macb *bp, int offset, u32 value);
89e5785f
HS
792
793 unsigned int rx_tail;
4df95131 794 unsigned int rx_prepared_head;
55054a16 795 struct macb_dma_desc *rx_ring;
4df95131 796 struct sk_buff **rx_skbuff;
89e5785f 797 void *rx_buffers;
1b44791a 798 size_t rx_buffer_size;
89e5785f 799
02c958dd 800 unsigned int num_queues;
bfa0914a 801 unsigned int queue_mask;
02c958dd 802 struct macb_queue queues[MACB_MAX_QUEUES];
89e5785f
HS
803
804 spinlock_t lock;
805 struct platform_device *pdev;
806 struct clk *pclk;
807 struct clk *hclk;
e1824dfe 808 struct clk *tx_clk;
89e5785f 809 struct net_device *dev;
bea3348e 810 struct napi_struct napi;
89e5785f 811 struct net_device_stats stats;
a494ed8e
JI
812 union {
813 struct macb_stats macb;
814 struct gem_stats gem;
815 } hw_stats;
89e5785f
HS
816
817 dma_addr_t rx_ring_dma;
89e5785f
HS
818 dma_addr_t rx_buffers_dma;
819
4df95131
NF
820 struct macb_or_gem_ops macbgem_ops;
821
298cf9be 822 struct mii_bus *mii_bus;
6c36a707 823 struct phy_device *phy_dev;
8bcbf82f
AS
824 int link;
825 int speed;
826 int duplex;
fb97a846 827
581df9e1 828 u32 caps;
e175587f 829 unsigned int dma_burst_length;
581df9e1 830
fb97a846 831 phy_interface_t phy_interface;
b85008b7 832
4dda6f6d 833 /* AT91RM9200 transmit */
b85008b7
JE
834 struct sk_buff *skb; /* holds skb until xmit interrupt completes */
835 dma_addr_t skb_physaddr; /* phys addr from pci_map_single */
836 int skb_length; /* saved skb length for pci_unmap_single */
a4c35ed3 837 unsigned int max_tx_length;
3ff13f1c
XH
838
839 u64 ethtool_stats[GEM_STATS_LEN];
98b5a0f4
HK
840
841 unsigned int rx_frm_len_mask;
842 unsigned int jumbo_max_len;
89e5785f
HS
843};
844
f75ba50b
JI
845static inline bool macb_is_gem(struct macb *bp)
846{
e175587f 847 return !!(bp->caps & MACB_CAPS_MACB_IS_GEM);
f75ba50b
JI
848}
849
89e5785f 850#endif /* _MACB_H */