1 /*-
2 * Copyright (c) 2001 Doug Rabson
3 * Copyright (c) 2002, 2006 Marcel Moolenaar
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28 #include <sys/param.h>
29 #include <net/ethernet.h>
30 #include <netinet/in.h>
31 #include <netinet/in_systm.h>
32
33 #include <stand.h>
34 #include <net.h>
35 #include <netif.h>
36
37 #include <efi.h>
38 #include <efilib.h>
39
40 #include "dev_net.h"
41
42 static EFI_GUID sn_guid = EFI_SIMPLE_NETWORK_PROTOCOL;
43
44 static void efinet_end(struct netif *);
45 static ssize_t efinet_get(struct iodesc *, void **, time_t);
46 static void efinet_init(struct iodesc *, void *);
47 static int efinet_match(struct netif *, void *);
48 static int efinet_probe(struct netif *, void *);
49 static ssize_t efinet_put(struct iodesc *, void *, size_t);
50
51 struct netif_driver efinetif = {
52 .netif_bname = "efinet",
53 .netif_match = efinet_match,
54 .netif_probe = efinet_probe,
55 .netif_init = efinet_init,
56 .netif_get = efinet_get,
57 .netif_put = efinet_put,
58 .netif_end = efinet_end,
59 .netif_ifs = NULL,
60 .netif_nifs = 0
61 };
62
63 #ifdef EFINET_DEBUG
64 static void
dump_mode(EFI_SIMPLE_NETWORK_MODE * mode)65 dump_mode(EFI_SIMPLE_NETWORK_MODE *mode)
66 {
67 int i;
68
69 printf("State = %x\n", mode->State);
70 printf("HwAddressSize = %u\n", mode->HwAddressSize);
71 printf("MediaHeaderSize = %u\n", mode->MediaHeaderSize);
72 printf("MaxPacketSize = %u\n", mode->MaxPacketSize);
73 printf("NvRamSize = %u\n", mode->NvRamSize);
74 printf("NvRamAccessSize = %u\n", mode->NvRamAccessSize);
75 printf("ReceiveFilterMask = %x\n", mode->ReceiveFilterMask);
76 printf("ReceiveFilterSetting = %u\n", mode->ReceiveFilterSetting);
77 printf("MaxMCastFilterCount = %u\n", mode->MaxMCastFilterCount);
78 printf("MCastFilterCount = %u\n", mode->MCastFilterCount);
79 printf("MCastFilter = {");
80 for (i = 0; i < mode->MCastFilterCount; i++)
81 printf(" %s", ether_sprintf(mode->MCastFilter[i].Addr));
82 printf(" }\n");
83 printf("CurrentAddress = %s\n",
84 ether_sprintf(mode->CurrentAddress.Addr));
85 printf("BroadcastAddress = %s\n",
86 ether_sprintf(mode->BroadcastAddress.Addr));
87 printf("PermanentAddress = %s\n",
88 ether_sprintf(mode->PermanentAddress.Addr));
89 printf("IfType = %u\n", mode->IfType);
90 printf("MacAddressChangeable = %d\n", mode->MacAddressChangeable);
91 printf("MultipleTxSupported = %d\n", mode->MultipleTxSupported);
92 printf("MediaPresentSupported = %d\n", mode->MediaPresentSupported);
93 printf("MediaPresent = %d\n", mode->MediaPresent);
94 }
95 #endif
96
97 static int
efinet_match(struct netif * nif,void * machdep_hint)98 efinet_match(struct netif *nif, void *machdep_hint)
99 {
100 struct devdesc *dev = machdep_hint;
101
102 if (dev->d_unit == nif->nif_unit)
103 return (1);
104 return(0);
105 }
106
107 static int
efinet_probe(struct netif * nif,void * machdep_hint)108 efinet_probe(struct netif *nif, void *machdep_hint)
109 {
110 EFI_SIMPLE_NETWORK *net;
111 EFI_HANDLE h;
112 EFI_STATUS status;
113
114 h = nif->nif_driver->netif_ifs[nif->nif_unit].dif_private;
115 /*
116 * Open the network device in exclusive mode. Without this
117 * we will be racing with the UEFI network stack. It will
118 * pull packets off the network leading to lost packets.
119 */
120 status = BS->OpenProtocol(h, &sn_guid, (void **)&net,
121 IH, NULL, EFI_OPEN_PROTOCOL_EXCLUSIVE);
122 if (status != EFI_SUCCESS) {
123 printf("Unable to open network interface %d for "
124 "exclusive access: %lu\n", nif->nif_unit,
125 EFI_ERROR_CODE(status));
126 return (efi_status_to_errno(status));
127 }
128
129 return (0);
130 }
131
132 static ssize_t
efinet_put(struct iodesc * desc,void * pkt,size_t len)133 efinet_put(struct iodesc *desc, void *pkt, size_t len)
134 {
135 struct netif *nif = desc->io_netif;
136 EFI_SIMPLE_NETWORK *net;
137 EFI_STATUS status;
138 void *buf;
139
140 net = nif->nif_devdata;
141 if (net == NULL)
142 return (-1);
143
144 status = net->Transmit(net, 0, len, pkt, NULL, NULL, NULL);
145 if (status != EFI_SUCCESS)
146 return (-1);
147
148 /* Wait for the buffer to be transmitted */
149 do {
150 buf = NULL; /* XXX Is this needed? */
151 status = net->GetStatus(net, NULL, &buf);
152 /*
153 * XXX EFI1.1 and the E1000 card returns a different
154 * address than we gave. Sigh.
155 */
156 } while (status == EFI_SUCCESS && buf == NULL);
157
158 /* XXX How do we deal with status != EFI_SUCCESS now? */
159 return ((status == EFI_SUCCESS) ? len : -1);
160 }
161
162 static ssize_t
efinet_get(struct iodesc * desc,void ** pkt,time_t timeout)163 efinet_get(struct iodesc *desc, void **pkt, time_t timeout)
164 {
165 struct netif *nif = desc->io_netif;
166 EFI_SIMPLE_NETWORK *net;
167 EFI_STATUS status;
168 UINTN bufsz;
169 time_t t;
170 char *buf, *ptr;
171 ssize_t ret = -1;
172
173 net = nif->nif_devdata;
174 if (net == NULL)
175 return (ret);
176
177 bufsz = net->Mode->MaxPacketSize + ETHER_HDR_LEN + ETHER_CRC_LEN;
178 buf = malloc(bufsz + ETHER_ALIGN);
179 if (buf == NULL)
180 return (ret);
181 ptr = buf + ETHER_ALIGN;
182
183 t = getsecs();
184 while ((getsecs() - t) < timeout) {
185 status = net->Receive(net, NULL, &bufsz, ptr, NULL, NULL, NULL);
186 if (status == EFI_SUCCESS) {
187 *pkt = buf;
188 ret = (ssize_t)bufsz;
189 break;
190 }
191 if (status != EFI_NOT_READY)
192 break;
193 }
194
195 if (ret == -1)
196 free(buf);
197 return (ret);
198 }
199
200 /*
201 * Loader uses BOOTP/DHCP and also uses RARP as a fallback to populate
202 * network parameters and problems with DHCP servers can cause the loader
203 * to fail to populate them. Allow the device to ask about the basic
204 * network parameters and if present use them.
205 */
206 static void
efi_env_net_params(struct iodesc * desc)207 efi_env_net_params(struct iodesc *desc)
208 {
209 char *envstr;
210 in_addr_t ipaddr, mask, gwaddr, serveraddr;
211 n_long rootaddr;
212
213 if ((envstr = getenv("rootpath")) != NULL)
214 strlcpy(rootpath, envstr, sizeof(rootpath));
215
216 /*
217 * Get network parameters.
218 */
219 envstr = getenv("ipaddr");
220 ipaddr = (envstr != NULL) ? inet_addr(envstr) : 0;
221
222 envstr = getenv("netmask");
223 mask = (envstr != NULL) ? inet_addr(envstr) : 0;
224
225 envstr = getenv("gatewayip");
226 gwaddr = (envstr != NULL) ? inet_addr(envstr) : 0;
227
228 envstr = getenv("serverip");
229 serveraddr = (envstr != NULL) ? inet_addr(envstr) : 0;
230
231 /* No network params. */
232 if (ipaddr == 0 && mask == 0 && gwaddr == 0 && serveraddr == 0)
233 return;
234
235 /* Partial network params. */
236 if (ipaddr == 0 || mask == 0 || gwaddr == 0 || serveraddr == 0) {
237 printf("Incomplete network settings from U-Boot\n");
238 return;
239 }
240
241 /*
242 * Set network parameters.
243 */
244 myip.s_addr = ipaddr;
245 netmask = mask;
246 gateip.s_addr = gwaddr;
247 servip.s_addr = serveraddr;
248
249 /*
250 * There must be a rootpath. It may be ip:/path or it may be just the
251 * path in which case the ip needs to be serverip.
252 */
253 rootaddr = net_parse_rootpath();
254 if (rootaddr == INADDR_NONE)
255 rootaddr = serveraddr;
256 rootip.s_addr = rootaddr;
257
258 #ifdef EFINET_DEBUG
259 printf("%s: proto=%d\n", __func__, netproto);
260 printf("%s: ip=%s\n", __func__, inet_ntoa(myip));
261 printf("%s: mask=%s\n", __func__, intoa(netmask));
262 printf("%s: gateway=%s\n", __func__, inet_ntoa(gateip));
263 printf("%s: server=%s\n", __func__, inet_ntoa(servip));
264 #endif
265
266 desc->myip = myip;
267 }
268
269 static void
efinet_init(struct iodesc * desc,void * machdep_hint)270 efinet_init(struct iodesc *desc, void *machdep_hint)
271 {
272 struct netif *nif = desc->io_netif;
273 EFI_SIMPLE_NETWORK *net;
274 EFI_HANDLE h;
275 EFI_STATUS status;
276 UINT32 mask;
277
278 /* Attempt to get netboot params from env */
279 efi_env_net_params(desc);
280
281 if (nif->nif_driver->netif_ifs[nif->nif_unit].dif_unit < 0) {
282 printf("Invalid network interface %d\n", nif->nif_unit);
283 return;
284 }
285
286 h = nif->nif_driver->netif_ifs[nif->nif_unit].dif_private;
287 status = OpenProtocolByHandle(h, &sn_guid, (void **)&nif->nif_devdata);
288 if (status != EFI_SUCCESS) {
289 printf("net%d: cannot fetch interface data (status=%lu)\n",
290 nif->nif_unit, EFI_ERROR_CODE(status));
291 return;
292 }
293
294 net = nif->nif_devdata;
295 if (net->Mode->State == EfiSimpleNetworkStopped) {
296 status = net->Start(net);
297 if (status != EFI_SUCCESS) {
298 printf("net%d: cannot start interface (status=%lu)\n",
299 nif->nif_unit, EFI_ERROR_CODE(status));
300 return;
301 }
302 }
303
304 if (net->Mode->State != EfiSimpleNetworkInitialized) {
305 status = net->Initialize(net, 0, 0);
306 if (status != EFI_SUCCESS) {
307 printf("net%d: cannot init. interface (status=%lu)\n",
308 nif->nif_unit, EFI_ERROR_CODE(status));
309 return;
310 }
311 }
312
313 mask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
314 EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST;
315
316 status = net->ReceiveFilters(net, mask, 0, FALSE, 0, NULL);
317 if (status != EFI_SUCCESS)
318 printf("net%d: cannot set rx. filters (status=%lu)\n",
319 nif->nif_unit, EFI_ERROR_CODE(status));
320
321 #ifdef EFINET_DEBUG
322 dump_mode(net->Mode);
323 #endif
324
325 bcopy(net->Mode->CurrentAddress.Addr, desc->myea, 6);
326 desc->xid = 1;
327 }
328
329 static void
efinet_end(struct netif * nif)330 efinet_end(struct netif *nif)
331 {
332 EFI_SIMPLE_NETWORK *net = nif->nif_devdata;
333
334 if (net == NULL)
335 return;
336
337 net->Shutdown(net);
338 }
339
340 static int efinet_dev_init(void);
341 static int efinet_dev_print(int);
342
343 struct devsw efinet_dev = {
344 .dv_name = "net",
345 .dv_type = DEVT_NET,
346 .dv_init = efinet_dev_init,
347 .dv_strategy = NULL, /* Will be set in efinet_dev_init */
348 .dv_open = NULL, /* Will be set in efinet_dev_init */
349 .dv_close = NULL, /* Will be set in efinet_dev_init */
350 .dv_ioctl = noioctl,
351 .dv_print = efinet_dev_print,
352 .dv_cleanup = nullsys,
353 };
354
355 static int
efinet_dev_init(void)356 efinet_dev_init(void)
357 {
358 struct netif_dif *dif;
359 struct netif_stats *stats;
360 EFI_DEVICE_PATH *devpath, *node;
361 EFI_HANDLE *handles, *handles2;
362 EFI_STATUS status;
363 UINTN sz;
364 int err, i, nifs;
365 extern struct devsw netdev;
366
367 sz = 0;
368 handles = NULL;
369 status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz, NULL);
370 if (status == EFI_BUFFER_TOO_SMALL) {
371 handles = (EFI_HANDLE *)malloc(sz);
372 if (handles == NULL)
373 return (ENOMEM);
374 status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz,
375 handles);
376 if (EFI_ERROR(status))
377 free(handles);
378 }
379 if (EFI_ERROR(status))
380 return (efi_status_to_errno(status));
381 handles2 = (EFI_HANDLE *)malloc(sz);
382 if (handles2 == NULL) {
383 free(handles);
384 return (ENOMEM);
385 }
386 nifs = 0;
387 for (i = 0; i < sz / sizeof(EFI_HANDLE); i++) {
388 devpath = efi_lookup_devpath(handles[i]);
389 if (devpath == NULL)
390 continue;
391 if ((node = efi_devpath_last_node(devpath)) == NULL)
392 continue;
393
394 if (DevicePathType(node) != MESSAGING_DEVICE_PATH ||
395 DevicePathSubType(node) != MSG_MAC_ADDR_DP)
396 continue;
397
398 handles2[nifs] = handles[i];
399 nifs++;
400 }
401 free(handles);
402 if (nifs == 0) {
403 err = ENOENT;
404 goto done;
405 }
406
407 err = efi_register_handles(&efinet_dev, handles2, NULL, nifs);
408 if (err != 0)
409 goto done;
410
411 efinetif.netif_ifs = calloc(nifs, sizeof(struct netif_dif));
412 stats = calloc(nifs, sizeof(struct netif_stats));
413 if (efinetif.netif_ifs == NULL || stats == NULL) {
414 free(efinetif.netif_ifs);
415 free(stats);
416 efinetif.netif_ifs = NULL;
417 err = ENOMEM;
418 goto done;
419 }
420 efinetif.netif_nifs = nifs;
421
422 for (i = 0; i < nifs; i++) {
423
424 dif = &efinetif.netif_ifs[i];
425 dif->dif_unit = i;
426 dif->dif_nsel = 1;
427 dif->dif_stats = &stats[i];
428 dif->dif_private = handles2[i];
429 }
430
431 efinet_dev.dv_cleanup = netdev.dv_cleanup;
432 efinet_dev.dv_open = netdev.dv_open;
433 efinet_dev.dv_close = netdev.dv_close;
434 efinet_dev.dv_strategy = netdev.dv_strategy;
435
436 done:
437 free(handles2);
438 return (err);
439 }
440
441 static int
efinet_dev_print(int verbose)442 efinet_dev_print(int verbose)
443 {
444 CHAR16 *text;
445 EFI_HANDLE h;
446 int unit, ret = 0;
447
448 printf("%s devices:", efinet_dev.dv_name);
449 if ((ret = pager_output("\n")) != 0)
450 return (ret);
451
452 for (unit = 0, h = efi_find_handle(&efinet_dev, 0);
453 h != NULL; h = efi_find_handle(&efinet_dev, ++unit)) {
454 printf(" %s%d:", efinet_dev.dv_name, unit);
455 if (verbose) {
456 text = efi_devpath_name(efi_lookup_devpath(h));
457 if (text != NULL) {
458 printf(" %S", text);
459 efi_free_devpath_name(text);
460 }
461 }
462 if ((ret = pager_output("\n")) != 0)
463 break;
464 }
465 return (ret);
466 }
467