1 /* $NetBSD: ucomvar.h,v 1.9 2001/01/23 21:56:17 augustss Exp $ */ 2 /* $FreeBSD$ */ 3 4 /*- 5 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD AND BSD-2-Clause-NetBSD 6 * 7 * Copyright (c) 2001-2002, Shunsuke Akiyama <akiyama@jp.FreeBSD.org>. 8 * All rights reserved. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 /*- 33 * Copyright (c) 1999 The NetBSD Foundation, Inc. 34 * All rights reserved. 35 * 36 * This code is derived from software contributed to The NetBSD Foundation 37 * by Lennart Augustsson (lennart@augustsson.net) at 38 * Carlstedt Research & Technology. 39 * 40 * Redistribution and use in source and binary forms, with or without 41 * modification, are permitted provided that the following conditions 42 * are met: 43 * 1. Redistributions of source code must retain the above copyright 44 * notice, this list of conditions and the following disclaimer. 45 * 2. Redistributions in binary form must reproduce the above copyright 46 * notice, this list of conditions and the following disclaimer in the 47 * documentation and/or other materials provided with the distribution. 48 * 49 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 50 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 51 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 52 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 53 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 54 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 55 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 56 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 57 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 58 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 59 * POSSIBILITY OF SUCH DAMAGE. 60 */ 61 62 #ifndef _USB_SERIAL_H_ 63 #define _USB_SERIAL_H_ 64 #include <termios.h> 65 #include <los_membox.h> 66 67 /* Module interface related macros */ 68 #define UCOM_MODVER 1 69 70 #define UCOM_MINVER 1 71 #define UCOM_PREFVER UCOM_MODVER 72 #define UCOM_MAXVER 1 73 #define UCOM_JITTERBUF_SIZE 128 /* bytes */ 74 75 struct usb_device; 76 struct ucom_softc; 77 struct usb_device_request; 78 struct thread; 79 80 typedef struct tag_ucom_handler_item 81 { 82 void* p_ucom_tx_data; 83 UINT32 length; 84 } ucom_handler_item_s; 85 86 extern UINT8 m_auc_tty_usb_handler_pool[sizeof(OS_MEMBOX_S) + 87 ((sizeof(ucom_handler_item_s) + 3) & (~3)) * 8]; 88 extern UINT32 m_uw_tty_usb_handler_queue; 89 90 struct tty{ 91 }; 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 #define TTY_NAME_LEN 16 153 struct ucom_softc { 154 /* 155 * NOTE: To avoid losing level change information we use two 156 * tasks instead of one for all commands. 157 * 158 * Level changes are transitions like: 159 * 160 * ON->OFF 161 * OFF->ON 162 * OPEN->CLOSE 163 * CLOSE->OPEN 164 */ 165 struct ucom_cfg_task sc_start_task[2]; 166 struct ucom_cfg_task sc_open_task[2]; 167 struct ucom_cfg_task sc_close_task[2]; 168 struct ucom_cfg_task sc_line_state_task[2]; 169 struct ucom_cfg_task sc_status_task[2]; 170 struct ucom_param_task sc_param_task[2]; 171 /* Used to set "UCOM_FLAG_GP_DATA" flag: */ 172 struct usb_proc_msg *sc_last_start_xfer; 173 const struct ucom_callback *sc_callback; 174 struct ucom_super_softc *sc_super; 175 struct tty *sc_tty; 176 struct mtx *sc_mtx; 177 void *sc_parent; 178 int sc_subunit; 179 uint16_t sc_jitterbuf_in; 180 uint16_t sc_jitterbuf_out; 181 uint16_t sc_portno; 182 uint16_t sc_flag; 183 char sc_name[TTY_NAME_LEN]; 184 #define UCOM_FLAG_RTS_IFLOW 0x01 /* use RTS input flow control */ 185 #define UCOM_FLAG_GONE 0x02 /* the device is gone */ 186 #define UCOM_FLAG_ATTACHED 0x04 /* set if attached */ 187 #define UCOM_FLAG_GP_DATA 0x08 /* set if get and put data is possible */ 188 #define UCOM_FLAG_LL_READY 0x20 /* set if low layer is ready */ 189 #define UCOM_FLAG_HL_READY 0x40 /* set if high layer is ready */ 190 #define UCOM_FLAG_CONSOLE 0x80 /* set if device is a console */ 191 #define UCOM_FLAG_WAIT_REFS 0x0100 /* set if we must wait for refs */ 192 #define UCOM_FLAG_FREE_UNIT 0x0200 /* set if we must free the unit */ 193 #define UCOM_FLAG_INWAKEUP 0x0400 /* set if we are in the tsw_inwakeup callback */ 194 #define UCOM_FLAG_OUTWAKEUP 0x0800 /* set if we are in the tsw_outwakeup callback */ 195 196 uint8_t sc_lsr; 197 uint8_t sc_msr; 198 uint8_t sc_mcr; 199 /* programmed line state bits */ 200 uint8_t sc_pls_set; /* set bits */ 201 uint8_t sc_pls_clr; /* cleared bits */ 202 uint8_t sc_pls_curr; /* last state */ 203 #define UCOM_LS_DTR 0x01 204 #define UCOM_LS_RTS 0x02 205 #define UCOM_LS_BREAK 0x04 206 #define UCOM_LS_RING 0x08 207 uint8_t sc_jitterbuf[UCOM_JITTERBUF_SIZE]; 208 }; 209 210 #define UCOM_MTX_ASSERT(sc, what) mtx_assert((sc)->sc_mtx, what) 211 #define UCOM_MTX_LOCK(sc) mtx_lock((sc)->sc_mtx) 212 #define UCOM_MTX_UNLOCK(sc) mtx_unlock((sc)->sc_mtx) 213 #define UCOM_UNLOAD_DRAIN(x) 214 215 #define ucom_cfg_do_request(udev,com,req,ptr,flags,timo) \ 216 usbd_do_request_proc(udev, &(com)->sc_super->sc_tq, req, ptr, flags, NULL, timo) 217 218 int ucom_attach(struct ucom_super_softc *, 219 struct ucom_softc *, int, void *, 220 const struct ucom_callback *callback, struct mtx *); 221 void ucom_detach(struct ucom_super_softc *, struct ucom_softc *); 222 void ucom_set_pnpinfo_usb(struct ucom_super_softc *, device_t); 223 void ucom_status_change(struct ucom_softc *); 224 uint8_t ucom_get_data(struct ucom_softc *, struct usb_page_cache *, 225 uint32_t, uint32_t, uint32_t *); 226 void ucom_put_data(struct ucom_softc *, struct usb_page_cache *, 227 uint32_t, uint32_t); 228 uint8_t ucom_cfg_is_gone(struct ucom_softc *); 229 void ucom_drain(struct ucom_super_softc *); 230 void ucom_drain_all(void *); 231 void ucom_ref(struct ucom_super_softc *); 232 int ucom_unref(struct ucom_super_softc *); 233 234 int ucom_open(struct ucom_softc *); 235 void ucom_start_transfers(struct ucom_softc *); 236 #endif /* _USB_SERIAL_H_ */ 237