xref: /netbsd-src/sys/dev/ofw/ofnet.c (revision 3816d47b2c42fcd6e549e3407f842a5b1a1d23ad)
1 /*	$NetBSD: ofnet.c,v 1.48 2009/05/12 14:39:22 cegger Exp $	*/
2 
3 /*
4  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
5  * Copyright (C) 1995, 1996 TooLs GmbH.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by TooLs GmbH.
19  * 4. The name of TooLs GmbH may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #include <sys/cdefs.h>
35 __KERNEL_RCSID(0, "$NetBSD: ofnet.c,v 1.48 2009/05/12 14:39:22 cegger Exp $");
36 
37 #include "ofnet.h"
38 #include "opt_inet.h"
39 #include "bpfilter.h"
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/callout.h>
44 #include <sys/device.h>
45 #include <sys/disk.h>
46 #include <sys/ioctl.h>
47 #include <sys/mbuf.h>
48 #include <sys/socket.h>
49 #include <sys/syslog.h>
50 
51 #include <net/if.h>
52 #include <net/if_ether.h>
53 
54 #ifdef INET
55 #include <netinet/in.h>
56 #include <netinet/if_inarp.h>
57 #endif
58 
59 #if NBPFILTER > 0
60 #include <net/bpf.h>
61 #include <net/bpfdesc.h>
62 #endif
63 
64 #include <dev/ofw/openfirm.h>
65 
66 #if NIPKDB_OFN > 0
67 #include <ipkdb/ipkdb.h>
68 #include <machine/ipkdb.h>
69 
70 CFATTACH_DECL(ipkdb_ofn, 0,
71     ipkdb_probe, ipkdb_attach, NULL, NULL);
72 
73 static struct ipkdb_if *kifp;
74 static struct ofnet_softc *ipkdb_of;
75 
76 static int ipkdbprobe (cfdata_t, void *);
77 #endif
78 
79 struct ofnet_softc {
80 	struct device sc_dev;
81 	int sc_phandle;
82 	int sc_ihandle;
83 	struct ethercom sc_ethercom;
84 	struct callout sc_callout;
85 };
86 
87 static int ofnet_match (device_t, cfdata_t, void *);
88 static void ofnet_attach (device_t, device_t, void *);
89 
90 CFATTACH_DECL(ofnet, sizeof(struct ofnet_softc),
91     ofnet_match, ofnet_attach, NULL, NULL);
92 
93 static void ofnet_read (struct ofnet_softc *);
94 static void ofnet_timer (void *);
95 static void ofnet_init (struct ofnet_softc *);
96 static void ofnet_stop (struct ofnet_softc *);
97 
98 static void ofnet_start (struct ifnet *);
99 static int ofnet_ioctl (struct ifnet *, u_long, void *);
100 static void ofnet_watchdog (struct ifnet *);
101 
102 static int
103 ofnet_match(device_t parent, cfdata_t match, void *aux)
104 {
105 	struct ofbus_attach_args *oba = aux;
106 	char type[32];
107 	int l;
108 
109 #if NIPKDB_OFN > 0
110 	if (!parent)
111 		return ipkdbprobe(match, aux);
112 #endif
113 	if (strcmp(oba->oba_busname, "ofw"))
114 		return (0);
115 	if ((l = OF_getprop(oba->oba_phandle, "device_type", type,
116 	    sizeof type - 1)) < 0)
117 		return 0;
118 	if (l >= sizeof type)
119 		return 0;
120 	type[l] = 0;
121 	if (strcmp(type, "network"))
122 		return 0;
123 	return 1;
124 }
125 
126 static void
127 ofnet_attach(device_t parent, device_t self, void *aux)
128 {
129 	struct ofnet_softc *of = device_private(self);
130 	struct ifnet *ifp = &of->sc_ethercom.ec_if;
131 	struct ofbus_attach_args *oba = aux;
132 	char path[256];
133 	int l;
134 	u_int8_t myaddr[ETHER_ADDR_LEN];
135 
136 	of->sc_phandle = oba->oba_phandle;
137 #if NIPKDB_OFN > 0
138 	if (kifp &&
139 	    kifp->unit - 1 == device_unit(&of->sc_dev) &&
140 	    OF_instance_to_package(kifp->port) == oba->oba_phandle)  {
141 		ipkdb_of = of;
142 		of->sc_ihandle = kifp->port;
143 	} else
144 #endif
145 	if ((l = OF_package_to_path(oba->oba_phandle, path,
146 	    sizeof path - 1)) < 0 ||
147 	    l >= sizeof path ||
148 	    (path[l] = 0, !(of->sc_ihandle = OF_open(path))))
149 		panic("ofnet_attach: unable to open");
150 	if (OF_getprop(oba->oba_phandle, "mac-address", myaddr,
151 	    sizeof myaddr) < 0)
152 		panic("ofnet_attach: no mac-address");
153 	printf(": address %s\n", ether_sprintf(myaddr));
154 
155 	callout_init(&of->sc_callout, 0);
156 
157 	strlcpy(ifp->if_xname, device_xname(&of->sc_dev), IFNAMSIZ);
158 	ifp->if_softc = of;
159 	ifp->if_start = ofnet_start;
160 	ifp->if_ioctl = ofnet_ioctl;
161 	ifp->if_watchdog = ofnet_watchdog;
162 	ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_NOTRAILERS;
163 	IFQ_SET_READY(&ifp->if_snd);
164 
165 	if_attach(ifp);
166 	ether_ifattach(ifp, myaddr);
167 }
168 
169 static char buf[ETHER_MAX_LEN];
170 
171 static void
172 ofnet_read(struct ofnet_softc *of)
173 {
174 	struct ifnet *ifp = &of->sc_ethercom.ec_if;
175 	struct mbuf *m, **mp, *head;
176 	int s, l, len;
177 	char *bufp;
178 
179 	s = splnet();
180 #if NIPKDB_OFN > 0
181 	ipkdbrint(kifp, ifp);
182 #endif
183 	for (;;) {
184 		len = OF_read(of->sc_ihandle, buf, sizeof buf);
185 		if (len == -2 || len == 0)
186 			break;
187 		if (len < sizeof(struct ether_header)) {
188 			ifp->if_ierrors++;
189 			continue;
190 		}
191 		bufp = buf;
192 
193 		/*
194 		 * We don't know if the interface included the FCS
195 		 * or not.  For now, assume that it did if we got
196 		 * a packet length that looks like it could include
197 		 * the FCS.
198 		 *
199 		 * XXX Yuck.
200 		 */
201 		if (len > ETHER_MAX_LEN - ETHER_CRC_LEN)
202 			len = ETHER_MAX_LEN - ETHER_CRC_LEN;
203 
204 		/* Allocate a header mbuf */
205 		MGETHDR(m, M_DONTWAIT, MT_DATA);
206 		if (m == 0) {
207 			ifp->if_ierrors++;
208 			continue;
209 		}
210 		m->m_pkthdr.rcvif = ifp;
211 		m->m_pkthdr.len = len;
212 
213 		l = MHLEN;
214 		head = 0;
215 		mp = &head;
216 
217 		while (len > 0) {
218 			if (head) {
219 				MGET(m, M_DONTWAIT, MT_DATA);
220 				if (m == 0) {
221 					ifp->if_ierrors++;
222 					m_freem(head);
223 					head = 0;
224 					break;
225 				}
226 				l = MLEN;
227 			}
228 			if (len >= MINCLSIZE) {
229 				MCLGET(m, M_DONTWAIT);
230 				if ((m->m_flags & M_EXT) == 0) {
231 					ifp->if_ierrors++;
232 					m_free(m);
233 					m_freem(head);
234 					head = 0;
235 					break;
236 				}
237 				l = MCLBYTES;
238 			}
239 
240 			/*
241 			 * Make sure the data after the Ethernet header
242 			 * is aligned.
243 			 *
244 			 * XXX Assumes the device is an ethernet, but
245 			 * XXX then so does other code in this driver.
246 			 */
247 			if (head == NULL) {
248 				char *newdata = (char *)ALIGN(m->m_data +
249 				      sizeof(struct ether_header)) -
250 				    sizeof(struct ether_header);
251 				l -= newdata - m->m_data;
252 				m->m_data = newdata;
253 			}
254 
255 			m->m_len = l = min(len, l);
256 			memcpy(mtod(m, char *), bufp, l);
257 			bufp += l;
258 			len -= l;
259 			*mp = m;
260 			mp = &m->m_next;
261 		}
262 		if (head == 0)
263 			continue;
264 
265 #if NBPFILTER > 0
266 		if (ifp->if_bpf)
267 			bpf_mtap(ifp->if_bpf, m);
268 #endif
269 		ifp->if_ipackets++;
270 		(*ifp->if_input)(ifp, head);
271 	}
272 	splx(s);
273 }
274 
275 static void
276 ofnet_timer(void *arg)
277 {
278 	struct ofnet_softc *of = arg;
279 
280 	ofnet_read(of);
281 	callout_reset(&of->sc_callout, 1, ofnet_timer, of);
282 }
283 
284 static void
285 ofnet_init(struct ofnet_softc *of)
286 {
287 	struct ifnet *ifp = &of->sc_ethercom.ec_if;
288 
289 	if (ifp->if_flags & IFF_RUNNING)
290 		return;
291 
292 	ifp->if_flags |= IFF_RUNNING;
293 	/* Start reading from interface */
294 	ofnet_timer(of);
295 	/* Attempt to start output */
296 	ofnet_start(ifp);
297 }
298 
299 static void
300 ofnet_stop(struct ofnet_softc *of)
301 {
302 	callout_stop(&of->sc_callout);
303 	of->sc_ethercom.ec_if.if_flags &= ~IFF_RUNNING;
304 }
305 
306 static void
307 ofnet_start(struct ifnet *ifp)
308 {
309 	struct ofnet_softc *of = ifp->if_softc;
310 	struct mbuf *m, *m0;
311 	char *bufp;
312 	int len;
313 
314 	if (!(ifp->if_flags & IFF_RUNNING))
315 		return;
316 
317 	for (;;) {
318 		/* First try reading any packets */
319 		ofnet_read(of);
320 
321 		/* Now get the first packet on the queue */
322 		IFQ_DEQUEUE(&ifp->if_snd, m0);
323 		if (!m0)
324 			return;
325 
326 		if (!(m0->m_flags & M_PKTHDR))
327 			panic("ofnet_start: no header mbuf");
328 		len = m0->m_pkthdr.len;
329 
330 #if NBPFILTER > 0
331 		if (ifp->if_bpf)
332 			bpf_mtap(ifp->if_bpf, m0);
333 #endif
334 
335 		if (len > ETHERMTU + sizeof(struct ether_header)) {
336 			/* packet too large, toss it */
337 			ifp->if_oerrors++;
338 			m_freem(m0);
339 			continue;
340 		}
341 
342 		for (bufp = buf; (m = m0) != NULL;) {
343 			memcpy(bufp, mtod(m, char *), m->m_len);
344 			bufp += m->m_len;
345 			MFREE(m, m0);
346 		}
347 
348 		/*
349 		 * We don't know if the interface will auto-pad for
350 		 * us, so make sure it's at least as large as a
351 		 * minimum size Ethernet packet.
352 		 */
353 
354 		if (len < (ETHER_MIN_LEN - ETHER_CRC_LEN)) {
355 			memset(bufp, 0, ETHER_MIN_LEN - ETHER_CRC_LEN - len);
356 			bufp += ETHER_MIN_LEN - ETHER_CRC_LEN - len;
357 		} else
358 			len = bufp - buf;
359 
360 		if (OF_write(of->sc_ihandle, buf, len) != len)
361 			ifp->if_oerrors++;
362 		else
363 			ifp->if_opackets++;
364 	}
365 }
366 
367 static int
368 ofnet_ioctl(struct ifnet *ifp, u_long cmd, void *data)
369 {
370 	struct ofnet_softc *of = ifp->if_softc;
371 	struct ifaddr *ifa = (struct ifaddr *)data;
372 	/* struct ifreq *ifr = (struct ifreq *)data; */
373 	int error = 0;
374 
375 	switch (cmd) {
376 	case SIOCINITIFADDR:
377 		ifp->if_flags |= IFF_UP;
378 
379 		switch (ifa->ifa_addr->sa_family) {
380 #ifdef	INET
381 		case AF_INET:
382 			arp_ifinit(ifp, ifa);
383 			break;
384 #endif
385 		default:
386 			break;
387 		}
388 		ofnet_init(of);
389 		break;
390 	case SIOCSIFFLAGS:
391 		if ((error = ifioctl_common(ifp, cmd, data)) != 0)
392 			break;
393 		/* XXX re-use ether_ioctl() */
394 		switch (ifp->if_flags & (IFF_UP|IFF_RUNNING)) {
395 		case IFF_RUNNING:
396 			/* If interface is down, but running, stop it. */
397 			ofnet_stop(of);
398 			break;
399 		case IFF_UP:
400 			/* If interface is up, but not running, start it. */
401 			ofnet_init(of);
402 			break;
403 		default:
404 			/* Other flags are ignored. */
405 			break;
406 		}
407 		break;
408 	default:
409 		error = ether_ioctl(ifp, cmd, data);
410 		break;
411 	}
412 	return error;
413 }
414 
415 static void
416 ofnet_watchdog(struct ifnet *ifp)
417 {
418 	struct ofnet_softc *of = ifp->if_softc;
419 
420 	log(LOG_ERR, "%s: device timeout\n", device_xname(&of->sc_dev));
421 	ifp->if_oerrors++;
422 	ofnet_stop(of);
423 	ofnet_init(of);
424 }
425 
426 #if NIPKDB_OFN > 0
427 static void
428 ipkdbofstart(struct ipkdb_if *kip)
429 {
430 	int unit = kip->unit - 1;
431 
432 	if (ipkdb_of)
433 		ipkdbattach(kip, &ipkdb_of->sc_ethercom);
434 }
435 
436 static void
437 ipkdbofleave(struct ipkdb_if *kip)
438 {
439 }
440 
441 static int
442 ipkdbofrcv(struct ipkdb_if *kip, u_char *buf, int poll)
443 {
444 	int l;
445 
446 	do {
447 		l = OF_read(kip->port, buf, ETHERMTU);
448 		if (l < 0)
449 			l = 0;
450 	} while (!poll && !l);
451 	return l;
452 }
453 
454 static void
455 ipkdbofsend(struct ipkdb_if *kip, u_char *buf, int l)
456 {
457 	OF_write(kip->port, buf, l);
458 }
459 
460 static int
461 ipkdbprobe(cfdata_t match, void *aux)
462 {
463 	struct ipkdb_if *kip = aux;
464 	static char name[256];
465 	int len;
466 	int phandle;
467 
468 	kip->unit = match->cf_unit + 1;
469 
470 	if (!(kip->port = OF_open("net")))
471 		return -1;
472 	if ((len = OF_instance_to_path(kip->port, name, sizeof name - 1)) < 0 ||
473 	    len >= sizeof name)
474 		return -1;
475 	name[len] = 0;
476 	if ((phandle = OF_instance_to_package(kip->port)) == -1)
477 		return -1;
478 	if (OF_getprop(phandle, "mac-address", kip->myenetaddr,
479 	    sizeof kip->myenetaddr) < 0)
480 		return -1;
481 
482 	kip->flags |= IPKDB_MYHW;
483 	kip->name = name;
484 	kip->start = ipkdbofstart;
485 	kip->leave = ipkdbofleave;
486 	kip->receive = ipkdbofrcv;
487 	kip->send = ipkdbofsend;
488 
489 	kifp = kip;
490 
491 	return 0;
492 }
493 #endif
494