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