1184610Salfred/* $NetBSD: ucomvar.h,v 1.9 2001/01/23 21:56:17 augustss Exp $ */ 2184610Salfred/* $FreeBSD: releng/11.0/sys/dev/usb/serial/usb_serial.h 279729 2015-03-07 18:25:58Z hselasky $ */ 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 * 47184610Salfred * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 48184610Salfred * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 49184610Salfred * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 50184610Salfred * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 51184610Salfred * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 52184610Salfred * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 53184610Salfred * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 54184610Salfred * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 55184610Salfred * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 56184610Salfred * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 57184610Salfred * POSSIBILITY OF SUCH DAMAGE. 58184610Salfred */ 59184610Salfred 60194230Sthompsa#ifndef _USB_SERIAL_H_ 61194230Sthompsa#define _USB_SERIAL_H_ 62184610Salfred 63184610Salfred#include <sys/tty.h> 64184610Salfred#include <sys/serial.h> 65184610Salfred#include <sys/fcntl.h> 66230204Shselasky#include <sys/sysctl.h> 67279729Shselasky#include <sys/timepps.h> 68184610Salfred 69184610Salfred/* Module interface related macros */ 70184610Salfred#define UCOM_MODVER 1 71184610Salfred 72184610Salfred#define UCOM_MINVER 1 73184610Salfred#define UCOM_PREFVER UCOM_MODVER 74184610Salfred#define UCOM_MAXVER 1 75242619Shselasky#define UCOM_JITTERBUF_SIZE 128 /* bytes */ 76184610Salfred 77192984Sthompsastruct usb_device; 78192984Sthompsastruct ucom_softc; 79192984Sthompsastruct usb_device_request; 80184610Salfredstruct thread; 81184610Salfred 82188413Sthompsa/* 83194228Sthompsa * NOTE: There is no guarantee that "ucom_cfg_close()" will 84194228Sthompsa * be called after "ucom_cfg_open()" if the device is detached 85184610Salfred * while it is open! 86184610Salfred */ 87192984Sthompsastruct ucom_callback { 88194228Sthompsa void (*ucom_cfg_get_status) (struct ucom_softc *, uint8_t *plsr, uint8_t *pmsr); 89194228Sthompsa void (*ucom_cfg_set_dtr) (struct ucom_softc *, uint8_t); 90194228Sthompsa void (*ucom_cfg_set_rts) (struct ucom_softc *, uint8_t); 91194228Sthompsa void (*ucom_cfg_set_break) (struct ucom_softc *, uint8_t); 92197570Sthompsa void (*ucom_cfg_set_ring) (struct ucom_softc *, uint8_t); 93194228Sthompsa void (*ucom_cfg_param) (struct ucom_softc *, struct termios *); 94194228Sthompsa void (*ucom_cfg_open) (struct ucom_softc *); 95194228Sthompsa void (*ucom_cfg_close) (struct ucom_softc *); 96194228Sthompsa int (*ucom_pre_open) (struct ucom_softc *); 97194228Sthompsa int (*ucom_pre_param) (struct ucom_softc *, struct termios *); 98194228Sthompsa int (*ucom_ioctl) (struct ucom_softc *, uint32_t, caddr_t, int, struct thread *); 99194228Sthompsa void (*ucom_start_read) (struct ucom_softc *); 100194228Sthompsa void (*ucom_stop_read) (struct ucom_softc *); 101194228Sthompsa void (*ucom_start_write) (struct ucom_softc *); 102194228Sthompsa void (*ucom_stop_write) (struct ucom_softc *); 103214761Sn_hibma void (*ucom_tty_name) (struct ucom_softc *, char *pbuf, uint16_t buflen, uint16_t unit, uint16_t subunit); 104197570Sthompsa void (*ucom_poll) (struct ucom_softc *); 105239179Shselasky void (*ucom_free) (struct ucom_softc *); 106184610Salfred}; 107184610Salfred 108184610Salfred/* Line status register */ 109184610Salfred#define ULSR_RCV_FIFO 0x80 110184610Salfred#define ULSR_TSRE 0x40 /* Transmitter empty: byte sent */ 111184610Salfred#define ULSR_TXRDY 0x20 /* Transmitter buffer empty */ 112184610Salfred#define ULSR_BI 0x10 /* Break detected */ 113184610Salfred#define ULSR_FE 0x08 /* Framing error: bad stop bit */ 114184610Salfred#define ULSR_PE 0x04 /* Parity error */ 115184610Salfred#define ULSR_OE 0x02 /* Overrun, lost incoming byte */ 116184610Salfred#define ULSR_RXRDY 0x01 /* Byte ready in Receive Buffer */ 117184610Salfred#define ULSR_RCV_MASK 0x1f /* Mask for incoming data or error */ 118184610Salfred 119192984Sthompsastruct ucom_cfg_task { 120192984Sthompsa struct usb_proc_msg hdr; 121192984Sthompsa struct ucom_softc *sc; 122187176Sthompsa}; 123187176Sthompsa 124192984Sthompsastruct ucom_param_task { 125192984Sthompsa struct usb_proc_msg hdr; 126192984Sthompsa struct ucom_softc *sc; 127188413Sthompsa struct termios termios_copy; 128187176Sthompsa}; 129187176Sthompsa 130192984Sthompsastruct ucom_super_softc { 131192984Sthompsa struct usb_process sc_tq; 132230204Shselasky int sc_unit; 133230204Shselasky int sc_subunits; 134239179Shselasky int sc_refs; 135239299Shselasky int sc_flag; /* see UCOM_FLAG_XXX */ 136230209Shselasky struct sysctl_oid *sc_sysctl_ttyname; 137230204Shselasky struct sysctl_oid *sc_sysctl_ttyports; 138230209Shselasky char sc_ttyname[16]; 139184610Salfred}; 140184610Salfred 141192984Sthompsastruct ucom_softc { 142188413Sthompsa /* 143250576Seadler * NOTE: To avoid losing level change information we use two 144188413Sthompsa * tasks instead of one for all commands. 145188413Sthompsa * 146188413Sthompsa * Level changes are transitions like: 147188413Sthompsa * 148188413Sthompsa * ON->OFF 149188413Sthompsa * OFF->ON 150188413Sthompsa * OPEN->CLOSE 151188413Sthompsa * CLOSE->OPEN 152188413Sthompsa */ 153192984Sthompsa struct ucom_cfg_task sc_start_task[2]; 154192984Sthompsa struct ucom_cfg_task sc_open_task[2]; 155192984Sthompsa struct ucom_cfg_task sc_close_task[2]; 156192984Sthompsa struct ucom_cfg_task sc_line_state_task[2]; 157192984Sthompsa struct ucom_cfg_task sc_status_task[2]; 158192984Sthompsa struct ucom_param_task sc_param_task[2]; 159279729Shselasky /* pulse capturing support, PPS */ 160279729Shselasky struct pps_state sc_pps; 161190742Sthompsa /* Used to set "UCOM_FLAG_GP_DATA" flag: */ 162192984Sthompsa struct usb_proc_msg *sc_last_start_xfer; 163192984Sthompsa const struct ucom_callback *sc_callback; 164192984Sthompsa struct ucom_super_softc *sc_super; 165184610Salfred struct tty *sc_tty; 166188413Sthompsa struct mtx *sc_mtx; 167184610Salfred void *sc_parent; 168233774Shselasky int sc_subunit; 169242619Shselasky uint16_t sc_jitterbuf_in; 170242619Shselasky uint16_t sc_jitterbuf_out; 171184610Salfred uint16_t sc_portno; 172197570Sthompsa uint16_t sc_flag; 173184610Salfred#define UCOM_FLAG_RTS_IFLOW 0x01 /* use RTS input flow control */ 174184610Salfred#define UCOM_FLAG_GONE 0x02 /* the device is gone */ 175184610Salfred#define UCOM_FLAG_ATTACHED 0x04 /* set if attached */ 176184610Salfred#define UCOM_FLAG_GP_DATA 0x08 /* set if get and put data is possible */ 177184610Salfred#define UCOM_FLAG_LL_READY 0x20 /* set if low layer is ready */ 178184610Salfred#define UCOM_FLAG_HL_READY 0x40 /* set if high layer is ready */ 179197570Sthompsa#define UCOM_FLAG_CONSOLE 0x80 /* set if device is a console */ 180239299Shselasky#define UCOM_FLAG_WAIT_REFS 0x0100 /* set if we must wait for refs */ 181239299Shselasky#define UCOM_FLAG_FREE_UNIT 0x0200 /* set if we must free the unit */ 182244489Shselasky#define UCOM_FLAG_INWAKEUP 0x0400 /* set if we are in the tsw_inwakeup callback */ 183184610Salfred uint8_t sc_lsr; 184184610Salfred uint8_t sc_msr; 185184610Salfred uint8_t sc_mcr; 186188413Sthompsa /* programmed line state bits */ 187188413Sthompsa uint8_t sc_pls_set; /* set bits */ 188188413Sthompsa uint8_t sc_pls_clr; /* cleared bits */ 189188413Sthompsa uint8_t sc_pls_curr; /* last state */ 190188413Sthompsa#define UCOM_LS_DTR 0x01 191188413Sthompsa#define UCOM_LS_RTS 0x02 192188413Sthompsa#define UCOM_LS_BREAK 0x04 193197570Sthompsa#define UCOM_LS_RING 0x08 194242619Shselasky uint8_t sc_jitterbuf[UCOM_JITTERBUF_SIZE]; 195184610Salfred}; 196184610Salfred 197239179Shselasky#define UCOM_MTX_ASSERT(sc, what) mtx_assert((sc)->sc_mtx, what) 198239179Shselasky#define UCOM_MTX_LOCK(sc) mtx_lock((sc)->sc_mtx) 199239179Shselasky#define UCOM_MTX_UNLOCK(sc) mtx_unlock((sc)->sc_mtx) 200239179Shselasky#define UCOM_UNLOAD_DRAIN(x) \ 201268080ShselaskySYSUNINIT(var, SI_SUB_KLD - 2, SI_ORDER_ANY, ucom_drain_all, 0) 202239179Shselasky 203194228Sthompsa#define ucom_cfg_do_request(udev,com,req,ptr,flags,timo) \ 204194228Sthompsa usbd_do_request_proc(udev,&(com)->sc_super->sc_tq,req,ptr,flags,NULL,timo) 205188413Sthompsa 206194228Sthompsaint ucom_attach(struct ucom_super_softc *, 207233774Shselasky struct ucom_softc *, int, void *, 208192984Sthompsa const struct ucom_callback *callback, struct mtx *); 209214761Sn_hibmavoid ucom_detach(struct ucom_super_softc *, struct ucom_softc *); 210214843Sn_hibmavoid ucom_set_pnpinfo_usb(struct ucom_super_softc *, device_t); 211194228Sthompsavoid ucom_status_change(struct ucom_softc *); 212194228Sthompsauint8_t ucom_get_data(struct ucom_softc *, struct usb_page_cache *, 213188413Sthompsa uint32_t, uint32_t, uint32_t *); 214194228Sthompsavoid ucom_put_data(struct ucom_softc *, struct usb_page_cache *, 215188413Sthompsa uint32_t, uint32_t); 216194228Sthompsauint8_t ucom_cfg_is_gone(struct ucom_softc *); 217239179Shselaskyvoid ucom_drain(struct ucom_super_softc *); 218239179Shselaskyvoid ucom_drain_all(void *); 219239179Shselaskyvoid ucom_ref(struct ucom_super_softc *); 220239179Shselaskyint ucom_unref(struct ucom_super_softc *); 221194230Sthompsa#endif /* _USB_SERIAL_H_ */ 222