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