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 "proc.h" 30 #include "quirks.h" 31 #include "endpoint.h" 32 #include "urb.h" 33 #include "pcm.h" 34 #include "helper.h" 35 #include "format.h" 36 #include "clock.h" 37 38 /* 39 * free a substream 40 */ 41 static void free_substream(struct snd_usb_substream *subs) 42 { 43 struct list_head *p, *n; 44 45 if (!subs->num_formats) 46 return; /* not initialized */ 47 list_for_each_safe(p, n, &subs->fmt_list) { 48 struct audioformat *fp = list_entry(p, struct audioformat, list); 49 kfree(fp->rate_table); 50 kfree(fp); 51 } 52 kfree(subs->rate_list.list); 53 } 54 55 56 /* 57 * free a usb stream instance 58 */ 59 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream) 60 { 61 free_substream(&stream->substream[0]); 62 free_substream(&stream->substream[1]); 63 list_del(&stream->list); 64 kfree(stream); 65 } 66 67 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm) 68 { 69 struct snd_usb_stream *stream = pcm->private_data; 70 if (stream) { 71 stream->pcm = NULL; 72 snd_usb_audio_stream_free(stream); 73 } 74 } 75 76 77 /* 78 * add this endpoint to the chip instance. 79 * if a stream with the same endpoint already exists, append to it. 80 * if not, create a new pcm stream. 81 */ 82 int snd_usb_add_audio_endpoint(struct snd_usb_audio *chip, int stream, struct audioformat *fp) 83 { 84 struct list_head *p; 85 struct snd_usb_stream *as; 86 struct snd_usb_substream *subs; 87 struct snd_pcm *pcm; 88 int err; 89 90 list_for_each(p, &chip->pcm_list) { 91 as = list_entry(p, struct snd_usb_stream, list); 92 if (as->fmt_type != fp->fmt_type) 93 continue; 94 subs = &as->substream[stream]; 95 if (!subs->endpoint) 96 continue; 97 if (subs->endpoint == fp->endpoint) { 98 list_add_tail(&fp->list, &subs->fmt_list); 99 subs->num_formats++; 100 subs->formats |= fp->formats; 101 return 0; 102 } 103 } 104 /* look for an empty stream */ 105 list_for_each(p, &chip->pcm_list) { 106 as = list_entry(p, struct snd_usb_stream, list); 107 if (as->fmt_type != fp->fmt_type) 108 continue; 109 subs = &as->substream[stream]; 110 if (subs->endpoint) 111 continue; 112 err = snd_pcm_new_stream(as->pcm, stream, 1); 113 if (err < 0) 114 return err; 115 snd_usb_init_substream(as, stream, fp); 116 return 0; 117 } 118 119 /* create a new pcm */ 120 as = kzalloc(sizeof(*as), GFP_KERNEL); 121 if (!as) 122 return -ENOMEM; 123 as->pcm_index = chip->pcm_devs; 124 as->chip = chip; 125 as->fmt_type = fp->fmt_type; 126 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs, 127 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0, 128 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1, 129 &pcm); 130 if (err < 0) { 131 kfree(as); 132 return err; 133 } 134 as->pcm = pcm; 135 pcm->private_data = as; 136 pcm->private_free = snd_usb_audio_pcm_free; 137 pcm->info_flags = 0; 138 if (chip->pcm_devs > 0) 139 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs); 140 else 141 strcpy(pcm->name, "USB Audio"); 142 143 snd_usb_init_substream(as, stream, fp); 144 145 list_add(&as->list, &chip->pcm_list); 146 chip->pcm_devs++; 147 148 snd_usb_proc_pcm_format_add(as); 149 150 return 0; 151 } 152 153 static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip, 154 struct usb_host_interface *alts, 155 int protocol, int iface_no) 156 { 157 /* parsed with a v1 header here. that's ok as we only look at the 158 * header first which is the same for both versions */ 159 struct uac_iso_endpoint_descriptor *csep; 160 struct usb_interface_descriptor *altsd = get_iface_desc(alts); 161 int attributes = 0; 162 163 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT); 164 165 /* Creamware Noah has this descriptor after the 2nd endpoint */ 166 if (!csep && altsd->bNumEndpoints >= 2) 167 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT); 168 169 if (!csep || csep->bLength < 7 || 170 csep->bDescriptorSubtype != UAC_EP_GENERAL) { 171 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid" 172 " class specific endpoint descriptor\n", 173 chip->dev->devnum, iface_no, 174 altsd->bAlternateSetting); 175 return 0; 176 } 177 178 if (protocol == UAC_VERSION_1) { 179 attributes = csep->bmAttributes; 180 } else { 181 struct uac2_iso_endpoint_descriptor *csep2 = 182 (struct uac2_iso_endpoint_descriptor *) csep; 183 184 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX; 185 186 /* emulate the endpoint attributes of a v1 device */ 187 if (csep2->bmControls & UAC2_CONTROL_PITCH) 188 attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL; 189 } 190 191 return attributes; 192 } 193 194 static struct uac2_input_terminal_descriptor * 195 snd_usb_find_input_terminal_descriptor(struct usb_host_interface *ctrl_iface, 196 int terminal_id) 197 { 198 struct uac2_input_terminal_descriptor *term = NULL; 199 200 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra, 201 ctrl_iface->extralen, 202 term, UAC_INPUT_TERMINAL))) { 203 if (term->bTerminalID == terminal_id) 204 return term; 205 } 206 207 return NULL; 208 } 209 210 static struct uac2_output_terminal_descriptor * 211 snd_usb_find_output_terminal_descriptor(struct usb_host_interface *ctrl_iface, 212 int terminal_id) 213 { 214 struct uac2_output_terminal_descriptor *term = NULL; 215 216 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra, 217 ctrl_iface->extralen, 218 term, UAC_OUTPUT_TERMINAL))) { 219 if (term->bTerminalID == terminal_id) 220 return term; 221 } 222 223 return NULL; 224 } 225 226 int snd_usb_parse_audio_endpoints(struct snd_usb_audio *chip, int iface_no) 227 { 228 struct usb_device *dev; 229 struct usb_interface *iface; 230 struct usb_host_interface *alts; 231 struct usb_interface_descriptor *altsd; 232 int i, altno, err, stream; 233 int format = 0, num_channels = 0; 234 struct audioformat *fp = NULL; 235 int num, protocol, clock = 0; 236 struct uac_format_type_i_continuous_descriptor *fmt; 237 238 dev = chip->dev; 239 240 /* parse the interface's altsettings */ 241 iface = usb_ifnum_to_if(dev, iface_no); 242 243 num = iface->num_altsetting; 244 245 /* 246 * Dallas DS4201 workaround: It presents 5 altsettings, but the last 247 * one misses syncpipe, and does not produce any sound. 248 */ 249 if (chip->usb_id == USB_ID(0x04fa, 0x4201)) 250 num = 4; 251 252 for (i = 0; i < num; i++) { 253 alts = &iface->altsetting[i]; 254 altsd = get_iface_desc(alts); 255 protocol = altsd->bInterfaceProtocol; 256 /* skip invalid one */ 257 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO && 258 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) || 259 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING && 260 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) || 261 altsd->bNumEndpoints < 1 || 262 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0) 263 continue; 264 /* must be isochronous */ 265 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != 266 USB_ENDPOINT_XFER_ISOC) 267 continue; 268 /* check direction */ 269 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ? 270 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK; 271 altno = altsd->bAlternateSetting; 272 273 if (snd_usb_apply_interface_quirk(chip, iface_no, altno)) 274 continue; 275 276 /* get audio formats */ 277 switch (protocol) { 278 case UAC_VERSION_1: { 279 struct uac1_as_header_descriptor *as = 280 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL); 281 282 if (!as) { 283 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n", 284 dev->devnum, iface_no, altno); 285 continue; 286 } 287 288 if (as->bLength < sizeof(*as)) { 289 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n", 290 dev->devnum, iface_no, altno); 291 continue; 292 } 293 294 format = le16_to_cpu(as->wFormatTag); /* remember the format value */ 295 break; 296 } 297 298 case UAC_VERSION_2: { 299 struct uac2_input_terminal_descriptor *input_term; 300 struct uac2_output_terminal_descriptor *output_term; 301 struct uac2_as_header_descriptor *as = 302 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL); 303 304 if (!as) { 305 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n", 306 dev->devnum, iface_no, altno); 307 continue; 308 } 309 310 if (as->bLength < sizeof(*as)) { 311 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n", 312 dev->devnum, iface_no, altno); 313 continue; 314 } 315 316 num_channels = as->bNrChannels; 317 format = le32_to_cpu(as->bmFormats); 318 319 /* lookup the terminal associated to this interface 320 * to extract the clock */ 321 input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf, 322 as->bTerminalLink); 323 if (input_term) { 324 clock = input_term->bCSourceID; 325 break; 326 } 327 328 output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf, 329 as->bTerminalLink); 330 if (output_term) { 331 clock = output_term->bCSourceID; 332 break; 333 } 334 335 snd_printk(KERN_ERR "%d:%u:%d : bogus bTerminalLink %d\n", 336 dev->devnum, iface_no, altno, as->bTerminalLink); 337 continue; 338 } 339 340 default: 341 snd_printk(KERN_ERR "%d:%u:%d : unknown interface protocol %04x\n", 342 dev->devnum, iface_no, altno, protocol); 343 continue; 344 } 345 346 /* get format type */ 347 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_FORMAT_TYPE); 348 if (!fmt) { 349 snd_printk(KERN_ERR "%d:%u:%d : no UAC_FORMAT_TYPE desc\n", 350 dev->devnum, iface_no, altno); 351 continue; 352 } 353 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8)) || 354 ((protocol == UAC_VERSION_2) && (fmt->bLength != 6))) { 355 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n", 356 dev->devnum, iface_no, altno); 357 continue; 358 } 359 360 /* 361 * Blue Microphones workaround: The last altsetting is identical 362 * with the previous one, except for a larger packet size, but 363 * is actually a mislabeled two-channel setting; ignore it. 364 */ 365 if (fmt->bNrChannels == 1 && 366 fmt->bSubframeSize == 2 && 367 altno == 2 && num == 3 && 368 fp && fp->altsetting == 1 && fp->channels == 1 && 369 fp->formats == SNDRV_PCM_FMTBIT_S16_LE && 370 protocol == UAC_VERSION_1 && 371 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 372 fp->maxpacksize * 2) 373 continue; 374 375 fp = kzalloc(sizeof(*fp), GFP_KERNEL); 376 if (! fp) { 377 snd_printk(KERN_ERR "cannot malloc\n"); 378 return -ENOMEM; 379 } 380 381 fp->iface = iface_no; 382 fp->altsetting = altno; 383 fp->altset_idx = i; 384 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress; 385 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes; 386 fp->datainterval = snd_usb_parse_datainterval(chip, alts); 387 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize); 388 /* num_channels is only set for v2 interfaces */ 389 fp->channels = num_channels; 390 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH) 391 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1) 392 * (fp->maxpacksize & 0x7ff); 393 fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol, iface_no); 394 fp->clock = clock; 395 396 /* some quirks for attributes here */ 397 398 switch (chip->usb_id) { 399 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */ 400 /* Optoplay sets the sample rate attribute although 401 * it seems not supporting it in fact. 402 */ 403 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE; 404 break; 405 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */ 406 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */ 407 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra 8 */ 408 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */ 409 /* doesn't set the sample rate attribute, but supports it */ 410 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE; 411 break; 412 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */ 413 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is 414 an older model 77d:223) */ 415 /* 416 * plantronics headset and Griffin iMic have set adaptive-in 417 * although it's really not... 418 */ 419 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE; 420 if (stream == SNDRV_PCM_STREAM_PLAYBACK) 421 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE; 422 else 423 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC; 424 break; 425 } 426 427 /* ok, let's parse further... */ 428 if (snd_usb_parse_audio_format(chip, fp, format, fmt, stream, alts) < 0) { 429 kfree(fp->rate_table); 430 kfree(fp); 431 fp = NULL; 432 continue; 433 } 434 435 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint); 436 err = snd_usb_add_audio_endpoint(chip, stream, fp); 437 if (err < 0) { 438 kfree(fp->rate_table); 439 kfree(fp); 440 return err; 441 } 442 /* try to set the interface... */ 443 usb_set_interface(chip->dev, iface_no, altno); 444 snd_usb_init_pitch(chip, iface_no, alts, fp); 445 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max); 446 } 447 return 0; 448 } 449 450