xref: /openbmc/u-boot/drivers/net/sh_eth.c (revision dd80264d)
1 /*
2  * sh_eth.c - Driver for Renesas SH7763's ethernet controler.
3  *
4  * Copyright (C) 2008 Renesas Solutions Corp.
5  * Copyright (c) 2008 Nobuhiro Iwamatsu
6  * Copyright (c) 2007 Carlos Munoz <carlos@kenati.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21  */
22 
23 #include <config.h>
24 #include <common.h>
25 #include <malloc.h>
26 #include <net.h>
27 #include <netdev.h>
28 #include <miiphy.h>
29 #include <asm/errno.h>
30 #include <asm/io.h>
31 
32 #include "sh_eth.h"
33 
34 #ifndef CONFIG_SH_ETHER_USE_PORT
35 # error "Please define CONFIG_SH_ETHER_USE_PORT"
36 #endif
37 #ifndef CONFIG_SH_ETHER_PHY_ADDR
38 # error "Please define CONFIG_SH_ETHER_PHY_ADDR"
39 #endif
40 #ifdef CONFIG_SH_ETHER_CACHE_WRITEBACK
41 #define flush_cache_wback(addr, len)	\
42 			dcache_wback_range((u32)addr, (u32)(addr + len - 1))
43 #else
44 #define flush_cache_wback(...)
45 #endif
46 
47 #define SH_ETH_PHY_DELAY 50000
48 
49 int sh_eth_send(struct eth_device *dev, volatile void *packet, int len)
50 {
51 	struct sh_eth_dev *eth = dev->priv;
52 	int port = eth->port, ret = 0, timeout;
53 	struct sh_eth_info *port_info = &eth->port_info[port];
54 
55 	if (!packet || len > 0xffff) {
56 		printf(SHETHER_NAME ": %s: Invalid argument\n", __func__);
57 		ret = -EINVAL;
58 		goto err;
59 	}
60 
61 	/* packet must be a 4 byte boundary */
62 	if ((int)packet & (4 - 1)) {
63 		printf(SHETHER_NAME ": %s: packet not 4 byte alligned\n", __func__);
64 		ret = -EFAULT;
65 		goto err;
66 	}
67 
68 	/* Update tx descriptor */
69 	flush_cache_wback(packet, len);
70 	port_info->tx_desc_cur->td2 = ADDR_TO_PHY(packet);
71 	port_info->tx_desc_cur->td1 = len << 16;
72 	/* Must preserve the end of descriptor list indication */
73 	if (port_info->tx_desc_cur->td0 & TD_TDLE)
74 		port_info->tx_desc_cur->td0 = TD_TACT | TD_TFP | TD_TDLE;
75 	else
76 		port_info->tx_desc_cur->td0 = TD_TACT | TD_TFP;
77 
78 	/* Restart the transmitter if disabled */
79 	if (!(inl(EDTRR(port)) & EDTRR_TRNS))
80 		outl(EDTRR_TRNS, EDTRR(port));
81 
82 	/* Wait until packet is transmitted */
83 	timeout = 1000;
84 	while (port_info->tx_desc_cur->td0 & TD_TACT && timeout--)
85 		udelay(100);
86 
87 	if (timeout < 0) {
88 		printf(SHETHER_NAME ": transmit timeout\n");
89 		ret = -ETIMEDOUT;
90 		goto err;
91 	}
92 
93 	port_info->tx_desc_cur++;
94 	if (port_info->tx_desc_cur >= port_info->tx_desc_base + NUM_TX_DESC)
95 		port_info->tx_desc_cur = port_info->tx_desc_base;
96 
97 	return ret;
98 err:
99 	return ret;
100 }
101 
102 int sh_eth_recv(struct eth_device *dev)
103 {
104 	struct sh_eth_dev *eth = dev->priv;
105 	int port = eth->port, len = 0;
106 	struct sh_eth_info *port_info = &eth->port_info[port];
107 	volatile u8 *packet;
108 
109 	/* Check if the rx descriptor is ready */
110 	if (!(port_info->rx_desc_cur->rd0 & RD_RACT)) {
111 		/* Check for errors */
112 		if (!(port_info->rx_desc_cur->rd0 & RD_RFE)) {
113 			len = port_info->rx_desc_cur->rd1 & 0xffff;
114 			packet = (volatile u8 *)
115 			    ADDR_TO_P2(port_info->rx_desc_cur->rd2);
116 			NetReceive(packet, len);
117 		}
118 
119 		/* Make current descriptor available again */
120 		if (port_info->rx_desc_cur->rd0 & RD_RDLE)
121 			port_info->rx_desc_cur->rd0 = RD_RACT | RD_RDLE;
122 		else
123 			port_info->rx_desc_cur->rd0 = RD_RACT;
124 
125 		/* Point to the next descriptor */
126 		port_info->rx_desc_cur++;
127 		if (port_info->rx_desc_cur >=
128 		    port_info->rx_desc_base + NUM_RX_DESC)
129 			port_info->rx_desc_cur = port_info->rx_desc_base;
130 	}
131 
132 	/* Restart the receiver if disabled */
133 	if (!(inl(EDRRR(port)) & EDRRR_R))
134 		outl(EDRRR_R, EDRRR(port));
135 
136 	return len;
137 }
138 
139 #define EDMR_INIT_CNT 1000
140 static int sh_eth_reset(struct sh_eth_dev *eth)
141 {
142 	int port = eth->port;
143 #if defined(CONFIG_CPU_SH7763)
144 	int ret = 0, i;
145 
146 	/* Start e-dmac transmitter and receiver */
147 	outl(EDSR_ENALL, EDSR(port));
148 
149 	/* Perform a software reset and wait for it to complete */
150 	outl(EDMR_SRST, EDMR(port));
151 	for (i = 0; i < EDMR_INIT_CNT; i++) {
152 		if (!(inl(EDMR(port)) & EDMR_SRST))
153 			break;
154 		udelay(1000);
155 	}
156 
157 	if (i == EDMR_INIT_CNT) {
158 		printf(SHETHER_NAME  ": Software reset timeout\n");
159 		ret = -EIO;
160 	}
161 
162 	return ret;
163 #else
164 	outl(inl(EDMR(port)) | EDMR_SRST, EDMR(port));
165 	udelay(3000);
166 	outl(inl(EDMR(port)) & ~EDMR_SRST, EDMR(port));
167 
168 	return 0;
169 #endif
170 }
171 
172 static int sh_eth_tx_desc_init(struct sh_eth_dev *eth)
173 {
174 	int port = eth->port, i, ret = 0;
175 	u32 tmp_addr;
176 	struct sh_eth_info *port_info = &eth->port_info[port];
177 	struct tx_desc_s *cur_tx_desc;
178 
179 	/*
180 	 * Allocate tx descriptors. They must be TX_DESC_SIZE bytes aligned
181 	 */
182 	port_info->tx_desc_malloc = malloc(NUM_TX_DESC *
183 						 sizeof(struct tx_desc_s) +
184 						 TX_DESC_SIZE - 1);
185 	if (!port_info->tx_desc_malloc) {
186 		printf(SHETHER_NAME ": malloc failed\n");
187 		ret = -ENOMEM;
188 		goto err;
189 	}
190 
191 	tmp_addr = (u32) (((int)port_info->tx_desc_malloc + TX_DESC_SIZE - 1) &
192 			  ~(TX_DESC_SIZE - 1));
193 	flush_cache_wback(tmp_addr, NUM_TX_DESC * sizeof(struct tx_desc_s));
194 	/* Make sure we use a P2 address (non-cacheable) */
195 	port_info->tx_desc_base = (struct tx_desc_s *)ADDR_TO_P2(tmp_addr);
196 	port_info->tx_desc_cur = port_info->tx_desc_base;
197 
198 	/* Initialize all descriptors */
199 	for (cur_tx_desc = port_info->tx_desc_base, i = 0; i < NUM_TX_DESC;
200 	     cur_tx_desc++, i++) {
201 		cur_tx_desc->td0 = 0x00;
202 		cur_tx_desc->td1 = 0x00;
203 		cur_tx_desc->td2 = 0x00;
204 	}
205 
206 	/* Mark the end of the descriptors */
207 	cur_tx_desc--;
208 	cur_tx_desc->td0 |= TD_TDLE;
209 
210 	/* Point the controller to the tx descriptor list. Must use physical
211 	   addresses */
212 	outl(ADDR_TO_PHY(port_info->tx_desc_base), TDLAR(port));
213 #if defined(CONFIG_CPU_SH7763)
214 	outl(ADDR_TO_PHY(port_info->tx_desc_base), TDFAR(port));
215 	outl(ADDR_TO_PHY(cur_tx_desc), TDFXR(port));
216 	outl(0x01, TDFFR(port));/* Last discriptor bit */
217 #endif
218 
219 err:
220 	return ret;
221 }
222 
223 static int sh_eth_rx_desc_init(struct sh_eth_dev *eth)
224 {
225 	int port = eth->port, i , ret = 0;
226 	struct sh_eth_info *port_info = &eth->port_info[port];
227 	struct rx_desc_s *cur_rx_desc;
228 	u32 tmp_addr;
229 	u8 *rx_buf;
230 
231 	/*
232 	 * Allocate rx descriptors. They must be RX_DESC_SIZE bytes aligned
233 	 */
234 	port_info->rx_desc_malloc = malloc(NUM_RX_DESC *
235 						 sizeof(struct rx_desc_s) +
236 						 RX_DESC_SIZE - 1);
237 	if (!port_info->rx_desc_malloc) {
238 		printf(SHETHER_NAME ": malloc failed\n");
239 		ret = -ENOMEM;
240 		goto err;
241 	}
242 
243 	tmp_addr = (u32) (((int)port_info->rx_desc_malloc + RX_DESC_SIZE - 1) &
244 			  ~(RX_DESC_SIZE - 1));
245 	flush_cache_wback(tmp_addr, NUM_RX_DESC * sizeof(struct rx_desc_s));
246 	/* Make sure we use a P2 address (non-cacheable) */
247 	port_info->rx_desc_base = (struct rx_desc_s *)ADDR_TO_P2(tmp_addr);
248 
249 	port_info->rx_desc_cur = port_info->rx_desc_base;
250 
251 	/*
252 	 * Allocate rx data buffers. They must be 32 bytes aligned  and in
253 	 * P2 area
254 	 */
255 	port_info->rx_buf_malloc = malloc(NUM_RX_DESC * MAX_BUF_SIZE + 31);
256 	if (!port_info->rx_buf_malloc) {
257 		printf(SHETHER_NAME ": malloc failed\n");
258 		ret = -ENOMEM;
259 		goto err_buf_malloc;
260 	}
261 
262 	tmp_addr = (u32)(((int)port_info->rx_buf_malloc + (32 - 1)) &
263 			  ~(32 - 1));
264 	port_info->rx_buf_base = (u8 *)ADDR_TO_P2(tmp_addr);
265 
266 	/* Initialize all descriptors */
267 	for (cur_rx_desc = port_info->rx_desc_base,
268 	     rx_buf = port_info->rx_buf_base, i = 0;
269 	     i < NUM_RX_DESC; cur_rx_desc++, rx_buf += MAX_BUF_SIZE, i++) {
270 		cur_rx_desc->rd0 = RD_RACT;
271 		cur_rx_desc->rd1 = MAX_BUF_SIZE << 16;
272 		cur_rx_desc->rd2 = (u32) ADDR_TO_PHY(rx_buf);
273 	}
274 
275 	/* Mark the end of the descriptors */
276 	cur_rx_desc--;
277 	cur_rx_desc->rd0 |= RD_RDLE;
278 
279 	/* Point the controller to the rx descriptor list */
280 	outl(ADDR_TO_PHY(port_info->rx_desc_base), RDLAR(port));
281 #if defined(CONFIG_CPU_SH7763)
282 	outl(ADDR_TO_PHY(port_info->rx_desc_base), RDFAR(port));
283 	outl(ADDR_TO_PHY(cur_rx_desc), RDFXR(port));
284 	outl(RDFFR_RDLF, RDFFR(port));
285 #endif
286 
287 	return ret;
288 
289 err_buf_malloc:
290 	free(port_info->rx_desc_malloc);
291 	port_info->rx_desc_malloc = NULL;
292 
293 err:
294 	return ret;
295 }
296 
297 static void sh_eth_tx_desc_free(struct sh_eth_dev *eth)
298 {
299 	int port = eth->port;
300 	struct sh_eth_info *port_info = &eth->port_info[port];
301 
302 	if (port_info->tx_desc_malloc) {
303 		free(port_info->tx_desc_malloc);
304 		port_info->tx_desc_malloc = NULL;
305 	}
306 }
307 
308 static void sh_eth_rx_desc_free(struct sh_eth_dev *eth)
309 {
310 	int port = eth->port;
311 	struct sh_eth_info *port_info = &eth->port_info[port];
312 
313 	if (port_info->rx_desc_malloc) {
314 		free(port_info->rx_desc_malloc);
315 		port_info->rx_desc_malloc = NULL;
316 	}
317 
318 	if (port_info->rx_buf_malloc) {
319 		free(port_info->rx_buf_malloc);
320 		port_info->rx_buf_malloc = NULL;
321 	}
322 }
323 
324 static int sh_eth_desc_init(struct sh_eth_dev *eth)
325 {
326 	int ret = 0;
327 
328 	ret = sh_eth_tx_desc_init(eth);
329 	if (ret)
330 		goto err_tx_init;
331 
332 	ret = sh_eth_rx_desc_init(eth);
333 	if (ret)
334 		goto err_rx_init;
335 
336 	return ret;
337 err_rx_init:
338 	sh_eth_tx_desc_free(eth);
339 
340 err_tx_init:
341 	return ret;
342 }
343 
344 static int sh_eth_phy_config(struct sh_eth_dev *eth)
345 {
346 	int port = eth->port, ret = 0;
347 	struct sh_eth_info *port_info = &eth->port_info[port];
348 	struct eth_device *dev = port_info->dev;
349 	struct phy_device *phydev;
350 
351 	phydev = phy_connect(miiphy_get_dev_by_name(dev->name),
352 			port_info->phy_addr, dev, PHY_INTERFACE_MODE_MII);
353 	port_info->phydev = phydev;
354 	phy_config(phydev);
355 
356 	return ret;
357 }
358 
359 static int sh_eth_config(struct sh_eth_dev *eth, bd_t *bd)
360 {
361 	int port = eth->port, ret = 0;
362 	u32 val;
363 	struct sh_eth_info *port_info = &eth->port_info[port];
364 	struct eth_device *dev = port_info->dev;
365 	struct phy_device *phy;
366 
367 	/* Configure e-dmac registers */
368 	outl((inl(EDMR(port)) & ~EMDR_DESC_R) | EDMR_EL, EDMR(port));
369 	outl(0, EESIPR(port));
370 	outl(0, TRSCER(port));
371 	outl(0, TFTR(port));
372 	outl((FIFO_SIZE_T | FIFO_SIZE_R), FDR(port));
373 	outl(RMCR_RST, RMCR(port));
374 #ifndef CONFIG_CPU_SH7757
375 	outl(0, RPADIR(port));
376 #endif
377 	outl((FIFO_F_D_RFF | FIFO_F_D_RFD), FCFTR(port));
378 
379 	/* Configure e-mac registers */
380 #if defined(CONFIG_CPU_SH7757)
381 	outl(ECSIPR_BRCRXIP | ECSIPR_PSRTOIP | ECSIPR_LCHNGIP |
382 		ECSIPR_MPDIP | ECSIPR_ICDIP, ECSIPR(port));
383 #else
384 	outl(0, ECSIPR(port));
385 #endif
386 
387 	/* Set Mac address */
388 	val = dev->enetaddr[0] << 24 | dev->enetaddr[1] << 16 |
389 	    dev->enetaddr[2] << 8 | dev->enetaddr[3];
390 	outl(val, MAHR(port));
391 
392 	val = dev->enetaddr[4] << 8 | dev->enetaddr[5];
393 	outl(val, MALR(port));
394 
395 	outl(RFLR_RFL_MIN, RFLR(port));
396 #ifndef CONFIG_CPU_SH7757
397 	outl(0, PIPR(port));
398 #endif
399 	outl(APR_AP, APR(port));
400 	outl(MPR_MP, MPR(port));
401 #ifdef CONFIG_CPU_SH7757
402 	outl(TPAUSER_UNLIMITED, TPAUSER(port));
403 #else
404 	outl(TPAUSER_TPAUSE, TPAUSER(port));
405 #endif
406 	/* Configure phy */
407 	ret = sh_eth_phy_config(eth);
408 	if (ret) {
409 		printf(SHETHER_NAME ": phy config timeout\n");
410 		goto err_phy_cfg;
411 	}
412 	phy = port_info->phydev;
413 	phy_startup(phy);
414 
415 	/* Set the transfer speed */
416 #ifdef CONFIG_CPU_SH7763
417 	if (phy->speed == 100) {
418 		printf(SHETHER_NAME ": 100Base/");
419 		outl(GECMR_100B, GECMR(port));
420 	} else if (phy->speed == 10) {
421 		printf(SHETHER_NAME ": 10Base/");
422 		outl(GECMR_10B, GECMR(port));
423 	}
424 #endif
425 #if defined(CONFIG_CPU_SH7757)
426 	if (phy->speed == 100) {
427 		printf("100Base/");
428 		outl(1, RTRATE(port));
429 	} else if (phy->speed == 10) {
430 		printf("10Base/");
431 		outl(0, RTRATE(port));
432 	}
433 #endif
434 
435 	/* Check if full duplex mode is supported by the phy */
436 	if (phy->duplex) {
437 		printf("Full\n");
438 		outl((ECMR_CHG_DM|ECMR_RE|ECMR_TE|ECMR_DM), ECMR(port));
439 	} else {
440 		printf("Half\n");
441 		outl((ECMR_CHG_DM|ECMR_RE|ECMR_TE),  ECMR(port));
442 	}
443 
444 	return ret;
445 
446 err_phy_cfg:
447 	return ret;
448 }
449 
450 static void sh_eth_start(struct sh_eth_dev *eth)
451 {
452 	/*
453 	 * Enable the e-dmac receiver only. The transmitter will be enabled when
454 	 * we have something to transmit
455 	 */
456 	outl(EDRRR_R, EDRRR(eth->port));
457 }
458 
459 static void sh_eth_stop(struct sh_eth_dev *eth)
460 {
461 	outl(~EDRRR_R, EDRRR(eth->port));
462 }
463 
464 int sh_eth_init(struct eth_device *dev, bd_t *bd)
465 {
466 	int ret = 0;
467 	struct sh_eth_dev *eth = dev->priv;
468 
469 	ret = sh_eth_reset(eth);
470 	if (ret)
471 		goto err;
472 
473 	ret = sh_eth_desc_init(eth);
474 	if (ret)
475 		goto err;
476 
477 	ret = sh_eth_config(eth, bd);
478 	if (ret)
479 		goto err_config;
480 
481 	sh_eth_start(eth);
482 
483 	return ret;
484 
485 err_config:
486 	sh_eth_tx_desc_free(eth);
487 	sh_eth_rx_desc_free(eth);
488 
489 err:
490 	return ret;
491 }
492 
493 void sh_eth_halt(struct eth_device *dev)
494 {
495 	struct sh_eth_dev *eth = dev->priv;
496 	sh_eth_stop(eth);
497 }
498 
499 int sh_eth_initialize(bd_t *bd)
500 {
501     int ret = 0;
502 	struct sh_eth_dev *eth = NULL;
503     struct eth_device *dev = NULL;
504 
505     eth = (struct sh_eth_dev *)malloc(sizeof(struct sh_eth_dev));
506 	if (!eth) {
507 		printf(SHETHER_NAME ": %s: malloc failed\n", __func__);
508 		ret = -ENOMEM;
509 		goto err;
510 	}
511 
512     dev = (struct eth_device *)malloc(sizeof(struct eth_device));
513 	if (!dev) {
514 		printf(SHETHER_NAME ": %s: malloc failed\n", __func__);
515 		ret = -ENOMEM;
516 		goto err;
517 	}
518     memset(dev, 0, sizeof(struct eth_device));
519     memset(eth, 0, sizeof(struct sh_eth_dev));
520 
521 	eth->port = CONFIG_SH_ETHER_USE_PORT;
522 	eth->port_info[eth->port].phy_addr = CONFIG_SH_ETHER_PHY_ADDR;
523 
524     dev->priv = (void *)eth;
525     dev->iobase = 0;
526     dev->init = sh_eth_init;
527     dev->halt = sh_eth_halt;
528     dev->send = sh_eth_send;
529     dev->recv = sh_eth_recv;
530     eth->port_info[eth->port].dev = dev;
531 
532 	sprintf(dev->name, SHETHER_NAME);
533 
534     /* Register Device to EtherNet subsystem  */
535     eth_register(dev);
536 
537 	bb_miiphy_buses[0].priv = eth;
538 	miiphy_register(dev->name, bb_miiphy_read, bb_miiphy_write);
539 
540 	if (!eth_getenv_enetaddr("ethaddr", dev->enetaddr))
541 		puts("Please set MAC address\n");
542 
543 	return ret;
544 
545 err:
546 	if (dev)
547 		free(dev);
548 
549 	if (eth)
550 		free(eth);
551 
552 	printf(SHETHER_NAME ": Failed\n");
553 	return ret;
554 }
555 
556 /******* for bb_miiphy *******/
557 static int sh_eth_bb_init(struct bb_miiphy_bus *bus)
558 {
559 	return 0;
560 }
561 
562 static int sh_eth_bb_mdio_active(struct bb_miiphy_bus *bus)
563 {
564 	struct sh_eth_dev *eth = bus->priv;
565 	int port = eth->port;
566 
567 	outl(inl(PIR(port)) | PIR_MMD, PIR(port));
568 
569 	return 0;
570 }
571 
572 static int sh_eth_bb_mdio_tristate(struct bb_miiphy_bus *bus)
573 {
574 	struct sh_eth_dev *eth = bus->priv;
575 	int port = eth->port;
576 
577 	outl(inl(PIR(port)) & ~PIR_MMD, PIR(port));
578 
579 	return 0;
580 }
581 
582 static int sh_eth_bb_set_mdio(struct bb_miiphy_bus *bus, int v)
583 {
584 	struct sh_eth_dev *eth = bus->priv;
585 	int port = eth->port;
586 
587 	if (v)
588 		outl(inl(PIR(port)) | PIR_MDO, PIR(port));
589 	else
590 		outl(inl(PIR(port)) & ~PIR_MDO, PIR(port));
591 
592 	return 0;
593 }
594 
595 static int sh_eth_bb_get_mdio(struct bb_miiphy_bus *bus, int *v)
596 {
597 	struct sh_eth_dev *eth = bus->priv;
598 	int port = eth->port;
599 
600 	*v = (inl(PIR(port)) & PIR_MDI) >> 3;
601 
602 	return 0;
603 }
604 
605 static int sh_eth_bb_set_mdc(struct bb_miiphy_bus *bus, int v)
606 {
607 	struct sh_eth_dev *eth = bus->priv;
608 	int port = eth->port;
609 
610 	if (v)
611 		outl(inl(PIR(port)) | PIR_MDC, PIR(port));
612 	else
613 		outl(inl(PIR(port)) & ~PIR_MDC, PIR(port));
614 
615 	return 0;
616 }
617 
618 static int sh_eth_bb_delay(struct bb_miiphy_bus *bus)
619 {
620 	udelay(10);
621 
622 	return 0;
623 }
624 
625 struct bb_miiphy_bus bb_miiphy_buses[] = {
626 	{
627 		.name		= "sh_eth",
628 		.init		= sh_eth_bb_init,
629 		.mdio_active	= sh_eth_bb_mdio_active,
630 		.mdio_tristate	= sh_eth_bb_mdio_tristate,
631 		.set_mdio	= sh_eth_bb_set_mdio,
632 		.get_mdio	= sh_eth_bb_get_mdio,
633 		.set_mdc	= sh_eth_bb_set_mdc,
634 		.delay		= sh_eth_bb_delay,
635 	}
636 };
637 int bb_miiphy_buses_num = ARRAY_SIZE(bb_miiphy_buses);
638