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