include/linux/usb/cdc.h

   1 /*
   2  * USB Communications Device Class (CDC) definitions
   3  *
   4  * CDC says how to talk to lots of different types of network adapters,
   5  * notably ethernet adapters and various modems.  It's used mostly with
   6  * firmware based USB peripherals.
   7  */
   8
   9 #ifndef __LINUX_USB_CDC_H
  10 #define __LINUX_USB_CDC_H
  11
  12 #include <linux/types.h>
  13
  14 #define USB_CDC_SUBCLASS_ACM                    0x02
  15 #define USB_CDC_SUBCLASS_ETHERNET               0x06
  16 #define USB_CDC_SUBCLASS_WHCM                   0x08
  17 #define USB_CDC_SUBCLASS_DMM                    0x09
  18 #define USB_CDC_SUBCLASS_MDLM                   0x0a
  19 #define USB_CDC_SUBCLASS_OBEX                   0x0b
  20
  21 #define USB_CDC_PROTO_NONE                      0
  22
  23 #define USB_CDC_ACM_PROTO_AT_V25TER             1
  24 #define USB_CDC_ACM_PROTO_AT_PCCA101            2
  25 #define USB_CDC_ACM_PROTO_AT_PCCA101_WAKE       3
  26 #define USB_CDC_ACM_PROTO_AT_GSM                4
  27 #define USB_CDC_ACM_PROTO_AT_3G                 5
  28 #define USB_CDC_ACM_PROTO_AT_CDMA               6
  29 #define USB_CDC_ACM_PROTO_VENDOR                0xff
  30
  31 /*-------------------------------------------------------------------------*/
  32
  33 /*
  34  * Class-Specific descriptors ... there are a couple dozen of them
  35  */
  36
  37 #define USB_CDC_HEADER_TYPE             0x00    /* header_desc */
  38 #define USB_CDC_CALL_MANAGEMENT_TYPE    0x01    /* call_mgmt_descriptor */
  39 #define USB_CDC_ACM_TYPE                0x02    /* acm_descriptor */
  40 #define USB_CDC_UNION_TYPE              0x06    /* union_desc */
  41 #define USB_CDC_COUNTRY_TYPE            0x07
  42 #define USB_CDC_NETWORK_TERMINAL_TYPE   0x0a    /* network_terminal_desc */
  43 #define USB_CDC_ETHERNET_TYPE           0x0f    /* ether_desc */
  44 #define USB_CDC_WHCM_TYPE               0x11
  45 #define USB_CDC_MDLM_TYPE               0x12    /* mdlm_desc */
  46 #define USB_CDC_MDLM_DETAIL_TYPE        0x13    /* mdlm_detail_desc */
  47 #define USB_CDC_DMM_TYPE                0x14
  48 #define USB_CDC_OBEX_TYPE               0x15
  49
  50 /* "Header Functional Descriptor" from CDC spec  5.2.3.1 */
  51 struct usb_cdc_header_desc {
  52         __u8    bLength;
  53         __u8    bDescriptorType;
  54         __u8    bDescriptorSubType;
  55
  56         __le16  bcdCDC;
  57 } __attribute__ ((packed));
  58
  59 /* "Call Management Descriptor" from CDC spec  5.2.3.2 */
  60 struct usb_cdc_call_mgmt_descriptor {
  61         __u8    bLength;
  62         __u8    bDescriptorType;
  63         __u8    bDescriptorSubType;
  64
  65         __u8    bmCapabilities;
  66 #define USB_CDC_CALL_MGMT_CAP_CALL_MGMT         0x01
  67 #define USB_CDC_CALL_MGMT_CAP_DATA_INTF         0x02
  68
  69         __u8    bDataInterface;
  70 } __attribute__ ((packed));
  71
  72 /* "Abstract Control Management Descriptor" from CDC spec  5.2.3.3 */
  73 struct usb_cdc_acm_descriptor {
  74         __u8    bLength;
  75         __u8    bDescriptorType;
  76         __u8    bDescriptorSubType;
  77
  78         __u8    bmCapabilities;
  79 } __attribute__ ((packed));
  80
  81 /* capabilities from 5.2.3.3 */
  82
  83 #define USB_CDC_COMM_FEATURE    0x01
  84 #define USB_CDC_CAP_LINE        0x02
  85 #define USB_CDC_CAP_BRK 0x04
  86 #define USB_CDC_CAP_NOTIFY      0x08
  87
  88 /* "Union Functional Descriptor" from CDC spec 5.2.3.8 */
  89 struct usb_cdc_union_desc {
  90         __u8    bLength;
  91         __u8    bDescriptorType;
  92         __u8    bDescriptorSubType;
  93
  94         __u8    bMasterInterface0;
  95         __u8    bSlaveInterface0;
  96         /* ... and there could be other slave interfaces */
  97 } __attribute__ ((packed));
  98
  99 /* "Country Selection Functional Descriptor" from CDC spec 5.2.3.9 */
 100 struct usb_cdc_country_functional_desc {
 101         __u8    bLength;
 102         __u8    bDescriptorType;
 103         __u8    bDescriptorSubType;
 104
 105         __u8    iCountryCodeRelDate;
 106         __le16  wCountyCode0;
 107         /* ... and there can be a lot of country codes */
 108 } __attribute__ ((packed));
 109
 110 /* "Network Channel Terminal Functional Descriptor" from CDC spec 5.2.3.11 */
 111 struct usb_cdc_network_terminal_desc {
 112         __u8    bLength;
 113         __u8    bDescriptorType;
 114         __u8    bDescriptorSubType;
 115
 116         __u8    bEntityId;
 117         __u8    iName;
 118         __u8    bChannelIndex;
 119         __u8    bPhysicalInterface;
 120 } __attribute__ ((packed));
 121
 122 /* "Ethernet Networking Functional Descriptor" from CDC spec 5.2.3.16 */
 123 struct usb_cdc_ether_desc {
 124         __u8    bLength;
 125         __u8    bDescriptorType;
 126         __u8    bDescriptorSubType;
 127
 128         __u8    iMACAddress;
 129         __le32  bmEthernetStatistics;
 130         __le16  wMaxSegmentSize;
 131         __le16  wNumberMCFilters;
 132         __u8    bNumberPowerFilters;
 133 } __attribute__ ((packed));
 134
 135 /* "Telephone Control Model Functional Descriptor" from CDC WMC spec 6.3..3 */
 136 struct usb_cdc_dmm_desc {
 137         __u8    bFunctionLength;
 138         __u8    bDescriptorType;
 139         __u8    bDescriptorSubtype;
 140         __u16   bcdVersion;
 141         __le16  wMaxCommand;
 142 } __attribute__ ((packed));
 143
 144 /* "MDLM Functional Descriptor" from CDC WMC spec 6.7.2.3 */
 145 struct usb_cdc_mdlm_desc {
 146         __u8    bLength;
 147         __u8    bDescriptorType;
 148         __u8    bDescriptorSubType;
 149
 150         __le16  bcdVersion;
 151         __u8    bGUID[16];
 152 } __attribute__ ((packed));
 153
 154 /* "MDLM Detail Functional Descriptor" from CDC WMC spec 6.7.2.4 */
 155 struct usb_cdc_mdlm_detail_desc {
 156         __u8    bLength;
 157         __u8    bDescriptorType;
 158         __u8    bDescriptorSubType;
 159
 160         /* type is associated with mdlm_desc.bGUID */
 161         __u8    bGuidDescriptorType;
 162         __u8    bDetailData[0];
 163 } __attribute__ ((packed));
 164
 165 /* "OBEX Control Model Functional Descriptor" */
 166 struct usb_cdc_obex_desc {
 167         __u8    bLength;
 168         __u8    bDescriptorType;
 169         __u8    bDescriptorSubType;
 170
 171         __le16  bcdVersion;
 172 } __attribute__ ((packed));
 173
 174 /*-------------------------------------------------------------------------*/
 175
 176 /*
 177  * Class-Specific Control Requests (6.2)
 178  *
 179  * section 3.6.2.1 table 4 has the ACM profile, for modems.
 180  * section 3.8.2 table 10 has the ethernet profile.
 181  *
 182  * Microsoft's RNDIS stack for Ethernet is a vendor-specific CDC ACM variant,
 183  * heavily dependent on the encapsulated (proprietary) command mechanism.
 184  */
 185
 186 #define USB_CDC_SEND_ENCAPSULATED_COMMAND       0x00
 187 #define USB_CDC_GET_ENCAPSULATED_RESPONSE       0x01
 188 #define USB_CDC_REQ_SET_LINE_CODING             0x20
 189 #define USB_CDC_REQ_GET_LINE_CODING             0x21
 190 #define USB_CDC_REQ_SET_CONTROL_LINE_STATE      0x22
 191 #define USB_CDC_REQ_SEND_BREAK                  0x23
 192 #define USB_CDC_SET_ETHERNET_MULTICAST_FILTERS  0x40
 193 #define USB_CDC_SET_ETHERNET_PM_PATTERN_FILTER  0x41
 194 #define USB_CDC_GET_ETHERNET_PM_PATTERN_FILTER  0x42
 195 #define USB_CDC_SET_ETHERNET_PACKET_FILTER      0x43
 196 #define USB_CDC_GET_ETHERNET_STATISTIC          0x44
 197
 198 /* Line Coding Structure from CDC spec 6.2.13 */
 199 struct usb_cdc_line_coding {
 200         __le32  dwDTERate;
 201         __u8    bCharFormat;
 202 #define USB_CDC_1_STOP_BITS                     0
 203 #define USB_CDC_1_5_STOP_BITS                   1
 204 #define USB_CDC_2_STOP_BITS                     2
 205
 206         __u8    bParityType;
 207 #define USB_CDC_NO_PARITY                       0
 208 #define USB_CDC_ODD_PARITY                      1
 209 #define USB_CDC_EVEN_PARITY                     2
 210 #define USB_CDC_MARK_PARITY                     3
 211 #define USB_CDC_SPACE_PARITY                    4
 212
 213         __u8    bDataBits;
 214 } __attribute__ ((packed));
 215
 216 /* table 62; bits in multicast filter */
 217 #define USB_CDC_PACKET_TYPE_PROMISCUOUS         (1 << 0)
 218 #define USB_CDC_PACKET_TYPE_ALL_MULTICAST       (1 << 1) /* no filter */
 219 #define USB_CDC_PACKET_TYPE_DIRECTED            (1 << 2)
 220 #define USB_CDC_PACKET_TYPE_BROADCAST           (1 << 3)
 221 #define USB_CDC_PACKET_TYPE_MULTICAST           (1 << 4) /* filtered */
 222
 223
 224 /*-------------------------------------------------------------------------*/
 225
 226 /*
 227  * Class-Specific Notifications (6.3) sent by interrupt transfers
 228  *
 229  * section 3.8.2 table 11 of the CDC spec lists Ethernet notifications
 230  * section 3.6.2.1 table 5 specifies ACM notifications, accepted by RNDIS
 231  * RNDIS also defines its own bit-incompatible notifications
 232  */
 233
 234 #define USB_CDC_NOTIFY_NETWORK_CONNECTION       0x00
 235 #define USB_CDC_NOTIFY_RESPONSE_AVAILABLE       0x01
 236 #define USB_CDC_NOTIFY_SERIAL_STATE             0x20
 237 #define USB_CDC_NOTIFY_SPEED_CHANGE             0x2a
 238
 239 struct usb_cdc_notification {
 240         __u8    bmRequestType;
 241         __u8    bNotificationType;
 242         __le16  wValue;
 243         __le16  wIndex;
 244         __le16  wLength;
 245 } __attribute__ ((packed));
 246
 247 #endif /* __LINUX_USB_CDC_H */