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                 if (!is_valid_ether_addr(dev->enetaddr))
 223                         return -1;
 224
 225                 ret = dev->write_hwaddr(dev);
 226         }
 227
 228         return ret;
 229 }
 230
 231 int eth_register(struct eth_device *dev)
 232 {
 233         struct eth_device *d;
 234         static int index;
 235
 236         assert(strlen(dev->name) < sizeof(dev->name));
 237
 238         if (!eth_devices) {
 239                 eth_current = eth_devices = dev;
 240                 eth_current_changed();
 241         } else {
 242                 for (d = eth_devices; d->next != eth_devices; d = d->next)
 243                         ;
 244                 d->next = dev;
 245         }
 246
 247         dev->state = ETH_STATE_INIT;
 248         dev->next  = eth_devices;
 249         dev->index = index++;
 250
 251         return 0;
 252 }
 253
 254 int eth_unregister(struct eth_device *dev)
 255 {
 256         struct eth_device *cur;
 257
 258         /* No device */
 259         if (!eth_devices)
 260                 return -1;
 261
 262         for (cur = eth_devices; cur->next != eth_devices && cur->next != dev;
 263              cur = cur->next)
 264                 ;
 265
 266         /* Device not found */
 267         if (cur->next != dev)
 268                 return -1;
 269
 270         cur->next = dev->next;
 271
 272         if (eth_devices == dev)
 273                 eth_devices = dev->next == eth_devices ? NULL : dev->next;
 274
 275         if (eth_current == dev) {
 276                 eth_current = eth_devices;
 277                 eth_current_changed();
 278         }
 279
 280         return 0;
 281 }
 282
 283 static void eth_env_init(bd_t *bis)
 284 {
 285         const char *s;
 286
 287         if ((s = getenv("bootfile")) != NULL)
 288                 copy_filename(BootFile, s, sizeof(BootFile));
 289 }
 290
 291 int eth_initialize(bd_t *bis)
 292 {
 293         int num_devices = 0;
 294         eth_devices = NULL;
 295         eth_current = NULL;
 296
 297         bootstage_mark(BOOTSTAGE_ID_NET_ETH_START);
 298 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII)
 299         miiphy_init();
 300 #endif
 301
 302 #ifdef CONFIG_PHYLIB
 303         phy_init();
 304 #endif
 305
 306         eth_env_init(bis);
 307
 308         /*
 309          * If board-specific initialization exists, call it.
 310          * If not, call a CPU-specific one
 311          */
 312         if (board_eth_init != __def_eth_init) {
 313                 if (board_eth_init(bis) < 0)
 314                         printf("Board Net Initialization Failed\n");
 315         } else if (cpu_eth_init != __def_eth_init) {
 316                 if (cpu_eth_init(bis) < 0)
 317                         printf("CPU Net Initialization Failed\n");
 318         } else
 319                 printf("Net Initialization Skipped\n");
 320
 321         if (!eth_devices) {
 322                 puts("No ethernet found.\n");
 323                 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
 324         } else {
 325                 struct eth_device *dev = eth_devices;
 326                 char *ethprime = getenv("ethprime");
 327
 328                 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
 329                 do {
 330                         if (dev->index)
 331                                 puts(", ");
 332
 333                         printf("%s", dev->name);
 334
 335                         if (ethprime && strcmp(dev->name, ethprime) == 0) {
 336                                 eth_current = dev;
 337                                 puts(" [PRIME]");
 338                         }
 339
 340                         if (strchr(dev->name, ' '))
 341                                 puts("\nWarning: eth device name has a space!"
 342                                         "\n");
 343
 344                         if (eth_write_hwaddr(dev, "eth", dev->index))
 345                                 puts("\nWarning: failed to set MAC address\n");
 346
 347                         dev = dev->next;
 348                         num_devices++;
 349                 } while (dev != eth_devices);
 350
 351                 eth_current_changed();
 352                 putc('\n');
 353         }
 354
 355         return num_devices;
 356 }
 357
 358 #ifdef CONFIG_MCAST_TFTP
 359 /* Multicast.
 360  * mcast_addr: multicast ipaddr from which multicast Mac is made
 361  * join: 1=join, 0=leave.
 362  */
 363 int eth_mcast_join(IPaddr_t mcast_ip, u8 join)
 364 {
 365         u8 mcast_mac[6];
 366         if (!eth_current || !eth_current->mcast)
 367                 return -1;
 368         mcast_mac[5] = htonl(mcast_ip) & 0xff;
 369         mcast_mac[4] = (htonl(mcast_ip)>>8) & 0xff;
 370         mcast_mac[3] = (htonl(mcast_ip)>>16) & 0x7f;
 371         mcast_mac[2] = 0x5e;
 372         mcast_mac[1] = 0x0;
 373         mcast_mac[0] = 0x1;
 374         return eth_current->mcast(eth_current, mcast_mac, join);
 375 }
 376
 377 /* the 'way' for ethernet-CRC-32. Spliced in from Linux lib/crc32.c
 378  * and this is the ethernet-crc method needed for TSEC -- and perhaps
 379  * some other adapter -- hash tables
 380  */
 381 #define CRCPOLY_LE 0xedb88320
 382 u32 ether_crc(size_t len, unsigned char const *p)
 383 {
 384         int i;
 385         u32 crc;
 386         crc = ~0;
 387         while (len--) {
 388                 crc ^= *p++;
 389                 for (i = 0; i < 8; i++)
 390                         crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
 391         }
 392         /* an reverse the bits, cuz of way they arrive -- last-first */
 393         crc = (crc >> 16) | (crc << 16);
 394         crc = (crc >> 8 & 0x00ff00ff) | (crc << 8 & 0xff00ff00);
 395         crc = (crc >> 4 & 0x0f0f0f0f) | (crc << 4 & 0xf0f0f0f0);
 396         crc = (crc >> 2 & 0x33333333) | (crc << 2 & 0xcccccccc);
 397         crc = (crc >> 1 & 0x55555555) | (crc << 1 & 0xaaaaaaaa);
 398         return crc;
 399 }
 400
 401 #endif
 402
 403
 404 int eth_init(bd_t *bis)
 405 {
 406         struct eth_device *old_current, *dev;
 407
 408         if (!eth_current) {
 409                 puts("No ethernet found.\n");
 410                 return -1;
 411         }
 412
 413         /* Sync environment with network devices */
 414         dev = eth_devices;
 415         do {
 416                 uchar env_enetaddr[6];
 417
 418                 if (eth_getenv_enetaddr_by_index("eth", dev->index,
 419                                                  env_enetaddr))
 420                         memcpy(dev->enetaddr, env_enetaddr, 6);
 421
 422                 dev = dev->next;
 423         } while (dev != eth_devices);
 424
 425         old_current = eth_current;
 426         do {
 427                 debug("Trying %s\n", eth_current->name);
 428
 429                 if (eth_current->init(eth_current, bis) >= 0) {
 430                         eth_current->state = ETH_STATE_ACTIVE;
 431
 432                         return 0;
 433                 }
 434                 debug("FAIL\n");
 435
 436                 eth_try_another(0);
 437         } while (old_current != eth_current);
 438
 439         return -1;
 440 }
 441
 442 void eth_halt(void)
 443 {
 444         if (!eth_current)
 445                 return;
 446
 447         eth_current->halt(eth_current);
 448
 449         eth_current->state = ETH_STATE_PASSIVE;
 450 }
 451
 452 int eth_send(void *packet, int length)
 453 {
 454         if (!eth_current)
 455                 return -1;
 456
 457         return eth_current->send(eth_current, packet, length);
 458 }
 459
 460 int eth_rx(void)
 461 {
 462         if (!eth_current)
 463                 return -1;
 464
 465         return eth_current->recv(eth_current);
 466 }
 467
 468 #ifdef CONFIG_API
 469 static void eth_save_packet(void *packet, int length)
 470 {
 471         char *p = packet;
 472         int i;
 473
 474         if ((eth_rcv_last+1) % PKTBUFSRX == eth_rcv_current)
 475                 return;
 476
 477         if (PKTSIZE < length)
 478                 return;
 479
 480         for (i = 0; i < length; i++)
 481                 eth_rcv_bufs[eth_rcv_last].data[i] = p[i];
 482
 483         eth_rcv_bufs[eth_rcv_last].length = length;
 484         eth_rcv_last = (eth_rcv_last + 1) % PKTBUFSRX;
 485 }
 486
 487 int eth_receive(void *packet, int length)
 488 {
 489         char *p = packet;
 490         void *pp = push_packet;
 491         int i;
 492
 493         if (eth_rcv_current == eth_rcv_last) {
 494                 push_packet = eth_save_packet;
 495                 eth_rx();
 496                 push_packet = pp;
 497
 498                 if (eth_rcv_current == eth_rcv_last)
 499                         return -1;
 500         }
 501
 502         length = min(eth_rcv_bufs[eth_rcv_current].length, length);
 503
 504         for (i = 0; i < length; i++)
 505                 p[i] = eth_rcv_bufs[eth_rcv_current].data[i];
 506
 507         eth_rcv_current = (eth_rcv_current + 1) % PKTBUFSRX;
 508         return length;
 509 }
 510 #endif /* CONFIG_API */
 511
 512 void eth_try_another(int first_restart)
 513 {
 514         static struct eth_device *first_failed;
 515         char *ethrotate;
 516
 517         /*
 518          * Do not rotate between network interfaces when
 519          * 'ethrotate' variable is set to 'no'.
 520          */
 521         ethrotate = getenv("ethrotate");
 522         if ((ethrotate != NULL) && (strcmp(ethrotate, "no") == 0))
 523                 return;
 524
 525         if (!eth_current)
 526                 return;
 527
 528         if (first_restart)
 529                 first_failed = eth_current;
 530
 531         eth_current = eth_current->next;
 532
 533         eth_current_changed();
 534
 535         if (first_failed == eth_current)
 536                 NetRestartWrap = 1;
 537 }
 538
 539 void eth_set_current(void)
 540 {
 541         static char *act;
 542         static int  env_changed_id;
 543         struct eth_device *old_current;
 544         int     env_id;
 545
 546         if (!eth_current)       /* XXX no current */
 547                 return;
 548
 549         env_id = get_env_id();
 550         if ((act == NULL) || (env_changed_id != env_id)) {
 551                 act = getenv("ethact");
 552                 env_changed_id = env_id;
 553         }
 554         if (act != NULL) {
 555                 old_current = eth_current;
 556                 do {
 557                         if (strcmp(eth_current->name, act) == 0)
 558                                 return;
 559                         eth_current = eth_current->next;
 560                 } while (old_current != eth_current);
 561         }
 562
 563         eth_current_changed();
 564 }
 565
 566 char *eth_get_name(void)
 567 {
 568         return eth_current ? eth_current->name : "unknown";
 569 }