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+
15 #include <asm/errno.h>
16 #include <dm/device-internal.h>
18 DECLARE_GLOBAL_DATA_PTR;
20 void eth_parse_enetaddr(const char *addr, uchar *enetaddr)
25 for (i = 0; i < 6; ++i) {
26 enetaddr[i] = addr ? simple_strtoul(addr, &end, 16) : 0;
28 addr = (*end) ? end + 1 : end;
32 int eth_getenv_enetaddr(char *name, uchar *enetaddr)
34 eth_parse_enetaddr(getenv(name), enetaddr);
35 return is_valid_ether_addr(enetaddr);
38 int eth_setenv_enetaddr(char *name, const uchar *enetaddr)
42 sprintf(buf, "%pM", enetaddr);
44 return setenv(name, buf);
47 int eth_getenv_enetaddr_by_index(const char *base_name, int index,
51 sprintf(enetvar, index ? "%s%daddr" : "%saddr", base_name, index);
52 return eth_getenv_enetaddr(enetvar, enetaddr);
55 static inline int eth_setenv_enetaddr_by_index(const char *base_name, int index,
59 sprintf(enetvar, index ? "%s%daddr" : "%saddr", base_name, index);
60 return eth_setenv_enetaddr(enetvar, enetaddr);
63 static void eth_env_init(void)
67 s = getenv("bootfile");
69 copy_filename(BootFile, s, sizeof(BootFile));
72 static int eth_mac_skip(int index)
76 sprintf(enetvar, index ? "eth%dmacskip" : "ethmacskip", index);
77 return ((skip_state = getenv(enetvar)) != NULL);
80 static void eth_current_changed(void);
84 * struct eth_device_priv - private structure for each Ethernet device
86 * @state: The state of the Ethernet MAC driver (defined by enum eth_state_t)
88 struct eth_device_priv {
89 enum eth_state_t state;
93 * struct eth_uclass_priv - The structure attached to the uclass itself
95 * @current: The Ethernet device that the network functions are using
97 struct eth_uclass_priv {
98 struct udevice *current;
101 static struct eth_uclass_priv *eth_get_uclass_priv(void)
105 uclass_get(UCLASS_ETH, &uc);
110 static void eth_set_current_to_next(void)
112 struct eth_uclass_priv *uc_priv;
114 uc_priv = eth_get_uclass_priv();
115 if (uc_priv->current)
116 uclass_next_device(&uc_priv->current);
117 if (!uc_priv->current)
118 uclass_first_device(UCLASS_ETH, &uc_priv->current);
121 struct udevice *eth_get_dev(void)
123 struct eth_uclass_priv *uc_priv;
125 uc_priv = eth_get_uclass_priv();
126 if (!uc_priv->current)
127 uclass_first_device(UCLASS_ETH,
129 return uc_priv->current;
132 static void eth_set_dev(struct udevice *dev)
135 eth_get_uclass_priv()->current = dev;
138 unsigned char *eth_get_ethaddr(void)
140 struct eth_pdata *pdata;
143 pdata = eth_get_dev()->platdata;
144 return pdata->enetaddr;
150 /* Set active state without calling start on the driver */
151 int eth_init_state_only(void)
153 struct udevice *current;
154 struct eth_device_priv *priv;
156 current = eth_get_dev();
157 if (!current || !device_active(current))
160 priv = current->uclass_priv;
161 priv->state = ETH_STATE_ACTIVE;
166 /* Set passive state without calling stop on the driver */
167 void eth_halt_state_only(void)
169 struct udevice *current;
170 struct eth_device_priv *priv;
172 current = eth_get_dev();
173 if (!current || !device_active(current))
176 priv = current->uclass_priv;
177 priv->state = ETH_STATE_PASSIVE;
180 int eth_get_dev_index(void)
183 return eth_get_dev()->seq;
189 struct udevice *current;
190 struct udevice *old_current;
192 current = eth_get_dev();
194 printf("No ethernet found.\n");
198 old_current = current;
200 debug("Trying %s\n", current->name);
202 if (device_active(current)) {
203 uchar env_enetaddr[6];
204 struct eth_pdata *pdata = current->platdata;
206 /* Sync environment with network device */
207 if (eth_getenv_enetaddr_by_index("eth", current->seq,
209 memcpy(pdata->enetaddr, env_enetaddr, 6);
211 memset(pdata->enetaddr, 0, 6);
213 if (eth_get_ops(current)->start(current) >= 0) {
214 struct eth_device_priv *priv =
215 current->uclass_priv;
217 priv->state = ETH_STATE_ACTIVE;
223 /* This will ensure the new "current" attempted to probe */
225 current = eth_get_dev();
226 } while (old_current != current);
233 struct udevice *current;
234 struct eth_device_priv *priv;
236 current = eth_get_dev();
237 if (!current || !device_active(current))
240 eth_get_ops(current)->stop(current);
241 priv = current->uclass_priv;
242 priv->state = ETH_STATE_PASSIVE;
245 int eth_send(void *packet, int length)
247 struct udevice *current;
249 current = eth_get_dev();
253 if (!device_active(current))
256 return eth_get_ops(current)->send(current, packet, length);
261 struct udevice *current;
263 current = eth_get_dev();
267 if (!device_active(current))
270 return eth_get_ops(current)->recv(current);
273 static int eth_write_hwaddr(struct udevice *dev)
275 struct eth_pdata *pdata = dev->platdata;
278 if (!dev || !device_active(dev))
281 /* seq is valid since the device is active */
282 if (eth_get_ops(dev)->write_hwaddr && !eth_mac_skip(dev->seq)) {
283 if (!is_valid_ether_addr(pdata->enetaddr)) {
284 printf("\nError: %s address %pM illegal value\n",
285 dev->name, pdata->enetaddr);
289 ret = eth_get_ops(dev)->write_hwaddr(dev);
291 printf("\nWarning: %s failed to set MAC address\n",
298 int eth_initialize(void)
303 bootstage_mark(BOOTSTAGE_ID_NET_ETH_START);
307 * Devices need to write the hwaddr even if not started so that Linux
308 * will have access to the hwaddr that u-boot stored for the device.
309 * This is accomplished by attempting to probe each device and calling
310 * their write_hwaddr() operation.
312 uclass_first_device(UCLASS_ETH, &dev);
314 printf("No ethernet found.\n");
315 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
317 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
322 printf("eth%d: %s", dev->seq, dev->name);
324 eth_write_hwaddr(dev);
326 uclass_next_device(&dev);
336 static int eth_post_bind(struct udevice *dev)
338 if (strchr(dev->name, ' ')) {
339 printf("\nError: eth device name \"%s\" has a space!\n",
347 static int eth_pre_unbind(struct udevice *dev)
349 /* Don't hang onto a pointer that is going away */
350 if (dev == eth_get_uclass_priv()->current)
356 static int eth_post_probe(struct udevice *dev)
358 struct eth_device_priv *priv = dev->uclass_priv;
359 struct eth_pdata *pdata = dev->platdata;
360 unsigned char env_enetaddr[6];
362 priv->state = ETH_STATE_INIT;
364 /* Check if the device has a MAC address in ROM */
365 if (eth_get_ops(dev)->read_rom_hwaddr)
366 eth_get_ops(dev)->read_rom_hwaddr(dev);
368 eth_getenv_enetaddr_by_index("eth", dev->seq, env_enetaddr);
369 if (!is_zero_ether_addr(env_enetaddr)) {
370 if (!is_zero_ether_addr(pdata->enetaddr) &&
371 memcmp(pdata->enetaddr, env_enetaddr, 6)) {
372 printf("\nWarning: %s MAC addresses don't match:\n",
374 printf("Address in SROM is %pM\n",
376 printf("Address in environment is %pM\n",
380 /* Override the ROM MAC address */
381 memcpy(pdata->enetaddr, env_enetaddr, 6);
382 } else if (is_valid_ether_addr(pdata->enetaddr)) {
383 eth_setenv_enetaddr_by_index("eth", dev->seq, pdata->enetaddr);
384 printf("\nWarning: %s using MAC address from ROM\n",
386 } else if (is_zero_ether_addr(pdata->enetaddr)) {
387 printf("\nError: %s address not set.\n",
395 static int eth_pre_remove(struct udevice *dev)
397 eth_get_ops(dev)->stop(dev);
402 UCLASS_DRIVER(eth) = {
405 .post_bind = eth_post_bind,
406 .pre_unbind = eth_pre_unbind,
407 .post_probe = eth_post_probe,
408 .pre_remove = eth_pre_remove,
409 .priv_auto_alloc_size = sizeof(struct eth_uclass_priv),
410 .per_device_auto_alloc_size = sizeof(struct eth_device_priv),
414 #ifndef CONFIG_DM_ETH
416 * CPU and board-specific Ethernet initializations. Aliased function
417 * signals caller to move on
419 static int __def_eth_init(bd_t *bis)
423 int cpu_eth_init(bd_t *bis) __attribute__((weak, alias("__def_eth_init")));
424 int board_eth_init(bd_t *bis) __attribute__((weak, alias("__def_eth_init")));
430 } eth_rcv_bufs[PKTBUFSRX];
432 static unsigned int eth_rcv_current, eth_rcv_last;
435 static struct eth_device *eth_devices;
436 struct eth_device *eth_current;
438 static void eth_set_current_to_next(void)
440 eth_current = eth_current->next;
443 struct eth_device *eth_get_dev_by_name(const char *devname)
445 struct eth_device *dev, *target_dev;
447 BUG_ON(devname == NULL);
455 if (strcmp(devname, dev->name) == 0) {
460 } while (dev != eth_devices);
465 struct eth_device *eth_get_dev_by_index(int index)
467 struct eth_device *dev, *target_dev;
475 if (dev->index == index) {
480 } while (dev != eth_devices);
485 int eth_get_dev_index(void)
490 return eth_current->index;
493 int eth_write_hwaddr(struct eth_device *dev, const char *base_name,
496 unsigned char env_enetaddr[6];
499 eth_getenv_enetaddr_by_index(base_name, eth_number, env_enetaddr);
501 if (!is_zero_ether_addr(env_enetaddr)) {
502 if (!is_zero_ether_addr(dev->enetaddr) &&
503 memcmp(dev->enetaddr, env_enetaddr, 6)) {
504 printf("\nWarning: %s MAC addresses don't match:\n",
506 printf("Address in SROM is %pM\n",
508 printf("Address in environment is %pM\n",
512 memcpy(dev->enetaddr, env_enetaddr, 6);
513 } else if (is_valid_ether_addr(dev->enetaddr)) {
514 eth_setenv_enetaddr_by_index(base_name, eth_number,
516 printf("\nWarning: %s using MAC address from net device\n",
518 } else if (is_zero_ether_addr(dev->enetaddr)) {
519 printf("\nError: %s address not set.\n",
524 if (dev->write_hwaddr && !eth_mac_skip(eth_number)) {
525 if (!is_valid_ether_addr(dev->enetaddr)) {
526 printf("\nError: %s address %pM illegal value\n",
527 dev->name, dev->enetaddr);
531 ret = dev->write_hwaddr(dev);
533 printf("\nWarning: %s failed to set MAC address\n", dev->name);
539 int eth_register(struct eth_device *dev)
541 struct eth_device *d;
544 assert(strlen(dev->name) < sizeof(dev->name));
547 eth_current = eth_devices = dev;
548 eth_current_changed();
550 for (d = eth_devices; d->next != eth_devices; d = d->next)
555 dev->state = ETH_STATE_INIT;
556 dev->next = eth_devices;
557 dev->index = index++;
562 int eth_unregister(struct eth_device *dev)
564 struct eth_device *cur;
570 for (cur = eth_devices; cur->next != eth_devices && cur->next != dev;
574 /* Device not found */
575 if (cur->next != dev)
578 cur->next = dev->next;
580 if (eth_devices == dev)
581 eth_devices = dev->next == eth_devices ? NULL : dev->next;
583 if (eth_current == dev) {
584 eth_current = eth_devices;
585 eth_current_changed();
591 int eth_initialize(void)
597 bootstage_mark(BOOTSTAGE_ID_NET_ETH_START);
598 #if defined(CONFIG_MII) || defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
609 * If board-specific initialization exists, call it.
610 * If not, call a CPU-specific one
612 if (board_eth_init != __def_eth_init) {
613 if (board_eth_init(gd->bd) < 0)
614 printf("Board Net Initialization Failed\n");
615 } else if (cpu_eth_init != __def_eth_init) {
616 if (cpu_eth_init(gd->bd) < 0)
617 printf("CPU Net Initialization Failed\n");
619 printf("Net Initialization Skipped\n");
622 puts("No ethernet found.\n");
623 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
625 struct eth_device *dev = eth_devices;
626 char *ethprime = getenv("ethprime");
628 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
633 printf("%s", dev->name);
635 if (ethprime && strcmp(dev->name, ethprime) == 0) {
640 if (strchr(dev->name, ' '))
641 puts("\nWarning: eth device name has a space!"
644 eth_write_hwaddr(dev, "eth", dev->index);
648 } while (dev != eth_devices);
650 eth_current_changed();
657 #ifdef CONFIG_MCAST_TFTP
659 * mcast_addr: multicast ipaddr from which multicast Mac is made
660 * join: 1=join, 0=leave.
662 int eth_mcast_join(IPaddr_t mcast_ip, int join)
665 if (!eth_current || !eth_current->mcast)
667 mcast_mac[5] = htonl(mcast_ip) & 0xff;
668 mcast_mac[4] = (htonl(mcast_ip)>>8) & 0xff;
669 mcast_mac[3] = (htonl(mcast_ip)>>16) & 0x7f;
673 return eth_current->mcast(eth_current, mcast_mac, join);
676 /* the 'way' for ethernet-CRC-32. Spliced in from Linux lib/crc32.c
677 * and this is the ethernet-crc method needed for TSEC -- and perhaps
678 * some other adapter -- hash tables
680 #define CRCPOLY_LE 0xedb88320
681 u32 ether_crc(size_t len, unsigned char const *p)
688 for (i = 0; i < 8; i++)
689 crc = (crc >> 1) ^ ((crc & 1) ? CRCPOLY_LE : 0);
691 /* an reverse the bits, cuz of way they arrive -- last-first */
692 crc = (crc >> 16) | (crc << 16);
693 crc = (crc >> 8 & 0x00ff00ff) | (crc << 8 & 0xff00ff00);
694 crc = (crc >> 4 & 0x0f0f0f0f) | (crc << 4 & 0xf0f0f0f0);
695 crc = (crc >> 2 & 0x33333333) | (crc << 2 & 0xcccccccc);
696 crc = (crc >> 1 & 0x55555555) | (crc << 1 & 0xaaaaaaaa);
705 struct eth_device *old_current, *dev;
708 puts("No ethernet found.\n");
712 /* Sync environment with network devices */
715 uchar env_enetaddr[6];
717 if (eth_getenv_enetaddr_by_index("eth", dev->index,
719 memcpy(dev->enetaddr, env_enetaddr, 6);
722 } while (dev != eth_devices);
724 old_current = eth_current;
726 debug("Trying %s\n", eth_current->name);
728 if (eth_current->init(eth_current, gd->bd) >= 0) {
729 eth_current->state = ETH_STATE_ACTIVE;
736 } while (old_current != eth_current);
746 eth_current->halt(eth_current);
748 eth_current->state = ETH_STATE_PASSIVE;
751 int eth_send(void *packet, int length)
756 return eth_current->send(eth_current, packet, length);
764 return eth_current->recv(eth_current);
766 #endif /* ifndef CONFIG_DM_ETH */
769 static void eth_save_packet(void *packet, int length)
774 if ((eth_rcv_last+1) % PKTBUFSRX == eth_rcv_current)
777 if (PKTSIZE < length)
780 for (i = 0; i < length; i++)
781 eth_rcv_bufs[eth_rcv_last].data[i] = p[i];
783 eth_rcv_bufs[eth_rcv_last].length = length;
784 eth_rcv_last = (eth_rcv_last + 1) % PKTBUFSRX;
787 int eth_receive(void *packet, int length)
790 void *pp = push_packet;
793 if (eth_rcv_current == eth_rcv_last) {
794 push_packet = eth_save_packet;
798 if (eth_rcv_current == eth_rcv_last)
802 length = min(eth_rcv_bufs[eth_rcv_current].length, length);
804 for (i = 0; i < length; i++)
805 p[i] = eth_rcv_bufs[eth_rcv_current].data[i];
807 eth_rcv_current = (eth_rcv_current + 1) % PKTBUFSRX;
810 #endif /* CONFIG_API */
812 static void eth_current_changed(void)
814 char *act = getenv("ethact");
815 /* update current ethernet name */
817 if (act == NULL || strcmp(act, eth_get_name()) != 0)
818 setenv("ethact", eth_get_name());
821 * remove the variable completely if there is no active
824 else if (act != NULL)
825 setenv("ethact", NULL);
828 void eth_try_another(int first_restart)
830 static void *first_failed;
834 * Do not rotate between network interfaces when
835 * 'ethrotate' variable is set to 'no'.
837 ethrotate = getenv("ethrotate");
838 if ((ethrotate != NULL) && (strcmp(ethrotate, "no") == 0))
845 first_failed = eth_get_dev();
847 eth_set_current_to_next();
849 eth_current_changed();
851 if (first_failed == eth_get_dev())
855 void eth_set_current(void)
858 static int env_changed_id;
862 env_id = get_env_id();
863 if ((act == NULL) || (env_changed_id != env_id)) {
864 act = getenv("ethact");
865 env_changed_id = env_id;
868 old_current = eth_get_dev();
870 if (strcmp(eth_get_name(), act) == 0)
872 eth_set_current_to_next();
873 } while (old_current != eth_get_dev());
876 eth_current_changed();
879 const char *eth_get_name(void)
881 return eth_get_dev() ? eth_get_dev()->name : "unknown";