usb_audio.h 83 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272
  1. /*
  2. * Copyright (c) 2022, sakumisu
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. */
  6. #ifndef USB_AUDIO_H
  7. #define USB_AUDIO_H
  8. /** Audio Interface Subclass Codes
  9. * Refer to Table A-2 from audio10.pdf
  10. */
  11. #define AUDIO_SUBCLASS_UNDEFINED 0x00
  12. #define AUDIO_SUBCLASS_AUDIOCONTROL 0x01
  13. #define AUDIO_SUBCLASS_AUDIOSTREAMING 0x02
  14. #define AUDIO_SUBCLASS_MIDISTREAMING 0x03
  15. #define AUDIO_PROTOCOL_UNDEFINED 0x00
  16. #define AUDIO_PROTOCOLv20 0x20 /* IP version 2.0 */
  17. /** Audio Class-Specific Request Codes
  18. * Refer to Table A-9 from audio10.pdf
  19. */
  20. #define AUDIO_REQUEST_UNDEFINED 0x00
  21. #define AUDIO_REQUEST_SET_CUR 0x01
  22. #define AUDIO_REQUEST_GET_CUR 0x81
  23. #define AUDIO_REQUEST_SET_MIN 0x02
  24. #define AUDIO_REQUEST_GET_MIN 0x82
  25. #define AUDIO_REQUEST_SET_MAX 0x03
  26. #define AUDIO_REQUEST_GET_MAX 0x83
  27. #define AUDIO_REQUEST_SET_RES 0x04
  28. #define AUDIO_REQUEST_GET_RES 0x84
  29. #define AUDIO_REQUEST_SET_MEM 0x05
  30. #define AUDIO_REQUEST_GET_MEM 0x85
  31. #define AUDIO_REQUEST_GET_STAT 0xFF
  32. /** Audio Class-Specific Request Codes
  33. * Refer from audio20_final.pdf
  34. */
  35. #define AUDIO_REQUEST_CUR 0x01
  36. #define AUDIO_REQUEST_RANGE 0x02
  37. /** Audio Class-Specific Control Interface Descriptor Subtypes
  38. * Refer to Table A-5 from audio10.pdf
  39. */
  40. #define AUDIO_CONTROL_UNDEF 0x01U
  41. #define AUDIO_CONTROL_HEADER 0x01U
  42. #define AUDIO_CONTROL_INPUT_TERMINAL 0x02U
  43. #define AUDIO_CONTROL_OUTPUT_TERMINAL 0x03U
  44. #define AUDIO_CONTROL_MIXER_UNIT 0x04U
  45. #define AUDIO_CONTROL_SELECTOR_UNIT 0x05U
  46. #define AUDIO_CONTROL_FEATURE_UNIT 0x06U
  47. #define AUDIO_CONTROL_EFFECT_UNIT 0x07U
  48. #define AUDIO_CONTROL_PROCESSING_UNIT 0x08U
  49. #define AUDIO_CONTROL_EXTENSION_UNIT 0x09U
  50. #define AUDIO_CONTROL_CLOCK_SOURCE 0x0aU
  51. #define AUDIO_CONTROL_CLOCK_SELECTOR 0x0bU
  52. #define AUDIO_CONTROL_CLOCK_MULTIPLIER 0x0cU
  53. #define AUDIO_CONTROL_SAMPLERATE_CONVERTER 0x0dU
  54. /** Audio Class-Specific AS Interface Descriptor Subtypes
  55. * Refer to Table A-6 from audio10.pdf
  56. */
  57. #define AUDIO_STREAMING_UNDEFINED 0x00U
  58. #define AUDIO_STREAMING_GENERAL 0x01U
  59. #define AUDIO_STREAMING_FORMAT_TYPE 0x02U
  60. #define AUDIO_STREAMING_ENCODER 0x03U
  61. #define AUDIO_STREAMING_DECODER 0x04U
  62. /* Clock Source Descriptor Clock Types */
  63. #define AUDIO_CLKSRC_EXTERNAL 0x00 /* External clock */
  64. #define AUDIO_CLKSRC_INTERNAL_FIXED 0x01 /* Internal fixed clock */
  65. #define AUDIO_CLKSRC_INTERNAL_VAR 0x02 /* Internal variable clock */
  66. #define AUDIO_CLKSRC_INTERNAL_PROG 0x03 /* Internal programmable clock */
  67. /* Effect Unit Effect Types */
  68. #define AUDIO_EFFECT_UNDEF 0x00
  69. #define AUDIO_EFFECT_PARAM_EQ_SECTION 0x01
  70. #define AUDIO_EFFECT_REVERBERATION 0x02
  71. #define AUDIO_EFFECT_MOD_DELAY 0x03
  72. #define AUDIO_EFFECT_DYN_RANGE_COMP 0x04
  73. /* Processing Unit Process Types */
  74. #define AUDIO_PROCESS_UNDEFINED 0x00
  75. #define AUDIO_PROCESS_UPDOWNMIX 0x01
  76. #define AUDIO_PROCESS_DOLBY_PROLOGIC 0x02
  77. #define AUDIO_PROCESS_STEREO_EXTENDER 0x03
  78. /* Audio Class-Specific Endpoint Descriptor Subtypes */
  79. #define AUDIO_ENDPOINT_UNDEFINED 0x00U
  80. #define AUDIO_ENDPOINT_GENERAL 0x01U
  81. /* Feature Unit Control Bits */
  82. #define AUDIO_CONTROL_MUTE 0x0001
  83. #define AUDIO_CONTROL_VOLUME 0x0002
  84. #define AUDIO_CONTROL_BASS 0x0004
  85. #define AUDIO_CONTROL_MID 0x0008
  86. #define AUDIO_CONTROL_TREBLE 0x0010
  87. #define AUDIO_CONTROL_GRAPHIC_EQUALIZER 0x0020
  88. #define AUDIO_CONTROL_AUTOMATIC_GAIN 0x0040
  89. #define AUDIO_CONTROL_DEALY 0x0080
  90. #define AUDIO_CONTROL_BASS_BOOST 0x0100
  91. #define AUDIO_CONTROL_LOUDNESS 0x0200
  92. /* Encoder Type Codes */
  93. #define AUDIO_ENCODER_UNDEF 0x00
  94. #define AUDIO_ENCODER_OTHER 0x01
  95. #define AUDIO_ENCODER_MPEG 0x02
  96. #define AUDIO_ENCODER_AC3 0x03
  97. #define AUDIO_ENCODER_WMA 0x04
  98. #define AUDIO_ENCODER_DTS 0x05
  99. /* Decoder Type Codes */
  100. #define AUDIO_DECODER_UNDEF 0x00
  101. #define AUDIO_DECODER_OTHER 0x01
  102. #define AUDIO_DECODER_MPEG 0x02
  103. #define AUDIO_DECODER_AC3 0x03
  104. #define AUDIO_DECODER_WMA 0x04
  105. #define AUDIO_DECODER_DTS 0x05
  106. /* Audio Descriptor Types */
  107. #define AUDIO_UNDEFINED_DESCRIPTOR_TYPE 0x20
  108. #define AUDIO_DEVICE_DESCRIPTOR_TYPE 0x21
  109. #define AUDIO_CONFIGURATION_DESCRIPTOR_TYPE 0x22
  110. #define AUDIO_STRING_DESCRIPTOR_TYPE 0x23
  111. #define AUDIO_INTERFACE_DESCRIPTOR_TYPE 0x24
  112. #define AUDIO_ENDPOINT_DESCRIPTOR_TYPE 0x25
  113. /* Audio Data Format Type I Codes */
  114. #define AUDIO_FORMAT_TYPE_I_UNDEFINED 0x0000
  115. #define AUDIO_FORMAT_PCM 0x0001
  116. #define AUDIO_FORMAT_PCM8 0x0002
  117. #define AUDIO_FORMAT_IEEE_FLOAT 0x0003
  118. #define AUDIO_FORMAT_ALAW 0x0004
  119. #define AUDIO_FORMAT_MULAW 0x0005
  120. #define AUDIO_V2_FORMAT_PCM 0x00000001
  121. #define AUDIO_V2_FORMAT_PCM8 0x00000002
  122. #define AUDIO_V2_FORMAT_IEEE_FLOAT 0x00000004
  123. #define AUDIO_V2_FORMAT_ALAW 0x00000008
  124. #define AUDIO_V2_FORMAT_MULAW 0x00000010
  125. /* bmChannelConfig: a bitmap field that indicates which spatial locations
  126. * are occupied by the channels present in the cluster. The bit allocations
  127. * are as follows:
  128. */
  129. #define AUDIO_CHANNEL_M 0 /* Mono */
  130. #define AUDIO_CHANNEL_FL (1 << 0) /* Front Left */
  131. #define AUDIO_CHANNEL_FR (1 << 1) /* Front Right */
  132. #define AUDIO_CHANNEL_FC (1 << 2) /* Front Center */
  133. #define AUDIO_CHANNEL_LFE (1 << 3) /* Low Frequency Effects */
  134. #define AUDIO_CHANNEL_BL (1 << 4) /* Back Left */
  135. #define AUDIO_CHANNEL_BR (1 << 5) /* Back Right */
  136. #define AUDIO_CHANNEL_FLC (1 << 6) /* Front Left of Center */
  137. #define AUDIO_CHANNEL_FRC (1 << 7) /* Front Right of Center */
  138. #define AUDIO_CHANNEL_BC (1 << 8) /* Back Center */
  139. #define AUDIO_CHANNEL_SL (1 << 9) /* Side Left */
  140. #define AUDIO_CHANNEL_SR (1 << 10) /* Side Right */
  141. #define AUDIO_CHANNEL_TC (1 << 11) /* Top Center */
  142. #define AUDIO_CHANNEL_TFL (1 << 12) /* Top Front Left */
  143. #define AUDIO_CHANNEL_TFC (1 << 13) /* Top Front Center */
  144. #define AUDIO_CHANNEL_TFR (1 << 14) /* Top Front Right */
  145. #define AUDIO_CHANNEL_TBL (1 << 15) /* Top Back Left */
  146. #define AUDIO_CHANNEL_TBC (1 << 16) /* Top Back Center */
  147. #define AUDIO_CHANNEL_TBR (1 << 17) /* Top Back Right */
  148. #define AUDIO_CHANNEL_TFLC (1 << 18) /* Top Front Left of Center */
  149. #define AUDIO_CHANNEL_TFRC (1 << 19) /* Top Front Right of Center */
  150. #define AUDIO_CHANNEL_LLFE (1 << 20) /* Left Low Frequency Effects */
  151. #define AUDIO_CHANNEL_RLFE (1 << 21) /* Right Low Frequency Effects */
  152. #define AUDIO_CHANNEL_TSL (1 << 22) /* Top Side Left */
  153. #define AUDIO_CHANNEL_TSR (1 << 23) /* Top Side Right */
  154. #define AUDIO_CHANNEL_BOC (1 << 24) /* Bottom Center */
  155. #define AUDIO_CHANNEL_BLC (1 << 25) /* Back Left of Center */
  156. #define AUDIO_CHANNEL_BRC (1 << 26) /* Back Right of Center */
  157. /* Bits 27-30: Reserved */
  158. #define AUDIO_CHANNEL_RD (1 << 31) /* Raw Data */
  159. /* Audio Function Category Codes */
  160. #define AUDIO_CATEGORY_UNDEF 0x00 /* Undefined */
  161. #define AUDIO_CATEGORY_SPEAKER 0x01 /* Desktop speaker */
  162. #define AUDIO_CATEGORY_THEATER 0x02 /* Home theater */
  163. #define AUDIO_CATEGORY_MICROPHONE 0x03 /* Microphone */
  164. #define AUDIO_CATEGORY_HEADSET 0x04 /* Headset */
  165. #define AUDIO_CATEGORY_TELEPHONE 0x05 /* Telephone */
  166. #define AUDIO_CATEGORY_CONVERTER 0x06 /* Converter */
  167. #define AUDIO_CATEGORY_RECORDER 0x07 /* Voice/Sound recorder */
  168. #define AUDIO_CATEGORY_IO_BOX 0x08 /* I/O box */
  169. #define AUDIO_CATEGORY_INSTRUMENT 0x09 /* Musical instrument */
  170. #define AUDIO_CATEGORY_PROAUDIO 0x0a /* Pro-audio */
  171. #define AUDIO_CATEGORY_AV 0x0b /* Audio/video */
  172. #define AUDIO_CATEGORY_CONTROL 0x0c /* Control panel */
  173. #define AUDIO_CATEGORY_OTHER 0xff
  174. /* Clock Source Control Selectors */
  175. #define AUDIO_CS_CONTROL_UNDEF 0x00
  176. #define AUDIO_CS_CONTROL_SAM_FREQ 0x01
  177. #define AUDIO_CS_CONTROL_CLOCK_VALID 0x02
  178. /* Clock Selector Control Selectors */
  179. #define AUDIO_CX_CONTROL_UNDEF 0x00
  180. #define AUDIO_CX_CONTROL_CLOCKSEL 0x01
  181. /* Clock Multiplier Control Selectors */
  182. #define AUDIO_CM_CONTROL_UNDEF 0x00
  183. #define AUDIO_CM_CONTROL_NUMERATOR 0x01
  184. #define AUDIO_CM_CONTROL_DENOMINATOR 0x02
  185. /* Terminal Control Selectors */
  186. #define AUDIO_TE_CONTROL_UNDEF 0x00
  187. #define AUDIO_TE_CONTROL_COPY_PROTECT 0x01
  188. #define AUDIO_TE_CONTROL_CONNECTOR 0x02
  189. #define AUDIO_TE_CONTROL_OVERLOAD 0x03
  190. #define AUDIO_TE_CONTROL_CLUSTER 0x04
  191. #define AUDIO_TE_CONTROL_UNDERFLOW 0x05
  192. #define AUDIO_TE_CONTROL_OVERFLOW 0x06
  193. #define AUDIO_TE_CONTROL_LATENCY 0x07
  194. /* Mixer Control Selectors */
  195. #define AUDIO_MU_CONTROL_UNDEF 0x00
  196. #define AUDIO_MU_CONTROL_MIXER 0x01
  197. #define AUDIO_MU_CONTROL_CLUSTER 0x02
  198. #define AUDIO_MU_CONTROL_UNDERFLOW 0x03
  199. #define AUDIO_MU_CONTROL_OVERFLOW 0x04
  200. #define AUDIO_MU_CONTROL_LATENCY 0x05
  201. /* Selector Control Selectors */
  202. #define AUDIO_SU_CONTROL_UNDEFINE 0x00
  203. #define AUDIO_SU_CONTROL_SELECTOR 0x01
  204. #define AUDIO_SU_CONTROL_LATENCY 0x02
  205. /* Feature Unit Control Selectors */
  206. #define AUDIO_FU_CONTROL_UNDEF 0x00
  207. #define AUDIO_FU_CONTROL_MUTE 0x01
  208. #define AUDIO_FU_CONTROL_VOLUME 0x02
  209. #define AUDIO_FU_CONTROL_BASS 0x03
  210. #define AUDIO_FU_CONTROL_MID 0x04
  211. #define AUDIO_FU_CONTROL_TREBLE 0x05
  212. #define AUDIO_FU_CONTROL_EQUALIZER 0x06
  213. #define AUDIO_FU_CONTROL_AGC 0x07
  214. #define AUDIO_FU_CONTROL_DELAY 0x08
  215. #define AUDIO_FU_CONTROL_BASS_BOOST 0x09
  216. #define AUDIO_FU_CONTROL_LOUDNESS 0x0a
  217. #define AUDIO_FU_CONTROL_INP_GAIN 0x0b
  218. #define AUDIO_FU_CONTROL_INP_GAIN_PAD 0x0c
  219. #define AUDIO_FU_CONTROL_PHASE_INVERT 0x0d
  220. #define AUDIO_FU_CONTROL_UNDERFLOW 0x0e
  221. #define AUDIO_FU_CONTROL_OVERFLOW 0x0f
  222. #define AUDIO_FU_CONTROL_LATENCY 0x10
  223. #define AUDIO_V2_FU_CONTROL_UNDEF 0x00
  224. #define AUDIO_V2_FU_CONTROL_MUTE (0x03 << 0)
  225. #define AUDIO_V2_FU_CONTROL_VOLUME (0x03 << 2)
  226. #define AUDIO_V2_FU_CONTROL_BASS (0x03 << 4)
  227. #define AUDIO_V2_FU_CONTROL_MID (0x03 << 6)
  228. #define AUDIO_V2_FU_CONTROL_TREBLE (0x03 << 8)
  229. #define AUDIO_V2_FU_CONTROL_EQUALIZER (0x03 << 10)
  230. #define AUDIO_V2_FU_CONTROL_AGC (0x03 << 12)
  231. #define AUDIO_V2_FU_CONTROL_DELAY (0x03 << 14)
  232. #define AUDIO_V2_FU_CONTROL_BASS_BOOST (0x03 << 16)
  233. #define AUDIO_V2_FU_CONTROL_LOUDNESS (0x03 << 18)
  234. #define AUDIO_V2_FU_CONTROL_INP_GAIN (0x03 << 20)
  235. #define AUDIO_V2_FU_CONTROL_INP_GAIN_PAD (0x03 << 22)
  236. #define AUDIO_V2_FU_CONTROL_PHASE_INVERT (0x03 << 24)
  237. #define AUDIO_V2_FU_CONTROL_UNDERFLOW (0x03 << 26)
  238. #define AUDIO_V2_FU_CONTROL_OVERFLOW (0x03 << 28)
  239. /* Parametric Equalizer Section Effect Unit Control Selectors */
  240. #define AUDIO_PE_CONTROL_UNDEF 0x00
  241. #define AUDIO_PE_CONTROL_ENABLE 0x01
  242. #define AUDIO_PE_CONTROL_CENTERFREQ 0x02
  243. #define AUDIO_PE_CONTROL_QFACTOR 0x03
  244. #define AUDIO_PE_CONTROL_GAIN 0x04
  245. #define AUDIO_PE_CONTROL_UNDERFLOW 0x05
  246. #define AUDIO_PE_CONTROL_OVERFLOW 0x06
  247. #define AUDIO_PE_CONTROL_LATENCY 0x07
  248. /* Reverberation Effect Unit Control Selectors */
  249. #define AUDIO_RV_CONTROL_UNDEF 0x00
  250. #define AUDIO_RV_CONTROL_ENABLE 0x01
  251. #define AUDIO_RV_CONTROL_TYPE 0x02
  252. #define AUDIO_RV_CONTROL_LEVEL 0x03
  253. #define AUDIO_RV_CONTROL_TIME 0x04
  254. #define AUDIO_RV_CONTROL_FEEDBACK 0x05
  255. #define AUDIO_RV_CONTROL_PREDELAY 0x06
  256. #define AUDIO_RV_CONTROL_DENSITY 0x07
  257. #define AUDIO_RV_CONTROL_HF_ROLLOFF 0x08
  258. #define AUDIO_RV_CONTROL_UNDERFLOW 0x09
  259. #define AUDIO_RV_CONTROL_OVERFLOW 0x0a
  260. #define AUDIO_RV_CONTROL_LATENCY 0x0b
  261. /* Modulation Delay Effect Unit Control Selectors */
  262. #define AUDIO_MD_CONTROL_UNDEF 0x00
  263. #define AUDIO_MD_CONTROL_ENABLE 0x01
  264. #define AUDIO_MD_CONTROL_BALANCE 0x02
  265. #define AUDIO_MD_CONTROL_RATE 0x03
  266. #define AUDIO_MD_CONTROL_DEPTH 0x04
  267. #define AUDIO_MD_CONTROL_TIME 0x05
  268. #define AUDIO_MD_CONTROL_FEEDBACK 0x06
  269. #define AUDIO_MD_CONTROL_UNDERFLOW 0x07
  270. #define AUDIO_MD_CONTROL_OVERFLOW 0x08
  271. #define AUDIO_MD_CONTROL_LATENCY 0x09
  272. /* Dynamic Range Compressor Effect Unit Control Selectors */
  273. #define AUDIO_DR_CONTROL_UNDEF 0x00
  274. #define AUDIO_DR_CONTROL_ENABLE 0x01
  275. #define AUDIO_DR_CONTROL_COMP_RATE 0x02
  276. #define AUDIO_DR_CONTROL_MAXAMPL 0x03
  277. #define AUDIO_DR_CONTROL_THRESHOLD 0x04
  278. #define AUDIO_DR_CONTROL_ATTACK_TIME 0x05
  279. #define AUDIO_DR_CONTROL_RELEASE_TIME 0x06
  280. #define AUDIO_DR_CONTROL_UNDERFLOW 0x07
  281. #define AUDIO_DR_CONTROL_OVERFLOW 0x08
  282. #define AUDIO_DR_CONTROL_LATENCY 0x09
  283. /* Up/Down-mix Processing Unit Control Selectors */
  284. #define AUDIO_UD_CONTROL_UNDEF 0x00
  285. #define AUDIO_UD_CONTROL_ENABLE 0x01
  286. #define AUDIO_UD_CONTROL_MODE_SELECT 0x02
  287. #define AUDIO_UD_CONTROL_CLUSTER 0x03
  288. #define AUDIO_UD_CONTROL_UNDERFLOW 0x04
  289. #define AUDIO_UD_CONTROL_OVERFLOW 0x05
  290. #define AUDIO_UD_CONTROL_LATENCY 0x06
  291. /* Dolby Prologic?Processing Unit Control Selectors */
  292. #define AUDIO_DP_CONTROL_UNDEF 0x00
  293. #define AUDIO_DP_CONTROL_ENABLE 0x01
  294. #define AUDIO_DP_CONTROL_MODE_SELECT 0x02
  295. #define AUDIO_DP_CONTROL_CLUSTER 0x03
  296. #define AUDIO_DP_CONTROL_UNDERFLOW 0x04
  297. #define AUDIO_DP_CONTROL_OVERFLOW 0x05
  298. #define AUDIO_DP_CONTROL_LATENCY 0x06
  299. /* Stereo Extender Processing Unit Control Selectors */
  300. #define AUDIO_STEXT_CONTROL_UNDEF 0x00
  301. #define AUDIO_STEXT_CONTROL_ENABLE 0x01
  302. #define AUDIO_STEXT_CONTROL_WIDTH 0x02
  303. #define AUDIO_STEXT_CONTROL_UNDERFLOW 0x03
  304. #define AUDIO_STEXT_CONTROL_OVERFLOW 0x04
  305. #define AUDIO_STEXT_CONTROL_LATENCY 0x05
  306. /* Extension Unit Control Selectors */
  307. #define AUDIO_XU_CONTROL_UNDEF 0x00
  308. #define AUDIO_XU_CONTROL_ENABLE 0x01
  309. #define AUDIO_XU_CONTROL_CLUSTER 0x02
  310. #define AUDIO_XU_CONTROL_UNDERFLOW 0x03
  311. #define AUDIO_XU_CONTROL_OVERFLOW 0x04
  312. #define AUDIO_XU_CONTROL_LATENCY 0x05
  313. /* AudioStreaming Interface Control Selectors */
  314. #define AUDIO_AS_CONTROL_UNDEF 0x00
  315. #define AUDIO_AS_CONTROL_ACT_ALT 0x01
  316. #define AUDIO_AS_CONTROL_VAL_ALT 0x02
  317. #define AUDIO_AS_CONTROL_AUDIO_FORMAT 0x03
  318. /* Encoder Control Selectors */
  319. #define AUDIO_EN_CONTROL_UNDEF 0x00
  320. #define AUDIO_EN_CONTROL_BIT_RATE 0x01
  321. #define AUDIO_EN_CONTROL_QUALITY 0x02
  322. #define AUDIO_EN_CONTROL_VBR 0x03
  323. #define AUDIO_EN_CONTROL_TYPE 0x04
  324. #define AUDIO_EN_CONTROL_UNDERFLOW 0x05
  325. #define AUDIO_EN_CONTROL_OVERFLOW 0x06
  326. #define AUDIO_EN_CONTROL_ENCODER_ERR 0x07
  327. #define AUDIO_EN_CONTROL_PARAM1 0x08
  328. #define AUDIO_EN_CONTROL_PARAM2 0x09
  329. #define AUDIO_EN_CONTROL_PARAM3 0x0a
  330. #define AUDIO_EN_CONTROL_PARAM4 0x0b
  331. #define AUDIO_EN_CONTROL_PARAM5 0x0c
  332. #define AUDIO_EN_CONTROL_PARAM6 0x0d
  333. #define AUDIO_EN_CONTROL_PARAM7 0x0e
  334. #define AUDIO_EN_CONTROL_PARAM8 0x0f
  335. /* MPEG Decoder Control Selectors */
  336. #define AUDIO_MPGD_CONTROL_UNDEF 0x00
  337. #define AUDIO_MPGD_CONTROL_DUAL_CHAN 0x01
  338. #define AUDIO_MPGD_CONTROL_2ND_STEREO 0x02
  339. #define AUDIO_MPGD_CONTROL_MULTILING 0x03
  340. #define AUDIO_MPGD_CONTROL_DYN_RANGE 0x04
  341. #define AUDIO_MPGD_CONTROL_SCALING 0x05
  342. #define AUDIO_MPGD_CONTROL_HILO_SCALE 0x06
  343. #define AUDIO_MPGD_CONTROL_UNDERFLOW 0x07
  344. #define AUDIO_MPGD_CONTROL_OVERFLOW 0x08
  345. #define AUDIO_MPGD_CONTROL_DECODE_ERR 0x09
  346. /* AC-3 Decoder Control Selectors */
  347. #define AUDIO_AC3D_CONTROL_UNDEF 0x00
  348. #define AUDIO_AC3D_CONTROL_MODE 0x01
  349. #define AUDIO_AC3D_CONTROL_DYN_RANGE 0x02
  350. #define AUDIO_AC3D_CONTROL_SCALING 0x03
  351. #define AUDIO_AC3D_CONTROL_HILO_SCALE 0x04
  352. #define AUDIO_AC3D_CONTROL_UNDERFLOW 0x05
  353. #define AUDIO_AC3D_CONTROL_OVERFLOW 0x06
  354. #define AUDIO_AC3D_CONTROL_DECODE_ERR 0x07
  355. /* WMA Decoder Control Selectors */
  356. #define AUDIO_WMAD_CONTROL_UNDEF 0x00
  357. #define AUDIO_WMAD_CONTROL_UNDERFLOW 0x01
  358. #define AUDIO_WMAD_CONTROL_OVERFLOW 0x02
  359. #define AUDIO_WMAD_CONTROL_DECODE_ERR 0x03
  360. /* DTS Decoder Control Selectors */
  361. #define AUDIO_DTSD_CONTROL_UNDEF 0x00
  362. #define AUDIO_DTSD_CONTROL_UNDERFLOW 0x01
  363. #define AUDIO_DTSD_CONTROL_OVERFLOW 0x02
  364. #define AUDIO_DTSD_CONTROL_DECODE_ERR 0x03
  365. /* Endpoint Control Selectors */
  366. #define AUDIO_EP_CONTROL_UNDEF 0x00
  367. #define AUDIO_EP_CONTROL_SAMPLING_FEQ 0x01
  368. #define AUDIO_EP_CONTROL_PITCH 0x02
  369. /* Encoder Error Codes */
  370. /* <0: Reserved for vendor extensions */
  371. #define AUDIO_ENCODER_SUCCESS 0 /* No Error */
  372. #define AUDIO_ENCODER_ERROR_NOMEM 1 /* Out of Memory */
  373. #define AUDIO_ENCODER_ERROR_BW 2 /* Out of Bandwidth */
  374. #define AUDIO_ENCODER_ERROR_CYCLE 3 /* Out of Processing Cycles */
  375. #define AUDIO_ENCODER_ERROR_FRAME 4 /* General Format Frame Error */
  376. #define AUDIO_ENCODER_ERROR_TOOSMALL 5 /* Format Frame Too Small */
  377. #define AUDIO_ENCODER_ERROR_TOOBIG 6 /* Format Frame Too Large */
  378. #define AUDIO_ENCODER_ERROR_BADFORMAT 7 /* Bad Data Format */
  379. #define AUDIO_ENCODER_ERROR_NCHAN 8 /* Incorrect Number of Channels */
  380. #define AUDIO_ENCODER_ERROR_RATE 9 /* Incorrect Sampling Rate */
  381. #define AUDIO_ENCODER_ERROR_BITRATE 10 /* Unable to Meet Target Bitrate */
  382. #define AUDIO_ENCODER_ERROR_PARMS 11 /* Inconsistent Set of Parameters */
  383. #define AUDIO_ENCODER_ERROR_NOTREADY 12 /* Not Ready */
  384. #define AUDIO_ENCODER_ERROR_BUSY 13 /* Busy */
  385. /* >13: Reserved */
  386. /* Format Type Codes */
  387. #define AUDIO_FORMAT_TYPE_UNDEF 0x00
  388. #define AUDIO_FORMAT_TYPEI 0x01
  389. #define AUDIO_FORMAT_TYPEII 0x02
  390. #define AUDIO_FORMAT_TYPEIII 0x03
  391. #define AUDIO_FORMAT_TYPEIV 0x04
  392. #define AUDIO_FORMAT_EXT_TYPEI 0x81
  393. #define AUDIO_FORMAT_EXT_TYPEII 0x82
  394. #define AUDIO_FORMAT_EXT_TYPEIII 0x83
  395. /* Audio Data Format Type I Bit Allocations */
  396. #define AUDIO_FORMAT_TYPEI_PCM (1 << 0)
  397. #define AUDIO_FORMAT_TYPEI_PCM8 (1 << 1)
  398. #define AUDIO_FORMAT_TYPEI_IEEEFLOAT (1 << 2)
  399. #define AUDIO_FORMAT_TYPEI_ALAW (1 << 3)
  400. #define AUDIO_FORMAT_TYPEI_MULAW (1 << 4)
  401. #define AUDIO_FORMAT_TYPEI_RAWDATA (1 << 31)
  402. /* Audio Data Format Type II Bit Allocations */
  403. #define AUDIO_FORMAT_TYPEII_MPEG (1 << 0)
  404. #define AUDIO_FORMAT_TYPEII_AC3 (1 << 1)
  405. #define AUDIO_FORMAT_TYPEII_WMA (1 << 2)
  406. #define AUDIO_FORMAT_TYPEII_DTS (1 << 3)
  407. #define AUDIO_FORMAT_TYPEII_RAWDATA (1 << 31)
  408. /* Audio Data Format Type III Bit Allocations */
  409. #define AUDIO_FORMAT_TYPEIII_IEC61937_AC3 (1 << 0)
  410. #define AUDIO_FORMAT_TYPEIII_IEC61937_MPEG1_L1 (1 << 1)
  411. #define AUDIO_FORMAT_TYPEIII_IEC61937_MPEG1_L2_3 (1 << 1)
  412. #define AUDIO_FORMAT_TYPEIII_IEC61937_MPEG2_NOEXT (1 << 2)
  413. #define AUDIO_FORMAT_TYPEIII_IEC61937_MPEG2_EXT (1 << 3)
  414. #define AUDIO_FORMAT_TYPEIII_IEC61937_MPEG2_AAC_ADTS (1 << 4)
  415. #define AUDIO_FORMAT_TYPEIII_IEC61937_MPEG2_L1_LS (1 << 5)
  416. #define AUDIO_FORMAT_TYPEIII_IEC61937_MPEG2_L2_3_LS (1 << 6)
  417. #define AUDIO_FORMAT_TYPEIII_IEC61937_DTS_I (1 << 7)
  418. #define AUDIO_FORMAT_TYPEIII_IEC61937_DTS_II (1 << 8)
  419. #define AUDIO_FORMAT_TYPEIII_IEC61937_DTS_III (1 << 9)
  420. #define AUDIO_FORMAT_TYPEIII_IEC61937_ATRAC (1 << 10)
  421. #define AUDIO_FORMAT_TYPEIII_IEC61937_ATRAC2_3 (1 << 11)
  422. #define AUDIO_FORMAT_TYPEIII_WMA (1 << 12)
  423. /* Audio Data Format Type IV Bit Allocations */
  424. #define AUDIO_FORMAT_TYPEIV_PCM (1 << 0)
  425. #define AUDIO_FORMAT_TYPEIV_PCM8 (1 << 1)
  426. #define AUDIO_FORMAT_TYPEIV_IEEE_FLOAT (1 << 2)
  427. #define AUDIO_FORMAT_TYPEIV_ALAW (1 << 3)
  428. #define AUDIO_FORMAT_TYPEIV_MULAW (1 << 4)
  429. #define AUDIO_FORMAT_TYPEIV_MPEG (1 << 5)
  430. #define AUDIO_FORMAT_TYPEIV_AC3 (1 << 6)
  431. #define AUDIO_FORMAT_TYPEIV_WMA (1 << 7)
  432. #define AUDIO_FORMAT_TYPEIV_IEC61937_AC3 (1 << 8)
  433. #define AUDIO_FORMAT_TYPEIV_IEC61937_MPEG1_L1 (1 << 9)
  434. #define AUDIO_FORMAT_TYPEIV_IEC61937_MPEG1_L2_3 (1 << 10)
  435. #define AUDIO_FORMAT_TYPEIV_IEC61937_MPEG2_NOEXT (1 << 10)
  436. #define AUDIO_FORMAT_TYPEIV_IEC61937_MPEG2_EXT (1 << 11)
  437. #define AUDIO_FORMAT_TYPEIV_IEC61937_MPEG2_AAC_ADTS (1 << 12)
  438. #define AUDIO_FORMAT_TYPEIV_IEC61937_MPEG2_L1_LS (1 << 13)
  439. #define AUDIO_FORMAT_TYPEIV_IEC61937_MPEG2_L2_3_LS (1 << 14)
  440. #define AUDIO_FORMAT_TYPEIV_IEC61937_DTS_I (1 << 15)
  441. #define AUDIO_FORMAT_TYPEIV_IEC61937_DTS_II (1 << 16)
  442. #define AUDIO_FORMAT_TYPEIV_IEC61937_DTS_III (1 << 17)
  443. #define AUDIO_FORMAT_TYPEIV_IEC61937_ATRAC (1 << 18)
  444. #define AUDIO_FORMAT_TYPEIV_IEC61937_ATRAC2_3 (1 << 19)
  445. #define AUDIO_FORMAT_TYPEIV_TYPE_III_WMA (1 << 20)
  446. #define AUDIO_FORMAT_TYPEIV_IEC60958_PCM (1 << 21)
  447. /* Side Band Protocol Codes */
  448. #define AUDIO_SIDEBAND_PROTOCOL_UNDEF 0x00
  449. #define AUDIO_PRES_TIMESTAMP_PROTOCOL 0x01
  450. /** USB Terminal Types
  451. * Refer to Table 2-1 - Table 2-4 from termt10.pdf
  452. */
  453. /* USB Terminal Types */
  454. #define AUDIO_TERMINAL_UNDEF 0x0100
  455. #define AUDIO_TERMINAL_STREAMING 0x0101
  456. #define AUDIO_TERMINAL_VENDOR 0x01ff
  457. /* Input Terminal Types */
  458. #define AUDIO_INTERM_UNDEF 0x0200 /* Undefined Type */
  459. #define AUDIO_INTERM_MIC 0x0201 /* A generic microhpone */
  460. #define AUDIO_INTERM_DESKTOP_MIC 0x0202 /* A desktop microphone */
  461. #define AUDIO_INTERM_PERSONAL_MIC 0x0203 /* Head-mounted or clip-on microphone */
  462. #define AUDIO_INTERM_OMNI_MIC 0x0204 /* Omni-directional microphone */
  463. #define AUDIO_INTERM_MIC_ARRAY 0x0205 /* Microphone array */
  464. #define AUDIO_INTERM_PROC_MIC_ARRAY 0x0206 /* Microphone array with signal processor */
  465. /* Output Terminal Types */
  466. #define AUDIO_OUTTERM_UNDEF 0x0300 /* Undefined Type */
  467. #define AUDIO_OUTTERM_SPEAKER 0x0301 /* Generic speakers */
  468. #define AUDIO_OUTTERM_HEADPHONES 0x0302 /* A head-mounted audio output device */
  469. #define AUDIO_OUTTERM_HEADDISPLAY 0x0303 /* Head Mounted Display Audio */
  470. #define AUDIO_OUTTERM_DESKTOP 0x0304 /* Desktop speaker */
  471. #define AUDIO_OUTTERM_ROOM 0x0305 /* Room speaker */
  472. #define AUDIO_OUTTERM_COMMS 0x0306 /* Communication speaker */
  473. #define AUDIO_OUTTERM_LOFREQ 0x0307 /* Low frequency effects speaker */
  474. /* Bi-directional Terminal Types */
  475. #define AUDIO_BIDITERM_UNDEF 0x0400 /* Undefined Type */
  476. #define AUDIO_BIDITERM_HANDSET 0x0401 /* Hand-held bi-directional audio device */
  477. #define AUDIO_BIDITERM_HEADSET 0x0402 /* Head-mounted bi-directional audio device */
  478. #define AUDIO_BIDITERM_SPEAKERPHONE 0x0403 /* Speakerphone, no echo reduction */
  479. #define AUDIO_BIDITERM_ECHOSUPPRESS 0x0404 /* Echo-suppressing speakerphone */
  480. #define AUDIO_BIDITERM_ECHOCANCEL 0x0405 /* Echo-canceling speakerphone */
  481. /* Telephony Terminal Types */
  482. #define AUDIO_TELETERM_UNDEF 0x0500 /* Undefined Type */
  483. #define AUDIO_TELETERM_PHONELINE 0x0501 /* Analog telephone line jack, an ISDN line,
  484. * a proprietary PBX interface, or a wireless link */
  485. #define AUDIO_TELETERM_TELEPHONE 0x0502 /* Device can be used as a telephone */
  486. #define AUDIO_TELETERM_DOWNLINE 0x0503 /* Down Line Phone */
  487. /* External Terminal Types */
  488. #define AUDIO_EXTTERM_UNDEF 0x0600 /* Undefined Type */
  489. #define AUDIO_EXTTERM_ANALOG 0x0601 /* Generic analog connector */
  490. #define AUDIO_EXTTERM_DIGITAL 0x0602 /* Generic digital audio interface */
  491. #define AUDIO_EXTTERM_LINE 0x0603 /* Analog connector at standard line levels */
  492. #define AUDIO_EXTTERM_LEGACY 0x0604 /* Legacy audio line out connector */
  493. #define AUDIO_EXTTERM_SPDIF 0x0605 /* SPDIF interface */
  494. #define AUDIO_EXTTERM_1394DA 0x0606 /* 1394 DA stream */
  495. #define AUDIO_EXTTERM_1394DV 0x0607 /* 1394 DV stream soundtrack */
  496. #define AUDIO_EXTTERM_ADAT 0x0608 /* ADAT Lightpipe */
  497. #define AUDIO_EXTTERM_TDIF 0x0609 /* TDIF - Tascam Digital Interface */
  498. #define AUDIO_EXTTERM_MADI 0x060a /* MADI - Multi-channel Audio Digital Interface (AES) */
  499. /* Embedded Function Terminal Types */
  500. #define AUDIO_EMBEDTERM_UNDEF 0x0700 /* Undefined Type */
  501. #define AUDIO_EMBEDTERM_CALIBRATION 0x0701 /* Level Calibration Noise Source */
  502. #define AUDIO_EMBEDTERM_EQUALIZATION 0x0702 /* Equalization Noise */
  503. #define AUDIO_EMBEDTERM_CD 0x0703 /* CD player */
  504. #define AUDIO_EMBEDTERM_DAT 0x0704 /* Digital Audio Tape */
  505. #define AUDIO_EMBEDTERM_DCC 0x0705 /* Digital Compact Cassette */
  506. #define AUDIO_EMBEDTERM_COMPRESSED 0x0706 /* Compressed Audio Player */
  507. #define AUDIO_EMBEDTERM_TAPE 0x0707 /* Analog Audio Tape */
  508. #define AUDIO_EMBEDTERM_PHONOGRAPH 0x0708 /* Analog vinyl record player */
  509. #define AUDIO_EMBEDTERM_VCR 0x0709 /* Audio track of VCR */
  510. #define AUDIO_EMBEDTERM_VIDDISC 0x070a /* Audio track of VideoDisc player */
  511. #define AUDIO_EMBEDTERM_DVD 0x070b /* Audio track of DVD player */
  512. #define AUDIO_EMBEDTERM_TVTUNER 0x070c /* Audio track of TV tuner */
  513. #define AUDIO_EMBEDTERM_SATELLITE 0x070d /* Audio track of satellite receiver */
  514. #define AUDIO_EMBEDTERM_CABLETUNER 0x070e /* Audio track of cable tuner */
  515. #define AUDIO_EMBEDTERM_DSS 0x070f /* Audio track of DSS receiver */
  516. #define AUDIO_EMBEDTERM_RADIO 0x0710 /* AM/FM radio receiver */
  517. #define AUDIO_EMBEDTERM_TRANSMITTER 0x0711 /* AM/FM radio transmitter */
  518. #define AUDIO_EMBEDTERM_MULTITRACK 0x0712 /* A multi-track recording system */
  519. #define AUDIO_EMBEDTERM_SYNTHESIZER 0x0713 /* Synthesizer */
  520. #define AUDIO_EMBEDTERM_PIANO 0x0714 /* Piano */
  521. #define AUDIO_EMBEDTERM_GUITAR 0x0715 /* Guitar */
  522. #define AUDIO_EMBEDTERM_PERCUSSON 0x0716 /* Percussion Instrument */
  523. #define AUDIO_EMBEDTERM_INSTRUMENT 0x0717 /* Other Musical Instrument */
  524. #define AUDIO_FORMAT_TYPE_I 0x01
  525. #define AUDIO_FORMAT_TYPE_II 0x02
  526. #define AUDIO_FORMAT_TYPE_III 0x03
  527. struct audio_cs_if_ac_header_descriptor {
  528. uint8_t bLength;
  529. uint8_t bDescriptorType;
  530. uint8_t bDescriptorSubtype;
  531. uint16_t bcdADC;
  532. uint16_t wTotalLength;
  533. uint8_t bInCollection;
  534. uint8_t baInterfaceNr[];
  535. } __PACKED;
  536. #define AUDIO_SIZEOF_AC_HEADER_DESC(n) (8 + n)
  537. struct audio_cs_if_ac_input_terminal_descriptor {
  538. uint8_t bLength;
  539. uint8_t bDescriptorType;
  540. uint8_t bDescriptorSubtype;
  541. uint8_t bTerminalID;
  542. uint16_t wTerminalType;
  543. uint8_t bAssocTerminal;
  544. uint8_t bNrChannels;
  545. uint16_t wChannelConfig;
  546. uint8_t iChannelNames;
  547. uint8_t iTerminal;
  548. } __PACKED;
  549. #define AUDIO_SIZEOF_AC_INPUT_TERMINAL_DESC (12)
  550. struct audio_cs_if_ac_output_terminal_descriptor {
  551. uint8_t bLength;
  552. uint8_t bDescriptorType;
  553. uint8_t bDescriptorSubtype;
  554. uint8_t bTerminalID;
  555. uint16_t wTerminalType;
  556. uint8_t bAssocTerminal;
  557. uint8_t bSourceID;
  558. uint8_t iTerminal;
  559. } __PACKED;
  560. #define AUDIO_SIZEOF_AC_OUTPUT_TERMINAL_DESC (9)
  561. struct audio_cs_if_ac_feature_unit_descriptor {
  562. uint8_t bLength;
  563. uint8_t bDescriptorType;
  564. uint8_t bDescriptorSubtype;
  565. uint8_t bUnitID;
  566. uint8_t bSourceID;
  567. uint8_t bControlSize;
  568. uint8_t bmaControls[1];
  569. uint8_t iFeature;
  570. } __PACKED;
  571. #define AUDIO_SIZEOF_AC_FEATURE_UNIT_DESC(ch, n) (7 + (ch + 1) * n)
  572. struct audio_cs_if_as_general_descriptor {
  573. uint8_t bLength;
  574. uint8_t bDescriptorType;
  575. uint8_t bDescriptorSubtype;
  576. uint8_t bTerminalLink;
  577. uint8_t bDelay;
  578. uint16_t wFormatTag;
  579. } __PACKED;
  580. #define AUDIO_SIZEOF_AS_GENERAL_DESC (7)
  581. struct audio_cs_if_as_format_type_descriptor {
  582. uint8_t bLength;
  583. uint8_t bDescriptorType;
  584. uint8_t bDescriptorSubtype;
  585. uint8_t bFormatType;
  586. uint8_t bNrChannels;
  587. uint8_t bSubframeSize;
  588. uint8_t bBitResolution;
  589. uint8_t bSamFreqType;
  590. uint8_t tSamFreq[3];
  591. } __PACKED;
  592. #define AUDIO_SIZEOF_FORMAT_TYPE_DESC(n) (8 + 3 * n)
  593. struct audio_ep_descriptor {
  594. uint8_t bLength;
  595. uint8_t bDescriptorType;
  596. uint8_t bEndpointAddress;
  597. uint8_t bmAttributes;
  598. uint16_t wMaxPacketSize;
  599. uint8_t bInterval;
  600. uint8_t bRefresh;
  601. uint8_t bSynchAddress;
  602. } __PACKED;
  603. #define AUDIO_SIZEOF_EP_DESC (9)
  604. struct audio_cs_ep_ep_general_descriptor {
  605. uint8_t bLength;
  606. uint8_t bDescriptorType;
  607. uint8_t bDescriptorSubtype;
  608. uint8_t bmAttributes;
  609. uint8_t bLockDelayUnits;
  610. uint16_t wLockDelay;
  611. } __PACKED;
  612. #define AUDIO_SIZEOF_CS_EP_GENERAL_DESC (7)
  613. // clang-format off
  614. #define AUDIO_AC_DESCRIPTOR_INIT(bFirstInterface, bInterfaceCount, wTotalLength, stridx, ...) \
  615. /* Interface Association Descriptor */ \
  616. 0x08, \
  617. USB_DESCRIPTOR_TYPE_INTERFACE_ASSOCIATION, \
  618. bFirstInterface, \
  619. bInterfaceCount, \
  620. USB_DEVICE_CLASS_AUDIO, \
  621. AUDIO_SUBCLASS_AUDIOCONTROL, \
  622. AUDIO_PROTOCOL_UNDEFINED, \
  623. 0x00, \
  624. /* ------------------ AudioControl Interface ------------------ */\
  625. 0x09, /* bLength */ \
  626. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  627. bFirstInterface, /* bInterfaceNumber */ \
  628. 0x00, /* bAlternateSetting */ \
  629. 0x00, /* bNumEndpoints */ \
  630. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  631. AUDIO_SUBCLASS_AUDIOCONTROL, /* bInterfaceSubClass */ \
  632. AUDIO_PROTOCOL_UNDEFINED, /* bInterfaceProtocol */ \
  633. stridx, /* iInterface */ \
  634. 0x08 + PP_NARG(__VA_ARGS__), /* bLength */ \
  635. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  636. AUDIO_CONTROL_HEADER, /* bDescriptorSubtype */ \
  637. WBVAL(0x0100), /* bcdADC */ \
  638. WBVAL(wTotalLength), /* wTotalLength */ \
  639. PP_NARG(__VA_ARGS__), /* bInCollection */ \
  640. __VA_ARGS__ /* baInterfaceNr */
  641. #define AUDIO_AC_DESCRIPTOR_INIT_LEN(n) (0x08 + 0x09 + 0x08 + n)
  642. #define AUDIO_AC_INPUT_TERMINAL_DESCRIPTOR_INIT(bTerminalID, wTerminalType, bNrChannels, wChannelConfig) \
  643. 0x0C, /* bLength */ \
  644. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  645. AUDIO_CONTROL_INPUT_TERMINAL, /* bDescriptorSubtype */ \
  646. bTerminalID, /* bTerminalID */ \
  647. WBVAL(wTerminalType), /* wTerminalType : Microphone 0x0201 */ \
  648. 0x00, /* bAssocTerminal */ \
  649. bNrChannels, /* bNrChannels */ \
  650. WBVAL(wChannelConfig), /* wChannelConfig : Mono sets no position bits */ \
  651. 0x00, /* iChannelNames */ \
  652. 0x00 /* iTerminal */
  653. #define AUDIO_AC_OUTPUT_TERMINAL_DESCRIPTOR_INIT(bTerminalID, wTerminalType, bSourceID) \
  654. 0x09, /* bLength */ \
  655. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  656. AUDIO_CONTROL_OUTPUT_TERMINAL, /* bDescriptorSubtype */ \
  657. bTerminalID, /* bTerminalID */ \
  658. WBVAL(wTerminalType), /* wTerminalType : USB Streaming */ \
  659. 0x00, /* bAssocTerminal */ \
  660. bSourceID, /* bSourceID */ \
  661. 0x00 /* iTerminal */
  662. #define AUDIO_AC_FEATURE_UNIT_DESCRIPTOR_INIT(bUnitID, bSourceID, bControlSize, ...) \
  663. 0x07 + PP_NARG(__VA_ARGS__), /* bLength */ \
  664. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  665. AUDIO_CONTROL_FEATURE_UNIT, /* bDescriptorSubtype */ \
  666. bUnitID, /* bUnitID */ \
  667. bSourceID, /* bSourceID */ \
  668. bControlSize, /* bControlSize */ \
  669. __VA_ARGS__, /* bmaControls(0) Mute */ \
  670. 0x00 /* iTerminal */
  671. #define AUDIO_AS_DESCRIPTOR_INIT(bInterfaceNumber, bTerminalLink, bNrChannels, bSubFrameSize, bBitResolution, bEndpointAddress, bmAttributes, wMaxPacketSize, bInterval, ...) \
  672. 0x09, /* bLength */ \
  673. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  674. bInterfaceNumber, /* bInterfaceNumber */ \
  675. 0x00, /* bAlternateSetting */ \
  676. 0x00, /* bNumEndpoints */ \
  677. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  678. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  679. AUDIO_PROTOCOL_UNDEFINED, /* bInterfaceProtocol */ \
  680. 0x00, /* iInterface */ \
  681. 0x09, /* bLength */ \
  682. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  683. bInterfaceNumber, /* bInterfaceNumber */ \
  684. 0x01, /* bAlternateSetting */ \
  685. 0x01, /* bNumEndpoints */ \
  686. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  687. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  688. AUDIO_PROTOCOL_UNDEFINED, /* bInterfaceProtocol */ \
  689. 0x00, /* iInterface */ \
  690. 0x07, /* bLength */ \
  691. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  692. AUDIO_STREAMING_GENERAL, /* bDescriptorSubtype */ \
  693. bTerminalLink, /* bTerminalLink : Unit ID of the Output Terminal*/ \
  694. 0x01, /* bDelay */ \
  695. WBVAL(AUDIO_FORMAT_PCM), /* wFormatTag : AUDIO_FORMAT_PCM */ \
  696. 0x08 + PP_NARG(__VA_ARGS__), /* bLength */ \
  697. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  698. AUDIO_STREAMING_FORMAT_TYPE, /* bDescriptorSubtype */ \
  699. AUDIO_FORMAT_TYPE_I, /* bFormatType */ \
  700. bNrChannels, /* bNrChannels */ \
  701. bSubFrameSize, /* bSubFrameSize : Bytes per audio subframe */ \
  702. bBitResolution, /* bBitResolution : bits per sample */ \
  703. (PP_NARG(__VA_ARGS__)/3), /* bSamFreqType : only one frequency supported */ \
  704. __VA_ARGS__, /* tSamFreq : Audio sampling frequency coded on 3 bytes */ \
  705. 0x09, /* bLength */ \
  706. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  707. bEndpointAddress, /* bEndpointAddress : IN endpoint 1 */ \
  708. bmAttributes, /* bmAttributes */ \
  709. WBVAL(wMaxPacketSize), /* wMaxPacketSize */ \
  710. bInterval, /* bInterval : one packet per frame */ \
  711. 0x00, /* bRefresh */ \
  712. 0x00, /* bSynchAddress */ \
  713. 0x07, /* bLength */ \
  714. AUDIO_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  715. AUDIO_ENDPOINT_GENERAL, /* bDescriptor */ \
  716. AUDIO_EP_CONTROL_SAMPLING_FEQ, /* bmAttributes AUDIO_SAMPLING_FREQ_CONTROL */ \
  717. 0x00, /* bLockDelayUnits */ \
  718. 0x00, /* wLockDelay */ \
  719. 0x00
  720. #define AUDIO_AS_DESCRIPTOR_INIT_LEN(n) (0x09 + 0x09 + 0x07 + 0x08 + 3 * n + 0x09 + 0x07)
  721. #define AUDIO_AS_ALTSETTING_DESCRIPTOR_INIT(bInterfaceNumber, bAlternateSetting, bTerminalLink, bNrChannels, bSubFrameSize, bBitResolution, bEndpointAddress, bmAttributes, wMaxPacketSize, bInterval, ...) \
  722. 0x09, /* bLength */ \
  723. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  724. bInterfaceNumber, /* bInterfaceNumber */ \
  725. bAlternateSetting, /* bAlternateSetting */ \
  726. 0x01, /* bNumEndpoints */ \
  727. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  728. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  729. AUDIO_PROTOCOL_UNDEFINED, /* bInterfaceProtocol */ \
  730. 0x00, /* iInterface */ \
  731. 0x07, /* bLength */ \
  732. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  733. AUDIO_STREAMING_GENERAL, /* bDescriptorSubtype */ \
  734. bTerminalLink, /* bTerminalLink : Unit ID of the Output Terminal*/ \
  735. 0x01, /* bDelay */ \
  736. WBVAL(AUDIO_FORMAT_PCM), /* wFormatTag : AUDIO_FORMAT_PCM */ \
  737. 0x08 + PP_NARG(__VA_ARGS__), /* bLength */ \
  738. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  739. AUDIO_STREAMING_FORMAT_TYPE, /* bDescriptorSubtype */ \
  740. AUDIO_FORMAT_TYPE_I, /* bFormatType */ \
  741. bNrChannels, /* bNrChannels */ \
  742. bSubFrameSize, /* bSubFrameSize : Bytes per audio subframe */ \
  743. bBitResolution, /* bBitResolution : bits per sample */ \
  744. (PP_NARG(__VA_ARGS__)/3), /* bSamFreqType : only one frequency supported */ \
  745. __VA_ARGS__, /* tSamFreq : Audio sampling frequency coded on 3 bytes */ \
  746. 0x09, /* bLength */ \
  747. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  748. bEndpointAddress, /* bEndpointAddress : IN endpoint 1 */ \
  749. bmAttributes, /* bmAttributes */ \
  750. WBVAL(wMaxPacketSize), /* wMaxPacketSize */ \
  751. bInterval, /* bInterval : one packet per frame */ \
  752. 0x00, /* bRefresh */ \
  753. 0x00, /* bSynchAddress */ \
  754. 0x07, /* bLength */ \
  755. AUDIO_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  756. AUDIO_ENDPOINT_GENERAL, /* bDescriptor */ \
  757. AUDIO_EP_CONTROL_SAMPLING_FEQ, /* bmAttributes AUDIO_SAMPLING_FREQ_CONTROL */ \
  758. 0x00, /* bLockDelayUnits */ \
  759. 0x00, /* wLockDelay */ \
  760. 0x00
  761. #define AUDIO_AS_ALTSETTING_DESCRIPTOR_INIT_LEN(n) (0x09 + 0x07 + 0x08 + 3 * n + 0x09 + 0x07)
  762. #define AUDIO_AS_ALTSETTING0_DESCRIPTOR_INIT(bInterfaceNumber) \
  763. 0x09, /* bLength */ \
  764. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  765. bInterfaceNumber, /* bInterfaceNumber */ \
  766. 0x00, /* bAlternateSetting */ \
  767. 0x01, /* bNumEndpoints */ \
  768. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  769. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  770. AUDIO_PROTOCOL_UNDEFINED, /* bInterfaceProtocol */ \
  771. 0x00 /* iInterface */
  772. #define AUDIO_MS_STANDARD_DESCRIPTOR_INIT(bInterfaceNumber, bNumEndpoints) \
  773. 0x09, /* bLength */ \
  774. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  775. bInterfaceNumber, /* bInterfaceNumber */ \
  776. 0x00, /* bAlternateSetting */ \
  777. bNumEndpoints, /* bNumEndpoints */ \
  778. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  779. AUDIO_SUBCLASS_MIDISTREAMING, /* bInterfaceSubClass */ \
  780. AUDIO_PROTOCOL_UNDEFINED, /* bInterfaceProtocol */ \
  781. 0x00 /* iInterface */
  782. #define AUDIO_MS_STANDARD_DESCRIPTOR_INIT_LEN 0x09
  783. struct audio_v2_channel_cluster_descriptor {
  784. uint8_t bNrChannels;
  785. uint32_t bmChannelConfig;
  786. uint8_t iChannelNames;
  787. } __PACKED;
  788. #define AUDIO_V2_SIZEOF_CHANNEL_CLUSTER_DESC (6)
  789. struct audio_v2_cs_if_ac_header_descriptor {
  790. uint8_t bLength;
  791. uint8_t bDescriptorType;
  792. uint8_t bDescriptorSubtype;
  793. uint16_t bcdADC;
  794. uint8_t bCategory;
  795. uint16_t wTotalLength;
  796. uint8_t bmControls;
  797. } __PACKED;
  798. #define AUDIO_V2_SIZEOF_AC_HEADER_DESC (9)
  799. struct audio_v2_cs_if_ac_clock_source_descriptor {
  800. uint8_t bLength;
  801. uint8_t bDescriptorType;
  802. uint8_t bDescriptorSubtype;
  803. uint8_t bClockID;
  804. uint8_t bmAttributes;
  805. uint8_t bmControls;
  806. uint8_t bAssocTerminal;
  807. uint8_t iClockSource;
  808. } __PACKED;
  809. #define AUDIO_V2_SIZEOF_AC_CLOCK_SOURCE_DESC (8)
  810. struct audio_v2_cs_if_ac_clock_selector_descriptor {
  811. uint8_t bLength;
  812. uint8_t bDescriptorType;
  813. uint8_t bDescriptorSubtype;
  814. uint8_t bClockID;
  815. uint8_t bNrInPins;
  816. uint8_t baCSourceID[1];
  817. uint8_t iClockSelector;
  818. } __PACKED;
  819. #define AUDIO_SIZEOF_AC_CLOCK_SELECTOR_DESC(n) (7 + n)
  820. struct audio_v2_cs_if_ac_clock_multiplier_descriptor {
  821. uint8_t bLength;
  822. uint8_t bDescriptorType;
  823. uint8_t bDescriptorSubtype;
  824. uint8_t bClockID;
  825. uint8_t bCSourceID;
  826. uint8_t bmControls;
  827. uint8_t iClockMultiplier;
  828. } __PACKED;
  829. #define AUDIO_SIZEOF_AC_CLOCK_MULTIPLIER_DESC() (7)
  830. struct audio_v2_cs_if_ac_input_terminal_descriptor {
  831. uint8_t bLength;
  832. uint8_t bDescriptorType;
  833. uint8_t bDescriptorSubtype;
  834. uint8_t bTerminalID;
  835. uint16_t wTerminalType;
  836. uint8_t bAssocTerminal;
  837. uint8_t bCSourceID;
  838. uint8_t bNrChannels;
  839. uint32_t wChannelConfig;
  840. uint8_t iChannelNames;
  841. uint16_t bmControls;
  842. uint8_t iTerminal;
  843. } __PACKED;
  844. #define AUDIO_V2_SIZEOF_AC_INPUT_TERMINAL_DESC (17)
  845. struct audio_v2_cs_if_ac_output_terminal_descriptor {
  846. uint8_t bLength;
  847. uint8_t bDescriptorType;
  848. uint8_t bDescriptorSubtype;
  849. uint8_t bTerminalID;
  850. uint16_t wTerminalType;
  851. uint8_t bAssocTerminal;
  852. uint8_t bSourceID;
  853. uint8_t bCSourceID;
  854. uint16_t bmControls;
  855. uint8_t iTerminal;
  856. } __PACKED;
  857. #define AUDIO_V2_SIZEOF_AC_OUTPUT_TERMINAL_DESC (12)
  858. struct audio_v2_cs_if_ac_feature_unit_descriptor {
  859. uint8_t bLength;
  860. uint8_t bDescriptorType;
  861. uint8_t bDescriptorSubtype;
  862. uint8_t bUnitID;
  863. uint8_t bSourceID;
  864. uint32_t bmaControls[1];
  865. uint8_t iFeature;
  866. } __PACKED;
  867. #define AUDIO_V2_SIZEOF_AC_FEATURE_UNIT_DESC(ch) (6 + (ch + 1) * 4)
  868. struct audio_v2_cs_if_as_general_descriptor {
  869. uint8_t bLength;
  870. uint8_t bDescriptorType;
  871. uint8_t bDescriptorSubtype;
  872. uint8_t bTerminalLink;
  873. uint8_t bmControls;
  874. uint8_t bFormatType;
  875. uint32_t bmFormats;
  876. uint8_t bNrChannels;
  877. uint32_t bmChannelConfig;
  878. uint8_t iChannelNames;
  879. } __PACKED;
  880. #define AUDIO_V2_SIZEOF_AS_GENERAL_DESC (16)
  881. struct audio_v2_control_range1_param_block {
  882. uint16_t wNumSubRanges;
  883. struct
  884. {
  885. uint8_t bMin;
  886. uint8_t bMax;
  887. uint8_t bRes;
  888. }subrange[];
  889. } __PACKED;
  890. struct audio_v2_control_range2_param_block {
  891. uint16_t wNumSubRanges;
  892. struct
  893. {
  894. uint16_t wMin;
  895. uint16_t wMax;
  896. uint16_t wRes;
  897. }subrange[];
  898. } __PACKED;
  899. struct audio_v2_control_range3_param_block {
  900. uint16_t wNumSubRanges;
  901. struct
  902. {
  903. uint32_t dMin;
  904. uint32_t dMax;
  905. uint32_t dRes;
  906. }subrange[];
  907. } __PACKED;
  908. #define AUDIO_V2_AC_DESCRIPTOR_INIT(bFirstInterface, bInterfaceCount, wTotalLength, bCategory, bmControls, stridx) \
  909. /* Interface Association Descriptor */ \
  910. 0x08, \
  911. USB_DESCRIPTOR_TYPE_INTERFACE_ASSOCIATION, \
  912. bFirstInterface, \
  913. bInterfaceCount, \
  914. USB_DEVICE_CLASS_AUDIO, \
  915. AUDIO_SUBCLASS_UNDEFINED, \
  916. AUDIO_PROTOCOLv20, \
  917. 0x00, \
  918. /* ------------------ AudioControl Interface ------------------ */\
  919. 0x09, /* bLength */ \
  920. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  921. bFirstInterface, /* bInterfaceNumber */ \
  922. 0x00, /* bAlternateSetting */ \
  923. 0x00, /* bNumEndpoints */ \
  924. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  925. AUDIO_SUBCLASS_AUDIOCONTROL, /* bInterfaceSubClass */ \
  926. AUDIO_PROTOCOLv20, /* bInterfaceProtocol */ \
  927. stridx, /* iInterface */ \
  928. 0x09, /* bLength */ \
  929. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  930. AUDIO_CONTROL_HEADER, /* bDescriptorSubtype */ \
  931. WBVAL(0x0200), /* bcdADC */ \
  932. bCategory, /* bCategory */ \
  933. WBVAL(wTotalLength), /* wTotalLength */ \
  934. bmControls /* bmControls */ \
  935. #define AUDIO_V2_AC_DESCRIPTOR_INIT_LEN (0x08 + 0x09 + 0x09)
  936. #define AUDIO_V2_AC_CLOCK_SOURCE_DESCRIPTOR_INIT(bClockID, bmAttributes, bmControls) \
  937. 0x08, /* bLength */ \
  938. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  939. AUDIO_CONTROL_CLOCK_SOURCE, /* bDescriptorSubtype */ \
  940. bClockID, /* bClockID */ \
  941. bmAttributes, /* bmAttributes */ \
  942. bmControls, /* bmControls */ \
  943. 0x00, /* bAssocTerminal */ \
  944. 0x00 /* iClockSource */
  945. #define AUDIO_V2_AC_INPUT_TERMINAL_DESCRIPTOR_INIT(bTerminalID, wTerminalType, bCSourceID, bNrChannels, wChannelConfig, bmControls) \
  946. 0x11, /* bLength */ \
  947. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  948. AUDIO_CONTROL_INPUT_TERMINAL, /* bDescriptorSubtype */ \
  949. bTerminalID, /* bTerminalID */ \
  950. WBVAL(wTerminalType), /* wTerminalType : Microphone 0x0201 */ \
  951. 0x00, /* bAssocTerminal */ \
  952. bCSourceID, /* bCSourceID */ \
  953. bNrChannels, /* bNrChannels */ \
  954. DBVAL(wChannelConfig), /* wChannelConfig : Mono sets no position bits */ \
  955. 0x00, /* iChannelNames */ \
  956. WBVAL(bmControls), /* bmControls */ \
  957. 0x00 /* iTerminal */
  958. #define AUDIO_V2_AC_OUTPUT_TERMINAL_DESCRIPTOR_INIT(bTerminalID, wTerminalType, bSourceID, bCSourceID, bmControls) \
  959. 0x0c, /* bLength */ \
  960. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  961. AUDIO_CONTROL_OUTPUT_TERMINAL, /* bDescriptorSubtype */ \
  962. bTerminalID, /* bTerminalID */ \
  963. WBVAL(wTerminalType), /* wTerminalType : USB Streaming */ \
  964. 0x00, /* bAssocTerminal */ \
  965. bSourceID, /* bSourceID */ \
  966. bCSourceID, /* bCSourceID */ \
  967. WBVAL(bmControls), /* bmControls */ \
  968. 0x00 /* iTerminal */
  969. #define AUDIO_V2_AC_FEATURE_UNIT_DESCRIPTOR_INIT(bUnitID, bSourceID, ...) \
  970. 0x06 + (PP_NARG(__VA_ARGS__)), /* bLength */ \
  971. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  972. AUDIO_CONTROL_FEATURE_UNIT, /* bDescriptorSubtype */ \
  973. bUnitID, /* bUnitID */ \
  974. bSourceID, /* bSourceID */ \
  975. __VA_ARGS__, /* bmaControls(0) Mute */ \
  976. 0x00 /* iTerminal */
  977. #define AUDIO_V2_AS_DESCRIPTOR_INIT(bInterfaceNumber, bTerminalLink, bNrChannels, bmChannelConfig, bSubslotSize, bBitResolution, bEndpointAddress, bmAttributes, wMaxPacketSize, bInterval) \
  978. 0x09, /* bLength */ \
  979. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  980. bInterfaceNumber, /* bInterfaceNumber */ \
  981. 0x00, /* bAlternateSetting */ \
  982. 0x00, /* bNumEndpoints */ \
  983. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  984. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  985. AUDIO_PROTOCOLv20, /* bInterfaceProtocol */ \
  986. 0x00, /* iInterface */ \
  987. 0x09, /* bLength */ \
  988. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  989. bInterfaceNumber, /* bInterfaceNumber */ \
  990. 0x01, /* bAlternateSetting */ \
  991. 0x01, /* bNumEndpoints */ \
  992. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  993. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  994. AUDIO_PROTOCOLv20, /* bInterfaceProtocol */ \
  995. 0x00, /* iInterface */ \
  996. 0x10, /* bLength */ \
  997. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  998. AUDIO_STREAMING_GENERAL, /* bDescriptorSubtype */ \
  999. bTerminalLink, /* bTerminalLink : Unit ID of the Output or Input Terminal*/ \
  1000. 0x00, /* bmControls */ \
  1001. AUDIO_FORMAT_TYPE_I, /* bFormatType : AUDIO_FORMAT_TYPE_I */ \
  1002. DBVAL(AUDIO_V2_FORMAT_PCM), /* bmFormats PCM */ \
  1003. bNrChannels, /* bNrChannels */ \
  1004. DBVAL(bmChannelConfig), /* bmChannelConfig */ \
  1005. 0x00, /* iChannelNames */ \
  1006. 0x06, /* bLength */ \
  1007. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1008. AUDIO_STREAMING_FORMAT_TYPE, /* bDescriptorSubtype */ \
  1009. AUDIO_FORMAT_TYPE_I, /* bFormatType */ \
  1010. bSubslotSize, /* bSubslotSize */ \
  1011. bBitResolution, /* bBitResolution */ \
  1012. 0x07, /* bLength */ \
  1013. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  1014. bEndpointAddress, /* bEndpointAddress 3 out endpoint for Audio */ \
  1015. bmAttributes, /* bmAttributes */ \
  1016. WBVAL(wMaxPacketSize), /* XXXX wMaxPacketSize in Bytes (SampleRate * SlotByteSize * NumChannels) */ \
  1017. bInterval, /* bInterval */ \
  1018. 0x08, /* bLength */ \
  1019. AUDIO_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1020. AUDIO_ENDPOINT_GENERAL, /* bDescriptor */ \
  1021. 0x00, /* bmAttributes */ \
  1022. 0x00, /* bmControls */ \
  1023. 0x00, /* bLockDelayUnits */ \
  1024. 0x00, /* wLockDelay */ \
  1025. 0x00
  1026. #define AUDIO_V2_AS_ALTSETTING_DESCRIPTOR_INIT(bInterfaceNumber, bAlternateSetting, bTerminalLink, bNrChannels, bmChannelConfig, bSubslotSize, bBitResolution, bEndpointAddress, bmAttributes, wMaxPacketSize, bInterval) \
  1027. 0x09, /* bLength */ \
  1028. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  1029. bInterfaceNumber, /* bInterfaceNumber */ \
  1030. bAlternateSetting, /* bAlternateSetting */ \
  1031. 0x01, /* bNumEndpoints */ \
  1032. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  1033. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  1034. AUDIO_PROTOCOLv20, /* bInterfaceProtocol */ \
  1035. 0x00, /* iInterface */ \
  1036. 0x10, /* bLength */ \
  1037. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1038. AUDIO_STREAMING_GENERAL, /* bDescriptorSubtype */ \
  1039. bTerminalLink, /* bTerminalLink : Unit ID of the Output or Input Terminal*/ \
  1040. 0x00, /* bmControls */ \
  1041. AUDIO_FORMAT_TYPE_I, /* bFormatType : AUDIO_FORMAT_TYPE_I */ \
  1042. DBVAL(AUDIO_V2_FORMAT_PCM), /* bmFormats PCM */ \
  1043. bNrChannels, /* bNrChannels */ \
  1044. DBVAL(bmChannelConfig), /* bmChannelConfig */ \
  1045. 0x00, /* iChannelNames */ \
  1046. 0x06, /* bLength */ \
  1047. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1048. AUDIO_STREAMING_FORMAT_TYPE, /* bDescriptorSubtype */ \
  1049. AUDIO_FORMAT_TYPE_I, /* bFormatType */ \
  1050. bSubslotSize, /* bSubslotSize */ \
  1051. bBitResolution, /* bBitResolution */ \
  1052. 0x07, /* bLength */ \
  1053. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  1054. bEndpointAddress, /* bEndpointAddress 3 out endpoint for Audio */ \
  1055. bmAttributes, /* bmAttributes */ \
  1056. WBVAL(wMaxPacketSize), /* XXXX wMaxPacketSize in Bytes (SampleRate * SlotByteSize * NumChannels) */ \
  1057. bInterval, /* bInterval */ \
  1058. 0x08, /* bLength */ \
  1059. AUDIO_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1060. AUDIO_ENDPOINT_GENERAL, /* bDescriptor */ \
  1061. 0x00, /* bmAttributes */ \
  1062. 0x00, /* bmControls */ \
  1063. 0x00, /* bLockDelayUnits */ \
  1064. 0x00, /* wLockDelay */ \
  1065. 0x00
  1066. #define AUDIO_V2_AS_ALTSETTING0_DESCRIPTOR_INIT(bInterfaceNumber) \
  1067. 0x09, /* bLength */ \
  1068. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  1069. bInterfaceNumber, /* bInterfaceNumber */ \
  1070. 0x00, /* bAlternateSetting */ \
  1071. 0x01, /* bNumEndpoints */ \
  1072. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  1073. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  1074. AUDIO_PROTOCOLv20, /* bInterfaceProtocol */ \
  1075. 0x00 /* iInterface */
  1076. #define AUDIO_V2_AS_FEEDBACK_DESCRIPTOR_INIT(bInterfaceNumber, bTerminalLink, bNrChannels, bmChannelConfig, bSubslotSize, bBitResolution, bEndpointAddress, wMaxPacketSize, bInterval, bFeedbackEndpointAddress) \
  1077. 0x09, /* bLength */ \
  1078. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  1079. bInterfaceNumber, /* bInterfaceNumber */ \
  1080. 0x00, /* bAlternateSetting */ \
  1081. 0x00, /* bNumEndpoints */ \
  1082. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  1083. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  1084. AUDIO_PROTOCOLv20, /* bInterfaceProtocol */ \
  1085. 0x00, /* iInterface */ \
  1086. 0x09, /* bLength */ \
  1087. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  1088. bInterfaceNumber, /* bInterfaceNumber */ \
  1089. 0x01, /* bAlternateSetting */ \
  1090. 0x02, /* bNumEndpoints */ \
  1091. USB_DEVICE_CLASS_AUDIO, /* bInterfaceClass */ \
  1092. AUDIO_SUBCLASS_AUDIOSTREAMING, /* bInterfaceSubClass */ \
  1093. AUDIO_PROTOCOLv20, /* bInterfaceProtocol */ \
  1094. 0x00, /* iInterface */ \
  1095. 0x10, /* bLength */ \
  1096. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1097. AUDIO_STREAMING_GENERAL, /* bDescriptorSubtype */ \
  1098. bTerminalLink, /* bTerminalLink : Unit ID of the Output or Input Terminal*/ \
  1099. 0x00, /* bmControls */ \
  1100. AUDIO_FORMAT_TYPE_I, /* bFormatType : AUDIO_FORMAT_TYPE_I */ \
  1101. DBVAL(AUDIO_V2_FORMAT_PCM), /* bmFormats PCM */ \
  1102. bNrChannels, /* bNrChannels */ \
  1103. DBVAL(bmChannelConfig), /* bmChannelConfig */ \
  1104. 0x00, /* iChannelNames */ \
  1105. 0x06, /* bLength */ \
  1106. AUDIO_INTERFACE_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1107. AUDIO_STREAMING_FORMAT_TYPE, /* bDescriptorSubtype */ \
  1108. AUDIO_FORMAT_TYPE_I, /* bFormatType */ \
  1109. bSubslotSize, /* bSubslotSize */ \
  1110. bBitResolution, /* bBitResolution */ \
  1111. 0x07, /* bLength */ \
  1112. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  1113. bEndpointAddress, /* bEndpointAddress 3 out endpoint for Audio */ \
  1114. 0x05, /* bmAttributes: TransferType=Isochronous SyncType=Asynchronous EndpointType=Data*/ \
  1115. WBVAL(wMaxPacketSize), /* XXXX wMaxPacketSize in Bytes (SampleRate * SlotByteSize * NumChannels) */ \
  1116. bInterval, /* bInterval */ \
  1117. 0x08, /* bLength */ \
  1118. AUDIO_ENDPOINT_DESCRIPTOR_TYPE, /* bDescriptorType */ \
  1119. AUDIO_ENDPOINT_GENERAL, /* bDescriptor */ \
  1120. 0x00, /* bmAttributes */ \
  1121. 0x00, /* bmControls */ \
  1122. 0x00, /* bLockDelayUnits */ \
  1123. 0x00, /* wLockDelay */ \
  1124. 0x00, \
  1125. 0x07, /* bLength */ \
  1126. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  1127. bFeedbackEndpointAddress, /* bFeedbackEndpointAddress Revise Dir to bEndpointAddress */ \
  1128. 0x11, /* bmAttributes: TransferType=Isochronous SyncType=None EndpointType=Feedback */ \
  1129. WBVAL(4), /* XXXX wMaxPacketSize in Bytes */ \
  1130. bInterval /* bInterval */
  1131. // clang-format on
  1132. #define AUDIO_V2_AS_DESCRIPTOR_INIT_LEN (0x09 + 0x09 + 0x10 + 0x06 + 0x07 + 0x08)
  1133. #define AUDIO_V2_AS_ALTSETTING_DESCRIPTOR_INIT_LEN (0x09 + 0x10 + 0x06 + 0x07 + 0x08)
  1134. #define AUDIO_V2_AS_FEEDBACK_DESCRIPTOR_INIT_LEN (0x09 + 0x09 + 0x10 + 0x06 + 0x07 + 0x08 + 0x07)
  1135. #define AUDIO_SAMPLE_FREQ_NUM(num) (uint8_t)(num), (uint8_t)((num >> 8))
  1136. #define AUDIO_SAMPLE_FREQ_3B(frq) (uint8_t)(frq), (uint8_t)((frq >> 8)), (uint8_t)((frq >> 16))
  1137. #define AUDIO_SAMPLE_FREQ_4B(frq) (uint8_t)(frq), (uint8_t)((frq >> 8)), \
  1138. (uint8_t)((frq >> 16)), (uint8_t)((frq >> 24))
  1139. #endif /* USB_AUDIO_H */