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 #include <sys/timepps.h> 74 75 /* We should seriously clean this up! */ 76 #define SET(t, f) (t) |= (f) 77 #define CLR(t, f) (t) &= ~((unsigned)(f)) 78 #define ISSET(t, f) ((t) & (f)) 79 80 /* Module interface related macros */ 81 #define UCOM_MODVER 1 82 83 #define UCOM_MINVER 1 84 #define UCOM_PREFVER UCOM_MODVER 85 #define UCOM_MAXVER 1 86 #define UCOM_JITTERBUF_SIZE 128 /* bytes */ 87 88 struct usb_device; 89 struct ucom_softc; 90 struct usb_device_request; 91 struct thread; 92 93 /* 94 * NOTE: There is no guarantee that "ucom_cfg_close()" will 95 * be called after "ucom_cfg_open()" if the device is detached 96 * while it is open! 97 */ 98 struct ucom_callback { 99 void (*ucom_cfg_get_status) (struct ucom_softc *, uint8_t *plsr, uint8_t *pmsr); 100 void (*ucom_cfg_set_dtr) (struct ucom_softc *, uint8_t); 101 void (*ucom_cfg_set_rts) (struct ucom_softc *, uint8_t); 102 void (*ucom_cfg_set_break) (struct ucom_softc *, uint8_t); 103 void (*ucom_cfg_set_ring) (struct ucom_softc *, uint8_t); 104 void (*ucom_cfg_param) (struct ucom_softc *, struct termios *); 105 void (*ucom_cfg_open) (struct ucom_softc *); 106 void (*ucom_cfg_close) (struct ucom_softc *); 107 int (*ucom_pre_open) (struct ucom_softc *); 108 int (*ucom_pre_param) (struct ucom_softc *, struct termios *); 109 int (*ucom_ioctl) (struct ucom_softc *, uint32_t, caddr_t, int, struct thread *); 110 void (*ucom_start_read) (struct ucom_softc *); 111 void (*ucom_stop_read) (struct ucom_softc *); 112 void (*ucom_start_write) (struct ucom_softc *); 113 void (*ucom_stop_write) (struct ucom_softc *); 114 void (*ucom_tty_name) (struct ucom_softc *, char *pbuf, uint16_t buflen, uint16_t unit, uint16_t subunit); 115 void (*ucom_poll) (struct ucom_softc *); 116 void (*ucom_free) (struct ucom_softc *); 117 }; 118 119 /* Line status register */ 120 #define ULSR_RCV_FIFO 0x80 121 #define ULSR_TSRE 0x40 /* Transmitter empty: byte sent */ 122 #define ULSR_TXRDY 0x20 /* Transmitter buffer empty */ 123 #define ULSR_BI 0x10 /* Break detected */ 124 #define ULSR_FE 0x08 /* Framing error: bad stop bit */ 125 #define ULSR_PE 0x04 /* Parity error */ 126 #define ULSR_OE 0x02 /* Overrun, lost incoming byte */ 127 #define ULSR_RXRDY 0x01 /* Byte ready in Receive Buffer */ 128 #define ULSR_RCV_MASK 0x1f /* Mask for incoming data or error */ 129 130 struct ucom_cfg_task { 131 struct usb_proc_msg hdr; 132 struct ucom_softc *sc; 133 }; 134 135 struct ucom_param_task { 136 struct usb_proc_msg hdr; 137 struct ucom_softc *sc; 138 struct termios termios_copy; 139 }; 140 141 struct ucom_super_softc { 142 struct usb_process sc_tq; 143 int sc_unit; 144 int sc_subunits; 145 int sc_refs; 146 int sc_flag; /* see UCOM_FLAG_XXX */ 147 struct sysctl_oid *sc_sysctl_ttyname; 148 struct sysctl_oid *sc_sysctl_ttyports; 149 char sc_ttyname[16]; 150 }; 151 152 struct ucom_softc { 153 /* 154 * NOTE: To avoid losing level change information we use two 155 * tasks instead of one for all commands. 156 * 157 * Level changes are transitions like: 158 * 159 * ON->OFF 160 * OFF->ON 161 * OPEN->CLOSE 162 * CLOSE->OPEN 163 */ 164 struct ucom_cfg_task sc_start_task[2]; 165 struct ucom_cfg_task sc_open_task[2]; 166 struct ucom_cfg_task sc_close_task[2]; 167 struct ucom_cfg_task sc_line_state_task[2]; 168 struct ucom_cfg_task sc_status_task[2]; 169 struct ucom_param_task sc_param_task[2]; 170 /* pulse capturing support, PPS */ 171 struct pps_state sc_pps; 172 /* Used to set "UCOM_FLAG_GP_DATA" flag: */ 173 struct usb_proc_msg *sc_last_start_xfer; 174 const struct ucom_callback *sc_callback; 175 struct ucom_super_softc *sc_super; 176 struct tty *sc_tty; 177 struct dev *sc_dev; 178 cdev_t sc_cdev; /* this is the /dev/ttyUX */ 179 cdev_t sc_cdev_init; /* /dev/ttyUX.init */ 180 cdev_t sc_cdev_lock; /* /dev/ttyUX.lock */ 181 cdev_t sc_cdev2; /* /dev/cuaUX */ 182 cdev_t sc_cdev2_init; /* /dev/cuaUX.init */ 183 cdev_t sc_cdev2_lock; /* /dev/cuaUX.lock */ 184 struct termios sc_it_in; /* Initial state in */ 185 struct termios sc_it_out; /* Initial state out */ 186 struct termios sc_lt_in; /* Lockstate in */ 187 struct termios sc_lt_out; /* Lockstate out */ 188 struct lock *sc_lock; 189 void *sc_parent; 190 int sc_subunit; 191 uint16_t sc_jitterbuf_in; 192 uint16_t sc_jitterbuf_out; 193 uint16_t sc_portno; 194 uint16_t sc_flag; 195 #define UCOM_FLAG_RTS_IFLOW 0x01 /* use RTS input flow control */ 196 #define UCOM_FLAG_GONE 0x02 /* the device is gone */ 197 #define UCOM_FLAG_ATTACHED 0x04 /* set if attached */ 198 #define UCOM_FLAG_GP_DATA 0x08 /* set if get and put data is possible */ 199 #define UCOM_FLAG_LL_READY 0x20 /* set if low layer is ready */ 200 #define UCOM_FLAG_HL_READY 0x40 /* set if high layer is ready */ 201 #define UCOM_FLAG_CONSOLE 0x80 /* set if device is a console */ 202 #define UCOM_FLAG_WAIT_REFS 0x0100 /* set if we must wait for refs */ 203 #define UCOM_FLAG_FREE_UNIT 0x0200 /* set if we must free the unit */ 204 #define UCOM_FLAG_INWAKEUP 0x0400 /* set if we are in the tsw_inwakeup callback */ 205 uint8_t sc_lsr; 206 uint8_t sc_msr; 207 uint8_t sc_mcr; 208 /* programmed line state bits */ 209 uint8_t sc_pls_set; /* set bits */ 210 uint8_t sc_pls_clr; /* cleared bits */ 211 uint8_t sc_pls_curr; /* last state */ 212 #define UCOM_LS_DTR 0x01 213 #define UCOM_LS_RTS 0x02 214 #define UCOM_LS_BREAK 0x04 215 #define UCOM_LS_RING 0x08 216 217 u_char hotchar; 218 uint8_t sc_jitterbuf[UCOM_JITTERBUF_SIZE]; 219 }; 220 221 #define UCOM_MTX_ASSERT(sc, what) KKASSERT(lockowned((sc)->sc_lock)) 222 #define UCOM_MTX_LOCK(sc) lockmgr((sc)->sc_lock, LK_EXCLUSIVE) 223 #define UCOM_MTX_UNLOCK(sc) lockmgr((sc)->sc_lock, LK_RELEASE) 224 #define UCOM_UNLOAD_DRAIN(x) \ 225 SYSUNINIT(var, SI_SUB_KLD - 3, SI_ORDER_ANY, ucom_drain_all, 0) 226 227 #define ucom_cfg_do_request(udev,com,req,ptr,flags,timo) \ 228 usbd_do_request_proc(udev,&(com)->sc_super->sc_tq,req,ptr,flags,NULL,timo) 229 230 int ucom_attach(struct ucom_super_softc *, 231 struct ucom_softc *, int, void *, 232 const struct ucom_callback *callback, struct lock *); 233 void ucom_detach(struct ucom_super_softc *, struct ucom_softc *); 234 void ucom_set_pnpinfo_usb(struct ucom_super_softc *, device_t); 235 void ucom_status_change(struct ucom_softc *); 236 uint8_t ucom_get_data(struct ucom_softc *, struct usb_page_cache *, 237 uint32_t, uint32_t, uint32_t *); 238 void ucom_put_data(struct ucom_softc *, struct usb_page_cache *, 239 uint32_t, uint32_t); 240 uint8_t ucom_cfg_is_gone(struct ucom_softc *); 241 void ucom_drain(struct ucom_super_softc *); 242 void ucom_drain_all(void *); 243 void ucom_ref(struct ucom_super_softc *); 244 int ucom_unref(struct ucom_super_softc *); 245 #endif /* _USB_SERIAL_H_ */ 246