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