2 * Copyright 2010-2011 Calxeda, Inc.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program. If not, see <http://www.gnu.org/licenses/>.
19 #include <linux/compiler.h>
20 #include <linux/err.h>
24 #define RX_NUM_DESC 32
26 #define MAC_TIMEOUT (5*CONFIG_SYS_HZ)
28 #define ETH_BUF_SZ 2048
29 #define TX_BUF_SZ (ETH_BUF_SZ * TX_NUM_DESC)
30 #define RX_BUF_SZ (ETH_BUF_SZ * RX_NUM_DESC)
32 #define RXSTART 0x00000002
33 #define TXSTART 0x00002000
35 #define RXENABLE 0x00000004
36 #define TXENABLE 0x00000008
38 #define XGMAC_CONTROL_SPD 0x40000000
39 #define XGMAC_CONTROL_SPD_MASK 0x60000000
40 #define XGMAC_CONTROL_SARC 0x10000000
41 #define XGMAC_CONTROL_SARK_MASK 0x18000000
42 #define XGMAC_CONTROL_CAR 0x04000000
43 #define XGMAC_CONTROL_CAR_MASK 0x06000000
44 #define XGMAC_CONTROL_CAR_SHIFT 25
45 #define XGMAC_CONTROL_DP 0x01000000
46 #define XGMAC_CONTROL_WD 0x00800000
47 #define XGMAC_CONTROL_JD 0x00400000
48 #define XGMAC_CONTROL_JE 0x00100000
49 #define XGMAC_CONTROL_LM 0x00001000
50 #define XGMAC_CONTROL_IPC 0x00000400
51 #define XGMAC_CONTROL_ACS 0x00000080
52 #define XGMAC_CONTROL_DDIC 0x00000010
53 #define XGMAC_CONTROL_TE 0x00000008
54 #define XGMAC_CONTROL_RE 0x00000004
56 #define XGMAC_DMA_BUSMODE_RESET 0x00000001
57 #define XGMAC_DMA_BUSMODE_DSL 0x00000004
58 #define XGMAC_DMA_BUSMODE_DSL_MASK 0x0000007c
59 #define XGMAC_DMA_BUSMODE_DSL_SHIFT 2
60 #define XGMAC_DMA_BUSMODE_ATDS 0x00000080
61 #define XGMAC_DMA_BUSMODE_PBL_MASK 0x00003f00
62 #define XGMAC_DMA_BUSMODE_PBL_SHIFT 8
63 #define XGMAC_DMA_BUSMODE_FB 0x00010000
64 #define XGMAC_DMA_BUSMODE_USP 0x00800000
65 #define XGMAC_DMA_BUSMODE_8PBL 0x01000000
66 #define XGMAC_DMA_BUSMODE_AAL 0x02000000
68 #define XGMAC_DMA_AXIMODE_ENLPI 0x80000000
69 #define XGMAC_DMA_AXIMODE_MGK 0x40000000
70 #define XGMAC_DMA_AXIMODE_WROSR 0x00100000
71 #define XGMAC_DMA_AXIMODE_WROSR_MASK 0x00F00000
72 #define XGMAC_DMA_AXIMODE_WROSR_SHIFT 20
73 #define XGMAC_DMA_AXIMODE_RDOSR 0x00010000
74 #define XGMAC_DMA_AXIMODE_RDOSR_MASK 0x000F0000
75 #define XGMAC_DMA_AXIMODE_RDOSR_SHIFT 16
76 #define XGMAC_DMA_AXIMODE_AAL 0x00001000
77 #define XGMAC_DMA_AXIMODE_BLEN256 0x00000080
78 #define XGMAC_DMA_AXIMODE_BLEN128 0x00000040
79 #define XGMAC_DMA_AXIMODE_BLEN64 0x00000020
80 #define XGMAC_DMA_AXIMODE_BLEN32 0x00000010
81 #define XGMAC_DMA_AXIMODE_BLEN16 0x00000008
82 #define XGMAC_DMA_AXIMODE_BLEN8 0x00000004
83 #define XGMAC_DMA_AXIMODE_BLEN4 0x00000002
84 #define XGMAC_DMA_AXIMODE_UNDEF 0x00000001
86 #define XGMAC_CORE_OMR_RTC_SHIFT 3
87 #define XGMAC_CORE_OMR_RTC_MASK 0x00000018
88 #define XGMAC_CORE_OMR_RTC 0x00000010
89 #define XGMAC_CORE_OMR_RSF 0x00000020
90 #define XGMAC_CORE_OMR_DT 0x00000040
91 #define XGMAC_CORE_OMR_FEF 0x00000080
92 #define XGMAC_CORE_OMR_EFC 0x00000100
93 #define XGMAC_CORE_OMR_RFA_SHIFT 9
94 #define XGMAC_CORE_OMR_RFA_MASK 0x00000E00
95 #define XGMAC_CORE_OMR_RFD_SHIFT 12
96 #define XGMAC_CORE_OMR_RFD_MASK 0x00007000
97 #define XGMAC_CORE_OMR_TTC_SHIFT 16
98 #define XGMAC_CORE_OMR_TTC_MASK 0x00030000
99 #define XGMAC_CORE_OMR_TTC 0x00020000
100 #define XGMAC_CORE_OMR_FTF 0x00100000
101 #define XGMAC_CORE_OMR_TSF 0x00200000
103 #define FIFO_MINUS_1K 0x0
104 #define FIFO_MINUS_2K 0x1
105 #define FIFO_MINUS_3K 0x2
106 #define FIFO_MINUS_4K 0x3
107 #define FIFO_MINUS_6K 0x4
108 #define FIFO_MINUS_8K 0x5
109 #define FIFO_MINUS_12K 0x6
110 #define FIFO_MINUS_16K 0x7
112 #define XGMAC_CORE_FLOW_PT_SHIFT 16
113 #define XGMAC_CORE_FLOW_PT_MASK 0xFFFF0000
114 #define XGMAC_CORE_FLOW_PT 0x00010000
115 #define XGMAC_CORE_FLOW_DZQP 0x00000080
116 #define XGMAC_CORE_FLOW_PLT_SHIFT 4
117 #define XGMAC_CORE_FLOW_PLT_MASK 0x00000030
118 #define XGMAC_CORE_FLOW_PLT 0x00000010
119 #define XGMAC_CORE_FLOW_UP 0x00000008
120 #define XGMAC_CORE_FLOW_RFE 0x00000004
121 #define XGMAC_CORE_FLOW_TFE 0x00000002
122 #define XGMAC_CORE_FLOW_FCB 0x00000001
124 /* XGMAC Descriptor Defines */
125 #define MAX_DESC_BUF_SZ (0x2000 - 8)
127 #define RXDESC_EXT_STATUS 0x00000001
128 #define RXDESC_CRC_ERR 0x00000002
129 #define RXDESC_RX_ERR 0x00000008
130 #define RXDESC_RX_WDOG 0x00000010
131 #define RXDESC_FRAME_TYPE 0x00000020
132 #define RXDESC_GIANT_FRAME 0x00000080
133 #define RXDESC_LAST_SEG 0x00000100
134 #define RXDESC_FIRST_SEG 0x00000200
135 #define RXDESC_VLAN_FRAME 0x00000400
136 #define RXDESC_OVERFLOW_ERR 0x00000800
137 #define RXDESC_LENGTH_ERR 0x00001000
138 #define RXDESC_SA_FILTER_FAIL 0x00002000
139 #define RXDESC_DESCRIPTOR_ERR 0x00004000
140 #define RXDESC_ERROR_SUMMARY 0x00008000
141 #define RXDESC_FRAME_LEN_OFFSET 16
142 #define RXDESC_FRAME_LEN_MASK 0x3fff0000
143 #define RXDESC_DA_FILTER_FAIL 0x40000000
145 #define RXDESC1_END_RING 0x00008000
147 #define RXDESC_IP_PAYLOAD_MASK 0x00000003
148 #define RXDESC_IP_PAYLOAD_UDP 0x00000001
149 #define RXDESC_IP_PAYLOAD_TCP 0x00000002
150 #define RXDESC_IP_PAYLOAD_ICMP 0x00000003
151 #define RXDESC_IP_HEADER_ERR 0x00000008
152 #define RXDESC_IP_PAYLOAD_ERR 0x00000010
153 #define RXDESC_IPV4_PACKET 0x00000040
154 #define RXDESC_IPV6_PACKET 0x00000080
155 #define TXDESC_UNDERFLOW_ERR 0x00000001
156 #define TXDESC_JABBER_TIMEOUT 0x00000002
157 #define TXDESC_LOCAL_FAULT 0x00000004
158 #define TXDESC_REMOTE_FAULT 0x00000008
159 #define TXDESC_VLAN_FRAME 0x00000010
160 #define TXDESC_FRAME_FLUSHED 0x00000020
161 #define TXDESC_IP_HEADER_ERR 0x00000040
162 #define TXDESC_PAYLOAD_CSUM_ERR 0x00000080
163 #define TXDESC_ERROR_SUMMARY 0x00008000
164 #define TXDESC_SA_CTRL_INSERT 0x00040000
165 #define TXDESC_SA_CTRL_REPLACE 0x00080000
166 #define TXDESC_2ND_ADDR_CHAINED 0x00100000
167 #define TXDESC_END_RING 0x00200000
168 #define TXDESC_CSUM_IP 0x00400000
169 #define TXDESC_CSUM_IP_PAYLD 0x00800000
170 #define TXDESC_CSUM_ALL 0x00C00000
171 #define TXDESC_CRC_EN_REPLACE 0x01000000
172 #define TXDESC_CRC_EN_APPEND 0x02000000
173 #define TXDESC_DISABLE_PAD 0x04000000
174 #define TXDESC_FIRST_SEG 0x10000000
175 #define TXDESC_LAST_SEG 0x20000000
176 #define TXDESC_INTERRUPT 0x40000000
178 #define DESC_OWN 0x80000000
179 #define DESC_BUFFER1_SZ_MASK 0x00001fff
180 #define DESC_BUFFER2_SZ_MASK 0x1fff0000
181 #define DESC_BUFFER2_SZ_OFFSET 16
201 u32 core_opmode
; /* 0x400 */
203 u32 busmode
; /* 0xf00 */
212 u32 axi_mode
; /* 0xf28 */
215 struct xgmac_dma_desc
{
218 __le32 buf1_addr
; /* Buffer 1 Address Pointer */
219 __le32 buf2_addr
; /* Buffer 2 Address Pointer */
224 /* XGMAC Descriptor Access Helpers */
225 static inline void desc_set_buf_len(struct xgmac_dma_desc
*p
, u32 buf_sz
)
227 if (buf_sz
> MAX_DESC_BUF_SZ
)
228 p
->buf_size
= cpu_to_le32(MAX_DESC_BUF_SZ
|
229 (buf_sz
- MAX_DESC_BUF_SZ
) << DESC_BUFFER2_SZ_OFFSET
);
231 p
->buf_size
= cpu_to_le32(buf_sz
);
234 static inline int desc_get_buf_len(struct xgmac_dma_desc
*p
)
236 u32 len
= le32_to_cpu(p
->buf_size
);
237 return (len
& DESC_BUFFER1_SZ_MASK
) +
238 ((len
& DESC_BUFFER2_SZ_MASK
) >> DESC_BUFFER2_SZ_OFFSET
);
241 static inline void desc_init_rx_desc(struct xgmac_dma_desc
*p
, int ring_size
,
244 struct xgmac_dma_desc
*end
= p
+ ring_size
- 1;
246 memset(p
, 0, sizeof(*p
) * ring_size
);
248 for (; p
<= end
; p
++)
249 desc_set_buf_len(p
, buf_sz
);
251 end
->buf_size
|= cpu_to_le32(RXDESC1_END_RING
);
254 static inline void desc_init_tx_desc(struct xgmac_dma_desc
*p
, u32 ring_size
)
256 memset(p
, 0, sizeof(*p
) * ring_size
);
257 p
[ring_size
- 1].flags
= cpu_to_le32(TXDESC_END_RING
);
260 static inline int desc_get_owner(struct xgmac_dma_desc
*p
)
262 return le32_to_cpu(p
->flags
) & DESC_OWN
;
265 static inline void desc_set_rx_owner(struct xgmac_dma_desc
*p
)
267 /* Clear all fields and set the owner */
268 p
->flags
= cpu_to_le32(DESC_OWN
);
271 static inline void desc_set_tx_owner(struct xgmac_dma_desc
*p
, u32 flags
)
273 u32 tmpflags
= le32_to_cpu(p
->flags
);
274 tmpflags
&= TXDESC_END_RING
;
275 tmpflags
|= flags
| DESC_OWN
;
276 p
->flags
= cpu_to_le32(tmpflags
);
279 static inline void *desc_get_buf_addr(struct xgmac_dma_desc
*p
)
281 return (void *)le32_to_cpu(p
->buf1_addr
);
284 static inline void desc_set_buf_addr(struct xgmac_dma_desc
*p
,
285 void *paddr
, int len
)
287 p
->buf1_addr
= cpu_to_le32(paddr
);
288 if (len
> MAX_DESC_BUF_SZ
)
289 p
->buf2_addr
= cpu_to_le32(paddr
+ MAX_DESC_BUF_SZ
);
292 static inline void desc_set_buf_addr_and_size(struct xgmac_dma_desc
*p
,
293 void *paddr
, int len
)
295 desc_set_buf_len(p
, len
);
296 desc_set_buf_addr(p
, paddr
, len
);
299 static inline int desc_get_rx_frame_len(struct xgmac_dma_desc
*p
)
301 u32 data
= le32_to_cpu(p
->flags
);
302 u32 len
= (data
& RXDESC_FRAME_LEN_MASK
) >> RXDESC_FRAME_LEN_OFFSET
;
303 if (data
& RXDESC_FRAME_TYPE
)
309 struct calxeda_eth_dev
{
310 struct xgmac_dma_desc rx_chain
[RX_NUM_DESC
];
311 struct xgmac_dma_desc tx_chain
[TX_NUM_DESC
];
312 char rxbuffer
[RX_BUF_SZ
];
317 struct eth_device
*dev
;
321 * Initialize a descriptor ring. Calxeda XGMAC is configured to use
322 * advanced descriptors.
325 static void init_rx_desc(struct calxeda_eth_dev
*priv
)
327 struct xgmac_dma_desc
*rxdesc
= priv
->rx_chain
;
328 struct xgmac_regs
*regs
= (struct xgmac_regs
*)priv
->dev
->iobase
;
329 void *rxbuffer
= priv
->rxbuffer
;
332 desc_init_rx_desc(rxdesc
, RX_NUM_DESC
, ETH_BUF_SZ
);
333 writel((ulong
)rxdesc
, ®s
->rxdesclist
);
335 for (i
= 0; i
< RX_NUM_DESC
; i
++) {
336 desc_set_buf_addr(rxdesc
+ i
, rxbuffer
+ (i
* ETH_BUF_SZ
),
338 desc_set_rx_owner(rxdesc
+ i
);
342 static void init_tx_desc(struct calxeda_eth_dev
*priv
)
344 struct xgmac_regs
*regs
= (struct xgmac_regs
*)priv
->dev
->iobase
;
346 desc_init_tx_desc(priv
->tx_chain
, TX_NUM_DESC
);
347 writel((ulong
)priv
->tx_chain
, ®s
->txdesclist
);
350 static int xgmac_reset(struct eth_device
*dev
)
352 struct xgmac_regs
*regs
= (struct xgmac_regs
*)dev
->iobase
;
353 int timeout
= MAC_TIMEOUT
;
356 value
= readl(®s
->config
) & XGMAC_CONTROL_SPD_MASK
;
358 writel(XGMAC_DMA_BUSMODE_RESET
, ®s
->busmode
);
359 while ((timeout
-- >= 0) &&
360 (readl(®s
->busmode
) & XGMAC_DMA_BUSMODE_RESET
))
363 writel(value
, ®s
->config
);
368 static void xgmac_hwmacaddr(struct eth_device
*dev
)
370 struct xgmac_regs
*regs
= (struct xgmac_regs
*)dev
->iobase
;
373 memcpy(macaddr
, dev
->enetaddr
, 6);
374 writel(macaddr
[1], ®s
->macaddr
[0].hi
);
375 writel(macaddr
[0], ®s
->macaddr
[0].lo
);
378 static int xgmac_init(struct eth_device
*dev
, bd_t
* bis
)
380 struct xgmac_regs
*regs
= (struct xgmac_regs
*)dev
->iobase
;
381 struct calxeda_eth_dev
*priv
= dev
->priv
;
384 if (xgmac_reset(dev
) < 0)
387 /* set the hardware MAC address */
388 xgmac_hwmacaddr(dev
);
390 /* set the AXI bus modes */
391 value
= XGMAC_DMA_BUSMODE_ATDS
|
392 (16 << XGMAC_DMA_BUSMODE_PBL_SHIFT
) |
393 XGMAC_DMA_BUSMODE_FB
| XGMAC_DMA_BUSMODE_AAL
;
394 writel(value
, ®s
->busmode
);
396 value
= XGMAC_DMA_AXIMODE_AAL
| XGMAC_DMA_AXIMODE_BLEN16
|
397 XGMAC_DMA_AXIMODE_BLEN8
| XGMAC_DMA_AXIMODE_BLEN4
;
398 writel(value
, ®s
->axi_mode
);
400 /* set flow control parameters and store and forward mode */
401 value
= (FIFO_MINUS_12K
<< XGMAC_CORE_OMR_RFD_SHIFT
) |
402 (FIFO_MINUS_4K
<< XGMAC_CORE_OMR_RFA_SHIFT
) |
403 XGMAC_CORE_OMR_EFC
| XGMAC_CORE_OMR_TSF
| XGMAC_CORE_OMR_RSF
;
404 writel(value
, ®s
->core_opmode
);
406 /* enable pause frames */
407 value
= (1024 << XGMAC_CORE_FLOW_PT_SHIFT
) |
408 (1 << XGMAC_CORE_FLOW_PLT_SHIFT
) |
409 XGMAC_CORE_FLOW_UP
| XGMAC_CORE_FLOW_RFE
| XGMAC_CORE_FLOW_TFE
;
410 writel(value
, ®s
->flow_control
);
412 /* Initialize the descriptor chains */
416 /* must set to 0, or when started up will cause issues */
417 priv
->tx_currdesc
= 0;
418 priv
->rx_currdesc
= 0;
420 /* set default core values */
421 value
= readl(®s
->config
);
422 value
&= XGMAC_CONTROL_SPD_MASK
;
423 value
|= XGMAC_CONTROL_DDIC
| XGMAC_CONTROL_ACS
|
424 XGMAC_CONTROL_IPC
| XGMAC_CONTROL_CAR
;
426 /* Everything is ready enable both mac and DMA */
427 value
|= RXENABLE
| TXENABLE
;
428 writel(value
, ®s
->config
);
430 value
= readl(®s
->dma_opmode
);
431 value
|= RXSTART
| TXSTART
;
432 writel(value
, ®s
->dma_opmode
);
437 static int xgmac_tx(struct eth_device
*dev
, volatile void *packet
, int length
)
439 struct xgmac_regs
*regs
= (struct xgmac_regs
*)dev
->iobase
;
440 struct calxeda_eth_dev
*priv
= dev
->priv
;
441 u32 currdesc
= priv
->tx_currdesc
;
442 struct xgmac_dma_desc
*txdesc
= &priv
->tx_chain
[currdesc
];
445 desc_set_buf_addr_and_size(txdesc
, (void *)packet
, length
);
446 desc_set_tx_owner(txdesc
, TXDESC_FIRST_SEG
|
447 TXDESC_LAST_SEG
| TXDESC_CRC_EN_APPEND
);
449 /* write poll demand */
450 writel(1, ®s
->txpoll
);
453 while (desc_get_owner(txdesc
)) {
455 printf("xgmac: TX timeout\n");
461 priv
->tx_currdesc
= (currdesc
+ 1) & (TX_NUM_DESC
- 1);
465 static int xgmac_rx(struct eth_device
*dev
)
467 struct xgmac_regs
*regs
= (struct xgmac_regs
*)dev
->iobase
;
468 struct calxeda_eth_dev
*priv
= dev
->priv
;
469 u32 currdesc
= priv
->rx_currdesc
;
470 struct xgmac_dma_desc
*rxdesc
= &priv
->rx_chain
[currdesc
];
473 /* check if the host has the desc */
474 if (desc_get_owner(rxdesc
))
475 return -1; /* something bad happened */
477 length
= desc_get_rx_frame_len(rxdesc
);
479 NetReceive((volatile unsigned char *)desc_get_buf_addr(rxdesc
), length
);
481 /* set descriptor back to owned by XGMAC */
482 desc_set_rx_owner(rxdesc
);
483 writel(1, ®s
->rxpoll
);
485 priv
->rx_currdesc
= (currdesc
+ 1) & (RX_NUM_DESC
- 1);
490 static void xgmac_halt(struct eth_device
*dev
)
492 struct xgmac_regs
*regs
= (struct xgmac_regs
*)dev
->iobase
;
493 struct calxeda_eth_dev
*priv
= dev
->priv
;
497 value
= readl(®s
->config
);
498 value
&= ~(RXENABLE
| TXENABLE
);
499 writel(value
, ®s
->config
);
502 value
= readl(®s
->dma_opmode
);
503 value
&= ~(RXSTART
| TXSTART
);
504 writel(value
, ®s
->dma_opmode
);
506 /* must set to 0, or when started up will cause issues */
507 priv
->tx_currdesc
= 0;
508 priv
->rx_currdesc
= 0;
511 int calxedaxgmac_initialize(u32 id
, ulong base_addr
)
513 struct eth_device
*dev
;
514 struct calxeda_eth_dev
*priv
;
515 struct xgmac_regs
*regs
;
518 regs
= (struct xgmac_regs
*)base_addr
;
520 /* check hardware version */
521 if (readl(®s
->version
) != 0x1012)
524 dev
= malloc(sizeof(*dev
));
527 memset(dev
, 0, sizeof(*dev
));
529 /* Structure must be aligned, because it contains the descriptors */
530 priv
= memalign(32, sizeof(*priv
));
536 dev
->iobase
= (int)base_addr
;
539 sprintf(dev
->name
, "xgmac%d", id
);
541 /* The MAC address is already configured, so read it from registers. */
542 macaddr
[1] = readl(®s
->macaddr
[0].hi
);
543 macaddr
[0] = readl(®s
->macaddr
[0].lo
);
544 memcpy(dev
->enetaddr
, macaddr
, 6);
546 dev
->init
= xgmac_init
;
547 dev
->send
= xgmac_tx
;
548 dev
->recv
= xgmac_rx
;
549 dev
->halt
= xgmac_halt
;