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