xref: /freebsd/stand/uboot/net.c (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 /*-
2  * Copyright (c) 2000-2001 Benno Rice
3  * Copyright (c) 2007 Semihalf, Rafal Jaworowski <raj@semihalf.com>
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 #include <sys/param.h>
30 #include <sys/types.h>
31 #include <sys/socket.h>
32 
33 #include <net/if.h>
34 #include <netinet/in.h>
35 #include <netinet/in_systm.h>
36 #include <netinet/if_ether.h>
37 #include <netinet/ip.h>
38 
39 #include <stand.h>
40 #include <net.h>
41 #include <netif.h>
42 
43 #include "api_public.h"
44 #include "glue.h"
45 #include "libuboot.h"
46 #include "dev_net.h"
47 
48 static int	net_probe(struct netif *, void *);
49 static int	net_match(struct netif *, void *);
50 static void	net_init(struct iodesc *, void *);
51 static ssize_t	net_get(struct iodesc *, void **, time_t);
52 static ssize_t	net_put(struct iodesc *, void *, size_t);
53 static void	net_end(struct netif *);
54 
55 extern struct netif_stats net_stats[];
56 
57 struct netif_dif net_ifs[] = {
58 	/*	dif_unit	dif_nsel	dif_stats	dif_private */
59 	{	0,		1,		&net_stats[0],	0,	},
60 };
61 
62 struct netif_stats net_stats[nitems(net_ifs)];
63 
64 struct netif_driver uboot_net = {
65 	"uboot_eth",		/* netif_bname */
66 	net_match,		/* netif_match */
67 	net_probe,		/* netif_probe */
68 	net_init,		/* netif_init */
69 	net_get,		/* netif_get */
70 	net_put,		/* netif_put */
71 	net_end,		/* netif_end */
72 	net_ifs,		/* netif_ifs */
73 	nitems(net_ifs)		/* netif_nifs */
74 };
75 
76 struct uboot_softc {
77 	uint32_t	sc_pad;
78 	uint8_t		sc_rxbuf[ETHER_MAX_LEN];
79 	uint8_t		sc_txbuf[ETHER_MAX_LEN + PKTALIGN];
80 	uint8_t		*sc_txbufp;
81 	int		sc_handle;	/* device handle for ub_dev_xxx */
82 };
83 
84 static struct uboot_softc uboot_softc;
85 
86 /*
87  * get_env_net_params()
88  *
89  * Attempt to obtain all the parms we need for netbooting from the U-Boot
90  * environment.  If we fail to obtain the values it may still be possible to
91  * netboot; the net_dev code will attempt to get the values from bootp, rarp,
92  * and other such sources.
93  *
94  * If rootip.s_addr is non-zero net_dev assumes the required global variables
95  * are set and skips the bootp inquiry.  For that reason, we don't set rootip
96  * until we've verified that we have at least the minimum required info.
97  *
98  * This is called from netif_init() which can result in it getting called
99  * multiple times, by design.  The network code at higher layers zeroes out
100  * rootip when it closes a network interface, so if it gets opened again we have
101  * to obtain all this info again.
102  */
103 static void
104 get_env_net_params()
105 {
106 	char *envstr;
107 	in_addr_t rootaddr, serveraddr;
108 
109 	/*
110 	 * Silently get out right away if we don't have rootpath, because none
111 	 * of the other info we obtain below is sufficient to boot without it.
112 	 *
113 	 * If we do have rootpath, copy it into the global var and also set
114 	 * dhcp.root-path in the env.  If we don't get all the other info from
115 	 * the u-boot env below, we will still try dhcp/bootp, but the server-
116 	 * provided path will not replace the user-provided value we set here.
117 	 */
118 	if ((envstr = ub_env_get("rootpath")) == NULL)
119 		return;
120 	strlcpy(rootpath, envstr, sizeof(rootpath));
121 	setenv("dhcp.root-path", rootpath, 0);
122 
123 	/*
124 	 * Our own IP address must be valid.  Silently get out if it's not set,
125 	 * but whine if it's there and we can't parse it.
126 	 */
127 	if ((envstr = ub_env_get("ipaddr")) == NULL)
128 		return;
129 	if ((myip.s_addr = inet_addr(envstr)) == INADDR_NONE) {
130 		printf("Could not parse ipaddr '%s'\n", envstr);
131 		return;
132 	}
133 
134 	/*
135 	 * Netmask is optional, default to the "natural" netmask for our IP, but
136 	 * whine if it was provided and we couldn't parse it.
137 	 */
138 	if ((envstr = ub_env_get("netmask")) != NULL &&
139 	    (netmask = inet_addr(envstr)) == INADDR_NONE) {
140 		printf("Could not parse netmask '%s'\n", envstr);
141 	}
142 	if (netmask == INADDR_NONE) {
143 		if (IN_CLASSA(myip.s_addr))
144 			netmask = IN_CLASSA_NET;
145 		else if (IN_CLASSB(myip.s_addr))
146 			netmask = IN_CLASSB_NET;
147 		else
148 			netmask = IN_CLASSC_NET;
149 	}
150 
151 	/*
152 	 * Get optional serverip before rootpath; the latter can override it.
153 	 * Whine only if it's present but can't be parsed.
154 	 */
155 	serveraddr = INADDR_NONE;
156 	if ((envstr = ub_env_get("serverip")) != NULL) {
157 		if ((serveraddr = inet_addr(envstr)) == INADDR_NONE)
158 			printf("Could not parse serverip '%s'\n", envstr);
159 	}
160 
161 	/*
162 	 * There must be a rootpath.  It may be ip:/path or it may be just the
163 	 * path in which case the ip needs to be in serverip.
164 	 */
165 	rootaddr = net_parse_rootpath();
166 	if (rootaddr == INADDR_NONE)
167 		rootaddr = serveraddr;
168 	if (rootaddr == INADDR_NONE) {
169 		printf("No server address for rootpath '%s'\n", envstr);
170 		return;
171 	}
172 	rootip.s_addr = rootaddr;
173 
174 	/*
175 	 * Gateway IP is optional unless rootip is on a different net in which
176 	 * case whine if it's missing or we can't parse it, and set rootip addr
177 	 * to zero, which signals to other network code that network params
178 	 * aren't set (so it will try dhcp, bootp, etc).
179 	 */
180 	envstr = ub_env_get("gatewayip");
181 	if (!SAMENET(myip, rootip, netmask)) {
182 		if (envstr == NULL)  {
183 			printf("Need gatewayip for a root server on a "
184 			    "different network.\n");
185 			rootip.s_addr = 0;
186 			return;
187 		}
188 		if ((gateip.s_addr = inet_addr(envstr)) == INADDR_NONE) {
189 			printf("Could not parse gatewayip '%s'\n", envstr);
190 			rootip.s_addr = 0;
191 			return;
192 		}
193 	}
194 }
195 
196 static int
197 net_match(struct netif *nif, void *machdep_hint)
198 {
199 	char **a = (char **)machdep_hint;
200 
201 	if (memcmp("net", *a, 3) == 0)
202 		return (1);
203 
204 	printf("net_match: could not match network device\n");
205 	return (0);
206 }
207 
208 static int
209 net_probe(struct netif *nif, void *machdep_hint)
210 {
211 	struct device_info *di;
212 	int i;
213 
214 	for (i = 0; i < devs_no; i++)
215 		if ((di = ub_dev_get(i)) != NULL)
216 			if (di->type == DEV_TYP_NET)
217 				break;
218 
219 	if (i == devs_no) {
220 		printf("net_probe: no network devices found, maybe not"
221 		    " enumerated yet..?\n");
222 		return (-1);
223 	}
224 
225 #if defined(NETIF_DEBUG)
226 	printf("net_probe: network device found: %d\n", i);
227 #endif
228 	uboot_softc.sc_handle = i;
229 
230 	return (0);
231 }
232 
233 static ssize_t
234 net_put(struct iodesc *desc, void *pkt, size_t len)
235 {
236 	struct netif *nif = desc->io_netif;
237 	struct uboot_softc *sc = nif->nif_devdata;
238 	size_t sendlen;
239 	ssize_t rv;
240 
241 #if defined(NETIF_DEBUG)
242 	struct ether_header *eh;
243 
244 	printf("net_put: desc %p, pkt %p, len %d\n", desc, pkt, len);
245 	eh = pkt;
246 	printf("dst: %s ", ether_sprintf(eh->ether_dhost));
247 	printf("src: %s ", ether_sprintf(eh->ether_shost));
248 	printf("type: 0x%x\n", eh->ether_type & 0xffff);
249 #endif
250 
251 	if (len < ETHER_MIN_LEN - ETHER_CRC_LEN) {
252 		sendlen = ETHER_MIN_LEN - ETHER_CRC_LEN;
253 		bzero(sc->sc_txbufp, sendlen);
254 	} else
255 		sendlen = len;
256 
257 	memcpy(sc->sc_txbufp, pkt, len);
258 
259 	rv = ub_dev_send(sc->sc_handle, sc->sc_txbufp, sendlen);
260 
261 #if defined(NETIF_DEBUG)
262 	printf("net_put: ub_send returned %d\n", rv);
263 #endif
264 	if (rv == 0)
265 		rv = len;
266 	else
267 		rv = -1;
268 
269 	return (rv);
270 }
271 
272 static ssize_t
273 net_get(struct iodesc *desc, void **pkt, time_t timeout)
274 {
275 	struct netif *nif = desc->io_netif;
276 	struct uboot_softc *sc = nif->nif_devdata;
277 	time_t t;
278 	int err, rlen;
279 	size_t len;
280 	char *buf;
281 
282 #if defined(NETIF_DEBUG)
283 	printf("net_get: pkt %p, timeout %d\n", pkt, timeout);
284 #endif
285 	t = getsecs();
286 	len = sizeof(sc->sc_rxbuf);
287 	do {
288 		err = ub_dev_recv(sc->sc_handle, sc->sc_rxbuf, len, &rlen);
289 
290 		if (err != 0) {
291 			printf("net_get: ub_dev_recv() failed, error=%d\n",
292 			    err);
293 			rlen = 0;
294 			break;
295 		}
296 	} while ((rlen == -1 || rlen == 0) && (getsecs() - t < timeout));
297 
298 #if defined(NETIF_DEBUG)
299 	printf("net_get: received len %d (%x)\n", rlen, rlen);
300 #endif
301 
302 	if (rlen > 0) {
303 		buf = malloc(rlen + ETHER_ALIGN);
304 		if (buf == NULL)
305 			return (-1);
306 		memcpy(buf + ETHER_ALIGN, sc->sc_rxbuf, rlen);
307 		*pkt = buf;
308 		return ((ssize_t)rlen);
309 	}
310 
311 	return (-1);
312 }
313 
314 static void
315 net_init(struct iodesc *desc, void *machdep_hint)
316 {
317 	struct netif *nif = desc->io_netif;
318 	struct uboot_softc *sc;
319 	struct device_info *di;
320 	int err;
321 
322 	sc = nif->nif_devdata = &uboot_softc;
323 
324 	if ((err = ub_dev_open(sc->sc_handle)) != 0)
325 		panic("%s%d: initialisation failed with error %d",
326 		    nif->nif_driver->netif_bname, nif->nif_unit, err);
327 
328 	/* Get MAC address */
329 	di = ub_dev_get(sc->sc_handle);
330 	memcpy(desc->myea, di->di_net.hwaddr, 6);
331 	if (memcmp (desc->myea, "\0\0\0\0\0\0", 6) == 0) {
332 		panic("%s%d: empty ethernet address!",
333 		    nif->nif_driver->netif_bname, nif->nif_unit);
334 	}
335 
336 	/* Attempt to get netboot params from the u-boot env. */
337 	get_env_net_params();
338 	if (myip.s_addr != 0)
339 		desc->myip = myip;
340 
341 #if defined(NETIF_DEBUG)
342 	printf("network: %s%d attached to %s\n", nif->nif_driver->netif_bname,
343 	    nif->nif_unit, ether_sprintf(desc->myea));
344 #endif
345 
346 	/* Set correct alignment for TX packets */
347 	sc->sc_txbufp = sc->sc_txbuf;
348 	if ((unsigned long)sc->sc_txbufp % PKTALIGN)
349 		sc->sc_txbufp += PKTALIGN -
350 		    (unsigned long)sc->sc_txbufp % PKTALIGN;
351 }
352 
353 static void
354 net_end(struct netif *nif)
355 {
356 	struct uboot_softc *sc = nif->nif_devdata;
357 	int err;
358 
359 	if ((err = ub_dev_close(sc->sc_handle)) != 0)
360 		panic("%s%d: net_end failed with error %d",
361 		    nif->nif_driver->netif_bname, nif->nif_unit, err);
362 }
363