usb_serial.h revision 188413
1/* $NetBSD: ucomvar.h,v 1.9 2001/01/23 21:56:17 augustss Exp $ */ 2/* $FreeBSD: head/sys/dev/usb2/serial/usb2_serial.h 188413 2009-02-09 22:05:25Z thompsa $ */ 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 _USB2_SERIAL_H_ 68#define _USB2_SERIAL_H_ 69 70#include <sys/tty.h> 71#include <sys/serial.h> 72#include <sys/fcntl.h> 73#include <sys/termios.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 82struct usb2_device; 83struct usb2_com_softc; 84struct usb2_device_request; 85struct thread; 86 87/* 88 * NOTE: There is no guarantee that "usb2_com_cfg_close()" will 89 * be called after "usb2_com_cfg_open()" if the device is detached 90 * while it is open! 91 */ 92struct usb2_com_callback { 93 void (*usb2_com_cfg_get_status) (struct usb2_com_softc *, uint8_t *plsr, uint8_t *pmsr); 94 void (*usb2_com_cfg_set_dtr) (struct usb2_com_softc *, uint8_t); 95 void (*usb2_com_cfg_set_rts) (struct usb2_com_softc *, uint8_t); 96 void (*usb2_com_cfg_set_break) (struct usb2_com_softc *, uint8_t); 97 void (*usb2_com_cfg_param) (struct usb2_com_softc *, struct termios *); 98 void (*usb2_com_cfg_open) (struct usb2_com_softc *); 99 void (*usb2_com_cfg_close) (struct usb2_com_softc *); 100 int (*usb2_com_pre_open) (struct usb2_com_softc *); 101 int (*usb2_com_pre_param) (struct usb2_com_softc *, struct termios *); 102 int (*usb2_com_ioctl) (struct usb2_com_softc *, uint32_t, caddr_t, int, struct thread *); 103 void (*usb2_com_start_read) (struct usb2_com_softc *); 104 void (*usb2_com_stop_read) (struct usb2_com_softc *); 105 void (*usb2_com_start_write) (struct usb2_com_softc *); 106 void (*usb2_com_stop_write) (struct usb2_com_softc *); 107 void (*usb2_com_tty_name) (struct usb2_com_softc *, char *pbuf, uint16_t buflen, uint16_t local_subunit); 108}; 109 110/* Line status register */ 111#define ULSR_RCV_FIFO 0x80 112#define ULSR_TSRE 0x40 /* Transmitter empty: byte sent */ 113#define ULSR_TXRDY 0x20 /* Transmitter buffer empty */ 114#define ULSR_BI 0x10 /* Break detected */ 115#define ULSR_FE 0x08 /* Framing error: bad stop bit */ 116#define ULSR_PE 0x04 /* Parity error */ 117#define ULSR_OE 0x02 /* Overrun, lost incoming byte */ 118#define ULSR_RXRDY 0x01 /* Byte ready in Receive Buffer */ 119#define ULSR_RCV_MASK 0x1f /* Mask for incoming data or error */ 120 121struct usb2_com_cfg_task { 122 struct usb2_proc_msg hdr; 123 struct usb2_com_softc *sc; 124}; 125 126struct usb2_com_param_task { 127 struct usb2_proc_msg hdr; 128 struct usb2_com_softc *sc; 129 struct termios termios_copy; 130}; 131 132struct usb2_com_super_softc { 133 struct usb2_process sc_tq; 134}; 135 136struct usb2_com_softc { 137 /* 138 * NOTE: To avoid loosing level change information we use two 139 * tasks instead of one for all commands. 140 * 141 * Level changes are transitions like: 142 * 143 * ON->OFF 144 * OFF->ON 145 * OPEN->CLOSE 146 * CLOSE->OPEN 147 */ 148 struct usb2_com_cfg_task sc_start_task[2]; 149 struct usb2_com_cfg_task sc_open_task[2]; 150 struct usb2_com_cfg_task sc_close_task[2]; 151 struct usb2_com_cfg_task sc_line_state_task[2]; 152 struct usb2_com_cfg_task sc_status_task[2]; 153 struct usb2_com_param_task sc_param_task[2]; 154 struct cv sc_cv; 155 const struct usb2_com_callback *sc_callback; 156 struct usb2_com_super_softc *sc_super; 157 struct tty *sc_tty; 158 struct mtx *sc_mtx; 159 void *sc_parent; 160 uint32_t sc_unit; 161 uint32_t sc_local_unit; 162 uint16_t sc_portno; 163 uint8_t sc_flag; 164#define UCOM_FLAG_RTS_IFLOW 0x01 /* use RTS input flow control */ 165#define UCOM_FLAG_GONE 0x02 /* the device is gone */ 166#define UCOM_FLAG_ATTACHED 0x04 /* set if attached */ 167#define UCOM_FLAG_GP_DATA 0x08 /* set if get and put data is possible */ 168#define UCOM_FLAG_WR_START 0x10 /* set if write start was issued */ 169#define UCOM_FLAG_LL_READY 0x20 /* set if low layer is ready */ 170#define UCOM_FLAG_HL_READY 0x40 /* set if high layer is ready */ 171 uint8_t sc_lsr; 172 uint8_t sc_msr; 173 uint8_t sc_mcr; 174 uint8_t sc_ttyfreed; /* set when TTY has been freed */ 175 /* programmed line state bits */ 176 uint8_t sc_pls_set; /* set bits */ 177 uint8_t sc_pls_clr; /* cleared bits */ 178 uint8_t sc_pls_curr; /* last state */ 179#define UCOM_LS_DTR 0x01 180#define UCOM_LS_RTS 0x02 181#define UCOM_LS_BREAK 0x04 182}; 183 184#define usb2_com_cfg_do_request(udev,com,req,ptr,flags,timo) \ 185 usb2_do_request_proc(udev,&(com)->sc_super->sc_tq,req,ptr,flags,NULL,timo) 186 187int usb2_com_attach(struct usb2_com_super_softc *, 188 struct usb2_com_softc *, uint32_t, void *, 189 const struct usb2_com_callback *callback, struct mtx *); 190void usb2_com_detach(struct usb2_com_super_softc *, 191 struct usb2_com_softc *, uint32_t); 192void usb2_com_status_change(struct usb2_com_softc *); 193uint8_t usb2_com_get_data(struct usb2_com_softc *, struct usb2_page_cache *, 194 uint32_t, uint32_t, uint32_t *); 195void usb2_com_put_data(struct usb2_com_softc *, struct usb2_page_cache *, 196 uint32_t, uint32_t); 197uint8_t usb2_com_cfg_is_gone(struct usb2_com_softc *); 198#endif /* _USB2_SERIAL_H_ */ 199