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