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