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