cdc.h 6.5 KB

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