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