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