usb_serial.h revision 194230
1184610Salfred/* $NetBSD: ucomvar.h,v 1.9 2001/01/23 21:56:17 augustss Exp $ */ 2184610Salfred/* $FreeBSD: head/sys/dev/usb/serial/usb_serial.h 194230 2009-06-15 01:09:19Z thompsa $ */ 3184610Salfred 4184610Salfred/*- 5184610Salfred * Copyright (c) 2001-2002, Shunsuke Akiyama <akiyama@jp.FreeBSD.org>. 6184610Salfred * All rights reserved. 7184610Salfred * 8184610Salfred * Redistribution and use in source and binary forms, with or without 9184610Salfred * modification, are permitted provided that the following conditions 10184610Salfred * are met: 11184610Salfred * 1. Redistributions of source code must retain the above copyright 12184610Salfred * notice, this list of conditions and the following disclaimer. 13184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 14184610Salfred * notice, this list of conditions and the following disclaimer in the 15184610Salfred * documentation and/or other materials provided with the distribution. 16184610Salfred * 17184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27184610Salfred * SUCH DAMAGE. 28184610Salfred */ 29184610Salfred 30184610Salfred/*- 31184610Salfred * Copyright (c) 1999 The NetBSD Foundation, Inc. 32184610Salfred * All rights reserved. 33184610Salfred * 34184610Salfred * This code is derived from software contributed to The NetBSD Foundation 35184610Salfred * by Lennart Augustsson (lennart@augustsson.net) at 36184610Salfred * Carlstedt Research & Technology. 37184610Salfred * 38184610Salfred * Redistribution and use in source and binary forms, with or without 39184610Salfred * modification, are permitted provided that the following conditions 40184610Salfred * are met: 41184610Salfred * 1. Redistributions of source code must retain the above copyright 42184610Salfred * notice, this list of conditions and the following disclaimer. 43184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 44184610Salfred * notice, this list of conditions and the following disclaimer in the 45184610Salfred * documentation and/or other materials provided with the distribution. 46184610Salfred * 3. All advertising materials mentioning features or use of this software 47184610Salfred * must display the following acknowledgement: 48184610Salfred * This product includes software developed by the NetBSD 49184610Salfred * Foundation, Inc. and its contributors. 50184610Salfred * 4. Neither the name of The NetBSD Foundation nor the names of its 51184610Salfred * contributors may be used to endorse or promote products derived 52184610Salfred * from this software without specific prior written permission. 53184610Salfred * 54184610Salfred * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 55184610Salfred * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 56184610Salfred * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 57184610Salfred * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 58184610Salfred * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 59184610Salfred * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 60184610Salfred * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 61184610Salfred * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 62184610Salfred * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 63184610Salfred * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 64184610Salfred * POSSIBILITY OF SUCH DAMAGE. 65184610Salfred */ 66184610Salfred 67194230Sthompsa#ifndef _USB_SERIAL_H_ 68194230Sthompsa#define _USB_SERIAL_H_ 69184610Salfred 70184610Salfred#include <sys/tty.h> 71184610Salfred#include <sys/serial.h> 72184610Salfred#include <sys/fcntl.h> 73184610Salfred#include <sys/termios.h> 74184610Salfred 75184610Salfred/* Module interface related macros */ 76184610Salfred#define UCOM_MODVER 1 77184610Salfred 78184610Salfred#define UCOM_MINVER 1 79184610Salfred#define UCOM_PREFVER UCOM_MODVER 80184610Salfred#define UCOM_MAXVER 1 81184610Salfred 82192984Sthompsastruct usb_device; 83192984Sthompsastruct ucom_softc; 84192984Sthompsastruct usb_device_request; 85184610Salfredstruct thread; 86184610Salfred 87188413Sthompsa/* 88194228Sthompsa * NOTE: There is no guarantee that "ucom_cfg_close()" will 89194228Sthompsa * be called after "ucom_cfg_open()" if the device is detached 90184610Salfred * while it is open! 91184610Salfred */ 92192984Sthompsastruct ucom_callback { 93194228Sthompsa void (*ucom_cfg_get_status) (struct ucom_softc *, uint8_t *plsr, uint8_t *pmsr); 94194228Sthompsa void (*ucom_cfg_set_dtr) (struct ucom_softc *, uint8_t); 95194228Sthompsa void (*ucom_cfg_set_rts) (struct ucom_softc *, uint8_t); 96194228Sthompsa void (*ucom_cfg_set_break) (struct ucom_softc *, uint8_t); 97194228Sthompsa void (*ucom_cfg_param) (struct ucom_softc *, struct termios *); 98194228Sthompsa void (*ucom_cfg_open) (struct ucom_softc *); 99194228Sthompsa void (*ucom_cfg_close) (struct ucom_softc *); 100194228Sthompsa int (*ucom_pre_open) (struct ucom_softc *); 101194228Sthompsa int (*ucom_pre_param) (struct ucom_softc *, struct termios *); 102194228Sthompsa int (*ucom_ioctl) (struct ucom_softc *, uint32_t, caddr_t, int, struct thread *); 103194228Sthompsa void (*ucom_start_read) (struct ucom_softc *); 104194228Sthompsa void (*ucom_stop_read) (struct ucom_softc *); 105194228Sthompsa void (*ucom_start_write) (struct ucom_softc *); 106194228Sthompsa void (*ucom_stop_write) (struct ucom_softc *); 107194228Sthompsa void (*ucom_tty_name) (struct ucom_softc *, char *pbuf, uint16_t buflen, uint16_t local_subunit); 108184610Salfred}; 109184610Salfred 110184610Salfred/* Line status register */ 111184610Salfred#define ULSR_RCV_FIFO 0x80 112184610Salfred#define ULSR_TSRE 0x40 /* Transmitter empty: byte sent */ 113184610Salfred#define ULSR_TXRDY 0x20 /* Transmitter buffer empty */ 114184610Salfred#define ULSR_BI 0x10 /* Break detected */ 115184610Salfred#define ULSR_FE 0x08 /* Framing error: bad stop bit */ 116184610Salfred#define ULSR_PE 0x04 /* Parity error */ 117184610Salfred#define ULSR_OE 0x02 /* Overrun, lost incoming byte */ 118184610Salfred#define ULSR_RXRDY 0x01 /* Byte ready in Receive Buffer */ 119184610Salfred#define ULSR_RCV_MASK 0x1f /* Mask for incoming data or error */ 120184610Salfred 121192984Sthompsastruct ucom_cfg_task { 122192984Sthompsa struct usb_proc_msg hdr; 123192984Sthompsa struct ucom_softc *sc; 124187176Sthompsa}; 125187176Sthompsa 126192984Sthompsastruct ucom_param_task { 127192984Sthompsa struct usb_proc_msg hdr; 128192984Sthompsa struct ucom_softc *sc; 129188413Sthompsa struct termios termios_copy; 130187176Sthompsa}; 131187176Sthompsa 132192984Sthompsastruct ucom_super_softc { 133192984Sthompsa struct usb_process sc_tq; 134184610Salfred}; 135184610Salfred 136192984Sthompsastruct ucom_softc { 137188413Sthompsa /* 138188413Sthompsa * NOTE: To avoid loosing level change information we use two 139188413Sthompsa * tasks instead of one for all commands. 140188413Sthompsa * 141188413Sthompsa * Level changes are transitions like: 142188413Sthompsa * 143188413Sthompsa * ON->OFF 144188413Sthompsa * OFF->ON 145188413Sthompsa * OPEN->CLOSE 146188413Sthompsa * CLOSE->OPEN 147188413Sthompsa */ 148192984Sthompsa struct ucom_cfg_task sc_start_task[2]; 149192984Sthompsa struct ucom_cfg_task sc_open_task[2]; 150192984Sthompsa struct ucom_cfg_task sc_close_task[2]; 151192984Sthompsa struct ucom_cfg_task sc_line_state_task[2]; 152192984Sthompsa struct ucom_cfg_task sc_status_task[2]; 153192984Sthompsa struct ucom_param_task sc_param_task[2]; 154184610Salfred struct cv sc_cv; 155190742Sthompsa /* Used to set "UCOM_FLAG_GP_DATA" flag: */ 156192984Sthompsa struct usb_proc_msg *sc_last_start_xfer; 157192984Sthompsa const struct ucom_callback *sc_callback; 158192984Sthompsa struct ucom_super_softc *sc_super; 159184610Salfred struct tty *sc_tty; 160188413Sthompsa struct mtx *sc_mtx; 161184610Salfred void *sc_parent; 162184610Salfred uint32_t sc_unit; 163184610Salfred uint32_t sc_local_unit; 164184610Salfred uint16_t sc_portno; 165184610Salfred uint8_t sc_flag; 166184610Salfred#define UCOM_FLAG_RTS_IFLOW 0x01 /* use RTS input flow control */ 167184610Salfred#define UCOM_FLAG_GONE 0x02 /* the device is gone */ 168184610Salfred#define UCOM_FLAG_ATTACHED 0x04 /* set if attached */ 169184610Salfred#define UCOM_FLAG_GP_DATA 0x08 /* set if get and put data is possible */ 170184610Salfred#define UCOM_FLAG_LL_READY 0x20 /* set if low layer is ready */ 171184610Salfred#define UCOM_FLAG_HL_READY 0x40 /* set if high layer is ready */ 172184610Salfred uint8_t sc_lsr; 173184610Salfred uint8_t sc_msr; 174184610Salfred uint8_t sc_mcr; 175184610Salfred uint8_t sc_ttyfreed; /* set when TTY has been freed */ 176188413Sthompsa /* programmed line state bits */ 177188413Sthompsa uint8_t sc_pls_set; /* set bits */ 178188413Sthompsa uint8_t sc_pls_clr; /* cleared bits */ 179188413Sthompsa uint8_t sc_pls_curr; /* last state */ 180188413Sthompsa#define UCOM_LS_DTR 0x01 181188413Sthompsa#define UCOM_LS_RTS 0x02 182188413Sthompsa#define UCOM_LS_BREAK 0x04 183184610Salfred}; 184184610Salfred 185194228Sthompsa#define ucom_cfg_do_request(udev,com,req,ptr,flags,timo) \ 186194228Sthompsa usbd_do_request_proc(udev,&(com)->sc_super->sc_tq,req,ptr,flags,NULL,timo) 187188413Sthompsa 188194228Sthompsaint ucom_attach(struct ucom_super_softc *, 189192984Sthompsa struct ucom_softc *, uint32_t, void *, 190192984Sthompsa const struct ucom_callback *callback, struct mtx *); 191194228Sthompsavoid ucom_detach(struct ucom_super_softc *, 192192984Sthompsa struct ucom_softc *, uint32_t); 193194228Sthompsavoid ucom_status_change(struct ucom_softc *); 194194228Sthompsauint8_t ucom_get_data(struct ucom_softc *, struct usb_page_cache *, 195188413Sthompsa uint32_t, uint32_t, uint32_t *); 196194228Sthompsavoid ucom_put_data(struct ucom_softc *, struct usb_page_cache *, 197188413Sthompsa uint32_t, uint32_t); 198194228Sthompsauint8_t ucom_cfg_is_gone(struct ucom_softc *); 199194230Sthompsa#endif /* _USB_SERIAL_H_ */ 200