1 /* $NetBSD: usbcdc.h,v 1.3 1999/01/03 01:09:18 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/usbcdc.h,v 1.7.2.2 2000/10/31 23:01:16 n_hibma Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the NetBSD
23 * Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 * contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
44 #define UDESCSUB_CDC_HEADER 0
45 #define UDESCSUB_CDC_CM 1 /* Call Management */
46 #define UDESCSUB_CDC_ACM 2 /* Abstract Control Model */
47 #define UDESCSUB_CDC_DLM 3 /* Direct Line Management */
48 #define UDESCSUB_CDC_TRF 4 /* Telephone Ringer */
49 #define UDESCSUB_CDC_TCLSR 5 /* Telephone Call ... */
50 #define UDESCSUB_CDC_UNION 6
51 #define UDESCSUB_CDC_CS 7 /* Country Selection */
52 #define UDESCSUB_CDC_TOM 8 /* Telephone Operational Modes */
53 #define UDESCSUB_CDC_USBT 9 /* USB Terminal */
57 uByte bDescriptorType;
58 uByte bDescriptorSubtype;
60 } usb_cdc_header_descriptor_t;
64 uByte bDescriptorType;
65 uByte bDescriptorSubtype;
67 #define USB_CDC_CM_DOES_CM 0x01
68 #define USB_CDC_CM_OVER_DATA 0x02
70 } usb_cdc_cm_descriptor_t;
74 uByte bDescriptorType;
75 uByte bDescriptorSubtype;
77 #define USB_CDC_ACM_HAS_FEATURE 0x01
78 #define USB_CDC_ACM_HAS_LINE 0x02
79 #define USB_CDC_ACM_HAS_BREAK 0x04
80 #define USB_CDC_ACM_HAS_NETWORK_CONN 0x08
81 } usb_cdc_acm_descriptor_t;
85 uByte bDescriptorType;
86 uByte bDescriptorSubtype;
87 uByte bMasterInterface;
88 uByte bSlaveInterface[1];
89 } usb_cdc_union_descriptor_t;
91 #define UCDC_SEND_ENCAPSULATED_COMMAND 0x00
92 #define UCDC_GET_ENCAPSULATED_RESPONSE 0x01
93 #define UCDC_SET_COMM_FEATURE 0x02
94 #define UCDC_GET_COMM_FEATURE 0x03
95 #define UCDC_ABSTRACT_STATE 0x01
96 #define UCDC_COUNTRY_SETTING 0x02
97 #define UCDC_CLEAR_COMM_FEATURE 0x04
98 #define UCDC_SET_LINE_CODING 0x20
99 #define UCDC_GET_LINE_CODING 0x21
100 #define UCDC_SET_CONTROL_LINE_STATE 0x22
101 #define UCDC_LINE_DTR 0x0001
102 #define UCDC_LINE_RTS 0x0002
103 #define UCDC_SEND_BREAK 0x23
104 #define UCDC_BREAK_ON 0xffff
105 #define UCDC_BREAK_OFF 0x0000
109 #define UCDC_IDLE_SETTING 0x0001
110 #define UCDC_DATA_MULTIPLEXED 0x0002
111 } usb_cdc_abstract_state_t;
112 #define UCDC_ABSTRACT_STATE_LENGTH 2
117 #define UCDC_STOP_BIT_1 0
118 #define UCDC_STOP_BIT_1_5 1
119 #define UCDC_STOP_BIT_2 2
121 #define UCDC_PARITY_NONE 0
122 #define UCDC_PARITY_ODD 1
123 #define UCDC_PARITY_EVEN 2
124 #define UCDC_PARITY_MARK 3
125 #define UCDC_PARITY_SPACE 4
127 } usb_cdc_line_state_t;
128 #define UCDC_LINE_STATE_LENGTH 7
132 #define UCDC_NOTIFICATION 0xa1
134 #define UCDC_N_NETWORK_CONNECTION 0x00
135 #define UCDC_N_RESPONSE_AVAILABLE 0x01
136 #define UCDC_N_AUX_JACK_HOOK_STATE 0x08
137 #define UCDC_N_RING_DETECT 0x09
138 #define UCDC_N_SERIAL_STATE 0x20
139 #define UCDC_N_CALL_STATE_CHANGED 0x28
140 #define UCDC_N_LINE_STATE_CHANGED 0x29
141 #define UCDC_N_CONNECTION_SPEED_CHANGE 0x2a
146 } usb_cdc_notification_t;
147 #define UCDC_NOTIFICATION_LENGTH 8
149 /* Serial state bit masks */
150 #define UCDC_MDM_RXCARRIER 0x01
151 #define UCDC_MDM_TXCARRIER 0x02
152 #define UCDC_MDM_BREAK 0x04
153 #define UCDC_MDM_RING 0x08
154 #define UCDC_MDM_FRAMING_ERR 0x10
155 #define UCDC_MDM_PARITY_ERR 0x20
156 #define UCDC_MDM_OVERRUN_ERR 0x40
158 #endif /* _USBCDC_H_ */