Loading...
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
68struct usb_audio_term {
69 int id;
70 int type;
71 int channels;
72 unsigned int chconfig;
73 int name;
74};
75
76struct usbmix_name_map;
77
78struct 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*/
90enum {
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};
98enum {
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
112static const struct usbmix_name_map *
113find_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 */
129static int
130check_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/* ignore the error value if ignore_ctl_error flag is set */
140#define filter_error(cval, err) \
141 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
142
143/* check whether the control should be ignored */
144static inline int
145check_ignored_ctl(const struct usbmix_name_map *p)
146{
147 if (!p || p->name || p->dB)
148 return 0;
149 return 1;
150}
151
152/* dB mapping */
153static inline void check_mapped_dB(const struct usbmix_name_map *p,
154 struct usb_mixer_elem_info *cval)
155{
156 if (p && p->dB) {
157 cval->dBmin = p->dB->min;
158 cval->dBmax = p->dB->max;
159 cval->initialized = 1;
160 }
161}
162
163/* get the mapped selector source name */
164static int check_mapped_selector_name(struct mixer_build *state, int unitid,
165 int index, char *buf, int buflen)
166{
167 const struct usbmix_selector_map *p;
168
169 if (!state->selector_map)
170 return 0;
171 for (p = state->selector_map; p->id; p++) {
172 if (p->id == unitid && index < p->count)
173 return strlcpy(buf, p->names[index], buflen);
174 }
175 return 0;
176}
177
178/*
179 * find an audio control unit with the given unit id
180 */
181static void *find_audio_control_unit(struct mixer_build *state,
182 unsigned char unit)
183{
184 /* we just parse the header */
185 struct uac_feature_unit_descriptor *hdr = NULL;
186
187 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
188 USB_DT_CS_INTERFACE)) != NULL) {
189 if (hdr->bLength >= 4 &&
190 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
191 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
192 hdr->bUnitID == unit)
193 return hdr;
194 }
195
196 return NULL;
197}
198
199/*
200 * copy a string with the given id
201 */
202static int snd_usb_copy_string_desc(struct mixer_build *state,
203 int index, char *buf, int maxlen)
204{
205 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
206 buf[len] = 0;
207 return len;
208}
209
210/*
211 * convert from the byte/word on usb descriptor to the zero-based integer
212 */
213static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
214{
215 switch (cval->val_type) {
216 case USB_MIXER_BOOLEAN:
217 return !!val;
218 case USB_MIXER_INV_BOOLEAN:
219 return !val;
220 case USB_MIXER_U8:
221 val &= 0xff;
222 break;
223 case USB_MIXER_S8:
224 val &= 0xff;
225 if (val >= 0x80)
226 val -= 0x100;
227 break;
228 case USB_MIXER_U16:
229 val &= 0xffff;
230 break;
231 case USB_MIXER_S16:
232 val &= 0xffff;
233 if (val >= 0x8000)
234 val -= 0x10000;
235 break;
236 }
237 return val;
238}
239
240/*
241 * convert from the zero-based int to the byte/word for usb descriptor
242 */
243static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
244{
245 switch (cval->val_type) {
246 case USB_MIXER_BOOLEAN:
247 return !!val;
248 case USB_MIXER_INV_BOOLEAN:
249 return !val;
250 case USB_MIXER_S8:
251 case USB_MIXER_U8:
252 return val & 0xff;
253 case USB_MIXER_S16:
254 case USB_MIXER_U16:
255 return val & 0xffff;
256 }
257 return 0; /* not reached */
258}
259
260static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
261{
262 if (!cval->res)
263 cval->res = 1;
264 if (val < cval->min)
265 return 0;
266 else if (val >= cval->max)
267 return (cval->max - cval->min + cval->res - 1) / cval->res;
268 else
269 return (val - cval->min) / cval->res;
270}
271
272static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
273{
274 if (val < 0)
275 return cval->min;
276 if (!cval->res)
277 cval->res = 1;
278 val *= cval->res;
279 val += cval->min;
280 if (val > cval->max)
281 return cval->max;
282 return val;
283}
284
285static int uac2_ctl_value_size(int val_type)
286{
287 switch (val_type) {
288 case USB_MIXER_S32:
289 case USB_MIXER_U32:
290 return 4;
291 case USB_MIXER_S16:
292 case USB_MIXER_U16:
293 return 2;
294 default:
295 return 1;
296 }
297 return 0; /* unreachable */
298}
299
300
301/*
302 * retrieve a mixer value
303 */
304
305static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
306 int validx, int *value_ret)
307{
308 struct snd_usb_audio *chip = cval->head.mixer->chip;
309 unsigned char buf[2];
310 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
311 int timeout = 10;
312 int idx = 0, err;
313
314 err = snd_usb_lock_shutdown(chip);
315 if (err < 0)
316 return -EIO;
317
318 while (timeout-- > 0) {
319 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
320 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
321 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
322 validx, idx, buf, val_len) >= val_len) {
323 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
324 err = 0;
325 goto out;
326 }
327 }
328 usb_audio_dbg(chip,
329 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
330 request, validx, idx, cval->val_type);
331 err = -EINVAL;
332
333 out:
334 snd_usb_unlock_shutdown(chip);
335 return err;
336}
337
338static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
339 int validx, int *value_ret)
340{
341 struct snd_usb_audio *chip = cval->head.mixer->chip;
342 unsigned char buf[4 + 3 * sizeof(__u32)]; /* enough space for one range */
343 unsigned char *val;
344 int idx = 0, ret, size;
345 __u8 bRequest;
346
347 if (request == UAC_GET_CUR) {
348 bRequest = UAC2_CS_CUR;
349 size = uac2_ctl_value_size(cval->val_type);
350 } else {
351 bRequest = UAC2_CS_RANGE;
352 size = sizeof(buf);
353 }
354
355 memset(buf, 0, sizeof(buf));
356
357 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
358 if (ret)
359 goto error;
360
361 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
362 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
363 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
364 validx, idx, buf, size);
365 snd_usb_unlock_shutdown(chip);
366
367 if (ret < 0) {
368error:
369 usb_audio_err(chip,
370 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
371 request, validx, idx, cval->val_type);
372 return ret;
373 }
374
375 /* FIXME: how should we handle multiple triplets here? */
376
377 switch (request) {
378 case UAC_GET_CUR:
379 val = buf;
380 break;
381 case UAC_GET_MIN:
382 val = buf + sizeof(__u16);
383 break;
384 case UAC_GET_MAX:
385 val = buf + sizeof(__u16) * 2;
386 break;
387 case UAC_GET_RES:
388 val = buf + sizeof(__u16) * 3;
389 break;
390 default:
391 return -EINVAL;
392 }
393
394 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
395
396 return 0;
397}
398
399static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
400 int validx, int *value_ret)
401{
402 validx += cval->idx_off;
403
404 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
405 get_ctl_value_v1(cval, request, validx, value_ret) :
406 get_ctl_value_v2(cval, request, validx, value_ret);
407}
408
409static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
410 int validx, int *value)
411{
412 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
413}
414
415/* channel = 0: master, 1 = first channel */
416static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
417 int channel, int *value)
418{
419 return get_ctl_value(cval, UAC_GET_CUR,
420 (cval->control << 8) | channel,
421 value);
422}
423
424int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
425 int channel, int index, int *value)
426{
427 int err;
428
429 if (cval->cached & (1 << channel)) {
430 *value = cval->cache_val[index];
431 return 0;
432 }
433 err = get_cur_mix_raw(cval, channel, value);
434 if (err < 0) {
435 if (!cval->head.mixer->ignore_ctl_error)
436 usb_audio_dbg(cval->head.mixer->chip,
437 "cannot get current value for control %d ch %d: err = %d\n",
438 cval->control, channel, err);
439 return err;
440 }
441 cval->cached |= 1 << channel;
442 cval->cache_val[index] = *value;
443 return 0;
444}
445
446/*
447 * set a mixer value
448 */
449
450int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
451 int request, int validx, int value_set)
452{
453 struct snd_usb_audio *chip = cval->head.mixer->chip;
454 unsigned char buf[4];
455 int idx = 0, val_len, err, timeout = 10;
456
457 validx += cval->idx_off;
458
459 if (cval->head.mixer->protocol == UAC_VERSION_1) {
460 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
461 } else { /* UAC_VERSION_2 */
462 val_len = uac2_ctl_value_size(cval->val_type);
463
464 /* FIXME */
465 if (request != UAC_SET_CUR) {
466 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
467 return -EINVAL;
468 }
469
470 request = UAC2_CS_CUR;
471 }
472
473 value_set = convert_bytes_value(cval, value_set);
474 buf[0] = value_set & 0xff;
475 buf[1] = (value_set >> 8) & 0xff;
476 buf[2] = (value_set >> 16) & 0xff;
477 buf[3] = (value_set >> 24) & 0xff;
478
479 err = snd_usb_lock_shutdown(chip);
480 if (err < 0)
481 return -EIO;
482
483 while (timeout-- > 0) {
484 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
485 if (snd_usb_ctl_msg(chip->dev,
486 usb_sndctrlpipe(chip->dev, 0), request,
487 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
488 validx, idx, buf, val_len) >= 0) {
489 err = 0;
490 goto out;
491 }
492 }
493 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
494 request, validx, idx, cval->val_type, buf[0], buf[1]);
495 err = -EINVAL;
496
497 out:
498 snd_usb_unlock_shutdown(chip);
499 return err;
500}
501
502static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
503 int validx, int value)
504{
505 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
506}
507
508int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
509 int index, int value)
510{
511 int err;
512 unsigned int read_only = (channel == 0) ?
513 cval->master_readonly :
514 cval->ch_readonly & (1 << (channel - 1));
515
516 if (read_only) {
517 usb_audio_dbg(cval->head.mixer->chip,
518 "%s(): channel %d of control %d is read_only\n",
519 __func__, channel, cval->control);
520 return 0;
521 }
522
523 err = snd_usb_mixer_set_ctl_value(cval,
524 UAC_SET_CUR, (cval->control << 8) | channel,
525 value);
526 if (err < 0)
527 return err;
528 cval->cached |= 1 << channel;
529 cval->cache_val[index] = value;
530 return 0;
531}
532
533/*
534 * TLV callback for mixer volume controls
535 */
536int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
537 unsigned int size, unsigned int __user *_tlv)
538{
539 struct usb_mixer_elem_info *cval = kcontrol->private_data;
540 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
541
542 if (size < sizeof(scale))
543 return -ENOMEM;
544 scale[2] = cval->dBmin;
545 scale[3] = cval->dBmax;
546 if (copy_to_user(_tlv, scale, sizeof(scale)))
547 return -EFAULT;
548 return 0;
549}
550
551/*
552 * parser routines begin here...
553 */
554
555static int parse_audio_unit(struct mixer_build *state, int unitid);
556
557
558/*
559 * check if the input/output channel routing is enabled on the given bitmap.
560 * used for mixer unit parser
561 */
562static int check_matrix_bitmap(unsigned char *bmap,
563 int ich, int och, int num_outs)
564{
565 int idx = ich * num_outs + och;
566 return bmap[idx >> 3] & (0x80 >> (idx & 7));
567}
568
569/*
570 * add an alsa control element
571 * search and increment the index until an empty slot is found.
572 *
573 * if failed, give up and free the control instance.
574 */
575
576int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
577 struct snd_kcontrol *kctl)
578{
579 struct usb_mixer_interface *mixer = list->mixer;
580 int err;
581
582 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
583 kctl->id.index++;
584 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
585 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
586 err);
587 return err;
588 }
589 list->kctl = kctl;
590 list->next_id_elem = mixer->id_elems[list->id];
591 mixer->id_elems[list->id] = list;
592 return 0;
593}
594
595/*
596 * get a terminal name string
597 */
598
599static struct iterm_name_combo {
600 int type;
601 char *name;
602} iterm_names[] = {
603 { 0x0300, "Output" },
604 { 0x0301, "Speaker" },
605 { 0x0302, "Headphone" },
606 { 0x0303, "HMD Audio" },
607 { 0x0304, "Desktop Speaker" },
608 { 0x0305, "Room Speaker" },
609 { 0x0306, "Com Speaker" },
610 { 0x0307, "LFE" },
611 { 0x0600, "External In" },
612 { 0x0601, "Analog In" },
613 { 0x0602, "Digital In" },
614 { 0x0603, "Line" },
615 { 0x0604, "Legacy In" },
616 { 0x0605, "IEC958 In" },
617 { 0x0606, "1394 DA Stream" },
618 { 0x0607, "1394 DV Stream" },
619 { 0x0700, "Embedded" },
620 { 0x0701, "Noise Source" },
621 { 0x0702, "Equalization Noise" },
622 { 0x0703, "CD" },
623 { 0x0704, "DAT" },
624 { 0x0705, "DCC" },
625 { 0x0706, "MiniDisk" },
626 { 0x0707, "Analog Tape" },
627 { 0x0708, "Phonograph" },
628 { 0x0709, "VCR Audio" },
629 { 0x070a, "Video Disk Audio" },
630 { 0x070b, "DVD Audio" },
631 { 0x070c, "TV Tuner Audio" },
632 { 0x070d, "Satellite Rec Audio" },
633 { 0x070e, "Cable Tuner Audio" },
634 { 0x070f, "DSS Audio" },
635 { 0x0710, "Radio Receiver" },
636 { 0x0711, "Radio Transmitter" },
637 { 0x0712, "Multi-Track Recorder" },
638 { 0x0713, "Synthesizer" },
639 { 0 },
640};
641
642static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
643 unsigned char *name, int maxlen, int term_only)
644{
645 struct iterm_name_combo *names;
646
647 if (iterm->name)
648 return snd_usb_copy_string_desc(state, iterm->name,
649 name, maxlen);
650
651 /* virtual type - not a real terminal */
652 if (iterm->type >> 16) {
653 if (term_only)
654 return 0;
655 switch (iterm->type >> 16) {
656 case UAC_SELECTOR_UNIT:
657 strcpy(name, "Selector");
658 return 8;
659 case UAC1_PROCESSING_UNIT:
660 strcpy(name, "Process Unit");
661 return 12;
662 case UAC1_EXTENSION_UNIT:
663 strcpy(name, "Ext Unit");
664 return 8;
665 case UAC_MIXER_UNIT:
666 strcpy(name, "Mixer");
667 return 5;
668 default:
669 return sprintf(name, "Unit %d", iterm->id);
670 }
671 }
672
673 switch (iterm->type & 0xff00) {
674 case 0x0100:
675 strcpy(name, "PCM");
676 return 3;
677 case 0x0200:
678 strcpy(name, "Mic");
679 return 3;
680 case 0x0400:
681 strcpy(name, "Headset");
682 return 7;
683 case 0x0500:
684 strcpy(name, "Phone");
685 return 5;
686 }
687
688 for (names = iterm_names; names->type; names++) {
689 if (names->type == iterm->type) {
690 strcpy(name, names->name);
691 return strlen(names->name);
692 }
693 }
694
695 return 0;
696}
697
698/*
699 * parse the source unit recursively until it reaches to a terminal
700 * or a branched unit.
701 */
702static int check_input_term(struct mixer_build *state, int id,
703 struct usb_audio_term *term)
704{
705 int err;
706 void *p1;
707
708 memset(term, 0, sizeof(*term));
709 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
710 unsigned char *hdr = p1;
711 term->id = id;
712 switch (hdr[2]) {
713 case UAC_INPUT_TERMINAL:
714 if (state->mixer->protocol == UAC_VERSION_1) {
715 struct uac_input_terminal_descriptor *d = p1;
716 term->type = le16_to_cpu(d->wTerminalType);
717 term->channels = d->bNrChannels;
718 term->chconfig = le16_to_cpu(d->wChannelConfig);
719 term->name = d->iTerminal;
720 } else { /* UAC_VERSION_2 */
721 struct uac2_input_terminal_descriptor *d = p1;
722
723 /* call recursively to verify that the
724 * referenced clock entity is valid */
725 err = check_input_term(state, d->bCSourceID, term);
726 if (err < 0)
727 return err;
728
729 /* save input term properties after recursion,
730 * to ensure they are not overriden by the
731 * recursion calls */
732 term->id = id;
733 term->type = le16_to_cpu(d->wTerminalType);
734 term->channels = d->bNrChannels;
735 term->chconfig = le32_to_cpu(d->bmChannelConfig);
736 term->name = d->iTerminal;
737 }
738 return 0;
739 case UAC_FEATURE_UNIT: {
740 /* the header is the same for v1 and v2 */
741 struct uac_feature_unit_descriptor *d = p1;
742 id = d->bSourceID;
743 break; /* continue to parse */
744 }
745 case UAC_MIXER_UNIT: {
746 struct uac_mixer_unit_descriptor *d = p1;
747 term->type = d->bDescriptorSubtype << 16; /* virtual type */
748 term->channels = uac_mixer_unit_bNrChannels(d);
749 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
750 term->name = uac_mixer_unit_iMixer(d);
751 return 0;
752 }
753 case UAC_SELECTOR_UNIT:
754 case UAC2_CLOCK_SELECTOR: {
755 struct uac_selector_unit_descriptor *d = p1;
756 /* call recursively to retrieve the channel info */
757 err = check_input_term(state, d->baSourceID[0], term);
758 if (err < 0)
759 return err;
760 term->type = d->bDescriptorSubtype << 16; /* virtual type */
761 term->id = id;
762 term->name = uac_selector_unit_iSelector(d);
763 return 0;
764 }
765 case UAC1_PROCESSING_UNIT:
766 case UAC1_EXTENSION_UNIT:
767 /* UAC2_PROCESSING_UNIT_V2 */
768 /* UAC2_EFFECT_UNIT */
769 case UAC2_EXTENSION_UNIT_V2: {
770 struct uac_processing_unit_descriptor *d = p1;
771
772 if (state->mixer->protocol == UAC_VERSION_2 &&
773 hdr[2] == UAC2_EFFECT_UNIT) {
774 /* UAC2/UAC1 unit IDs overlap here in an
775 * uncompatible way. Ignore this unit for now.
776 */
777 return 0;
778 }
779
780 if (d->bNrInPins) {
781 id = d->baSourceID[0];
782 break; /* continue to parse */
783 }
784 term->type = d->bDescriptorSubtype << 16; /* virtual type */
785 term->channels = uac_processing_unit_bNrChannels(d);
786 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
787 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
788 return 0;
789 }
790 case UAC2_CLOCK_SOURCE: {
791 struct uac_clock_source_descriptor *d = p1;
792 term->type = d->bDescriptorSubtype << 16; /* virtual type */
793 term->id = id;
794 term->name = d->iClockSource;
795 return 0;
796 }
797 default:
798 return -ENODEV;
799 }
800 }
801 return -ENODEV;
802}
803
804/*
805 * Feature Unit
806 */
807
808/* feature unit control information */
809struct usb_feature_control_info {
810 const char *name;
811 int type; /* data type for uac1 */
812 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
813};
814
815static struct usb_feature_control_info audio_feature_info[] = {
816 { "Mute", USB_MIXER_INV_BOOLEAN, -1 },
817 { "Volume", USB_MIXER_S16, -1 },
818 { "Tone Control - Bass", USB_MIXER_S8, -1 },
819 { "Tone Control - Mid", USB_MIXER_S8, -1 },
820 { "Tone Control - Treble", USB_MIXER_S8, -1 },
821 { "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
822 { "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
823 { "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
824 { "Bass Boost", USB_MIXER_BOOLEAN, -1 },
825 { "Loudness", USB_MIXER_BOOLEAN, -1 },
826 /* UAC2 specific */
827 { "Input Gain Control", USB_MIXER_S16, -1 },
828 { "Input Gain Pad Control", USB_MIXER_S16, -1 },
829 { "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
830};
831
832/* private_free callback */
833void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
834{
835 kfree(kctl->private_data);
836 kctl->private_data = NULL;
837}
838
839/*
840 * interface to ALSA control for feature/mixer units
841 */
842
843/* volume control quirks */
844static void volume_control_quirks(struct usb_mixer_elem_info *cval,
845 struct snd_kcontrol *kctl)
846{
847 struct snd_usb_audio *chip = cval->head.mixer->chip;
848 switch (chip->usb_id) {
849 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
850 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
851 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
852 cval->min = 0x0000;
853 cval->max = 0xffff;
854 cval->res = 0x00e6;
855 break;
856 }
857 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
858 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
859 cval->min = 0x00;
860 cval->max = 0xff;
861 break;
862 }
863 if (strstr(kctl->id.name, "Effect Return") != NULL) {
864 cval->min = 0xb706;
865 cval->max = 0xff7b;
866 cval->res = 0x0073;
867 break;
868 }
869 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
870 (strstr(kctl->id.name, "Effect Send") != NULL)) {
871 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
872 cval->max = 0xfcfe;
873 cval->res = 0x0073;
874 }
875 break;
876
877 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
878 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
879 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
880 usb_audio_info(chip,
881 "set quirk for FTU Effect Duration\n");
882 cval->min = 0x0000;
883 cval->max = 0x7f00;
884 cval->res = 0x0100;
885 break;
886 }
887 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
888 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
889 usb_audio_info(chip,
890 "set quirks for FTU Effect Feedback/Volume\n");
891 cval->min = 0x00;
892 cval->max = 0x7f;
893 break;
894 }
895 break;
896
897 case USB_ID(0x0471, 0x0101):
898 case USB_ID(0x0471, 0x0104):
899 case USB_ID(0x0471, 0x0105):
900 case USB_ID(0x0672, 0x1041):
901 /* quirk for UDA1321/N101.
902 * note that detection between firmware 2.1.1.7 (N101)
903 * and later 2.1.1.21 is not very clear from datasheets.
904 * I hope that the min value is -15360 for newer firmware --jk
905 */
906 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
907 cval->min == -15616) {
908 usb_audio_info(chip,
909 "set volume quirk for UDA1321/N101 chip\n");
910 cval->max = -256;
911 }
912 break;
913
914 case USB_ID(0x046d, 0x09a4):
915 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
916 usb_audio_info(chip,
917 "set volume quirk for QuickCam E3500\n");
918 cval->min = 6080;
919 cval->max = 8768;
920 cval->res = 192;
921 }
922 break;
923
924 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
925 case USB_ID(0x046d, 0x0808):
926 case USB_ID(0x046d, 0x0809):
927 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
928 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
929 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
930 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
931 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
932 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
933 case USB_ID(0x046d, 0x0991):
934 /* Most audio usb devices lie about volume resolution.
935 * Most Logitech webcams have res = 384.
936 * Proboly there is some logitech magic behind this number --fishor
937 */
938 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
939 usb_audio_info(chip,
940 "set resolution quirk: cval->res = 384\n");
941 cval->res = 384;
942 }
943 break;
944 }
945}
946
947/*
948 * retrieve the minimum and maximum values for the specified control
949 */
950static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
951 int default_min, struct snd_kcontrol *kctl)
952{
953 /* for failsafe */
954 cval->min = default_min;
955 cval->max = cval->min + 1;
956 cval->res = 1;
957 cval->dBmin = cval->dBmax = 0;
958
959 if (cval->val_type == USB_MIXER_BOOLEAN ||
960 cval->val_type == USB_MIXER_INV_BOOLEAN) {
961 cval->initialized = 1;
962 } else {
963 int minchn = 0;
964 if (cval->cmask) {
965 int i;
966 for (i = 0; i < MAX_CHANNELS; i++)
967 if (cval->cmask & (1 << i)) {
968 minchn = i + 1;
969 break;
970 }
971 }
972 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
973 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
974 usb_audio_err(cval->head.mixer->chip,
975 "%d:%d: cannot get min/max values for control %d (id %d)\n",
976 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
977 cval->control, cval->head.id);
978 return -EINVAL;
979 }
980 if (get_ctl_value(cval, UAC_GET_RES,
981 (cval->control << 8) | minchn,
982 &cval->res) < 0) {
983 cval->res = 1;
984 } else {
985 int last_valid_res = cval->res;
986
987 while (cval->res > 1) {
988 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
989 (cval->control << 8) | minchn,
990 cval->res / 2) < 0)
991 break;
992 cval->res /= 2;
993 }
994 if (get_ctl_value(cval, UAC_GET_RES,
995 (cval->control << 8) | minchn, &cval->res) < 0)
996 cval->res = last_valid_res;
997 }
998 if (cval->res == 0)
999 cval->res = 1;
1000
1001 /* Additional checks for the proper resolution
1002 *
1003 * Some devices report smaller resolutions than actually
1004 * reacting. They don't return errors but simply clip
1005 * to the lower aligned value.
1006 */
1007 if (cval->min + cval->res < cval->max) {
1008 int last_valid_res = cval->res;
1009 int saved, test, check;
1010 get_cur_mix_raw(cval, minchn, &saved);
1011 for (;;) {
1012 test = saved;
1013 if (test < cval->max)
1014 test += cval->res;
1015 else
1016 test -= cval->res;
1017 if (test < cval->min || test > cval->max ||
1018 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1019 get_cur_mix_raw(cval, minchn, &check)) {
1020 cval->res = last_valid_res;
1021 break;
1022 }
1023 if (test == check)
1024 break;
1025 cval->res *= 2;
1026 }
1027 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1028 }
1029
1030 cval->initialized = 1;
1031 }
1032
1033 if (kctl)
1034 volume_control_quirks(cval, kctl);
1035
1036 /* USB descriptions contain the dB scale in 1/256 dB unit
1037 * while ALSA TLV contains in 1/100 dB unit
1038 */
1039 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1040 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1041 if (cval->dBmin > cval->dBmax) {
1042 /* something is wrong; assume it's either from/to 0dB */
1043 if (cval->dBmin < 0)
1044 cval->dBmax = 0;
1045 else if (cval->dBmin > 0)
1046 cval->dBmin = 0;
1047 if (cval->dBmin > cval->dBmax) {
1048 /* totally crap, return an error */
1049 return -EINVAL;
1050 }
1051 }
1052
1053 return 0;
1054}
1055
1056#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1057
1058/* get a feature/mixer unit info */
1059static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1060 struct snd_ctl_elem_info *uinfo)
1061{
1062 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1063
1064 if (cval->val_type == USB_MIXER_BOOLEAN ||
1065 cval->val_type == USB_MIXER_INV_BOOLEAN)
1066 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1067 else
1068 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1069 uinfo->count = cval->channels;
1070 if (cval->val_type == USB_MIXER_BOOLEAN ||
1071 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1072 uinfo->value.integer.min = 0;
1073 uinfo->value.integer.max = 1;
1074 } else {
1075 if (!cval->initialized) {
1076 get_min_max_with_quirks(cval, 0, kcontrol);
1077 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1078 kcontrol->vd[0].access &=
1079 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1080 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1081 snd_ctl_notify(cval->head.mixer->chip->card,
1082 SNDRV_CTL_EVENT_MASK_INFO,
1083 &kcontrol->id);
1084 }
1085 }
1086 uinfo->value.integer.min = 0;
1087 uinfo->value.integer.max =
1088 (cval->max - cval->min + cval->res - 1) / cval->res;
1089 }
1090 return 0;
1091}
1092
1093/* get the current value from feature/mixer unit */
1094static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1095 struct snd_ctl_elem_value *ucontrol)
1096{
1097 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1098 int c, cnt, val, err;
1099
1100 ucontrol->value.integer.value[0] = cval->min;
1101 if (cval->cmask) {
1102 cnt = 0;
1103 for (c = 0; c < MAX_CHANNELS; c++) {
1104 if (!(cval->cmask & (1 << c)))
1105 continue;
1106 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1107 if (err < 0)
1108 return filter_error(cval, err);
1109 val = get_relative_value(cval, val);
1110 ucontrol->value.integer.value[cnt] = val;
1111 cnt++;
1112 }
1113 return 0;
1114 } else {
1115 /* master channel */
1116 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1117 if (err < 0)
1118 return filter_error(cval, err);
1119 val = get_relative_value(cval, val);
1120 ucontrol->value.integer.value[0] = val;
1121 }
1122 return 0;
1123}
1124
1125/* put the current value to feature/mixer unit */
1126static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1127 struct snd_ctl_elem_value *ucontrol)
1128{
1129 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1130 int c, cnt, val, oval, err;
1131 int changed = 0;
1132
1133 if (cval->cmask) {
1134 cnt = 0;
1135 for (c = 0; c < MAX_CHANNELS; c++) {
1136 if (!(cval->cmask & (1 << c)))
1137 continue;
1138 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1139 if (err < 0)
1140 return filter_error(cval, err);
1141 val = ucontrol->value.integer.value[cnt];
1142 val = get_abs_value(cval, val);
1143 if (oval != val) {
1144 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1145 changed = 1;
1146 }
1147 cnt++;
1148 }
1149 } else {
1150 /* master channel */
1151 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1152 if (err < 0)
1153 return filter_error(cval, err);
1154 val = ucontrol->value.integer.value[0];
1155 val = get_abs_value(cval, val);
1156 if (val != oval) {
1157 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1158 changed = 1;
1159 }
1160 }
1161 return changed;
1162}
1163
1164static struct snd_kcontrol_new usb_feature_unit_ctl = {
1165 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1166 .name = "", /* will be filled later manually */
1167 .info = mixer_ctl_feature_info,
1168 .get = mixer_ctl_feature_get,
1169 .put = mixer_ctl_feature_put,
1170};
1171
1172/* the read-only variant */
1173static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1174 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1175 .name = "", /* will be filled later manually */
1176 .info = mixer_ctl_feature_info,
1177 .get = mixer_ctl_feature_get,
1178 .put = NULL,
1179};
1180
1181/*
1182 * This symbol is exported in order to allow the mixer quirks to
1183 * hook up to the standard feature unit control mechanism
1184 */
1185struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1186
1187/*
1188 * build a feature control
1189 */
1190static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1191{
1192 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1193}
1194
1195/*
1196 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1197 * rename it to "Headphone". We determine if something is a headphone
1198 * similar to how udev determines form factor.
1199 */
1200static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1201 struct snd_card *card)
1202{
1203 const char *names_to_check[] = {
1204 "Headset", "headset", "Headphone", "headphone", NULL};
1205 const char **s;
1206 bool found = false;
1207
1208 if (strcmp("Speaker", kctl->id.name))
1209 return;
1210
1211 for (s = names_to_check; *s; s++)
1212 if (strstr(card->shortname, *s)) {
1213 found = true;
1214 break;
1215 }
1216
1217 if (!found)
1218 return;
1219
1220 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1221}
1222
1223static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1224 unsigned int ctl_mask, int control,
1225 struct usb_audio_term *iterm, int unitid,
1226 int readonly_mask)
1227{
1228 struct uac_feature_unit_descriptor *desc = raw_desc;
1229 struct usb_feature_control_info *ctl_info;
1230 unsigned int len = 0;
1231 int mapped_name = 0;
1232 int nameid = uac_feature_unit_iFeature(desc);
1233 struct snd_kcontrol *kctl;
1234 struct usb_mixer_elem_info *cval;
1235 const struct usbmix_name_map *map;
1236 unsigned int range;
1237
1238 control++; /* change from zero-based to 1-based value */
1239
1240 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1241 /* FIXME: not supported yet */
1242 return;
1243 }
1244
1245 map = find_map(state, unitid, control);
1246 if (check_ignored_ctl(map))
1247 return;
1248
1249 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1250 if (!cval)
1251 return;
1252 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1253 cval->control = control;
1254 cval->cmask = ctl_mask;
1255 ctl_info = &audio_feature_info[control-1];
1256 if (state->mixer->protocol == UAC_VERSION_1)
1257 cval->val_type = ctl_info->type;
1258 else /* UAC_VERSION_2 */
1259 cval->val_type = ctl_info->type_uac2 >= 0 ?
1260 ctl_info->type_uac2 : ctl_info->type;
1261
1262 if (ctl_mask == 0) {
1263 cval->channels = 1; /* master channel */
1264 cval->master_readonly = readonly_mask;
1265 } else {
1266 int i, c = 0;
1267 for (i = 0; i < 16; i++)
1268 if (ctl_mask & (1 << i))
1269 c++;
1270 cval->channels = c;
1271 cval->ch_readonly = readonly_mask;
1272 }
1273
1274 /*
1275 * If all channels in the mask are marked read-only, make the control
1276 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1277 * issue write commands to read-only channels.
1278 */
1279 if (cval->channels == readonly_mask)
1280 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1281 else
1282 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1283
1284 if (!kctl) {
1285 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1286 kfree(cval);
1287 return;
1288 }
1289 kctl->private_free = snd_usb_mixer_elem_free;
1290
1291 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1292 mapped_name = len != 0;
1293 if (!len && nameid)
1294 len = snd_usb_copy_string_desc(state, nameid,
1295 kctl->id.name, sizeof(kctl->id.name));
1296
1297 switch (control) {
1298 case UAC_FU_MUTE:
1299 case UAC_FU_VOLUME:
1300 /*
1301 * determine the control name. the rule is:
1302 * - if a name id is given in descriptor, use it.
1303 * - if the connected input can be determined, then use the name
1304 * of terminal type.
1305 * - if the connected output can be determined, use it.
1306 * - otherwise, anonymous name.
1307 */
1308 if (!len) {
1309 len = get_term_name(state, iterm, kctl->id.name,
1310 sizeof(kctl->id.name), 1);
1311 if (!len)
1312 len = get_term_name(state, &state->oterm,
1313 kctl->id.name,
1314 sizeof(kctl->id.name), 1);
1315 if (!len)
1316 snprintf(kctl->id.name, sizeof(kctl->id.name),
1317 "Feature %d", unitid);
1318 }
1319
1320 if (!mapped_name)
1321 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1322
1323 /*
1324 * determine the stream direction:
1325 * if the connected output is USB stream, then it's likely a
1326 * capture stream. otherwise it should be playback (hopefully :)
1327 */
1328 if (!mapped_name && !(state->oterm.type >> 16)) {
1329 if ((state->oterm.type & 0xff00) == 0x0100)
1330 append_ctl_name(kctl, " Capture");
1331 else
1332 append_ctl_name(kctl, " Playback");
1333 }
1334 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1335 " Switch" : " Volume");
1336 break;
1337 default:
1338 if (!len)
1339 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1340 sizeof(kctl->id.name));
1341 break;
1342 }
1343
1344 /* get min/max values */
1345 get_min_max_with_quirks(cval, 0, kctl);
1346
1347 if (control == UAC_FU_VOLUME) {
1348 check_mapped_dB(map, cval);
1349 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1350 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1351 kctl->vd[0].access |=
1352 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1353 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1354 }
1355 }
1356
1357 snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1358
1359 range = (cval->max - cval->min) / cval->res;
1360 /*
1361 * Are there devices with volume range more than 255? I use a bit more
1362 * to be sure. 384 is a resolution magic number found on Logitech
1363 * devices. It will definitively catch all buggy Logitech devices.
1364 */
1365 if (range > 384) {
1366 usb_audio_warn(state->chip,
1367 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1368 range);
1369 usb_audio_warn(state->chip,
1370 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1371 cval->head.id, kctl->id.name, cval->channels,
1372 cval->min, cval->max, cval->res);
1373 }
1374
1375 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1376 cval->head.id, kctl->id.name, cval->channels,
1377 cval->min, cval->max, cval->res);
1378 snd_usb_mixer_add_control(&cval->head, kctl);
1379}
1380
1381/*
1382 * parse a feature unit
1383 *
1384 * most of controls are defined here.
1385 */
1386static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1387 void *_ftr)
1388{
1389 int channels, i, j;
1390 struct usb_audio_term iterm;
1391 unsigned int master_bits, first_ch_bits;
1392 int err, csize;
1393 struct uac_feature_unit_descriptor *hdr = _ftr;
1394 __u8 *bmaControls;
1395
1396 if (state->mixer->protocol == UAC_VERSION_1) {
1397 csize = hdr->bControlSize;
1398 if (!csize) {
1399 usb_audio_dbg(state->chip,
1400 "unit %u: invalid bControlSize == 0\n",
1401 unitid);
1402 return -EINVAL;
1403 }
1404 channels = (hdr->bLength - 7) / csize - 1;
1405 bmaControls = hdr->bmaControls;
1406 if (hdr->bLength < 7 + csize) {
1407 usb_audio_err(state->chip,
1408 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1409 unitid);
1410 return -EINVAL;
1411 }
1412 } else {
1413 struct uac2_feature_unit_descriptor *ftr = _ftr;
1414 csize = 4;
1415 channels = (hdr->bLength - 6) / 4 - 1;
1416 bmaControls = ftr->bmaControls;
1417 if (hdr->bLength < 6 + csize) {
1418 usb_audio_err(state->chip,
1419 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1420 unitid);
1421 return -EINVAL;
1422 }
1423 }
1424
1425 /* parse the source unit */
1426 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1427 return err;
1428
1429 /* determine the input source type and name */
1430 err = check_input_term(state, hdr->bSourceID, &iterm);
1431 if (err < 0)
1432 return err;
1433
1434 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1435 /* master configuration quirks */
1436 switch (state->chip->usb_id) {
1437 case USB_ID(0x08bb, 0x2702):
1438 usb_audio_info(state->chip,
1439 "usbmixer: master volume quirk for PCM2702 chip\n");
1440 /* disable non-functional volume control */
1441 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1442 break;
1443 case USB_ID(0x1130, 0xf211):
1444 usb_audio_info(state->chip,
1445 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1446 /* disable non-functional volume control */
1447 channels = 0;
1448 break;
1449
1450 }
1451 if (channels > 0)
1452 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1453 else
1454 first_ch_bits = 0;
1455
1456 if (state->mixer->protocol == UAC_VERSION_1) {
1457 /* check all control types */
1458 for (i = 0; i < 10; i++) {
1459 unsigned int ch_bits = 0;
1460 for (j = 0; j < channels; j++) {
1461 unsigned int mask;
1462
1463 mask = snd_usb_combine_bytes(bmaControls +
1464 csize * (j+1), csize);
1465 if (mask & (1 << i))
1466 ch_bits |= (1 << j);
1467 }
1468 /* audio class v1 controls are never read-only */
1469
1470 /*
1471 * The first channel must be set
1472 * (for ease of programming).
1473 */
1474 if (ch_bits & 1)
1475 build_feature_ctl(state, _ftr, ch_bits, i,
1476 &iterm, unitid, 0);
1477 if (master_bits & (1 << i))
1478 build_feature_ctl(state, _ftr, 0, i, &iterm,
1479 unitid, 0);
1480 }
1481 } else { /* UAC_VERSION_2 */
1482 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1483 unsigned int ch_bits = 0;
1484 unsigned int ch_read_only = 0;
1485
1486 for (j = 0; j < channels; j++) {
1487 unsigned int mask;
1488
1489 mask = snd_usb_combine_bytes(bmaControls +
1490 csize * (j+1), csize);
1491 if (uac2_control_is_readable(mask, i)) {
1492 ch_bits |= (1 << j);
1493 if (!uac2_control_is_writeable(mask, i))
1494 ch_read_only |= (1 << j);
1495 }
1496 }
1497
1498 /*
1499 * NOTE: build_feature_ctl() will mark the control
1500 * read-only if all channels are marked read-only in
1501 * the descriptors. Otherwise, the control will be
1502 * reported as writeable, but the driver will not
1503 * actually issue a write command for read-only
1504 * channels.
1505 */
1506
1507 /*
1508 * The first channel must be set
1509 * (for ease of programming).
1510 */
1511 if (ch_bits & 1)
1512 build_feature_ctl(state, _ftr, ch_bits, i,
1513 &iterm, unitid, ch_read_only);
1514 if (uac2_control_is_readable(master_bits, i))
1515 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1516 !uac2_control_is_writeable(master_bits, i));
1517 }
1518 }
1519
1520 return 0;
1521}
1522
1523/*
1524 * Mixer Unit
1525 */
1526
1527/*
1528 * build a mixer unit control
1529 *
1530 * the callbacks are identical with feature unit.
1531 * input channel number (zero based) is given in control field instead.
1532 */
1533static void build_mixer_unit_ctl(struct mixer_build *state,
1534 struct uac_mixer_unit_descriptor *desc,
1535 int in_pin, int in_ch, int unitid,
1536 struct usb_audio_term *iterm)
1537{
1538 struct usb_mixer_elem_info *cval;
1539 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1540 unsigned int i, len;
1541 struct snd_kcontrol *kctl;
1542 const struct usbmix_name_map *map;
1543
1544 map = find_map(state, unitid, 0);
1545 if (check_ignored_ctl(map))
1546 return;
1547
1548 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1549 if (!cval)
1550 return;
1551
1552 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1553 cval->control = in_ch + 1; /* based on 1 */
1554 cval->val_type = USB_MIXER_S16;
1555 for (i = 0; i < num_outs; i++) {
1556 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1557
1558 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1559 cval->cmask |= (1 << i);
1560 cval->channels++;
1561 }
1562 }
1563
1564 /* get min/max values */
1565 get_min_max(cval, 0);
1566
1567 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1568 if (!kctl) {
1569 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1570 kfree(cval);
1571 return;
1572 }
1573 kctl->private_free = snd_usb_mixer_elem_free;
1574
1575 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1576 if (!len)
1577 len = get_term_name(state, iterm, kctl->id.name,
1578 sizeof(kctl->id.name), 0);
1579 if (!len)
1580 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1581 append_ctl_name(kctl, " Volume");
1582
1583 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1584 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1585 snd_usb_mixer_add_control(&cval->head, kctl);
1586}
1587
1588/*
1589 * parse a mixer unit
1590 */
1591static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1592 void *raw_desc)
1593{
1594 struct uac_mixer_unit_descriptor *desc = raw_desc;
1595 struct usb_audio_term iterm;
1596 int input_pins, num_ins, num_outs;
1597 int pin, ich, err;
1598
1599 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1600 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1601 usb_audio_err(state->chip,
1602 "invalid MIXER UNIT descriptor %d\n",
1603 unitid);
1604 return -EINVAL;
1605 }
1606
1607 num_ins = 0;
1608 ich = 0;
1609 for (pin = 0; pin < input_pins; pin++) {
1610 err = parse_audio_unit(state, desc->baSourceID[pin]);
1611 if (err < 0)
1612 continue;
1613 /* no bmControls field (e.g. Maya44) -> ignore */
1614 if (desc->bLength <= 10 + input_pins)
1615 continue;
1616 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1617 if (err < 0)
1618 return err;
1619 num_ins += iterm.channels;
1620 for (; ich < num_ins; ich++) {
1621 int och, ich_has_controls = 0;
1622
1623 for (och = 0; och < num_outs; och++) {
1624 __u8 *c = uac_mixer_unit_bmControls(desc,
1625 state->mixer->protocol);
1626
1627 if (check_matrix_bitmap(c, ich, och, num_outs)) {
1628 ich_has_controls = 1;
1629 break;
1630 }
1631 }
1632 if (ich_has_controls)
1633 build_mixer_unit_ctl(state, desc, pin, ich,
1634 unitid, &iterm);
1635 }
1636 }
1637 return 0;
1638}
1639
1640/*
1641 * Processing Unit / Extension Unit
1642 */
1643
1644/* get callback for processing/extension unit */
1645static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1646 struct snd_ctl_elem_value *ucontrol)
1647{
1648 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1649 int err, val;
1650
1651 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1652 if (err < 0) {
1653 ucontrol->value.integer.value[0] = cval->min;
1654 return filter_error(cval, err);
1655 }
1656 val = get_relative_value(cval, val);
1657 ucontrol->value.integer.value[0] = val;
1658 return 0;
1659}
1660
1661/* put callback for processing/extension unit */
1662static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1663 struct snd_ctl_elem_value *ucontrol)
1664{
1665 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1666 int val, oval, err;
1667
1668 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1669 if (err < 0)
1670 return filter_error(cval, err);
1671 val = ucontrol->value.integer.value[0];
1672 val = get_abs_value(cval, val);
1673 if (val != oval) {
1674 set_cur_ctl_value(cval, cval->control << 8, val);
1675 return 1;
1676 }
1677 return 0;
1678}
1679
1680/* alsa control interface for processing/extension unit */
1681static struct snd_kcontrol_new mixer_procunit_ctl = {
1682 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1683 .name = "", /* will be filled later */
1684 .info = mixer_ctl_feature_info,
1685 .get = mixer_ctl_procunit_get,
1686 .put = mixer_ctl_procunit_put,
1687};
1688
1689/*
1690 * predefined data for processing units
1691 */
1692struct procunit_value_info {
1693 int control;
1694 char *suffix;
1695 int val_type;
1696 int min_value;
1697};
1698
1699struct procunit_info {
1700 int type;
1701 char *name;
1702 struct procunit_value_info *values;
1703};
1704
1705static struct procunit_value_info updown_proc_info[] = {
1706 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1707 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1708 { 0 }
1709};
1710static struct procunit_value_info prologic_proc_info[] = {
1711 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1712 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1713 { 0 }
1714};
1715static struct procunit_value_info threed_enh_proc_info[] = {
1716 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1717 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1718 { 0 }
1719};
1720static struct procunit_value_info reverb_proc_info[] = {
1721 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1722 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1723 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1724 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1725 { 0 }
1726};
1727static struct procunit_value_info chorus_proc_info[] = {
1728 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1729 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1730 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1731 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1732 { 0 }
1733};
1734static struct procunit_value_info dcr_proc_info[] = {
1735 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1736 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1737 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1738 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1739 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1740 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1741 { 0 }
1742};
1743
1744static struct procunit_info procunits[] = {
1745 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1746 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1747 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1748 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1749 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1750 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1751 { 0 },
1752};
1753/*
1754 * predefined data for extension units
1755 */
1756static struct procunit_value_info clock_rate_xu_info[] = {
1757 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1758 { 0 }
1759};
1760static struct procunit_value_info clock_source_xu_info[] = {
1761 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1762 { 0 }
1763};
1764static struct procunit_value_info spdif_format_xu_info[] = {
1765 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1766 { 0 }
1767};
1768static struct procunit_value_info soft_limit_xu_info[] = {
1769 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1770 { 0 }
1771};
1772static struct procunit_info extunits[] = {
1773 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1774 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1775 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1776 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1777 { 0 }
1778};
1779
1780/*
1781 * build a processing/extension unit
1782 */
1783static int build_audio_procunit(struct mixer_build *state, int unitid,
1784 void *raw_desc, struct procunit_info *list,
1785 char *name)
1786{
1787 struct uac_processing_unit_descriptor *desc = raw_desc;
1788 int num_ins = desc->bNrInPins;
1789 struct usb_mixer_elem_info *cval;
1790 struct snd_kcontrol *kctl;
1791 int i, err, nameid, type, len;
1792 struct procunit_info *info;
1793 struct procunit_value_info *valinfo;
1794 const struct usbmix_name_map *map;
1795 static struct procunit_value_info default_value_info[] = {
1796 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1797 { 0 }
1798 };
1799 static struct procunit_info default_info = {
1800 0, NULL, default_value_info
1801 };
1802
1803 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1804 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1805 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
1806 return -EINVAL;
1807 }
1808
1809 for (i = 0; i < num_ins; i++) {
1810 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1811 return err;
1812 }
1813
1814 type = le16_to_cpu(desc->wProcessType);
1815 for (info = list; info && info->type; info++)
1816 if (info->type == type)
1817 break;
1818 if (!info || !info->type)
1819 info = &default_info;
1820
1821 for (valinfo = info->values; valinfo->control; valinfo++) {
1822 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1823
1824 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1825 continue;
1826 map = find_map(state, unitid, valinfo->control);
1827 if (check_ignored_ctl(map))
1828 continue;
1829 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1830 if (!cval)
1831 return -ENOMEM;
1832 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1833 cval->control = valinfo->control;
1834 cval->val_type = valinfo->val_type;
1835 cval->channels = 1;
1836
1837 /* get min/max values */
1838 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1839 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1840 /* FIXME: hard-coded */
1841 cval->min = 1;
1842 cval->max = control_spec[0];
1843 cval->res = 1;
1844 cval->initialized = 1;
1845 } else {
1846 if (type == USB_XU_CLOCK_RATE) {
1847 /*
1848 * E-Mu USB 0404/0202/TrackerPre/0204
1849 * samplerate control quirk
1850 */
1851 cval->min = 0;
1852 cval->max = 5;
1853 cval->res = 1;
1854 cval->initialized = 1;
1855 } else
1856 get_min_max(cval, valinfo->min_value);
1857 }
1858
1859 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1860 if (!kctl) {
1861 kfree(cval);
1862 return -ENOMEM;
1863 }
1864 kctl->private_free = snd_usb_mixer_elem_free;
1865
1866 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
1867 /* nothing */ ;
1868 } else if (info->name) {
1869 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1870 } else {
1871 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1872 len = 0;
1873 if (nameid)
1874 len = snd_usb_copy_string_desc(state, nameid,
1875 kctl->id.name,
1876 sizeof(kctl->id.name));
1877 if (!len)
1878 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1879 }
1880 append_ctl_name(kctl, " ");
1881 append_ctl_name(kctl, valinfo->suffix);
1882
1883 usb_audio_dbg(state->chip,
1884 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1885 cval->head.id, kctl->id.name, cval->channels,
1886 cval->min, cval->max);
1887
1888 err = snd_usb_mixer_add_control(&cval->head, kctl);
1889 if (err < 0)
1890 return err;
1891 }
1892 return 0;
1893}
1894
1895static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
1896 void *raw_desc)
1897{
1898 return build_audio_procunit(state, unitid, raw_desc,
1899 procunits, "Processing Unit");
1900}
1901
1902static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
1903 void *raw_desc)
1904{
1905 /*
1906 * Note that we parse extension units with processing unit descriptors.
1907 * That's ok as the layout is the same.
1908 */
1909 return build_audio_procunit(state, unitid, raw_desc,
1910 extunits, "Extension Unit");
1911}
1912
1913/*
1914 * Selector Unit
1915 */
1916
1917/*
1918 * info callback for selector unit
1919 * use an enumerator type for routing
1920 */
1921static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
1922 struct snd_ctl_elem_info *uinfo)
1923{
1924 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1925 const char **itemlist = (const char **)kcontrol->private_value;
1926
1927 if (snd_BUG_ON(!itemlist))
1928 return -EINVAL;
1929 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
1930}
1931
1932/* get callback for selector unit */
1933static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
1934 struct snd_ctl_elem_value *ucontrol)
1935{
1936 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1937 int val, err;
1938
1939 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1940 if (err < 0) {
1941 ucontrol->value.enumerated.item[0] = 0;
1942 return filter_error(cval, err);
1943 }
1944 val = get_relative_value(cval, val);
1945 ucontrol->value.enumerated.item[0] = val;
1946 return 0;
1947}
1948
1949/* put callback for selector unit */
1950static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
1951 struct snd_ctl_elem_value *ucontrol)
1952{
1953 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1954 int val, oval, err;
1955
1956 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1957 if (err < 0)
1958 return filter_error(cval, err);
1959 val = ucontrol->value.enumerated.item[0];
1960 val = get_abs_value(cval, val);
1961 if (val != oval) {
1962 set_cur_ctl_value(cval, cval->control << 8, val);
1963 return 1;
1964 }
1965 return 0;
1966}
1967
1968/* alsa control interface for selector unit */
1969static struct snd_kcontrol_new mixer_selectunit_ctl = {
1970 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1971 .name = "", /* will be filled later */
1972 .info = mixer_ctl_selector_info,
1973 .get = mixer_ctl_selector_get,
1974 .put = mixer_ctl_selector_put,
1975};
1976
1977/*
1978 * private free callback.
1979 * free both private_data and private_value
1980 */
1981static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1982{
1983 int i, num_ins = 0;
1984
1985 if (kctl->private_data) {
1986 struct usb_mixer_elem_info *cval = kctl->private_data;
1987 num_ins = cval->max;
1988 kfree(cval);
1989 kctl->private_data = NULL;
1990 }
1991 if (kctl->private_value) {
1992 char **itemlist = (char **)kctl->private_value;
1993 for (i = 0; i < num_ins; i++)
1994 kfree(itemlist[i]);
1995 kfree(itemlist);
1996 kctl->private_value = 0;
1997 }
1998}
1999
2000/*
2001 * parse a selector unit
2002 */
2003static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2004 void *raw_desc)
2005{
2006 struct uac_selector_unit_descriptor *desc = raw_desc;
2007 unsigned int i, nameid, len;
2008 int err;
2009 struct usb_mixer_elem_info *cval;
2010 struct snd_kcontrol *kctl;
2011 const struct usbmix_name_map *map;
2012 char **namelist;
2013
2014 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
2015 usb_audio_err(state->chip,
2016 "invalid SELECTOR UNIT descriptor %d\n", unitid);
2017 return -EINVAL;
2018 }
2019
2020 for (i = 0; i < desc->bNrInPins; i++) {
2021 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2022 return err;
2023 }
2024
2025 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2026 return 0;
2027
2028 map = find_map(state, unitid, 0);
2029 if (check_ignored_ctl(map))
2030 return 0;
2031
2032 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2033 if (!cval)
2034 return -ENOMEM;
2035 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2036 cval->val_type = USB_MIXER_U8;
2037 cval->channels = 1;
2038 cval->min = 1;
2039 cval->max = desc->bNrInPins;
2040 cval->res = 1;
2041 cval->initialized = 1;
2042
2043 if (state->mixer->protocol == UAC_VERSION_1)
2044 cval->control = 0;
2045 else /* UAC_VERSION_2 */
2046 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2047 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2048
2049 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2050 if (!namelist) {
2051 kfree(cval);
2052 return -ENOMEM;
2053 }
2054#define MAX_ITEM_NAME_LEN 64
2055 for (i = 0; i < desc->bNrInPins; i++) {
2056 struct usb_audio_term iterm;
2057 len = 0;
2058 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2059 if (!namelist[i]) {
2060 while (i--)
2061 kfree(namelist[i]);
2062 kfree(namelist);
2063 kfree(cval);
2064 return -ENOMEM;
2065 }
2066 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2067 MAX_ITEM_NAME_LEN);
2068 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2069 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2070 if (! len)
2071 sprintf(namelist[i], "Input %u", i);
2072 }
2073
2074 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2075 if (! kctl) {
2076 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2077 kfree(namelist);
2078 kfree(cval);
2079 return -ENOMEM;
2080 }
2081 kctl->private_value = (unsigned long)namelist;
2082 kctl->private_free = usb_mixer_selector_elem_free;
2083
2084 nameid = uac_selector_unit_iSelector(desc);
2085 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2086 if (len)
2087 ;
2088 else if (nameid)
2089 snd_usb_copy_string_desc(state, nameid, kctl->id.name,
2090 sizeof(kctl->id.name));
2091 else {
2092 len = get_term_name(state, &state->oterm,
2093 kctl->id.name, sizeof(kctl->id.name), 0);
2094 if (!len)
2095 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2096
2097 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2098 append_ctl_name(kctl, " Clock Source");
2099 else if ((state->oterm.type & 0xff00) == 0x0100)
2100 append_ctl_name(kctl, " Capture Source");
2101 else
2102 append_ctl_name(kctl, " Playback Source");
2103 }
2104
2105 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2106 cval->head.id, kctl->id.name, desc->bNrInPins);
2107 return snd_usb_mixer_add_control(&cval->head, kctl);
2108}
2109
2110/*
2111 * parse an audio unit recursively
2112 */
2113
2114static int parse_audio_unit(struct mixer_build *state, int unitid)
2115{
2116 unsigned char *p1;
2117
2118 if (test_and_set_bit(unitid, state->unitbitmap))
2119 return 0; /* the unit already visited */
2120
2121 p1 = find_audio_control_unit(state, unitid);
2122 if (!p1) {
2123 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2124 return -EINVAL;
2125 }
2126
2127 switch (p1[2]) {
2128 case UAC_INPUT_TERMINAL:
2129 case UAC2_CLOCK_SOURCE:
2130 return 0; /* NOP */
2131 case UAC_MIXER_UNIT:
2132 return parse_audio_mixer_unit(state, unitid, p1);
2133 case UAC_SELECTOR_UNIT:
2134 case UAC2_CLOCK_SELECTOR:
2135 return parse_audio_selector_unit(state, unitid, p1);
2136 case UAC_FEATURE_UNIT:
2137 return parse_audio_feature_unit(state, unitid, p1);
2138 case UAC1_PROCESSING_UNIT:
2139 /* UAC2_EFFECT_UNIT has the same value */
2140 if (state->mixer->protocol == UAC_VERSION_1)
2141 return parse_audio_processing_unit(state, unitid, p1);
2142 else
2143 return 0; /* FIXME - effect units not implemented yet */
2144 case UAC1_EXTENSION_UNIT:
2145 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2146 if (state->mixer->protocol == UAC_VERSION_1)
2147 return parse_audio_extension_unit(state, unitid, p1);
2148 else /* UAC_VERSION_2 */
2149 return parse_audio_processing_unit(state, unitid, p1);
2150 case UAC2_EXTENSION_UNIT_V2:
2151 return parse_audio_extension_unit(state, unitid, p1);
2152 default:
2153 usb_audio_err(state->chip,
2154 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2155 return -EINVAL;
2156 }
2157}
2158
2159static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2160{
2161 kfree(mixer->id_elems);
2162 if (mixer->urb) {
2163 kfree(mixer->urb->transfer_buffer);
2164 usb_free_urb(mixer->urb);
2165 }
2166 usb_free_urb(mixer->rc_urb);
2167 kfree(mixer->rc_setup_packet);
2168 kfree(mixer);
2169}
2170
2171static int snd_usb_mixer_dev_free(struct snd_device *device)
2172{
2173 struct usb_mixer_interface *mixer = device->device_data;
2174 snd_usb_mixer_free(mixer);
2175 return 0;
2176}
2177
2178/*
2179 * create mixer controls
2180 *
2181 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2182 */
2183static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2184{
2185 struct mixer_build state;
2186 int err;
2187 const struct usbmix_ctl_map *map;
2188 void *p;
2189
2190 memset(&state, 0, sizeof(state));
2191 state.chip = mixer->chip;
2192 state.mixer = mixer;
2193 state.buffer = mixer->hostif->extra;
2194 state.buflen = mixer->hostif->extralen;
2195
2196 /* check the mapping table */
2197 for (map = usbmix_ctl_maps; map->id; map++) {
2198 if (map->id == state.chip->usb_id) {
2199 state.map = map->map;
2200 state.selector_map = map->selector_map;
2201 mixer->ignore_ctl_error = map->ignore_ctl_error;
2202 break;
2203 }
2204 }
2205
2206 p = NULL;
2207 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2208 mixer->hostif->extralen,
2209 p, UAC_OUTPUT_TERMINAL)) != NULL) {
2210 if (mixer->protocol == UAC_VERSION_1) {
2211 struct uac1_output_terminal_descriptor *desc = p;
2212
2213 if (desc->bLength < sizeof(*desc))
2214 continue; /* invalid descriptor? */
2215 /* mark terminal ID as visited */
2216 set_bit(desc->bTerminalID, state.unitbitmap);
2217 state.oterm.id = desc->bTerminalID;
2218 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2219 state.oterm.name = desc->iTerminal;
2220 err = parse_audio_unit(&state, desc->bSourceID);
2221 if (err < 0 && err != -EINVAL)
2222 return err;
2223 } else { /* UAC_VERSION_2 */
2224 struct uac2_output_terminal_descriptor *desc = p;
2225
2226 if (desc->bLength < sizeof(*desc))
2227 continue; /* invalid descriptor? */
2228 /* mark terminal ID as visited */
2229 set_bit(desc->bTerminalID, state.unitbitmap);
2230 state.oterm.id = desc->bTerminalID;
2231 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2232 state.oterm.name = desc->iTerminal;
2233 err = parse_audio_unit(&state, desc->bSourceID);
2234 if (err < 0 && err != -EINVAL)
2235 return err;
2236
2237 /*
2238 * For UAC2, use the same approach to also add the
2239 * clock selectors
2240 */
2241 err = parse_audio_unit(&state, desc->bCSourceID);
2242 if (err < 0 && err != -EINVAL)
2243 return err;
2244 }
2245 }
2246
2247 return 0;
2248}
2249
2250void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2251{
2252 struct usb_mixer_elem_list *list;
2253
2254 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2255 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2256 &list->kctl->id);
2257}
2258
2259static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2260 struct usb_mixer_elem_list *list)
2261{
2262 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2263 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2264 "S8", "U8", "S16", "U16"};
2265 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2266 "channels=%i, type=\"%s\"\n", cval->head.id,
2267 cval->control, cval->cmask, cval->channels,
2268 val_types[cval->val_type]);
2269 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2270 cval->min, cval->max, cval->dBmin, cval->dBmax);
2271}
2272
2273static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2274 struct snd_info_buffer *buffer)
2275{
2276 struct snd_usb_audio *chip = entry->private_data;
2277 struct usb_mixer_interface *mixer;
2278 struct usb_mixer_elem_list *list;
2279 int unitid;
2280
2281 list_for_each_entry(mixer, &chip->mixer_list, list) {
2282 snd_iprintf(buffer,
2283 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2284 chip->usb_id, snd_usb_ctrl_intf(chip),
2285 mixer->ignore_ctl_error);
2286 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2287 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2288 for (list = mixer->id_elems[unitid]; list;
2289 list = list->next_id_elem) {
2290 snd_iprintf(buffer, " Unit: %i\n", list->id);
2291 if (list->kctl)
2292 snd_iprintf(buffer,
2293 " Control: name=\"%s\", index=%i\n",
2294 list->kctl->id.name,
2295 list->kctl->id.index);
2296 if (list->dump)
2297 list->dump(buffer, list);
2298 }
2299 }
2300 }
2301}
2302
2303static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2304 int attribute, int value, int index)
2305{
2306 struct usb_mixer_elem_list *list;
2307 __u8 unitid = (index >> 8) & 0xff;
2308 __u8 control = (value >> 8) & 0xff;
2309 __u8 channel = value & 0xff;
2310
2311 if (channel >= MAX_CHANNELS) {
2312 usb_audio_dbg(mixer->chip,
2313 "%s(): bogus channel number %d\n",
2314 __func__, channel);
2315 return;
2316 }
2317
2318 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2319 struct usb_mixer_elem_info *info;
2320
2321 if (!list->kctl)
2322 continue;
2323
2324 info = (struct usb_mixer_elem_info *)list;
2325 if (info->control != control)
2326 continue;
2327
2328 switch (attribute) {
2329 case UAC2_CS_CUR:
2330 /* invalidate cache, so the value is read from the device */
2331 if (channel)
2332 info->cached &= ~(1 << channel);
2333 else /* master channel */
2334 info->cached = 0;
2335
2336 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2337 &info->head.kctl->id);
2338 break;
2339
2340 case UAC2_CS_RANGE:
2341 /* TODO */
2342 break;
2343
2344 case UAC2_CS_MEM:
2345 /* TODO */
2346 break;
2347
2348 default:
2349 usb_audio_dbg(mixer->chip,
2350 "unknown attribute %d in interrupt\n",
2351 attribute);
2352 break;
2353 } /* switch */
2354 }
2355}
2356
2357static void snd_usb_mixer_interrupt(struct urb *urb)
2358{
2359 struct usb_mixer_interface *mixer = urb->context;
2360 int len = urb->actual_length;
2361 int ustatus = urb->status;
2362
2363 if (ustatus != 0)
2364 goto requeue;
2365
2366 if (mixer->protocol == UAC_VERSION_1) {
2367 struct uac1_status_word *status;
2368
2369 for (status = urb->transfer_buffer;
2370 len >= sizeof(*status);
2371 len -= sizeof(*status), status++) {
2372 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2373 status->bStatusType,
2374 status->bOriginator);
2375
2376 /* ignore any notifications not from the control interface */
2377 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2378 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2379 continue;
2380
2381 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2382 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2383 else
2384 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2385 }
2386 } else { /* UAC_VERSION_2 */
2387 struct uac2_interrupt_data_msg *msg;
2388
2389 for (msg = urb->transfer_buffer;
2390 len >= sizeof(*msg);
2391 len -= sizeof(*msg), msg++) {
2392 /* drop vendor specific and endpoint requests */
2393 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2394 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2395 continue;
2396
2397 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2398 le16_to_cpu(msg->wValue),
2399 le16_to_cpu(msg->wIndex));
2400 }
2401 }
2402
2403requeue:
2404 if (ustatus != -ENOENT &&
2405 ustatus != -ECONNRESET &&
2406 ustatus != -ESHUTDOWN) {
2407 urb->dev = mixer->chip->dev;
2408 usb_submit_urb(urb, GFP_ATOMIC);
2409 }
2410}
2411
2412/* create the handler for the optional status interrupt endpoint */
2413static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2414{
2415 struct usb_endpoint_descriptor *ep;
2416 void *transfer_buffer;
2417 int buffer_length;
2418 unsigned int epnum;
2419
2420 /* we need one interrupt input endpoint */
2421 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2422 return 0;
2423 ep = get_endpoint(mixer->hostif, 0);
2424 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2425 return 0;
2426
2427 epnum = usb_endpoint_num(ep);
2428 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2429 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2430 if (!transfer_buffer)
2431 return -ENOMEM;
2432 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2433 if (!mixer->urb) {
2434 kfree(transfer_buffer);
2435 return -ENOMEM;
2436 }
2437 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2438 usb_rcvintpipe(mixer->chip->dev, epnum),
2439 transfer_buffer, buffer_length,
2440 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2441 usb_submit_urb(mixer->urb, GFP_KERNEL);
2442 return 0;
2443}
2444
2445int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2446 int ignore_error)
2447{
2448 static struct snd_device_ops dev_ops = {
2449 .dev_free = snd_usb_mixer_dev_free
2450 };
2451 struct usb_mixer_interface *mixer;
2452 struct snd_info_entry *entry;
2453 int err;
2454
2455 strcpy(chip->card->mixername, "USB Mixer");
2456
2457 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2458 if (!mixer)
2459 return -ENOMEM;
2460 mixer->chip = chip;
2461 mixer->ignore_ctl_error = ignore_error;
2462 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2463 GFP_KERNEL);
2464 if (!mixer->id_elems) {
2465 kfree(mixer);
2466 return -ENOMEM;
2467 }
2468
2469 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2470 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2471 case UAC_VERSION_1:
2472 default:
2473 mixer->protocol = UAC_VERSION_1;
2474 break;
2475 case UAC_VERSION_2:
2476 mixer->protocol = UAC_VERSION_2;
2477 break;
2478 }
2479
2480 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2481 (err = snd_usb_mixer_status_create(mixer)) < 0)
2482 goto _error;
2483
2484 snd_usb_mixer_apply_create_quirk(mixer);
2485
2486 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2487 if (err < 0)
2488 goto _error;
2489
2490 if (list_empty(&chip->mixer_list) &&
2491 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2492 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2493
2494 list_add(&mixer->list, &chip->mixer_list);
2495 return 0;
2496
2497_error:
2498 snd_usb_mixer_free(mixer);
2499 return err;
2500}
2501
2502void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2503{
2504 usb_kill_urb(mixer->urb);
2505 usb_kill_urb(mixer->rc_urb);
2506}
2507
2508#ifdef CONFIG_PM
2509/* stop any bus activity of a mixer */
2510static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2511{
2512 usb_kill_urb(mixer->urb);
2513 usb_kill_urb(mixer->rc_urb);
2514}
2515
2516static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2517{
2518 int err;
2519
2520 if (mixer->urb) {
2521 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2522 if (err < 0)
2523 return err;
2524 }
2525
2526 return 0;
2527}
2528
2529int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2530{
2531 snd_usb_mixer_inactivate(mixer);
2532 return 0;
2533}
2534
2535static int restore_mixer_value(struct usb_mixer_elem_list *list)
2536{
2537 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2538 int c, err, idx;
2539
2540 if (cval->cmask) {
2541 idx = 0;
2542 for (c = 0; c < MAX_CHANNELS; c++) {
2543 if (!(cval->cmask & (1 << c)))
2544 continue;
2545 if (cval->cached & (1 << (c + 1))) {
2546 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2547 cval->cache_val[idx]);
2548 if (err < 0)
2549 return err;
2550 }
2551 idx++;
2552 }
2553 } else {
2554 /* master */
2555 if (cval->cached) {
2556 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2557 if (err < 0)
2558 return err;
2559 }
2560 }
2561
2562 return 0;
2563}
2564
2565int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2566{
2567 struct usb_mixer_elem_list *list;
2568 int id, err;
2569
2570 if (reset_resume) {
2571 /* restore cached mixer values */
2572 for (id = 0; id < MAX_ID_ELEMS; id++) {
2573 for (list = mixer->id_elems[id]; list;
2574 list = list->next_id_elem) {
2575 if (list->resume) {
2576 err = list->resume(list);
2577 if (err < 0)
2578 return err;
2579 }
2580 }
2581 }
2582 }
2583
2584 return snd_usb_mixer_activate(mixer);
2585}
2586#endif
2587
2588void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2589 struct usb_mixer_interface *mixer,
2590 int unitid)
2591{
2592 list->mixer = mixer;
2593 list->id = unitid;
2594 list->dump = snd_usb_mixer_dump_cval;
2595#ifdef CONFIG_PM
2596 list->resume = restore_mixer_value;
2597#endif
2598}
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/log2.h>
49#include <linux/slab.h>
50#include <linux/string.h>
51#include <linux/usb.h>
52#include <linux/usb/audio.h>
53#include <linux/usb/audio-v2.h>
54#include <linux/usb/audio-v3.h>
55
56#include <sound/core.h>
57#include <sound/control.h>
58#include <sound/hwdep.h>
59#include <sound/info.h>
60#include <sound/tlv.h>
61
62#include "usbaudio.h"
63#include "mixer.h"
64#include "helper.h"
65#include "mixer_quirks.h"
66#include "power.h"
67
68#define MAX_ID_ELEMS 256
69
70struct usb_audio_term {
71 int id;
72 int type;
73 int channels;
74 unsigned int chconfig;
75 int name;
76};
77
78struct usbmix_name_map;
79
80struct mixer_build {
81 struct snd_usb_audio *chip;
82 struct usb_mixer_interface *mixer;
83 unsigned char *buffer;
84 unsigned int buflen;
85 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
86 struct usb_audio_term oterm;
87 const struct usbmix_name_map *map;
88 const struct usbmix_selector_map *selector_map;
89};
90
91/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
92enum {
93 USB_XU_CLOCK_RATE = 0xe301,
94 USB_XU_CLOCK_SOURCE = 0xe302,
95 USB_XU_DIGITAL_IO_STATUS = 0xe303,
96 USB_XU_DEVICE_OPTIONS = 0xe304,
97 USB_XU_DIRECT_MONITORING = 0xe305,
98 USB_XU_METERING = 0xe306
99};
100enum {
101 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
102 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
103 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
104 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
105};
106
107/*
108 * manual mapping of mixer names
109 * if the mixer topology is too complicated and the parsed names are
110 * ambiguous, add the entries in usbmixer_maps.c.
111 */
112#include "mixer_maps.c"
113
114static const struct usbmix_name_map *
115find_map(struct mixer_build *state, int unitid, int control)
116{
117 const struct usbmix_name_map *p = state->map;
118
119 if (!p)
120 return NULL;
121
122 for (p = state->map; p->id; p++) {
123 if (p->id == unitid &&
124 (!control || !p->control || control == p->control))
125 return p;
126 }
127 return NULL;
128}
129
130/* get the mapped name if the unit matches */
131static int
132check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
133{
134 if (!p || !p->name)
135 return 0;
136
137 buflen--;
138 return strlcpy(buf, p->name, buflen);
139}
140
141/* ignore the error value if ignore_ctl_error flag is set */
142#define filter_error(cval, err) \
143 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
144
145/* check whether the control should be ignored */
146static inline int
147check_ignored_ctl(const struct usbmix_name_map *p)
148{
149 if (!p || p->name || p->dB)
150 return 0;
151 return 1;
152}
153
154/* dB mapping */
155static inline void check_mapped_dB(const struct usbmix_name_map *p,
156 struct usb_mixer_elem_info *cval)
157{
158 if (p && p->dB) {
159 cval->dBmin = p->dB->min;
160 cval->dBmax = p->dB->max;
161 cval->initialized = 1;
162 }
163}
164
165/* get the mapped selector source name */
166static int check_mapped_selector_name(struct mixer_build *state, int unitid,
167 int index, char *buf, int buflen)
168{
169 const struct usbmix_selector_map *p;
170
171 if (!state->selector_map)
172 return 0;
173 for (p = state->selector_map; p->id; p++) {
174 if (p->id == unitid && index < p->count)
175 return strlcpy(buf, p->names[index], buflen);
176 }
177 return 0;
178}
179
180/*
181 * find an audio control unit with the given unit id
182 */
183static void *find_audio_control_unit(struct mixer_build *state,
184 unsigned char unit)
185{
186 /* we just parse the header */
187 struct uac_feature_unit_descriptor *hdr = NULL;
188
189 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
190 USB_DT_CS_INTERFACE)) != NULL) {
191 if (hdr->bLength >= 4 &&
192 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
193 hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
194 hdr->bUnitID == unit)
195 return hdr;
196 }
197
198 return NULL;
199}
200
201/*
202 * copy a string with the given id
203 */
204static int snd_usb_copy_string_desc(struct mixer_build *state,
205 int index, char *buf, int maxlen)
206{
207 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
208
209 if (len < 0)
210 return 0;
211
212 buf[len] = 0;
213 return len;
214}
215
216/*
217 * convert from the byte/word on usb descriptor to the zero-based integer
218 */
219static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
220{
221 switch (cval->val_type) {
222 case USB_MIXER_BOOLEAN:
223 return !!val;
224 case USB_MIXER_INV_BOOLEAN:
225 return !val;
226 case USB_MIXER_U8:
227 val &= 0xff;
228 break;
229 case USB_MIXER_S8:
230 val &= 0xff;
231 if (val >= 0x80)
232 val -= 0x100;
233 break;
234 case USB_MIXER_U16:
235 val &= 0xffff;
236 break;
237 case USB_MIXER_S16:
238 val &= 0xffff;
239 if (val >= 0x8000)
240 val -= 0x10000;
241 break;
242 }
243 return val;
244}
245
246/*
247 * convert from the zero-based int to the byte/word for usb descriptor
248 */
249static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
250{
251 switch (cval->val_type) {
252 case USB_MIXER_BOOLEAN:
253 return !!val;
254 case USB_MIXER_INV_BOOLEAN:
255 return !val;
256 case USB_MIXER_S8:
257 case USB_MIXER_U8:
258 return val & 0xff;
259 case USB_MIXER_S16:
260 case USB_MIXER_U16:
261 return val & 0xffff;
262 }
263 return 0; /* not reached */
264}
265
266static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
267{
268 if (!cval->res)
269 cval->res = 1;
270 if (val < cval->min)
271 return 0;
272 else if (val >= cval->max)
273 return (cval->max - cval->min + cval->res - 1) / cval->res;
274 else
275 return (val - cval->min) / cval->res;
276}
277
278static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
279{
280 if (val < 0)
281 return cval->min;
282 if (!cval->res)
283 cval->res = 1;
284 val *= cval->res;
285 val += cval->min;
286 if (val > cval->max)
287 return cval->max;
288 return val;
289}
290
291static int uac2_ctl_value_size(int val_type)
292{
293 switch (val_type) {
294 case USB_MIXER_S32:
295 case USB_MIXER_U32:
296 return 4;
297 case USB_MIXER_S16:
298 case USB_MIXER_U16:
299 return 2;
300 default:
301 return 1;
302 }
303 return 0; /* unreachable */
304}
305
306
307/*
308 * retrieve a mixer value
309 */
310
311static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
312 int validx, int *value_ret)
313{
314 struct snd_usb_audio *chip = cval->head.mixer->chip;
315 unsigned char buf[2];
316 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
317 int timeout = 10;
318 int idx = 0, err;
319
320 err = snd_usb_lock_shutdown(chip);
321 if (err < 0)
322 return -EIO;
323
324 while (timeout-- > 0) {
325 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
326 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
327 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
328 validx, idx, buf, val_len);
329 if (err >= val_len) {
330 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
331 err = 0;
332 goto out;
333 } else if (err == -ETIMEDOUT) {
334 goto out;
335 }
336 }
337 usb_audio_dbg(chip,
338 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
339 request, validx, idx, cval->val_type);
340 err = -EINVAL;
341
342 out:
343 snd_usb_unlock_shutdown(chip);
344 return err;
345}
346
347static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
348 int validx, int *value_ret)
349{
350 struct snd_usb_audio *chip = cval->head.mixer->chip;
351 /* enough space for one range */
352 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
353 unsigned char *val;
354 int idx = 0, ret, val_size, size;
355 __u8 bRequest;
356
357 val_size = uac2_ctl_value_size(cval->val_type);
358
359 if (request == UAC_GET_CUR) {
360 bRequest = UAC2_CS_CUR;
361 size = val_size;
362 } else {
363 bRequest = UAC2_CS_RANGE;
364 size = sizeof(__u16) + 3 * val_size;
365 }
366
367 memset(buf, 0, sizeof(buf));
368
369 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
370 if (ret)
371 goto error;
372
373 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
374 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
375 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
376 validx, idx, buf, size);
377 snd_usb_unlock_shutdown(chip);
378
379 if (ret < 0) {
380error:
381 usb_audio_err(chip,
382 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
383 request, validx, idx, cval->val_type);
384 return ret;
385 }
386
387 /* FIXME: how should we handle multiple triplets here? */
388
389 switch (request) {
390 case UAC_GET_CUR:
391 val = buf;
392 break;
393 case UAC_GET_MIN:
394 val = buf + sizeof(__u16);
395 break;
396 case UAC_GET_MAX:
397 val = buf + sizeof(__u16) + val_size;
398 break;
399 case UAC_GET_RES:
400 val = buf + sizeof(__u16) + val_size * 2;
401 break;
402 default:
403 return -EINVAL;
404 }
405
406 *value_ret = convert_signed_value(cval,
407 snd_usb_combine_bytes(val, val_size));
408
409 return 0;
410}
411
412static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
413 int validx, int *value_ret)
414{
415 validx += cval->idx_off;
416
417 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
418 get_ctl_value_v1(cval, request, validx, value_ret) :
419 get_ctl_value_v2(cval, request, validx, value_ret);
420}
421
422static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
423 int validx, int *value)
424{
425 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
426}
427
428/* channel = 0: master, 1 = first channel */
429static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
430 int channel, int *value)
431{
432 return get_ctl_value(cval, UAC_GET_CUR,
433 (cval->control << 8) | channel,
434 value);
435}
436
437int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
438 int channel, int index, int *value)
439{
440 int err;
441
442 if (cval->cached & (1 << channel)) {
443 *value = cval->cache_val[index];
444 return 0;
445 }
446 err = get_cur_mix_raw(cval, channel, value);
447 if (err < 0) {
448 if (!cval->head.mixer->ignore_ctl_error)
449 usb_audio_dbg(cval->head.mixer->chip,
450 "cannot get current value for control %d ch %d: err = %d\n",
451 cval->control, channel, err);
452 return err;
453 }
454 cval->cached |= 1 << channel;
455 cval->cache_val[index] = *value;
456 return 0;
457}
458
459/*
460 * set a mixer value
461 */
462
463int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
464 int request, int validx, int value_set)
465{
466 struct snd_usb_audio *chip = cval->head.mixer->chip;
467 unsigned char buf[4];
468 int idx = 0, val_len, err, timeout = 10;
469
470 validx += cval->idx_off;
471
472
473 if (cval->head.mixer->protocol == UAC_VERSION_1) {
474 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
475 } else { /* UAC_VERSION_2/3 */
476 val_len = uac2_ctl_value_size(cval->val_type);
477
478 /* FIXME */
479 if (request != UAC_SET_CUR) {
480 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
481 return -EINVAL;
482 }
483
484 request = UAC2_CS_CUR;
485 }
486
487 value_set = convert_bytes_value(cval, value_set);
488 buf[0] = value_set & 0xff;
489 buf[1] = (value_set >> 8) & 0xff;
490 buf[2] = (value_set >> 16) & 0xff;
491 buf[3] = (value_set >> 24) & 0xff;
492
493 err = snd_usb_lock_shutdown(chip);
494 if (err < 0)
495 return -EIO;
496
497 while (timeout-- > 0) {
498 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
499 err = snd_usb_ctl_msg(chip->dev,
500 usb_sndctrlpipe(chip->dev, 0), request,
501 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
502 validx, idx, buf, val_len);
503 if (err >= 0) {
504 err = 0;
505 goto out;
506 } else if (err == -ETIMEDOUT) {
507 goto out;
508 }
509 }
510 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
511 request, validx, idx, cval->val_type, buf[0], buf[1]);
512 err = -EINVAL;
513
514 out:
515 snd_usb_unlock_shutdown(chip);
516 return err;
517}
518
519static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
520 int validx, int value)
521{
522 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
523}
524
525int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
526 int index, int value)
527{
528 int err;
529 unsigned int read_only = (channel == 0) ?
530 cval->master_readonly :
531 cval->ch_readonly & (1 << (channel - 1));
532
533 if (read_only) {
534 usb_audio_dbg(cval->head.mixer->chip,
535 "%s(): channel %d of control %d is read_only\n",
536 __func__, channel, cval->control);
537 return 0;
538 }
539
540 err = snd_usb_mixer_set_ctl_value(cval,
541 UAC_SET_CUR, (cval->control << 8) | channel,
542 value);
543 if (err < 0)
544 return err;
545 cval->cached |= 1 << channel;
546 cval->cache_val[index] = value;
547 return 0;
548}
549
550/*
551 * TLV callback for mixer volume controls
552 */
553int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
554 unsigned int size, unsigned int __user *_tlv)
555{
556 struct usb_mixer_elem_info *cval = kcontrol->private_data;
557 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
558
559 if (size < sizeof(scale))
560 return -ENOMEM;
561 if (cval->min_mute)
562 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
563 scale[2] = cval->dBmin;
564 scale[3] = cval->dBmax;
565 if (copy_to_user(_tlv, scale, sizeof(scale)))
566 return -EFAULT;
567 return 0;
568}
569
570/*
571 * parser routines begin here...
572 */
573
574static int parse_audio_unit(struct mixer_build *state, int unitid);
575
576
577/*
578 * check if the input/output channel routing is enabled on the given bitmap.
579 * used for mixer unit parser
580 */
581static int check_matrix_bitmap(unsigned char *bmap,
582 int ich, int och, int num_outs)
583{
584 int idx = ich * num_outs + och;
585 return bmap[idx >> 3] & (0x80 >> (idx & 7));
586}
587
588/*
589 * add an alsa control element
590 * search and increment the index until an empty slot is found.
591 *
592 * if failed, give up and free the control instance.
593 */
594
595int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
596 struct snd_kcontrol *kctl)
597{
598 struct usb_mixer_interface *mixer = list->mixer;
599 int err;
600
601 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
602 kctl->id.index++;
603 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
604 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
605 err);
606 return err;
607 }
608 list->kctl = kctl;
609 list->next_id_elem = mixer->id_elems[list->id];
610 mixer->id_elems[list->id] = list;
611 return 0;
612}
613
614/*
615 * get a terminal name string
616 */
617
618static struct iterm_name_combo {
619 int type;
620 char *name;
621} iterm_names[] = {
622 { 0x0300, "Output" },
623 { 0x0301, "Speaker" },
624 { 0x0302, "Headphone" },
625 { 0x0303, "HMD Audio" },
626 { 0x0304, "Desktop Speaker" },
627 { 0x0305, "Room Speaker" },
628 { 0x0306, "Com Speaker" },
629 { 0x0307, "LFE" },
630 { 0x0600, "External In" },
631 { 0x0601, "Analog In" },
632 { 0x0602, "Digital In" },
633 { 0x0603, "Line" },
634 { 0x0604, "Legacy In" },
635 { 0x0605, "IEC958 In" },
636 { 0x0606, "1394 DA Stream" },
637 { 0x0607, "1394 DV Stream" },
638 { 0x0700, "Embedded" },
639 { 0x0701, "Noise Source" },
640 { 0x0702, "Equalization Noise" },
641 { 0x0703, "CD" },
642 { 0x0704, "DAT" },
643 { 0x0705, "DCC" },
644 { 0x0706, "MiniDisk" },
645 { 0x0707, "Analog Tape" },
646 { 0x0708, "Phonograph" },
647 { 0x0709, "VCR Audio" },
648 { 0x070a, "Video Disk Audio" },
649 { 0x070b, "DVD Audio" },
650 { 0x070c, "TV Tuner Audio" },
651 { 0x070d, "Satellite Rec Audio" },
652 { 0x070e, "Cable Tuner Audio" },
653 { 0x070f, "DSS Audio" },
654 { 0x0710, "Radio Receiver" },
655 { 0x0711, "Radio Transmitter" },
656 { 0x0712, "Multi-Track Recorder" },
657 { 0x0713, "Synthesizer" },
658 { 0 },
659};
660
661static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
662 unsigned char *name, int maxlen, int term_only)
663{
664 struct iterm_name_combo *names;
665 int len;
666
667 if (iterm->name) {
668 len = snd_usb_copy_string_desc(state, iterm->name,
669 name, maxlen);
670 if (len)
671 return len;
672 }
673
674 /* virtual type - not a real terminal */
675 if (iterm->type >> 16) {
676 if (term_only)
677 return 0;
678 switch (iterm->type >> 16) {
679 case UAC_SELECTOR_UNIT:
680 strcpy(name, "Selector");
681 return 8;
682 case UAC1_PROCESSING_UNIT:
683 strcpy(name, "Process Unit");
684 return 12;
685 case UAC1_EXTENSION_UNIT:
686 strcpy(name, "Ext Unit");
687 return 8;
688 case UAC_MIXER_UNIT:
689 strcpy(name, "Mixer");
690 return 5;
691 default:
692 return sprintf(name, "Unit %d", iterm->id);
693 }
694 }
695
696 switch (iterm->type & 0xff00) {
697 case 0x0100:
698 strcpy(name, "PCM");
699 return 3;
700 case 0x0200:
701 strcpy(name, "Mic");
702 return 3;
703 case 0x0400:
704 strcpy(name, "Headset");
705 return 7;
706 case 0x0500:
707 strcpy(name, "Phone");
708 return 5;
709 }
710
711 for (names = iterm_names; names->type; names++) {
712 if (names->type == iterm->type) {
713 strcpy(name, names->name);
714 return strlen(names->name);
715 }
716 }
717
718 return 0;
719}
720
721/*
722 * parse the source unit recursively until it reaches to a terminal
723 * or a branched unit.
724 */
725static int check_input_term(struct mixer_build *state, int id,
726 struct usb_audio_term *term)
727{
728 int protocol = state->mixer->protocol;
729 int err;
730 void *p1;
731
732 memset(term, 0, sizeof(*term));
733 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
734 unsigned char *hdr = p1;
735 term->id = id;
736
737 if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
738 switch (hdr[2]) {
739 case UAC_INPUT_TERMINAL:
740 if (protocol == UAC_VERSION_1) {
741 struct uac_input_terminal_descriptor *d = p1;
742
743 term->type = le16_to_cpu(d->wTerminalType);
744 term->channels = d->bNrChannels;
745 term->chconfig = le16_to_cpu(d->wChannelConfig);
746 term->name = d->iTerminal;
747 } else { /* UAC_VERSION_2 */
748 struct uac2_input_terminal_descriptor *d = p1;
749
750 /* call recursively to verify that the
751 * referenced clock entity is valid */
752 err = check_input_term(state, d->bCSourceID, term);
753 if (err < 0)
754 return err;
755
756 /* save input term properties after recursion,
757 * to ensure they are not overriden by the
758 * recursion calls */
759 term->id = id;
760 term->type = le16_to_cpu(d->wTerminalType);
761 term->channels = d->bNrChannels;
762 term->chconfig = le32_to_cpu(d->bmChannelConfig);
763 term->name = d->iTerminal;
764 }
765 return 0;
766 case UAC_FEATURE_UNIT: {
767 /* the header is the same for v1 and v2 */
768 struct uac_feature_unit_descriptor *d = p1;
769
770 id = d->bSourceID;
771 break; /* continue to parse */
772 }
773 case UAC_MIXER_UNIT: {
774 struct uac_mixer_unit_descriptor *d = p1;
775
776 term->type = d->bDescriptorSubtype << 16; /* virtual type */
777 term->channels = uac_mixer_unit_bNrChannels(d);
778 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
779 term->name = uac_mixer_unit_iMixer(d);
780 return 0;
781 }
782 case UAC_SELECTOR_UNIT:
783 case UAC2_CLOCK_SELECTOR: {
784 struct uac_selector_unit_descriptor *d = p1;
785 /* call recursively to retrieve the channel info */
786 err = check_input_term(state, d->baSourceID[0], term);
787 if (err < 0)
788 return err;
789 term->type = d->bDescriptorSubtype << 16; /* virtual type */
790 term->id = id;
791 term->name = uac_selector_unit_iSelector(d);
792 return 0;
793 }
794 case UAC1_PROCESSING_UNIT:
795 case UAC1_EXTENSION_UNIT:
796 /* UAC2_PROCESSING_UNIT_V2 */
797 /* UAC2_EFFECT_UNIT */
798 case UAC2_EXTENSION_UNIT_V2: {
799 struct uac_processing_unit_descriptor *d = p1;
800
801 if (protocol == UAC_VERSION_2 &&
802 hdr[2] == UAC2_EFFECT_UNIT) {
803 /* UAC2/UAC1 unit IDs overlap here in an
804 * uncompatible way. Ignore this unit for now.
805 */
806 return 0;
807 }
808
809 if (d->bNrInPins) {
810 id = d->baSourceID[0];
811 break; /* continue to parse */
812 }
813 term->type = d->bDescriptorSubtype << 16; /* virtual type */
814 term->channels = uac_processing_unit_bNrChannels(d);
815 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
816 term->name = uac_processing_unit_iProcessing(d, protocol);
817 return 0;
818 }
819 case UAC2_CLOCK_SOURCE: {
820 struct uac_clock_source_descriptor *d = p1;
821
822 term->type = d->bDescriptorSubtype << 16; /* virtual type */
823 term->id = id;
824 term->name = d->iClockSource;
825 return 0;
826 }
827 default:
828 return -ENODEV;
829 }
830 } else { /* UAC_VERSION_3 */
831 switch (hdr[2]) {
832 case UAC_INPUT_TERMINAL: {
833 struct uac3_input_terminal_descriptor *d = p1;
834
835 /* call recursively to verify that the
836 * referenced clock entity is valid */
837 err = check_input_term(state, d->bCSourceID, term);
838 if (err < 0)
839 return err;
840
841 /* save input term properties after recursion,
842 * to ensure they are not overriden by the
843 * recursion calls */
844 term->id = id;
845 term->type = le16_to_cpu(d->wTerminalType);
846
847 /* REVISIT: UAC3 IT doesn't have channels/cfg */
848 term->channels = 0;
849 term->chconfig = 0;
850
851 term->name = le16_to_cpu(d->wTerminalDescrStr);
852 return 0;
853 }
854 case UAC3_FEATURE_UNIT: {
855 struct uac3_feature_unit_descriptor *d = p1;
856
857 id = d->bSourceID;
858 break; /* continue to parse */
859 }
860 case UAC3_CLOCK_SOURCE: {
861 struct uac3_clock_source_descriptor *d = p1;
862
863 term->type = d->bDescriptorSubtype << 16; /* virtual type */
864 term->id = id;
865 term->name = le16_to_cpu(d->wClockSourceStr);
866 return 0;
867 }
868 default:
869 return -ENODEV;
870 }
871 }
872 }
873 return -ENODEV;
874}
875
876/*
877 * Feature Unit
878 */
879
880/* feature unit control information */
881struct usb_feature_control_info {
882 int control;
883 const char *name;
884 int type; /* data type for uac1 */
885 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
886};
887
888static struct usb_feature_control_info audio_feature_info[] = {
889 { UAC_FU_MUTE, "Mute", USB_MIXER_INV_BOOLEAN, -1 },
890 { UAC_FU_VOLUME, "Volume", USB_MIXER_S16, -1 },
891 { UAC_FU_BASS, "Tone Control - Bass", USB_MIXER_S8, -1 },
892 { UAC_FU_MID, "Tone Control - Mid", USB_MIXER_S8, -1 },
893 { UAC_FU_TREBLE, "Tone Control - Treble", USB_MIXER_S8, -1 },
894 { UAC_FU_GRAPHIC_EQUALIZER, "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
895 { UAC_FU_AUTOMATIC_GAIN, "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
896 { UAC_FU_DELAY, "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
897 { UAC_FU_BASS_BOOST, "Bass Boost", USB_MIXER_BOOLEAN, -1 },
898 { UAC_FU_LOUDNESS, "Loudness", USB_MIXER_BOOLEAN, -1 },
899 /* UAC2 specific */
900 { UAC2_FU_INPUT_GAIN, "Input Gain Control", USB_MIXER_S16, -1 },
901 { UAC2_FU_INPUT_GAIN_PAD, "Input Gain Pad Control", USB_MIXER_S16, -1 },
902 { UAC2_FU_PHASE_INVERTER, "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
903};
904
905/* private_free callback */
906void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
907{
908 kfree(kctl->private_data);
909 kctl->private_data = NULL;
910}
911
912/*
913 * interface to ALSA control for feature/mixer units
914 */
915
916/* volume control quirks */
917static void volume_control_quirks(struct usb_mixer_elem_info *cval,
918 struct snd_kcontrol *kctl)
919{
920 struct snd_usb_audio *chip = cval->head.mixer->chip;
921 switch (chip->usb_id) {
922 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
923 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
924 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
925 cval->min = 0x0000;
926 cval->max = 0xffff;
927 cval->res = 0x00e6;
928 break;
929 }
930 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
931 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
932 cval->min = 0x00;
933 cval->max = 0xff;
934 break;
935 }
936 if (strstr(kctl->id.name, "Effect Return") != NULL) {
937 cval->min = 0xb706;
938 cval->max = 0xff7b;
939 cval->res = 0x0073;
940 break;
941 }
942 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
943 (strstr(kctl->id.name, "Effect Send") != NULL)) {
944 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
945 cval->max = 0xfcfe;
946 cval->res = 0x0073;
947 }
948 break;
949
950 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
951 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
952 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
953 usb_audio_info(chip,
954 "set quirk for FTU Effect Duration\n");
955 cval->min = 0x0000;
956 cval->max = 0x7f00;
957 cval->res = 0x0100;
958 break;
959 }
960 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
961 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
962 usb_audio_info(chip,
963 "set quirks for FTU Effect Feedback/Volume\n");
964 cval->min = 0x00;
965 cval->max = 0x7f;
966 break;
967 }
968 break;
969
970 case USB_ID(0x0d8c, 0x0103):
971 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
972 usb_audio_info(chip,
973 "set volume quirk for CM102-A+/102S+\n");
974 cval->min = -256;
975 }
976 break;
977
978 case USB_ID(0x0471, 0x0101):
979 case USB_ID(0x0471, 0x0104):
980 case USB_ID(0x0471, 0x0105):
981 case USB_ID(0x0672, 0x1041):
982 /* quirk for UDA1321/N101.
983 * note that detection between firmware 2.1.1.7 (N101)
984 * and later 2.1.1.21 is not very clear from datasheets.
985 * I hope that the min value is -15360 for newer firmware --jk
986 */
987 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
988 cval->min == -15616) {
989 usb_audio_info(chip,
990 "set volume quirk for UDA1321/N101 chip\n");
991 cval->max = -256;
992 }
993 break;
994
995 case USB_ID(0x046d, 0x09a4):
996 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
997 usb_audio_info(chip,
998 "set volume quirk for QuickCam E3500\n");
999 cval->min = 6080;
1000 cval->max = 8768;
1001 cval->res = 192;
1002 }
1003 break;
1004
1005 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1006 case USB_ID(0x046d, 0x0808):
1007 case USB_ID(0x046d, 0x0809):
1008 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1009 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1010 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1011 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1012 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1013 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1014 case USB_ID(0x046d, 0x0991):
1015 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1016 /* Most audio usb devices lie about volume resolution.
1017 * Most Logitech webcams have res = 384.
1018 * Probably there is some logitech magic behind this number --fishor
1019 */
1020 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1021 usb_audio_info(chip,
1022 "set resolution quirk: cval->res = 384\n");
1023 cval->res = 384;
1024 }
1025 break;
1026 }
1027}
1028
1029/*
1030 * retrieve the minimum and maximum values for the specified control
1031 */
1032static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1033 int default_min, struct snd_kcontrol *kctl)
1034{
1035 /* for failsafe */
1036 cval->min = default_min;
1037 cval->max = cval->min + 1;
1038 cval->res = 1;
1039 cval->dBmin = cval->dBmax = 0;
1040
1041 if (cval->val_type == USB_MIXER_BOOLEAN ||
1042 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1043 cval->initialized = 1;
1044 } else {
1045 int minchn = 0;
1046 if (cval->cmask) {
1047 int i;
1048 for (i = 0; i < MAX_CHANNELS; i++)
1049 if (cval->cmask & (1 << i)) {
1050 minchn = i + 1;
1051 break;
1052 }
1053 }
1054 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1055 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1056 usb_audio_err(cval->head.mixer->chip,
1057 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1058 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
1059 cval->control, cval->head.id);
1060 return -EINVAL;
1061 }
1062 if (get_ctl_value(cval, UAC_GET_RES,
1063 (cval->control << 8) | minchn,
1064 &cval->res) < 0) {
1065 cval->res = 1;
1066 } else {
1067 int last_valid_res = cval->res;
1068
1069 while (cval->res > 1) {
1070 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1071 (cval->control << 8) | minchn,
1072 cval->res / 2) < 0)
1073 break;
1074 cval->res /= 2;
1075 }
1076 if (get_ctl_value(cval, UAC_GET_RES,
1077 (cval->control << 8) | minchn, &cval->res) < 0)
1078 cval->res = last_valid_res;
1079 }
1080 if (cval->res == 0)
1081 cval->res = 1;
1082
1083 /* Additional checks for the proper resolution
1084 *
1085 * Some devices report smaller resolutions than actually
1086 * reacting. They don't return errors but simply clip
1087 * to the lower aligned value.
1088 */
1089 if (cval->min + cval->res < cval->max) {
1090 int last_valid_res = cval->res;
1091 int saved, test, check;
1092 get_cur_mix_raw(cval, minchn, &saved);
1093 for (;;) {
1094 test = saved;
1095 if (test < cval->max)
1096 test += cval->res;
1097 else
1098 test -= cval->res;
1099 if (test < cval->min || test > cval->max ||
1100 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1101 get_cur_mix_raw(cval, minchn, &check)) {
1102 cval->res = last_valid_res;
1103 break;
1104 }
1105 if (test == check)
1106 break;
1107 cval->res *= 2;
1108 }
1109 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1110 }
1111
1112 cval->initialized = 1;
1113 }
1114
1115 if (kctl)
1116 volume_control_quirks(cval, kctl);
1117
1118 /* USB descriptions contain the dB scale in 1/256 dB unit
1119 * while ALSA TLV contains in 1/100 dB unit
1120 */
1121 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1122 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1123 if (cval->dBmin > cval->dBmax) {
1124 /* something is wrong; assume it's either from/to 0dB */
1125 if (cval->dBmin < 0)
1126 cval->dBmax = 0;
1127 else if (cval->dBmin > 0)
1128 cval->dBmin = 0;
1129 if (cval->dBmin > cval->dBmax) {
1130 /* totally crap, return an error */
1131 return -EINVAL;
1132 }
1133 }
1134
1135 return 0;
1136}
1137
1138#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1139
1140/* get a feature/mixer unit info */
1141static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1142 struct snd_ctl_elem_info *uinfo)
1143{
1144 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1145
1146 if (cval->val_type == USB_MIXER_BOOLEAN ||
1147 cval->val_type == USB_MIXER_INV_BOOLEAN)
1148 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1149 else
1150 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1151 uinfo->count = cval->channels;
1152 if (cval->val_type == USB_MIXER_BOOLEAN ||
1153 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1154 uinfo->value.integer.min = 0;
1155 uinfo->value.integer.max = 1;
1156 } else {
1157 if (!cval->initialized) {
1158 get_min_max_with_quirks(cval, 0, kcontrol);
1159 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1160 kcontrol->vd[0].access &=
1161 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1162 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1163 snd_ctl_notify(cval->head.mixer->chip->card,
1164 SNDRV_CTL_EVENT_MASK_INFO,
1165 &kcontrol->id);
1166 }
1167 }
1168 uinfo->value.integer.min = 0;
1169 uinfo->value.integer.max =
1170 (cval->max - cval->min + cval->res - 1) / cval->res;
1171 }
1172 return 0;
1173}
1174
1175/* get the current value from feature/mixer unit */
1176static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1177 struct snd_ctl_elem_value *ucontrol)
1178{
1179 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1180 int c, cnt, val, err;
1181
1182 ucontrol->value.integer.value[0] = cval->min;
1183 if (cval->cmask) {
1184 cnt = 0;
1185 for (c = 0; c < MAX_CHANNELS; c++) {
1186 if (!(cval->cmask & (1 << c)))
1187 continue;
1188 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1189 if (err < 0)
1190 return filter_error(cval, err);
1191 val = get_relative_value(cval, val);
1192 ucontrol->value.integer.value[cnt] = val;
1193 cnt++;
1194 }
1195 return 0;
1196 } else {
1197 /* master channel */
1198 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1199 if (err < 0)
1200 return filter_error(cval, err);
1201 val = get_relative_value(cval, val);
1202 ucontrol->value.integer.value[0] = val;
1203 }
1204 return 0;
1205}
1206
1207/* put the current value to feature/mixer unit */
1208static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1209 struct snd_ctl_elem_value *ucontrol)
1210{
1211 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1212 int c, cnt, val, oval, err;
1213 int changed = 0;
1214
1215 if (cval->cmask) {
1216 cnt = 0;
1217 for (c = 0; c < MAX_CHANNELS; c++) {
1218 if (!(cval->cmask & (1 << c)))
1219 continue;
1220 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1221 if (err < 0)
1222 return filter_error(cval, err);
1223 val = ucontrol->value.integer.value[cnt];
1224 val = get_abs_value(cval, val);
1225 if (oval != val) {
1226 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1227 changed = 1;
1228 }
1229 cnt++;
1230 }
1231 } else {
1232 /* master channel */
1233 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1234 if (err < 0)
1235 return filter_error(cval, err);
1236 val = ucontrol->value.integer.value[0];
1237 val = get_abs_value(cval, val);
1238 if (val != oval) {
1239 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1240 changed = 1;
1241 }
1242 }
1243 return changed;
1244}
1245
1246/* get the boolean value from the master channel of a UAC control */
1247static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1248 struct snd_ctl_elem_value *ucontrol)
1249{
1250 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1251 int val, err;
1252
1253 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1254 if (err < 0)
1255 return filter_error(cval, err);
1256 val = (val != 0);
1257 ucontrol->value.integer.value[0] = val;
1258 return 0;
1259}
1260
1261static struct snd_kcontrol_new usb_feature_unit_ctl = {
1262 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1263 .name = "", /* will be filled later manually */
1264 .info = mixer_ctl_feature_info,
1265 .get = mixer_ctl_feature_get,
1266 .put = mixer_ctl_feature_put,
1267};
1268
1269/* the read-only variant */
1270static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1271 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1272 .name = "", /* will be filled later manually */
1273 .info = mixer_ctl_feature_info,
1274 .get = mixer_ctl_feature_get,
1275 .put = NULL,
1276};
1277
1278/*
1279 * A control which shows the boolean value from reading a UAC control on
1280 * the master channel.
1281 */
1282static struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1283 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1284 .name = "", /* will be filled later manually */
1285 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1286 .info = snd_ctl_boolean_mono_info,
1287 .get = mixer_ctl_master_bool_get,
1288 .put = NULL,
1289};
1290
1291/*
1292 * This symbol is exported in order to allow the mixer quirks to
1293 * hook up to the standard feature unit control mechanism
1294 */
1295struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1296
1297/*
1298 * build a feature control
1299 */
1300static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1301{
1302 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1303}
1304
1305/*
1306 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1307 * rename it to "Headphone". We determine if something is a headphone
1308 * similar to how udev determines form factor.
1309 */
1310static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1311 struct snd_card *card)
1312{
1313 const char *names_to_check[] = {
1314 "Headset", "headset", "Headphone", "headphone", NULL};
1315 const char **s;
1316 bool found = false;
1317
1318 if (strcmp("Speaker", kctl->id.name))
1319 return;
1320
1321 for (s = names_to_check; *s; s++)
1322 if (strstr(card->shortname, *s)) {
1323 found = true;
1324 break;
1325 }
1326
1327 if (!found)
1328 return;
1329
1330 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1331}
1332
1333static struct usb_feature_control_info *get_feature_control_info(int control)
1334{
1335 int i;
1336
1337 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1338 if (audio_feature_info[i].control == control)
1339 return &audio_feature_info[i];
1340 }
1341 return NULL;
1342}
1343
1344static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1345 unsigned int ctl_mask, int control,
1346 struct usb_audio_term *iterm, int unitid,
1347 int readonly_mask)
1348{
1349 struct uac_feature_unit_descriptor *desc = raw_desc;
1350 struct usb_feature_control_info *ctl_info;
1351 unsigned int len = 0;
1352 int mapped_name = 0;
1353 int nameid = uac_feature_unit_iFeature(desc);
1354 struct snd_kcontrol *kctl;
1355 struct usb_mixer_elem_info *cval;
1356 const struct usbmix_name_map *map;
1357 unsigned int range;
1358
1359 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1360 /* FIXME: not supported yet */
1361 return;
1362 }
1363
1364 map = find_map(state, unitid, control);
1365 if (check_ignored_ctl(map))
1366 return;
1367
1368 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1369 if (!cval)
1370 return;
1371 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1372 cval->control = control;
1373 cval->cmask = ctl_mask;
1374
1375 ctl_info = get_feature_control_info(control);
1376 if (!ctl_info) {
1377 kfree(cval);
1378 return;
1379 }
1380 if (state->mixer->protocol == UAC_VERSION_1)
1381 cval->val_type = ctl_info->type;
1382 else /* UAC_VERSION_2 */
1383 cval->val_type = ctl_info->type_uac2 >= 0 ?
1384 ctl_info->type_uac2 : ctl_info->type;
1385
1386 if (ctl_mask == 0) {
1387 cval->channels = 1; /* master channel */
1388 cval->master_readonly = readonly_mask;
1389 } else {
1390 int i, c = 0;
1391 for (i = 0; i < 16; i++)
1392 if (ctl_mask & (1 << i))
1393 c++;
1394 cval->channels = c;
1395 cval->ch_readonly = readonly_mask;
1396 }
1397
1398 /*
1399 * If all channels in the mask are marked read-only, make the control
1400 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1401 * issue write commands to read-only channels.
1402 */
1403 if (cval->channels == readonly_mask)
1404 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1405 else
1406 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1407
1408 if (!kctl) {
1409 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1410 kfree(cval);
1411 return;
1412 }
1413 kctl->private_free = snd_usb_mixer_elem_free;
1414
1415 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1416 mapped_name = len != 0;
1417 if (!len && nameid)
1418 len = snd_usb_copy_string_desc(state, nameid,
1419 kctl->id.name, sizeof(kctl->id.name));
1420
1421 switch (control) {
1422 case UAC_FU_MUTE:
1423 case UAC_FU_VOLUME:
1424 /*
1425 * determine the control name. the rule is:
1426 * - if a name id is given in descriptor, use it.
1427 * - if the connected input can be determined, then use the name
1428 * of terminal type.
1429 * - if the connected output can be determined, use it.
1430 * - otherwise, anonymous name.
1431 */
1432 if (!len) {
1433 len = get_term_name(state, iterm, kctl->id.name,
1434 sizeof(kctl->id.name), 1);
1435 if (!len)
1436 len = get_term_name(state, &state->oterm,
1437 kctl->id.name,
1438 sizeof(kctl->id.name), 1);
1439 if (!len)
1440 snprintf(kctl->id.name, sizeof(kctl->id.name),
1441 "Feature %d", unitid);
1442 }
1443
1444 if (!mapped_name)
1445 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1446
1447 /*
1448 * determine the stream direction:
1449 * if the connected output is USB stream, then it's likely a
1450 * capture stream. otherwise it should be playback (hopefully :)
1451 */
1452 if (!mapped_name && !(state->oterm.type >> 16)) {
1453 if ((state->oterm.type & 0xff00) == 0x0100)
1454 append_ctl_name(kctl, " Capture");
1455 else
1456 append_ctl_name(kctl, " Playback");
1457 }
1458 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1459 " Switch" : " Volume");
1460 break;
1461 default:
1462 if (!len)
1463 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1464 sizeof(kctl->id.name));
1465 break;
1466 }
1467
1468 /* get min/max values */
1469 get_min_max_with_quirks(cval, 0, kctl);
1470
1471 if (control == UAC_FU_VOLUME) {
1472 check_mapped_dB(map, cval);
1473 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1474 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1475 kctl->vd[0].access |=
1476 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1477 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1478 }
1479 }
1480
1481 snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1482
1483 range = (cval->max - cval->min) / cval->res;
1484 /*
1485 * Are there devices with volume range more than 255? I use a bit more
1486 * to be sure. 384 is a resolution magic number found on Logitech
1487 * devices. It will definitively catch all buggy Logitech devices.
1488 */
1489 if (range > 384) {
1490 usb_audio_warn(state->chip,
1491 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1492 range);
1493 usb_audio_warn(state->chip,
1494 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1495 cval->head.id, kctl->id.name, cval->channels,
1496 cval->min, cval->max, cval->res);
1497 }
1498
1499 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1500 cval->head.id, kctl->id.name, cval->channels,
1501 cval->min, cval->max, cval->res);
1502 snd_usb_mixer_add_control(&cval->head, kctl);
1503}
1504
1505static void get_connector_control_name(struct mixer_build *state,
1506 struct usb_audio_term *term,
1507 bool is_input, char *name, int name_size)
1508{
1509 int name_len = get_term_name(state, term, name, name_size, 0);
1510
1511 if (name_len == 0)
1512 strlcpy(name, "Unknown", name_size);
1513
1514 /*
1515 * sound/core/ctljack.c has a convention of naming jack controls
1516 * by ending in " Jack". Make it slightly more useful by
1517 * indicating Input or Output after the terminal name.
1518 */
1519 if (is_input)
1520 strlcat(name, " - Input Jack", name_size);
1521 else
1522 strlcat(name, " - Output Jack", name_size);
1523}
1524
1525/* Build a mixer control for a UAC connector control (jack-detect) */
1526static void build_connector_control(struct mixer_build *state,
1527 struct usb_audio_term *term, bool is_input)
1528{
1529 struct snd_kcontrol *kctl;
1530 struct usb_mixer_elem_info *cval;
1531
1532 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1533 if (!cval)
1534 return;
1535 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, term->id);
1536 /*
1537 * The first byte from reading the UAC2_TE_CONNECTOR control returns the
1538 * number of channels connected. This boolean ctl will simply report
1539 * if any channels are connected or not.
1540 * (Audio20_final.pdf Table 5-10: Connector Control CUR Parameter Block)
1541 */
1542 cval->control = UAC2_TE_CONNECTOR;
1543 cval->val_type = USB_MIXER_BOOLEAN;
1544 cval->channels = 1; /* report true if any channel is connected */
1545 cval->min = 0;
1546 cval->max = 1;
1547 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1548 if (!kctl) {
1549 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1550 kfree(cval);
1551 return;
1552 }
1553 get_connector_control_name(state, term, is_input, kctl->id.name,
1554 sizeof(kctl->id.name));
1555 kctl->private_free = snd_usb_mixer_elem_free;
1556 snd_usb_mixer_add_control(&cval->head, kctl);
1557}
1558
1559static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1560 void *_ftr)
1561{
1562 struct uac_clock_source_descriptor *hdr = _ftr;
1563 struct usb_mixer_elem_info *cval;
1564 struct snd_kcontrol *kctl;
1565 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1566 int ret;
1567
1568 if (state->mixer->protocol != UAC_VERSION_2)
1569 return -EINVAL;
1570
1571 if (hdr->bLength != sizeof(*hdr)) {
1572 usb_audio_dbg(state->chip,
1573 "Bogus clock source descriptor length of %d, ignoring.\n",
1574 hdr->bLength);
1575 return 0;
1576 }
1577
1578 /*
1579 * The only property of this unit we are interested in is the
1580 * clock source validity. If that isn't readable, just bail out.
1581 */
1582 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1583 UAC2_CS_CONTROL_CLOCK_VALID))
1584 return 0;
1585
1586 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1587 if (!cval)
1588 return -ENOMEM;
1589
1590 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1591
1592 cval->min = 0;
1593 cval->max = 1;
1594 cval->channels = 1;
1595 cval->val_type = USB_MIXER_BOOLEAN;
1596 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1597
1598 cval->master_readonly = 1;
1599 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1600 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1601
1602 if (!kctl) {
1603 kfree(cval);
1604 return -ENOMEM;
1605 }
1606
1607 kctl->private_free = snd_usb_mixer_elem_free;
1608 ret = snd_usb_copy_string_desc(state, hdr->iClockSource,
1609 name, sizeof(name));
1610 if (ret > 0)
1611 snprintf(kctl->id.name, sizeof(kctl->id.name),
1612 "%s Validity", name);
1613 else
1614 snprintf(kctl->id.name, sizeof(kctl->id.name),
1615 "Clock Source %d Validity", hdr->bClockID);
1616
1617 return snd_usb_mixer_add_control(&cval->head, kctl);
1618}
1619
1620/*
1621 * parse a feature unit
1622 *
1623 * most of controls are defined here.
1624 */
1625static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1626 void *_ftr)
1627{
1628 int channels, i, j;
1629 struct usb_audio_term iterm;
1630 unsigned int master_bits, first_ch_bits;
1631 int err, csize;
1632 struct uac_feature_unit_descriptor *hdr = _ftr;
1633 __u8 *bmaControls;
1634
1635 if (state->mixer->protocol == UAC_VERSION_1) {
1636 if (hdr->bLength < 7) {
1637 usb_audio_err(state->chip,
1638 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1639 unitid);
1640 return -EINVAL;
1641 }
1642 csize = hdr->bControlSize;
1643 if (!csize) {
1644 usb_audio_dbg(state->chip,
1645 "unit %u: invalid bControlSize == 0\n",
1646 unitid);
1647 return -EINVAL;
1648 }
1649 channels = (hdr->bLength - 7) / csize - 1;
1650 bmaControls = hdr->bmaControls;
1651 if (hdr->bLength < 7 + csize) {
1652 usb_audio_err(state->chip,
1653 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1654 unitid);
1655 return -EINVAL;
1656 }
1657 } else if (state->mixer->protocol == UAC_VERSION_2) {
1658 struct uac2_feature_unit_descriptor *ftr = _ftr;
1659 if (hdr->bLength < 6) {
1660 usb_audio_err(state->chip,
1661 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1662 unitid);
1663 return -EINVAL;
1664 }
1665 csize = 4;
1666 channels = (hdr->bLength - 6) / 4 - 1;
1667 bmaControls = ftr->bmaControls;
1668 if (hdr->bLength < 6 + csize) {
1669 usb_audio_err(state->chip,
1670 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1671 unitid);
1672 return -EINVAL;
1673 }
1674 } else { /* UAC_VERSION_3 */
1675 struct uac3_feature_unit_descriptor *ftr = _ftr;
1676
1677 if (hdr->bLength < 7) {
1678 usb_audio_err(state->chip,
1679 "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
1680 unitid);
1681 return -EINVAL;
1682 }
1683 csize = 4;
1684 channels = (ftr->bLength - 7) / 4 - 1;
1685 bmaControls = ftr->bmaControls;
1686 if (hdr->bLength < 7 + csize) {
1687 usb_audio_err(state->chip,
1688 "unit %u: invalid UAC3_FEATURE_UNIT descriptor\n",
1689 unitid);
1690 return -EINVAL;
1691 }
1692 }
1693
1694 /* parse the source unit */
1695 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1696 return err;
1697
1698 /* determine the input source type and name */
1699 err = check_input_term(state, hdr->bSourceID, &iterm);
1700 if (err < 0)
1701 return err;
1702
1703 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1704 /* master configuration quirks */
1705 switch (state->chip->usb_id) {
1706 case USB_ID(0x08bb, 0x2702):
1707 usb_audio_info(state->chip,
1708 "usbmixer: master volume quirk for PCM2702 chip\n");
1709 /* disable non-functional volume control */
1710 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1711 break;
1712 case USB_ID(0x1130, 0xf211):
1713 usb_audio_info(state->chip,
1714 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1715 /* disable non-functional volume control */
1716 channels = 0;
1717 break;
1718
1719 }
1720 if (channels > 0)
1721 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1722 else
1723 first_ch_bits = 0;
1724
1725 if (state->mixer->protocol == UAC_VERSION_1) {
1726 /* check all control types */
1727 for (i = 0; i < 10; i++) {
1728 unsigned int ch_bits = 0;
1729 int control = audio_feature_info[i].control;
1730
1731 for (j = 0; j < channels; j++) {
1732 unsigned int mask;
1733
1734 mask = snd_usb_combine_bytes(bmaControls +
1735 csize * (j+1), csize);
1736 if (mask & (1 << i))
1737 ch_bits |= (1 << j);
1738 }
1739 /* audio class v1 controls are never read-only */
1740
1741 /*
1742 * The first channel must be set
1743 * (for ease of programming).
1744 */
1745 if (ch_bits & 1)
1746 build_feature_ctl(state, _ftr, ch_bits, control,
1747 &iterm, unitid, 0);
1748 if (master_bits & (1 << i))
1749 build_feature_ctl(state, _ftr, 0, control,
1750 &iterm, unitid, 0);
1751 }
1752 } else { /* UAC_VERSION_2/3 */
1753 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1754 unsigned int ch_bits = 0;
1755 unsigned int ch_read_only = 0;
1756 int control = audio_feature_info[i].control;
1757
1758 for (j = 0; j < channels; j++) {
1759 unsigned int mask;
1760
1761 mask = snd_usb_combine_bytes(bmaControls +
1762 csize * (j+1), csize);
1763 if (uac_v2v3_control_is_readable(mask, control)) {
1764 ch_bits |= (1 << j);
1765 if (!uac_v2v3_control_is_writeable(mask, control))
1766 ch_read_only |= (1 << j);
1767 }
1768 }
1769
1770 /*
1771 * NOTE: build_feature_ctl() will mark the control
1772 * read-only if all channels are marked read-only in
1773 * the descriptors. Otherwise, the control will be
1774 * reported as writeable, but the driver will not
1775 * actually issue a write command for read-only
1776 * channels.
1777 */
1778
1779 /*
1780 * The first channel must be set
1781 * (for ease of programming).
1782 */
1783 if (ch_bits & 1)
1784 build_feature_ctl(state, _ftr, ch_bits, control,
1785 &iterm, unitid, ch_read_only);
1786 if (uac_v2v3_control_is_readable(master_bits, control))
1787 build_feature_ctl(state, _ftr, 0, control,
1788 &iterm, unitid,
1789 !uac_v2v3_control_is_writeable(master_bits,
1790 control));
1791 }
1792 }
1793
1794 return 0;
1795}
1796
1797/*
1798 * Mixer Unit
1799 */
1800
1801/*
1802 * build a mixer unit control
1803 *
1804 * the callbacks are identical with feature unit.
1805 * input channel number (zero based) is given in control field instead.
1806 */
1807static void build_mixer_unit_ctl(struct mixer_build *state,
1808 struct uac_mixer_unit_descriptor *desc,
1809 int in_pin, int in_ch, int unitid,
1810 struct usb_audio_term *iterm)
1811{
1812 struct usb_mixer_elem_info *cval;
1813 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1814 unsigned int i, len;
1815 struct snd_kcontrol *kctl;
1816 const struct usbmix_name_map *map;
1817
1818 map = find_map(state, unitid, 0);
1819 if (check_ignored_ctl(map))
1820 return;
1821
1822 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1823 if (!cval)
1824 return;
1825
1826 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1827 cval->control = in_ch + 1; /* based on 1 */
1828 cval->val_type = USB_MIXER_S16;
1829 for (i = 0; i < num_outs; i++) {
1830 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1831
1832 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1833 cval->cmask |= (1 << i);
1834 cval->channels++;
1835 }
1836 }
1837
1838 /* get min/max values */
1839 get_min_max(cval, 0);
1840
1841 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1842 if (!kctl) {
1843 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1844 kfree(cval);
1845 return;
1846 }
1847 kctl->private_free = snd_usb_mixer_elem_free;
1848
1849 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1850 if (!len)
1851 len = get_term_name(state, iterm, kctl->id.name,
1852 sizeof(kctl->id.name), 0);
1853 if (!len)
1854 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1855 append_ctl_name(kctl, " Volume");
1856
1857 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1858 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1859 snd_usb_mixer_add_control(&cval->head, kctl);
1860}
1861
1862static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
1863 void *raw_desc)
1864{
1865 struct usb_audio_term iterm;
1866 struct uac2_input_terminal_descriptor *d = raw_desc;
1867
1868 check_input_term(state, d->bTerminalID, &iterm);
1869 if (state->mixer->protocol == UAC_VERSION_2) {
1870 /* Check for jack detection. */
1871 if (uac_v2v3_control_is_readable(le16_to_cpu(d->bmControls),
1872 UAC2_TE_CONNECTOR)) {
1873 build_connector_control(state, &iterm, true);
1874 }
1875 }
1876 return 0;
1877}
1878
1879/*
1880 * parse a mixer unit
1881 */
1882static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1883 void *raw_desc)
1884{
1885 struct uac_mixer_unit_descriptor *desc = raw_desc;
1886 struct usb_audio_term iterm;
1887 int input_pins, num_ins, num_outs;
1888 int pin, ich, err;
1889
1890 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1891 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1892 usb_audio_err(state->chip,
1893 "invalid MIXER UNIT descriptor %d\n",
1894 unitid);
1895 return -EINVAL;
1896 }
1897
1898 num_ins = 0;
1899 ich = 0;
1900 for (pin = 0; pin < input_pins; pin++) {
1901 err = parse_audio_unit(state, desc->baSourceID[pin]);
1902 if (err < 0)
1903 continue;
1904 /* no bmControls field (e.g. Maya44) -> ignore */
1905 if (desc->bLength <= 10 + input_pins)
1906 continue;
1907 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1908 if (err < 0)
1909 return err;
1910 num_ins += iterm.channels;
1911 for (; ich < num_ins; ich++) {
1912 int och, ich_has_controls = 0;
1913
1914 for (och = 0; och < num_outs; och++) {
1915 __u8 *c = uac_mixer_unit_bmControls(desc,
1916 state->mixer->protocol);
1917
1918 if (check_matrix_bitmap(c, ich, och, num_outs)) {
1919 ich_has_controls = 1;
1920 break;
1921 }
1922 }
1923 if (ich_has_controls)
1924 build_mixer_unit_ctl(state, desc, pin, ich,
1925 unitid, &iterm);
1926 }
1927 }
1928 return 0;
1929}
1930
1931/*
1932 * Processing Unit / Extension Unit
1933 */
1934
1935/* get callback for processing/extension unit */
1936static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1937 struct snd_ctl_elem_value *ucontrol)
1938{
1939 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1940 int err, val;
1941
1942 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1943 if (err < 0) {
1944 ucontrol->value.integer.value[0] = cval->min;
1945 return filter_error(cval, err);
1946 }
1947 val = get_relative_value(cval, val);
1948 ucontrol->value.integer.value[0] = val;
1949 return 0;
1950}
1951
1952/* put callback for processing/extension unit */
1953static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1954 struct snd_ctl_elem_value *ucontrol)
1955{
1956 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1957 int val, oval, err;
1958
1959 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1960 if (err < 0)
1961 return filter_error(cval, err);
1962 val = ucontrol->value.integer.value[0];
1963 val = get_abs_value(cval, val);
1964 if (val != oval) {
1965 set_cur_ctl_value(cval, cval->control << 8, val);
1966 return 1;
1967 }
1968 return 0;
1969}
1970
1971/* alsa control interface for processing/extension unit */
1972static const struct snd_kcontrol_new mixer_procunit_ctl = {
1973 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1974 .name = "", /* will be filled later */
1975 .info = mixer_ctl_feature_info,
1976 .get = mixer_ctl_procunit_get,
1977 .put = mixer_ctl_procunit_put,
1978};
1979
1980/*
1981 * predefined data for processing units
1982 */
1983struct procunit_value_info {
1984 int control;
1985 char *suffix;
1986 int val_type;
1987 int min_value;
1988};
1989
1990struct procunit_info {
1991 int type;
1992 char *name;
1993 struct procunit_value_info *values;
1994};
1995
1996static struct procunit_value_info updown_proc_info[] = {
1997 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1998 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1999 { 0 }
2000};
2001static struct procunit_value_info prologic_proc_info[] = {
2002 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2003 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2004 { 0 }
2005};
2006static struct procunit_value_info threed_enh_proc_info[] = {
2007 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2008 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2009 { 0 }
2010};
2011static struct procunit_value_info reverb_proc_info[] = {
2012 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2013 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2014 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2015 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2016 { 0 }
2017};
2018static struct procunit_value_info chorus_proc_info[] = {
2019 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2020 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2021 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2022 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2023 { 0 }
2024};
2025static struct procunit_value_info dcr_proc_info[] = {
2026 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2027 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2028 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2029 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2030 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2031 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2032 { 0 }
2033};
2034
2035static struct procunit_info procunits[] = {
2036 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2037 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2038 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2039 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2040 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2041 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2042 { 0 },
2043};
2044/*
2045 * predefined data for extension units
2046 */
2047static struct procunit_value_info clock_rate_xu_info[] = {
2048 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2049 { 0 }
2050};
2051static struct procunit_value_info clock_source_xu_info[] = {
2052 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2053 { 0 }
2054};
2055static struct procunit_value_info spdif_format_xu_info[] = {
2056 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2057 { 0 }
2058};
2059static struct procunit_value_info soft_limit_xu_info[] = {
2060 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2061 { 0 }
2062};
2063static struct procunit_info extunits[] = {
2064 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2065 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2066 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2067 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2068 { 0 }
2069};
2070
2071/*
2072 * build a processing/extension unit
2073 */
2074static int build_audio_procunit(struct mixer_build *state, int unitid,
2075 void *raw_desc, struct procunit_info *list,
2076 char *name)
2077{
2078 struct uac_processing_unit_descriptor *desc = raw_desc;
2079 int num_ins = desc->bNrInPins;
2080 struct usb_mixer_elem_info *cval;
2081 struct snd_kcontrol *kctl;
2082 int i, err, nameid, type, len;
2083 struct procunit_info *info;
2084 struct procunit_value_info *valinfo;
2085 const struct usbmix_name_map *map;
2086 static struct procunit_value_info default_value_info[] = {
2087 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2088 { 0 }
2089 };
2090 static struct procunit_info default_info = {
2091 0, NULL, default_value_info
2092 };
2093
2094 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
2095 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
2096 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
2097 return -EINVAL;
2098 }
2099
2100 for (i = 0; i < num_ins; i++) {
2101 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2102 return err;
2103 }
2104
2105 type = le16_to_cpu(desc->wProcessType);
2106 for (info = list; info && info->type; info++)
2107 if (info->type == type)
2108 break;
2109 if (!info || !info->type)
2110 info = &default_info;
2111
2112 for (valinfo = info->values; valinfo->control; valinfo++) {
2113 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2114
2115 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
2116 continue;
2117 map = find_map(state, unitid, valinfo->control);
2118 if (check_ignored_ctl(map))
2119 continue;
2120 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2121 if (!cval)
2122 return -ENOMEM;
2123 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2124 cval->control = valinfo->control;
2125 cval->val_type = valinfo->val_type;
2126 cval->channels = 1;
2127
2128 /* get min/max values */
2129 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
2130 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
2131 /* FIXME: hard-coded */
2132 cval->min = 1;
2133 cval->max = control_spec[0];
2134 cval->res = 1;
2135 cval->initialized = 1;
2136 } else {
2137 if (type == USB_XU_CLOCK_RATE) {
2138 /*
2139 * E-Mu USB 0404/0202/TrackerPre/0204
2140 * samplerate control quirk
2141 */
2142 cval->min = 0;
2143 cval->max = 5;
2144 cval->res = 1;
2145 cval->initialized = 1;
2146 } else
2147 get_min_max(cval, valinfo->min_value);
2148 }
2149
2150 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2151 if (!kctl) {
2152 kfree(cval);
2153 return -ENOMEM;
2154 }
2155 kctl->private_free = snd_usb_mixer_elem_free;
2156
2157 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2158 /* nothing */ ;
2159 } else if (info->name) {
2160 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2161 } else {
2162 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2163 len = 0;
2164 if (nameid)
2165 len = snd_usb_copy_string_desc(state, nameid,
2166 kctl->id.name,
2167 sizeof(kctl->id.name));
2168 if (!len)
2169 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2170 }
2171 append_ctl_name(kctl, " ");
2172 append_ctl_name(kctl, valinfo->suffix);
2173
2174 usb_audio_dbg(state->chip,
2175 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2176 cval->head.id, kctl->id.name, cval->channels,
2177 cval->min, cval->max);
2178
2179 err = snd_usb_mixer_add_control(&cval->head, kctl);
2180 if (err < 0)
2181 return err;
2182 }
2183 return 0;
2184}
2185
2186static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2187 void *raw_desc)
2188{
2189 return build_audio_procunit(state, unitid, raw_desc,
2190 procunits, "Processing Unit");
2191}
2192
2193static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2194 void *raw_desc)
2195{
2196 /*
2197 * Note that we parse extension units with processing unit descriptors.
2198 * That's ok as the layout is the same.
2199 */
2200 return build_audio_procunit(state, unitid, raw_desc,
2201 extunits, "Extension Unit");
2202}
2203
2204/*
2205 * Selector Unit
2206 */
2207
2208/*
2209 * info callback for selector unit
2210 * use an enumerator type for routing
2211 */
2212static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2213 struct snd_ctl_elem_info *uinfo)
2214{
2215 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2216 const char **itemlist = (const char **)kcontrol->private_value;
2217
2218 if (snd_BUG_ON(!itemlist))
2219 return -EINVAL;
2220 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2221}
2222
2223/* get callback for selector unit */
2224static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2225 struct snd_ctl_elem_value *ucontrol)
2226{
2227 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2228 int val, err;
2229
2230 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2231 if (err < 0) {
2232 ucontrol->value.enumerated.item[0] = 0;
2233 return filter_error(cval, err);
2234 }
2235 val = get_relative_value(cval, val);
2236 ucontrol->value.enumerated.item[0] = val;
2237 return 0;
2238}
2239
2240/* put callback for selector unit */
2241static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2242 struct snd_ctl_elem_value *ucontrol)
2243{
2244 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2245 int val, oval, err;
2246
2247 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2248 if (err < 0)
2249 return filter_error(cval, err);
2250 val = ucontrol->value.enumerated.item[0];
2251 val = get_abs_value(cval, val);
2252 if (val != oval) {
2253 set_cur_ctl_value(cval, cval->control << 8, val);
2254 return 1;
2255 }
2256 return 0;
2257}
2258
2259/* alsa control interface for selector unit */
2260static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2261 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2262 .name = "", /* will be filled later */
2263 .info = mixer_ctl_selector_info,
2264 .get = mixer_ctl_selector_get,
2265 .put = mixer_ctl_selector_put,
2266};
2267
2268/*
2269 * private free callback.
2270 * free both private_data and private_value
2271 */
2272static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2273{
2274 int i, num_ins = 0;
2275
2276 if (kctl->private_data) {
2277 struct usb_mixer_elem_info *cval = kctl->private_data;
2278 num_ins = cval->max;
2279 kfree(cval);
2280 kctl->private_data = NULL;
2281 }
2282 if (kctl->private_value) {
2283 char **itemlist = (char **)kctl->private_value;
2284 for (i = 0; i < num_ins; i++)
2285 kfree(itemlist[i]);
2286 kfree(itemlist);
2287 kctl->private_value = 0;
2288 }
2289}
2290
2291/*
2292 * parse a selector unit
2293 */
2294static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2295 void *raw_desc)
2296{
2297 struct uac_selector_unit_descriptor *desc = raw_desc;
2298 unsigned int i, nameid, len;
2299 int err;
2300 struct usb_mixer_elem_info *cval;
2301 struct snd_kcontrol *kctl;
2302 const struct usbmix_name_map *map;
2303 char **namelist;
2304
2305 if (desc->bLength < 5 || !desc->bNrInPins ||
2306 desc->bLength < 5 + desc->bNrInPins) {
2307 usb_audio_err(state->chip,
2308 "invalid SELECTOR UNIT descriptor %d\n", unitid);
2309 return -EINVAL;
2310 }
2311
2312 for (i = 0; i < desc->bNrInPins; i++) {
2313 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2314 return err;
2315 }
2316
2317 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2318 return 0;
2319
2320 map = find_map(state, unitid, 0);
2321 if (check_ignored_ctl(map))
2322 return 0;
2323
2324 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2325 if (!cval)
2326 return -ENOMEM;
2327 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2328 cval->val_type = USB_MIXER_U8;
2329 cval->channels = 1;
2330 cval->min = 1;
2331 cval->max = desc->bNrInPins;
2332 cval->res = 1;
2333 cval->initialized = 1;
2334
2335 if (state->mixer->protocol == UAC_VERSION_1)
2336 cval->control = 0;
2337 else /* UAC_VERSION_2 */
2338 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2339 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2340
2341 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2342 if (!namelist) {
2343 kfree(cval);
2344 return -ENOMEM;
2345 }
2346#define MAX_ITEM_NAME_LEN 64
2347 for (i = 0; i < desc->bNrInPins; i++) {
2348 struct usb_audio_term iterm;
2349 len = 0;
2350 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2351 if (!namelist[i]) {
2352 while (i--)
2353 kfree(namelist[i]);
2354 kfree(namelist);
2355 kfree(cval);
2356 return -ENOMEM;
2357 }
2358 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2359 MAX_ITEM_NAME_LEN);
2360 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2361 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2362 if (! len)
2363 sprintf(namelist[i], "Input %u", i);
2364 }
2365
2366 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2367 if (! kctl) {
2368 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2369 kfree(namelist);
2370 kfree(cval);
2371 return -ENOMEM;
2372 }
2373 kctl->private_value = (unsigned long)namelist;
2374 kctl->private_free = usb_mixer_selector_elem_free;
2375
2376 /* check the static mapping table at first */
2377 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2378 if (!len) {
2379 /* no mapping ? */
2380 /* if iSelector is given, use it */
2381 nameid = uac_selector_unit_iSelector(desc);
2382 if (nameid)
2383 len = snd_usb_copy_string_desc(state, nameid,
2384 kctl->id.name,
2385 sizeof(kctl->id.name));
2386 /* ... or pick up the terminal name at next */
2387 if (!len)
2388 len = get_term_name(state, &state->oterm,
2389 kctl->id.name, sizeof(kctl->id.name), 0);
2390 /* ... or use the fixed string "USB" as the last resort */
2391 if (!len)
2392 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2393
2394 /* and add the proper suffix */
2395 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2396 append_ctl_name(kctl, " Clock Source");
2397 else if ((state->oterm.type & 0xff00) == 0x0100)
2398 append_ctl_name(kctl, " Capture Source");
2399 else
2400 append_ctl_name(kctl, " Playback Source");
2401 }
2402
2403 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2404 cval->head.id, kctl->id.name, desc->bNrInPins);
2405 return snd_usb_mixer_add_control(&cval->head, kctl);
2406}
2407
2408/*
2409 * parse an audio unit recursively
2410 */
2411
2412static int parse_audio_unit(struct mixer_build *state, int unitid)
2413{
2414 unsigned char *p1;
2415 int protocol = state->mixer->protocol;
2416
2417 if (test_and_set_bit(unitid, state->unitbitmap))
2418 return 0; /* the unit already visited */
2419
2420 p1 = find_audio_control_unit(state, unitid);
2421 if (!p1) {
2422 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2423 return -EINVAL;
2424 }
2425
2426 if (protocol == UAC_VERSION_1 || protocol == UAC_VERSION_2) {
2427 switch (p1[2]) {
2428 case UAC_INPUT_TERMINAL:
2429 return parse_audio_input_terminal(state, unitid, p1);
2430 case UAC_MIXER_UNIT:
2431 return parse_audio_mixer_unit(state, unitid, p1);
2432 case UAC2_CLOCK_SOURCE:
2433 return parse_clock_source_unit(state, unitid, p1);
2434 case UAC_SELECTOR_UNIT:
2435 case UAC2_CLOCK_SELECTOR:
2436 return parse_audio_selector_unit(state, unitid, p1);
2437 case UAC_FEATURE_UNIT:
2438 return parse_audio_feature_unit(state, unitid, p1);
2439 case UAC1_PROCESSING_UNIT:
2440 /* UAC2_EFFECT_UNIT has the same value */
2441 if (protocol == UAC_VERSION_1)
2442 return parse_audio_processing_unit(state, unitid, p1);
2443 else
2444 return 0; /* FIXME - effect units not implemented yet */
2445 case UAC1_EXTENSION_UNIT:
2446 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2447 if (protocol == UAC_VERSION_1)
2448 return parse_audio_extension_unit(state, unitid, p1);
2449 else /* UAC_VERSION_2 */
2450 return parse_audio_processing_unit(state, unitid, p1);
2451 case UAC2_EXTENSION_UNIT_V2:
2452 return parse_audio_extension_unit(state, unitid, p1);
2453 default:
2454 usb_audio_err(state->chip,
2455 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2456 return -EINVAL;
2457 }
2458 } else { /* UAC_VERSION_3 */
2459 switch (p1[2]) {
2460 case UAC_INPUT_TERMINAL:
2461 return 0; /* NOP */
2462 case UAC3_MIXER_UNIT:
2463 return parse_audio_mixer_unit(state, unitid, p1);
2464 case UAC3_CLOCK_SOURCE:
2465 return parse_clock_source_unit(state, unitid, p1);
2466 case UAC3_CLOCK_SELECTOR:
2467 return parse_audio_selector_unit(state, unitid, p1);
2468 case UAC3_FEATURE_UNIT:
2469 return parse_audio_feature_unit(state, unitid, p1);
2470 case UAC3_EFFECT_UNIT:
2471 return 0; /* FIXME - effect units not implemented yet */
2472 case UAC3_PROCESSING_UNIT:
2473 return parse_audio_processing_unit(state, unitid, p1);
2474 case UAC3_EXTENSION_UNIT:
2475 return parse_audio_extension_unit(state, unitid, p1);
2476 default:
2477 usb_audio_err(state->chip,
2478 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2479 return -EINVAL;
2480 }
2481 }
2482}
2483
2484static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2485{
2486 /* kill pending URBs */
2487 snd_usb_mixer_disconnect(mixer);
2488
2489 kfree(mixer->id_elems);
2490 if (mixer->urb) {
2491 kfree(mixer->urb->transfer_buffer);
2492 usb_free_urb(mixer->urb);
2493 }
2494 usb_free_urb(mixer->rc_urb);
2495 kfree(mixer->rc_setup_packet);
2496 kfree(mixer);
2497}
2498
2499static int snd_usb_mixer_dev_free(struct snd_device *device)
2500{
2501 struct usb_mixer_interface *mixer = device->device_data;
2502 snd_usb_mixer_free(mixer);
2503 return 0;
2504}
2505
2506/*
2507 * create mixer controls
2508 *
2509 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2510 */
2511static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2512{
2513 struct mixer_build state;
2514 int err;
2515 const struct usbmix_ctl_map *map;
2516 void *p;
2517
2518 memset(&state, 0, sizeof(state));
2519 state.chip = mixer->chip;
2520 state.mixer = mixer;
2521 state.buffer = mixer->hostif->extra;
2522 state.buflen = mixer->hostif->extralen;
2523
2524 /* check the mapping table */
2525 for (map = usbmix_ctl_maps; map->id; map++) {
2526 if (map->id == state.chip->usb_id) {
2527 state.map = map->map;
2528 state.selector_map = map->selector_map;
2529 mixer->ignore_ctl_error = map->ignore_ctl_error;
2530 break;
2531 }
2532 }
2533
2534 p = NULL;
2535 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2536 mixer->hostif->extralen,
2537 p, UAC_OUTPUT_TERMINAL)) != NULL) {
2538 if (mixer->protocol == UAC_VERSION_1) {
2539 struct uac1_output_terminal_descriptor *desc = p;
2540
2541 if (desc->bLength < sizeof(*desc))
2542 continue; /* invalid descriptor? */
2543 /* mark terminal ID as visited */
2544 set_bit(desc->bTerminalID, state.unitbitmap);
2545 state.oterm.id = desc->bTerminalID;
2546 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2547 state.oterm.name = desc->iTerminal;
2548 err = parse_audio_unit(&state, desc->bSourceID);
2549 if (err < 0 && err != -EINVAL)
2550 return err;
2551 } else if (mixer->protocol == UAC_VERSION_2) {
2552 struct uac2_output_terminal_descriptor *desc = p;
2553
2554 if (desc->bLength < sizeof(*desc))
2555 continue; /* invalid descriptor? */
2556 /* mark terminal ID as visited */
2557 set_bit(desc->bTerminalID, state.unitbitmap);
2558 state.oterm.id = desc->bTerminalID;
2559 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2560 state.oterm.name = desc->iTerminal;
2561 err = parse_audio_unit(&state, desc->bSourceID);
2562 if (err < 0 && err != -EINVAL)
2563 return err;
2564
2565 /*
2566 * For UAC2, use the same approach to also add the
2567 * clock selectors
2568 */
2569 err = parse_audio_unit(&state, desc->bCSourceID);
2570 if (err < 0 && err != -EINVAL)
2571 return err;
2572
2573 if (uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
2574 UAC2_TE_CONNECTOR)) {
2575 build_connector_control(&state, &state.oterm,
2576 false);
2577 }
2578 } else { /* UAC_VERSION_3 */
2579 struct uac3_output_terminal_descriptor *desc = p;
2580
2581 if (desc->bLength < sizeof(*desc))
2582 continue; /* invalid descriptor? */
2583 /* mark terminal ID as visited */
2584 set_bit(desc->bTerminalID, state.unitbitmap);
2585 state.oterm.id = desc->bTerminalID;
2586 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2587 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
2588 err = parse_audio_unit(&state, desc->bSourceID);
2589 if (err < 0 && err != -EINVAL)
2590 return err;
2591
2592 /*
2593 * For UAC3, use the same approach to also add the
2594 * clock selectors
2595 */
2596 err = parse_audio_unit(&state, desc->bCSourceID);
2597 if (err < 0 && err != -EINVAL)
2598 return err;
2599 }
2600 }
2601
2602 return 0;
2603}
2604
2605void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2606{
2607 struct usb_mixer_elem_list *list;
2608
2609 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2610 struct usb_mixer_elem_info *info =
2611 (struct usb_mixer_elem_info *)list;
2612 /* invalidate cache, so the value is read from the device */
2613 info->cached = 0;
2614 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2615 &list->kctl->id);
2616 }
2617}
2618
2619static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2620 struct usb_mixer_elem_list *list)
2621{
2622 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2623 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2624 "S8", "U8", "S16", "U16"};
2625 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2626 "channels=%i, type=\"%s\"\n", cval->head.id,
2627 cval->control, cval->cmask, cval->channels,
2628 val_types[cval->val_type]);
2629 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2630 cval->min, cval->max, cval->dBmin, cval->dBmax);
2631}
2632
2633static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2634 struct snd_info_buffer *buffer)
2635{
2636 struct snd_usb_audio *chip = entry->private_data;
2637 struct usb_mixer_interface *mixer;
2638 struct usb_mixer_elem_list *list;
2639 int unitid;
2640
2641 list_for_each_entry(mixer, &chip->mixer_list, list) {
2642 snd_iprintf(buffer,
2643 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2644 chip->usb_id, snd_usb_ctrl_intf(chip),
2645 mixer->ignore_ctl_error);
2646 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2647 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2648 for (list = mixer->id_elems[unitid]; list;
2649 list = list->next_id_elem) {
2650 snd_iprintf(buffer, " Unit: %i\n", list->id);
2651 if (list->kctl)
2652 snd_iprintf(buffer,
2653 " Control: name=\"%s\", index=%i\n",
2654 list->kctl->id.name,
2655 list->kctl->id.index);
2656 if (list->dump)
2657 list->dump(buffer, list);
2658 }
2659 }
2660 }
2661}
2662
2663static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2664 int attribute, int value, int index)
2665{
2666 struct usb_mixer_elem_list *list;
2667 __u8 unitid = (index >> 8) & 0xff;
2668 __u8 control = (value >> 8) & 0xff;
2669 __u8 channel = value & 0xff;
2670 unsigned int count = 0;
2671
2672 if (channel >= MAX_CHANNELS) {
2673 usb_audio_dbg(mixer->chip,
2674 "%s(): bogus channel number %d\n",
2675 __func__, channel);
2676 return;
2677 }
2678
2679 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2680 count++;
2681
2682 if (count == 0)
2683 return;
2684
2685 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2686 struct usb_mixer_elem_info *info;
2687
2688 if (!list->kctl)
2689 continue;
2690
2691 info = (struct usb_mixer_elem_info *)list;
2692 if (count > 1 && info->control != control)
2693 continue;
2694
2695 switch (attribute) {
2696 case UAC2_CS_CUR:
2697 /* invalidate cache, so the value is read from the device */
2698 if (channel)
2699 info->cached &= ~(1 << channel);
2700 else /* master channel */
2701 info->cached = 0;
2702
2703 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2704 &info->head.kctl->id);
2705 break;
2706
2707 case UAC2_CS_RANGE:
2708 /* TODO */
2709 break;
2710
2711 case UAC2_CS_MEM:
2712 /* TODO */
2713 break;
2714
2715 default:
2716 usb_audio_dbg(mixer->chip,
2717 "unknown attribute %d in interrupt\n",
2718 attribute);
2719 break;
2720 } /* switch */
2721 }
2722}
2723
2724static void snd_usb_mixer_interrupt(struct urb *urb)
2725{
2726 struct usb_mixer_interface *mixer = urb->context;
2727 int len = urb->actual_length;
2728 int ustatus = urb->status;
2729
2730 if (ustatus != 0)
2731 goto requeue;
2732
2733 if (mixer->protocol == UAC_VERSION_1) {
2734 struct uac1_status_word *status;
2735
2736 for (status = urb->transfer_buffer;
2737 len >= sizeof(*status);
2738 len -= sizeof(*status), status++) {
2739 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2740 status->bStatusType,
2741 status->bOriginator);
2742
2743 /* ignore any notifications not from the control interface */
2744 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2745 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2746 continue;
2747
2748 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2749 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2750 else
2751 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2752 }
2753 } else { /* UAC_VERSION_2 */
2754 struct uac2_interrupt_data_msg *msg;
2755
2756 for (msg = urb->transfer_buffer;
2757 len >= sizeof(*msg);
2758 len -= sizeof(*msg), msg++) {
2759 /* drop vendor specific and endpoint requests */
2760 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2761 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2762 continue;
2763
2764 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2765 le16_to_cpu(msg->wValue),
2766 le16_to_cpu(msg->wIndex));
2767 }
2768 }
2769
2770requeue:
2771 if (ustatus != -ENOENT &&
2772 ustatus != -ECONNRESET &&
2773 ustatus != -ESHUTDOWN) {
2774 urb->dev = mixer->chip->dev;
2775 usb_submit_urb(urb, GFP_ATOMIC);
2776 }
2777}
2778
2779/* create the handler for the optional status interrupt endpoint */
2780static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2781{
2782 struct usb_endpoint_descriptor *ep;
2783 void *transfer_buffer;
2784 int buffer_length;
2785 unsigned int epnum;
2786
2787 /* we need one interrupt input endpoint */
2788 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2789 return 0;
2790 ep = get_endpoint(mixer->hostif, 0);
2791 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2792 return 0;
2793
2794 epnum = usb_endpoint_num(ep);
2795 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2796 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2797 if (!transfer_buffer)
2798 return -ENOMEM;
2799 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2800 if (!mixer->urb) {
2801 kfree(transfer_buffer);
2802 return -ENOMEM;
2803 }
2804 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2805 usb_rcvintpipe(mixer->chip->dev, epnum),
2806 transfer_buffer, buffer_length,
2807 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2808 usb_submit_urb(mixer->urb, GFP_KERNEL);
2809 return 0;
2810}
2811
2812int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2813 int ignore_error)
2814{
2815 static struct snd_device_ops dev_ops = {
2816 .dev_free = snd_usb_mixer_dev_free
2817 };
2818 struct usb_mixer_interface *mixer;
2819 struct snd_info_entry *entry;
2820 int err;
2821
2822 strcpy(chip->card->mixername, "USB Mixer");
2823
2824 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2825 if (!mixer)
2826 return -ENOMEM;
2827 mixer->chip = chip;
2828 mixer->ignore_ctl_error = ignore_error;
2829 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2830 GFP_KERNEL);
2831 if (!mixer->id_elems) {
2832 kfree(mixer);
2833 return -ENOMEM;
2834 }
2835
2836 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2837 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2838 case UAC_VERSION_1:
2839 default:
2840 mixer->protocol = UAC_VERSION_1;
2841 break;
2842 case UAC_VERSION_2:
2843 mixer->protocol = UAC_VERSION_2;
2844 break;
2845 case UAC_VERSION_3:
2846 mixer->protocol = UAC_VERSION_3;
2847 break;
2848 }
2849
2850 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2851 (err = snd_usb_mixer_status_create(mixer)) < 0)
2852 goto _error;
2853
2854 snd_usb_mixer_apply_create_quirk(mixer);
2855
2856 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2857 if (err < 0)
2858 goto _error;
2859
2860 if (list_empty(&chip->mixer_list) &&
2861 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2862 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2863
2864 list_add(&mixer->list, &chip->mixer_list);
2865 return 0;
2866
2867_error:
2868 snd_usb_mixer_free(mixer);
2869 return err;
2870}
2871
2872void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2873{
2874 if (mixer->disconnected)
2875 return;
2876 if (mixer->urb)
2877 usb_kill_urb(mixer->urb);
2878 if (mixer->rc_urb)
2879 usb_kill_urb(mixer->rc_urb);
2880 mixer->disconnected = true;
2881}
2882
2883#ifdef CONFIG_PM
2884/* stop any bus activity of a mixer */
2885static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2886{
2887 usb_kill_urb(mixer->urb);
2888 usb_kill_urb(mixer->rc_urb);
2889}
2890
2891static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2892{
2893 int err;
2894
2895 if (mixer->urb) {
2896 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2897 if (err < 0)
2898 return err;
2899 }
2900
2901 return 0;
2902}
2903
2904int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2905{
2906 snd_usb_mixer_inactivate(mixer);
2907 return 0;
2908}
2909
2910static int restore_mixer_value(struct usb_mixer_elem_list *list)
2911{
2912 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2913 int c, err, idx;
2914
2915 if (cval->cmask) {
2916 idx = 0;
2917 for (c = 0; c < MAX_CHANNELS; c++) {
2918 if (!(cval->cmask & (1 << c)))
2919 continue;
2920 if (cval->cached & (1 << (c + 1))) {
2921 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2922 cval->cache_val[idx]);
2923 if (err < 0)
2924 return err;
2925 }
2926 idx++;
2927 }
2928 } else {
2929 /* master */
2930 if (cval->cached) {
2931 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2932 if (err < 0)
2933 return err;
2934 }
2935 }
2936
2937 return 0;
2938}
2939
2940int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2941{
2942 struct usb_mixer_elem_list *list;
2943 int id, err;
2944
2945 if (reset_resume) {
2946 /* restore cached mixer values */
2947 for (id = 0; id < MAX_ID_ELEMS; id++) {
2948 for (list = mixer->id_elems[id]; list;
2949 list = list->next_id_elem) {
2950 if (list->resume) {
2951 err = list->resume(list);
2952 if (err < 0)
2953 return err;
2954 }
2955 }
2956 }
2957 }
2958
2959 return snd_usb_mixer_activate(mixer);
2960}
2961#endif
2962
2963void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2964 struct usb_mixer_interface *mixer,
2965 int unitid)
2966{
2967 list->mixer = mixer;
2968 list->id = unitid;
2969 list->dump = snd_usb_mixer_dump_cval;
2970#ifdef CONFIG_PM
2971 list->resume = restore_mixer_value;
2972#endif
2973}