1/*	$NetBSD: ucomvar.h,v 1.9 2001/01/23 21:56:17 augustss Exp $	*/
2
3/*-
4 * SPDX-License-Identifier: BSD-2-Clause
5 *
6 * Copyright (c) 2001-2002, Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31/*-
32 * Copyright (c) 1999 The NetBSD Foundation, Inc.
33 * All rights reserved.
34 *
35 * This code is derived from software contributed to The NetBSD Foundation
36 * by Lennart Augustsson (lennart@augustsson.net) at
37 * Carlstedt Research & Technology.
38 *
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
41 * are met:
42 * 1. Redistributions of source code must retain the above copyright
43 *    notice, this list of conditions and the following disclaimer.
44 * 2. Redistributions in binary form must reproduce the above copyright
45 *    notice, this list of conditions and the following disclaimer in the
46 *    documentation and/or other materials provided with the distribution.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
49 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
50 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
51 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
52 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
53 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
54 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
55 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
56 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
57 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
58 * POSSIBILITY OF SUCH DAMAGE.
59 */
60
61#ifndef _USB_SERIAL_H_
62#define	_USB_SERIAL_H_
63#include <termios.h>
64#include <los_membox.h>
65
66/* Module interface related macros */
67#define	UCOM_MODVER	1
68
69#define	UCOM_MINVER	1
70#define	UCOM_PREFVER	UCOM_MODVER
71#define	UCOM_MAXVER	1
72#define	UCOM_JITTERBUF_SIZE	128	/* bytes */
73
74struct usb_device;
75struct ucom_softc;
76struct usb_device_request;
77struct thread;
78
79typedef struct tag_ucom_handler_item
80{
81	void*	p_ucom_tx_data;
82	UINT32	length;
83} ucom_handler_item_s;
84
85extern UINT8 m_auc_tty_usb_handler_pool[sizeof(OS_MEMBOX_S) +
86	    ((sizeof(ucom_handler_item_s) + 3) & (~3)) * 8];
87extern UINT32 m_uw_tty_usb_handler_queue;
88
89struct tty{
90};
91
92/*
93 * NOTE: There is no guarantee that "ucom_cfg_close()" will
94 * be called after "ucom_cfg_open()" if the device is detached
95 * while it is open!
96 */
97struct ucom_callback {
98	void    (*ucom_cfg_get_status) (struct ucom_softc *, uint8_t *plsr, uint8_t *pmsr);
99	void    (*ucom_cfg_set_dtr) (struct ucom_softc *, uint8_t);
100	void    (*ucom_cfg_set_rts) (struct ucom_softc *, uint8_t);
101	void    (*ucom_cfg_set_break) (struct ucom_softc *, uint8_t);
102	void    (*ucom_cfg_set_ring) (struct ucom_softc *, uint8_t);
103	void    (*ucom_cfg_param) (struct ucom_softc *, struct termios *);
104	void    (*ucom_cfg_open) (struct ucom_softc *);
105	void    (*ucom_cfg_close) (struct ucom_softc *);
106	int     (*ucom_pre_open) (struct ucom_softc *);
107	int     (*ucom_pre_param) (struct ucom_softc *, struct termios *);
108	int     (*ucom_ioctl) (struct ucom_softc *, uint32_t, caddr_t, int, struct thread *);
109	void    (*ucom_start_read) (struct ucom_softc *);
110	void    (*ucom_stop_read) (struct ucom_softc *);
111	void    (*ucom_start_write) (struct ucom_softc *);
112	void    (*ucom_stop_write) (struct ucom_softc *);
113	void    (*ucom_tty_name) (struct ucom_softc *, char *pbuf, uint16_t buflen, uint16_t unit, uint16_t subunit);
114	void    (*ucom_poll) (struct ucom_softc *);
115	void	(*ucom_free) (struct ucom_softc *);
116};
117
118/* Line status register */
119#define	ULSR_RCV_FIFO	0x80
120#define	ULSR_TSRE	0x40		/* Transmitter empty: byte sent */
121#define	ULSR_TXRDY	0x20		/* Transmitter buffer empty */
122#define	ULSR_BI		0x10		/* Break detected */
123#define	ULSR_FE		0x08		/* Framing error: bad stop bit */
124#define	ULSR_PE		0x04		/* Parity error */
125#define	ULSR_OE		0x02		/* Overrun, lost incoming byte */
126#define	ULSR_RXRDY	0x01		/* Byte ready in Receive Buffer */
127#define	ULSR_RCV_MASK	0x1f	/* Mask for incoming data or error */
128
129struct ucom_cfg_task {
130	struct usb_proc_msg hdr;
131	struct ucom_softc *sc;
132};
133
134struct ucom_param_task {
135	struct usb_proc_msg hdr;
136	struct ucom_softc *sc;
137	struct termios termios_copy;
138};
139
140struct ucom_super_softc {
141	struct usb_process sc_tq;
142	int sc_unit;
143	int sc_subunits;
144	int sc_refs;
145	int sc_flag;	/* see UCOM_FLAG_XXX */
146	struct sysctl_oid *sc_sysctl_ttyname;
147	struct sysctl_oid *sc_sysctl_ttyports;
148	char sc_ttyname[16];
149};
150
151#define	TTY_NAME_LEN	16
152struct ucom_softc {
153	/*
154	 * NOTE: To avoid losing level change information we use two
155	 * tasks instead of one for all commands.
156	 *
157	 * Level changes are transitions like:
158	 *
159	 * ON->OFF
160	 * OFF->ON
161	 * OPEN->CLOSE
162	 * CLOSE->OPEN
163	 */
164	struct ucom_cfg_task	sc_start_task[2];
165	struct ucom_cfg_task	sc_open_task[2];
166	struct ucom_cfg_task	sc_close_task[2];
167	struct ucom_cfg_task	sc_line_state_task[2];
168	struct ucom_cfg_task	sc_status_task[2];
169	struct ucom_param_task	sc_param_task[2];
170	/* Used to set "UCOM_FLAG_GP_DATA" flag: */
171	struct usb_proc_msg	*sc_last_start_xfer;
172	const struct ucom_callback *sc_callback;
173	struct ucom_super_softc *sc_super;
174	struct tty *sc_tty;
175	struct mtx *sc_mtx;
176	void   *sc_parent;
177	int sc_subunit;
178	uint16_t sc_jitterbuf_in;
179	uint16_t sc_jitterbuf_out;
180	uint16_t sc_portno;
181	uint16_t sc_flag;
182	char sc_name[TTY_NAME_LEN];
183#define	UCOM_FLAG_RTS_IFLOW	0x01	/* use RTS input flow control */
184#define	UCOM_FLAG_GONE		0x02	/* the device is gone */
185#define	UCOM_FLAG_ATTACHED	0x04	/* set if attached */
186#define	UCOM_FLAG_GP_DATA	0x08	/* set if get and put data is possible */
187#define	UCOM_FLAG_LL_READY	0x20	/* set if low layer is ready */
188#define	UCOM_FLAG_HL_READY	0x40	/* set if high layer is ready */
189#define	UCOM_FLAG_CONSOLE	0x80	/* set if device is a console */
190#define	UCOM_FLAG_WAIT_REFS	0x0100	/* set if we must wait for refs */
191#define	UCOM_FLAG_FREE_UNIT	0x0200	/* set if we must free the unit */
192#define	UCOM_FLAG_INWAKEUP	0x0400	/* set if we are in the tsw_inwakeup callback */
193#define	UCOM_FLAG_OUTWAKEUP	0x0800	/* set if we are in the tsw_outwakeup callback */
194
195	uint8_t	sc_lsr;
196	uint8_t	sc_msr;
197	uint8_t	sc_mcr;
198	/* programmed line state bits */
199	uint8_t sc_pls_set;		/* set bits */
200	uint8_t sc_pls_clr;		/* cleared bits */
201	uint8_t sc_pls_curr;	/* last state */
202#define	UCOM_LS_DTR	0x01
203#define	UCOM_LS_RTS	0x02
204#define	UCOM_LS_BREAK	0x04
205#define	UCOM_LS_RING	0x08
206	uint8_t sc_jitterbuf[UCOM_JITTERBUF_SIZE];
207};
208
209#define	UCOM_MTX_ASSERT(sc, what) USB_MTX_ASSERT((sc)->sc_mtx, what)
210#define	UCOM_MTX_LOCK(sc) USB_MTX_LOCK((sc)->sc_mtx)
211#define	UCOM_MTX_UNLOCK(sc) USB_MTX_UNLOCK((sc)->sc_mtx)
212#define	UCOM_UNLOAD_DRAIN(x)
213
214#define	ucom_cfg_do_request(udev,com,req,ptr,flags,timo) \
215    usbd_do_request_proc(udev, &(com)->sc_super->sc_tq, req, ptr, flags, NULL, timo)
216
217int ucom_attach(struct ucom_super_softc *,
218	    struct ucom_softc *, int, void *,
219	    const struct ucom_callback *callback, struct mtx *);
220void ucom_detach(struct ucom_super_softc *, struct ucom_softc *);
221void ucom_set_pnpinfo_usb(struct ucom_super_softc *, device_t);
222void ucom_status_change(struct ucom_softc *);
223uint8_t ucom_get_data(struct ucom_softc *, struct usb_page_cache *,
224	    uint32_t, uint32_t, uint32_t *);
225void ucom_put_data(struct ucom_softc *, struct usb_page_cache *,
226	    uint32_t, uint32_t);
227uint8_t ucom_cfg_is_gone(struct ucom_softc *);
228void ucom_drain(struct ucom_super_softc *);
229void ucom_drain_all(void *);
230void ucom_ref(struct ucom_super_softc *);
231int ucom_unref(struct ucom_super_softc *);
232
233int ucom_open(struct ucom_softc *);
234void ucom_start_transfers(struct ucom_softc *);
235#endif					/* _USB_SERIAL_H_ */
236