efinet.c revision 277943 
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__FBSDID("$FreeBSD: head/sys/boot/efi/libefi/efinet.c 277943 2015-01-30 18:25:53Z ambrisko $");
30
31#include <sys/param.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 <dev_net.c>
40
41#include <efi.h>
42#include <efilib.h>
43
44static EFI_GUID sn_guid = EFI_SIMPLE_NETWORK_PROTOCOL;
45
46static void efinet_end(struct netif *);
47static int efinet_get(struct iodesc *, void *, size_t, time_t);
48static void efinet_init(struct iodesc *, void *);
49static int efinet_match(struct netif *, void *);
50static int efinet_probe(struct netif *, void *);
51static int efinet_put(struct iodesc *, void *, size_t);
52
53struct netif_driver efinetif = {
54	.netif_bname = "efinet",
55	.netif_match = efinet_match,
56	.netif_probe = efinet_probe,
57	.netif_init = efinet_init,
58	.netif_get = efinet_get,
59	.netif_put = efinet_put,
60	.netif_end = efinet_end,
61	.netif_ifs = NULL,
62	.netif_nifs = 0
63};
64
65#ifdef EFINET_DEBUG
66static void
67dump_mode(EFI_SIMPLE_NETWORK_MODE *mode)
68{
69	int i;
70
71	printf("State                 = %x\n", mode->State);
72	printf("HwAddressSize         = %u\n", mode->HwAddressSize);
73	printf("MediaHeaderSize       = %u\n", mode->MediaHeaderSize);
74	printf("MaxPacketSize         = %u\n", mode->MaxPacketSize);
75	printf("NvRamSize             = %u\n", mode->NvRamSize);
76	printf("NvRamAccessSize       = %u\n", mode->NvRamAccessSize);
77	printf("ReceiveFilterMask     = %x\n", mode->ReceiveFilterMask);
78	printf("ReceiveFilterSetting  = %u\n", mode->ReceiveFilterSetting);
79	printf("MaxMCastFilterCount   = %u\n", mode->MaxMCastFilterCount);
80	printf("MCastFilterCount      = %u\n", mode->MCastFilterCount);
81	printf("MCastFilter           = {");
82	for (i = 0; i < mode->MCastFilterCount; i++)
83		printf(" %s", ether_sprintf(mode->MCastFilter[i].Addr));
84	printf(" }\n");
85	printf("CurrentAddress        = %s\n",
86	    ether_sprintf(mode->CurrentAddress.Addr));
87	printf("BroadcastAddress      = %s\n",
88	    ether_sprintf(mode->BroadcastAddress.Addr));
89	printf("PermanentAddress      = %s\n",
90	    ether_sprintf(mode->PermanentAddress.Addr));
91	printf("IfType                = %u\n", mode->IfType);
92	printf("MacAddressChangeable  = %d\n", mode->MacAddressChangeable);
93	printf("MultipleTxSupported   = %d\n", mode->MultipleTxSupported);
94	printf("MediaPresentSupported = %d\n", mode->MediaPresentSupported);
95	printf("MediaPresent          = %d\n", mode->MediaPresent);
96}
97#endif
98
99static int
100efinet_match(struct netif *nif, void *machdep_hint)
101{
102	struct devdesc *dev = machdep_hint;
103
104	if (dev->d_unit - 1 == nif->nif_unit)
105		return (1);
106	return(0);
107}
108
109static int
110efinet_probe(struct netif *nif, void *machdep_hint)
111{
112
113	return (0);
114}
115
116static int
117efinet_put(struct iodesc *desc, void *pkt, size_t len)
118{
119	struct netif *nif = desc->io_netif;
120	EFI_SIMPLE_NETWORK *net;
121	EFI_STATUS status;
122	void *buf;
123
124	net = nif->nif_devdata;
125
126	status = net->Transmit(net, 0, len, pkt, 0, 0, 0);
127	if (status != EFI_SUCCESS)
128		return (-1);
129
130	/* Wait for the buffer to be transmitted */
131	do {
132		buf = 0;	/* XXX Is this needed? */
133		status = net->GetStatus(net, 0, &buf);
134		/*
135		 * XXX EFI1.1 and the E1000 card returns a different
136		 * address than we gave.  Sigh.
137		 */
138	} while (status == EFI_SUCCESS && buf == 0);
139
140	/* XXX How do we deal with status != EFI_SUCCESS now? */
141	return ((status == EFI_SUCCESS) ? len : -1);
142}
143
144static int
145efinet_get(struct iodesc *desc, void *pkt, size_t len, time_t timeout)
146{
147	struct netif *nif = desc->io_netif;
148	EFI_SIMPLE_NETWORK *net;
149	EFI_STATUS status;
150	UINTN bufsz;
151	time_t t;
152	char buf[2048];
153
154	net = nif->nif_devdata;
155
156	t = time(0);
157	while ((time(0) - t) < timeout) {
158		bufsz = sizeof(buf);
159		status = net->Receive(net, 0, &bufsz, buf, 0, 0, 0);
160		if (status == EFI_SUCCESS) {
161			/*
162			 * XXX EFI1.1 and the E1000 card trash our
163			 * workspace if we do not do this silly copy.
164			 * Either they are not respecting the len
165			 * value or do not like the alignment.
166			 */
167			if (bufsz > len)
168				bufsz = len;
169			bcopy(buf, pkt, bufsz);
170			return (bufsz);
171		}
172		if (status != EFI_NOT_READY)
173			return (0);
174	}
175
176	return (0);
177}
178
179static void
180efinet_init(struct iodesc *desc, void *machdep_hint)
181{
182	struct netif *nif = desc->io_netif;
183	EFI_SIMPLE_NETWORK *net;
184	EFI_HANDLE h;
185	EFI_STATUS status;
186
187	h = nif->nif_driver->netif_ifs[nif->nif_unit].dif_private;
188	status = BS->HandleProtocol(h, &sn_guid, (VOID **)&nif->nif_devdata);
189	if (status != EFI_SUCCESS) {
190		printf("net%d: cannot start interface (status=%ld)\n",
191		    nif->nif_unit, (long)status);
192		return;
193	}
194
195	net = nif->nif_devdata;
196	if (net->Mode->State == EfiSimpleNetworkStopped) {
197		status = net->Start(net);
198		if (status != EFI_SUCCESS) {
199			printf("net%d: cannot start interface (status=%ld)\n",
200			    nif->nif_unit, (long)status);
201			return;
202		}
203	}
204
205	if (net->Mode->State != EfiSimpleNetworkInitialized) {
206		status = net->Initialize(net, 0, 0);
207		if (status != EFI_SUCCESS) {
208			printf("net%d: cannot init. interface (status=%ld)\n",
209			    nif->nif_unit, (long)status);
210			return;
211		}
212	}
213
214	if (net->Mode->ReceiveFilterSetting == 0) {
215		UINT32 mask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
216		    EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST;
217
218		status = net->ReceiveFilters(net, mask, 0, FALSE, 0, 0);
219		if (status != EFI_SUCCESS) {
220			printf("net%d: cannot set rx. filters (status=%ld)\n",
221			    nif->nif_unit, (long)status);
222			return;
223		}
224	}
225
226#ifdef EFINET_DEBUG
227	dump_mode(net->Mode);
228#endif
229
230	bcopy(net->Mode->CurrentAddress.Addr, desc->myea, 6);
231	desc->xid = 1;
232}
233
234static void
235efinet_end(struct netif *nif)
236{
237	EFI_SIMPLE_NETWORK *net = nif->nif_devdata;
238
239	net->Shutdown(net);
240}
241
242static int efinet_dev_init(void);
243static void efinet_dev_print(int);
244
245struct devsw efinet_dev = {
246	.dv_name = "net",
247	.dv_type = DEVT_NET,
248	.dv_init = efinet_dev_init,
249	.dv_strategy = net_strategy,
250	.dv_open = net_open,
251	.dv_close = net_close,
252	.dv_ioctl = noioctl,
253	.dv_print = efinet_dev_print,
254	.dv_cleanup = NULL
255};
256
257static int
258efinet_dev_init()
259{
260	struct netif_dif *dif;
261	struct netif_stats *stats;
262	EFI_HANDLE *handles;
263	EFI_STATUS status;
264	UINTN sz;
265	int err, i, nifs;
266
267	sz = 0;
268	handles = NULL;
269	status = BS->LocateHandle(ByProtocol, &sn_guid, 0, &sz, 0);
270	if (status == EFI_BUFFER_TOO_SMALL) {
271		handles = (EFI_HANDLE *)malloc(sz);
272		status = BS->LocateHandle(ByProtocol, &sn_guid, 0, &sz,
273		    handles);
274		if (EFI_ERROR(status))
275			free(handles);
276	}
277	if (EFI_ERROR(status))
278		return (efi_status_to_errno(status));
279	nifs = sz / sizeof(EFI_HANDLE);
280	err = efi_register_handles(&efinet_dev, handles, NULL, nifs);
281	free(handles);
282	if (err != 0)
283		return (err);
284
285	efinetif.netif_nifs = nifs;
286	efinetif.netif_ifs = calloc(nifs, sizeof(struct netif_dif));
287
288	stats = calloc(nifs, sizeof(struct netif_stats));
289
290	for (i = 0; i < nifs; i++) {
291		dif = &efinetif.netif_ifs[i];
292		dif->dif_unit = i;
293		dif->dif_nsel = 1;
294		dif->dif_stats = &stats[i];
295		dif->dif_private = efi_find_handle(&efinet_dev, i);
296	}
297
298	return (0);
299}
300
301static void
302efinet_dev_print(int verbose)
303{
304	char line[80];
305	EFI_HANDLE h;
306	int unit;
307
308	for (unit = 0, h = efi_find_handle(&efinet_dev, 0);
309	    h != NULL; h = efi_find_handle(&efinet_dev, ++unit)) {
310		sprintf(line, "    %s%d:\n", efinet_dev.dv_name, unit);
311		pager_output(line);
312	}
313}
314