blob: 3bfead393aa346e86ccfe4fb05e7fd21e14bc8cd [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Daniel Macke5779992010-03-04 19:46:13 +01002/*
Daniel Macke5779992010-03-04 19:46:13 +01003 */
4
5#include <linux/init.h>
Stephen Rothwell36db0452010-03-29 16:02:50 +11006#include <linux/slab.h>
Daniel Macke5779992010-03-04 19:46:13 +01007#include <linux/usb.h>
8#include <linux/usb/audio.h>
Daniel Mack7e847892010-03-11 21:13:20 +01009#include <linux/usb/audio-v2.h>
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +020010#include <linux/usb/audio-v3.h>
Daniel Macke5779992010-03-04 19:46:13 +010011
12#include <sound/core.h>
13#include <sound/pcm.h>
14
15#include "usbaudio.h"
16#include "card.h"
17#include "quirks.h"
18#include "helper.h"
19#include "debug.h"
Daniel Mack79f920f2010-05-31 14:51:31 +020020#include "clock.h"
Daniel Mackee95cb62011-05-18 11:28:40 +020021#include "format.h"
Daniel Macke5779992010-03-04 19:46:13 +010022
23/*
24 * parse the audio format type I descriptor
25 * and returns the corresponding pcm format
26 *
27 * @dev: usb device
28 * @fp: audioformat record
29 * @format: the format tag (wFormatTag)
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +020030 * @fmt: the format type descriptor (v1/v2) or AudioStreaming descriptor (v3)
Daniel Macke5779992010-03-04 19:46:13 +010031 */
Clemens Ladisch29088fe2010-03-04 19:46:16 +010032static u64 parse_audio_format_i_type(struct snd_usb_audio *chip,
Daniel Macke5779992010-03-04 19:46:13 +010033 struct audioformat *fp,
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +020034 u64 format, void *_fmt)
Daniel Macke5779992010-03-04 19:46:13 +010035{
Daniel Macke5779992010-03-04 19:46:13 +010036 int sample_width, sample_bytes;
Daniel Mack717bfb52013-03-17 20:07:25 +080037 u64 pcm_formats = 0;
Daniel Macke5779992010-03-04 19:46:13 +010038
Clemens Ladisch8f898e92013-01-31 21:39:17 +010039 switch (fp->protocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +020040 case UAC_VERSION_1:
41 default: {
Daniel Macke5779992010-03-04 19:46:13 +010042 struct uac_format_type_i_discrete_descriptor *fmt = _fmt;
43 sample_width = fmt->bBitResolution;
44 sample_bytes = fmt->bSubframeSize;
Dan Carpenterb44d4192018-03-29 12:03:19 +030045 format = 1ULL << format;
Daniel Macke5779992010-03-04 19:46:13 +010046 break;
47 }
48
49 case UAC_VERSION_2: {
50 struct uac_format_type_i_ext_descriptor *fmt = _fmt;
51 sample_width = fmt->bBitResolution;
52 sample_bytes = fmt->bSubslotSize;
Daniel Mack717bfb52013-03-17 20:07:25 +080053
Jussi Laako3a572d92018-06-13 01:43:01 +030054 if (format & UAC2_FORMAT_TYPE_I_RAW_DATA) {
Daniel Mack717bfb52013-03-17 20:07:25 +080055 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
Jussi Laako3a572d92018-06-13 01:43:01 +030056 /* flag potentially raw DSD capable altsettings */
57 fp->dsd_raw = true;
58 }
Daniel Mack717bfb52013-03-17 20:07:25 +080059
Clemens Ladisch29088fe2010-03-04 19:46:16 +010060 format <<= 1;
Daniel Macke5779992010-03-04 19:46:13 +010061 break;
62 }
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +020063 case UAC_VERSION_3: {
64 struct uac3_as_header_descriptor *as = _fmt;
65
66 sample_width = as->bBitResolution;
67 sample_bytes = as->bSubslotSize;
68
69 if (format & UAC3_FORMAT_TYPE_I_RAW_DATA)
70 pcm_formats |= SNDRV_PCM_FMTBIT_SPECIAL;
71
72 format <<= 1;
73 break;
74 }
Daniel Macke5779992010-03-04 19:46:13 +010075 }
76
Jussi Laakoc7a13262019-02-18 00:17:21 +020077 fp->fmt_bits = sample_width;
78
Daniel Mack717bfb52013-03-17 20:07:25 +080079 if ((pcm_formats == 0) &&
80 (format == 0 || format == (1 << UAC_FORMAT_TYPE_I_UNDEFINED))) {
Clemens Ladisch29088fe2010-03-04 19:46:16 +010081 /* some devices don't define this correctly... */
Takashi Iwai0ba41d92014-02-26 13:02:17 +010082 usb_audio_info(chip, "%u:%d : format type 0 is detected, processed as PCM\n",
83 fp->iface, fp->altsetting);
Clemens Ladisch29088fe2010-03-04 19:46:16 +010084 format = 1 << UAC_FORMAT_TYPE_I_PCM;
85 }
86 if (format & (1 << UAC_FORMAT_TYPE_I_PCM)) {
Takamichi Horikawa6d1f2f62015-04-21 11:23:57 +090087 if (((chip->usb_id == USB_ID(0x0582, 0x0016)) ||
88 /* Edirol SD-90 */
89 (chip->usb_id == USB_ID(0x0582, 0x000c))) &&
90 /* Roland SC-D70 */
Clemens Ladisch061b8692011-01-10 16:30:54 +010091 sample_width == 24 && sample_bytes == 2)
92 sample_bytes = 3;
93 else if (sample_width > sample_bytes * 8) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +010094 usb_audio_info(chip, "%u:%d : sample bitwidth %d in over sample bytes %d\n",
95 fp->iface, fp->altsetting,
96 sample_width, sample_bytes);
Daniel Macke5779992010-03-04 19:46:13 +010097 }
98 /* check the format byte size */
99 switch (sample_bytes) {
100 case 1:
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100101 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
Daniel Macke5779992010-03-04 19:46:13 +0100102 break;
103 case 2:
104 if (snd_usb_is_big_endian_format(chip, fp))
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100105 pcm_formats |= SNDRV_PCM_FMTBIT_S16_BE; /* grrr, big endian!! */
Daniel Macke5779992010-03-04 19:46:13 +0100106 else
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100107 pcm_formats |= SNDRV_PCM_FMTBIT_S16_LE;
Daniel Macke5779992010-03-04 19:46:13 +0100108 break;
109 case 3:
110 if (snd_usb_is_big_endian_format(chip, fp))
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100111 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3BE; /* grrr, big endian!! */
Daniel Macke5779992010-03-04 19:46:13 +0100112 else
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100113 pcm_formats |= SNDRV_PCM_FMTBIT_S24_3LE;
Daniel Macke5779992010-03-04 19:46:13 +0100114 break;
115 case 4:
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100116 pcm_formats |= SNDRV_PCM_FMTBIT_S32_LE;
Daniel Macke5779992010-03-04 19:46:13 +0100117 break;
118 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100119 usb_audio_info(chip,
120 "%u:%d : unsupported sample bitwidth %d in %d bytes\n",
121 fp->iface, fp->altsetting,
122 sample_width, sample_bytes);
Daniel Macke5779992010-03-04 19:46:13 +0100123 break;
124 }
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100125 }
126 if (format & (1 << UAC_FORMAT_TYPE_I_PCM8)) {
Daniel Macke5779992010-03-04 19:46:13 +0100127 /* Dallas DS4201 workaround: it advertises U8 format, but really
128 supports S8. */
129 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100130 pcm_formats |= SNDRV_PCM_FMTBIT_S8;
131 else
132 pcm_formats |= SNDRV_PCM_FMTBIT_U8;
Daniel Macke5779992010-03-04 19:46:13 +0100133 }
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100134 if (format & (1 << UAC_FORMAT_TYPE_I_IEEE_FLOAT)) {
135 pcm_formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
136 }
137 if (format & (1 << UAC_FORMAT_TYPE_I_ALAW)) {
138 pcm_formats |= SNDRV_PCM_FMTBIT_A_LAW;
139 }
140 if (format & (1 << UAC_FORMAT_TYPE_I_MULAW)) {
141 pcm_formats |= SNDRV_PCM_FMTBIT_MU_LAW;
142 }
143 if (format & ~0x3f) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100144 usb_audio_info(chip,
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200145 "%u:%d : unsupported format bits %#llx\n",
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100146 fp->iface, fp->altsetting, format);
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100147 }
Daniel Mack126825e2013-04-17 00:01:40 +0800148
149 pcm_formats |= snd_usb_interface_dsd_format_quirks(chip, fp, sample_bytes);
150
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100151 return pcm_formats;
Daniel Macke5779992010-03-04 19:46:13 +0100152}
153
Takashi Iwai74f73472020-02-11 12:14:19 +0100154static int set_fixed_rate(struct audioformat *fp, int rate, int rate_bits)
155{
156 kfree(fp->rate_table);
157 fp->rate_table = kmalloc(sizeof(int), GFP_KERNEL);
158 if (!fp->rate_table)
159 return -ENOMEM;
160 fp->nr_rates = 1;
161 fp->rate_min = rate;
162 fp->rate_max = rate;
163 fp->rates = rate_bits;
164 fp->rate_table[0] = rate;
165 return 0;
166}
Daniel Macke5779992010-03-04 19:46:13 +0100167
168/*
169 * parse the format descriptor and stores the possible sample rates
170 * on the audioformat table (audio class v1).
171 *
172 * @dev: usb device
173 * @fp: audioformat record
174 * @fmt: the format descriptor
175 * @offset: the start offset of descriptor pointing the rate type
176 * (7 for type I and II, 8 for type II)
177 */
178static int parse_audio_format_rates_v1(struct snd_usb_audio *chip, struct audioformat *fp,
179 unsigned char *fmt, int offset)
180{
181 int nr_rates = fmt[offset];
182
183 if (fmt[0] < offset + 1 + 3 * (nr_rates ? nr_rates : 2)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100184 usb_audio_err(chip,
185 "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
186 fp->iface, fp->altsetting);
Sachin Kamat8ad10dc2012-11-21 15:25:56 +0530187 return -EINVAL;
Daniel Macke5779992010-03-04 19:46:13 +0100188 }
189
190 if (nr_rates) {
191 /*
192 * build the rate table and bitmap flags
193 */
194 int r, idx;
195
Kees Cook6da2ec52018-06-12 13:55:00 -0700196 fp->rate_table = kmalloc_array(nr_rates, sizeof(int),
197 GFP_KERNEL);
Shawn Lin1bc00f322016-08-21 10:17:36 +0800198 if (fp->rate_table == NULL)
Sachin Kamat8ad10dc2012-11-21 15:25:56 +0530199 return -ENOMEM;
Daniel Macke5779992010-03-04 19:46:13 +0100200
201 fp->nr_rates = 0;
202 fp->rate_min = fp->rate_max = 0;
203 for (r = 0, idx = offset + 1; r < nr_rates; r++, idx += 3) {
204 unsigned int rate = combine_triple(&fmt[idx]);
205 if (!rate)
206 continue;
207 /* C-Media CM6501 mislabels its 96 kHz altsetting */
Wolfgang Breyha8129e792011-04-28 16:18:40 +0200208 /* Terratec Aureon 7.1 USB C-Media 6206, too */
Daniel Macke5779992010-03-04 19:46:13 +0100209 if (rate == 48000 && nr_rates == 1 &&
210 (chip->usb_id == USB_ID(0x0d8c, 0x0201) ||
Wolfgang Breyha8129e792011-04-28 16:18:40 +0200211 chip->usb_id == USB_ID(0x0d8c, 0x0102) ||
212 chip->usb_id == USB_ID(0x0ccd, 0x00b1)) &&
Daniel Macke5779992010-03-04 19:46:13 +0100213 fp->altsetting == 5 && fp->maxpacksize == 392)
214 rate = 96000;
Pavel Hofman8c4b79c2014-01-14 13:42:57 +0100215 /* Creative VF0420/VF0470 Live Cams report 16 kHz instead of 8kHz */
216 if (rate == 16000 &&
217 (chip->usb_id == USB_ID(0x041e, 0x4064) ||
218 chip->usb_id == USB_ID(0x041e, 0x4068)))
Daniel Macke5779992010-03-04 19:46:13 +0100219 rate = 8000;
220
221 fp->rate_table[fp->nr_rates] = rate;
222 if (!fp->rate_min || rate < fp->rate_min)
223 fp->rate_min = rate;
224 if (!fp->rate_max || rate > fp->rate_max)
225 fp->rate_max = rate;
226 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
227 fp->nr_rates++;
228 }
229 if (!fp->nr_rates) {
230 hwc_debug("All rates were zero. Skipping format!\n");
Sachin Kamat8ad10dc2012-11-21 15:25:56 +0530231 return -EINVAL;
Daniel Macke5779992010-03-04 19:46:13 +0100232 }
233 } else {
234 /* continuous rates */
235 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
236 fp->rate_min = combine_triple(&fmt[offset + 1]);
237 fp->rate_max = combine_triple(&fmt[offset + 4]);
238 }
Takashi Iwai74f73472020-02-11 12:14:19 +0100239
240 /* Jabra Evolve 65 headset */
241 if (chip->usb_id == USB_ID(0x0b0e, 0x030b)) {
242 /* only 48kHz for playback while keeping 16kHz for capture */
243 if (fp->nr_rates != 1)
244 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
245 }
246
Daniel Macke5779992010-03-04 19:46:13 +0100247 return 0;
248}
249
Nick Kossifidis8dc5efe2020-02-15 03:23:35 +0200250
251/*
252 * Presonus Studio 1810c supports a limited set of sampling
253 * rates per altsetting but reports the full set each time.
254 * If we don't filter out the unsupported rates and attempt
255 * to configure the card, it will hang refusing to do any
256 * further audio I/O until a hard reset is performed.
257 *
258 * The list of supported rates per altsetting (set of available
259 * I/O channels) is described in the owner's manual, section 2.2.
260 */
261static bool s1810c_valid_sample_rate(struct audioformat *fp,
262 unsigned int rate)
263{
264 switch (fp->altsetting) {
265 case 1:
266 /* All ADAT ports available */
267 return rate <= 48000;
268 case 2:
269 /* Half of ADAT ports available */
270 return (rate == 88200 || rate == 96000);
271 case 3:
272 /* Analog I/O only (no S/PDIF nor ADAT) */
273 return rate >= 176400;
274 default:
275 return false;
276 }
277 return false;
278}
279
Daniel Macke5779992010-03-04 19:46:13 +0100280/*
Alexander Tsoy1c826792020-04-18 20:58:15 +0300281 * Many Focusrite devices supports a limited set of sampling rates per
282 * altsetting. Maximum rate is exposed in the last 4 bytes of Format Type
283 * descriptor which has a non-standard bLength = 10.
284 */
285static bool focusrite_valid_sample_rate(struct snd_usb_audio *chip,
286 struct audioformat *fp,
287 unsigned int rate)
288{
289 struct usb_interface *iface;
290 struct usb_host_interface *alts;
291 unsigned char *fmt;
292 unsigned int max_rate;
293
294 iface = usb_ifnum_to_if(chip->dev, fp->iface);
295 if (!iface)
296 return true;
297
298 alts = &iface->altsetting[fp->altset_idx];
299 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
300 NULL, UAC_FORMAT_TYPE);
301 if (!fmt)
302 return true;
303
304 if (fmt[0] == 10) { /* bLength */
305 max_rate = combine_quad(&fmt[6]);
306
307 /* Validate max rate */
308 if (max_rate != 48000 &&
309 max_rate != 96000 &&
310 max_rate != 192000 &&
311 max_rate != 384000) {
312
313 usb_audio_info(chip,
314 "%u:%d : unexpected max rate: %u\n",
315 fp->iface, fp->altsetting, max_rate);
316
317 return true;
318 }
319
320 return rate <= max_rate;
321 }
322
323 return true;
324}
325
326/*
Daniel Mack67c10362010-06-11 17:46:33 +0200327 * Helper function to walk the array of sample rate triplets reported by
328 * the device. The problem is that we need to parse whole array first to
329 * get to know how many sample rates we have to expect.
330 * Then fp->rate_table can be allocated and filled.
331 */
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100332static int parse_uac2_sample_rate_range(struct snd_usb_audio *chip,
333 struct audioformat *fp, int nr_triplets,
Daniel Mack67c10362010-06-11 17:46:33 +0200334 const unsigned char *data)
335{
336 int i, nr_rates = 0;
337
338 fp->rates = fp->rate_min = fp->rate_max = 0;
339
340 for (i = 0; i < nr_triplets; i++) {
341 int min = combine_quad(&data[2 + 12 * i]);
342 int max = combine_quad(&data[6 + 12 * i]);
343 int res = combine_quad(&data[10 + 12 * i]);
Xi Wang4fa0e812012-01-08 09:02:52 -0500344 unsigned int rate;
Daniel Mack67c10362010-06-11 17:46:33 +0200345
346 if ((max < 0) || (min < 0) || (res < 0) || (max < min))
347 continue;
348
349 /*
350 * for ranges with res == 1, we announce a continuous sample
351 * rate range, and this function should return 0 for no further
352 * parsing.
353 */
354 if (res == 1) {
355 fp->rate_min = min;
356 fp->rate_max = max;
357 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
358 return 0;
359 }
360
361 for (rate = min; rate <= max; rate += res) {
Nick Kossifidis8dc5efe2020-02-15 03:23:35 +0200362
363 /* Filter out invalid rates on Presonus Studio 1810c */
364 if (chip->usb_id == USB_ID(0x0194f, 0x010c) &&
365 !s1810c_valid_sample_rate(fp, rate))
366 goto skip_rate;
367
Alexander Tsoy1c826792020-04-18 20:58:15 +0300368 /* Filter out invalid rates on Focusrite devices */
369 if (USB_ID_VENDOR(chip->usb_id) == 0x1235 &&
370 !focusrite_valid_sample_rate(chip, fp, rate))
371 goto skip_rate;
372
Daniel Mack67c10362010-06-11 17:46:33 +0200373 if (fp->rate_table)
374 fp->rate_table[nr_rates] = rate;
375 if (!fp->rate_min || rate < fp->rate_min)
376 fp->rate_min = rate;
377 if (!fp->rate_max || rate > fp->rate_max)
378 fp->rate_max = rate;
379 fp->rates |= snd_pcm_rate_to_rate_bit(rate);
380
381 nr_rates++;
Xi Wang8866f402012-02-14 05:18:48 -0500382 if (nr_rates >= MAX_NR_RATES) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100383 usb_audio_err(chip, "invalid uac2 rates\n");
Xi Wang4fa0e812012-01-08 09:02:52 -0500384 break;
385 }
Daniel Mack67c10362010-06-11 17:46:33 +0200386
Nick Kossifidis8dc5efe2020-02-15 03:23:35 +0200387skip_rate:
Daniel Mack67c10362010-06-11 17:46:33 +0200388 /* avoid endless loop */
389 if (res == 0)
390 break;
391 }
392 }
393
394 return nr_rates;
395}
396
Christopher Swenson8abf41d2020-06-14 17:11:47 -0700397/* Line6 Helix series and the Rode Rodecaster Pro don't support the
398 * UAC2_CS_RANGE usb function call. Return a static table of known
399 * clock rates.
Nicola Lunghid4bd3052019-07-07 09:27:34 +0100400 */
401static int line6_parse_audio_format_rates_quirk(struct snd_usb_audio *chip,
402 struct audioformat *fp)
403{
404 switch (chip->usb_id) {
Takashi Iwai8be03a72020-01-05 09:19:00 +0100405 case USB_ID(0x0e41, 0x4241): /* Line6 Helix */
406 case USB_ID(0x0e41, 0x4242): /* Line6 Helix Rack */
407 case USB_ID(0x0e41, 0x4244): /* Line6 Helix LT */
408 case USB_ID(0x0e41, 0x4246): /* Line6 HX-Stomp */
Lukasz Halman7da4c512020-10-20 08:14:09 +0200409 case USB_ID(0x0e41, 0x4247): /* Line6 Pod Go */
Takashi Iwai9b132f22020-01-26 09:31:34 +0100410 case USB_ID(0x0e41, 0x4248): /* Line6 Helix >= fw 2.82 */
411 case USB_ID(0x0e41, 0x4249): /* Line6 Helix Rack >= fw 2.82 */
412 case USB_ID(0x0e41, 0x424a): /* Line6 Helix LT >= fw 2.82 */
Christopher Swenson8abf41d2020-06-14 17:11:47 -0700413 case USB_ID(0x19f7, 0x0011): /* Rode Rodecaster Pro */
Takashi Iwai74f73472020-02-11 12:14:19 +0100414 return set_fixed_rate(fp, 48000, SNDRV_PCM_RATE_48000);
Nicola Lunghid4bd3052019-07-07 09:27:34 +0100415 }
416
417 return -ENODEV;
418}
419
Daniel Mack67c10362010-06-11 17:46:33 +0200420/*
Daniel Macke5779992010-03-04 19:46:13 +0100421 * parse the format descriptor and stores the possible sample rates
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200422 * on the audioformat table (audio class v2 and v3).
Daniel Macke5779992010-03-04 19:46:13 +0100423 */
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200424static int parse_audio_format_rates_v2v3(struct snd_usb_audio *chip,
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200425 struct audioformat *fp)
Daniel Macke5779992010-03-04 19:46:13 +0100426{
427 struct usb_device *dev = chip->dev;
428 unsigned char tmp[2], *data;
Nicola Lunghid4bd3052019-07-07 09:27:34 +0100429 int nr_triplets, data_size, ret = 0, ret_l6;
Alexander Tsoy9f35a312020-02-13 02:54:50 +0300430 int clock = snd_usb_clock_find_source(chip, fp, false);
Daniel Macke5779992010-03-04 19:46:13 +0100431
Daniel Mackd07140b2010-06-11 17:34:19 +0200432 if (clock < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100433 dev_err(&dev->dev,
434 "%s(): unable to find clock source (clock %d)\n",
Daniel Mackd07140b2010-06-11 17:34:19 +0200435 __func__, clock);
436 goto err;
437 }
438
Daniel Macke5779992010-03-04 19:46:13 +0100439 /* get the number of sample rates first by only fetching 2 bytes */
440 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
441 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
Daniel Mack11bcbc42010-06-11 17:34:20 +0200442 UAC2_CS_CONTROL_SAM_FREQ << 8,
443 snd_usb_ctrl_intf(chip) | (clock << 8),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200444 tmp, sizeof(tmp));
Daniel Macke5779992010-03-04 19:46:13 +0100445
446 if (ret < 0) {
Nicola Lunghid4bd3052019-07-07 09:27:34 +0100447 /* line6 helix devices don't support UAC2_CS_CONTROL_SAM_FREQ call */
448 ret_l6 = line6_parse_audio_format_rates_quirk(chip, fp);
449 if (ret_l6 == -ENODEV) {
450 /* no line6 device found continue showing the error */
451 dev_err(&dev->dev,
452 "%s(): unable to retrieve number of sample rates (clock %d)\n",
Daniel Mack79f920f2010-05-31 14:51:31 +0200453 __func__, clock);
Nicola Lunghid4bd3052019-07-07 09:27:34 +0100454 goto err;
455 }
456 if (ret_l6 == 0) {
457 dev_info(&dev->dev,
458 "%s(): unable to retrieve number of sample rates: set it to a predefined value (clock %d).\n",
459 __func__, clock);
460 return 0;
461 }
462 ret = ret_l6;
Daniel Macke5779992010-03-04 19:46:13 +0100463 goto err;
464 }
465
Daniel Mack67c10362010-06-11 17:46:33 +0200466 nr_triplets = (tmp[1] << 8) | tmp[0];
467 data_size = 2 + 12 * nr_triplets;
Daniel Macke5779992010-03-04 19:46:13 +0100468 data = kzalloc(data_size, GFP_KERNEL);
469 if (!data) {
470 ret = -ENOMEM;
471 goto err;
472 }
473
474 /* now get the full information */
475 ret = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_RANGE,
Daniel Mack79f920f2010-05-31 14:51:31 +0200476 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
Daniel Mack11bcbc42010-06-11 17:34:20 +0200477 UAC2_CS_CONTROL_SAM_FREQ << 8,
478 snd_usb_ctrl_intf(chip) | (clock << 8),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200479 data, data_size);
Daniel Macke5779992010-03-04 19:46:13 +0100480
481 if (ret < 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100482 dev_err(&dev->dev,
483 "%s(): unable to retrieve sample rate range (clock %d)\n",
Daniel Mack79f920f2010-05-31 14:51:31 +0200484 __func__, clock);
Daniel Macke5779992010-03-04 19:46:13 +0100485 ret = -EINVAL;
486 goto err_free;
487 }
488
Daniel Mack67c10362010-06-11 17:46:33 +0200489 /* Call the triplet parser, and make sure fp->rate_table is NULL.
490 * We just use the return value to know how many sample rates we
491 * will have to deal with. */
492 kfree(fp->rate_table);
493 fp->rate_table = NULL;
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100494 fp->nr_rates = parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
Daniel Mack67c10362010-06-11 17:46:33 +0200495
496 if (fp->nr_rates == 0) {
497 /* SNDRV_PCM_RATE_CONTINUOUS */
498 ret = 0;
499 goto err_free;
500 }
501
Kees Cook6da2ec52018-06-12 13:55:00 -0700502 fp->rate_table = kmalloc_array(fp->nr_rates, sizeof(int), GFP_KERNEL);
Daniel Macke5779992010-03-04 19:46:13 +0100503 if (!fp->rate_table) {
504 ret = -ENOMEM;
505 goto err_free;
506 }
507
Daniel Mack67c10362010-06-11 17:46:33 +0200508 /* Call the triplet parser again, but this time, fp->rate_table is
509 * allocated, so the rates will be stored */
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100510 parse_uac2_sample_rate_range(chip, fp, nr_triplets, data);
Daniel Macke5779992010-03-04 19:46:13 +0100511
512err_free:
513 kfree(data);
514err:
515 return ret;
516}
517
518/*
519 * parse the format type I and III descriptors
520 */
521static int parse_audio_format_i(struct snd_usb_audio *chip,
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200522 struct audioformat *fp, u64 format,
523 void *_fmt)
Daniel Macke5779992010-03-04 19:46:13 +0100524{
Eldad Zack74c34ca2013-04-23 01:00:41 +0200525 snd_pcm_format_t pcm_format;
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200526 unsigned int fmt_type;
Eldad Zack74c34ca2013-04-23 01:00:41 +0200527 int ret;
Daniel Macke5779992010-03-04 19:46:13 +0100528
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200529 switch (fp->protocol) {
530 default:
531 case UAC_VERSION_1:
532 case UAC_VERSION_2: {
533 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
534
535 fmt_type = fmt->bFormatType;
536 break;
537 }
538 case UAC_VERSION_3: {
539 /* fp->fmt_type is already set in this case */
540 fmt_type = fp->fmt_type;
541 break;
542 }
543 }
544
545 if (fmt_type == UAC_FORMAT_TYPE_III) {
Daniel Macke5779992010-03-04 19:46:13 +0100546 /* FIXME: the format type is really IECxxx
547 * but we give normal PCM format to get the existing
548 * apps working...
549 */
550 switch (chip->usb_id) {
551
552 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
553 if (chip->setup == 0x00 &&
554 fp->altsetting == 6)
555 pcm_format = SNDRV_PCM_FORMAT_S16_BE;
556 else
557 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
558 break;
559 default:
560 pcm_format = SNDRV_PCM_FORMAT_S16_LE;
561 }
Eldad Zack74c34ca2013-04-23 01:00:41 +0200562 fp->formats = pcm_format_to_bits(pcm_format);
Daniel Macke5779992010-03-04 19:46:13 +0100563 } else {
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200564 fp->formats = parse_audio_format_i_type(chip, fp, format, _fmt);
Clemens Ladisch29088fe2010-03-04 19:46:16 +0100565 if (!fp->formats)
Sachin Kamat8ad10dc2012-11-21 15:25:56 +0530566 return -EINVAL;
Daniel Macke5779992010-03-04 19:46:13 +0100567 }
568
Daniel Macke5779992010-03-04 19:46:13 +0100569 /* gather possible sample rates */
570 /* audio class v1 reports possible sample rates as part of the
571 * proprietary class specific descriptor.
572 * audio class v2 uses class specific EP0 range requests for that.
573 */
Clemens Ladisch8f898e92013-01-31 21:39:17 +0100574 switch (fp->protocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +0200575 default:
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200576 case UAC_VERSION_1: {
577 struct uac_format_type_i_continuous_descriptor *fmt = _fmt;
578
Daniel Macke5779992010-03-04 19:46:13 +0100579 fp->channels = fmt->bNrChannels;
Daniel Mack74754f92010-05-26 18:11:36 +0200580 ret = parse_audio_format_rates_v1(chip, fp, (unsigned char *) fmt, 7);
Daniel Macke5779992010-03-04 19:46:13 +0100581 break;
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200582 }
Daniel Macke5779992010-03-04 19:46:13 +0100583 case UAC_VERSION_2:
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200584 case UAC_VERSION_3: {
Daniel Macke5779992010-03-04 19:46:13 +0100585 /* fp->channels is already set in this case */
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200586 ret = parse_audio_format_rates_v2v3(chip, fp);
Daniel Macke5779992010-03-04 19:46:13 +0100587 break;
588 }
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200589 }
Daniel Macke5779992010-03-04 19:46:13 +0100590
591 if (fp->channels < 1) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100592 usb_audio_err(chip,
593 "%u:%d : invalid channels %d\n",
594 fp->iface, fp->altsetting, fp->channels);
Sachin Kamat8ad10dc2012-11-21 15:25:56 +0530595 return -EINVAL;
Daniel Macke5779992010-03-04 19:46:13 +0100596 }
597
598 return ret;
599}
600
601/*
602 * parse the format type II descriptor
603 */
604static int parse_audio_format_ii(struct snd_usb_audio *chip,
605 struct audioformat *fp,
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200606 u64 format, void *_fmt)
Daniel Macke5779992010-03-04 19:46:13 +0100607{
608 int brate, framesize, ret;
Daniel Macke5779992010-03-04 19:46:13 +0100609
610 switch (format) {
611 case UAC_FORMAT_TYPE_II_AC3:
612 /* FIXME: there is no AC3 format defined yet */
Clemens Ladisch015eb0b2010-03-04 19:46:15 +0100613 // fp->formats = SNDRV_PCM_FMTBIT_AC3;
614 fp->formats = SNDRV_PCM_FMTBIT_U8; /* temporary hack to receive byte streams */
Daniel Macke5779992010-03-04 19:46:13 +0100615 break;
616 case UAC_FORMAT_TYPE_II_MPEG:
Clemens Ladisch015eb0b2010-03-04 19:46:15 +0100617 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
Daniel Macke5779992010-03-04 19:46:13 +0100618 break;
619 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100620 usb_audio_info(chip,
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200621 "%u:%d : unknown format tag %#llx is detected. processed as MPEG.\n",
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100622 fp->iface, fp->altsetting, format);
Clemens Ladisch015eb0b2010-03-04 19:46:15 +0100623 fp->formats = SNDRV_PCM_FMTBIT_MPEG;
Daniel Macke5779992010-03-04 19:46:13 +0100624 break;
625 }
626
627 fp->channels = 1;
628
Clemens Ladisch8f898e92013-01-31 21:39:17 +0100629 switch (fp->protocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +0200630 default:
Daniel Macke5779992010-03-04 19:46:13 +0100631 case UAC_VERSION_1: {
632 struct uac_format_type_ii_discrete_descriptor *fmt = _fmt;
633 brate = le16_to_cpu(fmt->wMaxBitRate);
634 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100635 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
Daniel Macke5779992010-03-04 19:46:13 +0100636 fp->frame_size = framesize;
637 ret = parse_audio_format_rates_v1(chip, fp, _fmt, 8); /* fmt[8..] sample rates */
638 break;
639 }
640 case UAC_VERSION_2: {
641 struct uac_format_type_ii_ext_descriptor *fmt = _fmt;
642 brate = le16_to_cpu(fmt->wMaxBitRate);
643 framesize = le16_to_cpu(fmt->wSamplesPerFrame);
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100644 usb_audio_info(chip, "found format II with max.bitrate = %d, frame size=%d\n", brate, framesize);
Daniel Macke5779992010-03-04 19:46:13 +0100645 fp->frame_size = framesize;
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200646 ret = parse_audio_format_rates_v2v3(chip, fp);
Daniel Macke5779992010-03-04 19:46:13 +0100647 break;
648 }
649 }
650
651 return ret;
652}
653
Daniel Mack2fcdb062013-03-17 20:07:24 +0800654int snd_usb_parse_audio_format(struct snd_usb_audio *chip,
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200655 struct audioformat *fp, u64 format,
Daniel Mack2fcdb062013-03-17 20:07:24 +0800656 struct uac_format_type_i_continuous_descriptor *fmt,
Clemens Ladisch8f898e92013-01-31 21:39:17 +0100657 int stream)
Daniel Macke5779992010-03-04 19:46:13 +0100658{
659 int err;
660
Daniel Mack74754f92010-05-26 18:11:36 +0200661 switch (fmt->bFormatType) {
Daniel Macke5779992010-03-04 19:46:13 +0100662 case UAC_FORMAT_TYPE_I:
663 case UAC_FORMAT_TYPE_III:
Clemens Ladisch8f898e92013-01-31 21:39:17 +0100664 err = parse_audio_format_i(chip, fp, format, fmt);
Daniel Macke5779992010-03-04 19:46:13 +0100665 break;
666 case UAC_FORMAT_TYPE_II:
Clemens Ladisch8f898e92013-01-31 21:39:17 +0100667 err = parse_audio_format_ii(chip, fp, format, fmt);
Daniel Macke5779992010-03-04 19:46:13 +0100668 break;
669 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100670 usb_audio_info(chip,
671 "%u:%d : format type %d is not supported yet\n",
672 fp->iface, fp->altsetting,
673 fmt->bFormatType);
Daniel Mack8d091242010-05-26 18:11:37 +0200674 return -ENOTSUPP;
Daniel Macke5779992010-03-04 19:46:13 +0100675 }
Daniel Mack74754f92010-05-26 18:11:36 +0200676 fp->fmt_type = fmt->bFormatType;
Daniel Macke5779992010-03-04 19:46:13 +0100677 if (err < 0)
678 return err;
679#if 1
680 /* FIXME: temporary hack for extigy/audigy 2 nx/zs */
681 /* extigy apparently supports sample rates other than 48k
682 * but not in ordinary way. so we enable only 48k atm.
683 */
684 if (chip->usb_id == USB_ID(0x041e, 0x3000) ||
685 chip->usb_id == USB_ID(0x041e, 0x3020) ||
686 chip->usb_id == USB_ID(0x041e, 0x3061)) {
Daniel Mack74754f92010-05-26 18:11:36 +0200687 if (fmt->bFormatType == UAC_FORMAT_TYPE_I &&
Daniel Macke5779992010-03-04 19:46:13 +0100688 fp->rates != SNDRV_PCM_RATE_48000 &&
689 fp->rates != SNDRV_PCM_RATE_96000)
Daniel Mack8d091242010-05-26 18:11:37 +0200690 return -ENOTSUPP;
Daniel Macke5779992010-03-04 19:46:13 +0100691 }
692#endif
693 return 0;
694}
695
Ruslan Bilovol9a2fe9b2018-03-21 02:03:59 +0200696int snd_usb_parse_audio_format_v3(struct snd_usb_audio *chip,
697 struct audioformat *fp,
698 struct uac3_as_header_descriptor *as,
699 int stream)
700{
701 u64 format = le64_to_cpu(as->bmFormats);
702 int err;
703
704 /*
705 * Type I format bits are D0..D6
706 * This test works because type IV is not supported
707 */
708 if (format & 0x7f)
709 fp->fmt_type = UAC_FORMAT_TYPE_I;
710 else
711 fp->fmt_type = UAC_FORMAT_TYPE_III;
712
713 err = parse_audio_format_i(chip, fp, format, as);
714 if (err < 0)
715 return err;
716
717 return 0;
718}