blob: 240b5965345543ff679ae925a2401f9c254b6e8b [file] [log] [blame]
Simon Glassdb9391e2016-01-17 14:52:00 -07001/*
2 * (C) Copyright 2001-2015
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 * Joe Hershberger, National Instruments
5 *
6 * SPDX-License-Identifier: GPL-2.0+
7 */
8
9#include <common.h>
10#include <dm.h>
11#include <environment.h>
12#include <net.h>
13#include <dm/device-internal.h>
14#include <dm/uclass-internal.h>
15#include "eth_internal.h"
16
Simon Glassa7c45ec2016-01-30 15:45:14 -070017DECLARE_GLOBAL_DATA_PTR;
18
Simon Glassdb9391e2016-01-17 14:52:00 -070019/**
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 */
24struct 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 */
33struct eth_uclass_priv {
34 struct udevice *current;
35};
36
37/* eth_errno - This stores the most recent failure code from DM functions */
38static int eth_errno;
39
40static 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
49void 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 */
66struct 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 */
82void 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 */
97struct 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
133unsigned 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 */
146int 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 */
162void 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
175int eth_get_dev_index(void)
176{
177 if (eth_get_dev())
178 return eth_get_dev()->seq;
179 return -1;
180}
181
182static int eth_write_hwaddr(struct udevice *dev)
183{
xypron.glpk@gmx.dec08248d2017-05-16 05:07:01 +0200184 struct eth_pdata *pdata;
Simon Glassdb9391e2016-01-17 14:52:00 -0700185 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)) {
xypron.glpk@gmx.dec08248d2017-05-16 05:07:01 +0200192 pdata = dev->platdata;
Simon Glassdb9391e2016-01-17 14:52:00 -0700193 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
214static 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 eth_parse_enetaddr(value, pdata->enetaddr);
Hannes Schmelzerc86ff7f2016-09-02 14:48:17 +0200231 eth_write_hwaddr(dev);
Simon Glassdb9391e2016-01-17 14:52:00 -0700232 break;
233 case env_op_delete:
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100234 memset(pdata->enetaddr, 0, ARP_HLEN);
Simon Glassdb9391e2016-01-17 14:52:00 -0700235 }
236 }
237
238 return 0;
239}
240U_BOOT_ENV_CALLBACK(ethaddr, on_ethaddr);
241
242int eth_init(void)
243{
Simon Glass00caae62017-08-03 12:22:12 -0600244 char *ethact = env_get("ethact");
245 char *ethrotate = env_get("ethrotate");
Simon Glassdb9391e2016-01-17 14:52:00 -0700246 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
305void eth_halt(void)
306{
307 struct udevice *current;
308 struct eth_device_priv *priv;
309
310 current = eth_get_dev();
311 if (!current || !device_active(current))
312 return;
313
314 eth_get_ops(current)->stop(current);
315 priv = current->uclass_priv;
316 priv->state = ETH_STATE_PASSIVE;
317}
318
319int eth_is_active(struct udevice *dev)
320{
321 struct eth_device_priv *priv;
322
323 if (!dev || !device_active(dev))
324 return 0;
325
326 priv = dev_get_uclass_priv(dev);
327 return priv->state == ETH_STATE_ACTIVE;
328}
329
330int eth_send(void *packet, int length)
331{
332 struct udevice *current;
333 int ret;
334
335 current = eth_get_dev();
336 if (!current)
337 return -ENODEV;
338
Alexander Grafa532e2f2018-03-15 15:07:09 +0100339 if (!eth_is_active(current))
Simon Glassdb9391e2016-01-17 14:52:00 -0700340 return -EINVAL;
341
342 ret = eth_get_ops(current)->send(current, packet, length);
343 if (ret < 0) {
344 /* We cannot completely return the error at present */
345 debug("%s: send() returned error %d\n", __func__, ret);
346 }
347 return ret;
348}
349
350int eth_rx(void)
351{
352 struct udevice *current;
353 uchar *packet;
354 int flags;
355 int ret;
356 int i;
357
358 current = eth_get_dev();
359 if (!current)
360 return -ENODEV;
361
Alexander Grafa532e2f2018-03-15 15:07:09 +0100362 if (!eth_is_active(current))
Simon Glassdb9391e2016-01-17 14:52:00 -0700363 return -EINVAL;
364
365 /* Process up to 32 packets at one time */
366 flags = ETH_RECV_CHECK_DEVICE;
367 for (i = 0; i < 32; i++) {
368 ret = eth_get_ops(current)->recv(current, flags, &packet);
369 flags = 0;
370 if (ret > 0)
371 net_process_received_packet(packet, ret);
372 if (ret >= 0 && eth_get_ops(current)->free_pkt)
373 eth_get_ops(current)->free_pkt(current, packet, ret);
374 if (ret <= 0)
375 break;
376 }
377 if (ret == -EAGAIN)
378 ret = 0;
379 if (ret < 0) {
380 /* We cannot completely return the error at present */
381 debug("%s: recv() returned error %d\n", __func__, ret);
382 }
383 return ret;
384}
385
386int eth_initialize(void)
387{
388 int num_devices = 0;
389 struct udevice *dev;
390
391 eth_common_init();
392
393 /*
394 * Devices need to write the hwaddr even if not started so that Linux
395 * will have access to the hwaddr that u-boot stored for the device.
396 * This is accomplished by attempting to probe each device and calling
397 * their write_hwaddr() operation.
398 */
399 uclass_first_device(UCLASS_ETH, &dev);
400 if (!dev) {
401 printf("No ethernet found.\n");
402 bootstage_error(BOOTSTAGE_ID_NET_ETH_START);
403 } else {
Simon Glass00caae62017-08-03 12:22:12 -0600404 char *ethprime = env_get("ethprime");
Simon Glassdb9391e2016-01-17 14:52:00 -0700405 struct udevice *prime_dev = NULL;
406
407 if (ethprime)
408 prime_dev = eth_get_dev_by_name(ethprime);
409 if (prime_dev) {
410 eth_set_dev(prime_dev);
411 eth_current_changed();
412 } else {
413 eth_set_dev(NULL);
414 }
415
416 bootstage_mark(BOOTSTAGE_ID_NET_ETH_INIT);
417 do {
418 if (num_devices)
419 printf(", ");
420
421 printf("eth%d: %s", dev->seq, dev->name);
422
423 if (ethprime && dev == prime_dev)
424 printf(" [PRIME]");
425
426 eth_write_hwaddr(dev);
427
428 uclass_next_device(&dev);
429 num_devices++;
430 } while (dev);
431
432 putc('\n');
433 }
434
435 return num_devices;
436}
437
438static int eth_post_bind(struct udevice *dev)
439{
440 if (strchr(dev->name, ' ')) {
441 printf("\nError: eth device name \"%s\" has a space!\n",
442 dev->name);
443 return -EINVAL;
444 }
445
446 return 0;
447}
448
449static int eth_pre_unbind(struct udevice *dev)
450{
451 /* Don't hang onto a pointer that is going away */
452 if (dev == eth_get_uclass_priv()->current)
453 eth_set_dev(NULL);
454
455 return 0;
456}
457
458static int eth_post_probe(struct udevice *dev)
459{
460 struct eth_device_priv *priv = dev->uclass_priv;
461 struct eth_pdata *pdata = dev->platdata;
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100462 unsigned char env_enetaddr[ARP_HLEN];
Simon Glassdb9391e2016-01-17 14:52:00 -0700463
464#if defined(CONFIG_NEEDS_MANUAL_RELOC)
465 struct eth_ops *ops = eth_get_ops(dev);
466 static int reloc_done;
467
468 if (!reloc_done) {
469 if (ops->start)
470 ops->start += gd->reloc_off;
471 if (ops->send)
472 ops->send += gd->reloc_off;
473 if (ops->recv)
474 ops->recv += gd->reloc_off;
475 if (ops->free_pkt)
476 ops->free_pkt += gd->reloc_off;
477 if (ops->stop)
478 ops->stop += gd->reloc_off;
479#ifdef CONFIG_MCAST_TFTP
480 if (ops->mcast)
481 ops->mcast += gd->reloc_off;
482#endif
483 if (ops->write_hwaddr)
484 ops->write_hwaddr += gd->reloc_off;
485 if (ops->read_rom_hwaddr)
486 ops->read_rom_hwaddr += gd->reloc_off;
487
488 reloc_done++;
489 }
490#endif
491
492 priv->state = ETH_STATE_INIT;
493
494 /* Check if the device has a MAC address in ROM */
495 if (eth_get_ops(dev)->read_rom_hwaddr)
496 eth_get_ops(dev)->read_rom_hwaddr(dev);
497
Simon Glass35affd72017-08-03 12:22:14 -0600498 eth_env_get_enetaddr_by_index("eth", dev->seq, env_enetaddr);
Simon Glassdb9391e2016-01-17 14:52:00 -0700499 if (!is_zero_ethaddr(env_enetaddr)) {
500 if (!is_zero_ethaddr(pdata->enetaddr) &&
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100501 memcmp(pdata->enetaddr, env_enetaddr, ARP_HLEN)) {
Simon Glassdb9391e2016-01-17 14:52:00 -0700502 printf("\nWarning: %s MAC addresses don't match:\n",
503 dev->name);
oliver@schinagl.nl26d40b02016-11-25 16:30:23 +0100504 printf("Address in ROM is %pM\n",
Simon Glassdb9391e2016-01-17 14:52:00 -0700505 pdata->enetaddr);
506 printf("Address in environment is %pM\n",
507 env_enetaddr);
508 }
509
510 /* Override the ROM MAC address */
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100511 memcpy(pdata->enetaddr, env_enetaddr, ARP_HLEN);
Simon Glassdb9391e2016-01-17 14:52:00 -0700512 } else if (is_valid_ethaddr(pdata->enetaddr)) {
Simon Glassfd1e9592017-08-03 12:22:11 -0600513 eth_env_set_enetaddr_by_index("eth", dev->seq, pdata->enetaddr);
Simon Glassdb9391e2016-01-17 14:52:00 -0700514 printf("\nWarning: %s using MAC address from ROM\n",
515 dev->name);
Siva Durga Prasad Paladuguaa555fe2016-11-02 12:52:13 +0100516 } else if (is_zero_ethaddr(pdata->enetaddr) ||
517 !is_valid_ethaddr(pdata->enetaddr)) {
Simon Glassdb9391e2016-01-17 14:52:00 -0700518#ifdef CONFIG_NET_RANDOM_ETHADDR
519 net_random_ethaddr(pdata->enetaddr);
520 printf("\nWarning: %s (eth%d) using random MAC address - %pM\n",
521 dev->name, dev->seq, pdata->enetaddr);
522#else
523 printf("\nError: %s address not set.\n",
524 dev->name);
525 return -EINVAL;
526#endif
527 }
528
529 return 0;
530}
531
532static int eth_pre_remove(struct udevice *dev)
533{
534 struct eth_pdata *pdata = dev->platdata;
535
536 eth_get_ops(dev)->stop(dev);
537
538 /* clear the MAC address */
oliver@schinagl.nla40db6d2016-11-25 16:30:19 +0100539 memset(pdata->enetaddr, 0, ARP_HLEN);
Simon Glassdb9391e2016-01-17 14:52:00 -0700540
541 return 0;
542}
543
544UCLASS_DRIVER(eth) = {
545 .name = "eth",
546 .id = UCLASS_ETH,
547 .post_bind = eth_post_bind,
548 .pre_unbind = eth_pre_unbind,
549 .post_probe = eth_post_probe,
550 .pre_remove = eth_pre_remove,
551 .priv_auto_alloc_size = sizeof(struct eth_uclass_priv),
552 .per_device_auto_alloc_size = sizeof(struct eth_device_priv),
553 .flags = DM_UC_FLAG_SEQ_ALIAS,
554};