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(char *name, uchar *enetaddr)
36 eth_parse_enetaddr(getenv(name), enetaddr);
37 return is_valid_ethaddr(enetaddr);
40 int eth_setenv_enetaddr(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 printf("Net Initialization Skipped\n");
116 * struct eth_device_priv - private structure for each Ethernet device
118 * @state: The state of the Ethernet MAC driver (defined by enum eth_state_t)
120 struct eth_device_priv {
121 enum eth_state_t state;
125 * struct eth_uclass_priv - The structure attached to the uclass itself
127 * @current: The Ethernet device that the network functions are using
129 struct eth_uclass_priv {
130 struct udevice *current;
133 /* eth_errno - This stores the most recent failure code from DM functions */
134 static int eth_errno;
136 static struct eth_uclass_priv *eth_get_uclass_priv(void)
140 uclass_get(UCLASS_ETH, &uc);
145 static void eth_set_current_to_next(void)
147 struct eth_uclass_priv *uc_priv;
149 uc_priv = eth_get_uclass_priv();
150 if (uc_priv->current)
151 uclass_next_device(&uc_priv->current);
152 if (!uc_priv->current)
153 uclass_first_device(UCLASS_ETH, &uc_priv->current);
157 * Typically this will simply return the active device.
158 * In the case where the most recent active device was unset, this will attempt
159 * to return the first device. If that device doesn't exist or fails to probe,
160 * this function will return NULL.
162 struct udevice *eth_get_dev(void)
164 struct eth_uclass_priv *uc_priv;
166 uc_priv = eth_get_uclass_priv();
167 if (!uc_priv->current)
168 eth_errno = uclass_first_device(UCLASS_ETH,
170 return uc_priv->current;
174 * Typically this will just store a device pointer.
175 * In case it was not probed, we will attempt to do so.
176 * dev may be NULL to unset the active device.
178 static void eth_set_dev(struct udevice *dev)
180 if (dev && !device_active(dev))
181 eth_errno = device_probe(dev);
182 eth_get_uclass_priv()->current = dev;
186 * Find the udevice that either has the name passed in as devname or has an
187 * alias named devname.
189 struct udevice *eth_get_dev_by_name(const char *devname)
193 const char *startp = NULL;
197 /* Must be longer than 3 to be an alias */
198 if (strlen(devname) > strlen("eth")) {
199 startp = devname + strlen("eth");
200 seq = simple_strtoul(startp, &endp, 10);
203 uclass_get(UCLASS_ETH, &uc);
204 uclass_foreach_dev(it, uc) {
206 * We need the seq to be valid, so try to probe it.
207 * If the probe fails, the seq will not match since it will be
208 * -1 instead of what we are looking for.
209 * We don't care about errors from probe here. Either they won't
210 * match an alias or it will match a literal name and we'll pick
211 * up the error when we try to probe again in eth_set_dev().
215 * Check for the name or the sequence number to match
217 if (strcmp(it->name, devname) == 0 ||
218 (endp > startp && it->seq == seq))
225 unsigned char *eth_get_ethaddr(void)
227 struct eth_pdata *pdata;
230 pdata = eth_get_dev()->platdata;
231 return pdata->enetaddr;
237 /* Set active state without calling start on the driver */
238 int eth_init_state_only(void)
240 struct udevice *current;
241 struct eth_device_priv *priv;
243 current = eth_get_dev();
244 if (!current || !device_active(current))
247 priv = current->uclass_priv;
248 priv->state = ETH_STATE_ACTIVE;
253 /* Set passive state without calling stop on the driver */
254 void eth_halt_state_only(void)
256 struct udevice *current;
257 struct eth_device_priv *priv;
259 current = eth_get_dev();
260 if (!current || !device_active(current))
263 priv = current->uclass_priv;
264 priv->state = ETH_STATE_PASSIVE;
267 int eth_get_dev_index(void)
270 return eth_get_dev()->seq;
274 static int eth_write_hwaddr(struct udevice *dev)
276 struct eth_pdata *pdata = dev->platdata;
279 if (!dev || !device_active(dev))
282 /* seq is valid since the device is active */
283 if (eth_get_ops(dev)->write_hwaddr && !eth_mac_skip(dev->seq)) {
284 if (!is_valid_ethaddr(pdata->enetaddr)) {
285 printf("\nError: %s address %pM illegal value\n",
286 dev->name, pdata->enetaddr);
290 ret = eth_get_ops(dev)->write_hwaddr(dev);
292 printf("\nWarning: %s failed to set MAC address\n",
299 static int on_ethaddr(const char *name, const char *value, enum env_op op,
306 /* look for an index after "eth" */
307 index = simple_strtoul(name + 3, NULL, 10);
309 retval = uclass_find_device_by_seq(UCLASS_ETH, index, false, &dev);
311 struct eth_pdata *pdata = dev->platdata;
314 case env_op_overwrite:
315 eth_parse_enetaddr(value, pdata->enetaddr);
318 memset(pdata->enetaddr, 0, 6);
324 U_BOOT_ENV_CALLBACK(ethaddr, on_ethaddr);
328 struct udevice *current;
329 struct udevice *old_current;
332 current = eth_get_dev();
334 printf("No ethernet found.\n");
338 old_current = current;
340 debug("Trying %s\n", current->name);
342 if (device_active(current)) {
343 ret = eth_get_ops(current)->start(current);
345 struct eth_device_priv *priv =
346 current->uclass_priv;
348 priv->state = ETH_STATE_ACTIVE;
358 * If ethrotate is enabled, this will change "current",
359 * otherwise we will drop out of this while loop immediately
362 /* This will ensure the new "current" attempted to probe */
363 current = eth_get_dev();
364 } while (old_current != current);
371 struct udevice *current;
372 struct eth_device_priv *priv;
374 current = eth_get_dev();
375 if (!current || !device_active(current))
378 eth_get_ops(current)->stop(current);
379 priv = current->uclass_priv;
380 priv->state = ETH_STATE_PASSIVE;
383 int eth_send(void *packet, int length)
385 struct udevice *current;
388 current = eth_get_dev();
392 if (!device_active(current))
395 ret = eth_get_ops(current)->send(current, packet, length);
397 /* We cannot completely return the error at present */
398 debug("%s: send() returned error %d\n", __func__, ret);
405 struct udevice *current;
410 current = eth_get_dev();
414 if (!device_active(current))
417 /* Process up to 32 packets at one time */
418 for (i = 0; i < 32; i++) {
419 ret = eth_get_ops(current)->recv(current, &packet);
421 net_process_received_packet(packet, ret);
422 if (ret >= 0 && eth_get_ops(current)->free_pkt)
423 eth_get_ops(current)->free_pkt(current, packet, ret);
430 /* We cannot completely return the error at present */
431 debug("%s: recv() returned error %d\n", __func__, ret);
436 int eth_initialize(void)
444 * Devices need to write the hwaddr even if not started so that Linux
445 * will have access to the hwaddr that u-boot stored for the device.
446 * This is accomplished by attempting to probe each device and calling
447 * their write_hwaddr() operation.
449 uclass_first_device(UCLASS_ETH, &dev);
451 printf("No ethernet found.\n");
452 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
454 char *ethprime = getenv("ethprime");
455 struct udevice *prime_dev = NULL;
458 prime_dev = eth_get_dev_by_name(ethprime);
460 eth_set_dev(prime_dev);
461 eth_current_changed();
466 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
471 printf("eth%d: %s", dev->seq, dev->name);
473 if (ethprime && dev == prime_dev)
476 eth_write_hwaddr(dev);
478 uclass_next_device(&dev);
488 static int eth_post_bind(struct udevice *dev)
490 if (strchr(dev->name, ' ')) {
491 printf("\nError: eth device name \"%s\" has a space!\n",
499 static int eth_pre_unbind(struct udevice *dev)
501 /* Don't hang onto a pointer that is going away */
502 if (dev == eth_get_uclass_priv()->current)
508 static int eth_post_probe(struct udevice *dev)
510 struct eth_device_priv *priv = dev->uclass_priv;
511 struct eth_pdata *pdata = dev->platdata;
512 unsigned char env_enetaddr[6];
514 priv->state = ETH_STATE_INIT;
516 /* Check if the device has a MAC address in ROM */
517 if (eth_get_ops(dev)->read_rom_hwaddr)
518 eth_get_ops(dev)->read_rom_hwaddr(dev);
520 eth_getenv_enetaddr_by_index("eth", dev->seq, env_enetaddr);
521 if (!is_zero_ethaddr(env_enetaddr)) {
522 if (!is_zero_ethaddr(pdata->enetaddr) &&
523 memcmp(pdata->enetaddr, env_enetaddr, 6)) {
524 printf("\nWarning: %s MAC addresses don't match:\n",
526 printf("Address in SROM is %pM\n",
528 printf("Address in environment is %pM\n",
532 /* Override the ROM MAC address */
533 memcpy(pdata->enetaddr, env_enetaddr, 6);
534 } else if (is_valid_ethaddr(pdata->enetaddr)) {
535 eth_setenv_enetaddr_by_index("eth", dev->seq, pdata->enetaddr);
536 printf("\nWarning: %s using MAC address from ROM\n",
538 } else if (is_zero_ethaddr(pdata->enetaddr)) {
539 #ifdef CONFIG_NET_RANDOM_ETHADDR
540 net_random_ethaddr(pdata->enetaddr);
541 printf("\nWarning: %s (eth%d) using random MAC address - %pM\n",
542 dev->name, dev->seq, pdata->enetaddr);
544 printf("\nError: %s address not set.\n",
553 static int eth_pre_remove(struct udevice *dev)
555 eth_get_ops(dev)->stop(dev);
560 UCLASS_DRIVER(eth) = {
563 .post_bind = eth_post_bind,
564 .pre_unbind = eth_pre_unbind,
565 .post_probe = eth_post_probe,
566 .pre_remove = eth_pre_remove,
567 .priv_auto_alloc_size = sizeof(struct eth_uclass_priv),
568 .per_device_auto_alloc_size = sizeof(struct eth_device_priv),
569 .flags = DM_UC_FLAG_SEQ_ALIAS,
573 #ifndef CONFIG_DM_ETH
579 } eth_rcv_bufs[PKTBUFSRX];
581 static unsigned int eth_rcv_current, eth_rcv_last;
584 static struct eth_device *eth_devices;
585 struct eth_device *eth_current;
587 static void eth_set_current_to_next(void)
589 eth_current = eth_current->next;
592 static void eth_set_dev(struct eth_device *dev)
597 struct eth_device *eth_get_dev_by_name(const char *devname)
599 struct eth_device *dev, *target_dev;
601 BUG_ON(devname == NULL);
609 if (strcmp(devname, dev->name) == 0) {
614 } while (dev != eth_devices);
619 struct eth_device *eth_get_dev_by_index(int index)
621 struct eth_device *dev, *target_dev;
629 if (dev->index == index) {
634 } while (dev != eth_devices);
639 int eth_get_dev_index(void)
644 return eth_current->index;
647 static int on_ethaddr(const char *name, const char *value, enum env_op op,
651 struct eth_device *dev;
656 /* look for an index after "eth" */
657 index = simple_strtoul(name + 3, NULL, 10);
661 if (dev->index == index) {
664 case env_op_overwrite:
665 eth_parse_enetaddr(value, dev->enetaddr);
668 memset(dev->enetaddr, 0, 6);
671 } while (dev != eth_devices);
675 U_BOOT_ENV_CALLBACK(ethaddr, on_ethaddr);
677 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
680 unsigned char env_enetaddr[6];
683 eth_getenv_enetaddr_by_index(base_name, eth_number, env_enetaddr);
685 if (!is_zero_ethaddr(env_enetaddr)) {
686 if (!is_zero_ethaddr(dev->enetaddr) &&
687 memcmp(dev->enetaddr, env_enetaddr, 6)) {
688 printf("\nWarning: %s MAC addresses don't match:\n",
690 printf("Address in SROM is %pM\n",
692 printf("Address in environment is %pM\n",
696 memcpy(dev->enetaddr, env_enetaddr, 6);
697 } else if (is_valid_ethaddr(dev->enetaddr)) {
698 eth_setenv_enetaddr_by_index(base_name, eth_number,
700 printf("\nWarning: %s using MAC address from net device\n",
702 } else if (is_zero_ethaddr(dev->enetaddr)) {
703 #ifdef CONFIG_NET_RANDOM_ETHADDR
704 net_random_ethaddr(dev->enetaddr);
705 printf("\nWarning: %s (eth%d) using random MAC address - %pM\n",
706 dev->name, eth_number, dev->enetaddr);
708 printf("\nError: %s address not set.\n",
714 if (dev->write_hwaddr && !eth_mac_skip(eth_number)) {
715 if (!is_valid_ethaddr(dev->enetaddr)) {
716 printf("\nError: %s address %pM illegal value\n",
717 dev->name, dev->enetaddr);
721 ret = dev->write_hwaddr(dev);
723 printf("\nWarning: %s failed to set MAC address\n",
730 int eth_register(struct eth_device *dev)
732 struct eth_device *d;
735 assert(strlen(dev->name) < sizeof(dev->name));
740 eth_current_changed();
742 for (d = eth_devices; d->next != eth_devices; d = d->next)
747 dev->state = ETH_STATE_INIT;
748 dev->next = eth_devices;
749 dev->index = index++;
754 int eth_unregister(struct eth_device *dev)
756 struct eth_device *cur;
762 for (cur = eth_devices; cur->next != eth_devices && cur->next != dev;
766 /* Device not found */
767 if (cur->next != dev)
770 cur->next = dev->next;
772 if (eth_devices == dev)
773 eth_devices = dev->next == eth_devices ? NULL : dev->next;
775 if (eth_current == dev) {
776 eth_current = eth_devices;
777 eth_current_changed();
783 int eth_initialize(void)
792 puts("No ethernet found.\n");
793 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
795 struct eth_device *dev = eth_devices;
796 char *ethprime = getenv("ethprime");
798 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
803 printf("%s", dev->name);
805 if (ethprime && strcmp(dev->name, ethprime) == 0) {
810 if (strchr(dev->name, ' '))
811 puts("\nWarning: eth device name has a space!"
814 eth_write_hwaddr(dev, "eth", dev->index);
818 } while (dev != eth_devices);
820 eth_current_changed();
827 #ifdef CONFIG_MCAST_TFTP
829 * mcast_addr: multicast ipaddr from which multicast Mac is made
830 * join: 1=join, 0=leave.
832 int eth_mcast_join(struct in_addr mcast_ip, int join)
835 if (!eth_current || !eth_current->mcast)
837 mcast_mac[5] = htonl(mcast_ip.s_addr) & 0xff;
838 mcast_mac[4] = (htonl(mcast_ip.s_addr)>>8) & 0xff;
839 mcast_mac[3] = (htonl(mcast_ip.s_addr)>>16) & 0x7f;
843 return eth_current->mcast(eth_current, mcast_mac, join);
846 /* the 'way' for ethernet-CRC-32. Spliced in from Linux lib/crc32.c
847 * and this is the ethernet-crc method needed for TSEC -- and perhaps
848 * some other adapter -- hash tables
850 #define CRCPOLY_LE 0xedb88320
851 u32 ether_crc(size_t len, unsigned char const *p)
858 for (i = 0; i < 8; i++)
859 crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
861 /* an reverse the bits, cuz of way they arrive -- last-first */
862 crc = (crc >> 16) | (crc << 16);
863 crc = (crc >> 8 & 0x00ff00ff) | (crc << 8 & 0xff00ff00);
864 crc = (crc >> 4 & 0x0f0f0f0f) | (crc << 4 & 0xf0f0f0f0);
865 crc = (crc >> 2 & 0x33333333) | (crc << 2 & 0xcccccccc);
866 crc = (crc >> 1 & 0x55555555) | (crc << 1 & 0xaaaaaaaa);
875 struct eth_device *old_current;
878 puts("No ethernet found.\n");
882 old_current = eth_current;
884 debug("Trying %s\n", eth_current->name);
886 if (eth_current->init(eth_current, gd->bd) >= 0) {
887 eth_current->state = ETH_STATE_ACTIVE;
894 } while (old_current != eth_current);
904 eth_current->halt(eth_current);
906 eth_current->state = ETH_STATE_PASSIVE;
909 int eth_send(void *packet, int length)
914 return eth_current->send(eth_current, packet, length);
922 return eth_current->recv(eth_current);
924 #endif /* ifndef CONFIG_DM_ETH */
927 static void eth_save_packet(void *packet, int length)
932 if ((eth_rcv_last+1) % PKTBUFSRX == eth_rcv_current)
935 if (PKTSIZE < length)
938 for (i = 0; i < length; i++)
939 eth_rcv_bufs[eth_rcv_last].data[i] = p[i];
941 eth_rcv_bufs[eth_rcv_last].length = length;
942 eth_rcv_last = (eth_rcv_last + 1) % PKTBUFSRX;
945 int eth_receive(void *packet, int length)
948 void *pp = push_packet;
951 if (eth_rcv_current == eth_rcv_last) {
952 push_packet = eth_save_packet;
956 if (eth_rcv_current == eth_rcv_last)
960 length = min(eth_rcv_bufs[eth_rcv_current].length, length);
962 for (i = 0; i < length; i++)
963 p[i] = eth_rcv_bufs[eth_rcv_current].data[i];
965 eth_rcv_current = (eth_rcv_current + 1) % PKTBUFSRX;
968 #endif /* CONFIG_API */
970 static void eth_current_changed(void)
972 char *act = getenv("ethact");
973 /* update current ethernet name */
975 if (act == NULL || strcmp(act, eth_get_name()) != 0)
976 setenv("ethact", eth_get_name());
979 * remove the variable completely if there is no active
982 else if (act != NULL)
983 setenv("ethact", NULL);
986 void eth_try_another(int first_restart)
988 static void *first_failed;
992 * Do not rotate between network interfaces when
993 * 'ethrotate' variable is set to 'no'.
995 ethrotate = getenv("ethrotate");
996 if ((ethrotate != NULL) && (strcmp(ethrotate, "no") == 0))
1003 first_failed = eth_get_dev();
1005 eth_set_current_to_next();
1007 eth_current_changed();
1009 if (first_failed == eth_get_dev())
1010 net_restart_wrap = 1;
1013 void eth_set_current(void)
1016 static int env_changed_id;
1019 env_id = get_env_id();
1020 if ((act == NULL) || (env_changed_id != env_id)) {
1021 act = getenv("ethact");
1022 env_changed_id = env_id;
1026 char *ethprime = getenv("ethprime");
1030 dev = eth_get_dev_by_name(ethprime);
1036 eth_set_dev(eth_get_dev_by_name(act));
1039 eth_current_changed();
1042 const char *eth_get_name(void)
1044 return eth_get_dev() ? eth_get_dev()->name : "unknown";