net/eth.c

   1 /*
   2  * (C) Copyright 2001-2010
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (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., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 #include <common.h>
  25 #include <command.h>
  26 #include <net.h>
  27 #include <miiphy.h>
  28 #include <phy.h>
  29
  30 void eth_parse_enetaddr(const char *addr, uchar *enetaddr)
  31 {
  32         char *end;
  33         int i;
  34
  35         for (i = 0; i < 6; ++i) {
  36                 enetaddr[i] = addr ? simple_strtoul(addr, &end, 16) : 0;
  37                 if (addr)
  38                         addr = (*end) ? end + 1 : end;
  39         }
  40 }
  41
  42 int eth_getenv_enetaddr(char *name, uchar *enetaddr)
  43 {
  44         eth_parse_enetaddr(getenv(name), enetaddr);
  45         return is_valid_ether_addr(enetaddr);
  46 }
  47
  48 int eth_setenv_enetaddr(char *name, const uchar *enetaddr)
  49 {
  50         char buf[20];
  51
  52         sprintf(buf, "%pM", enetaddr);
  53
  54         return setenv(name, buf);
  55 }
  56
  57 int eth_getenv_enetaddr_by_index(const char *base_name, int index,
  58                                  uchar *enetaddr)
  59 {
  60         char enetvar[32];
  61         sprintf(enetvar, index ? "%s%daddr" : "%saddr", base_name, index);
  62         return eth_getenv_enetaddr(enetvar, enetaddr);
  63 }
  64
  65 static int eth_mac_skip(int index)
  66 {
  67         char enetvar[15];
  68         char *skip_state;
  69         sprintf(enetvar, index ? "eth%dmacskip" : "ethmacskip", index);
  70         return ((skip_state = getenv(enetvar)) != NULL);
  71 }
  72
  73 /*
  74  * CPU and board-specific Ethernet initializations.  Aliased function
  75  * signals caller to move on
  76  */
  77 static int __def_eth_init(bd_t *bis)
  78 {
  79         return -1;
  80 }
  81 int cpu_eth_init(bd_t *bis) __attribute__((weak, alias("__def_eth_init")));
  82 int board_eth_init(bd_t *bis) __attribute__((weak, alias("__def_eth_init")));
  83
  84 #ifdef CONFIG_API
  85 extern void (*push_packet)(volatile void *, int);
  86
  87 static struct {
  88         uchar data[PKTSIZE];
  89         int length;
  90 } eth_rcv_bufs[PKTBUFSRX];
  91
  92 static unsigned int eth_rcv_current = 0, eth_rcv_last = 0;
  93 #endif
  94
  95 static struct eth_device *eth_devices, *eth_current;
  96
  97 struct eth_device *eth_get_dev(void)
  98 {
  99         return eth_current;
 100 }
 101
 102 struct eth_device *eth_get_dev_by_name(const char *devname)
 103 {
 104         struct eth_device *dev, *target_dev;
 105
 106         BUG_ON(devname == NULL);
 107
 108         if (!eth_devices)
 109                 return NULL;
 110
 111         dev = eth_devices;
 112         target_dev = NULL;
 113         do {
 114                 if (strcmp(devname, dev->name) == 0) {
 115                         target_dev = dev;
 116                         break;
 117                 }
 118                 dev = dev->next;
 119         } while (dev != eth_devices);
 120
 121         return target_dev;
 122 }
 123
 124 struct eth_device *eth_get_dev_by_index(int index)
 125 {
 126         struct eth_device *dev, *target_dev;
 127
 128         if (!eth_devices)
 129                 return NULL;
 130
 131         dev = eth_devices;
 132         target_dev = NULL;
 133         do {
 134                 if (dev->index == index) {
 135                         target_dev = dev;
 136                         break;
 137                 }
 138                 dev = dev->next;
 139         } while (dev != eth_devices);
 140
 141         return target_dev;
 142 }
 143
 144 int eth_get_dev_index (void)
 145 {
 146         if (!eth_current) {
 147                 return -1;
 148         }
 149
 150         return eth_current->index;
 151 }
 152
 153 static void eth_current_changed(void)
 154 {
 155         char *act = getenv("ethact");
 156         /* update current ethernet name */
 157         if (eth_current) {
 158                 if (act == NULL || strcmp(act, eth_current->name) != 0)
 159                         setenv("ethact", eth_current->name);
 160         }
 161         /*
 162          * remove the variable completely if there is no active
 163          * interface
 164          */
 165         else if (act != NULL)
 166                 setenv("ethact", NULL);
 167 }
 168
 169 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
 170                    int eth_number)
 171 {
 172         unsigned char env_enetaddr[6];
 173         int ret = 0;
 174
 175         if (!eth_getenv_enetaddr_by_index(base_name, eth_number, env_enetaddr))
 176                 return -1;
 177
 178         if (memcmp(env_enetaddr, "\0\0\0\0\0\0", 6)) {
 179                 if (memcmp(dev->enetaddr, "\0\0\0\0\0\0", 6) &&
 180                         memcmp(dev->enetaddr, env_enetaddr, 6)) {
 181                         printf("\nWarning: %s MAC addresses don't match:\n",
 182                                 dev->name);
 183                         printf("Address in SROM is         %pM\n",
 184                                 dev->enetaddr);
 185                         printf("Address in environment is  %pM\n",
 186                                 env_enetaddr);
 187                 }
 188
 189                 memcpy(dev->enetaddr, env_enetaddr, 6);
 190         }
 191
 192         if (dev->write_hwaddr &&
 193                 !eth_mac_skip(eth_number) &&
 194                 is_valid_ether_addr(dev->enetaddr)) {
 195                 ret = dev->write_hwaddr(dev);
 196         }
 197
 198         return ret;
 199 }
 200
 201 int eth_register(struct eth_device *dev)
 202 {
 203         struct eth_device *d;
 204         static int index = 0;
 205
 206         assert(strlen(dev->name) < NAMESIZE);
 207
 208         if (!eth_devices) {
 209                 eth_current = eth_devices = dev;
 210                 eth_current_changed();
 211         } else {
 212                 for (d=eth_devices; d->next!=eth_devices; d=d->next)
 213                         ;
 214                 d->next = dev;
 215         }
 216
 217         dev->state = ETH_STATE_INIT;
 218         dev->next  = eth_devices;
 219         dev->index = index++;
 220
 221         return 0;
 222 }
 223
 224 int eth_unregister(struct eth_device *dev)
 225 {
 226         struct eth_device *cur;
 227
 228         /* No device */
 229         if (!eth_devices)
 230                 return -1;
 231
 232         for (cur = eth_devices; cur->next != eth_devices && cur->next != dev;
 233              cur = cur->next)
 234                 ;
 235
 236         /* Device not found */
 237         if (cur->next != dev)
 238                 return -1;
 239
 240         cur->next = dev->next;
 241
 242         if (eth_devices == dev)
 243                 eth_devices = dev->next == eth_devices ? NULL : dev->next;
 244
 245         if (eth_current == dev) {
 246                 eth_current = eth_devices;
 247                 eth_current_changed();
 248         }
 249
 250         return 0;
 251 }
 252
 253 int eth_initialize(bd_t *bis)
 254 {
 255         int num_devices = 0;
 256         eth_devices = NULL;
 257         eth_current = NULL;
 258
 259         show_boot_progress (64);
 260 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
 261         miiphy_init();
 262 #endif
 263
 264 #ifdef CONFIG_PHYLIB
 265         phy_init();
 266 #endif
 267
 268         /*
 269          * If board-specific initialization exists, call it.
 270          * If not, call a CPU-specific one
 271          */
 272         if (board_eth_init != __def_eth_init) {
 273                 if (board_eth_init(bis) < 0)
 274                         printf("Board Net Initialization Failed\n");
 275         } else if (cpu_eth_init != __def_eth_init) {
 276                 if (cpu_eth_init(bis) < 0)
 277                         printf("CPU Net Initialization Failed\n");
 278         } else
 279                 printf("Net Initialization Skipped\n");
 280
 281         if (!eth_devices) {
 282                 puts ("No ethernet found.\n");
 283                 show_boot_progress (-64);
 284         } else {
 285                 struct eth_device *dev = eth_devices;
 286                 char *ethprime = getenv ("ethprime");
 287
 288                 show_boot_progress (65);
 289                 do {
 290                         if (dev->index)
 291                                 puts (", ");
 292
 293                         printf("%s", dev->name);
 294
 295                         if (ethprime && strcmp (dev->name, ethprime) == 0) {
 296                                 eth_current = dev;
 297                                 puts (" [PRIME]");
 298                         }
 299
 300                         if (strchr(dev->name, ' '))
 301                                 puts("\nWarning: eth device name has a space!\n");
 302
 303                         if (eth_write_hwaddr(dev, "eth", dev->index))
 304                                 puts("\nWarning: failed to set MAC address\n");
 305
 306                         dev = dev->next;
 307                         num_devices++;
 308                 } while(dev != eth_devices);
 309
 310                 eth_current_changed();
 311                 putc ('\n');
 312         }
 313
 314         return num_devices;
 315 }
 316
 317 #ifdef CONFIG_MCAST_TFTP
 318 /* Multicast.
 319  * mcast_addr: multicast ipaddr from which multicast Mac is made
 320  * join: 1=join, 0=leave.
 321  */
 322 int eth_mcast_join( IPaddr_t mcast_ip, u8 join)
 323 {
 324  u8 mcast_mac[6];
 325         if (!eth_current || !eth_current->mcast)
 326                 return -1;
 327         mcast_mac[5] = htonl(mcast_ip) & 0xff;
 328         mcast_mac[4] = (htonl(mcast_ip)>>8) & 0xff;
 329         mcast_mac[3] = (htonl(mcast_ip)>>16) & 0x7f;
 330         mcast_mac[2] = 0x5e;
 331         mcast_mac[1] = 0x0;
 332         mcast_mac[0] = 0x1;
 333         return eth_current->mcast(eth_current, mcast_mac, join);
 334 }
 335
 336 /* the 'way' for ethernet-CRC-32. Spliced in from Linux lib/crc32.c
 337  * and this is the ethernet-crc method needed for TSEC -- and perhaps
 338  * some other adapter -- hash tables
 339  */
 340 #define CRCPOLY_LE 0xedb88320
 341 u32 ether_crc (size_t len, unsigned char const *p)
 342 {
 343         int i;
 344         u32 crc;
 345         crc = ~0;
 346         while (len--) {
 347                 crc ^= *p++;
 348                 for (i = 0; i < 8; i++)
 349                         crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
 350         }
 351         /* an reverse the bits, cuz of way they arrive -- last-first */
 352         crc = (crc >> 16) | (crc << 16);
 353         crc = (crc >> 8 & 0x00ff00ff) | (crc << 8 & 0xff00ff00);
 354         crc = (crc >> 4 & 0x0f0f0f0f) | (crc << 4 & 0xf0f0f0f0);
 355         crc = (crc >> 2 & 0x33333333) | (crc << 2 & 0xcccccccc);
 356         crc = (crc >> 1 & 0x55555555) | (crc << 1 & 0xaaaaaaaa);
 357         return crc;
 358 }
 359
 360 #endif
 361
 362
 363 int eth_init(bd_t *bis)
 364 {
 365         struct eth_device *old_current, *dev;
 366
 367         if (!eth_current) {
 368                 puts ("No ethernet found.\n");
 369                 return -1;
 370         }
 371
 372         /* Sync environment with network devices */
 373         dev = eth_devices;
 374         do {
 375                 uchar env_enetaddr[6];
 376
 377                 if (eth_getenv_enetaddr_by_index("eth", dev->index,
 378                                                  env_enetaddr))
 379                         memcpy(dev->enetaddr, env_enetaddr, 6);
 380
 381                 dev = dev->next;
 382         } while (dev != eth_devices);
 383
 384         old_current = eth_current;
 385         do {
 386                 debug("Trying %s\n", eth_current->name);
 387
 388                 if (eth_current->init(eth_current,bis) >= 0) {
 389                         eth_current->state = ETH_STATE_ACTIVE;
 390
 391                         return 0;
 392                 }
 393                 debug("FAIL\n");
 394
 395                 eth_try_another(0);
 396         } while (old_current != eth_current);
 397
 398         return -1;
 399 }
 400
 401 void eth_halt(void)
 402 {
 403         if (!eth_current)
 404                 return;
 405
 406         eth_current->halt(eth_current);
 407
 408         eth_current->state = ETH_STATE_PASSIVE;
 409 }
 410
 411 int eth_send(volatile void *packet, int length)
 412 {
 413         if (!eth_current)
 414                 return -1;
 415
 416         return eth_current->send(eth_current, packet, length);
 417 }
 418
 419 int eth_rx(void)
 420 {
 421         if (!eth_current)
 422                 return -1;
 423
 424         return eth_current->recv(eth_current);
 425 }
 426
 427 #ifdef CONFIG_API
 428 static void eth_save_packet(volatile void *packet, int length)
 429 {
 430         volatile char *p = packet;
 431         int i;
 432
 433         if ((eth_rcv_last+1) % PKTBUFSRX == eth_rcv_current)
 434                 return;
 435
 436         if (PKTSIZE < length)
 437                 return;
 438
 439         for (i = 0; i < length; i++)
 440                 eth_rcv_bufs[eth_rcv_last].data[i] = p[i];
 441
 442         eth_rcv_bufs[eth_rcv_last].length = length;
 443         eth_rcv_last = (eth_rcv_last + 1) % PKTBUFSRX;
 444 }
 445
 446 int eth_receive(volatile void *packet, int length)
 447 {
 448         volatile char *p = packet;
 449         void *pp = push_packet;
 450         int i;
 451
 452         if (eth_rcv_current == eth_rcv_last) {
 453                 push_packet = eth_save_packet;
 454                 eth_rx();
 455                 push_packet = pp;
 456
 457                 if (eth_rcv_current == eth_rcv_last)
 458                         return -1;
 459         }
 460
 461         if (length < eth_rcv_bufs[eth_rcv_current].length)
 462                 return -1;
 463
 464         length = eth_rcv_bufs[eth_rcv_current].length;
 465
 466         for (i = 0; i < length; i++)
 467                 p[i] = eth_rcv_bufs[eth_rcv_current].data[i];
 468
 469         eth_rcv_current = (eth_rcv_current + 1) % PKTBUFSRX;
 470         return length;
 471 }
 472 #endif /* CONFIG_API */
 473
 474 void eth_try_another(int first_restart)
 475 {
 476         static struct eth_device *first_failed = NULL;
 477         char *ethrotate;
 478
 479         /*
 480          * Do not rotate between network interfaces when
 481          * 'ethrotate' variable is set to 'no'.
 482          */
 483         if (((ethrotate = getenv ("ethrotate")) != NULL) &&
 484             (strcmp(ethrotate, "no") == 0))
 485                 return;
 486
 487         if (!eth_current)
 488                 return;
 489
 490         if (first_restart) {
 491                 first_failed = eth_current;
 492         }
 493
 494         eth_current = eth_current->next;
 495
 496         eth_current_changed();
 497
 498         if (first_failed == eth_current) {
 499                 NetRestartWrap = 1;
 500         }
 501 }
 502
 503 void eth_set_current(void)
 504 {
 505         static char *act = NULL;
 506         static int  env_changed_id = 0;
 507         struct eth_device* old_current;
 508         int     env_id;
 509
 510         if (!eth_current)       /* XXX no current */
 511                 return;
 512
 513         env_id = get_env_id();
 514         if ((act == NULL) || (env_changed_id != env_id)) {
 515                 act = getenv("ethact");
 516                 env_changed_id = env_id;
 517         }
 518         if (act != NULL) {
 519                 old_current = eth_current;
 520                 do {
 521                         if (strcmp(eth_current->name, act) == 0)
 522                                 return;
 523                         eth_current = eth_current->next;
 524                 } while (old_current != eth_current);
 525         }
 526
 527         eth_current_changed();
 528 }
 529
 530 char *eth_get_name (void)
 531 {
 532         return (eth_current ? eth_current->name : "unknown");
 533 }