net/eth-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2001-2015
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  * Joe Hershberger, National Instruments
   6  */
   7
   8 #include <common.h>
   9 #include <dm.h>
  10 #include <env.h>
  11 #include <net.h>
  12 #include <dm/device-internal.h>
  13 #include <dm/uclass-internal.h>
  14 #include <net/pcap.h>
  15 #include "eth_internal.h"
  16
  17 DECLARE_GLOBAL_DATA_PTR;
  18
  19 /**
  20  * struct eth_device_priv - private structure for each Ethernet device
  21  *
  22  * @state: The state of the Ethernet MAC driver (defined by enum eth_state_t)
  23  */
  24 struct eth_device_priv {
  25         enum eth_state_t state;
  26 };
  27
  28 /**
  29  * struct eth_uclass_priv - The structure attached to the uclass itself
  30  *
  31  * @current: The Ethernet device that the network functions are using
  32  */
  33 struct eth_uclass_priv {
  34         struct udevice *current;
  35 };
  36
  37 /* eth_errno - This stores the most recent failure code from DM functions */
  38 static int eth_errno;
  39
  40 static struct eth_uclass_priv *eth_get_uclass_priv(void)
  41 {
  42         struct uclass *uc;
  43
  44         uclass_get(UCLASS_ETH, &uc);
  45         assert(uc);
  46         return uc->priv;
  47 }
  48
  49 void eth_set_current_to_next(void)
  50 {
  51         struct eth_uclass_priv *uc_priv;
  52
  53         uc_priv = eth_get_uclass_priv();
  54         if (uc_priv->current)
  55                 uclass_next_device(&uc_priv->current);
  56         if (!uc_priv->current)
  57                 uclass_first_device(UCLASS_ETH, &uc_priv->current);
  58 }
  59
  60 /*
  61  * Typically this will simply return the active device.
  62  * In the case where the most recent active device was unset, this will attempt
  63  * to return the first device. If that device doesn't exist or fails to probe,
  64  * this function will return NULL.
  65  */
  66 struct udevice *eth_get_dev(void)
  67 {
  68         struct eth_uclass_priv *uc_priv;
  69
  70         uc_priv = eth_get_uclass_priv();
  71         if (!uc_priv->current)
  72                 eth_errno = uclass_first_device(UCLASS_ETH,
  73                                     &uc_priv->current);
  74         return uc_priv->current;
  75 }
  76
  77 /*
  78  * Typically this will just store a device pointer.
  79  * In case it was not probed, we will attempt to do so.
  80  * dev may be NULL to unset the active device.
  81  */
  82 void eth_set_dev(struct udevice *dev)
  83 {
  84         if (dev && !device_active(dev)) {
  85                 eth_errno = device_probe(dev);
  86                 if (eth_errno)
  87                         dev = NULL;
  88         }
  89
  90         eth_get_uclass_priv()->current = dev;
  91 }
  92
  93 /*
  94  * Find the udevice that either has the name passed in as devname or has an
  95  * alias named devname.
  96  */
  97 struct udevice *eth_get_dev_by_name(const char *devname)
  98 {
  99         int seq = -1;
 100         char *endp = NULL;
 101         const char *startp = NULL;
 102         struct udevice *it;
 103         struct uclass *uc;
 104         int len = strlen("eth");
 105
 106         /* Must be longer than 3 to be an alias */
 107         if (!strncmp(devname, "eth", len) && strlen(devname) > len) {
 108                 startp = devname + len;
 109                 seq = simple_strtoul(startp, &endp, 10);
 110         }
 111
 112         uclass_get(UCLASS_ETH, &uc);
 113         uclass_foreach_dev(it, uc) {
 114                 /*
 115                  * We need the seq to be valid, so try to probe it.
 116                  * If the probe fails, the seq will not match since it will be
 117                  * -1 instead of what we are looking for.
 118                  * We don't care about errors from probe here. Either they won't
 119                  * match an alias or it will match a literal name and we'll pick
 120                  * up the error when we try to probe again in eth_set_dev().
 121                  */
 122                 if (device_probe(it))
 123                         continue;
 124                 /* Check for the name or the sequence number to match */
 125                 if (strcmp(it->name, devname) == 0 ||
 126                     (endp > startp && it->seq == seq))
 127                         return it;
 128         }
 129
 130         return NULL;
 131 }
 132
 133 unsigned char *eth_get_ethaddr(void)
 134 {
 135         struct eth_pdata *pdata;
 136
 137         if (eth_get_dev()) {
 138                 pdata = eth_get_dev()->platdata;
 139                 return pdata->enetaddr;
 140         }
 141
 142         return NULL;
 143 }
 144
 145 /* Set active state without calling start on the driver */
 146 int eth_init_state_only(void)
 147 {
 148         struct udevice *current;
 149         struct eth_device_priv *priv;
 150
 151         current = eth_get_dev();
 152         if (!current || !device_active(current))
 153                 return -EINVAL;
 154
 155         priv = current->uclass_priv;
 156         priv->state = ETH_STATE_ACTIVE;
 157
 158         return 0;
 159 }
 160
 161 /* Set passive state without calling stop on the driver */
 162 void eth_halt_state_only(void)
 163 {
 164         struct udevice *current;
 165         struct eth_device_priv *priv;
 166
 167         current = eth_get_dev();
 168         if (!current || !device_active(current))
 169                 return;
 170
 171         priv = current->uclass_priv;
 172         priv->state = ETH_STATE_PASSIVE;
 173 }
 174
 175 int eth_get_dev_index(void)
 176 {
 177         if (eth_get_dev())
 178                 return eth_get_dev()->seq;
 179         return -1;
 180 }
 181
 182 static int eth_write_hwaddr(struct udevice *dev)
 183 {
 184         struct eth_pdata *pdata;
 185         int ret = 0;
 186
 187         if (!dev || !device_active(dev))
 188                 return -EINVAL;
 189
 190         /* seq is valid since the device is active */
 191         if (eth_get_ops(dev)->write_hwaddr && !eth_mac_skip(dev->seq)) {
 192                 pdata = dev->platdata;
 193                 if (!is_valid_ethaddr(pdata->enetaddr)) {
 194                         printf("\nError: %s address %pM illegal value\n",
 195                                dev->name, pdata->enetaddr);
 196                         return -EINVAL;
 197                 }
 198
 199                 /*
 200                  * Drivers are allowed to decide not to implement this at
 201                  * run-time. E.g. Some devices may use it and some may not.
 202                  */
 203                 ret = eth_get_ops(dev)->write_hwaddr(dev);
 204                 if (ret == -ENOSYS)
 205                         ret = 0;
 206                 if (ret)
 207                         printf("\nWarning: %s failed to set MAC address\n",
 208                                dev->name);
 209         }
 210
 211         return ret;
 212 }
 213
 214 static int on_ethaddr(const char *name, const char *value, enum env_op op,
 215         int flags)
 216 {
 217         int index;
 218         int retval;
 219         struct udevice *dev;
 220
 221         /* look for an index after "eth" */
 222         index = simple_strtoul(name + 3, NULL, 10);
 223
 224         retval = uclass_find_device_by_seq(UCLASS_ETH, index, false, &dev);
 225         if (!retval) {
 226                 struct eth_pdata *pdata = dev->platdata;
 227                 switch (op) {
 228                 case env_op_create:
 229                 case env_op_overwrite:
 230                         string_to_enetaddr(value, pdata->enetaddr);
 231                         eth_write_hwaddr(dev);
 232                         break;
 233                 case env_op_delete:
 234                         memset(pdata->enetaddr, 0, ARP_HLEN);
 235                 }
 236         }
 237
 238         return 0;
 239 }
 240 U_BOOT_ENV_CALLBACK(ethaddr, on_ethaddr);
 241
 242 int eth_init(void)
 243 {
 244         char *ethact = env_get("ethact");
 245         char *ethrotate = env_get("ethrotate");
 246         struct udevice *current = NULL;
 247         struct udevice *old_current;
 248         int ret = -ENODEV;
 249
 250         /*
 251          * When 'ethrotate' variable is set to 'no' and 'ethact' variable
 252          * is already set to an ethernet device, we should stick to 'ethact'.
 253          */
 254         if ((ethrotate != NULL) && (strcmp(ethrotate, "no") == 0)) {
 255                 if (ethact) {
 256                         current = eth_get_dev_by_name(ethact);
 257                         if (!current)
 258                                 return -EINVAL;
 259                 }
 260         }
 261
 262         if (!current) {
 263                 current = eth_get_dev();
 264                 if (!current) {
 265                         printf("No ethernet found.\n");
 266                         return -ENODEV;
 267                 }
 268         }
 269
 270         old_current = current;
 271         do {
 272                 if (current) {
 273                         debug("Trying %s\n", current->name);
 274
 275                         if (device_active(current)) {
 276                                 ret = eth_get_ops(current)->start(current);
 277                                 if (ret >= 0) {
 278                                         struct eth_device_priv *priv =
 279                                                 current->uclass_priv;
 280
 281                                         priv->state = ETH_STATE_ACTIVE;
 282                                         return 0;
 283                                 }
 284                         } else {
 285                                 ret = eth_errno;
 286                         }
 287
 288                         debug("FAIL\n");
 289                 } else {
 290                         debug("PROBE FAIL\n");
 291                 }
 292
 293                 /*
 294                  * If ethrotate is enabled, this will change "current",
 295                  * otherwise we will drop out of this while loop immediately
 296                  */
 297                 eth_try_another(0);
 298                 /* This will ensure the new "current" attempted to probe */
 299                 current = eth_get_dev();
 300         } while (old_current != current);
 301
 302         return ret;
 303 }
 304
 305 void eth_halt(void)
 306 {
 307         struct udevice *current;
 308         struct eth_device_priv *priv;
 309
 310         current = eth_get_dev();
 311         if (!current || !eth_is_active(current))
 312                 return;
 313
 314         eth_get_ops(current)->stop(current);
 315         priv = current->uclass_priv;
 316         if (priv)
 317                 priv->state = ETH_STATE_PASSIVE;
 318 }
 319
 320 int eth_is_active(struct udevice *dev)
 321 {
 322         struct eth_device_priv *priv;
 323
 324         if (!dev || !device_active(dev))
 325                 return 0;
 326
 327         priv = dev_get_uclass_priv(dev);
 328         return priv->state == ETH_STATE_ACTIVE;
 329 }
 330
 331 int eth_send(void *packet, int length)
 332 {
 333         struct udevice *current;
 334         int ret;
 335
 336         current = eth_get_dev();
 337         if (!current)
 338                 return -ENODEV;
 339
 340         if (!eth_is_active(current))
 341                 return -EINVAL;
 342
 343         ret = eth_get_ops(current)->send(current, packet, length);
 344         if (ret < 0) {
 345                 /* We cannot completely return the error at present */
 346                 debug("%s: send() returned error %d\n", __func__, ret);
 347         }
 348 #if defined(CONFIG_CMD_PCAP)
 349         if (ret >= 0)
 350                 pcap_post(packet, length, true);
 351 #endif
 352         return ret;
 353 }
 354
 355 int eth_rx(void)
 356 {
 357         struct udevice *current;
 358         uchar *packet;
 359         int flags;
 360         int ret;
 361         int i;
 362
 363         current = eth_get_dev();
 364         if (!current)
 365                 return -ENODEV;
 366
 367         if (!eth_is_active(current))
 368                 return -EINVAL;
 369
 370         /* Process up to 32 packets at one time */
 371         flags = ETH_RECV_CHECK_DEVICE;
 372         for (i = 0; i < 32; i++) {
 373                 ret = eth_get_ops(current)->recv(current, flags, &packet);
 374                 flags = 0;
 375                 if (ret > 0)
 376                         net_process_received_packet(packet, ret);
 377                 if (ret >= 0 && eth_get_ops(current)->free_pkt)
 378                         eth_get_ops(current)->free_pkt(current, packet, ret);
 379                 if (ret <= 0)
 380                         break;
 381         }
 382         if (ret == -EAGAIN)
 383                 ret = 0;
 384         if (ret < 0) {
 385                 /* We cannot completely return the error at present */
 386                 debug("%s: recv() returned error %d\n", __func__, ret);
 387         }
 388         return ret;
 389 }
 390
 391 int eth_initialize(void)
 392 {
 393         int num_devices = 0;
 394         struct udevice *dev;
 395
 396         eth_common_init();
 397
 398         /*
 399          * Devices need to write the hwaddr even if not started so that Linux
 400          * will have access to the hwaddr that u-boot stored for the device.
 401          * This is accomplished by attempting to probe each device and calling
 402          * their write_hwaddr() operation.
 403          */
 404         uclass_first_device_check(UCLASS_ETH, &dev);
 405         if (!dev) {
 406                 printf("No ethernet found.\n");
 407                 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
 408         } else {
 409                 char *ethprime = env_get("ethprime");
 410                 struct udevice *prime_dev = NULL;
 411
 412                 if (ethprime)
 413                         prime_dev = eth_get_dev_by_name(ethprime);
 414                 if (prime_dev) {
 415                         eth_set_dev(prime_dev);
 416                         eth_current_changed();
 417                 } else {
 418                         eth_set_dev(NULL);
 419                 }
 420
 421                 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
 422                 do {
 423                         if (dev->seq != -1) {
 424                                 if (num_devices)
 425                                         printf(", ");
 426
 427                                 printf("eth%d: %s", dev->seq, dev->name);
 428
 429                                 if (ethprime && dev == prime_dev)
 430                                         printf(" [PRIME]");
 431                         }
 432
 433                         eth_write_hwaddr(dev);
 434
 435                         if (dev->seq != -1)
 436                                 num_devices++;
 437                         uclass_next_device_check(&dev);
 438                 } while (dev);
 439
 440                 if (!num_devices)
 441                         printf("No ethernet found.\n");
 442                 putc('\n');
 443         }
 444
 445         return num_devices;
 446 }
 447
 448 static int eth_post_bind(struct udevice *dev)
 449 {
 450         if (strchr(dev->name, ' ')) {
 451                 printf("\nError: eth device name \"%s\" has a space!\n",
 452                        dev->name);
 453                 return -EINVAL;
 454         }
 455
 456         return 0;
 457 }
 458
 459 static int eth_pre_unbind(struct udevice *dev)
 460 {
 461         /* Don't hang onto a pointer that is going away */
 462         if (dev == eth_get_uclass_priv()->current)
 463                 eth_set_dev(NULL);
 464
 465         return 0;
 466 }
 467
 468 static bool eth_dev_get_mac_address(struct udevice *dev, u8 mac[ARP_HLEN])
 469 {
 470 #if IS_ENABLED(CONFIG_OF_CONTROL)
 471         const uint8_t *p;
 472
 473         p = dev_read_u8_array_ptr(dev, "mac-address", ARP_HLEN);
 474         if (!p)
 475                 p = dev_read_u8_array_ptr(dev, "local-mac-address", ARP_HLEN);
 476
 477         if (!p)
 478                 return false;
 479
 480         memcpy(mac, p, ARP_HLEN);
 481
 482         return true;
 483 #else
 484         return false;
 485 #endif
 486 }
 487
 488 static int eth_post_probe(struct udevice *dev)
 489 {
 490         struct eth_device_priv *priv = dev->uclass_priv;
 491         struct eth_pdata *pdata = dev->platdata;
 492         unsigned char env_enetaddr[ARP_HLEN];
 493
 494 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 495         struct eth_ops *ops = eth_get_ops(dev);
 496         static int reloc_done;
 497
 498         if (!reloc_done) {
 499                 if (ops->start)
 500                         ops->start += gd->reloc_off;
 501                 if (ops->send)
 502                         ops->send += gd->reloc_off;
 503                 if (ops->recv)
 504                         ops->recv += gd->reloc_off;
 505                 if (ops->free_pkt)
 506                         ops->free_pkt += gd->reloc_off;
 507                 if (ops->stop)
 508                         ops->stop += gd->reloc_off;
 509                 if (ops->mcast)
 510                         ops->mcast += gd->reloc_off;
 511                 if (ops->write_hwaddr)
 512                         ops->write_hwaddr += gd->reloc_off;
 513                 if (ops->read_rom_hwaddr)
 514                         ops->read_rom_hwaddr += gd->reloc_off;
 515
 516                 reloc_done++;
 517         }
 518 #endif
 519
 520         priv->state = ETH_STATE_INIT;
 521
 522         /* Check if the device has a valid MAC address in device tree */
 523         if (!eth_dev_get_mac_address(dev, pdata->enetaddr) ||
 524             !is_valid_ethaddr(pdata->enetaddr)) {
 525                 /* Check if the device has a MAC address in ROM */
 526                 if (eth_get_ops(dev)->read_rom_hwaddr)
 527                         eth_get_ops(dev)->read_rom_hwaddr(dev);
 528         }
 529
 530         eth_env_get_enetaddr_by_index("eth", dev->seq, env_enetaddr);
 531         if (!is_zero_ethaddr(env_enetaddr)) {
 532                 if (!is_zero_ethaddr(pdata->enetaddr) &&
 533                     memcmp(pdata->enetaddr, env_enetaddr, ARP_HLEN)) {
 534                         printf("\nWarning: %s MAC addresses don't match:\n",
 535                                dev->name);
 536                         printf("Address in ROM is          %pM\n",
 537                                pdata->enetaddr);
 538                         printf("Address in environment is  %pM\n",
 539                                env_enetaddr);
 540                 }
 541
 542                 /* Override the ROM MAC address */
 543                 memcpy(pdata->enetaddr, env_enetaddr, ARP_HLEN);
 544         } else if (is_valid_ethaddr(pdata->enetaddr)) {
 545                 eth_env_set_enetaddr_by_index("eth", dev->seq, pdata->enetaddr);
 546                 printf("\nWarning: %s using MAC address from ROM\n",
 547                        dev->name);
 548         } else if (is_zero_ethaddr(pdata->enetaddr) ||
 549                    !is_valid_ethaddr(pdata->enetaddr)) {
 550 #ifdef CONFIG_NET_RANDOM_ETHADDR
 551                 net_random_ethaddr(pdata->enetaddr);
 552                 printf("\nWarning: %s (eth%d) using random MAC address - %pM\n",
 553                        dev->name, dev->seq, pdata->enetaddr);
 554 #else
 555                 printf("\nError: %s address not set.\n",
 556                        dev->name);
 557                 return -EINVAL;
 558 #endif
 559         }
 560
 561         eth_write_hwaddr(dev);
 562
 563         return 0;
 564 }
 565
 566 static int eth_pre_remove(struct udevice *dev)
 567 {
 568         struct eth_pdata *pdata = dev->platdata;
 569
 570         eth_get_ops(dev)->stop(dev);
 571
 572         /* clear the MAC address */
 573         memset(pdata->enetaddr, 0, ARP_HLEN);
 574
 575         return 0;
 576 }
 577
 578 UCLASS_DRIVER(eth) = {
 579         .name           = "eth",
 580         .id             = UCLASS_ETH,
 581         .post_bind      = eth_post_bind,
 582         .pre_unbind     = eth_pre_unbind,
 583         .post_probe     = eth_post_probe,
 584         .pre_remove     = eth_pre_remove,
 585         .priv_auto_alloc_size = sizeof(struct eth_uclass_priv),
 586         .per_device_auto_alloc_size = sizeof(struct eth_device_priv),
 587         .flags          = DM_UC_FLAG_SEQ_ALIAS,
 588 };