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