xref: /netbsd-src/sys/dev/scsipi/if_se.c (revision da9817918ec7e88db2912a2882967c7570a83f47)
1 /*	$NetBSD: if_se.c,v 1.78 2009/05/12 14:44:31 cegger Exp $	*/
2 
3 /*
4  * Copyright (c) 1997 Ian W. Dall <ian.dall@dsto.defence.gov.au>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Ian W. Dall.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Driver for Cabletron EA41x scsi ethernet adaptor.
35  *
36  * Written by Ian Dall <ian.dall@dsto.defence.gov.au> Feb 3, 1997
37  *
38  * Acknowledgement: Thanks are due to Philip L. Budne <budd@cs.bu.edu>
39  * who reverse engineered the EA41x. In developing this code,
40  * Phil's userland daemon "etherd", was refered to extensively in lieu
41  * of accurate documentation for the device.
42  *
43  * This is a weird device! It doesn't conform to the scsi spec in much
44  * at all. About the only standard command supported is inquiry. Most
45  * commands are 6 bytes long, but the recv data is only 1 byte.  Data
46  * must be received by periodically polling the device with the recv
47  * command.
48  *
49  * This driver is also a bit unusual. It must look like a network
50  * interface and it must also appear to be a scsi device to the scsi
51  * system. Hence there are cases where there are two entry points. eg
52  * sestart is to be called from the scsi subsytem and se_ifstart from
53  * the network interface subsystem.  In addition, to facilitate scsi
54  * commands issued by userland programs, there are open, close and
55  * ioctl entry points. This allows a user program to, for example,
56  * display the ea41x stats and download new code into the adaptor ---
57  * functions which can't be performed through the ifconfig interface.
58  * Normal operation does not require any special userland program.
59  */
60 
61 #include <sys/cdefs.h>
62 __KERNEL_RCSID(0, "$NetBSD: if_se.c,v 1.78 2009/05/12 14:44:31 cegger Exp $");
63 
64 #include "opt_inet.h"
65 #include "opt_atalk.h"
66 #include "bpfilter.h"
67 
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/callout.h>
71 #include <sys/syslog.h>
72 #include <sys/kernel.h>
73 #include <sys/file.h>
74 #include <sys/stat.h>
75 #include <sys/ioctl.h>
76 #include <sys/buf.h>
77 #include <sys/uio.h>
78 #include <sys/malloc.h>
79 #include <sys/errno.h>
80 #include <sys/device.h>
81 #include <sys/disklabel.h>
82 #include <sys/disk.h>
83 #include <sys/proc.h>
84 #include <sys/conf.h>
85 
86 #include <dev/scsipi/scsipi_all.h>
87 #include <dev/scsipi/scsi_ctron_ether.h>
88 #include <dev/scsipi/scsiconf.h>
89 
90 #include <sys/mbuf.h>
91 
92 #include <sys/socket.h>
93 #include <net/if.h>
94 #include <net/if_dl.h>
95 #include <net/if_ether.h>
96 #include <net/if_media.h>
97 
98 #ifdef INET
99 #include <netinet/in.h>
100 #include <netinet/if_inarp.h>
101 #endif
102 
103 
104 #ifdef NETATALK
105 #include <netatalk/at.h>
106 #endif
107 
108 
109 #if NBPFILTER > 0
110 #include <net/bpf.h>
111 #include <net/bpfdesc.h>
112 #endif
113 
114 #define SETIMEOUT	1000
115 #define	SEOUTSTANDING	4
116 #define	SERETRIES	4
117 #define SE_PREFIX	4
118 #define ETHER_CRC	4
119 #define SEMINSIZE	60
120 
121 /* Make this big enough for an ETHERMTU packet in promiscuous mode. */
122 #define MAX_SNAP	(ETHERMTU + sizeof(struct ether_header) + \
123 			 SE_PREFIX + ETHER_CRC)
124 
125 /* 10 full length packets appears to be the max ever returned. 16k is OK */
126 #define RBUF_LEN	(16 * 1024)
127 
128 /* Tuning parameters:
129  * The EA41x only returns a maximum of 10 packets (regardless of size).
130  * We will attempt to adapt to polling fast enough to get RDATA_GOAL packets
131  * per read
132  */
133 #define RDATA_MAX 10
134 #define RDATA_GOAL 8
135 
136 /* se_poll and se_poll0 are the normal polling rate and the minimum
137  * polling rate respectively. se_poll0 should be chosen so that at
138  * maximum ethernet speed, we will read nearly RDATA_MAX packets. se_poll
139  * should be chosen for reasonable maximum latency.
140  * In practice, if we are being saturated with min length packets, we
141  * can't poll fast enough. Polling with zero delay actually
142  * worsens performance. se_poll0 is enforced to be always at least 1
143  */
144 #define SE_POLL 40		/* default in milliseconds */
145 #define SE_POLL0 10		/* default in milliseconds */
146 int se_poll = 0;		/* Delay in ticks set at attach time */
147 int se_poll0 = 0;
148 int se_max_received = 0;	/* Instrumentation */
149 
150 #define	PROTOCMD(p, d) \
151 	((d) = (p))
152 
153 #define	PROTOCMD_DECL(name) \
154 	static const struct scsi_ctron_ether_generic name
155 
156 #define	PROTOCMD_DECL_SPECIAL(name) \
157 	static const struct __CONCAT(scsi_,name) name
158 
159 /* Command initializers for commands using scsi_ctron_ether_generic */
160 PROTOCMD_DECL(ctron_ether_send)  = {CTRON_ETHER_SEND, 0, {0,0}, 0};
161 PROTOCMD_DECL(ctron_ether_add_proto) = {CTRON_ETHER_ADD_PROTO, 0, {0,0}, 0};
162 PROTOCMD_DECL(ctron_ether_get_addr) = {CTRON_ETHER_GET_ADDR, 0, {0,0}, 0};
163 PROTOCMD_DECL(ctron_ether_set_media) = {CTRON_ETHER_SET_MEDIA, 0, {0,0}, 0};
164 PROTOCMD_DECL(ctron_ether_set_addr) = {CTRON_ETHER_SET_ADDR, 0, {0,0}, 0};
165 PROTOCMD_DECL(ctron_ether_set_multi) = {CTRON_ETHER_SET_MULTI, 0, {0,0}, 0};
166 PROTOCMD_DECL(ctron_ether_remove_multi) =
167     {CTRON_ETHER_REMOVE_MULTI, 0, {0,0}, 0};
168 
169 /* Command initializers for commands using their own structures */
170 PROTOCMD_DECL_SPECIAL(ctron_ether_recv) = {CTRON_ETHER_RECV};
171 PROTOCMD_DECL_SPECIAL(ctron_ether_set_mode) =
172     {CTRON_ETHER_SET_MODE, 0, {0,0}, 0};
173 
174 struct se_softc {
175 	struct device sc_dev;
176 	struct ethercom sc_ethercom;	/* Ethernet common part */
177 	struct scsipi_periph *sc_periph;/* contains our targ, lun, etc. */
178 
179 	struct callout sc_ifstart_ch;
180 	struct callout sc_recv_ch;
181 
182 	char *sc_tbuf;
183 	char *sc_rbuf;
184 	int protos;
185 #define PROTO_IP	0x01
186 #define PROTO_ARP	0x02
187 #define PROTO_REVARP	0x04
188 #define PROTO_AT	0x08
189 #define PROTO_AARP	0x10
190 	int sc_debug;
191 	int sc_flags;
192 #define SE_NEED_RECV 0x1
193 	int sc_last_timeout;
194 	int sc_enabled;
195 };
196 
197 static int	sematch(device_t, cfdata_t, void *);
198 static void	seattach(device_t, device_t, void *);
199 
200 static void	se_ifstart(struct ifnet *);
201 static void	sestart(struct scsipi_periph *);
202 
203 static void	sedone(struct scsipi_xfer *, int);
204 static int	se_ioctl(struct ifnet *, u_long, void *);
205 static void	sewatchdog(struct ifnet *);
206 
207 static inline u_int16_t ether_cmp(void *, void *);
208 static void	se_recv(void *);
209 static struct mbuf *se_get(struct se_softc *, char *, int);
210 static int	se_read(struct se_softc *, char *, int);
211 static int	se_reset(struct se_softc *);
212 static int	se_add_proto(struct se_softc *, int);
213 static int	se_get_addr(struct se_softc *, u_int8_t *);
214 static int	se_set_media(struct se_softc *, int);
215 static int	se_init(struct se_softc *);
216 static int	se_set_multi(struct se_softc *, u_int8_t *);
217 static int	se_remove_multi(struct se_softc *, u_int8_t *);
218 #if 0
219 static int	sc_set_all_multi(struct se_softc *, int);
220 #endif
221 static void	se_stop(struct se_softc *);
222 static inline int se_scsipi_cmd(struct scsipi_periph *periph,
223 			struct scsipi_generic *scsipi_cmd,
224 			int cmdlen, u_char *data_addr, int datalen,
225 			int retries, int timeout, struct buf *bp,
226 			int flags);
227 static void	se_delayed_ifstart(void *);
228 static int	se_set_mode(struct se_softc *, int, int);
229 
230 int	se_enable(struct se_softc *);
231 void	se_disable(struct se_softc *);
232 
233 CFATTACH_DECL(se, sizeof(struct se_softc),
234     sematch, seattach, NULL, NULL);
235 
236 extern struct cfdriver se_cd;
237 
238 dev_type_open(seopen);
239 dev_type_close(seclose);
240 dev_type_ioctl(seioctl);
241 
242 const struct cdevsw se_cdevsw = {
243 	seopen, seclose, noread, nowrite, seioctl,
244 	nostop, notty, nopoll, nommap, nokqfilter, D_OTHER
245 };
246 
247 const struct scsipi_periphsw se_switch = {
248 	NULL,			/* Use default error handler */
249 	sestart,		/* have a queue, served by this */
250 	NULL,			/* have no async handler */
251 	sedone,			/* deal with stats at interrupt time */
252 };
253 
254 const struct scsipi_inquiry_pattern se_patterns[] = {
255 	{T_PROCESSOR, T_FIXED,
256 	 "CABLETRN",         "EA412",                 ""},
257 	{T_PROCESSOR, T_FIXED,
258 	 "Cabletrn",         "EA412",                 ""},
259 };
260 
261 /*
262  * Compare two Ether/802 addresses for equality, inlined and
263  * unrolled for speed.
264  * Note: use this like memcmp()
265  */
266 static inline u_int16_t
267 ether_cmp(void *one, void *two)
268 {
269 	u_int16_t *a = (u_int16_t *) one;
270 	u_int16_t *b = (u_int16_t *) two;
271 	u_int16_t diff;
272 
273 	diff = (a[0] - b[0]) | (a[1] - b[1]) | (a[2] - b[2]);
274 
275 	return (diff);
276 }
277 
278 #define ETHER_CMP	ether_cmp
279 
280 static int
281 sematch(device_t parent, cfdata_t match, void *aux)
282 {
283 	struct scsipibus_attach_args *sa = aux;
284 	int priority;
285 
286 	(void)scsipi_inqmatch(&sa->sa_inqbuf,
287 	    se_patterns, sizeof(se_patterns) / sizeof(se_patterns[0]),
288 	    sizeof(se_patterns[0]), &priority);
289 	return (priority);
290 }
291 
292 /*
293  * The routine called by the low level scsi routine when it discovers
294  * a device suitable for this driver.
295  */
296 static void
297 seattach(device_t parent, device_t self, void *aux)
298 {
299 	struct se_softc *sc = device_private(self);
300 	struct scsipibus_attach_args *sa = aux;
301 	struct scsipi_periph *periph = sa->sa_periph;
302 	struct ifnet *ifp = &sc->sc_ethercom.ec_if;
303 	u_int8_t myaddr[ETHER_ADDR_LEN];
304 
305 	printf("\n");
306 	SC_DEBUG(periph, SCSIPI_DB2, ("seattach: "));
307 
308 	callout_init(&sc->sc_ifstart_ch, 0);
309 	callout_init(&sc->sc_recv_ch, 0);
310 
311 
312 	/*
313 	 * Store information needed to contact our base driver
314 	 */
315 	sc->sc_periph = periph;
316 	periph->periph_dev = &sc->sc_dev;
317 	periph->periph_switch = &se_switch;
318 
319 	/* XXX increase openings? */
320 
321 	se_poll = (SE_POLL * hz) / 1000;
322 	se_poll = se_poll? se_poll: 1;
323 	se_poll0 = (SE_POLL0 * hz) / 1000;
324 	se_poll0 = se_poll0? se_poll0: 1;
325 
326 	/*
327 	 * Initialize and attach a buffer
328 	 */
329 	sc->sc_tbuf = malloc(ETHERMTU + sizeof(struct ether_header),
330 			     M_DEVBUF, M_NOWAIT);
331 	if (sc->sc_tbuf == 0)
332 		panic("seattach: can't allocate transmit buffer");
333 
334 	sc->sc_rbuf = malloc(RBUF_LEN, M_DEVBUF, M_NOWAIT);/* A Guess */
335 	if (sc->sc_rbuf == 0)
336 		panic("seattach: can't allocate receive buffer");
337 
338 	se_get_addr(sc, myaddr);
339 
340 	/* Initialize ifnet structure. */
341 	strlcpy(ifp->if_xname, device_xname(&sc->sc_dev), sizeof(ifp->if_xname));
342 	ifp->if_softc = sc;
343 	ifp->if_start = se_ifstart;
344 	ifp->if_ioctl = se_ioctl;
345 	ifp->if_watchdog = sewatchdog;
346 	ifp->if_flags =
347 	    IFF_BROADCAST | IFF_SIMPLEX | IFF_NOTRAILERS | IFF_MULTICAST;
348 	IFQ_SET_READY(&ifp->if_snd);
349 
350 	/* Attach the interface. */
351 	if_attach(ifp);
352 	ether_ifattach(ifp, myaddr);
353 }
354 
355 
356 static inline int
357 se_scsipi_cmd(periph, cmd, cmdlen, data_addr, datalen,
358 		       retries, timeout, bp, flags)
359 	struct scsipi_periph *periph;
360 	struct scsipi_generic *cmd;
361 	int cmdlen;
362 	u_char *data_addr;
363 	int datalen;
364 	int retries;
365 	int timeout;
366 	struct buf *bp;
367 	int flags;
368 {
369 	int error;
370 	int s = splbio();
371 
372 	error = scsipi_command(periph, cmd, cmdlen, data_addr,
373 	    datalen, retries, timeout, bp, flags);
374 	splx(s);
375 	return (error);
376 }
377 
378 /* Start routine for calling from scsi sub system */
379 static void
380 sestart(struct scsipi_periph *periph)
381 {
382 	struct se_softc *sc = (void *)periph->periph_dev;
383 	struct ifnet *ifp = &sc->sc_ethercom.ec_if;
384 	int s = splnet();
385 
386 	se_ifstart(ifp);
387 	(void) splx(s);
388 }
389 
390 static void
391 se_delayed_ifstart(void *v)
392 {
393 	struct ifnet *ifp = v;
394 	struct se_softc *sc = ifp->if_softc;
395 	int s;
396 
397 	s = splnet();
398 	if (sc->sc_enabled) {
399 		ifp->if_flags &= ~IFF_OACTIVE;
400 		se_ifstart(ifp);
401 	}
402 	splx(s);
403 }
404 
405 /*
406  * Start transmission on the interface.
407  * Always called at splnet().
408  */
409 static void
410 se_ifstart(struct ifnet *ifp)
411 {
412 	struct se_softc *sc = ifp->if_softc;
413 	struct scsi_ctron_ether_generic send_cmd;
414 	struct mbuf *m, *m0;
415 	int len, error;
416 	u_char *cp;
417 
418 	/* Don't transmit if interface is busy or not running */
419 	if ((ifp->if_flags & (IFF_RUNNING|IFF_OACTIVE)) != IFF_RUNNING)
420 		return;
421 
422 	IFQ_DEQUEUE(&ifp->if_snd, m0);
423 	if (m0 == 0)
424 		return;
425 #if NBPFILTER > 0
426 	/* If BPF is listening on this interface, let it see the
427 	 * packet before we commit it to the wire.
428 	 */
429 	if (ifp->if_bpf)
430 		bpf_mtap(ifp->if_bpf, m0);
431 #endif
432 
433 	/* We need to use m->m_pkthdr.len, so require the header */
434 	if ((m0->m_flags & M_PKTHDR) == 0)
435 		panic("ctscstart: no header mbuf");
436 	len = m0->m_pkthdr.len;
437 
438 	/* Mark the interface busy. */
439 	ifp->if_flags |= IFF_OACTIVE;
440 
441 	/* Chain; copy into linear buffer we allocated at attach time. */
442 	cp = sc->sc_tbuf;
443 	for (m = m0; m != NULL; ) {
444 		memcpy(cp, mtod(m, u_char *), m->m_len);
445 		cp += m->m_len;
446 		MFREE(m, m0);
447 		m = m0;
448 	}
449 	if (len < SEMINSIZE) {
450 #ifdef SEDEBUG
451 		if (sc->sc_debug)
452 			printf("se: packet size %d (%d) < %d\n", len,
453 			    cp - (u_char *)sc->sc_tbuf, SEMINSIZE);
454 #endif
455 		memset(cp, 0, SEMINSIZE - len);
456 		len = SEMINSIZE;
457 	}
458 
459 	/* Fill out SCSI command. */
460 	PROTOCMD(ctron_ether_send, send_cmd);
461 	_lto2b(len, send_cmd.length);
462 
463 	/* Send command to device. */
464 	error = se_scsipi_cmd(sc->sc_periph,
465 	    (void *)&send_cmd, sizeof(send_cmd),
466 	    sc->sc_tbuf, len, SERETRIES,
467 	    SETIMEOUT, NULL, XS_CTL_NOSLEEP|XS_CTL_ASYNC|XS_CTL_DATA_OUT);
468 	if (error) {
469 		aprint_error_dev(&sc->sc_dev, "not queued, error %d\n", error);
470 		ifp->if_oerrors++;
471 		ifp->if_flags &= ~IFF_OACTIVE;
472 	} else
473 		ifp->if_opackets++;
474 	if (sc->sc_flags & SE_NEED_RECV) {
475 		sc->sc_flags &= ~SE_NEED_RECV;
476 		se_recv((void *) sc);
477 	}
478 }
479 
480 
481 /*
482  * Called from the scsibus layer via our scsi device switch.
483  */
484 static void
485 sedone(struct scsipi_xfer *xs, int error)
486 {
487 	struct se_softc *sc = (void *)xs->xs_periph->periph_dev;
488 	struct scsipi_generic *cmd = xs->cmd;
489 	struct ifnet *ifp = &sc->sc_ethercom.ec_if;
490 	int s;
491 
492 	s = splnet();
493 	if(IS_SEND(cmd)) {
494 		if (xs->error == XS_BUSY) {
495 			printf("se: busy, retry txmit\n");
496 			callout_reset(&sc->sc_ifstart_ch, hz,
497 			    se_delayed_ifstart, ifp);
498 		} else {
499 			ifp->if_flags &= ~IFF_OACTIVE;
500 			/* the generic scsipi_done will call
501 			 * sestart (through scsipi_free_xs).
502 			 */
503 		}
504 	} else if(IS_RECV(cmd)) {
505 		/* RECV complete */
506 		/* pass data up. reschedule a recv */
507 		/* scsipi_free_xs will call start. Harmless. */
508 		if (error) {
509 			/* Reschedule after a delay */
510 			callout_reset(&sc->sc_recv_ch, se_poll,
511 			    se_recv, (void *)sc);
512 		} else {
513 			int n, ntimeo;
514 			n = se_read(sc, xs->data, xs->datalen - xs->resid);
515 			if (n > se_max_received)
516 				se_max_received = n;
517 			if (n == 0)
518 				ntimeo = se_poll;
519 			else if (n >= RDATA_MAX)
520 				ntimeo = se_poll0;
521 			else {
522 				ntimeo = sc->sc_last_timeout;
523 				ntimeo = (ntimeo * RDATA_GOAL)/n;
524 				ntimeo = (ntimeo < se_poll0?
525 					  se_poll0: ntimeo);
526 				ntimeo = (ntimeo > se_poll?
527 					  se_poll: ntimeo);
528 			}
529 			sc->sc_last_timeout = ntimeo;
530 			if (ntimeo == se_poll0  &&
531 			    IFQ_IS_EMPTY(&ifp->if_snd) == 0)
532 				/* Output is pending. Do next recv
533 				 * after the next send.  */
534 				sc->sc_flags |= SE_NEED_RECV;
535 			else {
536 				callout_reset(&sc->sc_recv_ch, ntimeo,
537 				    se_recv, (void *)sc);
538   			}
539 		}
540 	}
541 	splx(s);
542 }
543 
544 static void
545 se_recv(void *v)
546 {
547 	/* do a recv command */
548 	struct se_softc *sc = (struct se_softc *) v;
549 	struct scsi_ctron_ether_recv recv_cmd;
550 	int error;
551 
552 	if (sc->sc_enabled == 0)
553 		return;
554 
555 	PROTOCMD(ctron_ether_recv, recv_cmd);
556 
557 	error = se_scsipi_cmd(sc->sc_periph,
558 	    (void *)&recv_cmd, sizeof(recv_cmd),
559 	    sc->sc_rbuf, RBUF_LEN, SERETRIES, SETIMEOUT, NULL,
560 	    XS_CTL_NOSLEEP|XS_CTL_ASYNC|XS_CTL_DATA_IN);
561 	if (error)
562 		callout_reset(&sc->sc_recv_ch, se_poll, se_recv, (void *)sc);
563 }
564 
565 /*
566  * We copy the data into mbufs.  When full cluster sized units are present
567  * we copy into clusters.
568  */
569 static struct mbuf *
570 se_get(struct se_softc *sc, char *data, int totlen)
571 {
572 	struct ifnet *ifp = &sc->sc_ethercom.ec_if;
573 	struct mbuf *m, *m0, *newm;
574 	int len;
575 
576 	MGETHDR(m0, M_DONTWAIT, MT_DATA);
577 	if (m0 == 0)
578 		return (0);
579 	m0->m_pkthdr.rcvif = ifp;
580 	m0->m_pkthdr.len = totlen;
581 	len = MHLEN;
582 	m = m0;
583 
584 	while (totlen > 0) {
585 		if (totlen >= MINCLSIZE) {
586 			MCLGET(m, M_DONTWAIT);
587 			if ((m->m_flags & M_EXT) == 0)
588 				goto bad;
589 			len = MCLBYTES;
590 		}
591 
592 		if (m == m0) {
593 			char *newdata = (char *)
594 			    ALIGN(m->m_data + sizeof(struct ether_header)) -
595 			    sizeof(struct ether_header);
596 			len -= newdata - m->m_data;
597 			m->m_data = newdata;
598 		}
599 
600 		m->m_len = len = min(totlen, len);
601 		memcpy(mtod(m, void *), data, len);
602 		data += len;
603 
604 		totlen -= len;
605 		if (totlen > 0) {
606 			MGET(newm, M_DONTWAIT, MT_DATA);
607 			if (newm == 0)
608 				goto bad;
609 			len = MLEN;
610 			m = m->m_next = newm;
611 		}
612 	}
613 
614 	return (m0);
615 
616 bad:
617 	m_freem(m0);
618 	return (0);
619 }
620 
621 /*
622  * Pass packets to higher levels.
623  */
624 static int
625 se_read(struct se_softc *sc, char *data, int datalen)
626 {
627 	struct mbuf *m;
628 	struct ifnet *ifp = &sc->sc_ethercom.ec_if;
629 	int n;
630 
631 	n = 0;
632 	while (datalen >= 2) {
633 		int len = _2btol(data);
634 		data += 2;
635 		datalen -= 2;
636 
637 		if (len == 0)
638 			break;
639 #ifdef SEDEBUG
640 		if (sc->sc_debug) {
641 			printf("se_read: datalen = %d, packetlen = %d, proto = 0x%04x\n", datalen, len,
642 			 ntohs(((struct ether_header *)data)->ether_type));
643 		}
644 #endif
645 		if (len <= sizeof(struct ether_header) ||
646 		    len > MAX_SNAP) {
647 #ifdef SEDEBUG
648 			printf("%s: invalid packet size %d; dropping\n",
649 			       device_xname(&sc->sc_dev), len);
650 #endif
651 			ifp->if_ierrors++;
652 			goto next_packet;
653 		}
654 
655 		/* Don't need crc. Must keep ether header for BPF */
656 		m = se_get(sc, data, len - ETHER_CRC);
657 		if (m == 0) {
658 #ifdef SEDEBUG
659 			if (sc->sc_debug)
660 				printf("se_read: se_get returned null\n");
661 #endif
662 			ifp->if_ierrors++;
663 			goto next_packet;
664 		}
665 		if ((ifp->if_flags & IFF_PROMISC) != 0) {
666 			m_adj(m, SE_PREFIX);
667 		}
668 		ifp->if_ipackets++;
669 
670 #if NBPFILTER > 0
671 		/*
672 		 * Check if there's a BPF listener on this interface.
673 		 * If so, hand off the raw packet to BPF.
674 		 */
675 		if (ifp->if_bpf)
676 			bpf_mtap(ifp->if_bpf, m);
677 #endif
678 
679 		/* Pass the packet up. */
680 		(*ifp->if_input)(ifp, m);
681 
682 	next_packet:
683 		data += len;
684 		datalen -= len;
685 		n++;
686 	}
687 	return (n);
688 }
689 
690 
691 static void
692 sewatchdog(struct ifnet *ifp)
693 {
694 	struct se_softc *sc = ifp->if_softc;
695 
696 	log(LOG_ERR, "%s: device timeout\n", device_xname(&sc->sc_dev));
697 	++ifp->if_oerrors;
698 
699 	se_reset(sc);
700 }
701 
702 static int
703 se_reset(struct se_softc *sc)
704 {
705 	int error;
706 	int s = splnet();
707 #if 0
708 	/* Maybe we don't *really* want to reset the entire bus
709 	 * because the ctron isn't working. We would like to send a
710 	 * "BUS DEVICE RESET" message, but don't think the ctron
711 	 * understands it.
712 	 */
713 	error = se_scsipi_cmd(sc->sc_periph, 0, 0, 0, 0, SERETRIES, 2000, NULL,
714 	    XS_CTL_RESET);
715 #endif
716 	error = se_init(sc);
717 	splx(s);
718 	return (error);
719 }
720 
721 static int
722 se_add_proto(struct se_softc *sc, int proto)
723 {
724 	int error;
725 	struct scsi_ctron_ether_generic add_proto_cmd;
726 	u_int8_t data[2];
727 	_lto2b(proto, data);
728 #ifdef SEDEBUG
729 	if (sc->sc_debug)
730 		printf("se: adding proto 0x%02x%02x\n", data[0], data[1]);
731 #endif
732 
733 	PROTOCMD(ctron_ether_add_proto, add_proto_cmd);
734 	_lto2b(sizeof(data), add_proto_cmd.length);
735 	error = se_scsipi_cmd(sc->sc_periph,
736 	    (void *)&add_proto_cmd, sizeof(add_proto_cmd),
737 	    data, sizeof(data), SERETRIES, SETIMEOUT, NULL,
738 	    XS_CTL_DATA_OUT | XS_CTL_DATA_ONSTACK);
739 	return (error);
740 }
741 
742 static int
743 se_get_addr(struct se_softc *sc, u_int8_t *myaddr)
744 {
745 	int error;
746 	struct scsi_ctron_ether_generic get_addr_cmd;
747 
748 	PROTOCMD(ctron_ether_get_addr, get_addr_cmd);
749 	_lto2b(ETHER_ADDR_LEN, get_addr_cmd.length);
750 	error = se_scsipi_cmd(sc->sc_periph,
751 	    (void *)&get_addr_cmd, sizeof(get_addr_cmd),
752 	    myaddr, ETHER_ADDR_LEN, SERETRIES, SETIMEOUT, NULL,
753 	    XS_CTL_DATA_IN | XS_CTL_DATA_ONSTACK);
754 	printf("%s: ethernet address %s\n", device_xname(&sc->sc_dev),
755 	    ether_sprintf(myaddr));
756 	return (error);
757 }
758 
759 
760 static int
761 se_set_media(struct se_softc *sc, int type)
762 {
763 	int error;
764 	struct scsi_ctron_ether_generic set_media_cmd;
765 
766 	PROTOCMD(ctron_ether_set_media, set_media_cmd);
767 	set_media_cmd.byte3 = type;
768 	error = se_scsipi_cmd(sc->sc_periph,
769 	    (void *)&set_media_cmd, sizeof(set_media_cmd),
770 	    0, 0, SERETRIES, SETIMEOUT, NULL, 0);
771 	return (error);
772 }
773 
774 static int
775 se_set_mode(struct se_softc *sc, int len, int mode)
776 {
777 	int error;
778 	struct scsi_ctron_ether_set_mode set_mode_cmd;
779 
780 	PROTOCMD(ctron_ether_set_mode, set_mode_cmd);
781 	set_mode_cmd.mode = mode;
782 	_lto2b(len, set_mode_cmd.length);
783 	error = se_scsipi_cmd(sc->sc_periph,
784 	    (void *)&set_mode_cmd, sizeof(set_mode_cmd),
785 	    0, 0, SERETRIES, SETIMEOUT, NULL, 0);
786 	return (error);
787 }
788 
789 
790 static int
791 se_init(struct se_softc *sc)
792 {
793 	struct ifnet *ifp = &sc->sc_ethercom.ec_if;
794 	struct scsi_ctron_ether_generic set_addr_cmd;
795 	uint8_t enaddr[ETHER_ADDR_LEN];
796 	int error;
797 
798 #if NBPFILTER > 0
799 	if (ifp->if_flags & IFF_PROMISC) {
800 		error = se_set_mode(sc, MAX_SNAP, 1);
801 	}
802 	else
803 #endif
804 		error = se_set_mode(sc, ETHERMTU + sizeof(struct ether_header),
805 		    0);
806 	if (error != 0)
807 		return (error);
808 
809 	PROTOCMD(ctron_ether_set_addr, set_addr_cmd);
810 	_lto2b(ETHER_ADDR_LEN, set_addr_cmd.length);
811 	memcpy(enaddr, CLLADDR(ifp->if_sadl), sizeof(enaddr));
812 	error = se_scsipi_cmd(sc->sc_periph,
813 	    (void *)&set_addr_cmd, sizeof(set_addr_cmd),
814 	    enaddr, ETHER_ADDR_LEN, SERETRIES, SETIMEOUT, NULL,
815 	    XS_CTL_DATA_OUT);
816 	if (error != 0)
817 		return (error);
818 
819 	if ((sc->protos & PROTO_IP) &&
820 	    (error = se_add_proto(sc, ETHERTYPE_IP)) != 0)
821 		return (error);
822 	if ((sc->protos & PROTO_ARP) &&
823 	    (error = se_add_proto(sc, ETHERTYPE_ARP)) != 0)
824 		return (error);
825 	if ((sc->protos & PROTO_REVARP) &&
826 	    (error = se_add_proto(sc, ETHERTYPE_REVARP)) != 0)
827 		return (error);
828 #ifdef NETATALK
829 	if ((sc->protos & PROTO_AT) &&
830 	    (error = se_add_proto(sc, ETHERTYPE_ATALK)) != 0)
831 		return (error);
832 	if ((sc->protos & PROTO_AARP) &&
833 	    (error = se_add_proto(sc, ETHERTYPE_AARP)) != 0)
834 		return (error);
835 #endif
836 
837 	if ((ifp->if_flags & (IFF_RUNNING|IFF_UP)) == IFF_UP) {
838 		ifp->if_flags |= IFF_RUNNING;
839 		se_recv(sc);
840 		ifp->if_flags &= ~IFF_OACTIVE;
841 		se_ifstart(ifp);
842 	}
843 	return (error);
844 }
845 
846 static int
847 se_set_multi(struct se_softc *sc, u_int8_t *addr)
848 {
849 	struct scsi_ctron_ether_generic set_multi_cmd;
850 	int error;
851 
852 	if (sc->sc_debug)
853 		printf("%s: set_set_multi: %s\n", device_xname(&sc->sc_dev),
854 		    ether_sprintf(addr));
855 
856 	PROTOCMD(ctron_ether_set_multi, set_multi_cmd);
857 	_lto2b(sizeof(addr), set_multi_cmd.length);
858 	/* XXX sizeof(addr) is the size of the pointer.  Surely it
859 	 * is too small? --dyoung
860 	 */
861 	error = se_scsipi_cmd(sc->sc_periph,
862 	    (void *)&set_multi_cmd, sizeof(set_multi_cmd),
863 	    addr, sizeof(addr), SERETRIES, SETIMEOUT, NULL, XS_CTL_DATA_OUT);
864 	return (error);
865 }
866 
867 static int
868 se_remove_multi(struct se_softc *sc, u_int8_t *addr)
869 {
870 	struct scsi_ctron_ether_generic remove_multi_cmd;
871 	int error;
872 
873 	if (sc->sc_debug)
874 		printf("%s: se_remove_multi: %s\n", device_xname(&sc->sc_dev),
875 		    ether_sprintf(addr));
876 
877 	PROTOCMD(ctron_ether_remove_multi, remove_multi_cmd);
878 	_lto2b(sizeof(addr), remove_multi_cmd.length);
879 	/* XXX sizeof(addr) is the size of the pointer.  Surely it
880 	 * is too small? --dyoung
881 	 */
882 	error = se_scsipi_cmd(sc->sc_periph,
883 	    (void *)&remove_multi_cmd, sizeof(remove_multi_cmd),
884 	    addr, sizeof(addr), SERETRIES, SETIMEOUT, NULL, XS_CTL_DATA_OUT);
885 	return (error);
886 }
887 
888 #if 0	/* not used  --thorpej */
889 static int
890 sc_set_all_multi(struct se_softc *sc, int set)
891 {
892 	int error = 0;
893 	u_int8_t *addr;
894 	struct ethercom *ac = &sc->sc_ethercom;
895 	struct ether_multi *enm;
896 	struct ether_multistep step;
897 
898 	ETHER_FIRST_MULTI(step, ac, enm);
899 	while (enm != NULL) {
900 		if (ETHER_CMP(enm->enm_addrlo, enm->enm_addrhi)) {
901 			/*
902 			 * We must listen to a range of multicast addresses.
903 			 * For now, just accept all multicasts, rather than
904 			 * trying to set only those filter bits needed to match
905 			 * the range.  (At this time, the only use of address
906 			 * ranges is for IP multicast routing, for which the
907 			 * range is big enough to require all bits set.)
908 			 */
909 			/* We have no way of adding a range to this device.
910 			 * stepping through all addresses in the range is
911 			 * typically not possible. The only real alternative
912 			 * is to go into promicuous mode and filter by hand.
913 			 */
914 			return (ENODEV);
915 
916 		}
917 
918 		addr = enm->enm_addrlo;
919 		if ((error = set ? se_set_multi(sc, addr) :
920 		    se_remove_multi(sc, addr)) != 0)
921 			return (error);
922 		ETHER_NEXT_MULTI(step, enm);
923 	}
924 	return (error);
925 }
926 #endif /* not used */
927 
928 static void
929 se_stop(struct se_softc *sc)
930 {
931 
932 	/* Don't schedule any reads */
933 	callout_stop(&sc->sc_recv_ch);
934 
935 	/* How can we abort any scsi cmds in progress? */
936 }
937 
938 
939 /*
940  * Process an ioctl request.
941  */
942 static int
943 se_ioctl(struct ifnet *ifp, u_long cmd, void *data)
944 {
945 	struct se_softc *sc = ifp->if_softc;
946 	struct ifaddr *ifa = (struct ifaddr *)data;
947 	struct ifreq *ifr = (struct ifreq *)data;
948 	struct sockaddr *sa;
949 	int s, error = 0;
950 
951 	s = splnet();
952 
953 	switch (cmd) {
954 
955 	case SIOCINITIFADDR:
956 		if ((error = se_enable(sc)) != 0)
957 			break;
958 		ifp->if_flags |= IFF_UP;
959 
960 		if ((error = se_set_media(sc, CMEDIA_AUTOSENSE) != 0))
961 			break;
962 
963 		switch (ifa->ifa_addr->sa_family) {
964 #ifdef INET
965 		case AF_INET:
966 			sc->protos |= (PROTO_IP | PROTO_ARP | PROTO_REVARP);
967 			if ((error = se_init(sc)) != 0)
968 				break;
969 			arp_ifinit(ifp, ifa);
970 			break;
971 #endif
972 #ifdef NETATALK
973 		case AF_APPLETALK:
974 			sc->protos |= (PROTO_AT | PROTO_AARP);
975 			if ((error = se_init(sc)) != 0)
976 				break;
977 			break;
978 #endif
979 		default:
980 			error = se_init(sc);
981 			break;
982 		}
983 		break;
984 
985 
986 	case SIOCSIFFLAGS:
987 		if ((error = ifioctl_common(ifp, cmd, data)) != 0)
988 			break;
989 		/* XXX re-use ether_ioctl() */
990 		switch (ifp->if_flags & (IFF_UP|IFF_RUNNING)) {
991 		case IFF_RUNNING:
992 			/*
993 			 * If interface is marked down and it is running, then
994 			 * stop it.
995 			 */
996 			se_stop(sc);
997 			ifp->if_flags &= ~IFF_RUNNING;
998 			se_disable(sc);
999 			break;
1000 		case IFF_UP:
1001 			/*
1002 			 * If interface is marked up and it is stopped, then
1003 			 * start it.
1004 			 */
1005 			if ((error = se_enable(sc)) != 0)
1006 				break;
1007 			error = se_init(sc);
1008 			break;
1009 		default:
1010 			/*
1011 			 * Reset the interface to pick up changes in any other
1012 			 * flags that affect hardware registers.
1013 			 */
1014 			if (sc->sc_enabled)
1015 				error = se_init(sc);
1016 			break;
1017 		}
1018 #ifdef SEDEBUG
1019 		if (ifp->if_flags & IFF_DEBUG)
1020 			sc->sc_debug = 1;
1021 		else
1022 			sc->sc_debug = 0;
1023 #endif
1024 		break;
1025 
1026 	case SIOCADDMULTI:
1027 	case SIOCDELMULTI:
1028 		sa = sockaddr_dup(ifreq_getaddr(cmd, ifr), M_NOWAIT);
1029 		if (sa == NULL) {
1030 			error = ENOBUFS;
1031 			break;
1032 		}
1033 		if ((error = ether_ioctl(ifp, cmd, data)) == ENETRESET) {
1034 			if (ifp->if_flags & IFF_RUNNING) {
1035 				error = (cmd == SIOCADDMULTI) ?
1036 				   se_set_multi(sc, sa->sa_data) :
1037 				   se_remove_multi(sc, sa->sa_data);
1038 			} else
1039 				error = 0;
1040 		}
1041 		sockaddr_free(sa);
1042 		break;
1043 
1044 	default:
1045 
1046 		error = ether_ioctl(ifp, cmd, data);
1047 		break;
1048 	}
1049 
1050 	splx(s);
1051 	return (error);
1052 }
1053 
1054 /*
1055  * Enable the network interface.
1056  */
1057 int
1058 se_enable(struct se_softc *sc)
1059 {
1060 	struct scsipi_periph *periph = sc->sc_periph;
1061 	struct scsipi_adapter *adapt = periph->periph_channel->chan_adapter;
1062 	int error = 0;
1063 
1064 	if (sc->sc_enabled == 0 &&
1065 	    (error = scsipi_adapter_addref(adapt)) == 0)
1066 		sc->sc_enabled = 1;
1067 	else
1068 		aprint_error_dev(&sc->sc_dev, "device enable failed\n");
1069 
1070 	return (error);
1071 }
1072 
1073 /*
1074  * Disable the network interface.
1075  */
1076 void
1077 se_disable(struct se_softc *sc)
1078 {
1079 	struct scsipi_periph *periph = sc->sc_periph;
1080 	struct scsipi_adapter *adapt = periph->periph_channel->chan_adapter;
1081 
1082 	if (sc->sc_enabled != 0) {
1083 		scsipi_adapter_delref(adapt);
1084 		sc->sc_enabled = 0;
1085 	}
1086 }
1087 
1088 #define	SEUNIT(z)	(minor(z))
1089 /*
1090  * open the device.
1091  */
1092 int
1093 seopen(dev_t dev, int flag, int fmt, struct lwp *l)
1094 {
1095 	int unit, error;
1096 	struct se_softc *sc;
1097 	struct scsipi_periph *periph;
1098 	struct scsipi_adapter *adapt;
1099 
1100 	unit = SEUNIT(dev);
1101 	sc = device_lookup_private(&se_cd, unit);
1102 	if (sc == NULL)
1103 		return (ENXIO);
1104 
1105 	periph = sc->sc_periph;
1106 	adapt = periph->periph_channel->chan_adapter;
1107 
1108 	if ((error = scsipi_adapter_addref(adapt)) != 0)
1109 		return (error);
1110 
1111 	SC_DEBUG(periph, SCSIPI_DB1,
1112 	    ("scopen: dev=0x%"PRIx64" (unit %d (of %d))\n", dev, unit,
1113 	    se_cd.cd_ndevs));
1114 
1115 	periph->periph_flags |= PERIPH_OPEN;
1116 
1117 	SC_DEBUG(periph, SCSIPI_DB3, ("open complete\n"));
1118 	return (0);
1119 }
1120 
1121 /*
1122  * close the device.. only called if we are the LAST
1123  * occurence of an open device
1124  */
1125 int
1126 seclose(dev_t dev, int flag, int fmt, struct lwp *l)
1127 {
1128 	struct se_softc *sc = device_lookup_private(&se_cd, SEUNIT(dev));
1129 	struct scsipi_periph *periph = sc->sc_periph;
1130 	struct scsipi_adapter *adapt = periph->periph_channel->chan_adapter;
1131 
1132 	SC_DEBUG(sc->sc_periph, SCSIPI_DB1, ("closing\n"));
1133 
1134 	scsipi_wait_drain(periph);
1135 
1136 	scsipi_adapter_delref(adapt);
1137 	periph->periph_flags &= ~PERIPH_OPEN;
1138 
1139 	return (0);
1140 }
1141 
1142 /*
1143  * Perform special action on behalf of the user
1144  * Only does generic scsi ioctls.
1145  */
1146 int
1147 seioctl(dev_t dev, u_long cmd, void *addr, int flag, struct lwp *l)
1148 {
1149 	struct se_softc *sc = device_lookup_private(&se_cd, SEUNIT(dev));
1150 
1151 	return (scsipi_do_ioctl(sc->sc_periph, dev, cmd, addr, flag, l));
1152 }
1153