usb_cdc.h revision 192984
1/* $NetBSD: usbcdc.h,v 1.9 2004/10/23 13:24:24 augustss Exp $ */ 2/* $FreeBSD: head/sys/dev/usb/usb_cdc.h 192984 2009-05-28 17:36:36Z thompsa $ */ 3 4/*- 5 * Copyright (c) 1998 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Lennart Augustsson (lennart@augustsson.net) at 10 * Carlstedt Research & Technology. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 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. 27 * 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. 39 */ 40 41#ifndef _USB_CDC_H_ 42#define _USB_CDC_H_ 43 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 */ 54#define UDESCSUB_CDC_NCT 10 55#define UDESCSUB_CDC_PUF 11 56#define UDESCSUB_CDC_EUF 12 57#define UDESCSUB_CDC_MCMF 13 58#define UDESCSUB_CDC_CCMF 14 59#define UDESCSUB_CDC_ENF 15 60#define UDESCSUB_CDC_ANF 16 61 62struct usb_cdc_header_descriptor { 63 uByte bLength; 64 uByte bDescriptorType; 65 uByte bDescriptorSubtype; 66 uWord bcdCDC; 67} __packed; 68 69struct usb_cdc_cm_descriptor { 70 uByte bLength; 71 uByte bDescriptorType; 72 uByte bDescriptorSubtype; 73 uByte bmCapabilities; 74#define USB_CDC_CM_DOES_CM 0x01 75#define USB_CDC_CM_OVER_DATA 0x02 76 uByte bDataInterface; 77} __packed; 78 79struct usb_cdc_acm_descriptor { 80 uByte bLength; 81 uByte bDescriptorType; 82 uByte bDescriptorSubtype; 83 uByte bmCapabilities; 84#define USB_CDC_ACM_HAS_FEATURE 0x01 85#define USB_CDC_ACM_HAS_LINE 0x02 86#define USB_CDC_ACM_HAS_BREAK 0x04 87#define USB_CDC_ACM_HAS_NETWORK_CONN 0x08 88} __packed; 89 90struct usb_cdc_union_descriptor { 91 uByte bLength; 92 uByte bDescriptorType; 93 uByte bDescriptorSubtype; 94 uByte bMasterInterface; 95 uByte bSlaveInterface[1]; 96} __packed; 97 98struct usb_cdc_ethernet_descriptor { 99 uByte bLength; 100 uByte bDescriptorType; 101 uByte bDescriptorSubtype; 102 uByte iMacAddress; 103 uDWord bmEthernetStatistics; 104 uWord wMaxSegmentSize; 105 uWord wNumberMCFilters; 106 uByte bNumberPowerFilters; 107} __packed; 108 109#define UCDC_SEND_ENCAPSULATED_COMMAND 0x00 110#define UCDC_GET_ENCAPSULATED_RESPONSE 0x01 111#define UCDC_SET_COMM_FEATURE 0x02 112#define UCDC_GET_COMM_FEATURE 0x03 113#define UCDC_ABSTRACT_STATE 0x01 114#define UCDC_COUNTRY_SETTING 0x02 115#define UCDC_CLEAR_COMM_FEATURE 0x04 116#define UCDC_SET_LINE_CODING 0x20 117#define UCDC_GET_LINE_CODING 0x21 118#define UCDC_SET_CONTROL_LINE_STATE 0x22 119#define UCDC_LINE_DTR 0x0001 120#define UCDC_LINE_RTS 0x0002 121#define UCDC_SEND_BREAK 0x23 122#define UCDC_BREAK_ON 0xffff 123#define UCDC_BREAK_OFF 0x0000 124 125struct usb_cdc_abstract_state { 126 uWord wState; 127#define UCDC_IDLE_SETTING 0x0001 128#define UCDC_DATA_MULTIPLEXED 0x0002 129} __packed; 130 131#define UCDC_ABSTRACT_STATE_LENGTH 2 132 133struct usb_cdc_line_state { 134 uDWord dwDTERate; 135 uByte bCharFormat; 136#define UCDC_STOP_BIT_1 0 137#define UCDC_STOP_BIT_1_5 1 138#define UCDC_STOP_BIT_2 2 139 uByte bParityType; 140#define UCDC_PARITY_NONE 0 141#define UCDC_PARITY_ODD 1 142#define UCDC_PARITY_EVEN 2 143#define UCDC_PARITY_MARK 3 144#define UCDC_PARITY_SPACE 4 145 uByte bDataBits; 146} __packed; 147 148#define UCDC_LINE_STATE_LENGTH 7 149 150struct usb_cdc_notification { 151 uByte bmRequestType; 152#define UCDC_NOTIFICATION 0xa1 153 uByte bNotification; 154#define UCDC_N_NETWORK_CONNECTION 0x00 155#define UCDC_N_RESPONSE_AVAILABLE 0x01 156#define UCDC_N_AUX_JACK_HOOK_STATE 0x08 157#define UCDC_N_RING_DETECT 0x09 158#define UCDC_N_SERIAL_STATE 0x20 159#define UCDC_N_CALL_STATE_CHANGED 0x28 160#define UCDC_N_LINE_STATE_CHANGED 0x29 161#define UCDC_N_CONNECTION_SPEED_CHANGE 0x2a 162 uWord wValue; 163 uWord wIndex; 164 uWord wLength; 165 uByte data[16]; 166} __packed; 167 168#define UCDC_NOTIFICATION_LENGTH 8 169 170/* 171 * Bits set in the SERIAL STATE notifcation (first byte of data) 172 */ 173 174#define UCDC_N_SERIAL_OVERRUN 0x40 175#define UCDC_N_SERIAL_PARITY 0x20 176#define UCDC_N_SERIAL_FRAMING 0x10 177#define UCDC_N_SERIAL_RI 0x08 178#define UCDC_N_SERIAL_BREAK 0x04 179#define UCDC_N_SERIAL_DSR 0x02 180#define UCDC_N_SERIAL_DCD 0x01 181 182/* Serial state bit masks */ 183#define UCDC_MDM_RXCARRIER 0x01 184#define UCDC_MDM_TXCARRIER 0x02 185#define UCDC_MDM_BREAK 0x04 186#define UCDC_MDM_RING 0x08 187#define UCDC_MDM_FRAMING_ERR 0x10 188#define UCDC_MDM_PARITY_ERR 0x20 189#define UCDC_MDM_OVERRUN_ERR 0x40 190 191#endif /* _USB_CDC_H_ */ 192