]> asedeno.scripts.mit.edu Git - linux.git/blob - sound/usb/stream.c
Merge tag 'configfs-for-5.2' of git://git.infradead.org/users/hch/configfs
[linux.git] / sound / usb / stream.c
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 #include <linux/usb/audio-v3.h>
24
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/control.h>
28 #include <sound/tlv.h>
29
30 #include "usbaudio.h"
31 #include "card.h"
32 #include "proc.h"
33 #include "quirks.h"
34 #include "endpoint.h"
35 #include "pcm.h"
36 #include "helper.h"
37 #include "format.h"
38 #include "clock.h"
39 #include "stream.h"
40 #include "power.h"
41 #include "media.h"
42
43 /*
44  * free a substream
45  */
46 static void free_substream(struct snd_usb_substream *subs)
47 {
48         struct audioformat *fp, *n;
49
50         if (!subs->num_formats)
51                 return; /* not initialized */
52         list_for_each_entry_safe(fp, n, &subs->fmt_list, list) {
53                 kfree(fp->rate_table);
54                 kfree(fp->chmap);
55                 kfree(fp);
56         }
57         kfree(subs->rate_list.list);
58         kfree(subs->str_pd);
59         snd_media_stream_delete(subs);
60 }
61
62
63 /*
64  * free a usb stream instance
65  */
66 static void snd_usb_audio_stream_free(struct snd_usb_stream *stream)
67 {
68         free_substream(&stream->substream[0]);
69         free_substream(&stream->substream[1]);
70         list_del(&stream->list);
71         kfree(stream);
72 }
73
74 static void snd_usb_audio_pcm_free(struct snd_pcm *pcm)
75 {
76         struct snd_usb_stream *stream = pcm->private_data;
77         if (stream) {
78                 stream->pcm = NULL;
79                 snd_usb_audio_stream_free(stream);
80         }
81 }
82
83 /*
84  * initialize the substream instance.
85  */
86
87 static void snd_usb_init_substream(struct snd_usb_stream *as,
88                                    int stream,
89                                    struct audioformat *fp,
90                                    struct snd_usb_power_domain *pd)
91 {
92         struct snd_usb_substream *subs = &as->substream[stream];
93
94         INIT_LIST_HEAD(&subs->fmt_list);
95         spin_lock_init(&subs->lock);
96
97         subs->stream = as;
98         subs->direction = stream;
99         subs->dev = as->chip->dev;
100         subs->txfr_quirk = as->chip->txfr_quirk;
101         subs->tx_length_quirk = as->chip->tx_length_quirk;
102         subs->speed = snd_usb_get_speed(subs->dev);
103         subs->pkt_offset_adj = 0;
104
105         snd_usb_set_pcm_ops(as->pcm, stream);
106
107         list_add_tail(&fp->list, &subs->fmt_list);
108         subs->formats |= fp->formats;
109         subs->num_formats++;
110         subs->fmt_type = fp->fmt_type;
111         subs->ep_num = fp->endpoint;
112         if (fp->channels > subs->channels_max)
113                 subs->channels_max = fp->channels;
114
115         if (pd) {
116                 subs->str_pd = pd;
117                 /* Initialize Power Domain to idle status D1 */
118                 snd_usb_power_domain_set(subs->stream->chip, pd,
119                                          UAC3_PD_STATE_D1);
120         }
121
122         snd_usb_preallocate_buffer(subs);
123 }
124
125 /* kctl callbacks for usb-audio channel maps */
126 static int usb_chmap_ctl_info(struct snd_kcontrol *kcontrol,
127                               struct snd_ctl_elem_info *uinfo)
128 {
129         struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
130         struct snd_usb_substream *subs = info->private_data;
131
132         uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
133         uinfo->count = subs->channels_max;
134         uinfo->value.integer.min = 0;
135         uinfo->value.integer.max = SNDRV_CHMAP_LAST;
136         return 0;
137 }
138
139 /* check whether a duplicated entry exists in the audiofmt list */
140 static bool have_dup_chmap(struct snd_usb_substream *subs,
141                            struct audioformat *fp)
142 {
143         struct audioformat *prev = fp;
144
145         list_for_each_entry_continue_reverse(prev, &subs->fmt_list, list) {
146                 if (prev->chmap &&
147                     !memcmp(prev->chmap, fp->chmap, sizeof(*fp->chmap)))
148                         return true;
149         }
150         return false;
151 }
152
153 static int usb_chmap_ctl_tlv(struct snd_kcontrol *kcontrol, int op_flag,
154                              unsigned int size, unsigned int __user *tlv)
155 {
156         struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
157         struct snd_usb_substream *subs = info->private_data;
158         struct audioformat *fp;
159         unsigned int __user *dst;
160         int count = 0;
161
162         if (size < 8)
163                 return -ENOMEM;
164         if (put_user(SNDRV_CTL_TLVT_CONTAINER, tlv))
165                 return -EFAULT;
166         size -= 8;
167         dst = tlv + 2;
168         list_for_each_entry(fp, &subs->fmt_list, list) {
169                 int i, ch_bytes;
170
171                 if (!fp->chmap)
172                         continue;
173                 if (have_dup_chmap(subs, fp))
174                         continue;
175                 /* copy the entry */
176                 ch_bytes = fp->chmap->channels * 4;
177                 if (size < 8 + ch_bytes)
178                         return -ENOMEM;
179                 if (put_user(SNDRV_CTL_TLVT_CHMAP_FIXED, dst) ||
180                     put_user(ch_bytes, dst + 1))
181                         return -EFAULT;
182                 dst += 2;
183                 for (i = 0; i < fp->chmap->channels; i++, dst++) {
184                         if (put_user(fp->chmap->map[i], dst))
185                                 return -EFAULT;
186                 }
187
188                 count += 8 + ch_bytes;
189                 size -= 8 + ch_bytes;
190         }
191         if (put_user(count, tlv + 1))
192                 return -EFAULT;
193         return 0;
194 }
195
196 static int usb_chmap_ctl_get(struct snd_kcontrol *kcontrol,
197                              struct snd_ctl_elem_value *ucontrol)
198 {
199         struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
200         struct snd_usb_substream *subs = info->private_data;
201         struct snd_pcm_chmap_elem *chmap = NULL;
202         int i;
203
204         memset(ucontrol->value.integer.value, 0,
205                sizeof(ucontrol->value.integer.value));
206         if (subs->cur_audiofmt)
207                 chmap = subs->cur_audiofmt->chmap;
208         if (chmap) {
209                 for (i = 0; i < chmap->channels; i++)
210                         ucontrol->value.integer.value[i] = chmap->map[i];
211         }
212         return 0;
213 }
214
215 /* create a chmap kctl assigned to the given USB substream */
216 static int add_chmap(struct snd_pcm *pcm, int stream,
217                      struct snd_usb_substream *subs)
218 {
219         struct audioformat *fp;
220         struct snd_pcm_chmap *chmap;
221         struct snd_kcontrol *kctl;
222         int err;
223
224         list_for_each_entry(fp, &subs->fmt_list, list)
225                 if (fp->chmap)
226                         goto ok;
227         /* no chmap is found */
228         return 0;
229
230  ok:
231         err = snd_pcm_add_chmap_ctls(pcm, stream, NULL, 0, 0, &chmap);
232         if (err < 0)
233                 return err;
234
235         /* override handlers */
236         chmap->private_data = subs;
237         kctl = chmap->kctl;
238         kctl->info = usb_chmap_ctl_info;
239         kctl->get = usb_chmap_ctl_get;
240         kctl->tlv.c = usb_chmap_ctl_tlv;
241
242         return 0;
243 }
244
245 /* convert from USB ChannelConfig bits to ALSA chmap element */
246 static struct snd_pcm_chmap_elem *convert_chmap(int channels, unsigned int bits,
247                                                 int protocol)
248 {
249         static unsigned int uac1_maps[] = {
250                 SNDRV_CHMAP_FL,         /* left front */
251                 SNDRV_CHMAP_FR,         /* right front */
252                 SNDRV_CHMAP_FC,         /* center front */
253                 SNDRV_CHMAP_LFE,        /* LFE */
254                 SNDRV_CHMAP_SL,         /* left surround */
255                 SNDRV_CHMAP_SR,         /* right surround */
256                 SNDRV_CHMAP_FLC,        /* left of center */
257                 SNDRV_CHMAP_FRC,        /* right of center */
258                 SNDRV_CHMAP_RC,         /* surround */
259                 SNDRV_CHMAP_SL,         /* side left */
260                 SNDRV_CHMAP_SR,         /* side right */
261                 SNDRV_CHMAP_TC,         /* top */
262                 0 /* terminator */
263         };
264         static unsigned int uac2_maps[] = {
265                 SNDRV_CHMAP_FL,         /* front left */
266                 SNDRV_CHMAP_FR,         /* front right */
267                 SNDRV_CHMAP_FC,         /* front center */
268                 SNDRV_CHMAP_LFE,        /* LFE */
269                 SNDRV_CHMAP_RL,         /* back left */
270                 SNDRV_CHMAP_RR,         /* back right */
271                 SNDRV_CHMAP_FLC,        /* front left of center */
272                 SNDRV_CHMAP_FRC,        /* front right of center */
273                 SNDRV_CHMAP_RC,         /* back center */
274                 SNDRV_CHMAP_SL,         /* side left */
275                 SNDRV_CHMAP_SR,         /* side right */
276                 SNDRV_CHMAP_TC,         /* top center */
277                 SNDRV_CHMAP_TFL,        /* top front left */
278                 SNDRV_CHMAP_TFC,        /* top front center */
279                 SNDRV_CHMAP_TFR,        /* top front right */
280                 SNDRV_CHMAP_TRL,        /* top back left */
281                 SNDRV_CHMAP_TRC,        /* top back center */
282                 SNDRV_CHMAP_TRR,        /* top back right */
283                 SNDRV_CHMAP_TFLC,       /* top front left of center */
284                 SNDRV_CHMAP_TFRC,       /* top front right of center */
285                 SNDRV_CHMAP_LLFE,       /* left LFE */
286                 SNDRV_CHMAP_RLFE,       /* right LFE */
287                 SNDRV_CHMAP_TSL,        /* top side left */
288                 SNDRV_CHMAP_TSR,        /* top side right */
289                 SNDRV_CHMAP_BC,         /* bottom center */
290                 SNDRV_CHMAP_RLC,        /* back left of center */
291                 SNDRV_CHMAP_RRC,        /* back right of center */
292                 0 /* terminator */
293         };
294         struct snd_pcm_chmap_elem *chmap;
295         const unsigned int *maps;
296         int c;
297
298         if (channels > ARRAY_SIZE(chmap->map))
299                 return NULL;
300
301         chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
302         if (!chmap)
303                 return NULL;
304
305         maps = protocol == UAC_VERSION_2 ? uac2_maps : uac1_maps;
306         chmap->channels = channels;
307         c = 0;
308
309         if (bits) {
310                 for (; bits && *maps; maps++, bits >>= 1)
311                         if (bits & 1)
312                                 chmap->map[c++] = *maps;
313         } else {
314                 /* If we're missing wChannelConfig, then guess something
315                     to make sure the channel map is not skipped entirely */
316                 if (channels == 1)
317                         chmap->map[c++] = SNDRV_CHMAP_MONO;
318                 else
319                         for (; c < channels && *maps; maps++)
320                                 chmap->map[c++] = *maps;
321         }
322
323         for (; c < channels; c++)
324                 chmap->map[c] = SNDRV_CHMAP_UNKNOWN;
325
326         return chmap;
327 }
328
329 /* UAC3 device stores channels information in Cluster Descriptors */
330 static struct
331 snd_pcm_chmap_elem *convert_chmap_v3(struct uac3_cluster_header_descriptor
332                                                                 *cluster)
333 {
334         unsigned int channels = cluster->bNrChannels;
335         struct snd_pcm_chmap_elem *chmap;
336         void *p = cluster;
337         int len, c;
338
339         if (channels > ARRAY_SIZE(chmap->map))
340                 return NULL;
341
342         chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
343         if (!chmap)
344                 return NULL;
345
346         len = le16_to_cpu(cluster->wLength);
347         c = 0;
348         p += sizeof(struct uac3_cluster_header_descriptor);
349
350         while (((p - (void *)cluster) < len) && (c < channels)) {
351                 struct uac3_cluster_segment_descriptor *cs_desc = p;
352                 u16 cs_len;
353                 u8 cs_type;
354
355                 cs_len = le16_to_cpu(cs_desc->wLength);
356                 cs_type = cs_desc->bSegmentType;
357
358                 if (cs_type == UAC3_CHANNEL_INFORMATION) {
359                         struct uac3_cluster_information_segment_descriptor *is = p;
360                         unsigned char map;
361
362                         /*
363                          * TODO: this conversion is not complete, update it
364                          * after adding UAC3 values to asound.h
365                          */
366                         switch (is->bChRelationship) {
367                         case UAC3_CH_MONO:
368                                 map = SNDRV_CHMAP_MONO;
369                                 break;
370                         case UAC3_CH_LEFT:
371                         case UAC3_CH_FRONT_LEFT:
372                         case UAC3_CH_HEADPHONE_LEFT:
373                                 map = SNDRV_CHMAP_FL;
374                                 break;
375                         case UAC3_CH_RIGHT:
376                         case UAC3_CH_FRONT_RIGHT:
377                         case UAC3_CH_HEADPHONE_RIGHT:
378                                 map = SNDRV_CHMAP_FR;
379                                 break;
380                         case UAC3_CH_FRONT_CENTER:
381                                 map = SNDRV_CHMAP_FC;
382                                 break;
383                         case UAC3_CH_FRONT_LEFT_OF_CENTER:
384                                 map = SNDRV_CHMAP_FLC;
385                                 break;
386                         case UAC3_CH_FRONT_RIGHT_OF_CENTER:
387                                 map = SNDRV_CHMAP_FRC;
388                                 break;
389                         case UAC3_CH_SIDE_LEFT:
390                                 map = SNDRV_CHMAP_SL;
391                                 break;
392                         case UAC3_CH_SIDE_RIGHT:
393                                 map = SNDRV_CHMAP_SR;
394                                 break;
395                         case UAC3_CH_BACK_LEFT:
396                                 map = SNDRV_CHMAP_RL;
397                                 break;
398                         case UAC3_CH_BACK_RIGHT:
399                                 map = SNDRV_CHMAP_RR;
400                                 break;
401                         case UAC3_CH_BACK_CENTER:
402                                 map = SNDRV_CHMAP_RC;
403                                 break;
404                         case UAC3_CH_BACK_LEFT_OF_CENTER:
405                                 map = SNDRV_CHMAP_RLC;
406                                 break;
407                         case UAC3_CH_BACK_RIGHT_OF_CENTER:
408                                 map = SNDRV_CHMAP_RRC;
409                                 break;
410                         case UAC3_CH_TOP_CENTER:
411                                 map = SNDRV_CHMAP_TC;
412                                 break;
413                         case UAC3_CH_TOP_FRONT_LEFT:
414                                 map = SNDRV_CHMAP_TFL;
415                                 break;
416                         case UAC3_CH_TOP_FRONT_RIGHT:
417                                 map = SNDRV_CHMAP_TFR;
418                                 break;
419                         case UAC3_CH_TOP_FRONT_CENTER:
420                                 map = SNDRV_CHMAP_TFC;
421                                 break;
422                         case UAC3_CH_TOP_FRONT_LOC:
423                                 map = SNDRV_CHMAP_TFLC;
424                                 break;
425                         case UAC3_CH_TOP_FRONT_ROC:
426                                 map = SNDRV_CHMAP_TFRC;
427                                 break;
428                         case UAC3_CH_TOP_SIDE_LEFT:
429                                 map = SNDRV_CHMAP_TSL;
430                                 break;
431                         case UAC3_CH_TOP_SIDE_RIGHT:
432                                 map = SNDRV_CHMAP_TSR;
433                                 break;
434                         case UAC3_CH_TOP_BACK_LEFT:
435                                 map = SNDRV_CHMAP_TRL;
436                                 break;
437                         case UAC3_CH_TOP_BACK_RIGHT:
438                                 map = SNDRV_CHMAP_TRR;
439                                 break;
440                         case UAC3_CH_TOP_BACK_CENTER:
441                                 map = SNDRV_CHMAP_TRC;
442                                 break;
443                         case UAC3_CH_BOTTOM_CENTER:
444                                 map = SNDRV_CHMAP_BC;
445                                 break;
446                         case UAC3_CH_LOW_FREQUENCY_EFFECTS:
447                                 map = SNDRV_CHMAP_LFE;
448                                 break;
449                         case UAC3_CH_LFE_LEFT:
450                                 map = SNDRV_CHMAP_LLFE;
451                                 break;
452                         case UAC3_CH_LFE_RIGHT:
453                                 map = SNDRV_CHMAP_RLFE;
454                                 break;
455                         case UAC3_CH_RELATIONSHIP_UNDEFINED:
456                         default:
457                                 map = SNDRV_CHMAP_UNKNOWN;
458                                 break;
459                         }
460                         chmap->map[c++] = map;
461                 }
462                 p += cs_len;
463         }
464
465         if (channels < c)
466                 pr_err("%s: channel number mismatch\n", __func__);
467
468         chmap->channels = channels;
469
470         for (; c < channels; c++)
471                 chmap->map[c] = SNDRV_CHMAP_UNKNOWN;
472
473         return chmap;
474 }
475
476 /*
477  * add this endpoint to the chip instance.
478  * if a stream with the same endpoint already exists, append to it.
479  * if not, create a new pcm stream. note, fp is added to the substream
480  * fmt_list and will be freed on the chip instance release. do not free
481  * fp or do remove it from the substream fmt_list to avoid double-free.
482  */
483 static int __snd_usb_add_audio_stream(struct snd_usb_audio *chip,
484                                       int stream,
485                                       struct audioformat *fp,
486                                       struct snd_usb_power_domain *pd)
487
488 {
489         struct snd_usb_stream *as;
490         struct snd_usb_substream *subs;
491         struct snd_pcm *pcm;
492         int err;
493
494         list_for_each_entry(as, &chip->pcm_list, list) {
495                 if (as->fmt_type != fp->fmt_type)
496                         continue;
497                 subs = &as->substream[stream];
498                 if (subs->ep_num == fp->endpoint) {
499                         list_add_tail(&fp->list, &subs->fmt_list);
500                         subs->num_formats++;
501                         subs->formats |= fp->formats;
502                         return 0;
503                 }
504         }
505         /* look for an empty stream */
506         list_for_each_entry(as, &chip->pcm_list, list) {
507                 if (as->fmt_type != fp->fmt_type)
508                         continue;
509                 subs = &as->substream[stream];
510                 if (subs->ep_num)
511                         continue;
512                 err = snd_pcm_new_stream(as->pcm, stream, 1);
513                 if (err < 0)
514                         return err;
515                 snd_usb_init_substream(as, stream, fp, pd);
516                 return add_chmap(as->pcm, stream, subs);
517         }
518
519         /* create a new pcm */
520         as = kzalloc(sizeof(*as), GFP_KERNEL);
521         if (!as)
522                 return -ENOMEM;
523         as->pcm_index = chip->pcm_devs;
524         as->chip = chip;
525         as->fmt_type = fp->fmt_type;
526         err = snd_pcm_new(chip->card, "USB Audio", chip->pcm_devs,
527                           stream == SNDRV_PCM_STREAM_PLAYBACK ? 1 : 0,
528                           stream == SNDRV_PCM_STREAM_PLAYBACK ? 0 : 1,
529                           &pcm);
530         if (err < 0) {
531                 kfree(as);
532                 return err;
533         }
534         as->pcm = pcm;
535         pcm->private_data = as;
536         pcm->private_free = snd_usb_audio_pcm_free;
537         pcm->info_flags = 0;
538         if (chip->pcm_devs > 0)
539                 sprintf(pcm->name, "USB Audio #%d", chip->pcm_devs);
540         else
541                 strcpy(pcm->name, "USB Audio");
542
543         snd_usb_init_substream(as, stream, fp, pd);
544
545         /*
546          * Keep using head insertion for M-Audio Audiophile USB (tm) which has a
547          * fix to swap capture stream order in conf/cards/USB-audio.conf
548          */
549         if (chip->usb_id == USB_ID(0x0763, 0x2003))
550                 list_add(&as->list, &chip->pcm_list);
551         else
552                 list_add_tail(&as->list, &chip->pcm_list);
553
554         chip->pcm_devs++;
555
556         snd_usb_proc_pcm_format_add(as);
557
558         return add_chmap(pcm, stream, &as->substream[stream]);
559 }
560
561 int snd_usb_add_audio_stream(struct snd_usb_audio *chip,
562                              int stream,
563                              struct audioformat *fp)
564 {
565         return __snd_usb_add_audio_stream(chip, stream, fp, NULL);
566 }
567
568 static int snd_usb_add_audio_stream_v3(struct snd_usb_audio *chip,
569                                        int stream,
570                                        struct audioformat *fp,
571                                        struct snd_usb_power_domain *pd)
572 {
573         return __snd_usb_add_audio_stream(chip, stream, fp, pd);
574 }
575
576 static int parse_uac_endpoint_attributes(struct snd_usb_audio *chip,
577                                          struct usb_host_interface *alts,
578                                          int protocol, int iface_no)
579 {
580         /* parsed with a v1 header here. that's ok as we only look at the
581          * header first which is the same for both versions */
582         struct uac_iso_endpoint_descriptor *csep;
583         struct usb_interface_descriptor *altsd = get_iface_desc(alts);
584         int attributes = 0;
585
586         csep = snd_usb_find_desc(alts->endpoint[0].extra, alts->endpoint[0].extralen, NULL, USB_DT_CS_ENDPOINT);
587
588         /* Creamware Noah has this descriptor after the 2nd endpoint */
589         if (!csep && altsd->bNumEndpoints >= 2)
590                 csep = snd_usb_find_desc(alts->endpoint[1].extra, alts->endpoint[1].extralen, NULL, USB_DT_CS_ENDPOINT);
591
592         /*
593          * If we can't locate the USB_DT_CS_ENDPOINT descriptor in the extra
594          * bytes after the first endpoint, go search the entire interface.
595          * Some devices have it directly *before* the standard endpoint.
596          */
597         if (!csep)
598                 csep = snd_usb_find_desc(alts->extra, alts->extralen, NULL, USB_DT_CS_ENDPOINT);
599
600         if (!csep || csep->bLength < 7 ||
601             csep->bDescriptorSubtype != UAC_EP_GENERAL)
602                 goto error;
603
604         if (protocol == UAC_VERSION_1) {
605                 attributes = csep->bmAttributes;
606         } else if (protocol == UAC_VERSION_2) {
607                 struct uac2_iso_endpoint_descriptor *csep2 =
608                         (struct uac2_iso_endpoint_descriptor *) csep;
609
610                 if (csep2->bLength < sizeof(*csep2))
611                         goto error;
612                 attributes = csep->bmAttributes & UAC_EP_CS_ATTR_FILL_MAX;
613
614                 /* emulate the endpoint attributes of a v1 device */
615                 if (csep2->bmControls & UAC2_CONTROL_PITCH)
616                         attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
617         } else { /* UAC_VERSION_3 */
618                 struct uac3_iso_endpoint_descriptor *csep3 =
619                         (struct uac3_iso_endpoint_descriptor *) csep;
620
621                 if (csep3->bLength < sizeof(*csep3))
622                         goto error;
623                 /* emulate the endpoint attributes of a v1 device */
624                 if (le32_to_cpu(csep3->bmControls) & UAC2_CONTROL_PITCH)
625                         attributes |= UAC_EP_CS_ATTR_PITCH_CONTROL;
626         }
627
628         return attributes;
629
630  error:
631         usb_audio_warn(chip,
632                        "%u:%d : no or invalid class specific endpoint descriptor\n",
633                        iface_no, altsd->bAlternateSetting);
634         return 0;
635 }
636
637 /* find an input terminal descriptor (either UAC1 or UAC2) with the given
638  * terminal id
639  */
640 static void *
641 snd_usb_find_input_terminal_descriptor(struct usb_host_interface *ctrl_iface,
642                                        int terminal_id, bool uac23)
643 {
644         struct uac2_input_terminal_descriptor *term = NULL;
645         size_t minlen = uac23 ? sizeof(struct uac2_input_terminal_descriptor) :
646                 sizeof(struct uac_input_terminal_descriptor);
647
648         while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
649                                                ctrl_iface->extralen,
650                                                term, UAC_INPUT_TERMINAL))) {
651                 if (term->bLength < minlen)
652                         continue;
653                 if (term->bTerminalID == terminal_id)
654                         return term;
655         }
656
657         return NULL;
658 }
659
660 static void *
661 snd_usb_find_output_terminal_descriptor(struct usb_host_interface *ctrl_iface,
662                                         int terminal_id)
663 {
664         /* OK to use with both UAC2 and UAC3 */
665         struct uac2_output_terminal_descriptor *term = NULL;
666
667         while ((term = snd_usb_find_csint_desc(ctrl_iface->extra,
668                                                ctrl_iface->extralen,
669                                                term, UAC_OUTPUT_TERMINAL))) {
670                 if (term->bLength >= sizeof(*term) &&
671                     term->bTerminalID == terminal_id)
672                         return term;
673         }
674
675         return NULL;
676 }
677
678 static struct audioformat *
679 audio_format_alloc_init(struct snd_usb_audio *chip,
680                        struct usb_host_interface *alts,
681                        int protocol, int iface_no, int altset_idx,
682                        int altno, int num_channels, int clock)
683 {
684         struct audioformat *fp;
685
686         fp = kzalloc(sizeof(*fp), GFP_KERNEL);
687         if (!fp)
688                 return NULL;
689
690         fp->iface = iface_no;
691         fp->altsetting = altno;
692         fp->altset_idx = altset_idx;
693         fp->endpoint = get_endpoint(alts, 0)->bEndpointAddress;
694         fp->ep_attr = get_endpoint(alts, 0)->bmAttributes;
695         fp->datainterval = snd_usb_parse_datainterval(chip, alts);
696         fp->protocol = protocol;
697         fp->maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
698         fp->channels = num_channels;
699         if (snd_usb_get_speed(chip->dev) == USB_SPEED_HIGH)
700                 fp->maxpacksize = (((fp->maxpacksize >> 11) & 3) + 1)
701                                 * (fp->maxpacksize & 0x7ff);
702         fp->clock = clock;
703         INIT_LIST_HEAD(&fp->list);
704
705         return fp;
706 }
707
708 static struct audioformat *
709 snd_usb_get_audioformat_uac12(struct snd_usb_audio *chip,
710                               struct usb_host_interface *alts,
711                               int protocol, int iface_no, int altset_idx,
712                               int altno, int stream, int bm_quirk)
713 {
714         struct usb_device *dev = chip->dev;
715         struct uac_format_type_i_continuous_descriptor *fmt;
716         unsigned int num_channels = 0, chconfig = 0;
717         struct audioformat *fp;
718         int clock = 0;
719         u64 format;
720
721         /* get audio formats */
722         if (protocol == UAC_VERSION_1) {
723                 struct uac1_as_header_descriptor *as =
724                         snd_usb_find_csint_desc(alts->extra, alts->extralen,
725                                                 NULL, UAC_AS_GENERAL);
726                 struct uac_input_terminal_descriptor *iterm;
727
728                 if (!as) {
729                         dev_err(&dev->dev,
730                                 "%u:%d : UAC_AS_GENERAL descriptor not found\n",
731                                 iface_no, altno);
732                         return NULL;
733                 }
734
735                 if (as->bLength < sizeof(*as)) {
736                         dev_err(&dev->dev,
737                                 "%u:%d : invalid UAC_AS_GENERAL desc\n",
738                                 iface_no, altno);
739                         return NULL;
740                 }
741
742                 format = le16_to_cpu(as->wFormatTag); /* remember the format value */
743
744                 iterm = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
745                                                                as->bTerminalLink,
746                                                                false);
747                 if (iterm) {
748                         num_channels = iterm->bNrChannels;
749                         chconfig = le16_to_cpu(iterm->wChannelConfig);
750                 }
751         } else { /* UAC_VERSION_2 */
752                 struct uac2_input_terminal_descriptor *input_term;
753                 struct uac2_output_terminal_descriptor *output_term;
754                 struct uac2_as_header_descriptor *as =
755                         snd_usb_find_csint_desc(alts->extra, alts->extralen,
756                                                 NULL, UAC_AS_GENERAL);
757
758                 if (!as) {
759                         dev_err(&dev->dev,
760                                 "%u:%d : UAC_AS_GENERAL descriptor not found\n",
761                                 iface_no, altno);
762                         return NULL;
763                 }
764
765                 if (as->bLength < sizeof(*as)) {
766                         dev_err(&dev->dev,
767                                 "%u:%d : invalid UAC_AS_GENERAL desc\n",
768                                 iface_no, altno);
769                         return NULL;
770                 }
771
772                 num_channels = as->bNrChannels;
773                 format = le32_to_cpu(as->bmFormats);
774                 chconfig = le32_to_cpu(as->bmChannelConfig);
775
776                 /*
777                  * lookup the terminal associated to this interface
778                  * to extract the clock
779                  */
780                 input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
781                                                                     as->bTerminalLink,
782                                                                     true);
783                 if (input_term) {
784                         clock = input_term->bCSourceID;
785                         if (!chconfig && (num_channels == input_term->bNrChannels))
786                                 chconfig = le32_to_cpu(input_term->bmChannelConfig);
787                         goto found_clock;
788                 }
789
790                 output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
791                                                                       as->bTerminalLink);
792                 if (output_term) {
793                         clock = output_term->bCSourceID;
794                         goto found_clock;
795                 }
796
797                 dev_err(&dev->dev,
798                         "%u:%d : bogus bTerminalLink %d\n",
799                         iface_no, altno, as->bTerminalLink);
800                 return NULL;
801         }
802
803 found_clock:
804         /* get format type */
805         fmt = snd_usb_find_csint_desc(alts->extra, alts->extralen,
806                                       NULL, UAC_FORMAT_TYPE);
807         if (!fmt) {
808                 dev_err(&dev->dev,
809                         "%u:%d : no UAC_FORMAT_TYPE desc\n",
810                         iface_no, altno);
811                 return NULL;
812         }
813         if (((protocol == UAC_VERSION_1) && (fmt->bLength < 8))
814                         || ((protocol == UAC_VERSION_2) &&
815                                         (fmt->bLength < 6))) {
816                 dev_err(&dev->dev,
817                         "%u:%d : invalid UAC_FORMAT_TYPE desc\n",
818                         iface_no, altno);
819                 return NULL;
820         }
821
822         /*
823          * Blue Microphones workaround: The last altsetting is
824          * identical with the previous one, except for a larger
825          * packet size, but is actually a mislabeled two-channel
826          * setting; ignore it.
827          *
828          * Part 2: analyze quirk flag and format
829          */
830         if (bm_quirk && fmt->bNrChannels == 1 && fmt->bSubframeSize == 2)
831                 return NULL;
832
833         fp = audio_format_alloc_init(chip, alts, protocol, iface_no,
834                                      altset_idx, altno, num_channels, clock);
835         if (!fp)
836                 return ERR_PTR(-ENOMEM);
837
838         fp->attributes = parse_uac_endpoint_attributes(chip, alts, protocol,
839                                                        iface_no);
840
841         /* some quirks for attributes here */
842         snd_usb_audioformat_attributes_quirk(chip, fp, stream);
843
844         /* ok, let's parse further... */
845         if (snd_usb_parse_audio_format(chip, fp, format,
846                                         fmt, stream) < 0) {
847                 kfree(fp->rate_table);
848                 kfree(fp);
849                 return NULL;
850         }
851
852         /* Create chmap */
853         if (fp->channels != num_channels)
854                 chconfig = 0;
855
856         fp->chmap = convert_chmap(fp->channels, chconfig, protocol);
857
858         return fp;
859 }
860
861 static struct audioformat *
862 snd_usb_get_audioformat_uac3(struct snd_usb_audio *chip,
863                              struct usb_host_interface *alts,
864                              struct snd_usb_power_domain **pd_out,
865                              int iface_no, int altset_idx,
866                              int altno, int stream)
867 {
868         struct usb_device *dev = chip->dev;
869         struct uac3_input_terminal_descriptor *input_term;
870         struct uac3_output_terminal_descriptor *output_term;
871         struct uac3_cluster_header_descriptor *cluster;
872         struct uac3_as_header_descriptor *as = NULL;
873         struct uac3_hc_descriptor_header hc_header;
874         struct snd_pcm_chmap_elem *chmap;
875         struct snd_usb_power_domain *pd;
876         unsigned char badd_profile;
877         u64 badd_formats = 0;
878         unsigned int num_channels;
879         struct audioformat *fp;
880         u16 cluster_id, wLength;
881         int clock = 0;
882         int err;
883
884         badd_profile = chip->badd_profile;
885
886         if (badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
887                 unsigned int maxpacksize =
888                         le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
889
890                 switch (maxpacksize) {
891                 default:
892                         dev_err(&dev->dev,
893                                 "%u:%d : incorrect wMaxPacketSize for BADD profile\n",
894                                 iface_no, altno);
895                         return NULL;
896                 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
897                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
898                         badd_formats = SNDRV_PCM_FMTBIT_S16_LE;
899                         num_channels = 1;
900                         break;
901                 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
902                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
903                         badd_formats = SNDRV_PCM_FMTBIT_S24_3LE;
904                         num_channels = 1;
905                         break;
906                 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
907                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
908                         badd_formats = SNDRV_PCM_FMTBIT_S16_LE;
909                         num_channels = 2;
910                         break;
911                 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
912                 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
913                         badd_formats = SNDRV_PCM_FMTBIT_S24_3LE;
914                         num_channels = 2;
915                         break;
916                 }
917
918                 chmap = kzalloc(sizeof(*chmap), GFP_KERNEL);
919                 if (!chmap)
920                         return ERR_PTR(-ENOMEM);
921
922                 if (num_channels == 1) {
923                         chmap->map[0] = SNDRV_CHMAP_MONO;
924                 } else {
925                         chmap->map[0] = SNDRV_CHMAP_FL;
926                         chmap->map[1] = SNDRV_CHMAP_FR;
927                 }
928
929                 chmap->channels = num_channels;
930                 clock = UAC3_BADD_CS_ID9;
931                 goto found_clock;
932         }
933
934         as = snd_usb_find_csint_desc(alts->extra, alts->extralen,
935                                      NULL, UAC_AS_GENERAL);
936         if (!as) {
937                 dev_err(&dev->dev,
938                         "%u:%d : UAC_AS_GENERAL descriptor not found\n",
939                         iface_no, altno);
940                 return NULL;
941         }
942
943         if (as->bLength < sizeof(*as)) {
944                 dev_err(&dev->dev,
945                         "%u:%d : invalid UAC_AS_GENERAL desc\n",
946                         iface_no, altno);
947                 return NULL;
948         }
949
950         cluster_id = le16_to_cpu(as->wClusterDescrID);
951         if (!cluster_id) {
952                 dev_err(&dev->dev,
953                         "%u:%d : no cluster descriptor\n",
954                         iface_no, altno);
955                 return NULL;
956         }
957
958         /*
959          * Get number of channels and channel map through
960          * High Capability Cluster Descriptor
961          *
962          * First step: get High Capability header and
963          * read size of Cluster Descriptor
964          */
965         err = snd_usb_ctl_msg(chip->dev,
966                         usb_rcvctrlpipe(chip->dev, 0),
967                         UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
968                         USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
969                         cluster_id,
970                         snd_usb_ctrl_intf(chip),
971                         &hc_header, sizeof(hc_header));
972         if (err < 0)
973                 return ERR_PTR(err);
974         else if (err != sizeof(hc_header)) {
975                 dev_err(&dev->dev,
976                         "%u:%d : can't get High Capability descriptor\n",
977                         iface_no, altno);
978                 return ERR_PTR(-EIO);
979         }
980
981         /*
982          * Second step: allocate needed amount of memory
983          * and request Cluster Descriptor
984          */
985         wLength = le16_to_cpu(hc_header.wLength);
986         cluster = kzalloc(wLength, GFP_KERNEL);
987         if (!cluster)
988                 return ERR_PTR(-ENOMEM);
989         err = snd_usb_ctl_msg(chip->dev,
990                         usb_rcvctrlpipe(chip->dev, 0),
991                         UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
992                         USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
993                         cluster_id,
994                         snd_usb_ctrl_intf(chip),
995                         cluster, wLength);
996         if (err < 0) {
997                 kfree(cluster);
998                 return ERR_PTR(err);
999         } else if (err != wLength) {
1000                 dev_err(&dev->dev,
1001                         "%u:%d : can't get Cluster Descriptor\n",
1002                         iface_no, altno);
1003                 kfree(cluster);
1004                 return ERR_PTR(-EIO);
1005         }
1006
1007         num_channels = cluster->bNrChannels;
1008         chmap = convert_chmap_v3(cluster);
1009         kfree(cluster);
1010
1011         /*
1012          * lookup the terminal associated to this interface
1013          * to extract the clock
1014          */
1015         input_term = snd_usb_find_input_terminal_descriptor(chip->ctrl_intf,
1016                                                             as->bTerminalLink,
1017                                                             true);
1018         if (input_term) {
1019                 clock = input_term->bCSourceID;
1020                 goto found_clock;
1021         }
1022
1023         output_term = snd_usb_find_output_terminal_descriptor(chip->ctrl_intf,
1024                                                              as->bTerminalLink);
1025         if (output_term) {
1026                 clock = output_term->bCSourceID;
1027                 goto found_clock;
1028         }
1029
1030         dev_err(&dev->dev, "%u:%d : bogus bTerminalLink %d\n",
1031                         iface_no, altno, as->bTerminalLink);
1032         kfree(chmap);
1033         return NULL;
1034
1035 found_clock:
1036         fp = audio_format_alloc_init(chip, alts, UAC_VERSION_3, iface_no,
1037                                      altset_idx, altno, num_channels, clock);
1038         if (!fp) {
1039                 kfree(chmap);
1040                 return ERR_PTR(-ENOMEM);
1041         }
1042
1043         fp->chmap = chmap;
1044
1045         if (badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
1046                 fp->attributes = 0; /* No attributes */
1047
1048                 fp->fmt_type = UAC_FORMAT_TYPE_I;
1049                 fp->formats = badd_formats;
1050
1051                 fp->nr_rates = 0;       /* SNDRV_PCM_RATE_CONTINUOUS */
1052                 fp->rate_min = UAC3_BADD_SAMPLING_RATE;
1053                 fp->rate_max = UAC3_BADD_SAMPLING_RATE;
1054                 fp->rates = SNDRV_PCM_RATE_CONTINUOUS;
1055
1056                 pd = kzalloc(sizeof(*pd), GFP_KERNEL);
1057                 if (!pd) {
1058                         kfree(fp->rate_table);
1059                         kfree(fp);
1060                         return NULL;
1061                 }
1062                 pd->pd_id = (stream == SNDRV_PCM_STREAM_PLAYBACK) ?
1063                                         UAC3_BADD_PD_ID10 : UAC3_BADD_PD_ID11;
1064                 pd->pd_d1d0_rec = UAC3_BADD_PD_RECOVER_D1D0;
1065                 pd->pd_d2d0_rec = UAC3_BADD_PD_RECOVER_D2D0;
1066
1067         } else {
1068                 fp->attributes = parse_uac_endpoint_attributes(chip, alts,
1069                                                                UAC_VERSION_3,
1070                                                                iface_no);
1071
1072                 pd = snd_usb_find_power_domain(chip->ctrl_intf,
1073                                                as->bTerminalLink);
1074
1075                 /* ok, let's parse further... */
1076                 if (snd_usb_parse_audio_format_v3(chip, fp, as, stream) < 0) {
1077                         kfree(pd);
1078                         kfree(fp->chmap);
1079                         kfree(fp->rate_table);
1080                         kfree(fp);
1081                         return NULL;
1082                 }
1083         }
1084
1085         if (pd)
1086                 *pd_out = pd;
1087
1088         return fp;
1089 }
1090
1091 int snd_usb_parse_audio_interface(struct snd_usb_audio *chip, int iface_no)
1092 {
1093         struct usb_device *dev;
1094         struct usb_interface *iface;
1095         struct usb_host_interface *alts;
1096         struct usb_interface_descriptor *altsd;
1097         int i, altno, err, stream;
1098         struct audioformat *fp = NULL;
1099         struct snd_usb_power_domain *pd = NULL;
1100         int num, protocol;
1101
1102         dev = chip->dev;
1103
1104         /* parse the interface's altsettings */
1105         iface = usb_ifnum_to_if(dev, iface_no);
1106
1107         num = iface->num_altsetting;
1108
1109         /*
1110          * Dallas DS4201 workaround: It presents 5 altsettings, but the last
1111          * one misses syncpipe, and does not produce any sound.
1112          */
1113         if (chip->usb_id == USB_ID(0x04fa, 0x4201))
1114                 num = 4;
1115
1116         for (i = 0; i < num; i++) {
1117                 alts = &iface->altsetting[i];
1118                 altsd = get_iface_desc(alts);
1119                 protocol = altsd->bInterfaceProtocol;
1120                 /* skip invalid one */
1121                 if (((altsd->bInterfaceClass != USB_CLASS_AUDIO ||
1122                       (altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING &&
1123                        altsd->bInterfaceSubClass != USB_SUBCLASS_VENDOR_SPEC)) &&
1124                      altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||
1125                     altsd->bNumEndpoints < 1 ||
1126                     le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) == 0)
1127                         continue;
1128                 /* must be isochronous */
1129                 if ((get_endpoint(alts, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) !=
1130                     USB_ENDPOINT_XFER_ISOC)
1131                         continue;
1132                 /* check direction */
1133                 stream = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN) ?
1134                         SNDRV_PCM_STREAM_CAPTURE : SNDRV_PCM_STREAM_PLAYBACK;
1135                 altno = altsd->bAlternateSetting;
1136
1137                 if (snd_usb_apply_interface_quirk(chip, iface_no, altno))
1138                         continue;
1139
1140                 /*
1141                  * Roland audio streaming interfaces are marked with protocols
1142                  * 0/1/2, but are UAC 1 compatible.
1143                  */
1144                 if (USB_ID_VENDOR(chip->usb_id) == 0x0582 &&
1145                     altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
1146                     protocol <= 2)
1147                         protocol = UAC_VERSION_1;
1148
1149                 switch (protocol) {
1150                 default:
1151                         dev_dbg(&dev->dev, "%u:%d: unknown interface protocol %#02x, assuming v1\n",
1152                                 iface_no, altno, protocol);
1153                         protocol = UAC_VERSION_1;
1154                         /* fall through */
1155                 case UAC_VERSION_1:
1156                         /* fall through */
1157                 case UAC_VERSION_2: {
1158                         int bm_quirk = 0;
1159
1160                         /*
1161                          * Blue Microphones workaround: The last altsetting is
1162                          * identical with the previous one, except for a larger
1163                          * packet size, but is actually a mislabeled two-channel
1164                          * setting; ignore it.
1165                          *
1166                          * Part 1: prepare quirk flag
1167                          */
1168                         if (altno == 2 && num == 3 &&
1169                             fp && fp->altsetting == 1 && fp->channels == 1 &&
1170                             fp->formats == SNDRV_PCM_FMTBIT_S16_LE &&
1171                             protocol == UAC_VERSION_1 &&
1172                             le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize) ==
1173                                                         fp->maxpacksize * 2)
1174                                 bm_quirk = 1;
1175
1176                         fp = snd_usb_get_audioformat_uac12(chip, alts, protocol,
1177                                                            iface_no, i, altno,
1178                                                            stream, bm_quirk);
1179                         break;
1180                 }
1181                 case UAC_VERSION_3:
1182                         fp = snd_usb_get_audioformat_uac3(chip, alts, &pd,
1183                                                 iface_no, i, altno, stream);
1184                         break;
1185                 }
1186
1187                 if (!fp)
1188                         continue;
1189                 else if (IS_ERR(fp))
1190                         return PTR_ERR(fp);
1191
1192                 dev_dbg(&dev->dev, "%u:%d: add audio endpoint %#x\n", iface_no, altno, fp->endpoint);
1193                 if (protocol == UAC_VERSION_3)
1194                         err = snd_usb_add_audio_stream_v3(chip, stream, fp, pd);
1195                 else
1196                         err = snd_usb_add_audio_stream(chip, stream, fp);
1197
1198                 if (err < 0) {
1199                         list_del(&fp->list); /* unlink for avoiding double-free */
1200                         kfree(pd);
1201                         kfree(fp->rate_table);
1202                         kfree(fp->chmap);
1203                         kfree(fp);
1204                         return err;
1205                 }
1206                 /* try to set the interface... */
1207                 usb_set_interface(chip->dev, iface_no, altno);
1208                 snd_usb_init_pitch(chip, iface_no, alts, fp);
1209                 snd_usb_init_sample_rate(chip, iface_no, alts, fp, fp->rate_max);
1210         }
1211         return 0;
1212 }
1213