format.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. /*
  2. * This program is free software; you can redistribute it and/or modify
  3. * it under the terms of the GNU General Public License as published by
  4. * the Free Software Foundation; either version 2 of the License, or
  5. * (at your option) any later version.
  6. *
  7. * This program is distributed in the hope that it will be useful,
  8. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. * GNU General Public License for more details.
  11. *
  12. * You should have received a copy of the GNU General Public License
  13. * along with this program; if not, write to the Free Software
  14. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  15. *
  16. */
  17. #include <linux/init.h>
  18. #include <linux/slab.h>
  19. #include <linux/usb.h>
  20. #include <linux/usb/audio.h>
  21. #include <linux/usb/audio-v2.h>
  22. #include <sound/core.h>
  23. #include <sound/pcm.h>
  24. #include "usbaudio.h"
  25. #include "card.h"
  26. #include "quirks.h"
  27. #include "helper.h"
  28. #include "debug.h"
  29. #include "clock.h"
  30. #include "format.h"
  31. /*
  32. * parse the audio format type I descriptor
  33. * and returns the corresponding pcm format
  34. *
  35. * @dev: usb device
  36. * @fp: audioformat record
  37. * @format: the format tag (wFormatTag)
  38. * @fmt: the format type descriptor
  39. */
  40. static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
  41. struct audioformat *fp,
  42. unsigned int format, void *_fmt,
  43. int protocol)
  44. {
  45. int sample_width, sample_bytes;
  46. u64 pcm_formats = 0;
  47. switch (protocol) {
  48. case UAC_VERSION_1:
  49. default: {
  50. struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
  51. sample_width = fmt->bBitResolution;
  52. sample_bytes = fmt->bSubframeSize;
  53. format = 1 << format;
  54. break;
  55. }
  56. case UAC_VERSION_2: {
  57. struct uac_format_type_i_ext_descriptor *fmt = _fmt;
  58. sample_width = fmt->bBitResolution;
  59. sample_bytes = fmt->bSubslotSize;
  60. if (format & UAC2_FORMAT_TYPE_I_RAW_DATA)
  61. pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
  62. format <<= 1;
  63. break;
  64. }
  65. }
  66. if ((pcm_formats == 0) &&
  67. (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
  68. /* some devices don't define this correctly... */
  69. snd_printdd(KERN_INFO "%d:%u:%d : format type 0 is detected, processed as PCM\n",
  70. chip->dev->devnum, fp->iface, fp->altsetting);
  71. format = 1 << UAC_FORMAT_TYPE_I_PCM;
  72. }
  73. if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
  74. if (chip->usb_id == USB_ID(0x0582, 0x0016) /* Edirol SD-90 */ &&
  75. sample_width == 24 && sample_bytes == 2)
  76. sample_bytes = 3;
  77. else if (sample_width > sample_bytes * 8) {
  78. snd_printk(KERN_INFO "%d:%u:%d : sample bitwidth %d in over sample bytes %d\n",
  79. chip->dev->devnum, fp->iface, fp->altsetting,
  80. sample_width, sample_bytes);
  81. }
  82. /* check the format byte size */
  83. switch (sample_bytes) {
  84. case 1:
  85. pcm_formats |= SNDRV_PCM_FMTBIT_S8;
  86. break;
  87. case 2:
  88. if (snd_usb_is_big_endian_format(chip, fp))
  89. pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
  90. else
  91. pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
  92. break;
  93. case 3:
  94. if (snd_usb_is_big_endian_format(chip, fp))
  95. pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
  96. else
  97. pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
  98. break;
  99. case 4:
  100. pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
  101. break;
  102. default:
  103. snd_printk(KERN_INFO "%d:%u:%d : unsupported sample bitwidth %d in %d bytes\n",
  104. chip->dev->devnum, fp->iface, fp->altsetting,
  105. sample_width, sample_bytes);
  106. break;
  107. }
  108. }
  109. if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
  110. /* Dallas DS4201 workaround: it advertises U8 format, but really
  111. supports S8. */
  112. if (chip->usb_id == USB_ID(0x04fa, 0x4201))
  113. pcm_formats |= SNDRV_PCM_FMTBIT_S8;
  114. else
  115. pcm_formats |= SNDRV_PCM_FMTBIT_U8;
  116. }
  117. if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
  118. pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
  119. }
  120. if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
  121. pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
  122. }
  123. if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
  124. pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
  125. }
  126. if (format & ~0x3f) {
  127. snd_printk(KERN_INFO "%d:%u:%d : unsupported format bits %#x\n",
  128. chip->dev->devnum, fp->iface, fp->altsetting, format);
  129. }
  130. pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
  131. return pcm_formats;
  132. }
  133. /*
  134. * parse the format descriptor and stores the possible sample rates
  135. * on the audioformat table (audio class v1).
  136. *
  137. * @dev: usb device
  138. * @fp: audioformat record
  139. * @fmt: the format descriptor
  140. * @offset: the start offset of descriptor pointing the rate type
  141. * (7 for type I and II, 8 for type II)
  142. */
  143. static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
  144. unsigned char *fmt, int offset)
  145. {
  146. int nr_rates = fmt[offset];
  147. if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
  148. snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
  149. chip->dev->devnum, fp->iface, fp->altsetting);
  150. return -EINVAL;
  151. }
  152. if (nr_rates) {
  153. /*
  154. * build the rate table and bitmap flags
  155. */
  156. int r, idx;
  157. fp->rate_table = kmalloc(sizeof(int) * nr_rates, GFP_KERNEL);
  158. if (fp->rate_table == NULL) {
  159. snd_printk(KERN_ERR "cannot malloc\n");
  160. return -ENOMEM;
  161. }
  162. fp->nr_rates = 0;
  163. fp->rate_min = fp->rate_max = 0;
  164. for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
  165. unsigned int rate = combine_triple(&fmt[idx]);
  166. if (!rate)
  167. continue;
  168. /* C-Media CM6501 mislabels its 96 kHz altsetting */
  169. /* Terratec Aureon 7.1 USB C-Media 6206, too */
  170. if (rate == 48000 && nr_rates == 1 &&
  171. (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
  172. chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
  173. chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
  174. fp->altsetting == 5 && fp->maxpacksize == 392)
  175. rate = 96000;
  176. /* Creative VF0470 Live Cam reports 16 kHz instead of 8kHz */
  177. if (rate == 16000 && chip->usb_id == USB_ID(0x041e, 0x4068))
  178. rate = 8000;
  179. fp->rate_table[fp->nr_rates] = rate;
  180. if (!fp->rate_min || rate < fp->rate_min)
  181. fp->rate_min = rate;
  182. if (!fp->rate_max || rate > fp->rate_max)
  183. fp->rate_max = rate;
  184. fp->rates |= snd_pcm_rate_to_rate_bit(rate);
  185. fp->nr_rates++;
  186. }
  187. if (!fp->nr_rates) {
  188. hwc_debug("All rates were zero. Skipping format!\n");
  189. return -EINVAL;
  190. }
  191. } else {
  192. /* continuous rates */
  193. fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
  194. fp->rate_min = combine_triple(&fmt[offset + 1]);
  195. fp->rate_max = combine_triple(&fmt[offset + 4]);
  196. }
  197. return 0;
  198. }
  199. /*
  200. * Helper function to walk the array of sample rate triplets reported by
  201. * the device. The problem is that we need to parse whole array first to
  202. * get to know how many sample rates we have to expect.
  203. * Then fp->rate_table can be allocated and filled.
  204. */
  205. static int parse_uac2_sample_rate_range(struct audioformat *fp, int nr_triplets,
  206. const unsigned char *data)
  207. {
  208. int i, nr_rates = 0;
  209. fp->rates = fp->rate_min = fp->rate_max = 0;
  210. for (i = 0; i < nr_triplets; i++) {
  211. int min = combine_quad(&data[2 + 12 * i]);
  212. int max = combine_quad(&data[6 + 12 * i]);
  213. int res = combine_quad(&data[10 + 12 * i]);
  214. unsigned int rate;
  215. if ((max < 0) || (min < 0) || (res < 0) || (max < min))
  216. continue;
  217. /*
  218. * for ranges with res == 1, we announce a continuous sample
  219. * rate range, and this function should return 0 for no further
  220. * parsing.
  221. */
  222. if (res == 1) {
  223. fp->rate_min = min;
  224. fp->rate_max = max;
  225. fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
  226. return 0;
  227. }
  228. for (rate = min; rate <= max; rate += res) {
  229. if (fp->rate_table)
  230. fp->rate_table[nr_rates] = rate;
  231. if (!fp->rate_min || rate < fp->rate_min)
  232. fp->rate_min = rate;
  233. if (!fp->rate_max || rate > fp->rate_max)
  234. fp->rate_max = rate;
  235. fp->rates |= snd_pcm_rate_to_rate_bit(rate);
  236. nr_rates++;
  237. if (nr_rates >= MAX_NR_RATES) {
  238. snd_printk(KERN_ERR "invalid uac2 rates\n");
  239. break;
  240. }
  241. /* avoid endless loop */
  242. if (res == 0)
  243. break;
  244. }
  245. }
  246. return nr_rates;
  247. }
  248. /*
  249. * parse the format descriptor and stores the possible sample rates
  250. * on the audioformat table (audio class v2).
  251. */
  252. static int parse_audio_format_rates_v2(struct snd_usb_audio *chip,
  253. struct audioformat *fp)
  254. {
  255. struct usb_device *dev = chip->dev;
  256. unsigned char tmp[2], *data;
  257. int nr_triplets, data_size, ret = 0;
  258. int clock = snd_usb_clock_find_source(chip, fp->clock, false);
  259. if (clock < 0) {
  260. snd_printk(KERN_ERR "%s(): unable to find clock source (clock %d)\n",
  261. __func__, clock);
  262. goto err;
  263. }
  264. /* get the number of sample rates first by only fetching 2 bytes */
  265. ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
  266. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
  267. UAC2_CS_CONTROL_SAM_FREQ << 8,
  268. snd_usb_ctrl_intf(chip) | (clock << 8),
  269. tmp, sizeof(tmp));
  270. if (ret < 0) {
  271. snd_printk(KERN_ERR "%s(): unable to retrieve number of sample rates (clock %d)\n",
  272. __func__, clock);
  273. goto err;
  274. }
  275. nr_triplets = (tmp[1] << 8) | tmp[0];
  276. data_size = 2 + 12 * nr_triplets;
  277. data = kzalloc(data_size, GFP_KERNEL);
  278. if (!data) {
  279. ret = -ENOMEM;
  280. goto err;
  281. }
  282. /* now get the full information */
  283. ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
  284. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
  285. UAC2_CS_CONTROL_SAM_FREQ << 8,
  286. snd_usb_ctrl_intf(chip) | (clock << 8),
  287. data, data_size);
  288. if (ret < 0) {
  289. snd_printk(KERN_ERR "%s(): unable to retrieve sample rate range (clock %d)\n",
  290. __func__, clock);
  291. ret = -EINVAL;
  292. goto err_free;
  293. }
  294. /* Call the triplet parser, and make sure fp->rate_table is NULL.
  295. * We just use the return value to know how many sample rates we
  296. * will have to deal with. */
  297. kfree(fp->rate_table);
  298. fp->rate_table = NULL;
  299. fp->nr_rates = parse_uac2_sample_rate_range(fp, nr_triplets, data);
  300. if (fp->nr_rates == 0) {
  301. /* SNDRV_PCM_RATE_CONTINUOUS */
  302. ret = 0;
  303. goto err_free;
  304. }
  305. fp->rate_table = kmalloc(sizeof(int) * fp->nr_rates, GFP_KERNEL);
  306. if (!fp->rate_table) {
  307. ret = -ENOMEM;
  308. goto err_free;
  309. }
  310. /* Call the triplet parser again, but this time, fp->rate_table is
  311. * allocated, so the rates will be stored */
  312. parse_uac2_sample_rate_range(fp, nr_triplets, data);
  313. err_free:
  314. kfree(data);
  315. err:
  316. return ret;
  317. }
  318. /*
  319. * parse the format type I and III descriptors
  320. */
  321. static int parse_audio_format_i(struct snd_usb_audio *chip,
  322. struct audioformat *fp, unsigned int format,
  323. struct uac_format_type_i_continuous_descriptor *fmt,
  324. struct usb_host_interface *iface)
  325. {
  326. struct usb_interface_descriptor *altsd = get_iface_desc(iface);
  327. int protocol = altsd->bInterfaceProtocol;
  328. snd_pcm_format_t pcm_format;
  329. int ret;
  330. if (fmt->bFormatType == UAC_FORMAT_TYPE_III) {
  331. /* FIXME: the format type is really IECxxx
  332. * but we give normal PCM format to get the existing
  333. * apps working...
  334. */
  335. switch (chip->usb_id) {
  336. case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
  337. if (chip->setup == 0x00 &&
  338. fp->altsetting == 6)
  339. pcm_format = SNDRV_PCM_FORMAT_S16_BE;
  340. else
  341. pcm_format = SNDRV_PCM_FORMAT_S16_LE;
  342. break;
  343. default:
  344. pcm_format = SNDRV_PCM_FORMAT_S16_LE;
  345. }
  346. fp->formats = pcm_format_to_bits(pcm_format);
  347. } else {
  348. fp->formats = parse_audio_format_i_type(chip, fp, format,
  349. fmt, protocol);
  350. if (!fp->formats)
  351. return -EINVAL;
  352. }
  353. /* gather possible sample rates */
  354. /* audio class v1 reports possible sample rates as part of the
  355. * proprietary class specific descriptor.
  356. * audio class v2 uses class specific EP0 range requests for that.
  357. */
  358. switch (protocol) {
  359. default:
  360. snd_printdd(KERN_WARNING "%d:%u:%d : invalid protocol version %d, assuming v1\n",
  361. chip->dev->devnum, fp->iface, fp->altsetting, protocol);
  362. /* fall through */
  363. case UAC_VERSION_1:
  364. fp->channels = fmt->bNrChannels;
  365. ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
  366. break;
  367. case UAC_VERSION_2:
  368. /* fp->channels is already set in this case */
  369. ret = parse_audio_format_rates_v2(chip, fp);
  370. break;
  371. }
  372. if (fp->channels < 1) {
  373. snd_printk(KERN_ERR "%d:%u:%d : invalid channels %d\n",
  374. chip->dev->devnum, fp->iface, fp->altsetting, fp->channels);
  375. return -EINVAL;
  376. }
  377. return ret;
  378. }
  379. /*
  380. * parse the format type II descriptor
  381. */
  382. static int parse_audio_format_ii(struct snd_usb_audio *chip,
  383. struct audioformat *fp,
  384. int format, void *_fmt,
  385. struct usb_host_interface *iface)
  386. {
  387. int brate, framesize, ret;
  388. struct usb_interface_descriptor *altsd = get_iface_desc(iface);
  389. int protocol = altsd->bInterfaceProtocol;
  390. switch (format) {
  391. case UAC_FORMAT_TYPE_II_AC3:
  392. /* FIXME: there is no AC3 format defined yet */
  393. // fp->formats = SNDRV_PCM_FMTBIT_AC3;
  394. fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
  395. break;
  396. case UAC_FORMAT_TYPE_II_MPEG:
  397. fp->formats = SNDRV_PCM_FMTBIT_MPEG;
  398. break;
  399. default:
  400. snd_printd(KERN_INFO "%d:%u:%d : unknown format tag %#x is detected. processed as MPEG.\n",
  401. chip->dev->devnum, fp->iface, fp->altsetting, format);
  402. fp->formats = SNDRV_PCM_FMTBIT_MPEG;
  403. break;
  404. }
  405. fp->channels = 1;
  406. switch (protocol) {
  407. default:
  408. snd_printdd(KERN_WARNING "%d:%u:%d : invalid protocol version %d, assuming v1\n",
  409. chip->dev->devnum, fp->iface, fp->altsetting, protocol);
  410. /* fall through */
  411. case UAC_VERSION_1: {
  412. struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
  413. brate = le16_to_cpu(fmt->wMaxBitRate);
  414. framesize = le16_to_cpu(fmt->wSamplesPerFrame);
  415. snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
  416. fp->frame_size = framesize;
  417. ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
  418. break;
  419. }
  420. case UAC_VERSION_2: {
  421. struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
  422. brate = le16_to_cpu(fmt->wMaxBitRate);
  423. framesize = le16_to_cpu(fmt->wSamplesPerFrame);
  424. snd_printd(KERN_INFO "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
  425. fp->frame_size = framesize;
  426. ret = parse_audio_format_rates_v2(chip, fp);
  427. break;
  428. }
  429. }
  430. return ret;
  431. }
  432. int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
  433. struct audioformat *fp, unsigned int format,
  434. struct uac_format_type_i_continuous_descriptor *fmt,
  435. int stream, struct usb_host_interface *iface)
  436. {
  437. int err;
  438. switch (fmt->bFormatType) {
  439. case UAC_FORMAT_TYPE_I:
  440. case UAC_FORMAT_TYPE_III:
  441. err = parse_audio_format_i(chip, fp, format, fmt, iface);
  442. break;
  443. case UAC_FORMAT_TYPE_II:
  444. err = parse_audio_format_ii(chip, fp, format, fmt, iface);
  445. break;
  446. default:
  447. snd_printd(KERN_INFO "%d:%u:%d : format type %d is not supported yet\n",
  448. chip->dev->devnum, fp->iface, fp->altsetting,
  449. fmt->bFormatType);
  450. return -ENOTSUPP;
  451. }
  452. fp->fmt_type = fmt->bFormatType;
  453. if (err < 0)
  454. return err;
  455. #if 1
  456. /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
  457. /* extigy apparently supports sample rates other than 48k
  458. * but not in ordinary way. so we enable only 48k atm.
  459. */
  460. if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
  461. chip->usb_id == USB_ID(0x041e, 0x3020) ||
  462. chip->usb_id == USB_ID(0x041e, 0x3061)) {
  463. if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
  464. fp->rates != SNDRV_PCM_RATE_48000 &&
  465. fp->rates != SNDRV_PCM_RATE_96000)
  466. return -ENOTSUPP;
  467. }
  468. #endif
  469. return 0;
  470. }