Home | History | Annotate | Line # | Download | only in usb
ucomvar.h revision 1.22
      1  1.22       mrg /*	$NetBSD: ucomvar.h,v 1.22 2019/05/04 08:04:13 mrg Exp $	*/
      2   1.1  augustss 
      3   1.1  augustss /*
      4   1.1  augustss  * Copyright (c) 1999 The NetBSD Foundation, Inc.
      5   1.1  augustss  * All rights reserved.
      6   1.1  augustss  *
      7   1.1  augustss  * This code is derived from software contributed to The NetBSD Foundation
      8   1.6  augustss  * by Lennart Augustsson (lennart (at) augustsson.net) at
      9   1.1  augustss  * Carlstedt Research & Technology.
     10   1.1  augustss  *
     11   1.1  augustss  * Redistribution and use in source and binary forms, with or without
     12   1.1  augustss  * modification, are permitted provided that the following conditions
     13   1.1  augustss  * are met:
     14   1.1  augustss  * 1. Redistributions of source code must retain the above copyright
     15   1.1  augustss  *    notice, this list of conditions and the following disclaimer.
     16   1.1  augustss  * 2. Redistributions in binary form must reproduce the above copyright
     17   1.1  augustss  *    notice, this list of conditions and the following disclaimer in the
     18   1.1  augustss  *    documentation and/or other materials provided with the distribution.
     19   1.1  augustss  *
     20   1.1  augustss  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21   1.1  augustss  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22   1.1  augustss  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23   1.1  augustss  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24   1.1  augustss  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25   1.1  augustss  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26   1.1  augustss  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27   1.1  augustss  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28   1.1  augustss  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29   1.1  augustss  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30   1.1  augustss  * POSSIBILITY OF SUCH DAMAGE.
     31   1.1  augustss  */
     32   1.1  augustss 
     33   1.1  augustss 
     34  1.11  drochner /* just for ucom_attach_args, not in the config namespace */
     35  1.11  drochner #define UCOM_UNK_PORTNO (-1)
     36   1.1  augustss 
     37   1.1  augustss struct	ucom_softc;
     38   1.1  augustss 
     39  1.22       mrg /*
     40  1.22       mrg  * The first argument to the ucom callbacks is the passed in ucaa_arg
     41  1.22       mrg  * member of the attach args, typically the parent softc pointer.
     42  1.22       mrg  *
     43  1.22       mrg  * All of these are optional.
     44  1.22       mrg  */
     45   1.1  augustss struct ucom_methods {
     46  1.22       mrg 	/*
     47  1.22       mrg 	 * arg2: port number
     48  1.22       mrg 	 * arg3: pointer to lsr (always non NULL)
     49  1.22       mrg 	 * arg4: pointer to msr (always non NULL)
     50  1.22       mrg 	 */
     51  1.21     skrll 	void (*ucom_get_status)(void *, int, u_char *, u_char *);
     52  1.22       mrg 	/*
     53  1.22       mrg 	 * arg2: port number
     54  1.22       mrg 	 * arg3: value to turn on or off (DTR, RTS, BREAK)
     55  1.22       mrg 	 * arg4: onoff
     56  1.22       mrg 	 */
     57  1.21     skrll 	void (*ucom_set)(void *, int, int, int);
     58   1.1  augustss #define UCOM_SET_DTR 1
     59   1.1  augustss #define UCOM_SET_RTS 2
     60   1.1  augustss #define UCOM_SET_BREAK 3
     61  1.22       mrg 	/*
     62  1.22       mrg 	 * arg2: port number
     63  1.22       mrg 	 * arg3: termios structure to set parameters from
     64  1.22       mrg 	 */
     65  1.21     skrll 	int (*ucom_param)(void *, int, struct termios *);
     66  1.22       mrg 	/*
     67  1.22       mrg 	 * arg2: port number
     68  1.22       mrg 	 * arg3: ioctl command
     69  1.22       mrg 	 * arg4: ioctl data
     70  1.22       mrg 	 * arg5: ioctl flags
     71  1.22       mrg 	 * arg6: process calling ioctl
     72  1.22       mrg 	 */
     73  1.21     skrll 	int (*ucom_ioctl)(void *, int, u_long, void *, int, proc_t *);
     74  1.22       mrg 	/* arg2: port number */
     75  1.21     skrll 	int (*ucom_open)(void *, int);
     76  1.22       mrg 	/* arg2: port number */
     77  1.21     skrll 	void (*ucom_close)(void *, int);
     78  1.18       scw 	/*
     79  1.22       mrg 	 * arg2: port number
     80  1.22       mrg 	 * arg3: pointer to buffer pointer
     81  1.22       mrg 	 * arg4: pointer to buffer count
     82  1.22       mrg 	 *
     83  1.22       mrg 	 * Note: The 'ptr' (3nd arg) and 'count' (4rd arg) pointers can be
     84  1.21     skrll 	 * adjusted as follows:
     85  1.21     skrll 	 *
     86  1.21     skrll 	 *  ptr:	If consuming characters from the start of the buffer,
     87  1.21     skrll 	 *		advance '*ptr' to skip the data consumed.
     88  1.21     skrll 	 *
     89  1.21     skrll 	 *  count:	If consuming characters at the end of the buffer,
     90  1.21     skrll 	 *		decrement '*count' by the number of characters
     91  1.21     skrll 	 *		consumed.
     92  1.21     skrll 	 *
     93  1.18       scw 	 * If consuming all characters, set '*count' to zero.
     94  1.18       scw 	 */
     95  1.21     skrll 	void (*ucom_read)(void *, int, u_char **, uint32_t *);
     96  1.22       mrg 	/*
     97  1.22       mrg 	 * arg2: port number
     98  1.22       mrg 	 * arg3: pointer to source buffer
     99  1.22       mrg 	 * arg4: pointer to destination buffer
    100  1.22       mrg 	 * arg5: pointer to buffer count
    101  1.22       mrg 	 */
    102  1.21     skrll 	void (*ucom_write)(void *, int, u_char *, u_char *, uint32_t *);
    103   1.1  augustss };
    104   1.1  augustss 
    105   1.1  augustss /* modem control register */
    106   1.1  augustss #define	UMCR_RTS	0x02	/* Request To Send */
    107   1.1  augustss #define	UMCR_DTR	0x01	/* Data Terminal Ready */
    108   1.1  augustss 
    109   1.1  augustss /* line status register */
    110   1.1  augustss #define	ULSR_RCV_FIFO	0x80
    111   1.1  augustss #define	ULSR_TSRE	0x40	/* Transmitter empty: byte sent */
    112   1.1  augustss #define	ULSR_TXRDY	0x20	/* Transmitter buffer empty */
    113   1.1  augustss #define	ULSR_BI		0x10	/* Break detected */
    114   1.1  augustss #define	ULSR_FE		0x08	/* Framing error: bad stop bit */
    115   1.1  augustss #define	ULSR_PE		0x04	/* Parity error */
    116   1.1  augustss #define	ULSR_OE		0x02	/* Overrun, lost incoming byte */
    117   1.1  augustss #define	ULSR_RXRDY	0x01	/* Byte ready in Receive Buffer */
    118   1.1  augustss #define	ULSR_RCV_MASK	0x1f	/* Mask for incoming data or error */
    119   1.1  augustss 
    120   1.1  augustss /* modem status register */
    121   1.1  augustss /* All deltas are from the last read of the MSR. */
    122   1.1  augustss #define	UMSR_DCD	0x80	/* Current Data Carrier Detect */
    123   1.1  augustss #define	UMSR_RI		0x40	/* Current Ring Indicator */
    124   1.1  augustss #define	UMSR_DSR	0x20	/* Current Data Set Ready */
    125   1.1  augustss #define	UMSR_CTS	0x10	/* Current Clear to Send */
    126   1.1  augustss #define	UMSR_DDCD	0x08	/* DCD has changed state */
    127   1.1  augustss #define	UMSR_TERI	0x04	/* RI has toggled low to high */
    128   1.1  augustss #define	UMSR_DDSR	0x02	/* DSR has changed state */
    129   1.1  augustss #define	UMSR_DCTS	0x01	/* CTS has changed state */
    130   1.1  augustss 
    131   1.1  augustss struct ucom_attach_args {
    132  1.21     skrll 	int ucaa_portno;
    133  1.21     skrll 	int ucaa_bulkin;
    134  1.21     skrll 	int ucaa_bulkout;
    135  1.21     skrll 	u_int ucaa_ibufsize;
    136  1.21     skrll 	u_int ucaa_ibufsizepad;
    137  1.21     skrll 	u_int ucaa_obufsize;
    138  1.21     skrll 	u_int ucaa_opkthdrlen;
    139  1.21     skrll 	const char *ucaa_info;	/* attach message */
    140  1.21     skrll 	struct usbd_device *ucaa_device;
    141  1.21     skrll 	struct usbd_interface *ucaa_iface;
    142  1.21     skrll 	const struct ucom_methods *ucaa_methods;
    143  1.21     skrll 	void *ucaa_arg;
    144   1.1  augustss };
    145   1.1  augustss 
    146  1.12  drochner int ucomprint(void *, const char *);
    147  1.17      cube int ucomsubmatch(device_t t, cfdata_t, const int *, void *);
    148   1.7  augustss void ucom_status_change(struct ucom_softc *);
    149