xref: /netbsd-src/sys/dev/ofw/ofnet.c (revision 37b34d511dea595d3ba03a661cf3b775038ea5f8)
1 /*	$NetBSD: ofnet.c,v 1.29 2002/10/02 16:34:34 thorpej 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.29 2002/10/02 16:34:34 thorpej 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 (struct cfdata *, 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 (struct device *, struct cfdata *, void *);
88 static void ofnet_attach (struct device *, struct device *, 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, caddr_t);
100 static void ofnet_watchdog (struct ifnet *);
101 
102 static int
103 ofnet_match(struct device *parent, struct cfdata *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(struct device *parent, struct device *self, void *aux)
128 {
129 	struct ofnet_softc *of = (void *)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 == of->sc_dev.dv_unit &&
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);
156 
157 	bcopy(of->sc_dev.dv_xname, ifp->if_xname, 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[ETHERMTU + sizeof(struct ether_header)];
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 		if ((len = OF_read(of->sc_ihandle, buf, sizeof buf)) < 0) {
185 			if (len == -2 || len == 0)
186 				break;
187 			ifp->if_ierrors++;
188 			continue;
189 		}
190 		if (len < sizeof(struct ether_header)) {
191 			ifp->if_ierrors++;
192 			continue;
193 		}
194 		bufp = buf;
195 
196 		/* Allocate a header mbuf */
197 		MGETHDR(m, M_DONTWAIT, MT_DATA);
198 		if (m == 0) {
199 			ifp->if_ierrors++;
200 			continue;
201 		}
202 		m->m_pkthdr.rcvif = ifp;
203 		m->m_pkthdr.len = len;
204 
205 		/*
206 		 * We don't know if the interface included the FCS
207 		 * or not.  For now, assume that it did if we got
208 		 * a packet length that looks like it could include
209 		 * the FCS.
210  		 *
211 		 * XXX Yuck.
212 		 */
213 
214 		if (len > (ETHER_MAX_LEN - ETHER_CRC_LEN))
215 			m->m_flags |= M_HASFCS;
216 
217 		l = MHLEN;
218 		head = 0;
219 		mp = &head;
220 
221 		while (len > 0) {
222 			if (head) {
223 				MGET(m, M_DONTWAIT, MT_DATA);
224 				if (m == 0) {
225 					ifp->if_ierrors++;
226 					m_freem(head);
227 					head = 0;
228 					break;
229 				}
230 				l = MLEN;
231 			}
232 			if (len >= MINCLSIZE) {
233 				MCLGET(m, M_DONTWAIT);
234 				if ((m->m_flags & M_EXT) == 0) {
235 					ifp->if_ierrors++;
236 					m_free(m);
237 					m_freem(head);
238 					head = 0;
239 					break;
240 				}
241 				l = MCLBYTES;
242 			}
243 
244 			/*
245 			 * Make sure the data after the Ethernet header
246 			 * is aligned.
247 			 *
248 			 * XXX Assumes the device is an ethernet, but
249 			 * XXX then so does other code in this driver.
250 			 */
251 			if (head == NULL) {
252 				caddr_t newdata = (caddr_t)ALIGN(m->m_data +
253 				      sizeof(struct ether_header)) -
254 				    sizeof(struct ether_header);
255 				l -= newdata - m->m_data;
256 				m->m_data = newdata;
257 			}
258 
259 			m->m_len = l = min(len, l);
260 			bcopy(bufp, mtod(m, char *), l);
261 			bufp += l;
262 			len -= l;
263 			*mp = m;
264 			mp = &m->m_next;
265 		}
266 		if (head == 0)
267 			continue;
268 
269 #if NBPFILTER > 0
270 		if (ifp->if_bpf)
271 			bpf_mtap(ifp->if_bpf, m);
272 #endif
273 		ifp->if_ipackets++;
274 		(*ifp->if_input)(ifp, head);
275 	}
276 	splx(s);
277 }
278 
279 static void
280 ofnet_timer(arg)
281 	void *arg;
282 {
283 	struct ofnet_softc *of = arg;
284 
285 	ofnet_read(of);
286 	callout_reset(&of->sc_callout, 1, ofnet_timer, of);
287 }
288 
289 static void
290 ofnet_init(struct ofnet_softc *of)
291 {
292 	struct ifnet *ifp = &of->sc_ethercom.ec_if;
293 
294 	if (ifp->if_flags & IFF_RUNNING)
295 		return;
296 
297 	ifp->if_flags |= IFF_RUNNING;
298 	/* Start reading from interface */
299 	ofnet_timer(of);
300 	/* Attempt to start output */
301 	ofnet_start(ifp);
302 }
303 
304 static void
305 ofnet_stop(struct ofnet_softc *of)
306 {
307 	callout_stop(&of->sc_callout);
308 	of->sc_ethercom.ec_if.if_flags &= ~IFF_RUNNING;
309 }
310 
311 static void
312 ofnet_start(struct ifnet *ifp)
313 {
314 	struct ofnet_softc *of = ifp->if_softc;
315 	struct mbuf *m, *m0;
316 	char *bufp;
317 	int len;
318 
319 	if (!(ifp->if_flags & IFF_RUNNING))
320 		return;
321 
322 	for (;;) {
323 		/* First try reading any packets */
324 		ofnet_read(of);
325 
326 		/* Now get the first packet on the queue */
327 		IFQ_DEQUEUE(&ifp->if_snd, m0);
328 		if (!m0)
329 			return;
330 
331 		if (!(m0->m_flags & M_PKTHDR))
332 			panic("ofnet_start: no header mbuf");
333 		len = m0->m_pkthdr.len;
334 
335 #if NBPFILTER > 0
336 		if (ifp->if_bpf)
337 			bpf_mtap(ifp->if_bpf, m0);
338 #endif
339 
340 		if (len > ETHERMTU + sizeof(struct ether_header)) {
341 			/* packet too large, toss it */
342 			ifp->if_oerrors++;
343 			m_freem(m0);
344 			continue;
345 		}
346 
347 		for (bufp = buf; (m = m0) != NULL;) {
348 			bcopy(mtod(m, char *), bufp, m->m_len);
349 			bufp += m->m_len;
350 			MFREE(m, m0);
351 		}
352 
353 		/*
354 		 * We don't know if the interface will auto-pad for
355 		 * us, so make sure it's at least as large as a
356 		 * minimum size Ethernet packet.
357 		 */
358 
359 		if (len < (ETHER_MIN_LEN - ETHER_CRC_LEN))
360 			len = ETHER_MIN_LEN - ETHER_CRC_LEN;
361 		else
362 			len = bufp - buf;
363 
364 		if (OF_write(of->sc_ihandle, buf, len) != len)
365 			ifp->if_oerrors++;
366 		else
367 			ifp->if_opackets++;
368 	}
369 }
370 
371 static int
372 ofnet_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
373 {
374 	struct ofnet_softc *of = ifp->if_softc;
375 	struct ifaddr *ifa = (struct ifaddr *)data;
376 	/* struct ifreq *ifr = (struct ifreq *)data; */
377 	int error = 0;
378 
379 	switch (cmd) {
380 	case SIOCSIFADDR:
381 		ifp->if_flags |= IFF_UP;
382 
383 		switch (ifa->ifa_addr->sa_family) {
384 #ifdef	INET
385 		case AF_INET:
386 			arp_ifinit(ifp, ifa);
387 			break;
388 #endif
389 		default:
390 			break;
391 		}
392 		ofnet_init(of);
393 		break;
394 	case SIOCSIFFLAGS:
395 		if ((ifp->if_flags & IFF_UP) == 0 &&
396 		    (ifp->if_flags & IFF_RUNNING) != 0) {
397 			/* If interface is down, but running, stop it. */
398 			ofnet_stop(of);
399 		} else if ((ifp->if_flags & IFF_UP) != 0 &&
400 			   (ifp->if_flags & IFF_RUNNING) == 0) {
401 			/* If interface is up, but not running, start it. */
402 			ofnet_init(of);
403 		} else {
404 			/* Other flags are ignored. */
405 		}
406 		break;
407 	default:
408 		error = EINVAL;
409 		break;
410 	}
411 	return error;
412 }
413 
414 static void
415 ofnet_watchdog(struct ifnet *ifp)
416 {
417 	struct ofnet_softc *of = ifp->if_softc;
418 
419 	log(LOG_ERR, "%s: device timeout\n", of->sc_dev.dv_xname);
420 	ifp->if_oerrors++;
421 	ofnet_stop(of);
422 	ofnet_init(of);
423 }
424 
425 #if NIPKDB_OFN > 0
426 static void
427 ipkdbofstart(struct ipkdb_if *kip)
428 {
429 	int unit = kip->unit - 1;
430 
431 	if (ipkdb_of)
432 		ipkdbattach(kip, &ipkdb_of->sc_ethercom);
433 }
434 
435 static void
436 ipkdbofleave(struct ipkdb_if *kip)
437 {
438 }
439 
440 static int
441 ipkdbofrcv(struct ipkdb_if *kip, u_char *buf, int poll)
442 {
443 	int l;
444 
445 	do {
446 		l = OF_read(kip->port, buf, ETHERMTU);
447 		if (l < 0)
448 			l = 0;
449 	} while (!poll && !l);
450 	return l;
451 }
452 
453 static void
454 ipkdbofsend(struct ipkdb_if *kip, u_char *buf, int l)
455 {
456 	OF_write(kip->port, buf, l);
457 }
458 
459 static int
460 ipkdbprobe(struct cfdata *match, void *aux)
461 {
462 	struct ipkdb_if *kip = aux;
463 	static char name[256];
464 	int len;
465 	int phandle;
466 
467 	kip->unit = match->cf_unit + 1;
468 
469 	if (!(kip->port = OF_open("net")))
470 		return -1;
471 	if ((len = OF_instance_to_path(kip->port, name, sizeof name - 1)) < 0 ||
472 	    len >= sizeof name)
473 		return -1;
474 	name[len] = 0;
475 	if ((phandle = OF_instance_to_package(kip->port)) == -1)
476 		return -1;
477 	if (OF_getprop(phandle, "mac-address", kip->myenetaddr,
478 	    sizeof kip->myenetaddr) < 0)
479 		return -1;
480 
481 	kip->flags |= IPKDB_MYHW;
482 	kip->name = name;
483 	kip->start = ipkdbofstart;
484 	kip->leave = ipkdbofleave;
485 	kip->receive = ipkdbofrcv;
486 	kip->send = ipkdbofsend;
487 
488 	kifp = kip;
489 
490 	return 0;
491 }
492 #endif
493