1 /* $NetBSD: usbcdc.h,v 1.9 2004/10/23 13:24:24 augustss Exp $ */ 2 /* $FreeBSD$ */ 3 4 /*- 5 * SPDX-License-Identifier: BSD-2-Clause-NetBSD 6 * 7 * Copyright (c) 1998 The NetBSD Foundation, Inc. 8 * All rights reserved. 9 * 10 * This code is derived from software contributed to The NetBSD Foundation 11 * by Lennart Augustsson (lennart@augustsson.net) at 12 * Carlstedt Research & Technology. 13 * 14 * Redistribution and use in source and binary forms, with or without 15 * modification, are permitted provided that the following conditions 16 * are met: 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 2. Redistributions in binary form must reproduce the above copyright 20 * notice, this list of conditions and the following disclaimer in the 21 * documentation and/or other materials provided with the distribution. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 * POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36 #ifndef _USB_CDC_H_ 37 #define _USB_CDC_H_ 38 39 #define UDESCSUB_CDC_HEADER 0 40 #define UDESCSUB_CDC_CM 1 /* Call Management */ 41 #define UDESCSUB_CDC_ACM 2 /* Abstract Control Model */ 42 #define UDESCSUB_CDC_DLM 3 /* Direct Line Management */ 43 #define UDESCSUB_CDC_TRF 4 /* Telephone Ringer */ 44 #define UDESCSUB_CDC_TCLSR 5 /* Telephone Call */ 45 #define UDESCSUB_CDC_UNION 6 46 #define UDESCSUB_CDC_CS 7 /* Country Selection */ 47 #define UDESCSUB_CDC_TOM 8 /* Telephone Operational Modes */ 48 #define UDESCSUB_CDC_USBT 9 /* USB Terminal */ 49 #define UDESCSUB_CDC_NCT 10 50 #define UDESCSUB_CDC_PUF 11 51 #define UDESCSUB_CDC_EUF 12 52 #define UDESCSUB_CDC_MCMF 13 53 #define UDESCSUB_CDC_CCMF 14 54 #define UDESCSUB_CDC_ENF 15 55 #define UDESCSUB_CDC_ANF 16 56 57 struct usb_cdc_header_descriptor { 58 uByte bLength; 59 uByte bDescriptorType; 60 uByte bDescriptorSubtype; 61 uWord bcdCDC; 62 } __packed; 63 64 struct usb_cdc_cm_descriptor { 65 uByte bLength; 66 uByte bDescriptorType; 67 uByte bDescriptorSubtype; 68 uByte bmCapabilities; 69 #define USB_CDC_CM_DOES_CM 0x01 70 #define USB_CDC_CM_OVER_DATA 0x02 71 uByte bDataInterface; 72 } __packed; 73 74 struct usb_cdc_acm_descriptor { 75 uByte bLength; 76 uByte bDescriptorType; 77 uByte bDescriptorSubtype; 78 uByte bmCapabilities; 79 #define USB_CDC_ACM_HAS_FEATURE 0x01 80 #define USB_CDC_ACM_HAS_LINE 0x02 81 #define USB_CDC_ACM_HAS_BREAK 0x04 82 #define USB_CDC_ACM_HAS_NETWORK_CONN 0x08 83 } __packed; 84 85 struct usb_cdc_union_descriptor { 86 uByte bLength; 87 uByte bDescriptorType; 88 uByte bDescriptorSubtype; 89 uByte bMasterInterface; 90 uByte bSlaveInterface[1]; 91 } __packed; 92 93 struct usb_cdc_ethernet_descriptor { 94 uByte bLength; 95 uByte bDescriptorType; 96 uByte bDescriptorSubtype; 97 uByte iMacAddress; 98 uDWord bmEthernetStatistics; 99 uWord wMaxSegmentSize; 100 uWord wNumberMCFilters; 101 uByte bNumberPowerFilters; 102 } __packed; 103 104 #define UCDC_SEND_ENCAPSULATED_COMMAND 0x00 105 #define UCDC_GET_ENCAPSULATED_RESPONSE 0x01 106 #define UCDC_SET_COMM_FEATURE 0x02 107 #define UCDC_GET_COMM_FEATURE 0x03 108 #define UCDC_ABSTRACT_STATE 0x01 109 #define UCDC_COUNTRY_SETTING 0x02 110 #define UCDC_CLEAR_COMM_FEATURE 0x04 111 #define UCDC_SET_LINE_CODING 0x20 112 #define UCDC_GET_LINE_CODING 0x21 113 #define UCDC_SET_CONTROL_LINE_STATE 0x22 114 #define UCDC_LINE_DTR 0x0001 115 #define UCDC_LINE_RTS 0x0002 116 #define UCDC_SEND_BREAK 0x23 117 #define UCDC_BREAK_ON 0xffff 118 #define UCDC_BREAK_OFF 0x0000 119 120 struct usb_cdc_abstract_state { 121 uWord wState; 122 #define UCDC_IDLE_SETTING 0x0001 123 #define UCDC_DATA_MULTIPLEXED 0x0002 124 } __packed; 125 126 #define UCDC_ABSTRACT_STATE_LENGTH 2 127 128 struct usb_cdc_line_state { 129 uDWord dwDTERate; 130 uByte bCharFormat; 131 #define UCDC_STOP_BIT_1 0 132 #define UCDC_STOP_BIT_1_5 1 133 #define UCDC_STOP_BIT_2 2 134 uByte bParityType; 135 #define UCDC_PARITY_NONE 0 136 #define UCDC_PARITY_ODD 1 137 #define UCDC_PARITY_EVEN 2 138 #define UCDC_PARITY_MARK 3 139 #define UCDC_PARITY_SPACE 4 140 uByte bDataBits; 141 } __packed; 142 143 #define UCDC_LINE_STATE_LENGTH 7 144 145 struct usb_cdc_notification { 146 uByte bmRequestType; 147 #define UCDC_NOTIFICATION 0xa1 148 uByte bNotification; 149 #define UCDC_N_NETWORK_CONNECTION 0x00 150 #define UCDC_N_RESPONSE_AVAILABLE 0x01 151 #define UCDC_N_AUX_JACK_HOOK_STATE 0x08 152 #define UCDC_N_RING_DETECT 0x09 153 #define UCDC_N_SERIAL_STATE 0x20 154 #define UCDC_N_CALL_STATE_CHANGED 0x28 155 #define UCDC_N_LINE_STATE_CHANGED 0x29 156 #define UCDC_N_CONNECTION_SPEED_CHANGE 0x2a 157 uWord wValue; 158 uWord wIndex; 159 uWord wLength; 160 uByte data[16]; 161 } __packed; 162 163 #define UCDC_NOTIFICATION_LENGTH 8 164 165 /* 166 * Bits set in the SERIAL STATE notification (first byte of data) 167 */ 168 169 #define UCDC_N_SERIAL_OVERRUN 0x40 170 #define UCDC_N_SERIAL_PARITY 0x20 171 #define UCDC_N_SERIAL_FRAMING 0x10 172 #define UCDC_N_SERIAL_RI 0x08 173 #define UCDC_N_SERIAL_BREAK 0x04 174 #define UCDC_N_SERIAL_DSR 0x02 175 #define UCDC_N_SERIAL_DCD 0x01 176 177 /* Serial state bit masks */ 178 #define UCDC_MDM_RXCARRIER 0x01 179 #define UCDC_MDM_TXCARRIER 0x02 180 #define UCDC_MDM_BREAK 0x04 181 #define UCDC_MDM_RING 0x08 182 #define UCDC_MDM_FRAMING_ERR 0x10 183 #define UCDC_MDM_PARITY_ERR 0x20 184 #define UCDC_MDM_OVERRUN_ERR 0x40 185 186 /* 187 * Network Control Model, NCM16 + NCM32, protocol definitions 188 */ 189 struct usb_ncm16_hdr { 190 uDWord dwSignature; 191 uWord wHeaderLength; 192 uWord wSequence; 193 uWord wBlockLength; 194 uWord wDptIndex; 195 } __packed; 196 197 struct usb_ncm16_dp { 198 uWord wFrameIndex; 199 uWord wFrameLength; 200 } __packed; 201 202 struct usb_ncm16_dpt { 203 uDWord dwSignature; 204 uWord wLength; 205 uWord wNextNdpIndex; 206 struct usb_ncm16_dp dp[0]; 207 } __packed; 208 209 struct usb_ncm32_hdr { 210 uDWord dwSignature; 211 uWord wHeaderLength; 212 uWord wSequence; 213 uDWord dwBlockLength; 214 uDWord dwDptIndex; 215 } __packed; 216 217 struct usb_ncm32_dp { 218 uDWord dwFrameIndex; 219 uDWord dwFrameLength; 220 } __packed; 221 222 struct usb_ncm32_dpt { 223 uDWord dwSignature; 224 uWord wLength; 225 uWord wReserved6; 226 uDWord dwNextNdpIndex; 227 uDWord dwReserved12; 228 struct usb_ncm32_dp dp[0]; 229 } __packed; 230 231 /* Communications interface class specific descriptors */ 232 233 #define UCDC_NCM_FUNC_DESC_SUBTYPE 0x1A 234 235 struct usb_ncm_func_descriptor { 236 uByte bLength; 237 uByte bDescriptorType; 238 uByte bDescriptorSubtype; 239 uByte bcdNcmVersion[2]; 240 uByte bmNetworkCapabilities; 241 #define UCDC_NCM_CAP_FILTER 0x01 242 #define UCDC_NCM_CAP_MAC_ADDR 0x02 243 #define UCDC_NCM_CAP_ENCAP 0x04 244 #define UCDC_NCM_CAP_MAX_DATA 0x08 245 #define UCDC_NCM_CAP_CRCMODE 0x10 246 #define UCDC_NCM_CAP_MAX_DGRAM 0x20 247 } __packed; 248 249 /* Communications interface specific class request codes */ 250 251 #define UCDC_NCM_SET_ETHERNET_MULTICAST_FILTERS 0x40 252 #define UCDC_NCM_SET_ETHERNET_POWER_MGMT_PATTERN_FILTER 0x41 253 #define UCDC_NCM_GET_ETHERNET_POWER_MGMT_PATTERN_FILTER 0x42 254 #define UCDC_NCM_SET_ETHERNET_PACKET_FILTER 0x43 255 #define UCDC_NCM_GET_ETHERNET_STATISTIC 0x44 256 #define UCDC_NCM_GET_NTB_PARAMETERS 0x80 257 #define UCDC_NCM_GET_NET_ADDRESS 0x81 258 #define UCDC_NCM_SET_NET_ADDRESS 0x82 259 #define UCDC_NCM_GET_NTB_FORMAT 0x83 260 #define UCDC_NCM_SET_NTB_FORMAT 0x84 261 #define UCDC_NCM_GET_NTB_INPUT_SIZE 0x85 262 #define UCDC_NCM_SET_NTB_INPUT_SIZE 0x86 263 #define UCDC_NCM_GET_MAX_DATAGRAM_SIZE 0x87 264 #define UCDC_NCM_SET_MAX_DATAGRAM_SIZE 0x88 265 #define UCDC_NCM_GET_CRC_MODE 0x89 266 #define UCDC_NCM_SET_CRC_MODE 0x8A 267 268 struct usb_ncm_parameters { 269 uWord wLength; 270 uWord bmNtbFormatsSupported; 271 #define UCDC_NCM_FORMAT_NTB16 0x0001 272 #define UCDC_NCM_FORMAT_NTB32 0x0002 273 uDWord dwNtbInMaxSize; 274 uWord wNdpInDivisor; 275 uWord wNdpInPayloadRemainder; 276 uWord wNdpInAlignment; 277 uWord wReserved14; 278 uDWord dwNtbOutMaxSize; 279 uWord wNdpOutDivisor; 280 uWord wNdpOutPayloadRemainder; 281 uWord wNdpOutAlignment; 282 uWord wNtbOutMaxDatagrams; 283 } __packed; 284 285 /* Communications interface specific class notification codes */ 286 #define UCDC_NCM_NOTIF_NETWORK_CONNECTION 0x00 287 #define UCDC_NCM_NOTIF_RESPONSE_AVAILABLE 0x01 288 #define UCDC_NCM_NOTIF_CONNECTION_SPEED_CHANGE 0x2A 289 290 #endif /* _USB_CDC_H_ */ 291