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