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