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>
26 #include <sound/control.h>
27 #include <sound/tlv.h>
43 static void free_substream(struct snd_usb_substream *subs)
45 struct audioformat *fp, *n;
47 if (!subs->num_formats)
48 return; /* not initialized */
49 list_for_each_entry_safe(fp, n, &subs->fmt_list, list) {
50 kfree(fp->rate_table);
54 kfree(subs->rate_list.list);
59 * free a usb stream instance
61 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
63 free_substream(&stream->substream[0]);
64 free_substream(&stream->substream[1]);
65 list_del(&stream->list);
69 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
71 struct snd_usb_stream *stream = pcm->private_data;
74 snd_usb_audio_stream_free(stream);
79 * initialize the substream instance.
82 static void snd_usb_init_substream(struct snd_usb_stream *as,
84 struct audioformat *fp)
86 struct snd_usb_substream *subs = &as->substream[stream];
88 INIT_LIST_HEAD(&subs->fmt_list);
89 spin_lock_init(&subs->lock);
92 subs->direction = stream;
93 subs->dev = as->chip->dev;
94 subs->txfr_quirk = as->chip->txfr_quirk;
95 subs->speed = snd_usb_get_speed(subs->dev);
97 snd_usb_set_pcm_ops(as->pcm, stream);
99 list_add_tail(&fp->list, &subs->fmt_list);
100 subs->formats |= fp->formats;
102 subs->fmt_type = fp->fmt_type;
103 subs->ep_num = fp->endpoint;
104 if (fp->channels > subs->channels_max)
105 subs->channels_max = fp->channels;
108 /* kctl callbacks for usb-audio channel maps */
109 static int usb_chmap_ctl_info(struct snd_kcontrol *kcontrol,
110 struct snd_ctl_elem_info *uinfo)
112 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
113 struct snd_usb_substream *subs = info->private_data;
115 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
116 uinfo->count = subs->channels_max;
117 uinfo->value.integer.min = 0;
118 uinfo->value.integer.max = SNDRV_CHMAP_LAST;
122 /* check whether a duplicated entry exists in the audiofmt list */
123 static bool have_dup_chmap(struct snd_usb_substream *subs,
124 struct audioformat *fp)
128 for (p = fp->list.prev; p != &subs->fmt_list; p = p->prev) {
129 struct audioformat *prev;
130 prev = list_entry(p, struct audioformat, list);
132 !memcmp(prev->chmap, fp->chmap, sizeof(*fp->chmap)))
138 static int usb_chmap_ctl_tlv(struct snd_kcontrol *kcontrol, int op_flag,
139 unsigned int size, unsigned int __user *tlv)
141 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
142 struct snd_usb_substream *subs = info->private_data;
143 struct audioformat *fp;
144 unsigned int __user *dst;
149 if (put_user(SNDRV_CTL_TLVT_CONTAINER, tlv))
153 list_for_each_entry(fp, &subs->fmt_list, list) {
158 if (have_dup_chmap(subs, fp))
161 ch_bytes = fp->chmap->channels * 4;
162 if (size < 8 + ch_bytes)
164 if (put_user(SNDRV_CTL_TLVT_CHMAP_FIXED, dst) ||
165 put_user(ch_bytes, dst + 1))
168 for (i = 0; i < fp->chmap->channels; i++, dst++) {
169 if (put_user(fp->chmap->map[i], dst))
173 count += 8 + ch_bytes;
174 size -= 8 + ch_bytes;
176 if (put_user(count, tlv + 1))
181 static int usb_chmap_ctl_get(struct snd_kcontrol *kcontrol,
182 struct snd_ctl_elem_value *ucontrol)
184 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
185 struct snd_usb_substream *subs = info->private_data;
186 struct snd_pcm_chmap_elem *chmap = NULL;
189 memset(ucontrol->value.integer.value, 0,
190 sizeof(ucontrol->value.integer.value));
191 if (subs->cur_audiofmt)
192 chmap = subs->cur_audiofmt->chmap;
194 for (i = 0; i < chmap->channels; i++)
195 ucontrol->value.integer.value[i] = chmap->map[i];
200 /* create a chmap kctl assigned to the given USB substream */
201 static int add_chmap(struct snd_pcm *pcm, int stream,
202 struct snd_usb_substream *subs)
204 struct audioformat *fp;
205 struct snd_pcm_chmap *chmap;
206 struct snd_kcontrol *kctl;
209 list_for_each_entry(fp, &subs->fmt_list, list)
212 /* no chmap is found */
216 err = snd_pcm_add_chmap_ctls(pcm, stream, NULL, 0, 0, &chmap);
220 /* override handlers */
221 chmap->private_data = subs;
223 kctl->info = usb_chmap_ctl_info;
224 kctl->get = usb_chmap_ctl_get;
225 kctl->tlv.c = usb_chmap_ctl_tlv;
230 /* convert from USB ChannelConfig bits to ALSA chmap element */
231 static struct snd_pcm_chmap_elem *convert_chmap(int channels, unsigned int bits,
234 static unsigned int uac1_maps[] = {
235 SNDRV_CHMAP_FL, /* left front */
236 SNDRV_CHMAP_FR, /* right front */
237 SNDRV_CHMAP_FC, /* center front */
238 SNDRV_CHMAP_LFE, /* LFE */
239 SNDRV_CHMAP_SL, /* left surround */
240 SNDRV_CHMAP_SR, /* right surround */
241 SNDRV_CHMAP_FLC, /* left of center */
242 SNDRV_CHMAP_FRC, /* right of center */
243 SNDRV_CHMAP_RC, /* surround */
244 SNDRV_CHMAP_SL, /* side left */
245 SNDRV_CHMAP_SR, /* side right */
246 SNDRV_CHMAP_TC, /* top */
249 static unsigned int uac2_maps[] = {
250 SNDRV_CHMAP_FL, /* front left */
251 SNDRV_CHMAP_FR, /* front right */
252 SNDRV_CHMAP_FC, /* front center */
253 SNDRV_CHMAP_LFE, /* LFE */
254 SNDRV_CHMAP_RL, /* back left */
255 SNDRV_CHMAP_RR, /* back right */
256 SNDRV_CHMAP_FLC, /* front left of center */
257 SNDRV_CHMAP_FRC, /* front right of center */
258 SNDRV_CHMAP_RC, /* back center */
259 SNDRV_CHMAP_SL, /* side left */
260 SNDRV_CHMAP_SR, /* side right */
261 SNDRV_CHMAP_TC, /* top center */
262 SNDRV_CHMAP_TFL, /* top front left */
263 SNDRV_CHMAP_TFC, /* top front center */
264 SNDRV_CHMAP_TFR, /* top front right */
265 SNDRV_CHMAP_TRL, /* top back left */
266 SNDRV_CHMAP_TRC, /* top back center */
267 SNDRV_CHMAP_TRR, /* top back right */
268 SNDRV_CHMAP_TFLC, /* top front left of center */
269 SNDRV_CHMAP_TFRC, /* top front right of center */
270 SNDRV_CHMAP_LLFE, /* left LFE */
271 SNDRV_CHMAP_RLFE, /* right LFE */
272 SNDRV_CHMAP_TSL, /* top side left */
273 SNDRV_CHMAP_TSR, /* top side right */
274 SNDRV_CHMAP_BC, /* bottom center */
275 SNDRV_CHMAP_BLC, /* bottom left center */
276 SNDRV_CHMAP_BRC, /* bottom right center */
279 struct snd_pcm_chmap_elem *chmap;
280 const unsigned int *maps;
285 if (channels > ARRAY_SIZE(chmap->map))
288 chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
292 maps = protocol == UAC_VERSION_2 ? uac2_maps : uac1_maps;
293 chmap->channels = channels;
295 for (; bits && *maps; maps++, bits >>= 1) {
297 chmap->map[c++] = *maps;
300 for (; c < channels; c++)
301 chmap->map[c] = SNDRV_CHMAP_UNKNOWN;
307 * add this endpoint to the chip instance.
308 * if a stream with the same endpoint already exists, append to it.
309 * if not, create a new pcm stream.
311 int snd_usb_add_audio_stream(struct snd_usb_audio *chip,
313 struct audioformat *fp)
315 struct snd_usb_stream *as;
316 struct snd_usb_substream *subs;
320 list_for_each_entry(as, &chip->pcm_list, list) {
321 if (as->fmt_type != fp->fmt_type)
323 subs = &as->substream[stream];
324 if (subs->ep_num == fp->endpoint) {
325 list_add_tail(&fp->list, &subs->fmt_list);
327 subs->formats |= fp->formats;
331 /* look for an empty stream */
332 list_for_each_entry(as, &chip->pcm_list, list) {
333 if (as->fmt_type != fp->fmt_type)
335 subs = &as->substream[stream];
338 err = snd_pcm_new_stream(as->pcm, stream, 1);
341 snd_usb_init_substream(as, stream, fp);
342 return add_chmap(as->pcm, stream, subs);
345 /* create a new pcm */
346 as = kzalloc(sizeof(*as), GFP_KERNEL);
349 as->pcm_index = chip->pcm_devs;
351 as->fmt_type = fp->fmt_type;
352 err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
353 stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
354 stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
361 pcm->private_data = as;
362 pcm->private_free = snd_usb_audio_pcm_free;
364 if (chip->pcm_devs > 0)
365 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
367 strcpy(pcm->name, "USB Audio");
369 snd_usb_init_substream(as, stream, fp);
371 list_add(&as->list, &chip->pcm_list);
374 snd_usb_proc_pcm_format_add(as);
376 return add_chmap(pcm, stream, &as->substream[stream]);
379 static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip,
380 struct usb_host_interface *alts,
381 int protocol, int iface_no)
383 /* parsed with a v1 header here. that's ok as we only look at the
384 * header first which is the same for both versions */
385 struct uac_iso_endpoint_descriptor *csep;
386 struct usb_interface_descriptor *altsd = get_iface_desc(alts);
389 csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
391 /* Creamware Noah has this descriptor after the 2nd endpoint */
392 if (!csep && altsd->bNumEndpoints >= 2)
393 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
395 if (!csep || csep->bLength < 7 ||
396 csep->bDescriptorSubtype != UAC_EP_GENERAL) {
397 snd_printk(KERN_WARNING "%d:%u:%d : no or invalid"
398 " class specific endpoint descriptor\n",
399 chip->dev->devnum, iface_no,
400 altsd->bAlternateSetting);
404 if (protocol == UAC_VERSION_1) {
405 attributes = csep->bmAttributes;
407 struct uac2_iso_endpoint_descriptor *csep2 =
408 (struct uac2_iso_endpoint_descriptor *) csep;
410 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX;
412 /* emulate the endpoint attributes of a v1 device */
413 if (csep2->bmControls & UAC2_CONTROL_PITCH)
414 attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
420 /* find an input terminal descriptor (either UAC1 or UAC2) with the given
424 snd_usb_find_input_terminal_descriptor(struct usb_host_interface *ctrl_iface,
427 struct uac2_input_terminal_descriptor *term = NULL;
429 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
430 ctrl_iface->extralen,
431 term, UAC_INPUT_TERMINAL))) {
432 if (term->bTerminalID == terminal_id)
439 static struct uac2_output_terminal_descriptor *
440 snd_usb_find_output_terminal_descriptor(struct usb_host_interface *ctrl_iface,
443 struct uac2_output_terminal_descriptor *term = NULL;
445 while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
446 ctrl_iface->extralen,
447 term, UAC_OUTPUT_TERMINAL))) {
448 if (term->bTerminalID == terminal_id)
455 int snd_usb_parse_audio_interface(struct snd_usb_audio *chip, int iface_no)
457 struct usb_device *dev;
458 struct usb_interface *iface;
459 struct usb_host_interface *alts;
460 struct usb_interface_descriptor *altsd;
461 int i, altno, err, stream;
462 unsigned int format = 0, num_channels = 0;
463 struct audioformat *fp = NULL;
464 int num, protocol, clock = 0;
465 struct uac_format_type_i_continuous_descriptor *fmt;
466 unsigned int chconfig;
470 /* parse the interface's altsettings */
471 iface = usb_ifnum_to_if(dev, iface_no);
473 num = iface->num_altsetting;
476 * Dallas DS4201 workaround: It presents 5 altsettings, but the last
477 * one misses syncpipe, and does not produce any sound.
479 if (chip->usb_id == USB_ID(0x04fa, 0x4201))
482 for (i = 0; i < num; i++) {
483 alts = &iface->altsetting[i];
484 altsd = get_iface_desc(alts);
485 protocol = altsd->bInterfaceProtocol;
486 /* skip invalid one */
487 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&
488 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
489 (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
490 altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC) ||
491 altsd->bNumEndpoints < 1 ||
492 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
494 /* must be isochronous */
495 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
496 USB_ENDPOINT_XFER_ISOC)
498 /* check direction */
499 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
500 SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
501 altno = altsd->bAlternateSetting;
503 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
507 /* get audio formats */
510 snd_printdd(KERN_WARNING "%d:%u:%d: unknown interface protocol %#02x, assuming v1\n",
511 dev->devnum, iface_no, altno, protocol);
512 protocol = UAC_VERSION_1;
515 case UAC_VERSION_1: {
516 struct uac1_as_header_descriptor *as =
517 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
518 struct uac_input_terminal_descriptor *iterm;
521 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
522 dev->devnum, iface_no, altno);
526 if (as->bLength < sizeof(*as)) {
527 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
528 dev->devnum, iface_no, altno);
532 format = le16_to_cpu(as->wFormatTag); /* remember the format value */
534 iterm = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
537 num_channels = iterm->bNrChannels;
538 chconfig = le16_to_cpu(iterm->wChannelConfig);
544 case UAC_VERSION_2: {
545 struct uac2_input_terminal_descriptor *input_term;
546 struct uac2_output_terminal_descriptor *output_term;
547 struct uac2_as_header_descriptor *as =
548 snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_AS_GENERAL);
551 snd_printk(KERN_ERR "%d:%u:%d : UAC_AS_GENERAL descriptor not found\n",
552 dev->devnum, iface_no, altno);
556 if (as->bLength < sizeof(*as)) {
557 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_AS_GENERAL desc\n",
558 dev->devnum, iface_no, altno);
562 num_channels = as->bNrChannels;
563 format = le32_to_cpu(as->bmFormats);
565 /* lookup the terminal associated to this interface
566 * to extract the clock */
567 input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
570 clock = input_term->bCSourceID;
571 chconfig = le32_to_cpu(input_term->bmChannelConfig);
575 output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
578 clock = output_term->bCSourceID;
582 snd_printk(KERN_ERR "%d:%u:%d : bogus bTerminalLink %d\n",
583 dev->devnum, iface_no, altno, as->bTerminalLink);
588 /* get format type */
589 fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen, NULL, UAC_FORMAT_TYPE);
591 snd_printk(KERN_ERR "%d:%u:%d : no UAC_FORMAT_TYPE desc\n",
592 dev->devnum, iface_no, altno);
595 if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8)) ||
596 ((protocol == UAC_VERSION_2) && (fmt->bLength < 6))) {
597 snd_printk(KERN_ERR "%d:%u:%d : invalid UAC_FORMAT_TYPE desc\n",
598 dev->devnum, iface_no, altno);
603 * Blue Microphones workaround: The last altsetting is identical
604 * with the previous one, except for a larger packet size, but
605 * is actually a mislabeled two-channel setting; ignore it.
607 if (fmt->bNrChannels == 1 &&
608 fmt->bSubframeSize == 2 &&
609 altno == 2 && num == 3 &&
610 fp && fp->altsetting == 1 && fp->channels == 1 &&
611 fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
612 protocol == UAC_VERSION_1 &&
613 le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
617 fp = kzalloc(sizeof(*fp), GFP_KERNEL);
619 snd_printk(KERN_ERR "cannot malloc\n");
623 fp->iface = iface_no;
624 fp->altsetting = altno;
626 fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
627 fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
628 fp->datainterval = snd_usb_parse_datainterval(chip, alts);
629 fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
630 fp->channels = num_channels;
631 if (snd_usb_get_speed(dev) == USB_SPEED_HIGH)
632 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
633 * (fp->maxpacksize & 0x7ff);
634 fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol, iface_no);
636 fp->chmap = convert_chmap(num_channels, chconfig, protocol);
638 /* some quirks for attributes here */
640 switch (chip->usb_id) {
641 case USB_ID(0x0a92, 0x0053): /* AudioTrak Optoplay */
642 /* Optoplay sets the sample rate attribute although
643 * it seems not supporting it in fact.
645 fp->attributes &= ~UAC_EP_CS_ATTR_SAMPLE_RATE;
647 case USB_ID(0x041e, 0x3020): /* Creative SB Audigy 2 NX */
648 case USB_ID(0x0763, 0x2003): /* M-Audio Audiophile USB */
649 /* doesn't set the sample rate attribute, but supports it */
650 fp->attributes |= UAC_EP_CS_ATTR_SAMPLE_RATE;
652 case USB_ID(0x0763, 0x2001): /* M-Audio Quattro USB */
653 case USB_ID(0x0763, 0x2012): /* M-Audio Fast Track Pro USB */
654 case USB_ID(0x047f, 0x0ca1): /* plantronics headset */
655 case USB_ID(0x077d, 0x07af): /* Griffin iMic (note that there is
656 an older model 77d:223) */
658 * plantronics headset and Griffin iMic have set adaptive-in
659 * although it's really not...
661 fp->ep_attr &= ~USB_ENDPOINT_SYNCTYPE;
662 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
663 fp->ep_attr |= USB_ENDPOINT_SYNC_ADAPTIVE;
665 fp->ep_attr |= USB_ENDPOINT_SYNC_SYNC;
669 /* ok, let's parse further... */
670 if (snd_usb_parse_audio_format(chip, fp, format, fmt, stream, alts) < 0) {
671 kfree(fp->rate_table);
678 snd_printdd(KERN_INFO "%d:%u:%d: add audio endpoint %#x\n", dev->devnum, iface_no, altno, fp->endpoint);
679 err = snd_usb_add_audio_stream(chip, stream, fp);
681 kfree(fp->rate_table);
686 /* try to set the interface... */
687 usb_set_interface(chip->dev, iface_no, altno);
688 snd_usb_init_pitch(chip, iface_no, alts, fp);
689 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);