41b9fe0ae1772a0274c734091be91cd38e206fc6
[pandora-kernel.git] / sound / usb / mixer.c
1 /*
2  *   (Tentative) USB Audio Driver for ALSA
3  *
4  *   Mixer control part
5  *
6  *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
7  *
8  *   Many codes borrowed from audio.c by
9  *          Alan Cox (alan@lxorguk.ukuu.org.uk)
10  *          Thomas Sailer (sailer@ife.ee.ethz.ch)
11  *
12  *
13  *   This program is free software; you can redistribute it and/or modify
14  *   it under the terms of the GNU General Public License as published by
15  *   the Free Software Foundation; either version 2 of the License, or
16  *   (at your option) any later version.
17  *
18  *   This program is distributed in the hope that it will be useful,
19  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
20  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  *   GNU General Public License for more details.
22  *
23  *   You should have received a copy of the GNU General Public License
24  *   along with this program; if not, write to the Free Software
25  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
26  *
27  */
28
29 /*
30  * TODOs, for both the mixer and the streaming interfaces:
31  *
32  *  - support for UAC2 effect units
33  *  - support for graphical equalizers
34  *  - RANGE and MEM set commands (UAC2)
35  *  - RANGE and MEM interrupt dispatchers (UAC2)
36  *  - audio channel clustering (UAC2)
37  *  - audio sample rate converter units (UAC2)
38  *  - proper handling of clock multipliers (UAC2)
39  *  - dispatch clock change notifications (UAC2)
40  *      - stop PCM streams which use a clock that became invalid
41  *      - stop PCM streams which use a clock selector that has changed
42  *      - parse available sample rates again when clock sources changed
43  */
44
45 #include <linux/bitops.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/slab.h>
49 #include <linux/string.h>
50 #include <linux/usb.h>
51 #include <linux/usb/audio.h>
52 #include <linux/usb/audio-v2.h>
53
54 #include <sound/core.h>
55 #include <sound/control.h>
56 #include <sound/hwdep.h>
57 #include <sound/info.h>
58 #include <sound/tlv.h>
59
60 #include "usbaudio.h"
61 #include "mixer.h"
62 #include "helper.h"
63 #include "mixer_quirks.h"
64 #include "power.h"
65
66 #define MAX_ID_ELEMS    256
67
68 struct usb_audio_term {
69         int id;
70         int type;
71         int channels;
72         unsigned int chconfig;
73         int name;
74 };
75
76 struct usbmix_name_map;
77
78 struct mixer_build {
79         struct snd_usb_audio *chip;
80         struct usb_mixer_interface *mixer;
81         unsigned char *buffer;
82         unsigned int buflen;
83         DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
84         struct usb_audio_term oterm;
85         const struct usbmix_name_map *map;
86         const struct usbmix_selector_map *selector_map;
87 };
88
89 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
90 enum {
91         USB_XU_CLOCK_RATE               = 0xe301,
92         USB_XU_CLOCK_SOURCE             = 0xe302,
93         USB_XU_DIGITAL_IO_STATUS        = 0xe303,
94         USB_XU_DEVICE_OPTIONS           = 0xe304,
95         USB_XU_DIRECT_MONITORING        = 0xe305,
96         USB_XU_METERING                 = 0xe306
97 };
98 enum {
99         USB_XU_CLOCK_SOURCE_SELECTOR = 0x02,    /* clock source*/
100         USB_XU_CLOCK_RATE_SELECTOR = 0x03,      /* clock rate */
101         USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01,  /* the spdif format */
102         USB_XU_SOFT_LIMIT_SELECTOR = 0x03       /* soft limiter */
103 };
104
105 /*
106  * manual mapping of mixer names
107  * if the mixer topology is too complicated and the parsed names are
108  * ambiguous, add the entries in usbmixer_maps.c.
109  */
110 #include "mixer_maps.c"
111
112 static const struct usbmix_name_map *
113 find_map(struct mixer_build *state, int unitid, int control)
114 {
115         const struct usbmix_name_map *p = state->map;
116
117         if (!p)
118                 return NULL;
119
120         for (p = state->map; p->id; p++) {
121                 if (p->id == unitid &&
122                     (!control || !p->control || control == p->control))
123                         return p;
124         }
125         return NULL;
126 }
127
128 /* get the mapped name if the unit matches */
129 static int
130 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
131 {
132         if (!p || !p->name)
133                 return 0;
134
135         buflen--;
136         return strlcpy(buf, p->name, buflen);
137 }
138
139 /* check whether the control should be ignored */
140 static inline int
141 check_ignored_ctl(const struct usbmix_name_map *p)
142 {
143         if (!p || p->name || p->dB)
144                 return 0;
145         return 1;
146 }
147
148 /* dB mapping */
149 static inline void check_mapped_dB(const struct usbmix_name_map *p,
150                                    struct usb_mixer_elem_info *cval)
151 {
152         if (p && p->dB) {
153                 cval->dBmin = p->dB->min;
154                 cval->dBmax = p->dB->max;
155                 cval->initialized = 1;
156         }
157 }
158
159 /* get the mapped selector source name */
160 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
161                                       int index, char *buf, int buflen)
162 {
163         const struct usbmix_selector_map *p;
164
165         if (! state->selector_map)
166                 return 0;
167         for (p = state->selector_map; p->id; p++) {
168                 if (p->id == unitid && index < p->count)
169                         return strlcpy(buf, p->names[index], buflen);
170         }
171         return 0;
172 }
173
174 /*
175  * find an audio control unit with the given unit id
176  */
177 static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
178 {
179         /* we just parse the header */
180         struct uac_feature_unit_descriptor *hdr = NULL;
181
182         while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
183                                         USB_DT_CS_INTERFACE)) != NULL) {
184                 if (hdr->bLength >= 4 &&
185                     hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
186                     hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
187                     hdr->bUnitID == unit)
188                         return hdr;
189         }
190
191         return NULL;
192 }
193
194 /*
195  * copy a string with the given id
196  */
197 static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
198 {
199         int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
200         buf[len] = 0;
201         return len;
202 }
203
204 /*
205  * convert from the byte/word on usb descriptor to the zero-based integer
206  */
207 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
208 {
209         switch (cval->val_type) {
210         case USB_MIXER_BOOLEAN:
211                 return !!val;
212         case USB_MIXER_INV_BOOLEAN:
213                 return !val;
214         case USB_MIXER_U8:
215                 val &= 0xff;
216                 break;
217         case USB_MIXER_S8:
218                 val &= 0xff;
219                 if (val >= 0x80)
220                         val -= 0x100;
221                 break;
222         case USB_MIXER_U16:
223                 val &= 0xffff;
224                 break;
225         case USB_MIXER_S16:
226                 val &= 0xffff;
227                 if (val >= 0x8000)
228                         val -= 0x10000;
229                 break;
230         }
231         return val;
232 }
233
234 /*
235  * convert from the zero-based int to the byte/word for usb descriptor
236  */
237 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
238 {
239         switch (cval->val_type) {
240         case USB_MIXER_BOOLEAN:
241                 return !!val;
242         case USB_MIXER_INV_BOOLEAN:
243                 return !val;
244         case USB_MIXER_S8:
245         case USB_MIXER_U8:
246                 return val & 0xff;
247         case USB_MIXER_S16:
248         case USB_MIXER_U16:
249                 return val & 0xffff;
250         }
251         return 0; /* not reached */
252 }
253
254 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
255 {
256         if (! cval->res)
257                 cval->res = 1;
258         if (val < cval->min)
259                 return 0;
260         else if (val >= cval->max)
261                 return (cval->max - cval->min + cval->res - 1) / cval->res;
262         else
263                 return (val - cval->min) / cval->res;
264 }
265
266 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
267 {
268         if (val < 0)
269                 return cval->min;
270         if (! cval->res)
271                 cval->res = 1;
272         val *= cval->res;
273         val += cval->min;
274         if (val > cval->max)
275                 return cval->max;
276         return val;
277 }
278
279
280 /*
281  * retrieve a mixer value
282  */
283
284 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
285 {
286         struct snd_usb_audio *chip = cval->mixer->chip;
287         unsigned char buf[2];
288         int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
289         int timeout = 10;
290         int idx = 0, err;
291
292         err = snd_usb_autoresume(cval->mixer->chip);
293         if (err < 0)
294                 return -EIO;
295         down_read(&chip->shutdown_rwsem);
296         while (timeout-- > 0) {
297                 if (chip->shutdown)
298                         break;
299                 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
300                 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
301                                     USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
302                                     validx, idx, buf, val_len) >= val_len) {
303                         *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
304                         err = 0;
305                         goto out;
306                 }
307         }
308         snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
309                     request, validx, idx, cval->val_type);
310         err = -EINVAL;
311
312  out:
313         up_read(&chip->shutdown_rwsem);
314         snd_usb_autosuspend(cval->mixer->chip);
315         return err;
316 }
317
318 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
319 {
320         struct snd_usb_audio *chip = cval->mixer->chip;
321         unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */
322         unsigned char *val;
323         int idx = 0, ret, size;
324         __u8 bRequest;
325
326         if (request == UAC_GET_CUR) {
327                 bRequest = UAC2_CS_CUR;
328                 size = sizeof(__u16);
329         } else {
330                 bRequest = UAC2_CS_RANGE;
331                 size = sizeof(buf);
332         }
333
334         memset(buf, 0, sizeof(buf));
335
336         ret = snd_usb_autoresume(chip) ? -EIO : 0;
337         if (ret)
338                 goto error;
339
340         down_read(&chip->shutdown_rwsem);
341         if (chip->shutdown)
342                 ret = -ENODEV;
343         else {
344                 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
345                 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
346                               USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
347                               validx, idx, buf, size);
348         }
349         up_read(&chip->shutdown_rwsem);
350         snd_usb_autosuspend(chip);
351
352         if (ret < 0) {
353 error:
354                 snd_printk(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
355                            request, validx, idx, cval->val_type);
356                 return ret;
357         }
358
359         /* FIXME: how should we handle multiple triplets here? */
360
361         switch (request) {
362         case UAC_GET_CUR:
363                 val = buf;
364                 break;
365         case UAC_GET_MIN:
366                 val = buf + sizeof(__u16);
367                 break;
368         case UAC_GET_MAX:
369                 val = buf + sizeof(__u16) * 2;
370                 break;
371         case UAC_GET_RES:
372                 val = buf + sizeof(__u16) * 3;
373                 break;
374         default:
375                 return -EINVAL;
376         }
377
378         *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
379
380         return 0;
381 }
382
383 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
384 {
385         return (cval->mixer->protocol == UAC_VERSION_1) ?
386                 get_ctl_value_v1(cval, request, validx, value_ret) :
387                 get_ctl_value_v2(cval, request, validx, value_ret);
388 }
389
390 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
391 {
392         return get_ctl_value(cval, UAC_GET_CUR, validx, value);
393 }
394
395 /* channel = 0: master, 1 = first channel */
396 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
397                                   int channel, int *value)
398 {
399         return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
400 }
401
402 static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
403                              int channel, int index, int *value)
404 {
405         int err;
406
407         if (cval->cached & (1 << channel)) {
408                 *value = cval->cache_val[index];
409                 return 0;
410         }
411         err = get_cur_mix_raw(cval, channel, value);
412         if (err < 0) {
413                 if (!cval->mixer->ignore_ctl_error)
414                         snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
415                                    cval->control, channel, err);
416                 return err;
417         }
418         cval->cached |= 1 << channel;
419         cval->cache_val[index] = *value;
420         return 0;
421 }
422
423
424 /*
425  * set a mixer value
426  */
427
428 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
429                                 int request, int validx, int value_set)
430 {
431         struct snd_usb_audio *chip = cval->mixer->chip;
432         unsigned char buf[2];
433         int idx = 0, val_len, err, timeout = 10;
434
435         if (cval->mixer->protocol == UAC_VERSION_1) {
436                 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
437         } else { /* UAC_VERSION_2 */
438                 /* audio class v2 controls are always 2 bytes in size */
439                 val_len = sizeof(__u16);
440
441                 /* FIXME */
442                 if (request != UAC_SET_CUR) {
443                         snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
444                         return -EINVAL;
445                 }
446
447                 request = UAC2_CS_CUR;
448         }
449
450         value_set = convert_bytes_value(cval, value_set);
451         buf[0] = value_set & 0xff;
452         buf[1] = (value_set >> 8) & 0xff;
453         err = snd_usb_autoresume(chip);
454         if (err < 0)
455                 return -EIO;
456         down_read(&chip->shutdown_rwsem);
457         while (timeout-- > 0) {
458                 if (chip->shutdown)
459                         break;
460                 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
461                 if (snd_usb_ctl_msg(chip->dev,
462                                     usb_sndctrlpipe(chip->dev, 0), request,
463                                     USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
464                                     validx, idx, buf, val_len) >= 0) {
465                         err = 0;
466                         goto out;
467                 }
468         }
469         snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
470                     request, validx, idx, cval->val_type, buf[0], buf[1]);
471         err = -EINVAL;
472
473  out:
474         up_read(&chip->shutdown_rwsem);
475         snd_usb_autosuspend(chip);
476         return err;
477 }
478
479 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
480 {
481         return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
482 }
483
484 static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
485                              int index, int value)
486 {
487         int err;
488         unsigned int read_only = (channel == 0) ?
489                 cval->master_readonly :
490                 cval->ch_readonly & (1 << (channel - 1));
491
492         if (read_only) {
493                 snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
494                             __func__, channel, cval->control);
495                 return 0;
496         }
497
498         err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
499                             value);
500         if (err < 0)
501                 return err;
502         cval->cached |= 1 << channel;
503         cval->cache_val[index] = value;
504         return 0;
505 }
506
507 /*
508  * TLV callback for mixer volume controls
509  */
510 static int mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
511                          unsigned int size, unsigned int __user *_tlv)
512 {
513         struct usb_mixer_elem_info *cval = kcontrol->private_data;
514         DECLARE_TLV_DB_MINMAX(scale, 0, 0);
515
516         if (size < sizeof(scale))
517                 return -ENOMEM;
518         scale[2] = cval->dBmin;
519         scale[3] = cval->dBmax;
520         if (copy_to_user(_tlv, scale, sizeof(scale)))
521                 return -EFAULT;
522         return 0;
523 }
524
525 /*
526  * parser routines begin here...
527  */
528
529 static int parse_audio_unit(struct mixer_build *state, int unitid);
530
531
532 /*
533  * check if the input/output channel routing is enabled on the given bitmap.
534  * used for mixer unit parser
535  */
536 static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
537 {
538         int idx = ich * num_outs + och;
539         return bmap[idx >> 3] & (0x80 >> (idx & 7));
540 }
541
542
543 /*
544  * add an alsa control element
545  * search and increment the index until an empty slot is found.
546  *
547  * if failed, give up and free the control instance.
548  */
549
550 int snd_usb_mixer_add_control(struct usb_mixer_interface *mixer,
551                               struct snd_kcontrol *kctl)
552 {
553         struct usb_mixer_elem_info *cval = kctl->private_data;
554         int err;
555
556         while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
557                 kctl->id.index++;
558         if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
559                 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
560                 return err;
561         }
562         cval->elem_id = &kctl->id;
563         cval->next_id_elem = mixer->id_elems[cval->id];
564         mixer->id_elems[cval->id] = cval;
565         return 0;
566 }
567
568
569 /*
570  * get a terminal name string
571  */
572
573 static struct iterm_name_combo {
574         int type;
575         char *name;
576 } iterm_names[] = {
577         { 0x0300, "Output" },
578         { 0x0301, "Speaker" },
579         { 0x0302, "Headphone" },
580         { 0x0303, "HMD Audio" },
581         { 0x0304, "Desktop Speaker" },
582         { 0x0305, "Room Speaker" },
583         { 0x0306, "Com Speaker" },
584         { 0x0307, "LFE" },
585         { 0x0600, "External In" },
586         { 0x0601, "Analog In" },
587         { 0x0602, "Digital In" },
588         { 0x0603, "Line" },
589         { 0x0604, "Legacy In" },
590         { 0x0605, "IEC958 In" },
591         { 0x0606, "1394 DA Stream" },
592         { 0x0607, "1394 DV Stream" },
593         { 0x0700, "Embedded" },
594         { 0x0701, "Noise Source" },
595         { 0x0702, "Equalization Noise" },
596         { 0x0703, "CD" },
597         { 0x0704, "DAT" },
598         { 0x0705, "DCC" },
599         { 0x0706, "MiniDisk" },
600         { 0x0707, "Analog Tape" },
601         { 0x0708, "Phonograph" },
602         { 0x0709, "VCR Audio" },
603         { 0x070a, "Video Disk Audio" },
604         { 0x070b, "DVD Audio" },
605         { 0x070c, "TV Tuner Audio" },
606         { 0x070d, "Satellite Rec Audio" },
607         { 0x070e, "Cable Tuner Audio" },
608         { 0x070f, "DSS Audio" },
609         { 0x0710, "Radio Receiver" },
610         { 0x0711, "Radio Transmitter" },
611         { 0x0712, "Multi-Track Recorder" },
612         { 0x0713, "Synthesizer" },
613         { 0 },
614 };
615
616 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
617                          unsigned char *name, int maxlen, int term_only)
618 {
619         struct iterm_name_combo *names;
620
621         if (iterm->name)
622                 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
623
624         /* virtual type - not a real terminal */
625         if (iterm->type >> 16) {
626                 if (term_only)
627                         return 0;
628                 switch (iterm->type >> 16) {
629                 case UAC_SELECTOR_UNIT:
630                         strcpy(name, "Selector"); return 8;
631                 case UAC1_PROCESSING_UNIT:
632                         strcpy(name, "Process Unit"); return 12;
633                 case UAC1_EXTENSION_UNIT:
634                         strcpy(name, "Ext Unit"); return 8;
635                 case UAC_MIXER_UNIT:
636                         strcpy(name, "Mixer"); return 5;
637                 default:
638                         return sprintf(name, "Unit %d", iterm->id);
639                 }
640         }
641
642         switch (iterm->type & 0xff00) {
643         case 0x0100:
644                 strcpy(name, "PCM"); return 3;
645         case 0x0200:
646                 strcpy(name, "Mic"); return 3;
647         case 0x0400:
648                 strcpy(name, "Headset"); return 7;
649         case 0x0500:
650                 strcpy(name, "Phone"); return 5;
651         }
652
653         for (names = iterm_names; names->type; names++)
654                 if (names->type == iterm->type) {
655                         strcpy(name, names->name);
656                         return strlen(names->name);
657                 }
658         return 0;
659 }
660
661
662 /*
663  * parse the source unit recursively until it reaches to a terminal
664  * or a branched unit.
665  */
666 static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
667 {
668         int err;
669         void *p1;
670
671         memset(term, 0, sizeof(*term));
672         while ((p1 = find_audio_control_unit(state, id)) != NULL) {
673                 unsigned char *hdr = p1;
674                 term->id = id;
675                 switch (hdr[2]) {
676                 case UAC_INPUT_TERMINAL:
677                         if (state->mixer->protocol == UAC_VERSION_1) {
678                                 struct uac_input_terminal_descriptor *d = p1;
679                                 term->type = le16_to_cpu(d->wTerminalType);
680                                 term->channels = d->bNrChannels;
681                                 term->chconfig = le16_to_cpu(d->wChannelConfig);
682                                 term->name = d->iTerminal;
683                         } else { /* UAC_VERSION_2 */
684                                 struct uac2_input_terminal_descriptor *d = p1;
685                                 term->type = le16_to_cpu(d->wTerminalType);
686                                 term->channels = d->bNrChannels;
687                                 term->chconfig = le32_to_cpu(d->bmChannelConfig);
688                                 term->name = d->iTerminal;
689
690                                 /* call recursively to get the clock selectors */
691                                 err = check_input_term(state, d->bCSourceID, term);
692                                 if (err < 0)
693                                         return err;
694                         }
695                         return 0;
696                 case UAC_FEATURE_UNIT: {
697                         /* the header is the same for v1 and v2 */
698                         struct uac_feature_unit_descriptor *d = p1;
699                         id = d->bSourceID;
700                         break; /* continue to parse */
701                 }
702                 case UAC_MIXER_UNIT: {
703                         struct uac_mixer_unit_descriptor *d = p1;
704                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
705                         term->channels = uac_mixer_unit_bNrChannels(d);
706                         term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
707                         term->name = uac_mixer_unit_iMixer(d);
708                         return 0;
709                 }
710                 case UAC_SELECTOR_UNIT:
711                 case UAC2_CLOCK_SELECTOR: {
712                         struct uac_selector_unit_descriptor *d = p1;
713                         /* call recursively to retrieve the channel info */
714                         err = check_input_term(state, d->baSourceID[0], term);
715                         if (err < 0)
716                                 return err;
717                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
718                         term->id = id;
719                         term->name = uac_selector_unit_iSelector(d);
720                         return 0;
721                 }
722                 case UAC1_PROCESSING_UNIT:
723                 case UAC1_EXTENSION_UNIT:
724                 /* UAC2_PROCESSING_UNIT_V2 */
725                 /* UAC2_EFFECT_UNIT */
726                 case UAC2_EXTENSION_UNIT_V2: {
727                         struct uac_processing_unit_descriptor *d = p1;
728
729                         if (state->mixer->protocol == UAC_VERSION_2 &&
730                                 hdr[2] == UAC2_EFFECT_UNIT) {
731                                 /* UAC2/UAC1 unit IDs overlap here in an
732                                  * uncompatible way. Ignore this unit for now.
733                                  */
734                                 return 0;
735                         }
736
737                         if (d->bNrInPins) {
738                                 id = d->baSourceID[0];
739                                 break; /* continue to parse */
740                         }
741                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
742                         term->channels = uac_processing_unit_bNrChannels(d);
743                         term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
744                         term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
745                         return 0;
746                 }
747                 case UAC2_CLOCK_SOURCE: {
748                         struct uac_clock_source_descriptor *d = p1;
749                         term->type = d->bDescriptorSubtype << 16; /* virtual type */
750                         term->id = id;
751                         term->name = d->iClockSource;
752                         return 0;
753                 }
754                 default:
755                         return -ENODEV;
756                 }
757         }
758         return -ENODEV;
759 }
760
761
762 /*
763  * Feature Unit
764  */
765
766 /* feature unit control information */
767 struct usb_feature_control_info {
768         const char *name;
769         unsigned int type;      /* control type (mute, volume, etc.) */
770 };
771
772 static struct usb_feature_control_info audio_feature_info[] = {
773         { "Mute",                       USB_MIXER_INV_BOOLEAN },
774         { "Volume",                     USB_MIXER_S16 },
775         { "Tone Control - Bass",        USB_MIXER_S8 },
776         { "Tone Control - Mid",         USB_MIXER_S8 },
777         { "Tone Control - Treble",      USB_MIXER_S8 },
778         { "Graphic Equalizer",          USB_MIXER_S8 }, /* FIXME: not implemeted yet */
779         { "Auto Gain Control",          USB_MIXER_BOOLEAN },
780         { "Delay Control",              USB_MIXER_U16 },
781         { "Bass Boost",                 USB_MIXER_BOOLEAN },
782         { "Loudness",                   USB_MIXER_BOOLEAN },
783         /* UAC2 specific */
784         { "Input Gain Control",         USB_MIXER_U16 },
785         { "Input Gain Pad Control",     USB_MIXER_BOOLEAN },
786         { "Phase Inverter Control",     USB_MIXER_BOOLEAN },
787 };
788
789
790 /* private_free callback */
791 static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
792 {
793         kfree(kctl->private_data);
794         kctl->private_data = NULL;
795 }
796
797
798 /*
799  * interface to ALSA control for feature/mixer units
800  */
801
802 /* volume control quirks */
803 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
804                                   struct snd_kcontrol *kctl)
805 {
806         switch (cval->mixer->chip->usb_id) {
807         case USB_ID(0x0471, 0x0101):
808         case USB_ID(0x0471, 0x0104):
809         case USB_ID(0x0471, 0x0105):
810         case USB_ID(0x0672, 0x1041):
811         /* quirk for UDA1321/N101.
812          * note that detection between firmware 2.1.1.7 (N101)
813          * and later 2.1.1.21 is not very clear from datasheets.
814          * I hope that the min value is -15360 for newer firmware --jk
815          */
816                 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
817                     cval->min == -15616) {
818                         snd_printk(KERN_INFO
819                                  "set volume quirk for UDA1321/N101 chip\n");
820                         cval->max = -256;
821                 }
822                 break;
823
824         case USB_ID(0x046d, 0x09a4):
825                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
826                         snd_printk(KERN_INFO
827                                 "set volume quirk for QuickCam E3500\n");
828                         cval->min = 6080;
829                         cval->max = 8768;
830                         cval->res = 192;
831                 }
832                 break;
833
834         case USB_ID(0x046d, 0x0808):
835         case USB_ID(0x046d, 0x0809):
836         case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
837         case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
838         case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
839         case USB_ID(0x046d, 0x0991):
840         /* Most audio usb devices lie about volume resolution.
841          * Most Logitech webcams have res = 384.
842          * Proboly there is some logitech magic behind this number --fishor
843          */
844                 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
845                         snd_printk(KERN_INFO
846                                 "set resolution quirk: cval->res = 384\n");
847                         cval->res = 384;
848                 }
849                 break;
850
851         }
852 }
853
854 /*
855  * retrieve the minimum and maximum values for the specified control
856  */
857 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
858                                    int default_min, struct snd_kcontrol *kctl)
859 {
860         /* for failsafe */
861         cval->min = default_min;
862         cval->max = cval->min + 1;
863         cval->res = 1;
864         cval->dBmin = cval->dBmax = 0;
865
866         if (cval->val_type == USB_MIXER_BOOLEAN ||
867             cval->val_type == USB_MIXER_INV_BOOLEAN) {
868                 cval->initialized = 1;
869         } else {
870                 int minchn = 0;
871                 if (cval->cmask) {
872                         int i;
873                         for (i = 0; i < MAX_CHANNELS; i++)
874                                 if (cval->cmask & (1 << i)) {
875                                         minchn = i + 1;
876                                         break;
877                                 }
878                 }
879                 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
880                     get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
881                         snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
882                                    cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
883                         return -EINVAL;
884                 }
885                 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
886                         cval->res = 1;
887                 } else {
888                         int last_valid_res = cval->res;
889
890                         while (cval->res > 1) {
891                                 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
892                                                                 (cval->control << 8) | minchn, cval->res / 2) < 0)
893                                         break;
894                                 cval->res /= 2;
895                         }
896                         if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
897                                 cval->res = last_valid_res;
898                 }
899                 if (cval->res == 0)
900                         cval->res = 1;
901
902                 /* Additional checks for the proper resolution
903                  *
904                  * Some devices report smaller resolutions than actually
905                  * reacting.  They don't return errors but simply clip
906                  * to the lower aligned value.
907                  */
908                 if (cval->min + cval->res < cval->max) {
909                         int last_valid_res = cval->res;
910                         int saved, test, check;
911                         get_cur_mix_raw(cval, minchn, &saved);
912                         for (;;) {
913                                 test = saved;
914                                 if (test < cval->max)
915                                         test += cval->res;
916                                 else
917                                         test -= cval->res;
918                                 if (test < cval->min || test > cval->max ||
919                                     set_cur_mix_value(cval, minchn, 0, test) ||
920                                     get_cur_mix_raw(cval, minchn, &check)) {
921                                         cval->res = last_valid_res;
922                                         break;
923                                 }
924                                 if (test == check)
925                                         break;
926                                 cval->res *= 2;
927                         }
928                         set_cur_mix_value(cval, minchn, 0, saved);
929                 }
930
931                 cval->initialized = 1;
932         }
933
934         if (kctl)
935                 volume_control_quirks(cval, kctl);
936
937         /* USB descriptions contain the dB scale in 1/256 dB unit
938          * while ALSA TLV contains in 1/100 dB unit
939          */
940         cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
941         cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
942         if (cval->dBmin > cval->dBmax) {
943                 /* something is wrong; assume it's either from/to 0dB */
944                 if (cval->dBmin < 0)
945                         cval->dBmax = 0;
946                 else if (cval->dBmin > 0)
947                         cval->dBmin = 0;
948                 if (cval->dBmin > cval->dBmax) {
949                         /* totally crap, return an error */
950                         return -EINVAL;
951                 }
952         }
953
954         return 0;
955 }
956
957 #define get_min_max(cval, def)  get_min_max_with_quirks(cval, def, NULL)
958
959 /* get a feature/mixer unit info */
960 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
961 {
962         struct usb_mixer_elem_info *cval = kcontrol->private_data;
963
964         if (cval->val_type == USB_MIXER_BOOLEAN ||
965             cval->val_type == USB_MIXER_INV_BOOLEAN)
966                 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
967         else
968                 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
969         uinfo->count = cval->channels;
970         if (cval->val_type == USB_MIXER_BOOLEAN ||
971             cval->val_type == USB_MIXER_INV_BOOLEAN) {
972                 uinfo->value.integer.min = 0;
973                 uinfo->value.integer.max = 1;
974         } else {
975                 if (!cval->initialized) {
976                         get_min_max_with_quirks(cval, 0, kcontrol);
977                         if (cval->initialized && cval->dBmin >= cval->dBmax) {
978                                 kcontrol->vd[0].access &= 
979                                         ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
980                                           SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
981                                 snd_ctl_notify(cval->mixer->chip->card,
982                                                SNDRV_CTL_EVENT_MASK_INFO,
983                                                &kcontrol->id);
984                         }
985                 }
986                 uinfo->value.integer.min = 0;
987                 uinfo->value.integer.max =
988                         (cval->max - cval->min + cval->res - 1) / cval->res;
989         }
990         return 0;
991 }
992
993 /* get the current value from feature/mixer unit */
994 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
995 {
996         struct usb_mixer_elem_info *cval = kcontrol->private_data;
997         int c, cnt, val, err;
998
999         ucontrol->value.integer.value[0] = cval->min;
1000         if (cval->cmask) {
1001                 cnt = 0;
1002                 for (c = 0; c < MAX_CHANNELS; c++) {
1003                         if (!(cval->cmask & (1 << c)))
1004                                 continue;
1005                         err = get_cur_mix_value(cval, c + 1, cnt, &val);
1006                         if (err < 0)
1007                                 return cval->mixer->ignore_ctl_error ? 0 : err;
1008                         val = get_relative_value(cval, val);
1009                         ucontrol->value.integer.value[cnt] = val;
1010                         cnt++;
1011                 }
1012                 return 0;
1013         } else {
1014                 /* master channel */
1015                 err = get_cur_mix_value(cval, 0, 0, &val);
1016                 if (err < 0)
1017                         return cval->mixer->ignore_ctl_error ? 0 : err;
1018                 val = get_relative_value(cval, val);
1019                 ucontrol->value.integer.value[0] = val;
1020         }
1021         return 0;
1022 }
1023
1024 /* put the current value to feature/mixer unit */
1025 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1026 {
1027         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1028         int c, cnt, val, oval, err;
1029         int changed = 0;
1030
1031         if (cval->cmask) {
1032                 cnt = 0;
1033                 for (c = 0; c < MAX_CHANNELS; c++) {
1034                         if (!(cval->cmask & (1 << c)))
1035                                 continue;
1036                         err = get_cur_mix_value(cval, c + 1, cnt, &oval);
1037                         if (err < 0)
1038                                 return cval->mixer->ignore_ctl_error ? 0 : err;
1039                         val = ucontrol->value.integer.value[cnt];
1040                         val = get_abs_value(cval, val);
1041                         if (oval != val) {
1042                                 set_cur_mix_value(cval, c + 1, cnt, val);
1043                                 changed = 1;
1044                         }
1045                         cnt++;
1046                 }
1047         } else {
1048                 /* master channel */
1049                 err = get_cur_mix_value(cval, 0, 0, &oval);
1050                 if (err < 0)
1051                         return cval->mixer->ignore_ctl_error ? 0 : err;
1052                 val = ucontrol->value.integer.value[0];
1053                 val = get_abs_value(cval, val);
1054                 if (val != oval) {
1055                         set_cur_mix_value(cval, 0, 0, val);
1056                         changed = 1;
1057                 }
1058         }
1059         return changed;
1060 }
1061
1062 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1063         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1064         .name = "", /* will be filled later manually */
1065         .info = mixer_ctl_feature_info,
1066         .get = mixer_ctl_feature_get,
1067         .put = mixer_ctl_feature_put,
1068 };
1069
1070 /* the read-only variant */
1071 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1072         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1073         .name = "", /* will be filled later manually */
1074         .info = mixer_ctl_feature_info,
1075         .get = mixer_ctl_feature_get,
1076         .put = NULL,
1077 };
1078
1079 /* This symbol is exported in order to allow the mixer quirks to
1080  * hook up to the standard feature unit control mechanism */
1081 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1082
1083 /*
1084  * build a feature control
1085  */
1086
1087 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1088 {
1089         return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1090 }
1091
1092 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1093                               unsigned int ctl_mask, int control,
1094                               struct usb_audio_term *iterm, int unitid,
1095                               int readonly_mask)
1096 {
1097         struct uac_feature_unit_descriptor *desc = raw_desc;
1098         unsigned int len = 0;
1099         int mapped_name = 0;
1100         int nameid = uac_feature_unit_iFeature(desc);
1101         struct snd_kcontrol *kctl;
1102         struct usb_mixer_elem_info *cval;
1103         const struct usbmix_name_map *map;
1104         unsigned int range;
1105
1106         control++; /* change from zero-based to 1-based value */
1107
1108         if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1109                 /* FIXME: not supported yet */
1110                 return;
1111         }
1112
1113         map = find_map(state, unitid, control);
1114         if (check_ignored_ctl(map))
1115                 return;
1116
1117         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1118         if (! cval) {
1119                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1120                 return;
1121         }
1122         cval->mixer = state->mixer;
1123         cval->id = unitid;
1124         cval->control = control;
1125         cval->cmask = ctl_mask;
1126         cval->val_type = audio_feature_info[control-1].type;
1127         if (ctl_mask == 0) {
1128                 cval->channels = 1;     /* master channel */
1129                 cval->master_readonly = readonly_mask;
1130         } else {
1131                 int i, c = 0;
1132                 for (i = 0; i < 16; i++)
1133                         if (ctl_mask & (1 << i))
1134                                 c++;
1135                 cval->channels = c;
1136                 cval->ch_readonly = readonly_mask;
1137         }
1138
1139         /* if all channels in the mask are marked read-only, make the control
1140          * read-only. set_cur_mix_value() will check the mask again and won't
1141          * issue write commands to read-only channels. */
1142         if (cval->channels == readonly_mask)
1143                 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1144         else
1145                 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1146
1147         if (! kctl) {
1148                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1149                 kfree(cval);
1150                 return;
1151         }
1152         kctl->private_free = usb_mixer_elem_free;
1153
1154         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1155         mapped_name = len != 0;
1156         if (! len && nameid)
1157                 len = snd_usb_copy_string_desc(state, nameid,
1158                                 kctl->id.name, sizeof(kctl->id.name));
1159
1160         /* get min/max values */
1161         get_min_max_with_quirks(cval, 0, kctl);
1162
1163         switch (control) {
1164         case UAC_FU_MUTE:
1165         case UAC_FU_VOLUME:
1166                 /* determine the control name.  the rule is:
1167                  * - if a name id is given in descriptor, use it.
1168                  * - if the connected input can be determined, then use the name
1169                  *   of terminal type.
1170                  * - if the connected output can be determined, use it.
1171                  * - otherwise, anonymous name.
1172                  */
1173                 if (! len) {
1174                         len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1175                         if (! len)
1176                                 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1177                         if (! len)
1178                                 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1179                                                "Feature %d", unitid);
1180                 }
1181                 /* determine the stream direction:
1182                  * if the connected output is USB stream, then it's likely a
1183                  * capture stream.  otherwise it should be playback (hopefully :)
1184                  */
1185                 if (! mapped_name && ! (state->oterm.type >> 16)) {
1186                         if ((state->oterm.type & 0xff00) == 0x0100) {
1187                                 len = append_ctl_name(kctl, " Capture");
1188                         } else {
1189                                 len = append_ctl_name(kctl, " Playback");
1190                         }
1191                 }
1192                 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1193                                 " Switch" : " Volume");
1194                 if (control == UAC_FU_VOLUME) {
1195                         check_mapped_dB(map, cval);
1196                         if (cval->dBmin < cval->dBmax || !cval->initialized) {
1197                                 kctl->tlv.c = mixer_vol_tlv;
1198                                 kctl->vd[0].access |= 
1199                                         SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1200                                         SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1201                         }
1202                 }
1203                 break;
1204
1205         default:
1206                 if (! len)
1207                         strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1208                                 sizeof(kctl->id.name));
1209                 break;
1210         }
1211
1212         range = (cval->max - cval->min) / cval->res;
1213         /* Are there devices with volume range more than 255? I use a bit more
1214          * to be sure. 384 is a resolution magic number found on Logitech
1215          * devices. It will definitively catch all buggy Logitech devices.
1216          */
1217         if (range > 384) {
1218                 snd_printk(KERN_WARNING "usb_audio: Warning! Unlikely big "
1219                            "volume range (=%u), cval->res is probably wrong.",
1220                            range);
1221                 snd_printk(KERN_WARNING "usb_audio: [%d] FU [%s] ch = %d, "
1222                            "val = %d/%d/%d", cval->id,
1223                            kctl->id.name, cval->channels,
1224                            cval->min, cval->max, cval->res);
1225         }
1226
1227         snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1228                     cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
1229         snd_usb_mixer_add_control(state->mixer, kctl);
1230 }
1231
1232
1233
1234 /*
1235  * parse a feature unit
1236  *
1237  * most of controls are defined here.
1238  */
1239 static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
1240 {
1241         int channels, i, j;
1242         struct usb_audio_term iterm;
1243         unsigned int master_bits, first_ch_bits;
1244         int err, csize;
1245         struct uac_feature_unit_descriptor *hdr = _ftr;
1246         __u8 *bmaControls;
1247
1248         if (state->mixer->protocol == UAC_VERSION_1) {
1249                 csize = hdr->bControlSize;
1250                 if (!csize) {
1251                         snd_printdd(KERN_ERR "usbaudio: unit %u: "
1252                                     "invalid bControlSize == 0\n", unitid);
1253                         return -EINVAL;
1254                 }
1255                 channels = (hdr->bLength - 7) / csize - 1;
1256                 bmaControls = hdr->bmaControls;
1257                 if (hdr->bLength < 7 + csize) {
1258                         snd_printk(KERN_ERR "usbaudio: unit %u: "
1259                                    "invalid UAC_FEATURE_UNIT descriptor\n",
1260                                    unitid);
1261                         return -EINVAL;
1262                 }
1263         } else {
1264                 struct uac2_feature_unit_descriptor *ftr = _ftr;
1265                 csize = 4;
1266                 channels = (hdr->bLength - 6) / 4 - 1;
1267                 bmaControls = ftr->bmaControls;
1268                 if (hdr->bLength < 6 + csize) {
1269                         snd_printk(KERN_ERR "usbaudio: unit %u: "
1270                                    "invalid UAC_FEATURE_UNIT descriptor\n",
1271                                    unitid);
1272                         return -EINVAL;
1273                 }
1274         }
1275
1276         /* parse the source unit */
1277         if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1278                 return err;
1279
1280         /* determine the input source type and name */
1281         err = check_input_term(state, hdr->bSourceID, &iterm);
1282         if (err < 0)
1283                 return err;
1284
1285         master_bits = snd_usb_combine_bytes(bmaControls, csize);
1286         /* master configuration quirks */
1287         switch (state->chip->usb_id) {
1288         case USB_ID(0x08bb, 0x2702):
1289                 snd_printk(KERN_INFO
1290                            "usbmixer: master volume quirk for PCM2702 chip\n");
1291                 /* disable non-functional volume control */
1292                 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1293                 break;
1294         }
1295         if (channels > 0)
1296                 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1297         else
1298                 first_ch_bits = 0;
1299
1300         if (state->mixer->protocol == UAC_VERSION_1) {
1301                 /* check all control types */
1302                 for (i = 0; i < 10; i++) {
1303                         unsigned int ch_bits = 0;
1304                         for (j = 0; j < channels; j++) {
1305                                 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1306                                 if (mask & (1 << i))
1307                                         ch_bits |= (1 << j);
1308                         }
1309                         /* audio class v1 controls are never read-only */
1310                         if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1311                                 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1312                         if (master_bits & (1 << i))
1313                                 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
1314                 }
1315         } else { /* UAC_VERSION_2 */
1316                 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1317                         unsigned int ch_bits = 0;
1318                         unsigned int ch_read_only = 0;
1319
1320                         for (j = 0; j < channels; j++) {
1321                                 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1322                                 if (uac2_control_is_readable(mask, i)) {
1323                                         ch_bits |= (1 << j);
1324                                         if (!uac2_control_is_writeable(mask, i))
1325                                                 ch_read_only |= (1 << j);
1326                                 }
1327                         }
1328
1329                         /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1330                          * are marked read-only in the descriptors. Otherwise, the control will be
1331                          * reported as writeable, but the driver will not actually issue a write
1332                          * command for read-only channels */
1333                         if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1334                                 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
1335                         if (uac2_control_is_readable(master_bits, i))
1336                                 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1337                                                   !uac2_control_is_writeable(master_bits, i));
1338                 }
1339         }
1340
1341         return 0;
1342 }
1343
1344
1345 /*
1346  * Mixer Unit
1347  */
1348
1349 /*
1350  * build a mixer unit control
1351  *
1352  * the callbacks are identical with feature unit.
1353  * input channel number (zero based) is given in control field instead.
1354  */
1355
1356 static void build_mixer_unit_ctl(struct mixer_build *state,
1357                                  struct uac_mixer_unit_descriptor *desc,
1358                                  int in_pin, int in_ch, int unitid,
1359                                  struct usb_audio_term *iterm)
1360 {
1361         struct usb_mixer_elem_info *cval;
1362         unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1363         unsigned int i, len;
1364         struct snd_kcontrol *kctl;
1365         const struct usbmix_name_map *map;
1366
1367         map = find_map(state, unitid, 0);
1368         if (check_ignored_ctl(map))
1369                 return;
1370
1371         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1372         if (! cval)
1373                 return;
1374
1375         cval->mixer = state->mixer;
1376         cval->id = unitid;
1377         cval->control = in_ch + 1; /* based on 1 */
1378         cval->val_type = USB_MIXER_S16;
1379         for (i = 0; i < num_outs; i++) {
1380                 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
1381                         cval->cmask |= (1 << i);
1382                         cval->channels++;
1383                 }
1384         }
1385
1386         /* get min/max values */
1387         get_min_max(cval, 0);
1388
1389         kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1390         if (! kctl) {
1391                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1392                 kfree(cval);
1393                 return;
1394         }
1395         kctl->private_free = usb_mixer_elem_free;
1396
1397         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1398         if (! len)
1399                 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1400         if (! len)
1401                 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1402         append_ctl_name(kctl, " Volume");
1403
1404         snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1405                     cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1406         snd_usb_mixer_add_control(state->mixer, kctl);
1407 }
1408
1409
1410 /*
1411  * parse a mixer unit
1412  */
1413 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
1414 {
1415         struct uac_mixer_unit_descriptor *desc = raw_desc;
1416         struct usb_audio_term iterm;
1417         int input_pins, num_ins, num_outs;
1418         int pin, ich, err;
1419
1420         if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
1421                 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1422                 return -EINVAL;
1423         }
1424         /* no bmControls field (e.g. Maya44) -> ignore */
1425         if (desc->bLength <= 10 + input_pins) {
1426                 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1427                 return 0;
1428         }
1429
1430         num_ins = 0;
1431         ich = 0;
1432         for (pin = 0; pin < input_pins; pin++) {
1433                 err = parse_audio_unit(state, desc->baSourceID[pin]);
1434                 if (err < 0)
1435                         return err;
1436                 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1437                 if (err < 0)
1438                         return err;
1439                 num_ins += iterm.channels;
1440                 for (; ich < num_ins; ++ich) {
1441                         int och, ich_has_controls = 0;
1442
1443                         for (och = 0; och < num_outs; ++och) {
1444                                 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
1445                                                         ich, och, num_outs)) {
1446                                         ich_has_controls = 1;
1447                                         break;
1448                                 }
1449                         }
1450                         if (ich_has_controls)
1451                                 build_mixer_unit_ctl(state, desc, pin, ich,
1452                                                      unitid, &iterm);
1453                 }
1454         }
1455         return 0;
1456 }
1457
1458
1459 /*
1460  * Processing Unit / Extension Unit
1461  */
1462
1463 /* get callback for processing/extension unit */
1464 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1465 {
1466         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1467         int err, val;
1468
1469         err = get_cur_ctl_value(cval, cval->control << 8, &val);
1470         if (err < 0 && cval->mixer->ignore_ctl_error) {
1471                 ucontrol->value.integer.value[0] = cval->min;
1472                 return 0;
1473         }
1474         if (err < 0)
1475                 return err;
1476         val = get_relative_value(cval, val);
1477         ucontrol->value.integer.value[0] = val;
1478         return 0;
1479 }
1480
1481 /* put callback for processing/extension unit */
1482 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1483 {
1484         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1485         int val, oval, err;
1486
1487         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1488         if (err < 0) {
1489                 if (cval->mixer->ignore_ctl_error)
1490                         return 0;
1491                 return err;
1492         }
1493         val = ucontrol->value.integer.value[0];
1494         val = get_abs_value(cval, val);
1495         if (val != oval) {
1496                 set_cur_ctl_value(cval, cval->control << 8, val);
1497                 return 1;
1498         }
1499         return 0;
1500 }
1501
1502 /* alsa control interface for processing/extension unit */
1503 static struct snd_kcontrol_new mixer_procunit_ctl = {
1504         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1505         .name = "", /* will be filled later */
1506         .info = mixer_ctl_feature_info,
1507         .get = mixer_ctl_procunit_get,
1508         .put = mixer_ctl_procunit_put,
1509 };
1510
1511
1512 /*
1513  * predefined data for processing units
1514  */
1515 struct procunit_value_info {
1516         int control;
1517         char *suffix;
1518         int val_type;
1519         int min_value;
1520 };
1521
1522 struct procunit_info {
1523         int type;
1524         char *name;
1525         struct procunit_value_info *values;
1526 };
1527
1528 static struct procunit_value_info updown_proc_info[] = {
1529         { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1530         { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1531         { 0 }
1532 };
1533 static struct procunit_value_info prologic_proc_info[] = {
1534         { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1535         { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1536         { 0 }
1537 };
1538 static struct procunit_value_info threed_enh_proc_info[] = {
1539         { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1540         { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1541         { 0 }
1542 };
1543 static struct procunit_value_info reverb_proc_info[] = {
1544         { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1545         { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1546         { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1547         { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1548         { 0 }
1549 };
1550 static struct procunit_value_info chorus_proc_info[] = {
1551         { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1552         { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1553         { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1554         { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1555         { 0 }
1556 };
1557 static struct procunit_value_info dcr_proc_info[] = {
1558         { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1559         { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1560         { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1561         { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1562         { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1563         { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1564         { 0 }
1565 };
1566
1567 static struct procunit_info procunits[] = {
1568         { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1569         { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1570         { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1571         { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1572         { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1573         { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1574         { 0 },
1575 };
1576 /*
1577  * predefined data for extension units
1578  */
1579 static struct procunit_value_info clock_rate_xu_info[] = {
1580         { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1581         { 0 }
1582 };
1583 static struct procunit_value_info clock_source_xu_info[] = {
1584         { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1585         { 0 }
1586 };
1587 static struct procunit_value_info spdif_format_xu_info[] = {
1588         { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1589         { 0 }
1590 };
1591 static struct procunit_value_info soft_limit_xu_info[] = {
1592         { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1593         { 0 }
1594 };
1595 static struct procunit_info extunits[] = {
1596         { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1597         { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1598         { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1599         { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1600         { 0 }
1601 };
1602 /*
1603  * build a processing/extension unit
1604  */
1605 static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
1606 {
1607         struct uac_processing_unit_descriptor *desc = raw_desc;
1608         int num_ins = desc->bNrInPins;
1609         struct usb_mixer_elem_info *cval;
1610         struct snd_kcontrol *kctl;
1611         int i, err, nameid, type, len;
1612         struct procunit_info *info;
1613         struct procunit_value_info *valinfo;
1614         const struct usbmix_name_map *map;
1615         static struct procunit_value_info default_value_info[] = {
1616                 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1617                 { 0 }
1618         };
1619         static struct procunit_info default_info = {
1620                 0, NULL, default_value_info
1621         };
1622
1623         if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1624             desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1625                 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1626                 return -EINVAL;
1627         }
1628
1629         for (i = 0; i < num_ins; i++) {
1630                 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1631                         return err;
1632         }
1633
1634         type = le16_to_cpu(desc->wProcessType);
1635         for (info = list; info && info->type; info++)
1636                 if (info->type == type)
1637                         break;
1638         if (! info || ! info->type)
1639                 info = &default_info;
1640
1641         for (valinfo = info->values; valinfo->control; valinfo++) {
1642                 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1643
1644                 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1645                         continue;
1646                 map = find_map(state, unitid, valinfo->control);
1647                 if (check_ignored_ctl(map))
1648                         continue;
1649                 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1650                 if (! cval) {
1651                         snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1652                         return -ENOMEM;
1653                 }
1654                 cval->mixer = state->mixer;
1655                 cval->id = unitid;
1656                 cval->control = valinfo->control;
1657                 cval->val_type = valinfo->val_type;
1658                 cval->channels = 1;
1659
1660                 /* get min/max values */
1661                 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1662                         __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1663                         /* FIXME: hard-coded */
1664                         cval->min = 1;
1665                         cval->max = control_spec[0];
1666                         cval->res = 1;
1667                         cval->initialized = 1;
1668                 } else {
1669                         if (type == USB_XU_CLOCK_RATE) {
1670                                 /* E-Mu USB 0404/0202/TrackerPre/0204
1671                                  * samplerate control quirk
1672                                  */
1673                                 cval->min = 0;
1674                                 cval->max = 5;
1675                                 cval->res = 1;
1676                                 cval->initialized = 1;
1677                         } else
1678                                 get_min_max(cval, valinfo->min_value);
1679                 }
1680
1681                 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1682                 if (! kctl) {
1683                         snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1684                         kfree(cval);
1685                         return -ENOMEM;
1686                 }
1687                 kctl->private_free = usb_mixer_elem_free;
1688
1689                 if (check_mapped_name(map, kctl->id.name,
1690                                                 sizeof(kctl->id.name)))
1691                         /* nothing */ ;
1692                 else if (info->name)
1693                         strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1694                 else {
1695                         nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1696                         len = 0;
1697                         if (nameid)
1698                                 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1699                         if (! len)
1700                                 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1701                 }
1702                 append_ctl_name(kctl, " ");
1703                 append_ctl_name(kctl, valinfo->suffix);
1704
1705                 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1706                             cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1707                 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
1708                         return err;
1709         }
1710         return 0;
1711 }
1712
1713
1714 static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
1715 {
1716         return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
1717 }
1718
1719 static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
1720 {
1721         /* Note that we parse extension units with processing unit descriptors.
1722          * That's ok as the layout is the same */
1723         return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
1724 }
1725
1726
1727 /*
1728  * Selector Unit
1729  */
1730
1731 /* info callback for selector unit
1732  * use an enumerator type for routing
1733  */
1734 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1735 {
1736         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1737         const char **itemlist = (const char **)kcontrol->private_value;
1738
1739         if (snd_BUG_ON(!itemlist))
1740                 return -EINVAL;
1741         return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
1742 }
1743
1744 /* get callback for selector unit */
1745 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1746 {
1747         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1748         int val, err;
1749
1750         err = get_cur_ctl_value(cval, cval->control << 8, &val);
1751         if (err < 0) {
1752                 if (cval->mixer->ignore_ctl_error) {
1753                         ucontrol->value.enumerated.item[0] = 0;
1754                         return 0;
1755                 }
1756                 return err;
1757         }
1758         val = get_relative_value(cval, val);
1759         ucontrol->value.enumerated.item[0] = val;
1760         return 0;
1761 }
1762
1763 /* put callback for selector unit */
1764 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1765 {
1766         struct usb_mixer_elem_info *cval = kcontrol->private_data;
1767         int val, oval, err;
1768
1769         err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1770         if (err < 0) {
1771                 if (cval->mixer->ignore_ctl_error)
1772                         return 0;
1773                 return err;
1774         }
1775         val = ucontrol->value.enumerated.item[0];
1776         val = get_abs_value(cval, val);
1777         if (val != oval) {
1778                 set_cur_ctl_value(cval, cval->control << 8, val);
1779                 return 1;
1780         }
1781         return 0;
1782 }
1783
1784 /* alsa control interface for selector unit */
1785 static struct snd_kcontrol_new mixer_selectunit_ctl = {
1786         .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1787         .name = "", /* will be filled later */
1788         .info = mixer_ctl_selector_info,
1789         .get = mixer_ctl_selector_get,
1790         .put = mixer_ctl_selector_put,
1791 };
1792
1793
1794 /* private free callback.
1795  * free both private_data and private_value
1796  */
1797 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1798 {
1799         int i, num_ins = 0;
1800
1801         if (kctl->private_data) {
1802                 struct usb_mixer_elem_info *cval = kctl->private_data;
1803                 num_ins = cval->max;
1804                 kfree(cval);
1805                 kctl->private_data = NULL;
1806         }
1807         if (kctl->private_value) {
1808                 char **itemlist = (char **)kctl->private_value;
1809                 for (i = 0; i < num_ins; i++)
1810                         kfree(itemlist[i]);
1811                 kfree(itemlist);
1812                 kctl->private_value = 0;
1813         }
1814 }
1815
1816 /*
1817  * parse a selector unit
1818  */
1819 static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
1820 {
1821         struct uac_selector_unit_descriptor *desc = raw_desc;
1822         unsigned int i, nameid, len;
1823         int err;
1824         struct usb_mixer_elem_info *cval;
1825         struct snd_kcontrol *kctl;
1826         const struct usbmix_name_map *map;
1827         char **namelist;
1828
1829         if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
1830                 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1831                 return -EINVAL;
1832         }
1833
1834         for (i = 0; i < desc->bNrInPins; i++) {
1835                 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1836                         return err;
1837         }
1838
1839         if (desc->bNrInPins == 1) /* only one ? nonsense! */
1840                 return 0;
1841
1842         map = find_map(state, unitid, 0);
1843         if (check_ignored_ctl(map))
1844                 return 0;
1845
1846         cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1847         if (! cval) {
1848                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1849                 return -ENOMEM;
1850         }
1851         cval->mixer = state->mixer;
1852         cval->id = unitid;
1853         cval->val_type = USB_MIXER_U8;
1854         cval->channels = 1;
1855         cval->min = 1;
1856         cval->max = desc->bNrInPins;
1857         cval->res = 1;
1858         cval->initialized = 1;
1859
1860         if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1861                 cval->control = UAC2_CX_CLOCK_SELECTOR;
1862         else
1863                 cval->control = 0;
1864
1865         namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
1866         if (! namelist) {
1867                 snd_printk(KERN_ERR "cannot malloc\n");
1868                 kfree(cval);
1869                 return -ENOMEM;
1870         }
1871 #define MAX_ITEM_NAME_LEN       64
1872         for (i = 0; i < desc->bNrInPins; i++) {
1873                 struct usb_audio_term iterm;
1874                 len = 0;
1875                 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1876                 if (! namelist[i]) {
1877                         snd_printk(KERN_ERR "cannot malloc\n");
1878                         while (i--)
1879                                 kfree(namelist[i]);
1880                         kfree(namelist);
1881                         kfree(cval);
1882                         return -ENOMEM;
1883                 }
1884                 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1885                                                  MAX_ITEM_NAME_LEN);
1886                 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
1887                         len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1888                 if (! len)
1889                         sprintf(namelist[i], "Input %d", i);
1890         }
1891
1892         kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1893         if (! kctl) {
1894                 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1895                 kfree(namelist);
1896                 kfree(cval);
1897                 return -ENOMEM;
1898         }
1899         kctl->private_value = (unsigned long)namelist;
1900         kctl->private_free = usb_mixer_selector_elem_free;
1901
1902         nameid = uac_selector_unit_iSelector(desc);
1903         len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1904         if (len)
1905                 ;
1906         else if (nameid)
1907                 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1908         else {
1909                 len = get_term_name(state, &state->oterm,
1910                                     kctl->id.name, sizeof(kctl->id.name), 0);
1911                 if (! len)
1912                         strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1913
1914                 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1915                         append_ctl_name(kctl, " Clock Source");
1916                 else if ((state->oterm.type & 0xff00) == 0x0100)
1917                         append_ctl_name(kctl, " Capture Source");
1918                 else
1919                         append_ctl_name(kctl, " Playback Source");
1920         }
1921
1922         snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1923                     cval->id, kctl->id.name, desc->bNrInPins);
1924         if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
1925                 return err;
1926
1927         return 0;
1928 }
1929
1930
1931 /*
1932  * parse an audio unit recursively
1933  */
1934
1935 static int parse_audio_unit(struct mixer_build *state, int unitid)
1936 {
1937         unsigned char *p1;
1938
1939         if (test_and_set_bit(unitid, state->unitbitmap))
1940                 return 0; /* the unit already visited */
1941
1942         p1 = find_audio_control_unit(state, unitid);
1943         if (!p1) {
1944                 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1945                 return -EINVAL;
1946         }
1947
1948         switch (p1[2]) {
1949         case UAC_INPUT_TERMINAL:
1950         case UAC2_CLOCK_SOURCE:
1951                 return 0; /* NOP */
1952         case UAC_MIXER_UNIT:
1953                 return parse_audio_mixer_unit(state, unitid, p1);
1954         case UAC_SELECTOR_UNIT:
1955         case UAC2_CLOCK_SELECTOR:
1956                 return parse_audio_selector_unit(state, unitid, p1);
1957         case UAC_FEATURE_UNIT:
1958                 return parse_audio_feature_unit(state, unitid, p1);
1959         case UAC1_PROCESSING_UNIT:
1960         /*   UAC2_EFFECT_UNIT has the same value */
1961                 if (state->mixer->protocol == UAC_VERSION_1)
1962                         return parse_audio_processing_unit(state, unitid, p1);
1963                 else
1964                         return 0; /* FIXME - effect units not implemented yet */
1965         case UAC1_EXTENSION_UNIT:
1966         /*   UAC2_PROCESSING_UNIT_V2 has the same value */
1967                 if (state->mixer->protocol == UAC_VERSION_1)
1968                         return parse_audio_extension_unit(state, unitid, p1);
1969                 else /* UAC_VERSION_2 */
1970                         return parse_audio_processing_unit(state, unitid, p1);
1971         case UAC2_EXTENSION_UNIT_V2:
1972                 return parse_audio_extension_unit(state, unitid, p1);
1973         default:
1974                 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1975                 return -EINVAL;
1976         }
1977 }
1978
1979 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1980 {
1981         kfree(mixer->id_elems);
1982         if (mixer->urb) {
1983                 kfree(mixer->urb->transfer_buffer);
1984                 usb_free_urb(mixer->urb);
1985         }
1986         usb_free_urb(mixer->rc_urb);
1987         kfree(mixer->rc_setup_packet);
1988         kfree(mixer);
1989 }
1990
1991 static int snd_usb_mixer_dev_free(struct snd_device *device)
1992 {
1993         struct usb_mixer_interface *mixer = device->device_data;
1994         snd_usb_mixer_free(mixer);
1995         return 0;
1996 }
1997
1998 /*
1999  * create mixer controls
2000  *
2001  * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2002  */
2003 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2004 {
2005         struct mixer_build state;
2006         int err;
2007         const struct usbmix_ctl_map *map;
2008         void *p;
2009
2010         memset(&state, 0, sizeof(state));
2011         state.chip = mixer->chip;
2012         state.mixer = mixer;
2013         state.buffer = mixer->hostif->extra;
2014         state.buflen = mixer->hostif->extralen;
2015
2016         /* check the mapping table */
2017         for (map = usbmix_ctl_maps; map->id; map++) {
2018                 if (map->id == state.chip->usb_id) {
2019                         state.map = map->map;
2020                         state.selector_map = map->selector_map;
2021                         mixer->ignore_ctl_error = map->ignore_ctl_error;
2022                         break;
2023                 }
2024         }
2025
2026         p = NULL;
2027         while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen,
2028                                             p, UAC_OUTPUT_TERMINAL)) != NULL) {
2029                 if (mixer->protocol == UAC_VERSION_1) {
2030                         struct uac1_output_terminal_descriptor *desc = p;
2031
2032                         if (desc->bLength < sizeof(*desc))
2033                                 continue; /* invalid descriptor? */
2034                         set_bit(desc->bTerminalID, state.unitbitmap);  /* mark terminal ID as visited */
2035                         state.oterm.id = desc->bTerminalID;
2036                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
2037                         state.oterm.name = desc->iTerminal;
2038                         err = parse_audio_unit(&state, desc->bSourceID);
2039                         if (err < 0 && err != -EINVAL)
2040                                 return err;
2041                 } else { /* UAC_VERSION_2 */
2042                         struct uac2_output_terminal_descriptor *desc = p;
2043
2044                         if (desc->bLength < sizeof(*desc))
2045                                 continue; /* invalid descriptor? */
2046                         set_bit(desc->bTerminalID, state.unitbitmap);  /* mark terminal ID as visited */
2047                         state.oterm.id = desc->bTerminalID;
2048                         state.oterm.type = le16_to_cpu(desc->wTerminalType);
2049                         state.oterm.name = desc->iTerminal;
2050                         err = parse_audio_unit(&state, desc->bSourceID);
2051                         if (err < 0 && err != -EINVAL)
2052                                 return err;
2053
2054                         /* for UAC2, use the same approach to also add the clock selectors */
2055                         err = parse_audio_unit(&state, desc->bCSourceID);
2056                         if (err < 0 && err != -EINVAL)
2057                                 return err;
2058                 }
2059         }
2060
2061         return 0;
2062 }
2063
2064 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2065 {
2066         struct usb_mixer_elem_info *info;
2067
2068         for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
2069                 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2070                                info->elem_id);
2071 }
2072
2073 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2074                                     int unitid,
2075                                     struct usb_mixer_elem_info *cval)
2076 {
2077         static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2078                                     "S8", "U8", "S16", "U16"};
2079         snd_iprintf(buffer, "  Unit: %i\n", unitid);
2080         if (cval->elem_id)
2081                 snd_iprintf(buffer, "    Control: name=\"%s\", index=%i\n",
2082                                 cval->elem_id->name, cval->elem_id->index);
2083         snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
2084                             "channels=%i, type=\"%s\"\n", cval->id,
2085                             cval->control, cval->cmask, cval->channels,
2086                             val_types[cval->val_type]);
2087         snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2088                             cval->min, cval->max, cval->dBmin, cval->dBmax);
2089 }
2090
2091 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2092                                     struct snd_info_buffer *buffer)
2093 {
2094         struct snd_usb_audio *chip = entry->private_data;
2095         struct usb_mixer_interface *mixer;
2096         struct usb_mixer_elem_info *cval;
2097         int unitid;
2098
2099         list_for_each_entry(mixer, &chip->mixer_list, list) {
2100                 snd_iprintf(buffer,
2101                         "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2102                                 chip->usb_id, snd_usb_ctrl_intf(chip),
2103                                 mixer->ignore_ctl_error);
2104                 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2105                 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2106                         for (cval = mixer->id_elems[unitid]; cval;
2107                                                 cval = cval->next_id_elem)
2108                                 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2109                 }
2110         }
2111 }
2112
2113 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2114                                        int attribute, int value, int index)
2115 {
2116         struct usb_mixer_elem_info *info;
2117         __u8 unitid = (index >> 8) & 0xff;
2118         __u8 control = (value >> 8) & 0xff;
2119         __u8 channel = value & 0xff;
2120
2121         if (channel >= MAX_CHANNELS) {
2122                 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2123                                 __func__, channel);
2124                 return;
2125         }
2126
2127         for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2128                 if (info->control != control)
2129                         continue;
2130
2131                 switch (attribute) {
2132                 case UAC2_CS_CUR:
2133                         /* invalidate cache, so the value is read from the device */
2134                         if (channel)
2135                                 info->cached &= ~(1 << channel);
2136                         else /* master channel */
2137                                 info->cached = 0;
2138
2139                         snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2140                                         info->elem_id);
2141                         break;
2142
2143                 case UAC2_CS_RANGE:
2144                         /* TODO */
2145                         break;
2146
2147                 case UAC2_CS_MEM:
2148                         /* TODO */
2149                         break;
2150
2151                 default:
2152                         snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2153                                                 attribute);
2154                         break;
2155                 } /* switch */
2156         }
2157 }
2158
2159 static void snd_usb_mixer_interrupt(struct urb *urb)
2160 {
2161         struct usb_mixer_interface *mixer = urb->context;
2162         int len = urb->actual_length;
2163         int ustatus = urb->status;
2164
2165         if (ustatus != 0)
2166                 goto requeue;
2167
2168         if (mixer->protocol == UAC_VERSION_1) {
2169                 struct uac1_status_word *status;
2170
2171                 for (status = urb->transfer_buffer;
2172                      len >= sizeof(*status);
2173                      len -= sizeof(*status), status++) {
2174                         snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
2175                                                 status->bStatusType,
2176                                                 status->bOriginator);
2177
2178                         /* ignore any notifications not from the control interface */
2179                         if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2180                                 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2181                                 continue;
2182
2183                         if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2184                                 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2185                         else
2186                                 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2187                 }
2188         } else { /* UAC_VERSION_2 */
2189                 struct uac2_interrupt_data_msg *msg;
2190
2191                 for (msg = urb->transfer_buffer;
2192                      len >= sizeof(*msg);
2193                      len -= sizeof(*msg), msg++) {
2194                         /* drop vendor specific and endpoint requests */
2195                         if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2196                             (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2197                                 continue;
2198
2199                         snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2200                                                    le16_to_cpu(msg->wValue),
2201                                                    le16_to_cpu(msg->wIndex));
2202                 }
2203         }
2204
2205 requeue:
2206         if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) {
2207                 urb->dev = mixer->chip->dev;
2208                 usb_submit_urb(urb, GFP_ATOMIC);
2209         }
2210 }
2211
2212 /* stop any bus activity of a mixer */
2213 void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2214 {
2215         usb_kill_urb(mixer->urb);
2216         usb_kill_urb(mixer->rc_urb);
2217 }
2218
2219 int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2220 {
2221         int err;
2222
2223         if (mixer->urb) {
2224                 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2225                 if (err < 0)
2226                         return err;
2227         }
2228
2229         return 0;
2230 }
2231
2232 /* create the handler for the optional status interrupt endpoint */
2233 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2234 {
2235         struct usb_endpoint_descriptor *ep;
2236         void *transfer_buffer;
2237         int buffer_length;
2238         unsigned int epnum;
2239
2240         /* we need one interrupt input endpoint */
2241         if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2242                 return 0;
2243         ep = get_endpoint(mixer->hostif, 0);
2244         if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2245                 return 0;
2246
2247         epnum = usb_endpoint_num(ep);
2248         buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2249         transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2250         if (!transfer_buffer)
2251                 return -ENOMEM;
2252         mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2253         if (!mixer->urb) {
2254                 kfree(transfer_buffer);
2255                 return -ENOMEM;
2256         }
2257         usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2258                          usb_rcvintpipe(mixer->chip->dev, epnum),
2259                          transfer_buffer, buffer_length,
2260                          snd_usb_mixer_interrupt, mixer, ep->bInterval);
2261         usb_submit_urb(mixer->urb, GFP_KERNEL);
2262         return 0;
2263 }
2264
2265 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2266                          int ignore_error)
2267 {
2268         static struct snd_device_ops dev_ops = {
2269                 .dev_free = snd_usb_mixer_dev_free
2270         };
2271         struct usb_mixer_interface *mixer;
2272         struct snd_info_entry *entry;
2273         int err;
2274
2275         strcpy(chip->card->mixername, "USB Mixer");
2276
2277         mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2278         if (!mixer)
2279                 return -ENOMEM;
2280         mixer->chip = chip;
2281         mixer->ignore_ctl_error = ignore_error;
2282         mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2283                                   GFP_KERNEL);
2284         if (!mixer->id_elems) {
2285                 kfree(mixer);
2286                 return -ENOMEM;
2287         }
2288
2289         mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2290         switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2291         case UAC_VERSION_1:
2292         default:
2293                 mixer->protocol = UAC_VERSION_1;
2294                 break;
2295         case UAC_VERSION_2:
2296                 mixer->protocol = UAC_VERSION_2;
2297                 break;
2298         }
2299
2300         if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2301             (err = snd_usb_mixer_status_create(mixer)) < 0)
2302                 goto _error;
2303
2304         snd_usb_mixer_apply_create_quirk(mixer);
2305
2306         err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
2307         if (err < 0)
2308                 goto _error;
2309
2310         if (list_empty(&chip->mixer_list) &&
2311             !snd_card_proc_new(chip->card, "usbmixer", &entry))
2312                 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2313
2314         list_add(&mixer->list, &chip->mixer_list);
2315         return 0;
2316
2317 _error:
2318         snd_usb_mixer_free(mixer);
2319         return err;
2320 }
2321
2322 void snd_usb_mixer_disconnect(struct list_head *p)
2323 {
2324         struct usb_mixer_interface *mixer;
2325
2326         mixer = list_entry(p, struct usb_mixer_interface, list);
2327         usb_kill_urb(mixer->urb);
2328         usb_kill_urb(mixer->rc_urb);
2329 }