2 * (C) Copyright 2001-2015
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 * Joe Hershberger, National Instruments
6 * SPDX-License-Identifier: GPL-2.0+
12 #include <environment.h>
16 #include <asm/errno.h>
17 #include <dm/device-internal.h>
18 #include <dm/uclass-internal.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 void eth_parse_enetaddr(const char *addr, uchar *enetaddr)
27 for (i = 0; i < 6; ++i) {
28 enetaddr[i] = addr ? simple_strtoul(addr, &end, 16) : 0;
30 addr = (*end) ? end + 1 : end;
34 int eth_getenv_enetaddr(const char *name, uchar *enetaddr)
36 eth_parse_enetaddr(getenv(name), enetaddr);
37 return is_valid_ethaddr(enetaddr);
40 int eth_setenv_enetaddr(const char *name, const uchar *enetaddr)
44 sprintf(buf, "%pM", enetaddr);
46 return setenv(name, buf);
49 int eth_getenv_enetaddr_by_index(const char *base_name, int index,
53 sprintf(enetvar, index ? "%s%daddr" : "%saddr", base_name, index);
54 return eth_getenv_enetaddr(enetvar, enetaddr);
57 static inline int eth_setenv_enetaddr_by_index(const char *base_name, int index,
61 sprintf(enetvar, index ? "%s%daddr" : "%saddr", base_name, index);
62 return eth_setenv_enetaddr(enetvar, enetaddr);
65 static int eth_mac_skip(int index)
70 sprintf(enetvar, index ? "eth%dmacskip" : "ethmacskip", index);
71 skip_state = getenv(enetvar);
72 return skip_state != NULL;
75 static void eth_current_changed(void);
78 * CPU and board-specific Ethernet initializations. Aliased function
79 * signals caller to move on
81 static int __def_eth_init(bd_t *bis)
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")));
88 static void eth_common_init(void)
90 bootstage_mark(BOOTSTAGE_ID_NET_ETH_START);
91 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
100 * If board-specific initialization exists, call it.
101 * If not, call a CPU-specific one
103 if (board_eth_init != __def_eth_init) {
104 if (board_eth_init(gd->bd) < 0)
105 printf("Board Net Initialization Failed\n");
106 } else if (cpu_eth_init != __def_eth_init) {
107 if (cpu_eth_init(gd->bd) < 0)
108 printf("CPU Net Initialization Failed\n");
110 #ifndef CONFIG_DM_ETH
111 printf("Net Initialization Skipped\n");
118 * struct eth_device_priv - private structure for each Ethernet device
120 * @state: The state of the Ethernet MAC driver (defined by enum eth_state_t)
122 struct eth_device_priv {
123 enum eth_state_t state;
127 * struct eth_uclass_priv - The structure attached to the uclass itself
129 * @current: The Ethernet device that the network functions are using
131 struct eth_uclass_priv {
132 struct udevice *current;
135 /* eth_errno - This stores the most recent failure code from DM functions */
136 static int eth_errno;
138 static struct eth_uclass_priv *eth_get_uclass_priv(void)
142 uclass_get(UCLASS_ETH, &uc);
147 static void eth_set_current_to_next(void)
149 struct eth_uclass_priv *uc_priv;
151 uc_priv = eth_get_uclass_priv();
152 if (uc_priv->current)
153 uclass_next_device(&uc_priv->current);
154 if (!uc_priv->current)
155 uclass_first_device(UCLASS_ETH, &uc_priv->current);
159 * Typically this will simply return the active device.
160 * In the case where the most recent active device was unset, this will attempt
161 * to return the first device. If that device doesn't exist or fails to probe,
162 * this function will return NULL.
164 struct udevice *eth_get_dev(void)
166 struct eth_uclass_priv *uc_priv;
168 uc_priv = eth_get_uclass_priv();
169 if (!uc_priv->current)
170 eth_errno = uclass_first_device(UCLASS_ETH,
172 return uc_priv->current;
176 * Typically this will just store a device pointer.
177 * In case it was not probed, we will attempt to do so.
178 * dev may be NULL to unset the active device.
180 static void eth_set_dev(struct udevice *dev)
182 if (dev && !device_active(dev)) {
183 eth_errno = device_probe(dev);
188 eth_get_uclass_priv()->current = dev;
192 * Find the udevice that either has the name passed in as devname or has an
193 * alias named devname.
195 struct udevice *eth_get_dev_by_name(const char *devname)
199 const char *startp = NULL;
202 int len = strlen("eth");
204 /* Must be longer than 3 to be an alias */
205 if (!strncmp(devname, "eth", len) && strlen(devname) > len) {
206 startp = devname + len;
207 seq = simple_strtoul(startp, &endp, 10);
210 uclass_get(UCLASS_ETH, &uc);
211 uclass_foreach_dev(it, uc) {
213 * We need the seq to be valid, so try to probe it.
214 * If the probe fails, the seq will not match since it will be
215 * -1 instead of what we are looking for.
216 * We don't care about errors from probe here. Either they won't
217 * match an alias or it will match a literal name and we'll pick
218 * up the error when we try to probe again in eth_set_dev().
220 if (device_probe(it))
222 /* Check for the name or the sequence number to match */
223 if (strcmp(it->name, devname) == 0 ||
224 (endp > startp && it->seq == seq))
231 unsigned char *eth_get_ethaddr(void)
233 struct eth_pdata *pdata;
236 pdata = eth_get_dev()->platdata;
237 return pdata->enetaddr;
243 /* Set active state without calling start on the driver */
244 int eth_init_state_only(void)
246 struct udevice *current;
247 struct eth_device_priv *priv;
249 current = eth_get_dev();
250 if (!current || !device_active(current))
253 priv = current->uclass_priv;
254 priv->state = ETH_STATE_ACTIVE;
259 /* Set passive state without calling stop on the driver */
260 void eth_halt_state_only(void)
262 struct udevice *current;
263 struct eth_device_priv *priv;
265 current = eth_get_dev();
266 if (!current || !device_active(current))
269 priv = current->uclass_priv;
270 priv->state = ETH_STATE_PASSIVE;
273 int eth_get_dev_index(void)
276 return eth_get_dev()->seq;
280 static int eth_write_hwaddr(struct udevice *dev)
282 struct eth_pdata *pdata = dev->platdata;
285 if (!dev || !device_active(dev))
288 /* seq is valid since the device is active */
289 if (eth_get_ops(dev)->write_hwaddr && !eth_mac_skip(dev->seq)) {
290 if (!is_valid_ethaddr(pdata->enetaddr)) {
291 printf("\nError: %s address %pM illegal value\n",
292 dev->name, pdata->enetaddr);
297 * Drivers are allowed to decide not to implement this at
298 * run-time. E.g. Some devices may use it and some may not.
300 ret = eth_get_ops(dev)->write_hwaddr(dev);
304 printf("\nWarning: %s failed to set MAC address\n",
311 static int on_ethaddr(const char *name, const char *value, enum env_op op,
318 /* look for an index after "eth" */
319 index = simple_strtoul(name + 3, NULL, 10);
321 retval = uclass_find_device_by_seq(UCLASS_ETH, index, false, &dev);
323 struct eth_pdata *pdata = dev->platdata;
326 case env_op_overwrite:
327 eth_parse_enetaddr(value, pdata->enetaddr);
330 memset(pdata->enetaddr, 0, 6);
336 U_BOOT_ENV_CALLBACK(ethaddr, on_ethaddr);
340 char *ethact = getenv("ethact");
341 char *ethrotate = getenv("ethrotate");
342 struct udevice *current = NULL;
343 struct udevice *old_current;
347 * When 'ethrotate' variable is set to 'no' and 'ethact' variable
348 * is already set to an ethernet device, we should stick to 'ethact'.
350 if ((ethrotate != NULL) && (strcmp(ethrotate, "no") == 0)) {
352 current = eth_get_dev_by_name(ethact);
359 current = eth_get_dev();
361 printf("No ethernet found.\n");
366 old_current = current;
369 debug("Trying %s\n", current->name);
371 if (device_active(current)) {
372 ret = eth_get_ops(current)->start(current);
374 struct eth_device_priv *priv =
375 current->uclass_priv;
377 priv->state = ETH_STATE_ACTIVE;
386 debug("PROBE FAIL\n");
390 * If ethrotate is enabled, this will change "current",
391 * otherwise we will drop out of this while loop immediately
394 /* This will ensure the new "current" attempted to probe */
395 current = eth_get_dev();
396 } while (old_current != current);
403 struct udevice *current;
404 struct eth_device_priv *priv;
406 current = eth_get_dev();
407 if (!current || !device_active(current))
410 eth_get_ops(current)->stop(current);
411 priv = current->uclass_priv;
412 priv->state = ETH_STATE_PASSIVE;
415 int eth_is_active(struct udevice *dev)
417 struct eth_device_priv *priv;
419 if (!dev || !device_active(dev))
422 priv = dev_get_uclass_priv(dev);
423 return priv->state == ETH_STATE_ACTIVE;
426 int eth_send(void *packet, int length)
428 struct udevice *current;
431 current = eth_get_dev();
435 if (!device_active(current))
438 ret = eth_get_ops(current)->send(current, packet, length);
440 /* We cannot completely return the error at present */
441 debug("%s: send() returned error %d\n", __func__, ret);
448 struct udevice *current;
454 current = eth_get_dev();
458 if (!device_active(current))
461 /* Process up to 32 packets at one time */
462 flags = ETH_RECV_CHECK_DEVICE;
463 for (i = 0; i < 32; i++) {
464 ret = eth_get_ops(current)->recv(current, flags, &packet);
467 net_process_received_packet(packet, ret);
468 if (ret >= 0 && eth_get_ops(current)->free_pkt)
469 eth_get_ops(current)->free_pkt(current, packet, ret);
476 /* We cannot completely return the error at present */
477 debug("%s: recv() returned error %d\n", __func__, ret);
482 int eth_initialize(void)
490 * Devices need to write the hwaddr even if not started so that Linux
491 * will have access to the hwaddr that u-boot stored for the device.
492 * This is accomplished by attempting to probe each device and calling
493 * their write_hwaddr() operation.
495 uclass_first_device(UCLASS_ETH, &dev);
497 printf("No ethernet found.\n");
498 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
500 char *ethprime = getenv("ethprime");
501 struct udevice *prime_dev = NULL;
504 prime_dev = eth_get_dev_by_name(ethprime);
506 eth_set_dev(prime_dev);
507 eth_current_changed();
512 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
517 printf("eth%d: %s", dev->seq, dev->name);
519 if (ethprime && dev == prime_dev)
522 eth_write_hwaddr(dev);
524 uclass_next_device(&dev);
534 static int eth_post_bind(struct udevice *dev)
536 if (strchr(dev->name, ' ')) {
537 printf("\nError: eth device name \"%s\" has a space!\n",
545 static int eth_pre_unbind(struct udevice *dev)
547 /* Don't hang onto a pointer that is going away */
548 if (dev == eth_get_uclass_priv()->current)
554 static int eth_post_probe(struct udevice *dev)
556 struct eth_device_priv *priv = dev->uclass_priv;
557 struct eth_pdata *pdata = dev->platdata;
558 unsigned char env_enetaddr[6];
560 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
561 struct eth_ops *ops = eth_get_ops(dev);
562 static int reloc_done;
566 ops->start += gd->reloc_off;
568 ops->send += gd->reloc_off;
570 ops->recv += gd->reloc_off;
572 ops->free_pkt += gd->reloc_off;
574 ops->stop += gd->reloc_off;
575 #ifdef CONFIG_MCAST_TFTP
577 ops->mcast += gd->reloc_off;
579 if (ops->write_hwaddr)
580 ops->write_hwaddr += gd->reloc_off;
581 if (ops->read_rom_hwaddr)
582 ops->read_rom_hwaddr += gd->reloc_off;
588 priv->state = ETH_STATE_INIT;
590 /* Check if the device has a MAC address in ROM */
591 if (eth_get_ops(dev)->read_rom_hwaddr)
592 eth_get_ops(dev)->read_rom_hwaddr(dev);
594 eth_getenv_enetaddr_by_index("eth", dev->seq, env_enetaddr);
595 if (!is_zero_ethaddr(env_enetaddr)) {
596 if (!is_zero_ethaddr(pdata->enetaddr) &&
597 memcmp(pdata->enetaddr, env_enetaddr, 6)) {
598 printf("\nWarning: %s MAC addresses don't match:\n",
600 printf("Address in SROM is %pM\n",
602 printf("Address in environment is %pM\n",
606 /* Override the ROM MAC address */
607 memcpy(pdata->enetaddr, env_enetaddr, 6);
608 } else if (is_valid_ethaddr(pdata->enetaddr)) {
609 eth_setenv_enetaddr_by_index("eth", dev->seq, pdata->enetaddr);
610 printf("\nWarning: %s using MAC address from ROM\n",
612 } else if (is_zero_ethaddr(pdata->enetaddr)) {
613 #ifdef CONFIG_NET_RANDOM_ETHADDR
614 net_random_ethaddr(pdata->enetaddr);
615 printf("\nWarning: %s (eth%d) using random MAC address - %pM\n",
616 dev->name, dev->seq, pdata->enetaddr);
618 printf("\nError: %s address not set.\n",
627 static int eth_pre_remove(struct udevice *dev)
629 struct eth_pdata *pdata = dev->platdata;
631 eth_get_ops(dev)->stop(dev);
633 /* clear the MAC address */
634 memset(pdata->enetaddr, 0, 6);
639 UCLASS_DRIVER(eth) = {
642 .post_bind = eth_post_bind,
643 .pre_unbind = eth_pre_unbind,
644 .post_probe = eth_post_probe,
645 .pre_remove = eth_pre_remove,
646 .priv_auto_alloc_size = sizeof(struct eth_uclass_priv),
647 .per_device_auto_alloc_size = sizeof(struct eth_device_priv),
648 .flags = DM_UC_FLAG_SEQ_ALIAS,
650 #endif /* #ifdef CONFIG_DM_ETH */
652 #ifndef CONFIG_DM_ETH
658 } eth_rcv_bufs[PKTBUFSRX];
660 static unsigned int eth_rcv_current, eth_rcv_last;
663 static struct eth_device *eth_devices;
664 struct eth_device *eth_current;
666 static void eth_set_current_to_next(void)
668 eth_current = eth_current->next;
671 static void eth_set_dev(struct eth_device *dev)
676 struct eth_device *eth_get_dev_by_name(const char *devname)
678 struct eth_device *dev, *target_dev;
680 BUG_ON(devname == NULL);
688 if (strcmp(devname, dev->name) == 0) {
693 } while (dev != eth_devices);
698 struct eth_device *eth_get_dev_by_index(int index)
700 struct eth_device *dev, *target_dev;
708 if (dev->index == index) {
713 } while (dev != eth_devices);
718 int eth_get_dev_index(void)
723 return eth_current->index;
726 static int on_ethaddr(const char *name, const char *value, enum env_op op,
730 struct eth_device *dev;
735 /* look for an index after "eth" */
736 index = simple_strtoul(name + 3, NULL, 10);
740 if (dev->index == index) {
743 case env_op_overwrite:
744 eth_parse_enetaddr(value, dev->enetaddr);
747 memset(dev->enetaddr, 0, 6);
751 } while (dev != eth_devices);
755 U_BOOT_ENV_CALLBACK(ethaddr, on_ethaddr);
757 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
760 unsigned char env_enetaddr[6];
763 eth_getenv_enetaddr_by_index(base_name, eth_number, env_enetaddr);
765 if (!is_zero_ethaddr(env_enetaddr)) {
766 if (!is_zero_ethaddr(dev->enetaddr) &&
767 memcmp(dev->enetaddr, env_enetaddr, 6)) {
768 printf("\nWarning: %s MAC addresses don't match:\n",
770 printf("Address in SROM is %pM\n",
772 printf("Address in environment is %pM\n",
776 memcpy(dev->enetaddr, env_enetaddr, 6);
777 } else if (is_valid_ethaddr(dev->enetaddr)) {
778 eth_setenv_enetaddr_by_index(base_name, eth_number,
780 } else if (is_zero_ethaddr(dev->enetaddr)) {
781 #ifdef CONFIG_NET_RANDOM_ETHADDR
782 net_random_ethaddr(dev->enetaddr);
783 printf("\nWarning: %s (eth%d) using random MAC address - %pM\n",
784 dev->name, eth_number, dev->enetaddr);
786 printf("\nError: %s address not set.\n",
792 if (dev->write_hwaddr && !eth_mac_skip(eth_number)) {
793 if (!is_valid_ethaddr(dev->enetaddr)) {
794 printf("\nError: %s address %pM illegal value\n",
795 dev->name, dev->enetaddr);
799 ret = dev->write_hwaddr(dev);
801 printf("\nWarning: %s failed to set MAC address\n",
808 int eth_register(struct eth_device *dev)
810 struct eth_device *d;
813 assert(strlen(dev->name) < sizeof(dev->name));
818 eth_current_changed();
820 for (d = eth_devices; d->next != eth_devices; d = d->next)
825 dev->state = ETH_STATE_INIT;
826 dev->next = eth_devices;
827 dev->index = index++;
832 int eth_unregister(struct eth_device *dev)
834 struct eth_device *cur;
840 for (cur = eth_devices; cur->next != eth_devices && cur->next != dev;
844 /* Device not found */
845 if (cur->next != dev)
848 cur->next = dev->next;
850 if (eth_devices == dev)
851 eth_devices = dev->next == eth_devices ? NULL : dev->next;
853 if (eth_current == dev) {
854 eth_current = eth_devices;
855 eth_current_changed();
861 int eth_initialize(void)
870 puts("No ethernet found.\n");
871 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
873 struct eth_device *dev = eth_devices;
874 char *ethprime = getenv("ethprime");
876 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
881 printf("%s", dev->name);
883 if (ethprime && strcmp(dev->name, ethprime) == 0) {
888 if (strchr(dev->name, ' '))
889 puts("\nWarning: eth device name has a space!"
892 eth_write_hwaddr(dev, "eth", dev->index);
896 } while (dev != eth_devices);
898 eth_current_changed();
905 #ifdef CONFIG_MCAST_TFTP
907 * mcast_addr: multicast ipaddr from which multicast Mac is made
908 * join: 1=join, 0=leave.
910 int eth_mcast_join(struct in_addr mcast_ip, int join)
913 if (!eth_current || !eth_current->mcast)
915 mcast_mac[5] = htonl(mcast_ip.s_addr) & 0xff;
916 mcast_mac[4] = (htonl(mcast_ip.s_addr)>>8) & 0xff;
917 mcast_mac[3] = (htonl(mcast_ip.s_addr)>>16) & 0x7f;
921 return eth_current->mcast(eth_current, mcast_mac, join);
924 /* the 'way' for ethernet-CRC-32. Spliced in from Linux lib/crc32.c
925 * and this is the ethernet-crc method needed for TSEC -- and perhaps
926 * some other adapter -- hash tables
928 #define CRCPOLY_LE 0xedb88320
929 u32 ether_crc(size_t len, unsigned char const *p)
936 for (i = 0; i < 8; i++)
937 crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
939 /* an reverse the bits, cuz of way they arrive -- last-first */
940 crc = (crc >> 16) | (crc << 16);
941 crc = (crc >> 8 & 0x00ff00ff) | (crc << 8 & 0xff00ff00);
942 crc = (crc >> 4 & 0x0f0f0f0f) | (crc << 4 & 0xf0f0f0f0);
943 crc = (crc >> 2 & 0x33333333) | (crc << 2 & 0xcccccccc);
944 crc = (crc >> 1 & 0x55555555) | (crc << 1 & 0xaaaaaaaa);
953 struct eth_device *old_current;
956 puts("No ethernet found.\n");
960 old_current = eth_current;
962 debug("Trying %s\n", eth_current->name);
964 if (eth_current->init(eth_current, gd->bd) >= 0) {
965 eth_current->state = ETH_STATE_ACTIVE;
972 } while (old_current != eth_current);
982 eth_current->halt(eth_current);
984 eth_current->state = ETH_STATE_PASSIVE;
987 int eth_is_active(struct eth_device *dev)
989 return dev && dev->state == ETH_STATE_ACTIVE;
992 int eth_send(void *packet, int length)
997 return eth_current->send(eth_current, packet, length);
1005 return eth_current->recv(eth_current);
1007 #endif /* ifndef CONFIG_DM_ETH */
1010 static void eth_save_packet(void *packet, int length)
1015 if ((eth_rcv_last+1) % PKTBUFSRX == eth_rcv_current)
1018 if (PKTSIZE < length)
1021 for (i = 0; i < length; i++)
1022 eth_rcv_bufs[eth_rcv_last].data[i] = p[i];
1024 eth_rcv_bufs[eth_rcv_last].length = length;
1025 eth_rcv_last = (eth_rcv_last + 1) % PKTBUFSRX;
1028 int eth_receive(void *packet, int length)
1031 void *pp = push_packet;
1034 if (eth_rcv_current == eth_rcv_last) {
1035 push_packet = eth_save_packet;
1039 if (eth_rcv_current == eth_rcv_last)
1043 length = min(eth_rcv_bufs[eth_rcv_current].length, length);
1045 for (i = 0; i < length; i++)
1046 p[i] = eth_rcv_bufs[eth_rcv_current].data[i];
1048 eth_rcv_current = (eth_rcv_current + 1) % PKTBUFSRX;
1051 #endif /* CONFIG_API */
1053 static void eth_current_changed(void)
1055 char *act = getenv("ethact");
1059 * The call to eth_get_dev() below has a side effect of rotating
1060 * ethernet device if uc_priv->current == NULL. This is not what
1061 * we want when 'ethrotate' variable is 'no'.
1063 ethrotate = getenv("ethrotate");
1064 if ((ethrotate != NULL) && (strcmp(ethrotate, "no") == 0))
1067 /* update current ethernet name */
1068 if (eth_get_dev()) {
1069 if (act == NULL || strcmp(act, eth_get_name()) != 0)
1070 setenv("ethact", eth_get_name());
1073 * remove the variable completely if there is no active
1076 else if (act != NULL)
1077 setenv("ethact", NULL);
1080 void eth_try_another(int first_restart)
1082 static void *first_failed;
1086 * Do not rotate between network interfaces when
1087 * 'ethrotate' variable is set to 'no'.
1089 ethrotate = getenv("ethrotate");
1090 if ((ethrotate != NULL) && (strcmp(ethrotate, "no") == 0))
1097 first_failed = eth_get_dev();
1099 eth_set_current_to_next();
1101 eth_current_changed();
1103 if (first_failed == eth_get_dev())
1104 net_restart_wrap = 1;
1107 void eth_set_current(void)
1110 static int env_changed_id;
1113 env_id = get_env_id();
1114 if ((act == NULL) || (env_changed_id != env_id)) {
1115 act = getenv("ethact");
1116 env_changed_id = env_id;
1120 char *ethprime = getenv("ethprime");
1124 dev = eth_get_dev_by_name(ethprime);
1130 eth_set_dev(eth_get_dev_by_name(act));
1133 eth_current_changed();
1136 const char *eth_get_name(void)
1138 return eth_get_dev() ? eth_get_dev()->name : "unknown";