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/cdefs.h>
29 
30 #include <sys/param.h>
31 #include <net/ethernet.h>
32 #include <netinet/in.h>
33 #include <netinet/in_systm.h>
34 
35 #include <stand.h>
36 #include <net.h>
37 #include <netif.h>
38 
39 #include <efi.h>
40 #include <efilib.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
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
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
108 efinet_probe(struct netif *nif, void *machdep_hint __unused)
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 	/*
117 	 * Open the network device in exclusive mode. Without this
118 	 * we will be racing with the UEFI network stack. It will
119 	 * pull packets off the network leading to lost packets.
120 	 */
121 	status = BS->OpenProtocol(h, &sn_guid, (void **)&net,
122 	    IH, NULL, EFI_OPEN_PROTOCOL_EXCLUSIVE);
123 	if (status != EFI_SUCCESS) {
124 		printf("Unable to open network interface %d for "
125 		    "exclusive access: %lu\n", nif->nif_unit,
126 		    EFI_ERROR_CODE(status));
127 	}
128 
129 	return (0);
130 }
131 
132 static ssize_t
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
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 static void
201 efinet_init(struct iodesc *desc, void *machdep_hint __unused)
202 {
203 	struct netif *nif = desc->io_netif;
204 	EFI_SIMPLE_NETWORK *net;
205 	EFI_HANDLE h;
206 	EFI_STATUS status;
207 	UINT32 mask;
208 
209 	if (nif->nif_driver->netif_ifs[nif->nif_unit].dif_unit < 0) {
210 		printf("Invalid network interface %d\n", nif->nif_unit);
211 		return;
212 	}
213 
214 	h = nif->nif_driver->netif_ifs[nif->nif_unit].dif_private;
215 	status = OpenProtocolByHandle(h, &sn_guid, (void **)&nif->nif_devdata);
216 	if (status != EFI_SUCCESS) {
217 		printf("net%d: cannot fetch interface data (status=%lu)\n",
218 		    nif->nif_unit, EFI_ERROR_CODE(status));
219 		return;
220 	}
221 
222 	net = nif->nif_devdata;
223 	if (net->Mode->State == EfiSimpleNetworkStopped) {
224 		status = net->Start(net);
225 		if (status != EFI_SUCCESS) {
226 			printf("net%d: cannot start interface (status=%lu)\n",
227 			    nif->nif_unit, EFI_ERROR_CODE(status));
228 			return;
229 		}
230 	}
231 
232 	if (net->Mode->State != EfiSimpleNetworkInitialized) {
233 		status = net->Initialize(net, 0, 0);
234 		if (status != EFI_SUCCESS) {
235 			printf("net%d: cannot init. interface (status=%lu)\n",
236 			    nif->nif_unit, EFI_ERROR_CODE(status));
237 			return;
238 		}
239 	}
240 
241 	mask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
242 	    EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST;
243 
244 	status = net->ReceiveFilters(net, mask, 0, FALSE, 0, NULL);
245 	if (status != EFI_SUCCESS)
246 		printf("net%d: cannot set rx. filters (status=%lu)\n",
247 		    nif->nif_unit, EFI_ERROR_CODE(status));
248 
249 #ifdef EFINET_DEBUG
250 	dump_mode(net->Mode);
251 #endif
252 
253 	bcopy(net->Mode->CurrentAddress.Addr, desc->myea, 6);
254 	desc->xid = 1;
255 }
256 
257 static void
258 efinet_end(struct netif *nif)
259 {
260 	EFI_SIMPLE_NETWORK *net = nif->nif_devdata;
261 
262 	if (net == NULL)
263 		return;
264 
265 	net->Shutdown(net);
266 }
267 
268 static int efinet_dev_init(void);
269 static int efinet_dev_print(int);
270 
271 struct devsw efinet_dev = {
272 	.dv_name = "net",
273 	.dv_type = DEVT_NET,
274 	.dv_init = efinet_dev_init,
275 	.dv_strategy = NULL,		/* Will be set in efinet_dev_init */
276 	.dv_open = NULL,		/* Will be set in efinet_dev_init */
277 	.dv_close = NULL,		/* Will be set in efinet_dev_init */
278 	.dv_ioctl = noioctl,
279 	.dv_print = efinet_dev_print,
280 	.dv_cleanup = NULL
281 };
282 
283 static int
284 efinet_dev_init(void)
285 {
286 	struct netif_dif *dif;
287 	struct netif_stats *stats;
288 	EFI_DEVICE_PATH *devpath, *node;
289 	EFI_HANDLE *handles, *handles2;
290 	EFI_STATUS status;
291 	UINTN sz;
292 	int err, i, nifs;
293 	extern struct devsw netdev;
294 
295 	sz = 0;
296 	handles = NULL;
297 	status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz, NULL);
298 	if (status == EFI_BUFFER_TOO_SMALL) {
299 		handles = (EFI_HANDLE *)malloc(sz);
300 		status = BS->LocateHandle(ByProtocol, &sn_guid, NULL, &sz,
301 		    handles);
302 		if (EFI_ERROR(status))
303 			free(handles);
304 	}
305 	if (EFI_ERROR(status))
306 		return (efi_status_to_errno(status));
307 	handles2 = (EFI_HANDLE *)malloc(sz);
308 	if (handles2 == NULL) {
309 		free(handles);
310 		return (ENOMEM);
311 	}
312 	nifs = 0;
313 	for (i = 0; i < sz / sizeof (EFI_HANDLE); i++) {
314 		devpath = efi_lookup_devpath(handles[i]);
315 		if (devpath == NULL)
316 			continue;
317 		if ((node = efi_devpath_last_node(devpath)) == NULL)
318 			continue;
319 
320 		if (DevicePathType(node) != MESSAGING_DEVICE_PATH ||
321 		    DevicePathSubType(node) != MSG_MAC_ADDR_DP)
322 			continue;
323 
324 		handles2[nifs] = handles[i];
325 		nifs++;
326 	}
327 	free(handles);
328 	if (nifs == 0) {
329 		err = ENOENT;
330 		goto done;
331 	}
332 
333 	err = efi_register_handles(&efinet_dev, handles2, NULL, nifs);
334 	if (err != 0)
335 		goto done;
336 
337 	efinetif.netif_ifs = calloc(nifs, sizeof (struct netif_dif));
338 	stats = calloc(nifs, sizeof (struct netif_stats));
339 	if (efinetif.netif_ifs == NULL || stats == NULL) {
340 		free(efinetif.netif_ifs);
341 		free(stats);
342 		efinetif.netif_ifs = NULL;
343 		err = ENOMEM;
344 		goto done;
345 	}
346 	efinetif.netif_nifs = nifs;
347 
348 	for (i = 0; i < nifs; i++) {
349 
350 		dif = &efinetif.netif_ifs[i];
351 		dif->dif_unit = i;
352 		dif->dif_nsel = 1;
353 		dif->dif_stats = &stats[i];
354 		dif->dif_private = handles2[i];
355 	}
356 
357 	efinet_dev.dv_open = netdev.dv_open;
358 	efinet_dev.dv_close = netdev.dv_close;
359 	efinet_dev.dv_strategy = netdev.dv_strategy;
360 
361 done:
362 	free(handles2);
363 	return (err);
364 }
365 
366 static int
367 efinet_dev_print(int verbose)
368 {
369 	CHAR16 *text;
370 	EFI_HANDLE h;
371 	int unit, ret = 0;
372 
373 	printf("%s devices:", efinet_dev.dv_name);
374 	if ((ret = pager_output("\n")) != 0)
375 		return (ret);
376 
377 	for (unit = 0, h = efi_find_handle(&efinet_dev, 0);
378 	    h != NULL; h = efi_find_handle(&efinet_dev, ++unit)) {
379 		printf("    %s%d:", efinet_dev.dv_name, unit);
380 		if (verbose) {
381 			text = efi_devpath_name(efi_lookup_devpath(h));
382 			if (text != NULL) {
383 				printf("    %S", text);
384 				efi_free_devpath_name(text);
385 			}
386 		}
387 		if ((ret = pager_output("\n")) != 0)
388 			break;
389 	}
390 	return (ret);
391 }
392