xref: /netbsd-src/sys/dev/usb/ucom.c (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: ucom.c,v 1.53 2004/09/13 12:55:49 drochner 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.53 2004/09/13 12:55:49 drochner 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, usb_proc_ptr);
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->portno != UCOM_UNK_PORTNO)
182 		printf(": portno %d", uca->portno);
183 	if (uca->info != NULL)
184 		printf(", %s", uca->info);
185 	printf("\n");
186 
187 	sc->sc_udev = uca->device;
188 	sc->sc_iface = uca->iface;
189 	sc->sc_bulkout_no = uca->bulkout;
190 	sc->sc_bulkin_no = uca->bulkin;
191 	sc->sc_ibufsize = uca->ibufsize;
192 	sc->sc_ibufsizepad = uca->ibufsizepad;
193 	sc->sc_obufsize = uca->obufsize;
194 	sc->sc_opkthdrlen = uca->opkthdrlen;
195 	sc->sc_methods = uca->methods;
196 	sc->sc_parent = uca->arg;
197 	sc->sc_portno = uca->portno;
198 
199 	tp = ttymalloc();
200 	tp->t_oproc = ucomstart;
201 	tp->t_param = ucomparam;
202 	sc->sc_tty = tp;
203 
204 	DPRINTF(("ucom_attach: tty_attach %p\n", tp));
205 	tty_attach(tp);
206 
207 #if defined(__NetBSD__) && NRND > 0
208 	rnd_attach_source(&sc->sc_rndsource, USBDEVNAME(sc->sc_dev),
209 			  RND_TYPE_TTY, 0);
210 #endif
211 
212 	USB_ATTACH_SUCCESS_RETURN;
213 }
214 
215 USB_DETACH(ucom)
216 {
217 	struct ucom_softc *sc = (struct ucom_softc *)self;
218 	struct tty *tp = sc->sc_tty;
219 	int maj, mn;
220 	int s;
221 
222 	DPRINTF(("ucom_detach: sc=%p flags=%d tp=%p, pipe=%d,%d\n",
223 		 sc, flags, tp, sc->sc_bulkin_no, sc->sc_bulkout_no));
224 
225 	sc->sc_dying = 1;
226 
227 	if (sc->sc_bulkin_pipe != NULL)
228 		usbd_abort_pipe(sc->sc_bulkin_pipe);
229 	if (sc->sc_bulkout_pipe != NULL)
230 		usbd_abort_pipe(sc->sc_bulkout_pipe);
231 
232 	s = splusb();
233 	if (--sc->sc_refcnt >= 0) {
234 		/* Wake up anyone waiting */
235 		if (tp != NULL) {
236 			CLR(tp->t_state, TS_CARR_ON);
237 			CLR(tp->t_cflag, CLOCAL | MDMBUF);
238 			ttyflush(tp, FREAD|FWRITE);
239 		}
240 		/* Wait for processes to go away. */
241 		usb_detach_wait(USBDEV(sc->sc_dev));
242 	}
243 	splx(s);
244 
245 	/* locate the major number */
246 	maj = cdevsw_lookup_major(&ucom_cdevsw);
247 
248 	/* Nuke the vnodes for any open instances. */
249 	mn = self->dv_unit;
250 	DPRINTF(("ucom_detach: maj=%d mn=%d\n", maj, mn));
251 	vdevgone(maj, mn, mn, VCHR);
252 	vdevgone(maj, mn | UCOMDIALOUT_MASK, mn | UCOMDIALOUT_MASK, VCHR);
253 	vdevgone(maj, mn | UCOMCALLUNIT_MASK, mn | UCOMCALLUNIT_MASK, VCHR);
254 
255 	/* Detach and free the tty. */
256 	if (tp != NULL) {
257 		tty_detach(tp);
258 		ttyfree(tp);
259 		sc->sc_tty = NULL;
260 	}
261 
262 	/* Detach the random source */
263 #if defined(__NetBSD__) && NRND > 0
264 	rnd_detach_source(&sc->sc_rndsource);
265 #endif
266 
267 	return (0);
268 }
269 
270 int
271 ucom_activate(device_ptr_t self, enum devact act)
272 {
273 	struct ucom_softc *sc = (struct ucom_softc *)self;
274 
275 	DPRINTFN(5,("ucom_activate: %d\n", act));
276 
277 	switch (act) {
278 	case DVACT_ACTIVATE:
279 		return (EOPNOTSUPP);
280 
281 	case DVACT_DEACTIVATE:
282 		sc->sc_dying = 1;
283 		break;
284 	}
285 	return (0);
286 }
287 
288 void
289 ucom_shutdown(struct ucom_softc *sc)
290 {
291 	struct tty *tp = sc->sc_tty;
292 
293 	DPRINTF(("ucom_shutdown\n"));
294 	/*
295 	 * Hang up if necessary.  Wait a bit, so the other side has time to
296 	 * notice even if we immediately open the port again.
297 	 */
298 	if (ISSET(tp->t_cflag, HUPCL)) {
299 		ucom_dtr(sc, 0);
300 		(void)tsleep(sc, TTIPRI, ttclos, hz);
301 	}
302 }
303 
304 int
305 ucomopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
306 {
307 	int unit = UCOMUNIT(dev);
308 	usbd_status err;
309 	struct ucom_softc *sc;
310 	struct tty *tp;
311 	int s;
312 	int error;
313 
314 	if (unit >= ucom_cd.cd_ndevs)
315 		return (ENXIO);
316 	sc = ucom_cd.cd_devs[unit];
317 	if (sc == NULL)
318 		return (ENXIO);
319 
320 	if (sc->sc_dying)
321 		return (EIO);
322 
323 	if (ISSET(sc->sc_dev.dv_flags, DVF_ACTIVE) == 0)
324 		return (ENXIO);
325 
326 	tp = sc->sc_tty;
327 
328 	DPRINTF(("ucomopen: unit=%d, tp=%p\n", unit, tp));
329 
330 	if (ISSET(tp->t_state, TS_ISOPEN) &&
331 	    ISSET(tp->t_state, TS_XCLUDE) &&
332 	    p->p_ucred->cr_uid != 0)
333 		return (EBUSY);
334 
335 	s = spltty();
336 
337 	/*
338 	 * Do the following iff this is a first open.
339 	 */
340 	while (sc->sc_opening)
341 		tsleep(&sc->sc_opening, PRIBIO, "ucomop", 0);
342 
343 	if (sc->sc_dying) {
344 		splx(s);
345 		return (EIO);
346 	}
347 	sc->sc_opening = 1;
348 
349 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
350 		struct termios t;
351 
352 		tp->t_dev = dev;
353 
354 		if (sc->sc_methods->ucom_open != NULL) {
355 			error = sc->sc_methods->ucom_open(sc->sc_parent,
356 							  sc->sc_portno);
357 			if (error) {
358 				ucom_cleanup(sc);
359 				sc->sc_opening = 0;
360 				wakeup(&sc->sc_opening);
361 				splx(s);
362 				return (error);
363 			}
364 		}
365 
366 		ucom_status_change(sc);
367 
368 		/*
369 		 * Initialize the termios status to the defaults.  Add in the
370 		 * sticky bits from TIOCSFLAGS.
371 		 */
372 		t.c_ispeed = 0;
373 		t.c_ospeed = TTYDEF_SPEED;
374 		t.c_cflag = TTYDEF_CFLAG;
375 		if (ISSET(sc->sc_swflags, TIOCFLAG_CLOCAL))
376 			SET(t.c_cflag, CLOCAL);
377 		if (ISSET(sc->sc_swflags, TIOCFLAG_CRTSCTS))
378 			SET(t.c_cflag, CRTSCTS);
379 		if (ISSET(sc->sc_swflags, TIOCFLAG_MDMBUF))
380 			SET(t.c_cflag, MDMBUF);
381 		/* Make sure ucomparam() will do something. */
382 		tp->t_ospeed = 0;
383 		(void) ucomparam(tp, &t);
384 		tp->t_iflag = TTYDEF_IFLAG;
385 		tp->t_oflag = TTYDEF_OFLAG;
386 		tp->t_lflag = TTYDEF_LFLAG;
387 		ttychars(tp);
388 		ttsetwater(tp);
389 
390 		/*
391 		 * Turn on DTR.  We must always do this, even if carrier is not
392 		 * present, because otherwise we'd have to use TIOCSDTR
393 		 * immediately after setting CLOCAL, which applications do not
394 		 * expect.  We always assert DTR while the device is open
395 		 * unless explicitly requested to deassert it.
396 		 */
397 		ucom_dtr(sc, 1);
398 
399 		/* XXX CLR(sc->sc_rx_flags, RX_ANY_BLOCK);*/
400 		ucom_hwiflow(sc);
401 
402 		DPRINTF(("ucomopen: open pipes in=%d out=%d\n",
403 			 sc->sc_bulkin_no, sc->sc_bulkout_no));
404 
405 		/* Open the bulk pipes */
406 		err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin_no, 0,
407 				     &sc->sc_bulkin_pipe);
408 		if (err) {
409 			DPRINTF(("%s: open bulk in error (addr %d), err=%s\n",
410 				 USBDEVNAME(sc->sc_dev), sc->sc_bulkin_no,
411 				 usbd_errstr(err)));
412 			error = EIO;
413 			goto fail_0;
414 		}
415 		err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout_no,
416 				     USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
417 		if (err) {
418 			DPRINTF(("%s: open bulk out error (addr %d), err=%s\n",
419 				 USBDEVNAME(sc->sc_dev), sc->sc_bulkout_no,
420 				 usbd_errstr(err)));
421 			error = EIO;
422 			goto fail_1;
423 		}
424 
425 		/* Allocate a request and an input buffer and start reading. */
426 		sc->sc_ixfer = usbd_alloc_xfer(sc->sc_udev);
427 		if (sc->sc_ixfer == NULL) {
428 			error = ENOMEM;
429 			goto fail_2;
430 		}
431 
432 		sc->sc_ibuf = usbd_alloc_buffer(sc->sc_ixfer,
433 						sc->sc_ibufsizepad);
434 		if (sc->sc_ibuf == NULL) {
435 			error = ENOMEM;
436 			goto fail_3;
437 		}
438 
439 		sc->sc_oxfer = usbd_alloc_xfer(sc->sc_udev);
440 		if (sc->sc_oxfer == NULL) {
441 			error = ENOMEM;
442 			goto fail_3;
443 		}
444 
445 		sc->sc_obuf = usbd_alloc_buffer(sc->sc_oxfer,
446 						sc->sc_obufsize +
447 						sc->sc_opkthdrlen);
448 		if (sc->sc_obuf == NULL) {
449 			error = ENOMEM;
450 			goto fail_4;
451 		}
452 
453 		ucomstartread(sc);
454 	}
455 	sc->sc_opening = 0;
456 	wakeup(&sc->sc_opening);
457 	splx(s);
458 
459 	error = ttyopen(tp, UCOMDIALOUT(dev), ISSET(flag, O_NONBLOCK));
460 	if (error)
461 		goto bad;
462 
463 	error = (*tp->t_linesw->l_open)(dev, tp);
464 	if (error)
465 		goto bad;
466 
467 	return (0);
468 
469 fail_4:
470 	usbd_free_xfer(sc->sc_oxfer);
471 	sc->sc_oxfer = NULL;
472 fail_3:
473 	usbd_free_xfer(sc->sc_ixfer);
474 	sc->sc_ixfer = NULL;
475 fail_2:
476 	usbd_close_pipe(sc->sc_bulkout_pipe);
477 	sc->sc_bulkout_pipe = NULL;
478 fail_1:
479 	usbd_close_pipe(sc->sc_bulkin_pipe);
480 	sc->sc_bulkin_pipe = NULL;
481 fail_0:
482 	sc->sc_opening = 0;
483 	wakeup(&sc->sc_opening);
484 	splx(s);
485 	return (error);
486 
487 bad:
488 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
489 		/*
490 		 * We failed to open the device, and nobody else had it opened.
491 		 * Clean up the state as appropriate.
492 		 */
493 		ucom_cleanup(sc);
494 	}
495 
496 	return (error);
497 }
498 
499 int
500 ucomclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
501 {
502 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
503 	struct tty *tp = sc->sc_tty;
504 
505 	DPRINTF(("ucomclose: unit=%d\n", UCOMUNIT(dev)));
506 	if (!ISSET(tp->t_state, TS_ISOPEN))
507 		return (0);
508 
509 	sc->sc_refcnt++;
510 
511 	(*tp->t_linesw->l_close)(tp, flag);
512 	ttyclose(tp);
513 
514 	if (!ISSET(tp->t_state, TS_ISOPEN) && tp->t_wopen == 0) {
515 		/*
516 		 * Although we got a last close, the device may still be in
517 		 * use; e.g. if this was the dialout node, and there are still
518 		 * processes waiting for carrier on the non-dialout node.
519 		 */
520 		ucom_cleanup(sc);
521 	}
522 
523 	if (sc->sc_methods->ucom_close != NULL)
524 		sc->sc_methods->ucom_close(sc->sc_parent, sc->sc_portno);
525 
526 	if (--sc->sc_refcnt < 0)
527 		usb_detach_wakeup(USBDEV(sc->sc_dev));
528 
529 	return (0);
530 }
531 
532 int
533 ucomread(dev_t dev, struct uio *uio, int flag)
534 {
535 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
536 	struct tty *tp = sc->sc_tty;
537 	int error;
538 
539 	if (sc->sc_dying)
540 		return (EIO);
541 
542 	sc->sc_refcnt++;
543 	error = ((*tp->t_linesw->l_read)(tp, uio, flag));
544 	if (--sc->sc_refcnt < 0)
545 		usb_detach_wakeup(USBDEV(sc->sc_dev));
546 	return (error);
547 }
548 
549 int
550 ucomwrite(dev_t dev, struct uio *uio, int flag)
551 {
552 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
553 	struct tty *tp = sc->sc_tty;
554 	int error;
555 
556 	if (sc->sc_dying)
557 		return (EIO);
558 
559 	sc->sc_refcnt++;
560 	error = ((*tp->t_linesw->l_write)(tp, uio, flag));
561 	if (--sc->sc_refcnt < 0)
562 		usb_detach_wakeup(USBDEV(sc->sc_dev));
563 	return (error);
564 }
565 
566 int
567 ucompoll(dev_t dev, int events, usb_proc_ptr p)
568 {
569 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
570 	struct tty *tp = sc->sc_tty;
571 	int error;
572 
573 	if (sc->sc_dying)
574 		return (EIO);
575 
576 	sc->sc_refcnt++;
577 	error = ((*tp->t_linesw->l_poll)(tp, events, p));
578 	if (--sc->sc_refcnt < 0)
579 		usb_detach_wakeup(USBDEV(sc->sc_dev));
580 	return (error);
581 }
582 
583 struct tty *
584 ucomtty(dev_t dev)
585 {
586 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
587 	struct tty *tp = sc->sc_tty;
588 
589 	return (tp);
590 }
591 
592 int
593 ucomioctl(dev_t dev, u_long cmd, caddr_t data, int flag, usb_proc_ptr p)
594 {
595 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(dev)];
596 	int error;
597 
598 	sc->sc_refcnt++;
599 	error = ucom_do_ioctl(sc, cmd, data, flag, p);
600 	if (--sc->sc_refcnt < 0)
601 		usb_detach_wakeup(USBDEV(sc->sc_dev));
602 	return (error);
603 }
604 
605 Static int
606 ucom_do_ioctl(struct ucom_softc *sc, u_long cmd, caddr_t data,
607 	      int flag, usb_proc_ptr p)
608 {
609 	struct tty *tp = sc->sc_tty;
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, p);
619 	if (error != EPASSTHROUGH)
620 		return (error);
621 
622 	error = ttioctl(tp, cmd, data, flag, p);
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, p);
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 		sc->sc_msr = 0;
797 	}
798 }
799 
800 Static int
801 ucomparam(struct tty *tp, struct termios *t)
802 {
803 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(tp->t_dev)];
804 	int error;
805 
806 	if (sc->sc_dying)
807 		return (EIO);
808 
809 	/* Check requested parameters. */
810 	if (t->c_ispeed && t->c_ispeed != t->c_ospeed)
811 		return (EINVAL);
812 
813 	/*
814 	 * For the console, always force CLOCAL and !HUPCL, so that the port
815 	 * is always active.
816 	 */
817 	if (ISSET(sc->sc_swflags, TIOCFLAG_SOFTCAR)) {
818 		SET(t->c_cflag, CLOCAL);
819 		CLR(t->c_cflag, HUPCL);
820 	}
821 
822 	/*
823 	 * If there were no changes, don't do anything.  This avoids dropping
824 	 * input and improves performance when all we did was frob things like
825 	 * VMIN and VTIME.
826 	 */
827 	if (tp->t_ospeed == t->c_ospeed &&
828 	    tp->t_cflag == t->c_cflag)
829 		return (0);
830 
831 	/* XXX lcr = ISSET(sc->sc_lcr, LCR_SBREAK) | cflag2lcr(t->c_cflag); */
832 
833 	/* And copy to tty. */
834 	tp->t_ispeed = 0;
835 	tp->t_ospeed = t->c_ospeed;
836 	tp->t_cflag = t->c_cflag;
837 
838 	if (sc->sc_methods->ucom_param != NULL) {
839 		error = sc->sc_methods->ucom_param(sc->sc_parent, sc->sc_portno,
840 			    t);
841 		if (error)
842 			return (error);
843 	}
844 
845 	/* XXX worry about CHWFLOW */
846 
847 	/*
848 	 * Update the tty layer's idea of the carrier bit, in case we changed
849 	 * CLOCAL or MDMBUF.  We don't hang up here; we only do that by
850 	 * explicit request.
851 	 */
852 	DPRINTF(("ucomparam: l_modem\n"));
853 	(void) (*tp->t_linesw->l_modem)(tp, 1 /* XXX carrier */ );
854 
855 #if 0
856 XXX what if the hardware is not open
857 	if (!ISSET(t->c_cflag, CHWFLOW)) {
858 		if (sc->sc_tx_stopped) {
859 			sc->sc_tx_stopped = 0;
860 			ucomstart(tp);
861 		}
862 	}
863 #endif
864 
865 	return (0);
866 }
867 
868 /*
869  * (un)block input via hw flowcontrol
870  */
871 Static void
872 ucom_hwiflow(struct ucom_softc *sc)
873 {
874 	DPRINTF(("ucom_hwiflow:\n"));
875 #if 0
876 XXX
877 	bus_space_tag_t iot = sc->sc_iot;
878 	bus_space_handle_t ioh = sc->sc_ioh;
879 
880 	if (sc->sc_mcr_rts == 0)
881 		return;
882 
883 	if (ISSET(sc->sc_rx_flags, RX_ANY_BLOCK)) {
884 		CLR(sc->sc_mcr, sc->sc_mcr_rts);
885 		CLR(sc->sc_mcr_active, sc->sc_mcr_rts);
886 	} else {
887 		SET(sc->sc_mcr, sc->sc_mcr_rts);
888 		SET(sc->sc_mcr_active, sc->sc_mcr_rts);
889 	}
890 	bus_space_write_1(iot, ioh, com_mcr, sc->sc_mcr_active);
891 #endif
892 }
893 
894 Static void
895 ucomstart(struct tty *tp)
896 {
897 	struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(tp->t_dev)];
898 	usbd_status err;
899 	int s;
900 	u_char *data;
901 	int cnt;
902 
903 	if (sc->sc_dying)
904 		return;
905 
906 	s = spltty();
907 	if (ISSET(tp->t_state, TS_BUSY | TS_TIMEOUT | TS_TTSTOP)) {
908 		DPRINTFN(4,("ucomstart: no go, state=0x%x\n", tp->t_state));
909 		goto out;
910 	}
911 	if (sc->sc_tx_stopped)
912 		goto out;
913 
914 	if (tp->t_outq.c_cc <= tp->t_lowat) {
915 		if (ISSET(tp->t_state, TS_ASLEEP)) {
916 			CLR(tp->t_state, TS_ASLEEP);
917 			wakeup(&tp->t_outq);
918 		}
919 		selwakeup(&tp->t_wsel);
920 		if (tp->t_outq.c_cc == 0)
921 			goto out;
922 	}
923 
924 	/* Grab the first contiguous region of buffer space. */
925 	data = tp->t_outq.c_cf;
926 	cnt = ndqb(&tp->t_outq, 0);
927 
928 	if (cnt == 0) {
929 		DPRINTF(("ucomstart: cnt==0\n"));
930 		goto out;
931 	}
932 
933 	SET(tp->t_state, TS_BUSY);
934 
935 	if (cnt > sc->sc_obufsize) {
936 		DPRINTF(("ucomstart: big buffer %d chars\n", cnt));
937 		cnt = sc->sc_obufsize;
938 	}
939 	if (sc->sc_methods->ucom_write != NULL)
940 		sc->sc_methods->ucom_write(sc->sc_parent, sc->sc_portno,
941 					   sc->sc_obuf, data, &cnt);
942 	else
943 		memcpy(sc->sc_obuf, data, cnt);
944 
945 	DPRINTFN(4,("ucomstart: %d chars\n", cnt));
946 	usbd_setup_xfer(sc->sc_oxfer, sc->sc_bulkout_pipe,
947 			(usbd_private_handle)sc, sc->sc_obuf, cnt,
948 			USBD_NO_COPY, USBD_NO_TIMEOUT, ucomwritecb);
949 	/* What can we do on error? */
950 	err = usbd_transfer(sc->sc_oxfer);
951 #ifdef DIAGNOSTIC
952 	if (err != USBD_IN_PROGRESS)
953 		printf("ucomstart: err=%s\n", usbd_errstr(err));
954 #endif
955 
956 out:
957 	splx(s);
958 }
959 
960 void
961 ucomstop(struct tty *tp, int flag)
962 {
963 	DPRINTF(("ucomstop: flag=%d\n", flag));
964 #if 0
965 	/*struct ucom_softc *sc = ucom_cd.cd_devs[UCOMUNIT(tp->t_dev)];*/
966 	int s;
967 
968 	s = spltty();
969 	if (ISSET(tp->t_state, TS_BUSY)) {
970 		DPRINTF(("ucomstop: XXX\n"));
971 		/* sc->sc_tx_stopped = 1; */
972 		if (!ISSET(tp->t_state, TS_TTSTOP))
973 			SET(tp->t_state, TS_FLUSH);
974 	}
975 	splx(s);
976 #endif
977 }
978 
979 Static void
980 ucomwritecb(usbd_xfer_handle xfer, usbd_private_handle p, usbd_status status)
981 {
982 	struct ucom_softc *sc = (struct ucom_softc *)p;
983 	struct tty *tp = sc->sc_tty;
984 	u_int32_t cc;
985 	int s;
986 
987 	DPRINTFN(5,("ucomwritecb: status=%d\n", status));
988 
989 	if (status == USBD_CANCELLED || sc->sc_dying)
990 		goto error;
991 
992 	if (status) {
993 		DPRINTF(("ucomwritecb: status=%d\n", status));
994 		usbd_clear_endpoint_stall_async(sc->sc_bulkin_pipe);
995 		/* XXX we should restart after some delay. */
996 		goto error;
997 	}
998 
999 	usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
1000 #if defined(__NetBSD__) && NRND > 0
1001 	rnd_add_uint32(&sc->sc_rndsource, cc);
1002 #endif
1003 	DPRINTFN(5,("ucomwritecb: cc=%d\n", cc));
1004 	/* convert from USB bytes to tty bytes */
1005 	cc -= sc->sc_opkthdrlen;
1006 
1007 	s = spltty();
1008 	CLR(tp->t_state, TS_BUSY);
1009 	if (ISSET(tp->t_state, TS_FLUSH))
1010 		CLR(tp->t_state, TS_FLUSH);
1011 	else
1012 		ndflush(&tp->t_outq, cc);
1013 	(*tp->t_linesw->l_start)(tp);
1014 	splx(s);
1015 	return;
1016 
1017 error:
1018 	s = spltty();
1019 	CLR(tp->t_state, TS_BUSY);
1020 	splx(s);
1021 }
1022 
1023 Static usbd_status
1024 ucomstartread(struct ucom_softc *sc)
1025 {
1026 	usbd_status err;
1027 
1028 	DPRINTFN(5,("ucomstartread: start\n"));
1029 	usbd_setup_xfer(sc->sc_ixfer, sc->sc_bulkin_pipe,
1030 			(usbd_private_handle)sc,
1031 			sc->sc_ibuf, sc->sc_ibufsize,
1032 			USBD_SHORT_XFER_OK | USBD_NO_COPY,
1033 			USBD_NO_TIMEOUT, ucomreadcb);
1034 	err = usbd_transfer(sc->sc_ixfer);
1035 	if (err != USBD_IN_PROGRESS) {
1036 		DPRINTF(("ucomstartread: err=%s\n", usbd_errstr(err)));
1037 		return (err);
1038 	}
1039 	return (USBD_NORMAL_COMPLETION);
1040 }
1041 
1042 Static void
1043 ucomreadcb(usbd_xfer_handle xfer, usbd_private_handle p, usbd_status status)
1044 {
1045 	struct ucom_softc *sc = (struct ucom_softc *)p;
1046 	struct tty *tp = sc->sc_tty;
1047 	int (*rint)(int c, struct tty *tp) = tp->t_linesw->l_rint;
1048 	usbd_status err;
1049 	u_int32_t cc;
1050 	u_char *cp;
1051 	int s;
1052 
1053 	DPRINTFN(5,("ucomreadcb: status=%d\n", status));
1054 
1055 	if (status == USBD_CANCELLED || status == USBD_IOERROR ||
1056 	    sc->sc_dying) {
1057 		DPRINTF(("ucomreadcb: dying\n"));
1058 		/* Send something to wake upper layer */
1059 		s = spltty();
1060 		(*rint)('\n', tp);
1061 		ttwakeup(tp);
1062 		splx(s);
1063 		return;
1064 	}
1065 
1066 	if (status) {
1067 		usbd_clear_endpoint_stall_async(sc->sc_bulkin_pipe);
1068 		/* XXX we should restart after some delay. */
1069 		return;
1070 	}
1071 
1072 	usbd_get_xfer_status(xfer, NULL, (void *)&cp, &cc, NULL);
1073 #if defined(__NetBSD__) && NRND > 0
1074 	rnd_add_uint32(&sc->sc_rndsource, cc);
1075 #endif
1076 	DPRINTFN(5,("ucomreadcb: got %d chars, tp=%p\n", cc, tp));
1077 	if (sc->sc_methods->ucom_read != NULL)
1078 		sc->sc_methods->ucom_read(sc->sc_parent, sc->sc_portno,
1079 					  &cp, &cc);
1080 
1081 	s = spltty();
1082 	/* Give characters to tty layer. */
1083 	while (cc-- > 0) {
1084 		DPRINTFN(7,("ucomreadcb: char=0x%02x\n", *cp));
1085 		if ((*rint)(*cp++, tp) == -1) {
1086 			/* XXX what should we do? */
1087 			printf("%s: lost %d chars\n", USBDEVNAME(sc->sc_dev),
1088 			       cc);
1089 			break;
1090 		}
1091 	}
1092 	splx(s);
1093 
1094 	err = ucomstartread(sc);
1095 	if (err) {
1096 		printf("%s: read start failed\n", USBDEVNAME(sc->sc_dev));
1097 		/* XXX what should we dow now? */
1098 	}
1099 }
1100 
1101 Static void
1102 ucom_cleanup(struct ucom_softc *sc)
1103 {
1104 	DPRINTF(("ucom_cleanup: closing pipes\n"));
1105 
1106 	ucom_shutdown(sc);
1107 	if (sc->sc_bulkin_pipe != NULL) {
1108 		usbd_abort_pipe(sc->sc_bulkin_pipe);
1109 		usbd_close_pipe(sc->sc_bulkin_pipe);
1110 		sc->sc_bulkin_pipe = NULL;
1111 	}
1112 	if (sc->sc_bulkout_pipe != NULL) {
1113 		usbd_abort_pipe(sc->sc_bulkout_pipe);
1114 		usbd_close_pipe(sc->sc_bulkout_pipe);
1115 		sc->sc_bulkout_pipe = NULL;
1116 	}
1117 	if (sc->sc_ixfer != NULL) {
1118 		usbd_free_xfer(sc->sc_ixfer);
1119 		sc->sc_ixfer = NULL;
1120 	}
1121 	if (sc->sc_oxfer != NULL) {
1122 		usbd_free_xfer(sc->sc_oxfer);
1123 		sc->sc_oxfer = NULL;
1124 	}
1125 }
1126 
1127 #endif /* NUCOM > 0 */
1128 
1129 int
1130 ucomprint(void *aux, const char *pnp)
1131 {
1132 	struct ucom_attach_args *uca = aux;
1133 
1134 	if (pnp)
1135 		aprint_normal("ucom at %s", pnp);
1136 	if (uca->portno != UCOM_UNK_PORTNO)
1137 		aprint_normal(" portno %d", uca->portno);
1138 	return (UNCONF);
1139 }
1140 
1141 int
1142 ucomsubmatch(struct device *parent, struct cfdata *cf,
1143 	     const locdesc_t *ldesc, void *aux)
1144 {
1145 	struct ucom_attach_args *uca = aux;
1146 
1147 	if (uca->portno != UCOM_UNK_PORTNO &&
1148 	    cf->cf_loc[UCOMBUSCF_PORTNO] != UCOMBUSCF_PORTNO_DEFAULT &&
1149 	    cf->cf_loc[UCOMBUSCF_PORTNO] != uca->portno)
1150 		return (0);
1151 	return (config_match(parent, cf, aux));
1152 }
1153