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