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.
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.
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
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>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
42 static void free_substream(struct snd_usb_substream *subs)
44 struct list_head *p, *n;
46 if (!subs->num_formats)
47 return; /* not initialized */
48 list_for_each_safe(p, n, &subs->fmt_list) {
49 struct audioformat *fp = list_entry(p, struct audioformat, list);
50 kfree(fp->rate_table);
53 kfree(subs->rate_list.list);
58 * free a usb stream instance
60 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
62 free_substream(&stream->substream[0]);
63 free_substream(&stream->substream[1]);
64 list_del(&stream->list);
68 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
70 struct snd_usb_stream *stream = pcm->private_data;
73 snd_usb_audio_stream_free(stream);
79 * add this endpoint to the chip instance.
80 * if a stream with the same endpoint already exists, append to it.
81 * if not, create a new pcm stream.
83 int snd_usb_add_audio_stream(struct snd_usb_audio *chip,
85 struct audioformat *fp)
88 struct snd_usb_stream *as;
89 struct snd_usb_substream *subs;
93 list_for_each(p, &chip->pcm_list) {
94 as = list_entry(p, struct snd_usb_stream, list);
95 if (as->fmt_type != fp->fmt_type)
97 subs = &as->substream[stream];
100 if (subs->endpoint == fp->endpoint) {
101 list_add_tail(&fp->list, &subs->fmt_list);
103 subs->formats |= fp->formats;
107 /* look for an empty stream */
108 list_for_each(p, &chip->pcm_list) {
109 as = list_entry(p, struct snd_usb_stream, list);
110 if (as->fmt_type != fp->fmt_type)
112 subs = &as->substream[stream];
115 err = snd_pcm_new_stream(as->pcm, stream, 1);
118 snd_usb_init_substream(as, stream, fp);
122 /* create a new pcm */
123 as = kzalloc(sizeof(*as), GFP_KERNEL);
126 as->pcm_index = chip->pcm_devs;
128 as->fmt_type = fp->fmt_type;
129 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
130 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
131 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
138 pcm->private_data = as;
139 pcm->private_free = snd_usb_audio_pcm_free;
141 if (chip->pcm_devs > 0)
142 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
144 strcpy(pcm->name, "USB Audio");
146 snd_usb_init_substream(as, stream, fp);
148 list_add(&as->list, &chip->pcm_list);
151 snd_usb_proc_pcm_format_add(as);
156 static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip,
157 struct usb_host_interface *alts,
158 int protocol, int iface_no)
160 /* parsed with a v1 header here. that's ok as we only look at the
161 * header first which is the same for both versions */
162 struct uac_iso_endpoint_descriptor *csep;
163 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
166 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
168 /* Creamware Noah has this descriptor after the 2nd endpoint */
169 if (!csep && altsd->bNumEndpoints >= 2)
170 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
172 if (!csep || csep->bLength < 7 ||
173 csep->bDescriptorSubtype != UAC_EP_GENERAL) {
174 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
175 " class specific endpoint descriptor\n",
176 chip->dev->devnum, iface_no,
177 altsd->bAlternateSetting);
181 if (protocol == UAC_VERSION_1) {
182 attributes = csep->bmAttributes;
184 struct uac2_iso_endpoint_descriptor *csep2 =
185 (struct uac2_iso_endpoint_descriptor *) csep;
187 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX;
189 /* emulate the endpoint attributes of a v1 device */
190 if (csep2->bmControls & UAC2_CONTROL_PITCH)
191 attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
197 static struct uac2_input_terminal_descriptor *
198 snd_usb_find_input_terminal_descriptor(struct usb_host_interface *ctrl_iface,
201 struct uac2_input_terminal_descriptor *term = NULL;
203 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
204 ctrl_iface->extralen,
205 term, UAC_INPUT_TERMINAL))) {
206 if (term->bTerminalID == terminal_id)
213 static struct uac2_output_terminal_descriptor *
214 snd_usb_find_output_terminal_descriptor(struct usb_host_interface *ctrl_iface,
217 struct uac2_output_terminal_descriptor *term = NULL;
219 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
220 ctrl_iface->extralen,
221 term, UAC_OUTPUT_TERMINAL))) {
222 if (term->bTerminalID == terminal_id)
229 int snd_usb_parse_audio_interface(struct snd_usb_audio *chip, int iface_no)
231 struct usb_device *dev;
232 struct usb_interface *iface;
233 struct usb_host_interface *alts;
234 struct usb_interface_descriptor *altsd;
235 int i, altno, err, stream;
236 int format = 0, num_channels = 0;
237 struct audioformat *fp = NULL;
238 int num, protocol, clock = 0;
239 struct uac_format_type_i_continuous_descriptor *fmt;
243 /* parse the interface's altsettings */
244 iface = usb_ifnum_to_if(dev, iface_no);
246 num = iface->num_altsetting;
249 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
250 * one misses syncpipe, and does not produce any sound.
252 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
255 for (i = 0; i < num; i++) {
256 alts = &iface->altsetting[i];
257 altsd = get_iface_desc(alts);
258 protocol = altsd->bInterfaceProtocol;
259 /* skip invalid one */
260 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
261 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
262 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
263 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
264 altsd->bNumEndpoints < 1 ||
265 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
267 /* must be isochronous */
268 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
269 USB_ENDPOINT_XFER_ISOC)
271 /* check direction */
272 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
273 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
274 altno = altsd->bAlternateSetting;
276 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
279 /* get audio formats */
282 snd_printdd(KERN_WARNING "%d:%u:%d: unknown interface protocol %#02x, assuming v1\n",
283 dev->devnum, iface_no, altno, protocol);
284 protocol = UAC_VERSION_1;
287 case UAC_VERSION_1: {
288 struct uac1_as_header_descriptor *as =
289 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
292 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
293 dev->devnum, iface_no, altno);
297 if (as->bLength < sizeof(*as)) {
298 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
299 dev->devnum, iface_no, altno);
303 format = le16_to_cpu(as->wFormatTag); /* remember the format value */
307 case UAC_VERSION_2: {
308 struct uac2_input_terminal_descriptor *input_term;
309 struct uac2_output_terminal_descriptor *output_term;
310 struct uac2_as_header_descriptor *as =
311 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
314 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
315 dev->devnum, iface_no, altno);
319 if (as->bLength < sizeof(*as)) {
320 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
321 dev->devnum, iface_no, altno);
325 num_channels = as->bNrChannels;
326 format = le32_to_cpu(as->bmFormats);
328 /* lookup the terminal associated to this interface
329 * to extract the clock */
330 input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
333 clock = input_term->bCSourceID;
337 output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
340 clock = output_term->bCSourceID;
344 snd_printk(KERN_ERR "%d:%u:%d : bogus bTerminalLink %d\n",
345 dev->devnum, iface_no, altno, as->bTerminalLink);
350 /* get format type */
351 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_FORMAT_TYPE);
353 snd_printk(KERN_ERR "%d:%u:%d : no UAC_FORMAT_TYPE desc\n",
354 dev->devnum, iface_no, altno);
357 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8)) ||
358 ((protocol == UAC_VERSION_2) && (fmt->bLength < 6))) {
359 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
360 dev->devnum, iface_no, altno);
365 * Blue Microphones workaround: The last altsetting is identical
366 * with the previous one, except for a larger packet size, but
367 * is actually a mislabeled two-channel setting; ignore it.
369 if (fmt->bNrChannels == 1 &&
370 fmt->bSubframeSize == 2 &&
371 altno == 2 && num == 3 &&
372 fp && fp->altsetting == 1 && fp->channels == 1 &&
373 fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
374 protocol == UAC_VERSION_1 &&
375 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
379 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
381 snd_printk(KERN_ERR "cannot malloc\n");
385 fp->iface = iface_no;
386 fp->altsetting = altno;
388 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
389 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
390 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
391 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
392 /* num_channels is only set for v2 interfaces */
393 fp->channels = num_channels;
394 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
395 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
396 * (fp->maxpacksize & 0x7ff);
397 fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol, iface_no);
400 /* some quirks for attributes here */
402 switch (chip->usb_id) {
403 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
404 /* Optoplay sets the sample rate attribute although
405 * it seems not supporting it in fact.
407 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
409 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
410 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
411 /* doesn't set the sample rate attribute, but supports it */
412 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
414 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
415 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
416 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
417 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
418 an older model 77d:223) */
420 * plantronics headset and Griffin iMic have set adaptive-in
421 * although it's really not...
423 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
424 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
425 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
427 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
431 /* ok, let's parse further... */
432 if (snd_usb_parse_audio_format(chip, fp, format, fmt, stream, alts) < 0) {
433 kfree(fp->rate_table);
439 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint);
440 err = snd_usb_add_audio_stream(chip, stream, fp);
442 kfree(fp->rate_table);
446 /* try to set the interface... */
447 usb_set_interface(chip->dev, iface_no, altno);
448 snd_usb_init_pitch(chip, iface_no, alts, fp);
449 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);