net/eth.c

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