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