xref: /netbsd-src/sys/dev/usb/ucom.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: ucom.c,v 1.60 2005/12/11 12:24:01 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1998, 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Lennart Augustsson (lennart@augustsson.net) at
9  * Carlstedt Research & Technology.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *        This product includes software developed by the NetBSD
22  *        Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 /*
40  * This code is very heavily based on the 16550 driver, com.c.
41  */
42 
43 #include <sys/cdefs.h>
44 __KERNEL_RCSID(0, "$NetBSD: ucom.c,v 1.60 2005/12/11 12:24:01 christos Exp $");
45 
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/kernel.h>
49 #include <sys/ioctl.h>
50 #include <sys/conf.h>
51 #include <sys/tty.h>
52 #include <sys/file.h>
53 #include <sys/select.h>
54 #include <sys/proc.h>
55 #include <sys/vnode.h>
56 #include <sys/device.h>
57 #include <sys/poll.h>
58 #if defined(__NetBSD__)
59 #include "rnd.h"
60 #if NRND > 0
61 #include <sys/rnd.h>
62 #endif
63 #endif
64 
65 #include <dev/usb/usb.h>
66 
67 #include <dev/usb/usbdi.h>
68 #include <dev/usb/usbdi_util.h>
69 #include <dev/usb/usbdevs.h>
70 #include <dev/usb/usb_quirks.h>
71 
72 #include <dev/usb/ucomvar.h>
73 
74 #include "ucom.h"
75 
76 #include "locators.h"
77 
78 #if NUCOM > 0
79 
80 #ifdef UCOM_DEBUG
81 #define DPRINTFN(n, x)	if (ucomdebug > (n)) logprintf x
82 int ucomdebug = 0;
83 #else
84 #define DPRINTFN(n, x)
85 #endif
86 #define DPRINTF(x) DPRINTFN(0, x)
87 
88 #define	UCOMUNIT_MASK		0x3ffff
89 #define	UCOMDIALOUT_MASK	0x80000
90 #define	UCOMCALLUNIT_MASK	0x40000
91 
92 #define	UCOMUNIT(x)		(minor(x) & UCOMUNIT_MASK)
93 #define	UCOMDIALOUT(x)		(minor(x) & UCOMDIALOUT_MASK)
94 #define	UCOMCALLUNIT(x)		(minor(x) & UCOMCALLUNIT_MASK)
95 
96 struct ucom_softc {
97 	USBBASEDEVICE		sc_dev;		/* base device */
98 
99 	usbd_device_handle	sc_udev;	/* USB device */
100 
101 	usbd_interface_handle	sc_iface;	/* data interface */
102 
103 	int			sc_bulkin_no;	/* bulk in endpoint address */
104 	usbd_pipe_handle	sc_bulkin_pipe;	/* bulk in pipe */
105 	usbd_xfer_handle	sc_ixfer;	/* read request */
106 	u_char			*sc_ibuf;	/* read buffer */
107 	u_int			sc_ibufsize;	/* read buffer size */
108 	u_int			sc_ibufsizepad;	/* read buffer size padded */
109 
110 	int			sc_bulkout_no;	/* bulk out endpoint address */
111 	usbd_pipe_handle	sc_bulkout_pipe;/* bulk out pipe */
112 	usbd_xfer_handle	sc_oxfer;	/* write request */
113 	u_char			*sc_obuf;	/* write buffer */
114 	u_int			sc_obufsize;	/* write buffer size */
115 	u_int			sc_opkthdrlen;	/* header length of
116 						 * output packet */
117 
118 	struct ucom_methods     *sc_methods;
119 	void                    *sc_parent;
120 	int			sc_portno;
121 
122 	struct tty		*sc_tty;	/* our tty */
123 	u_char			sc_lsr;
124 	u_char			sc_msr;
125 	u_char			sc_mcr;
126 	u_char			sc_tx_stopped;
127 	int			sc_swflags;
128 
129 	u_char			sc_opening;	/* lock during open */
130 	int			sc_refcnt;
131 	u_char			sc_dying;	/* disconnecting */
132 
133 #if defined(__NetBSD__) && NRND > 0
134 	rndsource_element_t	sc_rndsource;	/* random source */
135 #endif
136 };
137 
138 dev_type_open(ucomopen);
139 dev_type_close(ucomclose);
140 dev_type_read(ucomread);
141 dev_type_write(ucomwrite);
142 dev_type_ioctl(ucomioctl);
143 dev_type_stop(ucomstop);
144 dev_type_tty(ucomtty);
145 dev_type_poll(ucompoll);
146 
147 const struct cdevsw ucom_cdevsw = {
148 	ucomopen, ucomclose, ucomread, ucomwrite, ucomioctl,
149 	ucomstop, ucomtty, ucompoll, nommap, ttykqfilter, D_TTY
150 };
151 
152 Static void	ucom_cleanup(struct ucom_softc *);
153 Static void	ucom_hwiflow(struct ucom_softc *);
154 Static int	ucomparam(struct tty *, struct termios *);
155 Static void	ucomstart(struct tty *);
156 Static void	ucom_shutdown(struct ucom_softc *);
157 Static int	ucom_do_ioctl(struct ucom_softc *, u_long, caddr_t,
158 			      int, struct lwp *);
159 Static void	ucom_dtr(struct ucom_softc *, int);
160 Static void	ucom_rts(struct ucom_softc *, int);
161 Static void	ucom_break(struct ucom_softc *, int);
162 Static usbd_status ucomstartread(struct ucom_softc *);
163 Static void	ucomreadcb(usbd_xfer_handle, usbd_private_handle, usbd_status);
164 Static void	ucomwritecb(usbd_xfer_handle, usbd_private_handle, usbd_status);
165 Static void	tiocm_to_ucom(struct ucom_softc *, u_long, int);
166 Static int	ucom_to_tiocm(struct ucom_softc *);
167 
168 USB_DECLARE_DRIVER(ucom);
169 
170 USB_MATCH(ucom)
171 {
172 	return (1);
173 }
174 
175 USB_ATTACH(ucom)
176 {
177 	struct ucom_softc *sc = (struct ucom_softc *)self;
178 	struct ucom_attach_args *uca = aux;
179 	struct tty *tp;
180 
181 	if (uca->info != NULL)
182 		printf(": %s", uca->info);
183 	printf("\n");
184 
185 	sc->sc_udev = uca->device;
186 	sc->sc_iface = uca->iface;
187 	sc->sc_bulkout_no = uca->bulkout;
188 	sc->sc_bulkin_no = uca->bulkin;
189 	sc->sc_ibufsize = uca->ibufsize;
190 	sc->sc_ibufsizepad = uca->ibufsizepad;
191 	sc->sc_obufsize = uca->obufsize;
192 	sc->sc_opkthdrlen = uca->opkthdrlen;
193 	sc->sc_methods = uca->methods;
194 	sc->sc_parent = uca->arg;
195 	sc->sc_portno = uca->portno;
196 
197 	tp = ttymalloc();
198 	tp->t_oproc = ucomstart;
199 	tp->t_param = ucomparam;
200 	sc->sc_tty = tp;
201 
202 	DPRINTF(("ucom_attach: tty_attach %p\n", tp));
203 	tty_attach(tp);
204 
205 #if defined(__NetBSD__) && NRND > 0
206 	rnd_attach_source(&sc->sc_rndsource, USBDEVNAME(sc->sc_dev),
207 			  RND_TYPE_TTY, 0);
208 #endif
209 
210 	USB_ATTACH_SUCCESS_RETURN;
211 }
212 
213 USB_DETACH(ucom)
214 {
215 	struct ucom_softc *sc = (struct ucom_softc *)self;
216 	struct tty *tp = sc->sc_tty;
217 	int maj, mn;
218 	int s;
219 
220 	DPRINTF(("ucom_detach: sc=%p flags=%d tp=%p, pipe=%d,%d\n",
221 		 sc, flags, tp, sc->sc_bulkin_no, sc->sc_bulkout_no));
222 
223 	sc->sc_dying = 1;
224 
225 	if (sc->sc_bulkin_pipe != NULL)
226 		usbd_abort_pipe(sc->sc_bulkin_pipe);
227 	if (sc->sc_bulkout_pipe != NULL)
228 		usbd_abort_pipe(sc->sc_bulkout_pipe);
229 
230 	s = splusb();
231 	if (--sc->sc_refcnt >= 0) {
232 		/* Wake up anyone waiting */
233 		if (tp != NULL) {
234 			CLR(tp->t_state, TS_CARR_ON);
235 			CLR(tp->t_cflag, CLOCAL | MDMBUF);
236 			ttyflush(tp, FREAD|FWRITE);
237 		}
238 		/* Wait for processes to go away. */
239 		usb_detach_wait(USBDEV(sc->sc_dev));
240 	}
241 	splx(s);
242 
243 	/* locate the major number */
244 	maj = cdevsw_lookup_major(&ucom_cdevsw);
245 
246 	/* Nuke the vnodes for any open instances. */
247 	mn = self->dv_unit;
248 	DPRINTF(("ucom_detach: maj=%d mn=%d\n", maj, mn));
249 	vdevgone(maj, mn, mn, VCHR);
250 	vdevgone(maj, mn | UCOMDIALOUT_MASK, mn | UCOMDIALOUT_MASK, VCHR);
251 	vdevgone(maj, mn | UCOMCALLUNIT_MASK, mn | UCOMCALLUNIT_MASK, VCHR);
252 
253 	/* Detach and free the tty. */
254 	if (tp != NULL) {
255 		tty_detach(tp);
256 		ttyfree(tp);
257 		sc->sc_tty = NULL;
258 	}
259 
260 	/* Detach the random source */
261 #if defined(__NetBSD__) && NRND > 0
262 	rnd_detach_source(&sc->sc_rndsource);
263 #endif
264 
265 	return (0);
266 }
267 
268 int
269 ucom_activate(device_ptr_t self, enum devact act)
270 {
271 	struct ucom_softc *sc = (struct ucom_softc *)self;
272 
273 	DPRINTFN(5,("ucom_activate: %d\n", act));
274 
275 	switch (act) {
276 	case DVACT_ACTIVATE:
277 		return (EOPNOTSUPP);
278 
279 	case DVACT_DEACTIVATE:
280 		sc->sc_dying = 1;
281 		break;
282 	}
283 	return (0);
284 }
285 
286 void
287 ucom_shutdown(struct ucom_softc *sc)
288 {
289 	struct tty *tp = sc->sc_tty;
290 
291 	DPRINTF(("ucom_shutdown\n"));
292 	/*
293 	 * Hang up if necessary.  Wait a bit, so the other side has time to
294 	 * notice even if we immediately open the port again.
295 	 */
296 	if (ISSET(tp->t_cflag, HUPCL)) {
297 		ucom_dtr(sc, 0);
298 		(void)tsleep(sc, TTIPRI, ttclos, hz);
299 	}
300 }
301 
302 int
303 ucomopen(dev_t dev, int flag, int mode, struct lwp *l)
304 {
305 	int unit = UCOMUNIT(dev);
306 	usbd_status err;
307 	struct proc *p = l->l_proc;
308 	struct ucom_softc *sc;
309 	struct tty *tp;
310 	int s;
311 	int error;
312 
313 	if (unit >= ucom_cd.cd_ndevs)
314 		return (ENXIO);
315 	sc = ucom_cd.cd_devs[unit];
316 	if (sc == NULL)
317 		return (ENXIO);
318 
319 	if (sc->sc_dying)
320 		return (EIO);
321 
322 	if (ISSET(sc->sc_dev.dv_flags, DVF_ACTIVE) == 0)
323 		return (ENXIO);
324 
325 	tp = sc->sc_tty;
326 
327 	DPRINTF(("ucomopen: unit=%d, tp=%p\n", unit, tp));
328 
329 	if (ISSET(tp->t_state, TS_ISOPEN) &&
330 	    ISSET(tp->t_state, TS_XCLUDE) &&
331 	    suser(p->p_ucred, &p->p_acflag) != 0)
332 		return (EBUSY);
333 
334 	s = spltty();
335 
336 	/*
337 	 * Do the following iff this is a first open.
338 	 */
339 	while (sc->sc_opening)
340 		tsleep(&sc->sc_opening, PRIBIO, "ucomop", 0);
341 
342 	if (sc->sc_dying) {
343 		splx(s);
344 		return (EIO);
345 	}
346 	sc->sc_opening = 1;
347 
348 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
349 		struct termios t;
350 
351 		tp->t_dev = dev;
352 
353 		if (sc->sc_methods->ucom_open != NULL) {
354 			error = sc->sc_methods->ucom_open(sc->sc_parent,
355 							  sc->sc_portno);
356 			if (error) {
357 				ucom_cleanup(sc);
358 				sc->sc_opening = 0;
359 				wakeup(&sc->sc_opening);
360 				splx(s);
361 				return (error);
362 			}
363 		}
364 
365 		ucom_status_change(sc);
366 
367 		/*
368 		 * Initialize the termios status to the defaults.  Add in the
369 		 * sticky bits from TIOCSFLAGS.
370 		 */
371 		t.c_ispeed = 0;
372 		t.c_ospeed = TTYDEF_SPEED;
373 		t.c_cflag = TTYDEF_CFLAG;
374 		if (ISSET(sc->sc_swflags, TIOCFLAG_CLOCAL))
375 			SET(t.c_cflag, CLOCAL);
376 		if (ISSET(sc->sc_swflags, TIOCFLAG_CRTSCTS))
377 			SET(t.c_cflag, CRTSCTS);
378 		if (ISSET(sc->sc_swflags, TIOCFLAG_MDMBUF))
379 			SET(t.c_cflag, MDMBUF);
380 		/* Make sure ucomparam() will do something. */
381 		tp->t_ospeed = 0;
382 		(void) ucomparam(tp, &t);
383 		tp->t_iflag = TTYDEF_IFLAG;
384 		tp->t_oflag = TTYDEF_OFLAG;
385 		tp->t_lflag = TTYDEF_LFLAG;
386 		ttychars(tp);
387 		ttsetwater(tp);
388 
389 		/*
390 		 * Turn on DTR.  We must always do this, even if carrier is not
391 		 * present, because otherwise we'd have to use TIOCSDTR
392 		 * immediately after setting CLOCAL, which applications do not
393 		 * expect.  We always assert DTR while the device is open
394 		 * unless explicitly requested to deassert it.
395 		 */
396 		ucom_dtr(sc, 1);
397 
398 		/* XXX CLR(sc->sc_rx_flags, RX_ANY_BLOCK);*/
399 		ucom_hwiflow(sc);
400 
401 		DPRINTF(("ucomopen: open pipes in=%d out=%d\n",
402 			 sc->sc_bulkin_no, sc->sc_bulkout_no));
403 
404 		/* Open the bulk pipes */
405 		err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin_no, 0,
406 				     &sc->sc_bulkin_pipe);
407 		if (err) {
408 			DPRINTF(("%s: open bulk in error (addr %d), err=%s\n",
409 				 USBDEVNAME(sc->sc_dev), sc->sc_bulkin_no,
410 				 usbd_errstr(err)));
411 			error = EIO;
412 			goto fail_0;
413 		}
414 		err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout_no,
415 				     USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
416 		if (err) {
417 			DPRINTF(("%s: open bulk out error (addr %d), err=%s\n",
418 				 USBDEVNAME(sc->sc_dev), sc->sc_bulkout_no,
419 				 usbd_errstr(err)));
420 			error = EIO;
421 			goto fail_1;
422 		}
423 
424 		/* Allocate a request and an input buffer and start reading. */
425 		sc->sc_ixfer = usbd_alloc_xfer(sc->sc_udev);
426 		if (sc->sc_ixfer == NULL) {
427 			error = ENOMEM;
428 			goto fail_2;
429 		}
430 
431 		sc->sc_ibuf = usbd_alloc_buffer(sc->sc_ixfer,
432 						sc->sc_ibufsizepad);
433 		if (sc->sc_ibuf == NULL) {
434 			error = ENOMEM;
435 			goto fail_3;
436 		}
437 
438 		sc->sc_oxfer = usbd_alloc_xfer(sc->sc_udev);
439 		if (sc->sc_oxfer == NULL) {
440 			error = ENOMEM;
441 			goto fail_3;
442 		}
443 
444 		sc->sc_obuf = usbd_alloc_buffer(sc->sc_oxfer,
445 						sc->sc_obufsize +
446 						sc->sc_opkthdrlen);
447 		if (sc->sc_obuf == NULL) {
448 			error = ENOMEM;
449 			goto fail_4;
450 		}
451 
452 		ucomstartread(sc);
453 	}
454 	sc->sc_opening = 0;
455 	wakeup(&sc->sc_opening);
456 	splx(s);
457 
458 	error = ttyopen(tp, UCOMDIALOUT(dev), ISSET(flag, O_NONBLOCK));
459 	if (error)
460 		goto bad;
461 
462 	error = (*tp->t_linesw->l_open)(dev, tp);
463 	if (error)
464 		goto bad;
465 
466 	return (0);
467 
468 fail_4:
469 	usbd_free_xfer(sc->sc_oxfer);
470 	sc->sc_oxfer = NULL;
471 fail_3:
472 	usbd_free_xfer(sc->sc_ixfer);
473 	sc->sc_ixfer = NULL;
474 fail_2:
475 	usbd_close_pipe(sc->sc_bulkout_pipe);
476 	sc->sc_bulkout_pipe = NULL;
477 fail_1:
478 	usbd_close_pipe(sc->sc_bulkin_pipe);
479 	sc->sc_bulkin_pipe = NULL;
480 fail_0:
481 	sc->sc_opening = 0;
482 	wakeup(&sc->sc_opening);
483 	splx(s);
484 	return (error);
485 
486 bad:
487 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
488 		/*
489 		 * We failed to open the device, and nobody else had it opened.
490 		 * Clean up the state as appropriate.
491 		 */
492 		ucom_cleanup(sc);
493 	}
494 
495 	return (error);
496 }
497 
498 int
499 ucomclose(dev_t dev, int flag, int mode, struct lwp *l)
500 {
501 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
502 	struct tty *tp = sc->sc_tty;
503 
504 	DPRINTF(("ucomclose: unit=%d\n", UCOMUNIT(dev)));
505 	if (!ISSET(tp->t_state, TS_ISOPEN))
506 		return (0);
507 
508 	sc->sc_refcnt++;
509 
510 	(*tp->t_linesw->l_close)(tp, flag);
511 	ttyclose(tp);
512 
513 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
514 		/*
515 		 * Although we got a last close, the device may still be in
516 		 * use; e.g. if this was the dialout node, and there are still
517 		 * processes waiting for carrier on the non-dialout node.
518 		 */
519 		ucom_cleanup(sc);
520 	}
521 
522 	if (sc->sc_methods->ucom_close != NULL)
523 		sc->sc_methods->ucom_close(sc->sc_parent, sc->sc_portno);
524 
525 	if (--sc->sc_refcnt < 0)
526 		usb_detach_wakeup(USBDEV(sc->sc_dev));
527 
528 	return (0);
529 }
530 
531 int
532 ucomread(dev_t dev, struct uio *uio, int flag)
533 {
534 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
535 	struct tty *tp = sc->sc_tty;
536 	int error;
537 
538 	if (sc->sc_dying)
539 		return (EIO);
540 
541 	sc->sc_refcnt++;
542 	error = ((*tp->t_linesw->l_read)(tp, uio, flag));
543 	if (--sc->sc_refcnt < 0)
544 		usb_detach_wakeup(USBDEV(sc->sc_dev));
545 	return (error);
546 }
547 
548 int
549 ucomwrite(dev_t dev, struct uio *uio, int flag)
550 {
551 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
552 	struct tty *tp = sc->sc_tty;
553 	int error;
554 
555 	if (sc->sc_dying)
556 		return (EIO);
557 
558 	sc->sc_refcnt++;
559 	error = ((*tp->t_linesw->l_write)(tp, uio, flag));
560 	if (--sc->sc_refcnt < 0)
561 		usb_detach_wakeup(USBDEV(sc->sc_dev));
562 	return (error);
563 }
564 
565 int
566 ucompoll(dev_t dev, int events, struct lwp *l)
567 {
568 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
569 	struct tty *tp = sc->sc_tty;
570 	int revents;
571 
572 	if (sc->sc_dying)
573 		return (POLLHUP);
574 
575 	sc->sc_refcnt++;
576 	revents = ((*tp->t_linesw->l_poll)(tp, events, l));
577 	if (--sc->sc_refcnt < 0)
578 		usb_detach_wakeup(USBDEV(sc->sc_dev));
579 	return (revents);
580 }
581 
582 struct tty *
583 ucomtty(dev_t dev)
584 {
585 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
586 	struct tty *tp = sc->sc_tty;
587 
588 	return (tp);
589 }
590 
591 int
592 ucomioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct lwp *l)
593 {
594 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
595 	int error;
596 
597 	sc->sc_refcnt++;
598 	error = ucom_do_ioctl(sc, cmd, data, flag, l);
599 	if (--sc->sc_refcnt < 0)
600 		usb_detach_wakeup(USBDEV(sc->sc_dev));
601 	return (error);
602 }
603 
604 Static int
605 ucom_do_ioctl(struct ucom_softc *sc, u_long cmd, caddr_t data,
606 	      int flag, struct lwp *l)
607 {
608 	struct tty *tp = sc->sc_tty;
609 	struct proc *p = l->l_proc;
610 	int error;
611 	int s;
612 
613 	if (sc->sc_dying)
614 		return (EIO);
615 
616 	DPRINTF(("ucomioctl: cmd=0x%08lx\n", cmd));
617 
618 	error = (*tp->t_linesw->l_ioctl)(tp, cmd, data, flag, l);
619 	if (error != EPASSTHROUGH)
620 		return (error);
621 
622 	error = ttioctl(tp, cmd, data, flag, l);
623 	if (error != EPASSTHROUGH)
624 		return (error);
625 
626 	if (sc->sc_methods->ucom_ioctl != NULL) {
627 		error = sc->sc_methods->ucom_ioctl(sc->sc_parent,
628 			    sc->sc_portno, cmd, data, flag, l->l_proc);
629 		if (error != EPASSTHROUGH)
630 			return (error);
631 	}
632 
633 	error = 0;
634 
635 	DPRINTF(("ucomioctl: our cmd=0x%08lx\n", cmd));
636 	s = spltty();
637 
638 	switch (cmd) {
639 	case TIOCSBRK:
640 		ucom_break(sc, 1);
641 		break;
642 
643 	case TIOCCBRK:
644 		ucom_break(sc, 0);
645 		break;
646 
647 	case TIOCSDTR:
648 		ucom_dtr(sc, 1);
649 		break;
650 
651 	case TIOCCDTR:
652 		ucom_dtr(sc, 0);
653 		break;
654 
655 	case TIOCGFLAGS:
656 		*(int *)data = sc->sc_swflags;
657 		break;
658 
659 	case TIOCSFLAGS:
660 		error = suser(p->p_ucred, &p->p_acflag);
661 		if (error)
662 			break;
663 		sc->sc_swflags = *(int *)data;
664 		break;
665 
666 	case TIOCMSET:
667 	case TIOCMBIS:
668 	case TIOCMBIC:
669 		tiocm_to_ucom(sc, cmd, *(int *)data);
670 		break;
671 
672 	case TIOCMGET:
673 		*(int *)data = ucom_to_tiocm(sc);
674 		break;
675 
676 	default:
677 		error = EPASSTHROUGH;
678 		break;
679 	}
680 
681 	splx(s);
682 
683 	return (error);
684 }
685 
686 Static void
687 tiocm_to_ucom(struct ucom_softc *sc, u_long how, int ttybits)
688 {
689 	u_char combits;
690 
691 	combits = 0;
692 	if (ISSET(ttybits, TIOCM_DTR))
693 		SET(combits, UMCR_DTR);
694 	if (ISSET(ttybits, TIOCM_RTS))
695 		SET(combits, UMCR_RTS);
696 
697 	switch (how) {
698 	case TIOCMBIC:
699 		CLR(sc->sc_mcr, combits);
700 		break;
701 
702 	case TIOCMBIS:
703 		SET(sc->sc_mcr, combits);
704 		break;
705 
706 	case TIOCMSET:
707 		CLR(sc->sc_mcr, UMCR_DTR | UMCR_RTS);
708 		SET(sc->sc_mcr, combits);
709 		break;
710 	}
711 
712 	if (how == TIOCMSET || ISSET(combits, UMCR_DTR))
713 		ucom_dtr(sc, (sc->sc_mcr & UMCR_DTR) != 0);
714 	if (how == TIOCMSET || ISSET(combits, UMCR_RTS))
715 		ucom_rts(sc, (sc->sc_mcr & UMCR_RTS) != 0);
716 }
717 
718 Static int
719 ucom_to_tiocm(struct ucom_softc *sc)
720 {
721 	u_char combits;
722 	int ttybits = 0;
723 
724 	combits = sc->sc_mcr;
725 	if (ISSET(combits, UMCR_DTR))
726 		SET(ttybits, TIOCM_DTR);
727 	if (ISSET(combits, UMCR_RTS))
728 		SET(ttybits, TIOCM_RTS);
729 
730 	combits = sc->sc_msr;
731 	if (ISSET(combits, UMSR_DCD))
732 		SET(ttybits, TIOCM_CD);
733 	if (ISSET(combits, UMSR_CTS))
734 		SET(ttybits, TIOCM_CTS);
735 	if (ISSET(combits, UMSR_DSR))
736 		SET(ttybits, TIOCM_DSR);
737 	if (ISSET(combits, UMSR_RI | UMSR_TERI))
738 		SET(ttybits, TIOCM_RI);
739 
740 #if 0
741 XXX;
742 	if (sc->sc_ier != 0)
743 		SET(ttybits, TIOCM_LE);
744 #endif
745 
746 	return (ttybits);
747 }
748 
749 Static void
750 ucom_break(sc, onoff)
751 	struct ucom_softc *sc;
752 	int onoff;
753 {
754 	DPRINTF(("ucom_break: onoff=%d\n", onoff));
755 
756 	if (sc->sc_methods->ucom_set != NULL)
757 		sc->sc_methods->ucom_set(sc->sc_parent, sc->sc_portno,
758 		    UCOM_SET_BREAK, onoff);
759 }
760 
761 Static void
762 ucom_dtr(struct ucom_softc *sc, int onoff)
763 {
764 	DPRINTF(("ucom_dtr: onoff=%d\n", onoff));
765 
766 	if (sc->sc_methods->ucom_set != NULL)
767 		sc->sc_methods->ucom_set(sc->sc_parent, sc->sc_portno,
768 		    UCOM_SET_DTR, onoff);
769 }
770 
771 Static void
772 ucom_rts(struct ucom_softc *sc, int onoff)
773 {
774 	DPRINTF(("ucom_rts: onoff=%d\n", onoff));
775 
776 	if (sc->sc_methods->ucom_set != NULL)
777 		sc->sc_methods->ucom_set(sc->sc_parent, sc->sc_portno,
778 		    UCOM_SET_RTS, onoff);
779 }
780 
781 void
782 ucom_status_change(struct ucom_softc *sc)
783 {
784 	struct tty *tp = sc->sc_tty;
785 	u_char old_msr;
786 
787 	if (sc->sc_methods->ucom_get_status != NULL) {
788 		old_msr = sc->sc_msr;
789 		sc->sc_methods->ucom_get_status(sc->sc_parent, sc->sc_portno,
790 		    &sc->sc_lsr, &sc->sc_msr);
791 		if (ISSET((sc->sc_msr ^ old_msr), UMSR_DCD))
792 			(*tp->t_linesw->l_modem)(tp,
793 			    ISSET(sc->sc_msr, UMSR_DCD));
794 	} else {
795 		sc->sc_lsr = 0;
796 		/* Assume DCD is present, if we have no chance to check it. */
797 		sc->sc_msr = UMSR_DCD;
798 	}
799 }
800 
801 Static int
802 ucomparam(struct tty *tp, struct termios *t)
803 {
804 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(tp->t_dev)];
805 	int error;
806 
807 	if (sc->sc_dying)
808 		return (EIO);
809 
810 	/* Check requested parameters. */
811 	if (t->c_ispeed && t->c_ispeed != t->c_ospeed)
812 		return (EINVAL);
813 
814 	/*
815 	 * For the console, always force CLOCAL and !HUPCL, so that the port
816 	 * is always active.
817 	 */
818 	if (ISSET(sc->sc_swflags, TIOCFLAG_SOFTCAR)) {
819 		SET(t->c_cflag, CLOCAL);
820 		CLR(t->c_cflag, HUPCL);
821 	}
822 
823 	/*
824 	 * If there were no changes, don't do anything.  This avoids dropping
825 	 * input and improves performance when all we did was frob things like
826 	 * VMIN and VTIME.
827 	 */
828 	if (tp->t_ospeed == t->c_ospeed &&
829 	    tp->t_cflag == t->c_cflag)
830 		return (0);
831 
832 	/* XXX lcr = ISSET(sc->sc_lcr, LCR_SBREAK) | cflag2lcr(t->c_cflag); */
833 
834 	/* And copy to tty. */
835 	tp->t_ispeed = 0;
836 	tp->t_ospeed = t->c_ospeed;
837 	tp->t_cflag = t->c_cflag;
838 
839 	if (sc->sc_methods->ucom_param != NULL) {
840 		error = sc->sc_methods->ucom_param(sc->sc_parent, sc->sc_portno,
841 			    t);
842 		if (error)
843 			return (error);
844 	}
845 
846 	/* XXX worry about CHWFLOW */
847 
848 	/*
849 	 * Update the tty layer's idea of the carrier bit, in case we changed
850 	 * CLOCAL or MDMBUF.  We don't hang up here; we only do that by
851 	 * explicit request.
852 	 */
853 	DPRINTF(("ucomparam: l_modem\n"));
854 	(void) (*tp->t_linesw->l_modem)(tp, ISSET(sc->sc_msr, UMSR_DCD));
855 
856 #if 0
857 XXX what if the hardware is not open
858 	if (!ISSET(t->c_cflag, CHWFLOW)) {
859 		if (sc->sc_tx_stopped) {
860 			sc->sc_tx_stopped = 0;
861 			ucomstart(tp);
862 		}
863 	}
864 #endif
865 
866 	return (0);
867 }
868 
869 /*
870  * (un)block input via hw flowcontrol
871  */
872 Static void
873 ucom_hwiflow(struct ucom_softc *sc)
874 {
875 	DPRINTF(("ucom_hwiflow:\n"));
876 #if 0
877 XXX
878 	bus_space_tag_t iot = sc->sc_iot;
879 	bus_space_handle_t ioh = sc->sc_ioh;
880 
881 	if (sc->sc_mcr_rts == 0)
882 		return;
883 
884 	if (ISSET(sc->sc_rx_flags, RX_ANY_BLOCK)) {
885 		CLR(sc->sc_mcr, sc->sc_mcr_rts);
886 		CLR(sc->sc_mcr_active, sc->sc_mcr_rts);
887 	} else {
888 		SET(sc->sc_mcr, sc->sc_mcr_rts);
889 		SET(sc->sc_mcr_active, sc->sc_mcr_rts);
890 	}
891 	bus_space_write_1(iot, ioh, com_mcr, sc->sc_mcr_active);
892 #endif
893 }
894 
895 Static void
896 ucomstart(struct tty *tp)
897 {
898 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(tp->t_dev)];
899 	usbd_status err;
900 	int s;
901 	u_char *data;
902 	int cnt;
903 
904 	if (sc->sc_dying)
905 		return;
906 
907 	s = spltty();
908 	if (ISSET(tp->t_state, TS_BUSY | TS_TIMEOUT | TS_TTSTOP)) {
909 		DPRINTFN(4,("ucomstart: no go, state=0x%x\n", tp->t_state));
910 		goto out;
911 	}
912 	if (sc->sc_tx_stopped)
913 		goto out;
914 
915 	if (tp->t_outq.c_cc <= tp->t_lowat) {
916 		if (ISSET(tp->t_state, TS_ASLEEP)) {
917 			CLR(tp->t_state, TS_ASLEEP);
918 			wakeup(&tp->t_outq);
919 		}
920 		selwakeup(&tp->t_wsel);
921 		if (tp->t_outq.c_cc == 0)
922 			goto out;
923 	}
924 
925 	/* Grab the first contiguous region of buffer space. */
926 	data = tp->t_outq.c_cf;
927 	cnt = ndqb(&tp->t_outq, 0);
928 
929 	if (cnt == 0) {
930 		DPRINTF(("ucomstart: cnt==0\n"));
931 		goto out;
932 	}
933 
934 	SET(tp->t_state, TS_BUSY);
935 
936 	if (cnt > sc->sc_obufsize) {
937 		DPRINTF(("ucomstart: big buffer %d chars\n", cnt));
938 		cnt = sc->sc_obufsize;
939 	}
940 	if (sc->sc_methods->ucom_write != NULL)
941 		sc->sc_methods->ucom_write(sc->sc_parent, sc->sc_portno,
942 					   sc->sc_obuf, data, &cnt);
943 	else
944 		memcpy(sc->sc_obuf, data, cnt);
945 
946 	DPRINTFN(4,("ucomstart: %d chars\n", cnt));
947 	usbd_setup_xfer(sc->sc_oxfer, sc->sc_bulkout_pipe,
948 			(usbd_private_handle)sc, sc->sc_obuf, cnt,
949 			USBD_NO_COPY, USBD_NO_TIMEOUT, ucomwritecb);
950 	/* What can we do on error? */
951 	err = usbd_transfer(sc->sc_oxfer);
952 #ifdef DIAGNOSTIC
953 	if (err != USBD_IN_PROGRESS)
954 		printf("ucomstart: err=%s\n", usbd_errstr(err));
955 #endif
956 
957 out:
958 	splx(s);
959 }
960 
961 void
962 ucomstop(struct tty *tp, int flag)
963 {
964 	DPRINTF(("ucomstop: flag=%d\n", flag));
965 #if 0
966 	/*struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(tp->t_dev)];*/
967 	int s;
968 
969 	s = spltty();
970 	if (ISSET(tp->t_state, TS_BUSY)) {
971 		DPRINTF(("ucomstop: XXX\n"));
972 		/* sc->sc_tx_stopped = 1; */
973 		if (!ISSET(tp->t_state, TS_TTSTOP))
974 			SET(tp->t_state, TS_FLUSH);
975 	}
976 	splx(s);
977 #endif
978 }
979 
980 Static void
981 ucomwritecb(usbd_xfer_handle xfer, usbd_private_handle p, usbd_status status)
982 {
983 	struct ucom_softc *sc = (struct ucom_softc *)p;
984 	struct tty *tp = sc->sc_tty;
985 	u_int32_t cc;
986 	int s;
987 
988 	DPRINTFN(5,("ucomwritecb: status=%d\n", status));
989 
990 	if (status == USBD_CANCELLED || sc->sc_dying)
991 		goto error;
992 
993 	if (status) {
994 		DPRINTF(("ucomwritecb: status=%d\n", status));
995 		usbd_clear_endpoint_stall_async(sc->sc_bulkin_pipe);
996 		/* XXX we should restart after some delay. */
997 		goto error;
998 	}
999 
1000 	usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
1001 #if defined(__NetBSD__) && NRND > 0
1002 	rnd_add_uint32(&sc->sc_rndsource, cc);
1003 #endif
1004 	DPRINTFN(5,("ucomwritecb: cc=%d\n", cc));
1005 	/* convert from USB bytes to tty bytes */
1006 	cc -= sc->sc_opkthdrlen;
1007 
1008 	s = spltty();
1009 	CLR(tp->t_state, TS_BUSY);
1010 	if (ISSET(tp->t_state, TS_FLUSH))
1011 		CLR(tp->t_state, TS_FLUSH);
1012 	else
1013 		ndflush(&tp->t_outq, cc);
1014 	(*tp->t_linesw->l_start)(tp);
1015 	splx(s);
1016 	return;
1017 
1018 error:
1019 	s = spltty();
1020 	CLR(tp->t_state, TS_BUSY);
1021 	splx(s);
1022 }
1023 
1024 Static usbd_status
1025 ucomstartread(struct ucom_softc *sc)
1026 {
1027 	usbd_status err;
1028 
1029 	DPRINTFN(5,("ucomstartread: start\n"));
1030 	usbd_setup_xfer(sc->sc_ixfer, sc->sc_bulkin_pipe,
1031 			(usbd_private_handle)sc,
1032 			sc->sc_ibuf, sc->sc_ibufsize,
1033 			USBD_SHORT_XFER_OK | USBD_NO_COPY,
1034 			USBD_NO_TIMEOUT, ucomreadcb);
1035 	err = usbd_transfer(sc->sc_ixfer);
1036 	if (err != USBD_IN_PROGRESS) {
1037 		DPRINTF(("ucomstartread: err=%s\n", usbd_errstr(err)));
1038 		return (err);
1039 	}
1040 	return (USBD_NORMAL_COMPLETION);
1041 }
1042 
1043 Static void
1044 ucomreadcb(usbd_xfer_handle xfer, usbd_private_handle p, usbd_status status)
1045 {
1046 	struct ucom_softc *sc = (struct ucom_softc *)p;
1047 	struct tty *tp = sc->sc_tty;
1048 	int (*rint)(int, struct tty *) = tp->t_linesw->l_rint;
1049 	usbd_status err;
1050 	u_int32_t cc;
1051 	u_char *cp;
1052 	int s;
1053 
1054 	DPRINTFN(5,("ucomreadcb: status=%d\n", status));
1055 
1056 	if (status == USBD_CANCELLED || status == USBD_IOERROR ||
1057 	    sc->sc_dying) {
1058 		DPRINTF(("ucomreadcb: dying\n"));
1059 		/* Send something to wake upper layer */
1060 		s = spltty();
1061 		(*rint)('\n', tp);
1062 		ttwakeup(tp);
1063 		splx(s);
1064 		return;
1065 	}
1066 
1067 	if (status) {
1068 		usbd_clear_endpoint_stall_async(sc->sc_bulkin_pipe);
1069 		/* XXX we should restart after some delay. */
1070 		return;
1071 	}
1072 
1073 	usbd_get_xfer_status(xfer, NULL, (void *)&cp, &cc, NULL);
1074 #if defined(__NetBSD__) && NRND > 0
1075 	rnd_add_uint32(&sc->sc_rndsource, cc);
1076 #endif
1077 	DPRINTFN(5,("ucomreadcb: got %d chars, tp=%p\n", cc, tp));
1078 	if (sc->sc_methods->ucom_read != NULL)
1079 		sc->sc_methods->ucom_read(sc->sc_parent, sc->sc_portno,
1080 					  &cp, &cc);
1081 
1082 	s = spltty();
1083 	/* Give characters to tty layer. */
1084 	while (cc-- > 0) {
1085 		DPRINTFN(7,("ucomreadcb: char=0x%02x\n", *cp));
1086 		if ((*rint)(*cp++, tp) == -1) {
1087 			/* XXX what should we do? */
1088 			printf("%s: lost %d chars\n", USBDEVNAME(sc->sc_dev),
1089 			       cc);
1090 			break;
1091 		}
1092 	}
1093 	splx(s);
1094 
1095 	err = ucomstartread(sc);
1096 	if (err) {
1097 		printf("%s: read start failed\n", USBDEVNAME(sc->sc_dev));
1098 		/* XXX what should we dow now? */
1099 	}
1100 }
1101 
1102 Static void
1103 ucom_cleanup(struct ucom_softc *sc)
1104 {
1105 	DPRINTF(("ucom_cleanup: closing pipes\n"));
1106 
1107 	ucom_shutdown(sc);
1108 	if (sc->sc_bulkin_pipe != NULL) {
1109 		usbd_abort_pipe(sc->sc_bulkin_pipe);
1110 		usbd_close_pipe(sc->sc_bulkin_pipe);
1111 		sc->sc_bulkin_pipe = NULL;
1112 	}
1113 	if (sc->sc_bulkout_pipe != NULL) {
1114 		usbd_abort_pipe(sc->sc_bulkout_pipe);
1115 		usbd_close_pipe(sc->sc_bulkout_pipe);
1116 		sc->sc_bulkout_pipe = NULL;
1117 	}
1118 	if (sc->sc_ixfer != NULL) {
1119 		usbd_free_xfer(sc->sc_ixfer);
1120 		sc->sc_ixfer = NULL;
1121 	}
1122 	if (sc->sc_oxfer != NULL) {
1123 		usbd_free_xfer(sc->sc_oxfer);
1124 		sc->sc_oxfer = NULL;
1125 	}
1126 }
1127 
1128 #endif /* NUCOM > 0 */
1129 
1130 int
1131 ucomprint(void *aux, const char *pnp)
1132 {
1133 	struct ucom_attach_args *uca = aux;
1134 
1135 	if (pnp)
1136 		aprint_normal("ucom at %s", pnp);
1137 	if (uca->portno != UCOM_UNK_PORTNO)
1138 		aprint_normal(" portno %d", uca->portno);
1139 	return (UNCONF);
1140 }
1141 
1142 int
1143 ucomsubmatch(struct device *parent, struct cfdata *cf,
1144 	     const int *ldesc, void *aux)
1145 {
1146 	struct ucom_attach_args *uca = aux;
1147 
1148 	if (uca->portno != UCOM_UNK_PORTNO &&
1149 	    cf->cf_loc[UCOMBUSCF_PORTNO] != UCOMBUSCF_PORTNO_DEFAULT &&
1150 	    cf->cf_loc[UCOMBUSCF_PORTNO] != uca->portno)
1151 		return (0);
1152 	return (config_match(parent, cf, aux));
1153 }
1154