1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * Cirrus Logic CS8900A Ethernet
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * (C) 2009 Ben Warren , biggerbadderben@gmail.com
5*4882a593Smuzhiyun * Converted to use CONFIG_NET_MULTI API
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * (C) 2003 Wolfgang Denk, wd@denx.de
8*4882a593Smuzhiyun * Extension to synchronize ethaddr environment variable
9*4882a593Smuzhiyun * against value in EEPROM
10*4882a593Smuzhiyun *
11*4882a593Smuzhiyun * (C) Copyright 2002
12*4882a593Smuzhiyun * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
13*4882a593Smuzhiyun * Marius Groeger <mgroeger@sysgo.de>
14*4882a593Smuzhiyun *
15*4882a593Smuzhiyun * Copyright (C) 1999 Ben Williamson <benw@pobox.com>
16*4882a593Smuzhiyun *
17*4882a593Smuzhiyun * This program is loaded into SRAM in bootstrap mode, where it waits
18*4882a593Smuzhiyun * for commands on UART1 to read and write memory, jump to code etc.
19*4882a593Smuzhiyun * A design goal for this program is to be entirely independent of the
20*4882a593Smuzhiyun * target board. Anything with a CL-PS7111 or EP7211 should be able to run
21*4882a593Smuzhiyun * this code in bootstrap mode. All the board specifics can be handled on
22*4882a593Smuzhiyun * the host.
23*4882a593Smuzhiyun *
24*4882a593Smuzhiyun * SPDX-License-Identifier: GPL-2.0+
25*4882a593Smuzhiyun */
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun #include <common.h>
28*4882a593Smuzhiyun #include <command.h>
29*4882a593Smuzhiyun #include <asm/io.h>
30*4882a593Smuzhiyun #include <net.h>
31*4882a593Smuzhiyun #include <malloc.h>
32*4882a593Smuzhiyun #include "cs8900.h"
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun #undef DEBUG
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun /* packet page register access functions */
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun #ifdef CONFIG_CS8900_BUS32
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun #define REG_WRITE(v, a) writel((v),(a))
41*4882a593Smuzhiyun #define REG_READ(a) readl((a))
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun /* we don't need 16 bit initialisation on 32 bit bus */
44*4882a593Smuzhiyun #define get_reg_init_bus(r,d) get_reg((r),(d))
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun #else
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun #define REG_WRITE(v, a) writew((v),(a))
49*4882a593Smuzhiyun #define REG_READ(a) readw((a))
50*4882a593Smuzhiyun
get_reg_init_bus(struct eth_device * dev,int regno)51*4882a593Smuzhiyun static u16 get_reg_init_bus(struct eth_device *dev, int regno)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun /* force 16 bit busmode */
54*4882a593Smuzhiyun struct cs8900_priv *priv = (struct cs8900_priv *)(dev->priv);
55*4882a593Smuzhiyun uint8_t volatile * const iob = (uint8_t volatile * const)dev->iobase;
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun readb(iob);
58*4882a593Smuzhiyun readb(iob + 1);
59*4882a593Smuzhiyun readb(iob);
60*4882a593Smuzhiyun readb(iob + 1);
61*4882a593Smuzhiyun readb(iob);
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun REG_WRITE(regno, &priv->regs->pptr);
64*4882a593Smuzhiyun return REG_READ(&priv->regs->pdata);
65*4882a593Smuzhiyun }
66*4882a593Smuzhiyun #endif
67*4882a593Smuzhiyun
get_reg(struct eth_device * dev,int regno)68*4882a593Smuzhiyun static u16 get_reg(struct eth_device *dev, int regno)
69*4882a593Smuzhiyun {
70*4882a593Smuzhiyun struct cs8900_priv *priv = (struct cs8900_priv *)(dev->priv);
71*4882a593Smuzhiyun REG_WRITE(regno, &priv->regs->pptr);
72*4882a593Smuzhiyun return REG_READ(&priv->regs->pdata);
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun
put_reg(struct eth_device * dev,int regno,u16 val)76*4882a593Smuzhiyun static void put_reg(struct eth_device *dev, int regno, u16 val)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun struct cs8900_priv *priv = (struct cs8900_priv *)(dev->priv);
79*4882a593Smuzhiyun REG_WRITE(regno, &priv->regs->pptr);
80*4882a593Smuzhiyun REG_WRITE(val, &priv->regs->pdata);
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun
cs8900_reset(struct eth_device * dev)83*4882a593Smuzhiyun static void cs8900_reset(struct eth_device *dev)
84*4882a593Smuzhiyun {
85*4882a593Smuzhiyun int tmo;
86*4882a593Smuzhiyun u16 us;
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun /* reset NIC */
89*4882a593Smuzhiyun put_reg(dev, PP_SelfCTL, get_reg(dev, PP_SelfCTL) | PP_SelfCTL_Reset);
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun /* wait for 200ms */
92*4882a593Smuzhiyun udelay(200000);
93*4882a593Smuzhiyun /* Wait until the chip is reset */
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun tmo = get_timer(0) + 1 * CONFIG_SYS_HZ;
96*4882a593Smuzhiyun while ((((us = get_reg_init_bus(dev, PP_SelfSTAT)) &
97*4882a593Smuzhiyun PP_SelfSTAT_InitD) == 0) && tmo < get_timer(0))
98*4882a593Smuzhiyun /*NOP*/;
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun
cs8900_reginit(struct eth_device * dev)101*4882a593Smuzhiyun static void cs8900_reginit(struct eth_device *dev)
102*4882a593Smuzhiyun {
103*4882a593Smuzhiyun /* receive only error free packets addressed to this card */
104*4882a593Smuzhiyun put_reg(dev, PP_RxCTL,
105*4882a593Smuzhiyun PP_RxCTL_IA | PP_RxCTL_Broadcast | PP_RxCTL_RxOK);
106*4882a593Smuzhiyun /* do not generate any interrupts on receive operations */
107*4882a593Smuzhiyun put_reg(dev, PP_RxCFG, 0);
108*4882a593Smuzhiyun /* do not generate any interrupts on transmit operations */
109*4882a593Smuzhiyun put_reg(dev, PP_TxCFG, 0);
110*4882a593Smuzhiyun /* do not generate any interrupts on buffer operations */
111*4882a593Smuzhiyun put_reg(dev, PP_BufCFG, 0);
112*4882a593Smuzhiyun /* enable transmitter/receiver mode */
113*4882a593Smuzhiyun put_reg(dev, PP_LineCTL, PP_LineCTL_Rx | PP_LineCTL_Tx);
114*4882a593Smuzhiyun }
115*4882a593Smuzhiyun
cs8900_get_enetaddr(struct eth_device * dev)116*4882a593Smuzhiyun void cs8900_get_enetaddr(struct eth_device *dev)
117*4882a593Smuzhiyun {
118*4882a593Smuzhiyun int i;
119*4882a593Smuzhiyun
120*4882a593Smuzhiyun /* verify chip id */
121*4882a593Smuzhiyun if (get_reg_init_bus(dev, PP_ChipID) != 0x630e)
122*4882a593Smuzhiyun return;
123*4882a593Smuzhiyun cs8900_reset(dev);
124*4882a593Smuzhiyun if ((get_reg(dev, PP_SelfSTAT) &
125*4882a593Smuzhiyun (PP_SelfSTAT_EEPROM | PP_SelfSTAT_EEPROM_OK)) ==
126*4882a593Smuzhiyun (PP_SelfSTAT_EEPROM | PP_SelfSTAT_EEPROM_OK)) {
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun /* Load the MAC from EEPROM */
129*4882a593Smuzhiyun for (i = 0; i < 3; i++) {
130*4882a593Smuzhiyun u32 Addr;
131*4882a593Smuzhiyun
132*4882a593Smuzhiyun Addr = get_reg(dev, PP_IA + i * 2);
133*4882a593Smuzhiyun dev->enetaddr[i * 2] = Addr & 0xFF;
134*4882a593Smuzhiyun dev->enetaddr[i * 2 + 1] = Addr >> 8;
135*4882a593Smuzhiyun }
136*4882a593Smuzhiyun }
137*4882a593Smuzhiyun }
138*4882a593Smuzhiyun
cs8900_halt(struct eth_device * dev)139*4882a593Smuzhiyun void cs8900_halt(struct eth_device *dev)
140*4882a593Smuzhiyun {
141*4882a593Smuzhiyun /* disable transmitter/receiver mode */
142*4882a593Smuzhiyun put_reg(dev, PP_LineCTL, 0);
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun /* "shutdown" to show ChipID or kernel wouldn't find he cs8900 ... */
145*4882a593Smuzhiyun get_reg_init_bus(dev, PP_ChipID);
146*4882a593Smuzhiyun }
147*4882a593Smuzhiyun
cs8900_init(struct eth_device * dev,bd_t * bd)148*4882a593Smuzhiyun static int cs8900_init(struct eth_device *dev, bd_t * bd)
149*4882a593Smuzhiyun {
150*4882a593Smuzhiyun uchar *enetaddr = dev->enetaddr;
151*4882a593Smuzhiyun u16 id;
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun /* verify chip id */
154*4882a593Smuzhiyun id = get_reg_init_bus(dev, PP_ChipID);
155*4882a593Smuzhiyun if (id != 0x630e) {
156*4882a593Smuzhiyun printf ("CS8900 Ethernet chip not found: "
157*4882a593Smuzhiyun "ID=0x%04x instead 0x%04x\n", id, 0x630e);
158*4882a593Smuzhiyun return 1;
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun cs8900_reset (dev);
162*4882a593Smuzhiyun /* set the ethernet address */
163*4882a593Smuzhiyun put_reg(dev, PP_IA + 0, enetaddr[0] | (enetaddr[1] << 8));
164*4882a593Smuzhiyun put_reg(dev, PP_IA + 2, enetaddr[2] | (enetaddr[3] << 8));
165*4882a593Smuzhiyun put_reg(dev, PP_IA + 4, enetaddr[4] | (enetaddr[5] << 8));
166*4882a593Smuzhiyun
167*4882a593Smuzhiyun cs8900_reginit(dev);
168*4882a593Smuzhiyun return 0;
169*4882a593Smuzhiyun }
170*4882a593Smuzhiyun
171*4882a593Smuzhiyun /* Get a data block via Ethernet */
cs8900_recv(struct eth_device * dev)172*4882a593Smuzhiyun static int cs8900_recv(struct eth_device *dev)
173*4882a593Smuzhiyun {
174*4882a593Smuzhiyun int i;
175*4882a593Smuzhiyun u16 rxlen;
176*4882a593Smuzhiyun u16 *addr;
177*4882a593Smuzhiyun u16 status;
178*4882a593Smuzhiyun
179*4882a593Smuzhiyun struct cs8900_priv *priv = (struct cs8900_priv *)(dev->priv);
180*4882a593Smuzhiyun
181*4882a593Smuzhiyun status = get_reg(dev, PP_RER);
182*4882a593Smuzhiyun
183*4882a593Smuzhiyun if ((status & PP_RER_RxOK) == 0)
184*4882a593Smuzhiyun return 0;
185*4882a593Smuzhiyun
186*4882a593Smuzhiyun status = REG_READ(&priv->regs->rtdata);
187*4882a593Smuzhiyun rxlen = REG_READ(&priv->regs->rtdata);
188*4882a593Smuzhiyun
189*4882a593Smuzhiyun if (rxlen > PKTSIZE_ALIGN + PKTALIGN)
190*4882a593Smuzhiyun debug("packet too big!\n");
191*4882a593Smuzhiyun for (addr = (u16 *)net_rx_packets[0], i = rxlen >> 1; i > 0; i--)
192*4882a593Smuzhiyun *addr++ = REG_READ(&priv->regs->rtdata);
193*4882a593Smuzhiyun if (rxlen & 1)
194*4882a593Smuzhiyun *addr++ = REG_READ(&priv->regs->rtdata);
195*4882a593Smuzhiyun
196*4882a593Smuzhiyun /* Pass the packet up to the protocol layers. */
197*4882a593Smuzhiyun net_process_received_packet(net_rx_packets[0], rxlen);
198*4882a593Smuzhiyun return rxlen;
199*4882a593Smuzhiyun }
200*4882a593Smuzhiyun
201*4882a593Smuzhiyun /* Send a data block via Ethernet. */
cs8900_send(struct eth_device * dev,void * packet,int length)202*4882a593Smuzhiyun static int cs8900_send(struct eth_device *dev, void *packet, int length)
203*4882a593Smuzhiyun {
204*4882a593Smuzhiyun volatile u16 *addr;
205*4882a593Smuzhiyun int tmo;
206*4882a593Smuzhiyun u16 s;
207*4882a593Smuzhiyun struct cs8900_priv *priv = (struct cs8900_priv *)(dev->priv);
208*4882a593Smuzhiyun
209*4882a593Smuzhiyun retry:
210*4882a593Smuzhiyun /* initiate a transmit sequence */
211*4882a593Smuzhiyun REG_WRITE(PP_TxCmd_TxStart_Full, &priv->regs->txcmd);
212*4882a593Smuzhiyun REG_WRITE(length, &priv->regs->txlen);
213*4882a593Smuzhiyun
214*4882a593Smuzhiyun /* Test to see if the chip has allocated memory for the packet */
215*4882a593Smuzhiyun if ((get_reg(dev, PP_BusSTAT) & PP_BusSTAT_TxRDY) == 0) {
216*4882a593Smuzhiyun /* Oops... this should not happen! */
217*4882a593Smuzhiyun debug("cs: unable to send packet; retrying...\n");
218*4882a593Smuzhiyun for (tmo = get_timer(0) + 5 * CONFIG_SYS_HZ;
219*4882a593Smuzhiyun get_timer(0) < tmo;)
220*4882a593Smuzhiyun /*NOP*/;
221*4882a593Smuzhiyun cs8900_reset(dev);
222*4882a593Smuzhiyun cs8900_reginit(dev);
223*4882a593Smuzhiyun goto retry;
224*4882a593Smuzhiyun }
225*4882a593Smuzhiyun
226*4882a593Smuzhiyun /* Write the contents of the packet */
227*4882a593Smuzhiyun /* assume even number of bytes */
228*4882a593Smuzhiyun for (addr = packet; length > 0; length -= 2)
229*4882a593Smuzhiyun REG_WRITE(*addr++, &priv->regs->rtdata);
230*4882a593Smuzhiyun
231*4882a593Smuzhiyun /* wait for transfer to succeed */
232*4882a593Smuzhiyun tmo = get_timer(0) + 5 * CONFIG_SYS_HZ;
233*4882a593Smuzhiyun while ((s = get_reg(dev, PP_TER) & ~0x1F) == 0) {
234*4882a593Smuzhiyun if (get_timer(0) >= tmo)
235*4882a593Smuzhiyun break;
236*4882a593Smuzhiyun }
237*4882a593Smuzhiyun
238*4882a593Smuzhiyun /* nothing */ ;
239*4882a593Smuzhiyun if((s & (PP_TER_CRS | PP_TER_TxOK)) != PP_TER_TxOK) {
240*4882a593Smuzhiyun debug("\ntransmission error %#x\n", s);
241*4882a593Smuzhiyun }
242*4882a593Smuzhiyun
243*4882a593Smuzhiyun return 0;
244*4882a593Smuzhiyun }
245*4882a593Smuzhiyun
cs8900_e2prom_ready(struct eth_device * dev)246*4882a593Smuzhiyun static void cs8900_e2prom_ready(struct eth_device *dev)
247*4882a593Smuzhiyun {
248*4882a593Smuzhiyun while (get_reg(dev, PP_SelfSTAT) & SI_BUSY)
249*4882a593Smuzhiyun ;
250*4882a593Smuzhiyun }
251*4882a593Smuzhiyun
252*4882a593Smuzhiyun /***********************************************************/
253*4882a593Smuzhiyun /* read a 16-bit word out of the EEPROM */
254*4882a593Smuzhiyun /***********************************************************/
255*4882a593Smuzhiyun
cs8900_e2prom_read(struct eth_device * dev,u8 addr,u16 * value)256*4882a593Smuzhiyun int cs8900_e2prom_read(struct eth_device *dev,
257*4882a593Smuzhiyun u8 addr, u16 *value)
258*4882a593Smuzhiyun {
259*4882a593Smuzhiyun cs8900_e2prom_ready(dev);
260*4882a593Smuzhiyun put_reg(dev, PP_EECMD, EEPROM_READ_CMD | addr);
261*4882a593Smuzhiyun cs8900_e2prom_ready(dev);
262*4882a593Smuzhiyun *value = get_reg(dev, PP_EEData);
263*4882a593Smuzhiyun
264*4882a593Smuzhiyun return 0;
265*4882a593Smuzhiyun }
266*4882a593Smuzhiyun
267*4882a593Smuzhiyun
268*4882a593Smuzhiyun /***********************************************************/
269*4882a593Smuzhiyun /* write a 16-bit word into the EEPROM */
270*4882a593Smuzhiyun /***********************************************************/
271*4882a593Smuzhiyun
cs8900_e2prom_write(struct eth_device * dev,u8 addr,u16 value)272*4882a593Smuzhiyun int cs8900_e2prom_write(struct eth_device *dev, u8 addr, u16 value)
273*4882a593Smuzhiyun {
274*4882a593Smuzhiyun cs8900_e2prom_ready(dev);
275*4882a593Smuzhiyun put_reg(dev, PP_EECMD, EEPROM_WRITE_EN);
276*4882a593Smuzhiyun cs8900_e2prom_ready(dev);
277*4882a593Smuzhiyun put_reg(dev, PP_EEData, value);
278*4882a593Smuzhiyun put_reg(dev, PP_EECMD, EEPROM_WRITE_CMD | addr);
279*4882a593Smuzhiyun cs8900_e2prom_ready(dev);
280*4882a593Smuzhiyun put_reg(dev, PP_EECMD, EEPROM_WRITE_DIS);
281*4882a593Smuzhiyun cs8900_e2prom_ready(dev);
282*4882a593Smuzhiyun
283*4882a593Smuzhiyun return 0;
284*4882a593Smuzhiyun }
285*4882a593Smuzhiyun
cs8900_initialize(u8 dev_num,int base_addr)286*4882a593Smuzhiyun int cs8900_initialize(u8 dev_num, int base_addr)
287*4882a593Smuzhiyun {
288*4882a593Smuzhiyun struct eth_device *dev;
289*4882a593Smuzhiyun struct cs8900_priv *priv;
290*4882a593Smuzhiyun
291*4882a593Smuzhiyun dev = malloc(sizeof(*dev));
292*4882a593Smuzhiyun if (!dev) {
293*4882a593Smuzhiyun return 0;
294*4882a593Smuzhiyun }
295*4882a593Smuzhiyun memset(dev, 0, sizeof(*dev));
296*4882a593Smuzhiyun
297*4882a593Smuzhiyun priv = malloc(sizeof(*priv));
298*4882a593Smuzhiyun if (!priv) {
299*4882a593Smuzhiyun free(dev);
300*4882a593Smuzhiyun return 0;
301*4882a593Smuzhiyun }
302*4882a593Smuzhiyun memset(priv, 0, sizeof(*priv));
303*4882a593Smuzhiyun priv->regs = (struct cs8900_regs *)base_addr;
304*4882a593Smuzhiyun
305*4882a593Smuzhiyun dev->iobase = base_addr;
306*4882a593Smuzhiyun dev->priv = priv;
307*4882a593Smuzhiyun dev->init = cs8900_init;
308*4882a593Smuzhiyun dev->halt = cs8900_halt;
309*4882a593Smuzhiyun dev->send = cs8900_send;
310*4882a593Smuzhiyun dev->recv = cs8900_recv;
311*4882a593Smuzhiyun
312*4882a593Smuzhiyun /* Load MAC address from EEPROM */
313*4882a593Smuzhiyun cs8900_get_enetaddr(dev);
314*4882a593Smuzhiyun
315*4882a593Smuzhiyun sprintf(dev->name, "%s-%hu", CS8900_DRIVERNAME, dev_num);
316*4882a593Smuzhiyun
317*4882a593Smuzhiyun eth_register(dev);
318*4882a593Smuzhiyun return 0;
319*4882a593Smuzhiyun }
320