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