xref: /netbsd-src/sys/dev/usb/ucomvar.h (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: ucomvar.h,v 1.15 2007/03/04 06:02:49 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1999 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 
41 /* just for ucom_attach_args, not in the config namespace */
42 #define UCOM_UNK_PORTNO (-1)
43 
44 struct	ucom_softc;
45 
46 struct ucom_methods {
47 	void (*ucom_get_status)(void *sc, int portno, u_char *lsr, u_char *msr);
48 	void (*ucom_set)(void *sc, int portno, int reg, int onoff);
49 #define UCOM_SET_DTR 1
50 #define UCOM_SET_RTS 2
51 #define UCOM_SET_BREAK 3
52 	int (*ucom_param)(void *sc, int portno, struct termios *);
53 	int (*ucom_ioctl)(void *sc, int portno, u_long cmd,
54 			  void *data, int flag, usb_proc_ptr p);
55 	int (*ucom_open)(void *sc, int portno);
56 	void (*ucom_close)(void *sc, int portno);
57 	void (*ucom_read)(void *sc, int portno, u_char **ptr, u_int32_t *count);
58 	void (*ucom_write)(void *sc, int portno, u_char *to, u_char *from,
59 			   u_int32_t *count);
60 };
61 
62 /* modem control register */
63 #define	UMCR_RTS	0x02	/* Request To Send */
64 #define	UMCR_DTR	0x01	/* Data Terminal Ready */
65 
66 /* line status register */
67 #define	ULSR_RCV_FIFO	0x80
68 #define	ULSR_TSRE	0x40	/* Transmitter empty: byte sent */
69 #define	ULSR_TXRDY	0x20	/* Transmitter buffer empty */
70 #define	ULSR_BI		0x10	/* Break detected */
71 #define	ULSR_FE		0x08	/* Framing error: bad stop bit */
72 #define	ULSR_PE		0x04	/* Parity error */
73 #define	ULSR_OE		0x02	/* Overrun, lost incoming byte */
74 #define	ULSR_RXRDY	0x01	/* Byte ready in Receive Buffer */
75 #define	ULSR_RCV_MASK	0x1f	/* Mask for incoming data or error */
76 
77 /* modem status register */
78 /* All deltas are from the last read of the MSR. */
79 #define	UMSR_DCD	0x80	/* Current Data Carrier Detect */
80 #define	UMSR_RI		0x40	/* Current Ring Indicator */
81 #define	UMSR_DSR	0x20	/* Current Data Set Ready */
82 #define	UMSR_CTS	0x10	/* Current Clear to Send */
83 #define	UMSR_DDCD	0x08	/* DCD has changed state */
84 #define	UMSR_TERI	0x04	/* RI has toggled low to high */
85 #define	UMSR_DDSR	0x02	/* DSR has changed state */
86 #define	UMSR_DCTS	0x01	/* CTS has changed state */
87 
88 struct ucom_attach_args {
89 	int portno;
90 	int bulkin;
91 	int bulkout;
92 	u_int ibufsize;
93 	u_int ibufsizepad;
94 	u_int obufsize;
95 	u_int opkthdrlen;
96 	const char *info;	/* attach message */
97 	usbd_device_handle device;
98 	usbd_interface_handle iface;
99 	struct ucom_methods *methods;
100 	void *arg;
101 };
102 
103 int ucomprint(void *, const char *);
104 int ucomsubmatch(struct device *t, struct cfdata *,
105 		 const int *, void *);
106 void ucom_status_change(struct ucom_softc *);
107