usb4bsd: Fixup some ucom issues.
[dragonfly.git] / sys / bus / u4b / serial / usb_serial.h
1 /*      $NetBSD: ucomvar.h,v 1.9 2001/01/23 21:56:17 augustss Exp $     */
2 /*      $FreeBSD$       */
3
4 /*-
5  * Copyright (c) 2001-2002, Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 /*-
31  * Copyright (c) 1999 The NetBSD Foundation, Inc.
32  * All rights reserved.
33  *
34  * This code is derived from software contributed to The NetBSD Foundation
35  * by Lennart Augustsson (lennart@augustsson.net) at
36  * Carlstedt Research & Technology.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  * 1. Redistributions of source code must retain the above copyright
42  *    notice, this list of conditions and the following disclaimer.
43  * 2. Redistributions in binary form must reproduce the above copyright
44  *    notice, this list of conditions and the following disclaimer in the
45  *    documentation and/or other materials provided with the distribution.
46  * 3. All advertising materials mentioning features or use of this software
47  *    must display the following acknowledgement:
48  *        This product includes software developed by the NetBSD
49  *        Foundation, Inc. and its contributors.
50  * 4. Neither the name of The NetBSD Foundation nor the names of its
51  *    contributors may be used to endorse or promote products derived
52  *    from this software without specific prior written permission.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
55  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
56  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
57  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
58  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
59  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
60  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
61  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
62  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
63  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
64  * POSSIBILITY OF SUCH DAMAGE.
65  */
66
67 #ifndef _USB_SERIAL_H_
68 #define _USB_SERIAL_H_
69
70 #include <sys/tty.h>
71 #include <sys/fcntl.h>
72 #include <sys/sysctl.h>
73
74 /* We should seriously clean this up! */
75 #define SET(t, f)       (t) |= (f)
76 #define CLR(t, f)       (t) &= ~((unsigned)(f))
77 #define ISSET(t, f)     ((t) & (f))
78
79 /* Module interface related macros */
80 #define UCOM_MODVER     1
81
82 #define UCOM_MINVER     1
83 #define UCOM_PREFVER    UCOM_MODVER
84 #define UCOM_MAXVER     1
85 #define UCOM_JITTERBUF_SIZE     128     /* bytes */
86
87 struct usb_device;
88 struct ucom_softc;
89 struct usb_device_request;
90 struct thread;
91
92 /*
93  * NOTE: There is no guarantee that "ucom_cfg_close()" will
94  * be called after "ucom_cfg_open()" if the device is detached
95  * while it is open!
96  */
97 struct ucom_callback {
98         void    (*ucom_cfg_get_status) (struct ucom_softc *, uint8_t *plsr, uint8_t *pmsr);
99         void    (*ucom_cfg_set_dtr) (struct ucom_softc *, uint8_t);
100         void    (*ucom_cfg_set_rts) (struct ucom_softc *, uint8_t);
101         void    (*ucom_cfg_set_break) (struct ucom_softc *, uint8_t);
102         void    (*ucom_cfg_set_ring) (struct ucom_softc *, uint8_t);
103         void    (*ucom_cfg_param) (struct ucom_softc *, struct termios *);
104         void    (*ucom_cfg_open) (struct ucom_softc *);
105         void    (*ucom_cfg_close) (struct ucom_softc *);
106         int     (*ucom_pre_open) (struct ucom_softc *);
107         int     (*ucom_pre_param) (struct ucom_softc *, struct termios *);
108         int     (*ucom_ioctl) (struct ucom_softc *, uint32_t, caddr_t, int, struct thread *);
109         void    (*ucom_start_read) (struct ucom_softc *);
110         void    (*ucom_stop_read) (struct ucom_softc *);
111         void    (*ucom_start_write) (struct ucom_softc *);
112         void    (*ucom_stop_write) (struct ucom_softc *);
113         void    (*ucom_tty_name) (struct ucom_softc *, char *pbuf, uint16_t buflen, uint16_t unit, uint16_t subunit);
114         void    (*ucom_poll) (struct ucom_softc *);
115         void    (*ucom_free) (struct ucom_softc *);
116 };
117
118 /* Line status register */
119 #define ULSR_RCV_FIFO   0x80
120 #define ULSR_TSRE       0x40            /* Transmitter empty: byte sent */
121 #define ULSR_TXRDY      0x20            /* Transmitter buffer empty */
122 #define ULSR_BI         0x10            /* Break detected */
123 #define ULSR_FE         0x08            /* Framing error: bad stop bit */
124 #define ULSR_PE         0x04            /* Parity error */
125 #define ULSR_OE         0x02            /* Overrun, lost incoming byte */
126 #define ULSR_RXRDY      0x01            /* Byte ready in Receive Buffer */
127 #define ULSR_RCV_MASK   0x1f            /* Mask for incoming data or error */
128
129 struct ucom_cfg_task {
130         struct usb_proc_msg hdr;
131         struct ucom_softc *sc;
132 };
133
134 struct ucom_param_task {
135         struct usb_proc_msg hdr;
136         struct ucom_softc *sc;
137         struct termios termios_copy;
138 };
139
140 struct ucom_super_softc {
141         struct usb_process sc_tq;
142         int sc_unit;
143         int sc_subunits;
144         int sc_refs;
145         int sc_flag;    /* see UCOM_FLAG_XXX */
146         struct sysctl_oid *sc_sysctl_ttyname;
147         struct sysctl_oid *sc_sysctl_ttyports;
148         char sc_ttyname[16];
149 };
150
151 struct ucom_softc {
152         /*
153          * NOTE: To avoid losing level change information we use two
154          * tasks instead of one for all commands.
155          *
156          * Level changes are transitions like:
157          *
158          * ON->OFF
159          * OFF->ON
160          * OPEN->CLOSE
161          * CLOSE->OPEN
162          */
163         struct ucom_cfg_task    sc_start_task[2];
164         struct ucom_cfg_task    sc_open_task[2];
165         struct ucom_cfg_task    sc_close_task[2];
166         struct ucom_cfg_task    sc_line_state_task[2];
167         struct ucom_cfg_task    sc_status_task[2];
168         struct ucom_param_task  sc_param_task[2];
169         /* Used to set "UCOM_FLAG_GP_DATA" flag: */
170         struct usb_proc_msg     *sc_last_start_xfer;
171         const struct ucom_callback *sc_callback;
172         struct ucom_super_softc *sc_super;
173         struct tty *sc_tty;
174         struct dev *sc_dev;
175         struct lock *sc_lock;
176         void   *sc_parent;
177         int sc_subunit;
178         uint16_t sc_jitterbuf_in;
179         uint16_t sc_jitterbuf_out;
180         uint16_t sc_portno;
181         uint16_t sc_flag;
182 #define UCOM_FLAG_RTS_IFLOW     0x01    /* use RTS input flow control */
183 #define UCOM_FLAG_GONE          0x02    /* the device is gone */
184 #define UCOM_FLAG_ATTACHED      0x04    /* set if attached */
185 #define UCOM_FLAG_GP_DATA       0x08    /* set if get and put data is possible */
186 #define UCOM_FLAG_LL_READY      0x20    /* set if low layer is ready */
187 #define UCOM_FLAG_HL_READY      0x40    /* set if high layer is ready */
188 #define UCOM_FLAG_CONSOLE       0x80    /* set if device is a console */
189 #define UCOM_FLAG_WAIT_REFS   0x0100    /* set if we must wait for refs */
190 #define UCOM_FLAG_FREE_UNIT   0x0200    /* set if we must free the unit */
191 #define UCOM_FLAG_INWAKEUP    0x0400    /* set if we are in the tsw_inwakeup callback */
192         uint8_t sc_lsr;
193         uint8_t sc_msr;
194         uint8_t sc_mcr;
195         /* programmed line state bits */
196         uint8_t sc_pls_set;             /* set bits */
197         uint8_t sc_pls_clr;             /* cleared bits */
198         uint8_t sc_pls_curr;            /* last state */
199 #define UCOM_LS_DTR     0x01
200 #define UCOM_LS_RTS     0x02
201 #define UCOM_LS_BREAK   0x04
202 #define UCOM_LS_RING    0x08
203
204         u_char  hotchar;
205         uint8_t sc_jitterbuf[UCOM_JITTERBUF_SIZE];
206 };
207
208 #define UCOM_MTX_ASSERT(sc, what) KKASSERT(lockowned((sc)->sc_lock))
209 #define UCOM_MTX_LOCK(sc) lockmgr((sc)->sc_lock, LK_EXCLUSIVE)
210 #define UCOM_MTX_UNLOCK(sc) lockmgr((sc)->sc_lock, LK_RELEASE)
211 #define UCOM_UNLOAD_DRAIN(x) \
212 SYSUNINIT(var, SI_SUB_KLD - 3, SI_ORDER_ANY, ucom_drain_all, 0)
213
214 #define ucom_cfg_do_request(udev,com,req,ptr,flags,timo) \
215     usbd_do_request_proc(udev,&(com)->sc_super->sc_tq,req,ptr,flags,NULL,timo)
216
217 int     ucom_attach(struct ucom_super_softc *,
218             struct ucom_softc *, int, void *,
219             const struct ucom_callback *callback, struct lock *);
220 void    ucom_detach(struct ucom_super_softc *, struct ucom_softc *);
221 void    ucom_set_pnpinfo_usb(struct ucom_super_softc *, device_t);
222 void    ucom_status_change(struct ucom_softc *);
223 uint8_t ucom_get_data(struct ucom_softc *, struct usb_page_cache *,
224             uint32_t, uint32_t, uint32_t *);
225 void    ucom_put_data(struct ucom_softc *, struct usb_page_cache *,
226             uint32_t, uint32_t);
227 uint8_t ucom_cfg_is_gone(struct ucom_softc *);
228 void    ucom_drain(struct ucom_super_softc *);
229 void    ucom_drain_all(void *);
230 void    ucom_ref(struct ucom_super_softc *);
231 int     ucom_unref(struct ucom_super_softc *);
232 #endif                                  /* _USB_SERIAL_H_ */