net: sh_eth: clean up for the SH7757's code
[platform/kernel/u-boot.git] / drivers / net / sh_eth.c
1 /*
2  * sh_eth.c - Driver for Renesas SH7763's ethernet controler.
3  *
4  * Copyright (C) 2008, 2011 Renesas Solutions Corp.
5  * Copyright (c) 2008, 2011 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 TIMEOUT_CNT 1000
48
49 int sh_eth_send(struct eth_device *dev, 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 & 3) {
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 = TIMEOUT_CNT;
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 err:
98         return ret;
99 }
100
101 int sh_eth_recv(struct eth_device *dev)
102 {
103         struct sh_eth_dev *eth = dev->priv;
104         int port = eth->port, len = 0;
105         struct sh_eth_info *port_info = &eth->port_info[port];
106         uchar *packet;
107
108         /* Check if the rx descriptor is ready */
109         if (!(port_info->rx_desc_cur->rd0 & RD_RACT)) {
110                 /* Check for errors */
111                 if (!(port_info->rx_desc_cur->rd0 & RD_RFE)) {
112                         len = port_info->rx_desc_cur->rd1 & 0xffff;
113                         packet = (uchar *)
114                                 ADDR_TO_P2(port_info->rx_desc_cur->rd2);
115                         NetReceive(packet, len);
116                 }
117
118                 /* Make current descriptor available again */
119                 if (port_info->rx_desc_cur->rd0 & RD_RDLE)
120                         port_info->rx_desc_cur->rd0 = RD_RACT | RD_RDLE;
121                 else
122                         port_info->rx_desc_cur->rd0 = RD_RACT;
123
124                 /* Point to the next descriptor */
125                 port_info->rx_desc_cur++;
126                 if (port_info->rx_desc_cur >=
127                     port_info->rx_desc_base + NUM_RX_DESC)
128                         port_info->rx_desc_cur = port_info->rx_desc_base;
129         }
130
131         /* Restart the receiver if disabled */
132         if (!(inl(EDRRR(port)) & EDRRR_R))
133                 outl(EDRRR_R, EDRRR(port));
134
135         return len;
136 }
137
138 static int sh_eth_reset(struct sh_eth_dev *eth)
139 {
140         int port = eth->port;
141 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
142         int ret = 0, i;
143
144         /* Start e-dmac transmitter and receiver */
145         outl(EDSR_ENALL, EDSR(port));
146
147         /* Perform a software reset and wait for it to complete */
148         outl(EDMR_SRST, EDMR(port));
149         for (i = 0; i < TIMEOUT_CNT ; i++) {
150                 if (!(inl(EDMR(port)) & EDMR_SRST))
151                         break;
152                 udelay(1000);
153         }
154
155         if (i == TIMEOUT_CNT) {
156                 printf(SHETHER_NAME  ": Software reset timeout\n");
157                 ret = -EIO;
158         }
159
160         return ret;
161 #else
162         outl(inl(EDMR(port)) | EDMR_SRST, EDMR(port));
163         udelay(3000);
164         outl(inl(EDMR(port)) & ~EDMR_SRST, EDMR(port));
165
166         return 0;
167 #endif
168 }
169
170 static int sh_eth_tx_desc_init(struct sh_eth_dev *eth)
171 {
172         int port = eth->port, i, ret = 0;
173         u32 tmp_addr;
174         struct sh_eth_info *port_info = &eth->port_info[port];
175         struct tx_desc_s *cur_tx_desc;
176
177         /*
178          * Allocate tx descriptors. They must be TX_DESC_SIZE bytes aligned
179          */
180         port_info->tx_desc_malloc = malloc(NUM_TX_DESC *
181                                                  sizeof(struct tx_desc_s) +
182                                                  TX_DESC_SIZE - 1);
183         if (!port_info->tx_desc_malloc) {
184                 printf(SHETHER_NAME ": malloc failed\n");
185                 ret = -ENOMEM;
186                 goto err;
187         }
188
189         tmp_addr = (u32) (((int)port_info->tx_desc_malloc + TX_DESC_SIZE - 1) &
190                           ~(TX_DESC_SIZE - 1));
191         flush_cache_wback(tmp_addr, NUM_TX_DESC * sizeof(struct tx_desc_s));
192         /* Make sure we use a P2 address (non-cacheable) */
193         port_info->tx_desc_base = (struct tx_desc_s *)ADDR_TO_P2(tmp_addr);
194         port_info->tx_desc_cur = port_info->tx_desc_base;
195
196         /* Initialize all descriptors */
197         for (cur_tx_desc = port_info->tx_desc_base, i = 0; i < NUM_TX_DESC;
198              cur_tx_desc++, i++) {
199                 cur_tx_desc->td0 = 0x00;
200                 cur_tx_desc->td1 = 0x00;
201                 cur_tx_desc->td2 = 0x00;
202         }
203
204         /* Mark the end of the descriptors */
205         cur_tx_desc--;
206         cur_tx_desc->td0 |= TD_TDLE;
207
208         /* Point the controller to the tx descriptor list. Must use physical
209            addresses */
210         outl(ADDR_TO_PHY(port_info->tx_desc_base), TDLAR(port));
211 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
212         outl(ADDR_TO_PHY(port_info->tx_desc_base), TDFAR(port));
213         outl(ADDR_TO_PHY(cur_tx_desc), TDFXR(port));
214         outl(0x01, TDFFR(port));/* Last discriptor bit */
215 #endif
216
217 err:
218         return ret;
219 }
220
221 static int sh_eth_rx_desc_init(struct sh_eth_dev *eth)
222 {
223         int port = eth->port, i , ret = 0;
224         struct sh_eth_info *port_info = &eth->port_info[port];
225         struct rx_desc_s *cur_rx_desc;
226         u32 tmp_addr;
227         u8 *rx_buf;
228
229         /*
230          * Allocate rx descriptors. They must be RX_DESC_SIZE bytes aligned
231          */
232         port_info->rx_desc_malloc = malloc(NUM_RX_DESC *
233                                                  sizeof(struct rx_desc_s) +
234                                                  RX_DESC_SIZE - 1);
235         if (!port_info->rx_desc_malloc) {
236                 printf(SHETHER_NAME ": malloc failed\n");
237                 ret = -ENOMEM;
238                 goto err;
239         }
240
241         tmp_addr = (u32) (((int)port_info->rx_desc_malloc + RX_DESC_SIZE - 1) &
242                           ~(RX_DESC_SIZE - 1));
243         flush_cache_wback(tmp_addr, NUM_RX_DESC * sizeof(struct rx_desc_s));
244         /* Make sure we use a P2 address (non-cacheable) */
245         port_info->rx_desc_base = (struct rx_desc_s *)ADDR_TO_P2(tmp_addr);
246
247         port_info->rx_desc_cur = port_info->rx_desc_base;
248
249         /*
250          * Allocate rx data buffers. They must be 32 bytes aligned  and in
251          * P2 area
252          */
253         port_info->rx_buf_malloc = malloc(NUM_RX_DESC * MAX_BUF_SIZE + 31);
254         if (!port_info->rx_buf_malloc) {
255                 printf(SHETHER_NAME ": malloc failed\n");
256                 ret = -ENOMEM;
257                 goto err_buf_malloc;
258         }
259
260         tmp_addr = (u32)(((int)port_info->rx_buf_malloc + (32 - 1)) &
261                           ~(32 - 1));
262         port_info->rx_buf_base = (u8 *)ADDR_TO_P2(tmp_addr);
263
264         /* Initialize all descriptors */
265         for (cur_rx_desc = port_info->rx_desc_base,
266              rx_buf = port_info->rx_buf_base, i = 0;
267              i < NUM_RX_DESC; cur_rx_desc++, rx_buf += MAX_BUF_SIZE, i++) {
268                 cur_rx_desc->rd0 = RD_RACT;
269                 cur_rx_desc->rd1 = MAX_BUF_SIZE << 16;
270                 cur_rx_desc->rd2 = (u32) ADDR_TO_PHY(rx_buf);
271         }
272
273         /* Mark the end of the descriptors */
274         cur_rx_desc--;
275         cur_rx_desc->rd0 |= RD_RDLE;
276
277         /* Point the controller to the rx descriptor list */
278         outl(ADDR_TO_PHY(port_info->rx_desc_base), RDLAR(port));
279 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
280         outl(ADDR_TO_PHY(port_info->rx_desc_base), RDFAR(port));
281         outl(ADDR_TO_PHY(cur_rx_desc), RDFXR(port));
282         outl(RDFFR_RDLF, RDFFR(port));
283 #endif
284
285         return ret;
286
287 err_buf_malloc:
288         free(port_info->rx_desc_malloc);
289         port_info->rx_desc_malloc = NULL;
290
291 err:
292         return ret;
293 }
294
295 static void sh_eth_tx_desc_free(struct sh_eth_dev *eth)
296 {
297         int port = eth->port;
298         struct sh_eth_info *port_info = &eth->port_info[port];
299
300         if (port_info->tx_desc_malloc) {
301                 free(port_info->tx_desc_malloc);
302                 port_info->tx_desc_malloc = NULL;
303         }
304 }
305
306 static void sh_eth_rx_desc_free(struct sh_eth_dev *eth)
307 {
308         int port = eth->port;
309         struct sh_eth_info *port_info = &eth->port_info[port];
310
311         if (port_info->rx_desc_malloc) {
312                 free(port_info->rx_desc_malloc);
313                 port_info->rx_desc_malloc = NULL;
314         }
315
316         if (port_info->rx_buf_malloc) {
317                 free(port_info->rx_buf_malloc);
318                 port_info->rx_buf_malloc = NULL;
319         }
320 }
321
322 static int sh_eth_desc_init(struct sh_eth_dev *eth)
323 {
324         int ret = 0;
325
326         ret = sh_eth_tx_desc_init(eth);
327         if (ret)
328                 goto err_tx_init;
329
330         ret = sh_eth_rx_desc_init(eth);
331         if (ret)
332                 goto err_rx_init;
333
334         return ret;
335 err_rx_init:
336         sh_eth_tx_desc_free(eth);
337
338 err_tx_init:
339         return ret;
340 }
341
342 static int sh_eth_phy_config(struct sh_eth_dev *eth)
343 {
344         int port = eth->port, ret = 0;
345         struct sh_eth_info *port_info = &eth->port_info[port];
346         struct eth_device *dev = port_info->dev;
347         struct phy_device *phydev;
348
349         phydev = phy_connect(
350                         miiphy_get_dev_by_name(dev->name),
351                         port_info->phy_addr, dev, CONFIG_SH_ETHER_PHY_MODE);
352         port_info->phydev = phydev;
353         phy_config(phydev);
354
355         return ret;
356 }
357
358 static int sh_eth_config(struct sh_eth_dev *eth, bd_t *bd)
359 {
360         int port = eth->port, ret = 0;
361         u32 val;
362         struct sh_eth_info *port_info = &eth->port_info[port];
363         struct eth_device *dev = port_info->dev;
364         struct phy_device *phy;
365
366         /* Configure e-dmac registers */
367         outl((inl(EDMR(port)) & ~EMDR_DESC_R) | EDMR_EL, EDMR(port));
368         outl(0, EESIPR(port));
369         outl(0, TRSCER(port));
370         outl(0, TFTR(port));
371         outl((FIFO_SIZE_T | FIFO_SIZE_R), FDR(port));
372         outl(RMCR_RST, RMCR(port));
373 #if !defined(CONFIG_CPU_SH7757) && !defined(CONFIG_CPU_SH7724)
374         outl(0, RPADIR(port));
375 #endif
376         outl((FIFO_F_D_RFF | FIFO_F_D_RFD), FCFTR(port));
377
378         /* Configure e-mac registers */
379         outl(0, ECSIPR(port));
380
381         /* Set Mac address */
382         val = dev->enetaddr[0] << 24 | dev->enetaddr[1] << 16 |
383             dev->enetaddr[2] << 8 | dev->enetaddr[3];
384         outl(val, MAHR(port));
385
386         val = dev->enetaddr[4] << 8 | dev->enetaddr[5];
387         outl(val, MALR(port));
388
389         outl(RFLR_RFL_MIN, RFLR(port));
390 #if !defined(CONFIG_CPU_SH7757) && !defined(CONFIG_CPU_SH7724)
391         outl(0, PIPR(port));
392 #endif
393 #if !defined(CONFIG_CPU_SH7724) && !defined(CONFIG_CPU_SH7757)
394         outl(APR_AP, APR(port));
395         outl(MPR_MP, MPR(port));
396 #endif
397 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
398         outl(TPAUSER_TPAUSE, TPAUSER(port));
399 #endif
400
401 #if defined(CONFIG_CPU_SH7734)
402         outl(CONFIG_SH_ETHER_SH7734_MII, RMII_MII(port));
403 #endif
404         /* Configure phy */
405         ret = sh_eth_phy_config(eth);
406         if (ret) {
407                 printf(SHETHER_NAME ": phy config timeout\n");
408                 goto err_phy_cfg;
409         }
410         phy = port_info->phydev;
411         ret = phy_startup(phy);
412         if (ret) {
413                 printf(SHETHER_NAME ": phy startup failure\n");
414                 return ret;
415         }
416
417         val = 0;
418
419         /* Set the transfer speed */
420         if (phy->speed == 100) {
421                 printf(SHETHER_NAME ": 100Base/");
422 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
423                 outl(GECMR_100B, GECMR(port));
424 #elif defined(CONFIG_CPU_SH7757)
425                 outl(1, RTRATE(port));
426 #elif defined(CONFIG_CPU_SH7724)
427                 val = ECMR_RTM;
428 #endif
429         } else if (phy->speed == 10) {
430                 printf(SHETHER_NAME ": 10Base/");
431 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
432                 outl(GECMR_10B, GECMR(port));
433 #elif defined(CONFIG_CPU_SH7757)
434                 outl(0, RTRATE(port));
435 #endif
436         }
437 #if defined(CONFIG_CPU_SH7763) || defined(CONFIG_CPU_SH7734)
438         else if (phy->speed == 1000) {
439                 printf(SHETHER_NAME ": 1000Base/");
440                 outl(GECMR_1000B, GECMR(port));
441         }
442 #endif
443
444         /* Check if full duplex mode is supported by the phy */
445         if (phy->duplex) {
446                 printf("Full\n");
447                 outl(val | (ECMR_CHG_DM|ECMR_RE|ECMR_TE|ECMR_DM), ECMR(port));
448         } else {
449                 printf("Half\n");
450                 outl(val | (ECMR_CHG_DM|ECMR_RE|ECMR_TE),  ECMR(port));
451         }
452
453         return ret;
454
455 err_phy_cfg:
456         return ret;
457 }
458
459 static void sh_eth_start(struct sh_eth_dev *eth)
460 {
461         /*
462          * Enable the e-dmac receiver only. The transmitter will be enabled when
463          * we have something to transmit
464          */
465         outl(EDRRR_R, EDRRR(eth->port));
466 }
467
468 static void sh_eth_stop(struct sh_eth_dev *eth)
469 {
470         outl(~EDRRR_R, EDRRR(eth->port));
471 }
472
473 int sh_eth_init(struct eth_device *dev, bd_t *bd)
474 {
475         int ret = 0;
476         struct sh_eth_dev *eth = dev->priv;
477
478         ret = sh_eth_reset(eth);
479         if (ret)
480                 goto err;
481
482         ret = sh_eth_desc_init(eth);
483         if (ret)
484                 goto err;
485
486         ret = sh_eth_config(eth, bd);
487         if (ret)
488                 goto err_config;
489
490         sh_eth_start(eth);
491
492         return ret;
493
494 err_config:
495         sh_eth_tx_desc_free(eth);
496         sh_eth_rx_desc_free(eth);
497
498 err:
499         return ret;
500 }
501
502 void sh_eth_halt(struct eth_device *dev)
503 {
504         struct sh_eth_dev *eth = dev->priv;
505         sh_eth_stop(eth);
506 }
507
508 int sh_eth_initialize(bd_t *bd)
509 {
510     int ret = 0;
511         struct sh_eth_dev *eth = NULL;
512     struct eth_device *dev = NULL;
513
514     eth = (struct sh_eth_dev *)malloc(sizeof(struct sh_eth_dev));
515         if (!eth) {
516                 printf(SHETHER_NAME ": %s: malloc failed\n", __func__);
517                 ret = -ENOMEM;
518                 goto err;
519         }
520
521     dev = (struct eth_device *)malloc(sizeof(struct eth_device));
522         if (!dev) {
523                 printf(SHETHER_NAME ": %s: malloc failed\n", __func__);
524                 ret = -ENOMEM;
525                 goto err;
526         }
527     memset(dev, 0, sizeof(struct eth_device));
528     memset(eth, 0, sizeof(struct sh_eth_dev));
529
530         eth->port = CONFIG_SH_ETHER_USE_PORT;
531         eth->port_info[eth->port].phy_addr = CONFIG_SH_ETHER_PHY_ADDR;
532
533     dev->priv = (void *)eth;
534     dev->iobase = 0;
535     dev->init = sh_eth_init;
536     dev->halt = sh_eth_halt;
537     dev->send = sh_eth_send;
538     dev->recv = sh_eth_recv;
539     eth->port_info[eth->port].dev = dev;
540
541         sprintf(dev->name, SHETHER_NAME);
542
543     /* Register Device to EtherNet subsystem  */
544     eth_register(dev);
545
546         bb_miiphy_buses[0].priv = eth;
547         miiphy_register(dev->name, bb_miiphy_read, bb_miiphy_write);
548
549         if (!eth_getenv_enetaddr("ethaddr", dev->enetaddr))
550                 puts("Please set MAC address\n");
551
552         return ret;
553
554 err:
555         if (dev)
556                 free(dev);
557
558         if (eth)
559                 free(eth);
560
561         printf(SHETHER_NAME ": Failed\n");
562         return ret;
563 }
564
565 /******* for bb_miiphy *******/
566 static int sh_eth_bb_init(struct bb_miiphy_bus *bus)
567 {
568         return 0;
569 }
570
571 static int sh_eth_bb_mdio_active(struct bb_miiphy_bus *bus)
572 {
573         struct sh_eth_dev *eth = bus->priv;
574         int port = eth->port;
575
576         outl(inl(PIR(port)) | PIR_MMD, PIR(port));
577
578         return 0;
579 }
580
581 static int sh_eth_bb_mdio_tristate(struct bb_miiphy_bus *bus)
582 {
583         struct sh_eth_dev *eth = bus->priv;
584         int port = eth->port;
585
586         outl(inl(PIR(port)) & ~PIR_MMD, PIR(port));
587
588         return 0;
589 }
590
591 static int sh_eth_bb_set_mdio(struct bb_miiphy_bus *bus, int v)
592 {
593         struct sh_eth_dev *eth = bus->priv;
594         int port = eth->port;
595
596         if (v)
597                 outl(inl(PIR(port)) | PIR_MDO, PIR(port));
598         else
599                 outl(inl(PIR(port)) & ~PIR_MDO, PIR(port));
600
601         return 0;
602 }
603
604 static int sh_eth_bb_get_mdio(struct bb_miiphy_bus *bus, int *v)
605 {
606         struct sh_eth_dev *eth = bus->priv;
607         int port = eth->port;
608
609         *v = (inl(PIR(port)) & PIR_MDI) >> 3;
610
611         return 0;
612 }
613
614 static int sh_eth_bb_set_mdc(struct bb_miiphy_bus *bus, int v)
615 {
616         struct sh_eth_dev *eth = bus->priv;
617         int port = eth->port;
618
619         if (v)
620                 outl(inl(PIR(port)) | PIR_MDC, PIR(port));
621         else
622                 outl(inl(PIR(port)) & ~PIR_MDC, PIR(port));
623
624         return 0;
625 }
626
627 static int sh_eth_bb_delay(struct bb_miiphy_bus *bus)
628 {
629         udelay(10);
630
631         return 0;
632 }
633
634 struct bb_miiphy_bus bb_miiphy_buses[] = {
635         {
636                 .name           = "sh_eth",
637                 .init           = sh_eth_bb_init,
638                 .mdio_active    = sh_eth_bb_mdio_active,
639                 .mdio_tristate  = sh_eth_bb_mdio_tristate,
640                 .set_mdio       = sh_eth_bb_set_mdio,
641                 .get_mdio       = sh_eth_bb_get_mdio,
642                 .set_mdc        = sh_eth_bb_set_mdc,
643                 .delay          = sh_eth_bb_delay,
644         }
645 };
646 int bb_miiphy_buses_num = ARRAY_SIZE(bb_miiphy_buses);