Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * (Tentative) USB Audio Driver for ALSA
4 *
5 * Mixer control part
6 *
7 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
8 *
9 * Many codes borrowed from audio.c by
10 * Alan Cox (alan@lxorguk.ukuu.org.uk)
11 * Thomas Sailer (sailer@ife.ee.ethz.ch)
12 */
13
14/*
15 * TODOs, for both the mixer and the streaming interfaces:
16 *
17 * - support for UAC2 effect units
18 * - support for graphical equalizers
19 * - RANGE and MEM set commands (UAC2)
20 * - RANGE and MEM interrupt dispatchers (UAC2)
21 * - audio channel clustering (UAC2)
22 * - audio sample rate converter units (UAC2)
23 * - proper handling of clock multipliers (UAC2)
24 * - dispatch clock change notifications (UAC2)
25 * - stop PCM streams which use a clock that became invalid
26 * - stop PCM streams which use a clock selector that has changed
27 * - parse available sample rates again when clock sources changed
28 */
29
30#include <linux/bitops.h>
31#include <linux/init.h>
32#include <linux/list.h>
33#include <linux/log2.h>
34#include <linux/slab.h>
35#include <linux/string.h>
36#include <linux/usb.h>
37#include <linux/usb/audio.h>
38#include <linux/usb/audio-v2.h>
39#include <linux/usb/audio-v3.h>
40
41#include <sound/core.h>
42#include <sound/control.h>
43#include <sound/hwdep.h>
44#include <sound/info.h>
45#include <sound/tlv.h>
46
47#include "usbaudio.h"
48#include "mixer.h"
49#include "helper.h"
50#include "mixer_quirks.h"
51#include "power.h"
52
53#define MAX_ID_ELEMS 256
54
55struct usb_audio_term {
56 int id;
57 int type;
58 int channels;
59 unsigned int chconfig;
60 int name;
61};
62
63struct usbmix_name_map;
64
65struct mixer_build {
66 struct snd_usb_audio *chip;
67 struct usb_mixer_interface *mixer;
68 unsigned char *buffer;
69 unsigned int buflen;
70 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
71 DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS);
72 struct usb_audio_term oterm;
73 const struct usbmix_name_map *map;
74 const struct usbmix_selector_map *selector_map;
75};
76
77/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
78enum {
79 USB_XU_CLOCK_RATE = 0xe301,
80 USB_XU_CLOCK_SOURCE = 0xe302,
81 USB_XU_DIGITAL_IO_STATUS = 0xe303,
82 USB_XU_DEVICE_OPTIONS = 0xe304,
83 USB_XU_DIRECT_MONITORING = 0xe305,
84 USB_XU_METERING = 0xe306
85};
86enum {
87 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
88 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
89 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
90 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
91};
92
93/*
94 * manual mapping of mixer names
95 * if the mixer topology is too complicated and the parsed names are
96 * ambiguous, add the entries in usbmixer_maps.c.
97 */
98#include "mixer_maps.c"
99
100static const struct usbmix_name_map *
101find_map(const struct usbmix_name_map *p, int unitid, int control)
102{
103 if (!p)
104 return NULL;
105
106 for (; p->id; p++) {
107 if (p->id == unitid &&
108 (!control || !p->control || control == p->control))
109 return p;
110 }
111 return NULL;
112}
113
114/* get the mapped name if the unit matches */
115static int
116check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
117{
118 int len;
119
120 if (!p || !p->name)
121 return 0;
122
123 buflen--;
124 len = strscpy(buf, p->name, buflen);
125 return len < 0 ? buflen : len;
126}
127
128/* ignore the error value if ignore_ctl_error flag is set */
129#define filter_error(cval, err) \
130 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
131
132/* check whether the control should be ignored */
133static inline int
134check_ignored_ctl(const struct usbmix_name_map *p)
135{
136 if (!p || p->name || p->dB)
137 return 0;
138 return 1;
139}
140
141/* dB mapping */
142static inline void check_mapped_dB(const struct usbmix_name_map *p,
143 struct usb_mixer_elem_info *cval)
144{
145 if (p && p->dB) {
146 cval->dBmin = p->dB->min;
147 cval->dBmax = p->dB->max;
148 cval->min_mute = p->dB->min_mute;
149 cval->initialized = 1;
150 }
151}
152
153/* get the mapped selector source name */
154static int check_mapped_selector_name(struct mixer_build *state, int unitid,
155 int index, char *buf, int buflen)
156{
157 const struct usbmix_selector_map *p;
158 int len;
159
160 if (!state->selector_map)
161 return 0;
162 for (p = state->selector_map; p->id; p++) {
163 if (p->id == unitid && index < p->count) {
164 len = strscpy(buf, p->names[index], buflen);
165 return len < 0 ? buflen : len;
166 }
167 }
168 return 0;
169}
170
171/*
172 * find an audio control unit with the given unit id
173 */
174static void *find_audio_control_unit(struct mixer_build *state,
175 unsigned char unit)
176{
177 /* we just parse the header */
178 struct uac_feature_unit_descriptor *hdr = NULL;
179
180 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
181 USB_DT_CS_INTERFACE)) != NULL) {
182 if (hdr->bLength >= 4 &&
183 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
184 hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
185 hdr->bUnitID == unit)
186 return hdr;
187 }
188
189 return NULL;
190}
191
192/*
193 * copy a string with the given id
194 */
195static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
196 int index, char *buf, int maxlen)
197{
198 int len = usb_string(chip->dev, index, buf, maxlen - 1);
199
200 if (len < 0)
201 return 0;
202
203 buf[len] = 0;
204 return len;
205}
206
207/*
208 * convert from the byte/word on usb descriptor to the zero-based integer
209 */
210static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
211{
212 switch (cval->val_type) {
213 case USB_MIXER_BOOLEAN:
214 return !!val;
215 case USB_MIXER_INV_BOOLEAN:
216 return !val;
217 case USB_MIXER_U8:
218 val &= 0xff;
219 break;
220 case USB_MIXER_S8:
221 val &= 0xff;
222 if (val >= 0x80)
223 val -= 0x100;
224 break;
225 case USB_MIXER_U16:
226 val &= 0xffff;
227 break;
228 case USB_MIXER_S16:
229 val &= 0xffff;
230 if (val >= 0x8000)
231 val -= 0x10000;
232 break;
233 }
234 return val;
235}
236
237/*
238 * convert from the zero-based int to the byte/word for usb descriptor
239 */
240static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
241{
242 switch (cval->val_type) {
243 case USB_MIXER_BOOLEAN:
244 return !!val;
245 case USB_MIXER_INV_BOOLEAN:
246 return !val;
247 case USB_MIXER_S8:
248 case USB_MIXER_U8:
249 return val & 0xff;
250 case USB_MIXER_S16:
251 case USB_MIXER_U16:
252 return val & 0xffff;
253 }
254 return 0; /* not reached */
255}
256
257static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
258{
259 if (!cval->res)
260 cval->res = 1;
261 if (val < cval->min)
262 return 0;
263 else if (val >= cval->max)
264 return DIV_ROUND_UP(cval->max - cval->min, cval->res);
265 else
266 return (val - cval->min) / cval->res;
267}
268
269static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
270{
271 if (val < 0)
272 return cval->min;
273 if (!cval->res)
274 cval->res = 1;
275 val *= cval->res;
276 val += cval->min;
277 if (val > cval->max)
278 return cval->max;
279 return val;
280}
281
282static int uac2_ctl_value_size(int val_type)
283{
284 switch (val_type) {
285 case USB_MIXER_S32:
286 case USB_MIXER_U32:
287 return 4;
288 case USB_MIXER_S16:
289 case USB_MIXER_U16:
290 return 2;
291 default:
292 return 1;
293 }
294 return 0; /* unreachable */
295}
296
297
298/*
299 * retrieve a mixer value
300 */
301
302static inline int mixer_ctrl_intf(struct usb_mixer_interface *mixer)
303{
304 return get_iface_desc(mixer->hostif)->bInterfaceNumber;
305}
306
307static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
308 int validx, int *value_ret)
309{
310 struct snd_usb_audio *chip = cval->head.mixer->chip;
311 unsigned char buf[2];
312 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
313 int timeout = 10;
314 int idx = 0, err;
315
316 err = snd_usb_lock_shutdown(chip);
317 if (err < 0)
318 return -EIO;
319
320 while (timeout-- > 0) {
321 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
322 err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
323 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
324 validx, idx, buf, val_len);
325 if (err >= val_len) {
326 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
327 err = 0;
328 goto out;
329 } else if (err == -ETIMEDOUT) {
330 goto out;
331 }
332 }
333 usb_audio_dbg(chip,
334 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
335 request, validx, idx, cval->val_type);
336 err = -EINVAL;
337
338 out:
339 snd_usb_unlock_shutdown(chip);
340 return err;
341}
342
343static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
344 int validx, int *value_ret)
345{
346 struct snd_usb_audio *chip = cval->head.mixer->chip;
347 /* enough space for one range */
348 unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
349 unsigned char *val;
350 int idx = 0, ret, val_size, size;
351 __u8 bRequest;
352
353 val_size = uac2_ctl_value_size(cval->val_type);
354
355 if (request == UAC_GET_CUR) {
356 bRequest = UAC2_CS_CUR;
357 size = val_size;
358 } else {
359 bRequest = UAC2_CS_RANGE;
360 size = sizeof(__u16) + 3 * val_size;
361 }
362
363 memset(buf, 0, sizeof(buf));
364
365 if (snd_usb_lock_shutdown(chip))
366 return -EIO;
367
368 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
369 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
370 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
371 validx, idx, buf, size);
372 snd_usb_unlock_shutdown(chip);
373
374 if (ret < 0) {
375 usb_audio_dbg(chip,
376 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
377 request, validx, idx, cval->val_type);
378 return ret;
379 }
380
381 /* FIXME: how should we handle multiple triplets here? */
382
383 switch (request) {
384 case UAC_GET_CUR:
385 val = buf;
386 break;
387 case UAC_GET_MIN:
388 val = buf + sizeof(__u16);
389 break;
390 case UAC_GET_MAX:
391 val = buf + sizeof(__u16) + val_size;
392 break;
393 case UAC_GET_RES:
394 val = buf + sizeof(__u16) + val_size * 2;
395 break;
396 default:
397 return -EINVAL;
398 }
399
400 *value_ret = convert_signed_value(cval,
401 snd_usb_combine_bytes(val, val_size));
402
403 return 0;
404}
405
406static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
407 int validx, int *value_ret)
408{
409 validx += cval->idx_off;
410
411 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
412 get_ctl_value_v1(cval, request, validx, value_ret) :
413 get_ctl_value_v2(cval, request, validx, value_ret);
414}
415
416static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
417 int validx, int *value)
418{
419 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
420}
421
422/* channel = 0: master, 1 = first channel */
423static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
424 int channel, int *value)
425{
426 return get_ctl_value(cval, UAC_GET_CUR,
427 (cval->control << 8) | channel,
428 value);
429}
430
431int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
432 int channel, int index, int *value)
433{
434 int err;
435
436 if (cval->cached & (1 << channel)) {
437 *value = cval->cache_val[index];
438 return 0;
439 }
440 err = get_cur_mix_raw(cval, channel, value);
441 if (err < 0) {
442 if (!cval->head.mixer->ignore_ctl_error)
443 usb_audio_dbg(cval->head.mixer->chip,
444 "cannot get current value for control %d ch %d: err = %d\n",
445 cval->control, channel, err);
446 return err;
447 }
448 cval->cached |= 1 << channel;
449 cval->cache_val[index] = *value;
450 return 0;
451}
452
453/*
454 * set a mixer value
455 */
456
457int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
458 int request, int validx, int value_set)
459{
460 struct snd_usb_audio *chip = cval->head.mixer->chip;
461 unsigned char buf[4];
462 int idx = 0, val_len, err, timeout = 10;
463
464 validx += cval->idx_off;
465
466
467 if (cval->head.mixer->protocol == UAC_VERSION_1) {
468 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
469 } else { /* UAC_VERSION_2/3 */
470 val_len = uac2_ctl_value_size(cval->val_type);
471
472 /* FIXME */
473 if (request != UAC_SET_CUR) {
474 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
475 return -EINVAL;
476 }
477
478 request = UAC2_CS_CUR;
479 }
480
481 value_set = convert_bytes_value(cval, value_set);
482 buf[0] = value_set & 0xff;
483 buf[1] = (value_set >> 8) & 0xff;
484 buf[2] = (value_set >> 16) & 0xff;
485 buf[3] = (value_set >> 24) & 0xff;
486
487 err = snd_usb_lock_shutdown(chip);
488 if (err < 0)
489 return -EIO;
490
491 while (timeout-- > 0) {
492 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
493 err = snd_usb_ctl_msg(chip->dev,
494 usb_sndctrlpipe(chip->dev, 0), request,
495 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
496 validx, idx, buf, val_len);
497 if (err >= 0) {
498 err = 0;
499 goto out;
500 } else if (err == -ETIMEDOUT) {
501 goto out;
502 }
503 }
504 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
505 request, validx, idx, cval->val_type, buf[0], buf[1]);
506 err = -EINVAL;
507
508 out:
509 snd_usb_unlock_shutdown(chip);
510 return err;
511}
512
513static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
514 int validx, int value)
515{
516 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
517}
518
519int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
520 int index, int value)
521{
522 int err;
523 unsigned int read_only = (channel == 0) ?
524 cval->master_readonly :
525 cval->ch_readonly & (1 << (channel - 1));
526
527 if (read_only) {
528 usb_audio_dbg(cval->head.mixer->chip,
529 "%s(): channel %d of control %d is read_only\n",
530 __func__, channel, cval->control);
531 return 0;
532 }
533
534 err = snd_usb_mixer_set_ctl_value(cval,
535 UAC_SET_CUR, (cval->control << 8) | channel,
536 value);
537 if (err < 0)
538 return err;
539 cval->cached |= 1 << channel;
540 cval->cache_val[index] = value;
541 return 0;
542}
543
544/*
545 * TLV callback for mixer volume controls
546 */
547int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
548 unsigned int size, unsigned int __user *_tlv)
549{
550 struct usb_mixer_elem_info *cval = kcontrol->private_data;
551 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
552
553 if (size < sizeof(scale))
554 return -ENOMEM;
555 if (cval->min_mute)
556 scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
557 scale[2] = cval->dBmin;
558 scale[3] = cval->dBmax;
559 if (copy_to_user(_tlv, scale, sizeof(scale)))
560 return -EFAULT;
561 return 0;
562}
563
564/*
565 * parser routines begin here...
566 */
567
568static int parse_audio_unit(struct mixer_build *state, int unitid);
569
570
571/*
572 * check if the input/output channel routing is enabled on the given bitmap.
573 * used for mixer unit parser
574 */
575static int check_matrix_bitmap(unsigned char *bmap,
576 int ich, int och, int num_outs)
577{
578 int idx = ich * num_outs + och;
579 return bmap[idx >> 3] & (0x80 >> (idx & 7));
580}
581
582/*
583 * add an alsa control element
584 * search and increment the index until an empty slot is found.
585 *
586 * if failed, give up and free the control instance.
587 */
588
589int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
590 struct snd_kcontrol *kctl,
591 bool is_std_info)
592{
593 struct usb_mixer_interface *mixer = list->mixer;
594 int err;
595
596 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
597 kctl->id.index++;
598 err = snd_ctl_add(mixer->chip->card, kctl);
599 if (err < 0) {
600 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
601 err);
602 return err;
603 }
604 list->kctl = kctl;
605 list->is_std_info = is_std_info;
606 list->next_id_elem = mixer->id_elems[list->id];
607 mixer->id_elems[list->id] = list;
608 return 0;
609}
610
611/*
612 * get a terminal name string
613 */
614
615static struct iterm_name_combo {
616 int type;
617 char *name;
618} iterm_names[] = {
619 { 0x0300, "Output" },
620 { 0x0301, "Speaker" },
621 { 0x0302, "Headphone" },
622 { 0x0303, "HMD Audio" },
623 { 0x0304, "Desktop Speaker" },
624 { 0x0305, "Room Speaker" },
625 { 0x0306, "Com Speaker" },
626 { 0x0307, "LFE" },
627 { 0x0600, "External In" },
628 { 0x0601, "Analog In" },
629 { 0x0602, "Digital In" },
630 { 0x0603, "Line" },
631 { 0x0604, "Legacy In" },
632 { 0x0605, "IEC958 In" },
633 { 0x0606, "1394 DA Stream" },
634 { 0x0607, "1394 DV Stream" },
635 { 0x0700, "Embedded" },
636 { 0x0701, "Noise Source" },
637 { 0x0702, "Equalization Noise" },
638 { 0x0703, "CD" },
639 { 0x0704, "DAT" },
640 { 0x0705, "DCC" },
641 { 0x0706, "MiniDisk" },
642 { 0x0707, "Analog Tape" },
643 { 0x0708, "Phonograph" },
644 { 0x0709, "VCR Audio" },
645 { 0x070a, "Video Disk Audio" },
646 { 0x070b, "DVD Audio" },
647 { 0x070c, "TV Tuner Audio" },
648 { 0x070d, "Satellite Rec Audio" },
649 { 0x070e, "Cable Tuner Audio" },
650 { 0x070f, "DSS Audio" },
651 { 0x0710, "Radio Receiver" },
652 { 0x0711, "Radio Transmitter" },
653 { 0x0712, "Multi-Track Recorder" },
654 { 0x0713, "Synthesizer" },
655 { 0 },
656};
657
658static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
659 unsigned char *name, int maxlen, int term_only)
660{
661 struct iterm_name_combo *names;
662 int len;
663
664 if (iterm->name) {
665 len = snd_usb_copy_string_desc(chip, iterm->name,
666 name, maxlen);
667 if (len)
668 return len;
669 }
670
671 /* virtual type - not a real terminal */
672 if (iterm->type >> 16) {
673 if (term_only)
674 return 0;
675 switch (iterm->type >> 16) {
676 case UAC3_SELECTOR_UNIT:
677 strcpy(name, "Selector");
678 return 8;
679 case UAC3_PROCESSING_UNIT:
680 strcpy(name, "Process Unit");
681 return 12;
682 case UAC3_EXTENSION_UNIT:
683 strcpy(name, "Ext Unit");
684 return 8;
685 case UAC3_MIXER_UNIT:
686 strcpy(name, "Mixer");
687 return 5;
688 default:
689 return sprintf(name, "Unit %d", iterm->id);
690 }
691 }
692
693 switch (iterm->type & 0xff00) {
694 case 0x0100:
695 strcpy(name, "PCM");
696 return 3;
697 case 0x0200:
698 strcpy(name, "Mic");
699 return 3;
700 case 0x0400:
701 strcpy(name, "Headset");
702 return 7;
703 case 0x0500:
704 strcpy(name, "Phone");
705 return 5;
706 }
707
708 for (names = iterm_names; names->type; names++) {
709 if (names->type == iterm->type) {
710 strcpy(name, names->name);
711 return strlen(names->name);
712 }
713 }
714
715 return 0;
716}
717
718/*
719 * Get logical cluster information for UAC3 devices.
720 */
721static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
722{
723 struct uac3_cluster_header_descriptor c_header;
724 int err;
725
726 err = snd_usb_ctl_msg(state->chip->dev,
727 usb_rcvctrlpipe(state->chip->dev, 0),
728 UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
729 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
730 cluster_id,
731 snd_usb_ctrl_intf(state->chip),
732 &c_header, sizeof(c_header));
733 if (err < 0)
734 goto error;
735 if (err != sizeof(c_header)) {
736 err = -EIO;
737 goto error;
738 }
739
740 return c_header.bNrChannels;
741
742error:
743 usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
744 return err;
745}
746
747/*
748 * Get number of channels for a Mixer Unit.
749 */
750static int uac_mixer_unit_get_channels(struct mixer_build *state,
751 struct uac_mixer_unit_descriptor *desc)
752{
753 int mu_channels;
754
755 switch (state->mixer->protocol) {
756 case UAC_VERSION_1:
757 case UAC_VERSION_2:
758 default:
759 if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
760 return 0; /* no bmControls -> skip */
761 mu_channels = uac_mixer_unit_bNrChannels(desc);
762 break;
763 case UAC_VERSION_3:
764 mu_channels = get_cluster_channels_v3(state,
765 uac3_mixer_unit_wClusterDescrID(desc));
766 break;
767 }
768
769 return mu_channels;
770}
771
772/*
773 * Parse Input Terminal Unit
774 */
775static int __check_input_term(struct mixer_build *state, int id,
776 struct usb_audio_term *term);
777
778static int parse_term_uac1_iterm_unit(struct mixer_build *state,
779 struct usb_audio_term *term,
780 void *p1, int id)
781{
782 struct uac_input_terminal_descriptor *d = p1;
783
784 term->type = le16_to_cpu(d->wTerminalType);
785 term->channels = d->bNrChannels;
786 term->chconfig = le16_to_cpu(d->wChannelConfig);
787 term->name = d->iTerminal;
788 return 0;
789}
790
791static int parse_term_uac2_iterm_unit(struct mixer_build *state,
792 struct usb_audio_term *term,
793 void *p1, int id)
794{
795 struct uac2_input_terminal_descriptor *d = p1;
796 int err;
797
798 /* call recursively to verify the referenced clock entity */
799 err = __check_input_term(state, d->bCSourceID, term);
800 if (err < 0)
801 return err;
802
803 /* save input term properties after recursion,
804 * to ensure they are not overriden by the recursion calls
805 */
806 term->id = id;
807 term->type = le16_to_cpu(d->wTerminalType);
808 term->channels = d->bNrChannels;
809 term->chconfig = le32_to_cpu(d->bmChannelConfig);
810 term->name = d->iTerminal;
811 return 0;
812}
813
814static int parse_term_uac3_iterm_unit(struct mixer_build *state,
815 struct usb_audio_term *term,
816 void *p1, int id)
817{
818 struct uac3_input_terminal_descriptor *d = p1;
819 int err;
820
821 /* call recursively to verify the referenced clock entity */
822 err = __check_input_term(state, d->bCSourceID, term);
823 if (err < 0)
824 return err;
825
826 /* save input term properties after recursion,
827 * to ensure they are not overriden by the recursion calls
828 */
829 term->id = id;
830 term->type = le16_to_cpu(d->wTerminalType);
831
832 err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
833 if (err < 0)
834 return err;
835 term->channels = err;
836
837 /* REVISIT: UAC3 IT doesn't have channels cfg */
838 term->chconfig = 0;
839
840 term->name = le16_to_cpu(d->wTerminalDescrStr);
841 return 0;
842}
843
844static int parse_term_mixer_unit(struct mixer_build *state,
845 struct usb_audio_term *term,
846 void *p1, int id)
847{
848 struct uac_mixer_unit_descriptor *d = p1;
849 int protocol = state->mixer->protocol;
850 int err;
851
852 err = uac_mixer_unit_get_channels(state, d);
853 if (err <= 0)
854 return err;
855
856 term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
857 term->channels = err;
858 if (protocol != UAC_VERSION_3) {
859 term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
860 term->name = uac_mixer_unit_iMixer(d);
861 }
862 return 0;
863}
864
865static int parse_term_selector_unit(struct mixer_build *state,
866 struct usb_audio_term *term,
867 void *p1, int id)
868{
869 struct uac_selector_unit_descriptor *d = p1;
870 int err;
871
872 /* call recursively to retrieve the channel info */
873 err = __check_input_term(state, d->baSourceID[0], term);
874 if (err < 0)
875 return err;
876 term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
877 term->id = id;
878 if (state->mixer->protocol != UAC_VERSION_3)
879 term->name = uac_selector_unit_iSelector(d);
880 return 0;
881}
882
883static int parse_term_proc_unit(struct mixer_build *state,
884 struct usb_audio_term *term,
885 void *p1, int id, int vtype)
886{
887 struct uac_processing_unit_descriptor *d = p1;
888 int protocol = state->mixer->protocol;
889 int err;
890
891 if (d->bNrInPins) {
892 /* call recursively to retrieve the channel info */
893 err = __check_input_term(state, d->baSourceID[0], term);
894 if (err < 0)
895 return err;
896 }
897
898 term->type = vtype << 16; /* virtual type */
899 term->id = id;
900
901 if (protocol == UAC_VERSION_3)
902 return 0;
903
904 if (!term->channels) {
905 term->channels = uac_processing_unit_bNrChannels(d);
906 term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
907 }
908 term->name = uac_processing_unit_iProcessing(d, protocol);
909 return 0;
910}
911
912static int parse_term_effect_unit(struct mixer_build *state,
913 struct usb_audio_term *term,
914 void *p1, int id)
915{
916 struct uac2_effect_unit_descriptor *d = p1;
917 int err;
918
919 err = __check_input_term(state, d->bSourceID, term);
920 if (err < 0)
921 return err;
922 term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
923 term->id = id;
924 return 0;
925}
926
927static int parse_term_uac2_clock_source(struct mixer_build *state,
928 struct usb_audio_term *term,
929 void *p1, int id)
930{
931 struct uac_clock_source_descriptor *d = p1;
932
933 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
934 term->id = id;
935 term->name = d->iClockSource;
936 return 0;
937}
938
939static int parse_term_uac3_clock_source(struct mixer_build *state,
940 struct usb_audio_term *term,
941 void *p1, int id)
942{
943 struct uac3_clock_source_descriptor *d = p1;
944
945 term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
946 term->id = id;
947 term->name = le16_to_cpu(d->wClockSourceStr);
948 return 0;
949}
950
951#define PTYPE(a, b) ((a) << 8 | (b))
952
953/*
954 * parse the source unit recursively until it reaches to a terminal
955 * or a branched unit.
956 */
957static int __check_input_term(struct mixer_build *state, int id,
958 struct usb_audio_term *term)
959{
960 int protocol = state->mixer->protocol;
961 void *p1;
962 unsigned char *hdr;
963
964 for (;;) {
965 /* a loop in the terminal chain? */
966 if (test_and_set_bit(id, state->termbitmap))
967 return -EINVAL;
968
969 p1 = find_audio_control_unit(state, id);
970 if (!p1)
971 break;
972 if (!snd_usb_validate_audio_desc(p1, protocol))
973 break; /* bad descriptor */
974
975 hdr = p1;
976 term->id = id;
977
978 switch (PTYPE(protocol, hdr[2])) {
979 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
980 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
981 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
982 /* the header is the same for all versions */
983 struct uac_feature_unit_descriptor *d = p1;
984
985 id = d->bSourceID;
986 break; /* continue to parse */
987 }
988 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
989 return parse_term_uac1_iterm_unit(state, term, p1, id);
990 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
991 return parse_term_uac2_iterm_unit(state, term, p1, id);
992 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
993 return parse_term_uac3_iterm_unit(state, term, p1, id);
994 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
995 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
996 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
997 return parse_term_mixer_unit(state, term, p1, id);
998 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
999 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
1000 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
1001 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
1002 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
1003 return parse_term_selector_unit(state, term, p1, id);
1004 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
1005 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
1006 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
1007 return parse_term_proc_unit(state, term, p1, id,
1008 UAC3_PROCESSING_UNIT);
1009 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
1010 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
1011 return parse_term_effect_unit(state, term, p1, id);
1012 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
1013 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
1014 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
1015 return parse_term_proc_unit(state, term, p1, id,
1016 UAC3_EXTENSION_UNIT);
1017 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
1018 return parse_term_uac2_clock_source(state, term, p1, id);
1019 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
1020 return parse_term_uac3_clock_source(state, term, p1, id);
1021 default:
1022 return -ENODEV;
1023 }
1024 }
1025 return -ENODEV;
1026}
1027
1028
1029static int check_input_term(struct mixer_build *state, int id,
1030 struct usb_audio_term *term)
1031{
1032 memset(term, 0, sizeof(*term));
1033 memset(state->termbitmap, 0, sizeof(state->termbitmap));
1034 return __check_input_term(state, id, term);
1035}
1036
1037/*
1038 * Feature Unit
1039 */
1040
1041/* feature unit control information */
1042struct usb_feature_control_info {
1043 int control;
1044 const char *name;
1045 int type; /* data type for uac1 */
1046 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
1047};
1048
1049static const struct usb_feature_control_info audio_feature_info[] = {
1050 { UAC_FU_MUTE, "Mute", USB_MIXER_INV_BOOLEAN, -1 },
1051 { UAC_FU_VOLUME, "Volume", USB_MIXER_S16, -1 },
1052 { UAC_FU_BASS, "Tone Control - Bass", USB_MIXER_S8, -1 },
1053 { UAC_FU_MID, "Tone Control - Mid", USB_MIXER_S8, -1 },
1054 { UAC_FU_TREBLE, "Tone Control - Treble", USB_MIXER_S8, -1 },
1055 { UAC_FU_GRAPHIC_EQUALIZER, "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1056 { UAC_FU_AUTOMATIC_GAIN, "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
1057 { UAC_FU_DELAY, "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
1058 { UAC_FU_BASS_BOOST, "Bass Boost", USB_MIXER_BOOLEAN, -1 },
1059 { UAC_FU_LOUDNESS, "Loudness", USB_MIXER_BOOLEAN, -1 },
1060 /* UAC2 specific */
1061 { UAC2_FU_INPUT_GAIN, "Input Gain Control", USB_MIXER_S16, -1 },
1062 { UAC2_FU_INPUT_GAIN_PAD, "Input Gain Pad Control", USB_MIXER_S16, -1 },
1063 { UAC2_FU_PHASE_INVERTER, "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1064};
1065
1066static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1067{
1068 kfree(cval);
1069}
1070
1071/* private_free callback */
1072void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1073{
1074 usb_mixer_elem_info_free(kctl->private_data);
1075 kctl->private_data = NULL;
1076}
1077
1078/*
1079 * interface to ALSA control for feature/mixer units
1080 */
1081
1082/* volume control quirks */
1083static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1084 struct snd_kcontrol *kctl)
1085{
1086 struct snd_usb_audio *chip = cval->head.mixer->chip;
1087 switch (chip->usb_id) {
1088 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1089 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1090 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1091 cval->min = 0x0000;
1092 cval->max = 0xffff;
1093 cval->res = 0x00e6;
1094 break;
1095 }
1096 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1097 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1098 cval->min = 0x00;
1099 cval->max = 0xff;
1100 break;
1101 }
1102 if (strstr(kctl->id.name, "Effect Return") != NULL) {
1103 cval->min = 0xb706;
1104 cval->max = 0xff7b;
1105 cval->res = 0x0073;
1106 break;
1107 }
1108 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1109 (strstr(kctl->id.name, "Effect Send") != NULL)) {
1110 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1111 cval->max = 0xfcfe;
1112 cval->res = 0x0073;
1113 }
1114 break;
1115
1116 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1117 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1118 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1119 usb_audio_info(chip,
1120 "set quirk for FTU Effect Duration\n");
1121 cval->min = 0x0000;
1122 cval->max = 0x7f00;
1123 cval->res = 0x0100;
1124 break;
1125 }
1126 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1127 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1128 usb_audio_info(chip,
1129 "set quirks for FTU Effect Feedback/Volume\n");
1130 cval->min = 0x00;
1131 cval->max = 0x7f;
1132 break;
1133 }
1134 break;
1135
1136 case USB_ID(0x0d8c, 0x0103):
1137 if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1138 usb_audio_info(chip,
1139 "set volume quirk for CM102-A+/102S+\n");
1140 cval->min = -256;
1141 }
1142 break;
1143
1144 case USB_ID(0x0471, 0x0101):
1145 case USB_ID(0x0471, 0x0104):
1146 case USB_ID(0x0471, 0x0105):
1147 case USB_ID(0x0672, 0x1041):
1148 /* quirk for UDA1321/N101.
1149 * note that detection between firmware 2.1.1.7 (N101)
1150 * and later 2.1.1.21 is not very clear from datasheets.
1151 * I hope that the min value is -15360 for newer firmware --jk
1152 */
1153 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1154 cval->min == -15616) {
1155 usb_audio_info(chip,
1156 "set volume quirk for UDA1321/N101 chip\n");
1157 cval->max = -256;
1158 }
1159 break;
1160
1161 case USB_ID(0x046d, 0x09a4):
1162 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1163 usb_audio_info(chip,
1164 "set volume quirk for QuickCam E3500\n");
1165 cval->min = 6080;
1166 cval->max = 8768;
1167 cval->res = 192;
1168 }
1169 break;
1170
1171 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1172 case USB_ID(0x046d, 0x0808):
1173 case USB_ID(0x046d, 0x0809):
1174 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1175 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1176 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1177 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1178 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1179 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1180 case USB_ID(0x046d, 0x0991):
1181 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1182 /* Most audio usb devices lie about volume resolution.
1183 * Most Logitech webcams have res = 384.
1184 * Probably there is some logitech magic behind this number --fishor
1185 */
1186 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1187 usb_audio_info(chip,
1188 "set resolution quirk: cval->res = 384\n");
1189 cval->res = 384;
1190 }
1191 break;
1192 case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */
1193 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1194 strstr(kctl->id.name, "Capture Volume") != NULL) {
1195 cval->min >>= 8;
1196 cval->max = 0;
1197 cval->res = 1;
1198 }
1199 break;
1200 case USB_ID(0x1224, 0x2a25): /* Jieli Technology USB PHY 2.0 */
1201 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1202 usb_audio_info(chip,
1203 "set resolution quirk: cval->res = 16\n");
1204 cval->res = 16;
1205 }
1206 break;
1207 case USB_ID(0x1bcf, 0x2283): /* NexiGo N930AF FHD Webcam */
1208 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1209 usb_audio_info(chip,
1210 "set resolution quirk: cval->res = 16\n");
1211 cval->res = 16;
1212 }
1213 break;
1214 }
1215}
1216
1217/* forcibly initialize the current mixer value; if GET_CUR fails, set to
1218 * the minimum as default
1219 */
1220static void init_cur_mix_raw(struct usb_mixer_elem_info *cval, int ch, int idx)
1221{
1222 int val, err;
1223
1224 err = snd_usb_get_cur_mix_value(cval, ch, idx, &val);
1225 if (!err)
1226 return;
1227 if (!cval->head.mixer->ignore_ctl_error)
1228 usb_audio_warn(cval->head.mixer->chip,
1229 "%d:%d: failed to get current value for ch %d (%d)\n",
1230 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1231 ch, err);
1232 snd_usb_set_cur_mix_value(cval, ch, idx, cval->min);
1233}
1234
1235/*
1236 * retrieve the minimum and maximum values for the specified control
1237 */
1238static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1239 int default_min, struct snd_kcontrol *kctl)
1240{
1241 int i, idx;
1242
1243 /* for failsafe */
1244 cval->min = default_min;
1245 cval->max = cval->min + 1;
1246 cval->res = 1;
1247 cval->dBmin = cval->dBmax = 0;
1248
1249 if (cval->val_type == USB_MIXER_BOOLEAN ||
1250 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1251 cval->initialized = 1;
1252 } else {
1253 int minchn = 0;
1254 if (cval->cmask) {
1255 for (i = 0; i < MAX_CHANNELS; i++)
1256 if (cval->cmask & (1 << i)) {
1257 minchn = i + 1;
1258 break;
1259 }
1260 }
1261 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1262 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1263 usb_audio_err(cval->head.mixer->chip,
1264 "%d:%d: cannot get min/max values for control %d (id %d)\n",
1265 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1266 cval->control, cval->head.id);
1267 return -EINVAL;
1268 }
1269 if (get_ctl_value(cval, UAC_GET_RES,
1270 (cval->control << 8) | minchn,
1271 &cval->res) < 0) {
1272 cval->res = 1;
1273 } else if (cval->head.mixer->protocol == UAC_VERSION_1) {
1274 int last_valid_res = cval->res;
1275
1276 while (cval->res > 1) {
1277 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1278 (cval->control << 8) | minchn,
1279 cval->res / 2) < 0)
1280 break;
1281 cval->res /= 2;
1282 }
1283 if (get_ctl_value(cval, UAC_GET_RES,
1284 (cval->control << 8) | minchn, &cval->res) < 0)
1285 cval->res = last_valid_res;
1286 }
1287 if (cval->res == 0)
1288 cval->res = 1;
1289
1290 /* Additional checks for the proper resolution
1291 *
1292 * Some devices report smaller resolutions than actually
1293 * reacting. They don't return errors but simply clip
1294 * to the lower aligned value.
1295 */
1296 if (cval->min + cval->res < cval->max) {
1297 int last_valid_res = cval->res;
1298 int saved, test, check;
1299 if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1300 goto no_res_check;
1301 for (;;) {
1302 test = saved;
1303 if (test < cval->max)
1304 test += cval->res;
1305 else
1306 test -= cval->res;
1307 if (test < cval->min || test > cval->max ||
1308 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1309 get_cur_mix_raw(cval, minchn, &check)) {
1310 cval->res = last_valid_res;
1311 break;
1312 }
1313 if (test == check)
1314 break;
1315 cval->res *= 2;
1316 }
1317 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1318 }
1319
1320no_res_check:
1321 cval->initialized = 1;
1322 }
1323
1324 if (kctl)
1325 volume_control_quirks(cval, kctl);
1326
1327 /* USB descriptions contain the dB scale in 1/256 dB unit
1328 * while ALSA TLV contains in 1/100 dB unit
1329 */
1330 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1331 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1332 if (cval->dBmin > cval->dBmax) {
1333 /* something is wrong; assume it's either from/to 0dB */
1334 if (cval->dBmin < 0)
1335 cval->dBmax = 0;
1336 else if (cval->dBmin > 0)
1337 cval->dBmin = 0;
1338 if (cval->dBmin > cval->dBmax) {
1339 /* totally crap, return an error */
1340 return -EINVAL;
1341 }
1342 } else {
1343 /* if the max volume is too low, it's likely a bogus range;
1344 * here we use -96dB as the threshold
1345 */
1346 if (cval->dBmax <= -9600) {
1347 usb_audio_info(cval->head.mixer->chip,
1348 "%d:%d: bogus dB values (%d/%d), disabling dB reporting\n",
1349 cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1350 cval->dBmin, cval->dBmax);
1351 cval->dBmin = cval->dBmax = 0;
1352 }
1353 }
1354
1355 /* initialize all elements */
1356 if (!cval->cmask) {
1357 init_cur_mix_raw(cval, 0, 0);
1358 } else {
1359 idx = 0;
1360 for (i = 0; i < MAX_CHANNELS; i++) {
1361 if (cval->cmask & (1 << i)) {
1362 init_cur_mix_raw(cval, i + 1, idx);
1363 idx++;
1364 }
1365 }
1366 }
1367
1368 return 0;
1369}
1370
1371#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1372
1373/* get a feature/mixer unit info */
1374static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1375 struct snd_ctl_elem_info *uinfo)
1376{
1377 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1378
1379 if (cval->val_type == USB_MIXER_BOOLEAN ||
1380 cval->val_type == USB_MIXER_INV_BOOLEAN)
1381 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1382 else
1383 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1384 uinfo->count = cval->channels;
1385 if (cval->val_type == USB_MIXER_BOOLEAN ||
1386 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1387 uinfo->value.integer.min = 0;
1388 uinfo->value.integer.max = 1;
1389 } else {
1390 if (!cval->initialized) {
1391 get_min_max_with_quirks(cval, 0, kcontrol);
1392 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1393 kcontrol->vd[0].access &=
1394 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1395 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1396 snd_ctl_notify(cval->head.mixer->chip->card,
1397 SNDRV_CTL_EVENT_MASK_INFO,
1398 &kcontrol->id);
1399 }
1400 }
1401 uinfo->value.integer.min = 0;
1402 uinfo->value.integer.max =
1403 DIV_ROUND_UP(cval->max - cval->min, cval->res);
1404 }
1405 return 0;
1406}
1407
1408/* get the current value from feature/mixer unit */
1409static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1410 struct snd_ctl_elem_value *ucontrol)
1411{
1412 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1413 int c, cnt, val, err;
1414
1415 ucontrol->value.integer.value[0] = cval->min;
1416 if (cval->cmask) {
1417 cnt = 0;
1418 for (c = 0; c < MAX_CHANNELS; c++) {
1419 if (!(cval->cmask & (1 << c)))
1420 continue;
1421 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1422 if (err < 0)
1423 return filter_error(cval, err);
1424 val = get_relative_value(cval, val);
1425 ucontrol->value.integer.value[cnt] = val;
1426 cnt++;
1427 }
1428 return 0;
1429 } else {
1430 /* master channel */
1431 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1432 if (err < 0)
1433 return filter_error(cval, err);
1434 val = get_relative_value(cval, val);
1435 ucontrol->value.integer.value[0] = val;
1436 }
1437 return 0;
1438}
1439
1440/* put the current value to feature/mixer unit */
1441static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1442 struct snd_ctl_elem_value *ucontrol)
1443{
1444 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1445 int c, cnt, val, oval, err;
1446 int changed = 0;
1447
1448 if (cval->cmask) {
1449 cnt = 0;
1450 for (c = 0; c < MAX_CHANNELS; c++) {
1451 if (!(cval->cmask & (1 << c)))
1452 continue;
1453 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1454 if (err < 0)
1455 return filter_error(cval, err);
1456 val = ucontrol->value.integer.value[cnt];
1457 val = get_abs_value(cval, val);
1458 if (oval != val) {
1459 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1460 changed = 1;
1461 }
1462 cnt++;
1463 }
1464 } else {
1465 /* master channel */
1466 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1467 if (err < 0)
1468 return filter_error(cval, err);
1469 val = ucontrol->value.integer.value[0];
1470 val = get_abs_value(cval, val);
1471 if (val != oval) {
1472 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1473 changed = 1;
1474 }
1475 }
1476 return changed;
1477}
1478
1479/* get the boolean value from the master channel of a UAC control */
1480static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1481 struct snd_ctl_elem_value *ucontrol)
1482{
1483 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1484 int val, err;
1485
1486 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1487 if (err < 0)
1488 return filter_error(cval, err);
1489 val = (val != 0);
1490 ucontrol->value.integer.value[0] = val;
1491 return 0;
1492}
1493
1494static int get_connector_value(struct usb_mixer_elem_info *cval,
1495 char *name, int *val)
1496{
1497 struct snd_usb_audio *chip = cval->head.mixer->chip;
1498 int idx = 0, validx, ret;
1499
1500 validx = cval->control << 8 | 0;
1501
1502 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1503 if (ret)
1504 goto error;
1505
1506 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1507 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1508 struct uac2_connectors_ctl_blk uac2_conn;
1509
1510 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1511 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1512 validx, idx, &uac2_conn, sizeof(uac2_conn));
1513 if (val)
1514 *val = !!uac2_conn.bNrChannels;
1515 } else { /* UAC_VERSION_3 */
1516 struct uac3_insertion_ctl_blk uac3_conn;
1517
1518 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1519 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1520 validx, idx, &uac3_conn, sizeof(uac3_conn));
1521 if (val)
1522 *val = !!uac3_conn.bmConInserted;
1523 }
1524
1525 snd_usb_unlock_shutdown(chip);
1526
1527 if (ret < 0) {
1528 if (name && strstr(name, "Speaker")) {
1529 if (val)
1530 *val = 1;
1531 return 0;
1532 }
1533error:
1534 usb_audio_err(chip,
1535 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1536 UAC_GET_CUR, validx, idx, cval->val_type);
1537
1538 if (val)
1539 *val = 0;
1540
1541 return filter_error(cval, ret);
1542 }
1543
1544 return ret;
1545}
1546
1547/* get the connectors status and report it as boolean type */
1548static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1549 struct snd_ctl_elem_value *ucontrol)
1550{
1551 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1552 int ret, val;
1553
1554 ret = get_connector_value(cval, kcontrol->id.name, &val);
1555
1556 if (ret < 0)
1557 return ret;
1558
1559 ucontrol->value.integer.value[0] = val;
1560 return 0;
1561}
1562
1563static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1564 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1565 .name = "", /* will be filled later manually */
1566 .info = mixer_ctl_feature_info,
1567 .get = mixer_ctl_feature_get,
1568 .put = mixer_ctl_feature_put,
1569};
1570
1571/* the read-only variant */
1572static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1573 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1574 .name = "", /* will be filled later manually */
1575 .info = mixer_ctl_feature_info,
1576 .get = mixer_ctl_feature_get,
1577 .put = NULL,
1578};
1579
1580/*
1581 * A control which shows the boolean value from reading a UAC control on
1582 * the master channel.
1583 */
1584static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1585 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1586 .name = "", /* will be filled later manually */
1587 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1588 .info = snd_ctl_boolean_mono_info,
1589 .get = mixer_ctl_master_bool_get,
1590 .put = NULL,
1591};
1592
1593static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1594 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1595 .name = "", /* will be filled later manually */
1596 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1597 .info = snd_ctl_boolean_mono_info,
1598 .get = mixer_ctl_connector_get,
1599 .put = NULL,
1600};
1601
1602/*
1603 * This symbol is exported in order to allow the mixer quirks to
1604 * hook up to the standard feature unit control mechanism
1605 */
1606const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1607
1608/*
1609 * build a feature control
1610 */
1611static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1612{
1613 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1614}
1615
1616/*
1617 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1618 * rename it to "Headphone". We determine if something is a headphone
1619 * similar to how udev determines form factor.
1620 */
1621static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1622 struct snd_card *card)
1623{
1624 static const char * const names_to_check[] = {
1625 "Headset", "headset", "Headphone", "headphone", NULL};
1626 const char * const *s;
1627 bool found = false;
1628
1629 if (strcmp("Speaker", kctl->id.name))
1630 return;
1631
1632 for (s = names_to_check; *s; s++)
1633 if (strstr(card->shortname, *s)) {
1634 found = true;
1635 break;
1636 }
1637
1638 if (!found)
1639 return;
1640
1641 snd_ctl_rename(card, kctl, "Headphone");
1642}
1643
1644static const struct usb_feature_control_info *get_feature_control_info(int control)
1645{
1646 int i;
1647
1648 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1649 if (audio_feature_info[i].control == control)
1650 return &audio_feature_info[i];
1651 }
1652 return NULL;
1653}
1654
1655static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1656 const struct usbmix_name_map *imap,
1657 unsigned int ctl_mask, int control,
1658 struct usb_audio_term *iterm,
1659 struct usb_audio_term *oterm,
1660 int unitid, int nameid, int readonly_mask)
1661{
1662 const struct usb_feature_control_info *ctl_info;
1663 unsigned int len = 0;
1664 int mapped_name = 0;
1665 struct snd_kcontrol *kctl;
1666 struct usb_mixer_elem_info *cval;
1667 const struct usbmix_name_map *map;
1668 unsigned int range;
1669
1670 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1671 /* FIXME: not supported yet */
1672 return;
1673 }
1674
1675 map = find_map(imap, unitid, control);
1676 if (check_ignored_ctl(map))
1677 return;
1678
1679 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1680 if (!cval)
1681 return;
1682 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1683 cval->control = control;
1684 cval->cmask = ctl_mask;
1685
1686 ctl_info = get_feature_control_info(control);
1687 if (!ctl_info) {
1688 usb_mixer_elem_info_free(cval);
1689 return;
1690 }
1691 if (mixer->protocol == UAC_VERSION_1)
1692 cval->val_type = ctl_info->type;
1693 else /* UAC_VERSION_2 */
1694 cval->val_type = ctl_info->type_uac2 >= 0 ?
1695 ctl_info->type_uac2 : ctl_info->type;
1696
1697 if (ctl_mask == 0) {
1698 cval->channels = 1; /* master channel */
1699 cval->master_readonly = readonly_mask;
1700 } else {
1701 int i, c = 0;
1702 for (i = 0; i < 16; i++)
1703 if (ctl_mask & (1 << i))
1704 c++;
1705 cval->channels = c;
1706 cval->ch_readonly = readonly_mask;
1707 }
1708
1709 /*
1710 * If all channels in the mask are marked read-only, make the control
1711 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1712 * issue write commands to read-only channels.
1713 */
1714 if (cval->channels == readonly_mask)
1715 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1716 else
1717 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1718
1719 if (!kctl) {
1720 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1721 usb_mixer_elem_info_free(cval);
1722 return;
1723 }
1724 kctl->private_free = snd_usb_mixer_elem_free;
1725
1726 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1727 mapped_name = len != 0;
1728 if (!len && nameid)
1729 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1730 kctl->id.name, sizeof(kctl->id.name));
1731
1732 switch (control) {
1733 case UAC_FU_MUTE:
1734 case UAC_FU_VOLUME:
1735 /*
1736 * determine the control name. the rule is:
1737 * - if a name id is given in descriptor, use it.
1738 * - if the connected input can be determined, then use the name
1739 * of terminal type.
1740 * - if the connected output can be determined, use it.
1741 * - otherwise, anonymous name.
1742 */
1743 if (!len) {
1744 if (iterm)
1745 len = get_term_name(mixer->chip, iterm,
1746 kctl->id.name,
1747 sizeof(kctl->id.name), 1);
1748 if (!len && oterm)
1749 len = get_term_name(mixer->chip, oterm,
1750 kctl->id.name,
1751 sizeof(kctl->id.name), 1);
1752 if (!len)
1753 snprintf(kctl->id.name, sizeof(kctl->id.name),
1754 "Feature %d", unitid);
1755 }
1756
1757 if (!mapped_name)
1758 check_no_speaker_on_headset(kctl, mixer->chip->card);
1759
1760 /*
1761 * determine the stream direction:
1762 * if the connected output is USB stream, then it's likely a
1763 * capture stream. otherwise it should be playback (hopefully :)
1764 */
1765 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1766 if ((oterm->type & 0xff00) == 0x0100)
1767 append_ctl_name(kctl, " Capture");
1768 else
1769 append_ctl_name(kctl, " Playback");
1770 }
1771 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1772 " Switch" : " Volume");
1773 break;
1774 default:
1775 if (!len)
1776 strscpy(kctl->id.name, audio_feature_info[control-1].name,
1777 sizeof(kctl->id.name));
1778 break;
1779 }
1780
1781 /* get min/max values */
1782 get_min_max_with_quirks(cval, 0, kctl);
1783
1784 /* skip a bogus volume range */
1785 if (cval->max <= cval->min) {
1786 usb_audio_dbg(mixer->chip,
1787 "[%d] FU [%s] skipped due to invalid volume\n",
1788 cval->head.id, kctl->id.name);
1789 snd_ctl_free_one(kctl);
1790 return;
1791 }
1792
1793
1794 if (control == UAC_FU_VOLUME) {
1795 check_mapped_dB(map, cval);
1796 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1797 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1798 kctl->vd[0].access |=
1799 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1800 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1801 }
1802 }
1803
1804 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1805
1806 range = (cval->max - cval->min) / cval->res;
1807 /*
1808 * Are there devices with volume range more than 255? I use a bit more
1809 * to be sure. 384 is a resolution magic number found on Logitech
1810 * devices. It will definitively catch all buggy Logitech devices.
1811 */
1812 if (range > 384) {
1813 usb_audio_warn(mixer->chip,
1814 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1815 range);
1816 usb_audio_warn(mixer->chip,
1817 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1818 cval->head.id, kctl->id.name, cval->channels,
1819 cval->min, cval->max, cval->res);
1820 }
1821
1822 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1823 cval->head.id, kctl->id.name, cval->channels,
1824 cval->min, cval->max, cval->res);
1825 snd_usb_mixer_add_control(&cval->head, kctl);
1826}
1827
1828static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1829 unsigned int ctl_mask, int control,
1830 struct usb_audio_term *iterm, int unitid,
1831 int readonly_mask)
1832{
1833 struct uac_feature_unit_descriptor *desc = raw_desc;
1834 int nameid = uac_feature_unit_iFeature(desc);
1835
1836 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1837 iterm, &state->oterm, unitid, nameid, readonly_mask);
1838}
1839
1840static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1841 unsigned int ctl_mask, int control, int unitid,
1842 const struct usbmix_name_map *badd_map)
1843{
1844 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1845 NULL, NULL, unitid, 0, 0);
1846}
1847
1848static void get_connector_control_name(struct usb_mixer_interface *mixer,
1849 struct usb_audio_term *term,
1850 bool is_input, char *name, int name_size)
1851{
1852 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1853
1854 if (name_len == 0)
1855 strscpy(name, "Unknown", name_size);
1856
1857 /*
1858 * sound/core/ctljack.c has a convention of naming jack controls
1859 * by ending in " Jack". Make it slightly more useful by
1860 * indicating Input or Output after the terminal name.
1861 */
1862 if (is_input)
1863 strlcat(name, " - Input Jack", name_size);
1864 else
1865 strlcat(name, " - Output Jack", name_size);
1866}
1867
1868/* get connector value to "wake up" the USB audio */
1869static int connector_mixer_resume(struct usb_mixer_elem_list *list)
1870{
1871 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
1872
1873 get_connector_value(cval, NULL, NULL);
1874 return 0;
1875}
1876
1877/* Build a mixer control for a UAC connector control (jack-detect) */
1878static void build_connector_control(struct usb_mixer_interface *mixer,
1879 const struct usbmix_name_map *imap,
1880 struct usb_audio_term *term, bool is_input)
1881{
1882 struct snd_kcontrol *kctl;
1883 struct usb_mixer_elem_info *cval;
1884 const struct usbmix_name_map *map;
1885
1886 map = find_map(imap, term->id, 0);
1887 if (check_ignored_ctl(map))
1888 return;
1889
1890 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1891 if (!cval)
1892 return;
1893 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1894
1895 /* set up a specific resume callback */
1896 cval->head.resume = connector_mixer_resume;
1897
1898 /*
1899 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1900 * number of channels connected.
1901 *
1902 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1903 * following byte(s) specifies which connectors are inserted.
1904 *
1905 * This boolean ctl will simply report if any channels are connected
1906 * or not.
1907 */
1908 if (mixer->protocol == UAC_VERSION_2)
1909 cval->control = UAC2_TE_CONNECTOR;
1910 else /* UAC_VERSION_3 */
1911 cval->control = UAC3_TE_INSERTION;
1912
1913 cval->val_type = USB_MIXER_BOOLEAN;
1914 cval->channels = 1; /* report true if any channel is connected */
1915 cval->min = 0;
1916 cval->max = 1;
1917 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1918 if (!kctl) {
1919 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1920 usb_mixer_elem_info_free(cval);
1921 return;
1922 }
1923
1924 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1925 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1926 else
1927 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1928 sizeof(kctl->id.name));
1929 kctl->private_free = snd_usb_mixer_elem_free;
1930 snd_usb_mixer_add_control(&cval->head, kctl);
1931}
1932
1933static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1934 void *_ftr)
1935{
1936 struct uac_clock_source_descriptor *hdr = _ftr;
1937 struct usb_mixer_elem_info *cval;
1938 struct snd_kcontrol *kctl;
1939 int ret;
1940
1941 if (state->mixer->protocol != UAC_VERSION_2)
1942 return -EINVAL;
1943
1944 /*
1945 * The only property of this unit we are interested in is the
1946 * clock source validity. If that isn't readable, just bail out.
1947 */
1948 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1949 UAC2_CS_CONTROL_CLOCK_VALID))
1950 return 0;
1951
1952 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1953 if (!cval)
1954 return -ENOMEM;
1955
1956 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1957
1958 cval->min = 0;
1959 cval->max = 1;
1960 cval->channels = 1;
1961 cval->val_type = USB_MIXER_BOOLEAN;
1962 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1963
1964 cval->master_readonly = 1;
1965 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1966 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1967
1968 if (!kctl) {
1969 usb_mixer_elem_info_free(cval);
1970 return -ENOMEM;
1971 }
1972
1973 kctl->private_free = snd_usb_mixer_elem_free;
1974 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1975 kctl->id.name, sizeof(kctl->id.name));
1976 if (ret > 0)
1977 append_ctl_name(kctl, " Validity");
1978 else
1979 snprintf(kctl->id.name, sizeof(kctl->id.name),
1980 "Clock Source %d Validity", hdr->bClockID);
1981
1982 return snd_usb_mixer_add_control(&cval->head, kctl);
1983}
1984
1985/*
1986 * parse a feature unit
1987 *
1988 * most of controls are defined here.
1989 */
1990static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1991 void *_ftr)
1992{
1993 int channels, i, j;
1994 struct usb_audio_term iterm;
1995 unsigned int master_bits;
1996 int err, csize;
1997 struct uac_feature_unit_descriptor *hdr = _ftr;
1998 __u8 *bmaControls;
1999
2000 if (state->mixer->protocol == UAC_VERSION_1) {
2001 csize = hdr->bControlSize;
2002 channels = (hdr->bLength - 7) / csize - 1;
2003 bmaControls = hdr->bmaControls;
2004 } else if (state->mixer->protocol == UAC_VERSION_2) {
2005 struct uac2_feature_unit_descriptor *ftr = _ftr;
2006 csize = 4;
2007 channels = (hdr->bLength - 6) / 4 - 1;
2008 bmaControls = ftr->bmaControls;
2009 } else { /* UAC_VERSION_3 */
2010 struct uac3_feature_unit_descriptor *ftr = _ftr;
2011
2012 csize = 4;
2013 channels = (ftr->bLength - 7) / 4 - 1;
2014 bmaControls = ftr->bmaControls;
2015 }
2016
2017 /* parse the source unit */
2018 err = parse_audio_unit(state, hdr->bSourceID);
2019 if (err < 0)
2020 return err;
2021
2022 /* determine the input source type and name */
2023 err = check_input_term(state, hdr->bSourceID, &iterm);
2024 if (err < 0)
2025 return err;
2026
2027 master_bits = snd_usb_combine_bytes(bmaControls, csize);
2028 /* master configuration quirks */
2029 switch (state->chip->usb_id) {
2030 case USB_ID(0x08bb, 0x2702):
2031 usb_audio_info(state->chip,
2032 "usbmixer: master volume quirk for PCM2702 chip\n");
2033 /* disable non-functional volume control */
2034 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
2035 break;
2036 case USB_ID(0x1130, 0xf211):
2037 usb_audio_info(state->chip,
2038 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
2039 /* disable non-functional volume control */
2040 channels = 0;
2041 break;
2042
2043 }
2044
2045 if (state->mixer->protocol == UAC_VERSION_1) {
2046 /* check all control types */
2047 for (i = 0; i < 10; i++) {
2048 unsigned int ch_bits = 0;
2049 int control = audio_feature_info[i].control;
2050
2051 for (j = 0; j < channels; j++) {
2052 unsigned int mask;
2053
2054 mask = snd_usb_combine_bytes(bmaControls +
2055 csize * (j+1), csize);
2056 if (mask & (1 << i))
2057 ch_bits |= (1 << j);
2058 }
2059 /* audio class v1 controls are never read-only */
2060
2061 /*
2062 * The first channel must be set
2063 * (for ease of programming).
2064 */
2065 if (ch_bits & 1)
2066 build_feature_ctl(state, _ftr, ch_bits, control,
2067 &iterm, unitid, 0);
2068 if (master_bits & (1 << i))
2069 build_feature_ctl(state, _ftr, 0, control,
2070 &iterm, unitid, 0);
2071 }
2072 } else { /* UAC_VERSION_2/3 */
2073 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
2074 unsigned int ch_bits = 0;
2075 unsigned int ch_read_only = 0;
2076 int control = audio_feature_info[i].control;
2077
2078 for (j = 0; j < channels; j++) {
2079 unsigned int mask;
2080
2081 mask = snd_usb_combine_bytes(bmaControls +
2082 csize * (j+1), csize);
2083 if (uac_v2v3_control_is_readable(mask, control)) {
2084 ch_bits |= (1 << j);
2085 if (!uac_v2v3_control_is_writeable(mask, control))
2086 ch_read_only |= (1 << j);
2087 }
2088 }
2089
2090 /*
2091 * NOTE: build_feature_ctl() will mark the control
2092 * read-only if all channels are marked read-only in
2093 * the descriptors. Otherwise, the control will be
2094 * reported as writeable, but the driver will not
2095 * actually issue a write command for read-only
2096 * channels.
2097 */
2098
2099 /*
2100 * The first channel must be set
2101 * (for ease of programming).
2102 */
2103 if (ch_bits & 1)
2104 build_feature_ctl(state, _ftr, ch_bits, control,
2105 &iterm, unitid, ch_read_only);
2106 if (uac_v2v3_control_is_readable(master_bits, control))
2107 build_feature_ctl(state, _ftr, 0, control,
2108 &iterm, unitid,
2109 !uac_v2v3_control_is_writeable(master_bits,
2110 control));
2111 }
2112 }
2113
2114 return 0;
2115}
2116
2117/*
2118 * Mixer Unit
2119 */
2120
2121/* check whether the given in/out overflows bmMixerControls matrix */
2122static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2123 int protocol, int num_ins, int num_outs)
2124{
2125 u8 *hdr = (u8 *)desc;
2126 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2127 size_t rest; /* remaining bytes after bmMixerControls */
2128
2129 switch (protocol) {
2130 case UAC_VERSION_1:
2131 default:
2132 rest = 1; /* iMixer */
2133 break;
2134 case UAC_VERSION_2:
2135 rest = 2; /* bmControls + iMixer */
2136 break;
2137 case UAC_VERSION_3:
2138 rest = 6; /* bmControls + wMixerDescrStr */
2139 break;
2140 }
2141
2142 /* overflow? */
2143 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2144}
2145
2146/*
2147 * build a mixer unit control
2148 *
2149 * the callbacks are identical with feature unit.
2150 * input channel number (zero based) is given in control field instead.
2151 */
2152static void build_mixer_unit_ctl(struct mixer_build *state,
2153 struct uac_mixer_unit_descriptor *desc,
2154 int in_pin, int in_ch, int num_outs,
2155 int unitid, struct usb_audio_term *iterm)
2156{
2157 struct usb_mixer_elem_info *cval;
2158 unsigned int i, len;
2159 struct snd_kcontrol *kctl;
2160 const struct usbmix_name_map *map;
2161
2162 map = find_map(state->map, unitid, 0);
2163 if (check_ignored_ctl(map))
2164 return;
2165
2166 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2167 if (!cval)
2168 return;
2169
2170 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2171 cval->control = in_ch + 1; /* based on 1 */
2172 cval->val_type = USB_MIXER_S16;
2173 for (i = 0; i < num_outs; i++) {
2174 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2175
2176 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2177 cval->cmask |= (1 << i);
2178 cval->channels++;
2179 }
2180 }
2181
2182 /* get min/max values */
2183 get_min_max(cval, 0);
2184
2185 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2186 if (!kctl) {
2187 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2188 usb_mixer_elem_info_free(cval);
2189 return;
2190 }
2191 kctl->private_free = snd_usb_mixer_elem_free;
2192
2193 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2194 if (!len)
2195 len = get_term_name(state->chip, iterm, kctl->id.name,
2196 sizeof(kctl->id.name), 0);
2197 if (!len)
2198 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2199 append_ctl_name(kctl, " Volume");
2200
2201 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2202 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2203 snd_usb_mixer_add_control(&cval->head, kctl);
2204}
2205
2206static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2207 void *raw_desc)
2208{
2209 struct usb_audio_term iterm;
2210 unsigned int control, bmctls, term_id;
2211
2212 if (state->mixer->protocol == UAC_VERSION_2) {
2213 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2214 control = UAC2_TE_CONNECTOR;
2215 term_id = d_v2->bTerminalID;
2216 bmctls = le16_to_cpu(d_v2->bmControls);
2217 } else if (state->mixer->protocol == UAC_VERSION_3) {
2218 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2219 control = UAC3_TE_INSERTION;
2220 term_id = d_v3->bTerminalID;
2221 bmctls = le32_to_cpu(d_v3->bmControls);
2222 } else {
2223 return 0; /* UAC1. No Insertion control */
2224 }
2225
2226 check_input_term(state, term_id, &iterm);
2227
2228 /* Check for jack detection. */
2229 if ((iterm.type & 0xff00) != 0x0100 &&
2230 uac_v2v3_control_is_readable(bmctls, control))
2231 build_connector_control(state->mixer, state->map, &iterm, true);
2232
2233 return 0;
2234}
2235
2236/*
2237 * parse a mixer unit
2238 */
2239static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2240 void *raw_desc)
2241{
2242 struct uac_mixer_unit_descriptor *desc = raw_desc;
2243 struct usb_audio_term iterm;
2244 int input_pins, num_ins, num_outs;
2245 int pin, ich, err;
2246
2247 err = uac_mixer_unit_get_channels(state, desc);
2248 if (err < 0) {
2249 usb_audio_err(state->chip,
2250 "invalid MIXER UNIT descriptor %d\n",
2251 unitid);
2252 return err;
2253 }
2254
2255 num_outs = err;
2256 input_pins = desc->bNrInPins;
2257
2258 num_ins = 0;
2259 ich = 0;
2260 for (pin = 0; pin < input_pins; pin++) {
2261 err = parse_audio_unit(state, desc->baSourceID[pin]);
2262 if (err < 0)
2263 continue;
2264 /* no bmControls field (e.g. Maya44) -> ignore */
2265 if (!num_outs)
2266 continue;
2267 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2268 if (err < 0)
2269 return err;
2270 num_ins += iterm.channels;
2271 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2272 num_ins, num_outs))
2273 break;
2274 for (; ich < num_ins; ich++) {
2275 int och, ich_has_controls = 0;
2276
2277 for (och = 0; och < num_outs; och++) {
2278 __u8 *c = uac_mixer_unit_bmControls(desc,
2279 state->mixer->protocol);
2280
2281 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2282 ich_has_controls = 1;
2283 break;
2284 }
2285 }
2286 if (ich_has_controls)
2287 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2288 unitid, &iterm);
2289 }
2290 }
2291 return 0;
2292}
2293
2294/*
2295 * Processing Unit / Extension Unit
2296 */
2297
2298/* get callback for processing/extension unit */
2299static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2300 struct snd_ctl_elem_value *ucontrol)
2301{
2302 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2303 int err, val;
2304
2305 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2306 if (err < 0) {
2307 ucontrol->value.integer.value[0] = cval->min;
2308 return filter_error(cval, err);
2309 }
2310 val = get_relative_value(cval, val);
2311 ucontrol->value.integer.value[0] = val;
2312 return 0;
2313}
2314
2315/* put callback for processing/extension unit */
2316static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2317 struct snd_ctl_elem_value *ucontrol)
2318{
2319 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2320 int val, oval, err;
2321
2322 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2323 if (err < 0)
2324 return filter_error(cval, err);
2325 val = ucontrol->value.integer.value[0];
2326 val = get_abs_value(cval, val);
2327 if (val != oval) {
2328 set_cur_ctl_value(cval, cval->control << 8, val);
2329 return 1;
2330 }
2331 return 0;
2332}
2333
2334/* alsa control interface for processing/extension unit */
2335static const struct snd_kcontrol_new mixer_procunit_ctl = {
2336 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2337 .name = "", /* will be filled later */
2338 .info = mixer_ctl_feature_info,
2339 .get = mixer_ctl_procunit_get,
2340 .put = mixer_ctl_procunit_put,
2341};
2342
2343/*
2344 * predefined data for processing units
2345 */
2346struct procunit_value_info {
2347 int control;
2348 const char *suffix;
2349 int val_type;
2350 int min_value;
2351};
2352
2353struct procunit_info {
2354 int type;
2355 char *name;
2356 const struct procunit_value_info *values;
2357};
2358
2359static const struct procunit_value_info undefined_proc_info[] = {
2360 { 0x00, "Control Undefined", 0 },
2361 { 0 }
2362};
2363
2364static const struct procunit_value_info updown_proc_info[] = {
2365 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2366 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2367 { 0 }
2368};
2369static const struct procunit_value_info prologic_proc_info[] = {
2370 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2371 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2372 { 0 }
2373};
2374static const struct procunit_value_info threed_enh_proc_info[] = {
2375 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2376 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2377 { 0 }
2378};
2379static const struct procunit_value_info reverb_proc_info[] = {
2380 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2381 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2382 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2383 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2384 { 0 }
2385};
2386static const struct procunit_value_info chorus_proc_info[] = {
2387 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2388 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2389 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2390 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2391 { 0 }
2392};
2393static const struct procunit_value_info dcr_proc_info[] = {
2394 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2395 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2396 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2397 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2398 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2399 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2400 { 0 }
2401};
2402
2403static const struct procunit_info procunits[] = {
2404 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2405 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2406 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2407 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2408 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2409 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2410 { 0 },
2411};
2412
2413static const struct procunit_value_info uac3_updown_proc_info[] = {
2414 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2415 { 0 }
2416};
2417static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2418 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2419 { 0 }
2420};
2421
2422static const struct procunit_info uac3_procunits[] = {
2423 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2424 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2425 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2426 { 0 },
2427};
2428
2429/*
2430 * predefined data for extension units
2431 */
2432static const struct procunit_value_info clock_rate_xu_info[] = {
2433 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2434 { 0 }
2435};
2436static const struct procunit_value_info clock_source_xu_info[] = {
2437 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2438 { 0 }
2439};
2440static const struct procunit_value_info spdif_format_xu_info[] = {
2441 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2442 { 0 }
2443};
2444static const struct procunit_value_info soft_limit_xu_info[] = {
2445 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2446 { 0 }
2447};
2448static const struct procunit_info extunits[] = {
2449 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2450 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2451 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2452 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2453 { 0 }
2454};
2455
2456/*
2457 * build a processing/extension unit
2458 */
2459static int build_audio_procunit(struct mixer_build *state, int unitid,
2460 void *raw_desc, const struct procunit_info *list,
2461 bool extension_unit)
2462{
2463 struct uac_processing_unit_descriptor *desc = raw_desc;
2464 int num_ins;
2465 struct usb_mixer_elem_info *cval;
2466 struct snd_kcontrol *kctl;
2467 int i, err, nameid, type, len, val;
2468 const struct procunit_info *info;
2469 const struct procunit_value_info *valinfo;
2470 const struct usbmix_name_map *map;
2471 static const struct procunit_value_info default_value_info[] = {
2472 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2473 { 0 }
2474 };
2475 static const struct procunit_info default_info = {
2476 0, NULL, default_value_info
2477 };
2478 const char *name = extension_unit ?
2479 "Extension Unit" : "Processing Unit";
2480
2481 num_ins = desc->bNrInPins;
2482 for (i = 0; i < num_ins; i++) {
2483 err = parse_audio_unit(state, desc->baSourceID[i]);
2484 if (err < 0)
2485 return err;
2486 }
2487
2488 type = le16_to_cpu(desc->wProcessType);
2489 for (info = list; info && info->type; info++)
2490 if (info->type == type)
2491 break;
2492 if (!info || !info->type)
2493 info = &default_info;
2494
2495 for (valinfo = info->values; valinfo->control; valinfo++) {
2496 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2497
2498 if (state->mixer->protocol == UAC_VERSION_1) {
2499 if (!(controls[valinfo->control / 8] &
2500 (1 << ((valinfo->control % 8) - 1))))
2501 continue;
2502 } else { /* UAC_VERSION_2/3 */
2503 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2504 valinfo->control))
2505 continue;
2506 }
2507
2508 map = find_map(state->map, unitid, valinfo->control);
2509 if (check_ignored_ctl(map))
2510 continue;
2511 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2512 if (!cval)
2513 return -ENOMEM;
2514 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2515 cval->control = valinfo->control;
2516 cval->val_type = valinfo->val_type;
2517 cval->channels = 1;
2518
2519 if (state->mixer->protocol > UAC_VERSION_1 &&
2520 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2521 valinfo->control))
2522 cval->master_readonly = 1;
2523
2524 /* get min/max values */
2525 switch (type) {
2526 case UAC_PROCESS_UP_DOWNMIX: {
2527 bool mode_sel = false;
2528
2529 switch (state->mixer->protocol) {
2530 case UAC_VERSION_1:
2531 case UAC_VERSION_2:
2532 default:
2533 if (cval->control == UAC_UD_MODE_SELECT)
2534 mode_sel = true;
2535 break;
2536 case UAC_VERSION_3:
2537 if (cval->control == UAC3_UD_MODE_SELECT)
2538 mode_sel = true;
2539 break;
2540 }
2541
2542 if (mode_sel) {
2543 __u8 *control_spec = uac_processing_unit_specific(desc,
2544 state->mixer->protocol);
2545 cval->min = 1;
2546 cval->max = control_spec[0];
2547 cval->res = 1;
2548 cval->initialized = 1;
2549 break;
2550 }
2551
2552 get_min_max(cval, valinfo->min_value);
2553 break;
2554 }
2555 case USB_XU_CLOCK_RATE:
2556 /*
2557 * E-Mu USB 0404/0202/TrackerPre/0204
2558 * samplerate control quirk
2559 */
2560 cval->min = 0;
2561 cval->max = 5;
2562 cval->res = 1;
2563 cval->initialized = 1;
2564 break;
2565 default:
2566 get_min_max(cval, valinfo->min_value);
2567 break;
2568 }
2569
2570 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2571 if (err < 0) {
2572 usb_mixer_elem_info_free(cval);
2573 return -EINVAL;
2574 }
2575
2576 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2577 if (!kctl) {
2578 usb_mixer_elem_info_free(cval);
2579 return -ENOMEM;
2580 }
2581 kctl->private_free = snd_usb_mixer_elem_free;
2582
2583 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2584 /* nothing */ ;
2585 } else if (info->name) {
2586 strscpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2587 } else {
2588 if (extension_unit)
2589 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2590 else
2591 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2592 len = 0;
2593 if (nameid)
2594 len = snd_usb_copy_string_desc(state->chip,
2595 nameid,
2596 kctl->id.name,
2597 sizeof(kctl->id.name));
2598 if (!len)
2599 strscpy(kctl->id.name, name, sizeof(kctl->id.name));
2600 }
2601 append_ctl_name(kctl, " ");
2602 append_ctl_name(kctl, valinfo->suffix);
2603
2604 usb_audio_dbg(state->chip,
2605 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2606 cval->head.id, kctl->id.name, cval->channels,
2607 cval->min, cval->max);
2608
2609 err = snd_usb_mixer_add_control(&cval->head, kctl);
2610 if (err < 0)
2611 return err;
2612 }
2613 return 0;
2614}
2615
2616static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2617 void *raw_desc)
2618{
2619 switch (state->mixer->protocol) {
2620 case UAC_VERSION_1:
2621 case UAC_VERSION_2:
2622 default:
2623 return build_audio_procunit(state, unitid, raw_desc,
2624 procunits, false);
2625 case UAC_VERSION_3:
2626 return build_audio_procunit(state, unitid, raw_desc,
2627 uac3_procunits, false);
2628 }
2629}
2630
2631static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2632 void *raw_desc)
2633{
2634 /*
2635 * Note that we parse extension units with processing unit descriptors.
2636 * That's ok as the layout is the same.
2637 */
2638 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2639}
2640
2641/*
2642 * Selector Unit
2643 */
2644
2645/*
2646 * info callback for selector unit
2647 * use an enumerator type for routing
2648 */
2649static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2650 struct snd_ctl_elem_info *uinfo)
2651{
2652 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2653 const char **itemlist = (const char **)kcontrol->private_value;
2654
2655 if (snd_BUG_ON(!itemlist))
2656 return -EINVAL;
2657 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2658}
2659
2660/* get callback for selector unit */
2661static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2662 struct snd_ctl_elem_value *ucontrol)
2663{
2664 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2665 int val, err;
2666
2667 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2668 if (err < 0) {
2669 ucontrol->value.enumerated.item[0] = 0;
2670 return filter_error(cval, err);
2671 }
2672 val = get_relative_value(cval, val);
2673 ucontrol->value.enumerated.item[0] = val;
2674 return 0;
2675}
2676
2677/* put callback for selector unit */
2678static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2679 struct snd_ctl_elem_value *ucontrol)
2680{
2681 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2682 int val, oval, err;
2683
2684 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2685 if (err < 0)
2686 return filter_error(cval, err);
2687 val = ucontrol->value.enumerated.item[0];
2688 val = get_abs_value(cval, val);
2689 if (val != oval) {
2690 set_cur_ctl_value(cval, cval->control << 8, val);
2691 return 1;
2692 }
2693 return 0;
2694}
2695
2696/* alsa control interface for selector unit */
2697static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2698 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2699 .name = "", /* will be filled later */
2700 .info = mixer_ctl_selector_info,
2701 .get = mixer_ctl_selector_get,
2702 .put = mixer_ctl_selector_put,
2703};
2704
2705/*
2706 * private free callback.
2707 * free both private_data and private_value
2708 */
2709static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2710{
2711 int i, num_ins = 0;
2712
2713 if (kctl->private_data) {
2714 struct usb_mixer_elem_info *cval = kctl->private_data;
2715 num_ins = cval->max;
2716 usb_mixer_elem_info_free(cval);
2717 kctl->private_data = NULL;
2718 }
2719 if (kctl->private_value) {
2720 char **itemlist = (char **)kctl->private_value;
2721 for (i = 0; i < num_ins; i++)
2722 kfree(itemlist[i]);
2723 kfree(itemlist);
2724 kctl->private_value = 0;
2725 }
2726}
2727
2728/*
2729 * parse a selector unit
2730 */
2731static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2732 void *raw_desc)
2733{
2734 struct uac_selector_unit_descriptor *desc = raw_desc;
2735 unsigned int i, nameid, len;
2736 int err;
2737 struct usb_mixer_elem_info *cval;
2738 struct snd_kcontrol *kctl;
2739 const struct usbmix_name_map *map;
2740 char **namelist;
2741
2742 for (i = 0; i < desc->bNrInPins; i++) {
2743 err = parse_audio_unit(state, desc->baSourceID[i]);
2744 if (err < 0)
2745 return err;
2746 }
2747
2748 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2749 return 0;
2750
2751 map = find_map(state->map, unitid, 0);
2752 if (check_ignored_ctl(map))
2753 return 0;
2754
2755 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2756 if (!cval)
2757 return -ENOMEM;
2758 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2759 cval->val_type = USB_MIXER_U8;
2760 cval->channels = 1;
2761 cval->min = 1;
2762 cval->max = desc->bNrInPins;
2763 cval->res = 1;
2764 cval->initialized = 1;
2765
2766 switch (state->mixer->protocol) {
2767 case UAC_VERSION_1:
2768 default:
2769 cval->control = 0;
2770 break;
2771 case UAC_VERSION_2:
2772 case UAC_VERSION_3:
2773 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2774 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2775 cval->control = UAC2_CX_CLOCK_SELECTOR;
2776 else /* UAC2/3_SELECTOR_UNIT */
2777 cval->control = UAC2_SU_SELECTOR;
2778 break;
2779 }
2780
2781 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2782 if (!namelist) {
2783 err = -ENOMEM;
2784 goto error_cval;
2785 }
2786#define MAX_ITEM_NAME_LEN 64
2787 for (i = 0; i < desc->bNrInPins; i++) {
2788 struct usb_audio_term iterm;
2789 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2790 if (!namelist[i]) {
2791 err = -ENOMEM;
2792 goto error_name;
2793 }
2794 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2795 MAX_ITEM_NAME_LEN);
2796 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2797 len = get_term_name(state->chip, &iterm, namelist[i],
2798 MAX_ITEM_NAME_LEN, 0);
2799 if (! len)
2800 sprintf(namelist[i], "Input %u", i);
2801 }
2802
2803 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2804 if (! kctl) {
2805 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2806 err = -ENOMEM;
2807 goto error_name;
2808 }
2809 kctl->private_value = (unsigned long)namelist;
2810 kctl->private_free = usb_mixer_selector_elem_free;
2811
2812 /* check the static mapping table at first */
2813 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2814 if (!len) {
2815 /* no mapping ? */
2816 switch (state->mixer->protocol) {
2817 case UAC_VERSION_1:
2818 case UAC_VERSION_2:
2819 default:
2820 /* if iSelector is given, use it */
2821 nameid = uac_selector_unit_iSelector(desc);
2822 if (nameid)
2823 len = snd_usb_copy_string_desc(state->chip,
2824 nameid, kctl->id.name,
2825 sizeof(kctl->id.name));
2826 break;
2827 case UAC_VERSION_3:
2828 /* TODO: Class-Specific strings not yet supported */
2829 break;
2830 }
2831
2832 /* ... or pick up the terminal name at next */
2833 if (!len)
2834 len = get_term_name(state->chip, &state->oterm,
2835 kctl->id.name, sizeof(kctl->id.name), 0);
2836 /* ... or use the fixed string "USB" as the last resort */
2837 if (!len)
2838 strscpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2839
2840 /* and add the proper suffix */
2841 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2842 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2843 append_ctl_name(kctl, " Clock Source");
2844 else if ((state->oterm.type & 0xff00) == 0x0100)
2845 append_ctl_name(kctl, " Capture Source");
2846 else
2847 append_ctl_name(kctl, " Playback Source");
2848 }
2849
2850 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2851 cval->head.id, kctl->id.name, desc->bNrInPins);
2852 return snd_usb_mixer_add_control(&cval->head, kctl);
2853
2854 error_name:
2855 for (i = 0; i < desc->bNrInPins; i++)
2856 kfree(namelist[i]);
2857 kfree(namelist);
2858 error_cval:
2859 usb_mixer_elem_info_free(cval);
2860 return err;
2861}
2862
2863/*
2864 * parse an audio unit recursively
2865 */
2866
2867static int parse_audio_unit(struct mixer_build *state, int unitid)
2868{
2869 unsigned char *p1;
2870 int protocol = state->mixer->protocol;
2871
2872 if (test_and_set_bit(unitid, state->unitbitmap))
2873 return 0; /* the unit already visited */
2874
2875 p1 = find_audio_control_unit(state, unitid);
2876 if (!p1) {
2877 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2878 return -EINVAL;
2879 }
2880
2881 if (!snd_usb_validate_audio_desc(p1, protocol)) {
2882 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2883 return 0; /* skip invalid unit */
2884 }
2885
2886 switch (PTYPE(protocol, p1[2])) {
2887 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2888 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2889 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2890 return parse_audio_input_terminal(state, unitid, p1);
2891 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2892 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2893 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2894 return parse_audio_mixer_unit(state, unitid, p1);
2895 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2896 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2897 return parse_clock_source_unit(state, unitid, p1);
2898 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2899 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2900 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2901 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2902 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2903 return parse_audio_selector_unit(state, unitid, p1);
2904 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2905 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2906 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2907 return parse_audio_feature_unit(state, unitid, p1);
2908 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2909 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2910 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2911 return parse_audio_processing_unit(state, unitid, p1);
2912 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2913 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2914 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2915 return parse_audio_extension_unit(state, unitid, p1);
2916 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2917 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2918 return 0; /* FIXME - effect units not implemented yet */
2919 default:
2920 usb_audio_err(state->chip,
2921 "unit %u: unexpected type 0x%02x\n",
2922 unitid, p1[2]);
2923 return -EINVAL;
2924 }
2925}
2926
2927static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2928{
2929 /* kill pending URBs */
2930 snd_usb_mixer_disconnect(mixer);
2931
2932 kfree(mixer->id_elems);
2933 if (mixer->urb) {
2934 kfree(mixer->urb->transfer_buffer);
2935 usb_free_urb(mixer->urb);
2936 }
2937 usb_free_urb(mixer->rc_urb);
2938 kfree(mixer->rc_setup_packet);
2939 kfree(mixer);
2940}
2941
2942static int snd_usb_mixer_dev_free(struct snd_device *device)
2943{
2944 struct usb_mixer_interface *mixer = device->device_data;
2945 snd_usb_mixer_free(mixer);
2946 return 0;
2947}
2948
2949/* UAC3 predefined channels configuration */
2950struct uac3_badd_profile {
2951 int subclass;
2952 const char *name;
2953 int c_chmask; /* capture channels mask */
2954 int p_chmask; /* playback channels mask */
2955 int st_chmask; /* side tone mixing channel mask */
2956};
2957
2958static const struct uac3_badd_profile uac3_badd_profiles[] = {
2959 {
2960 /*
2961 * BAIF, BAOF or combination of both
2962 * IN: Mono or Stereo cfg, Mono alt possible
2963 * OUT: Mono or Stereo cfg, Mono alt possible
2964 */
2965 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2966 .name = "GENERIC IO",
2967 .c_chmask = -1, /* dynamic channels */
2968 .p_chmask = -1, /* dynamic channels */
2969 },
2970 {
2971 /* BAOF; Stereo only cfg, Mono alt possible */
2972 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2973 .name = "HEADPHONE",
2974 .p_chmask = 3,
2975 },
2976 {
2977 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2978 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2979 .name = "SPEAKER",
2980 .p_chmask = -1, /* dynamic channels */
2981 },
2982 {
2983 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2984 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2985 .name = "MICROPHONE",
2986 .c_chmask = -1, /* dynamic channels */
2987 },
2988 {
2989 /*
2990 * BAIOF topology
2991 * IN: Mono only
2992 * OUT: Mono or Stereo cfg, Mono alt possible
2993 */
2994 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2995 .name = "HEADSET",
2996 .c_chmask = 1,
2997 .p_chmask = -1, /* dynamic channels */
2998 .st_chmask = 1,
2999 },
3000 {
3001 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
3002 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
3003 .name = "HEADSET ADAPTER",
3004 .c_chmask = 1,
3005 .p_chmask = 3,
3006 .st_chmask = 1,
3007 },
3008 {
3009 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
3010 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
3011 .name = "SPEAKERPHONE",
3012 .c_chmask = 1,
3013 .p_chmask = 1,
3014 },
3015 { 0 } /* terminator */
3016};
3017
3018static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
3019 const struct uac3_badd_profile *f,
3020 int c_chmask, int p_chmask)
3021{
3022 /*
3023 * If both playback/capture channels are dynamic, make sure
3024 * at least one channel is present
3025 */
3026 if (f->c_chmask < 0 && f->p_chmask < 0) {
3027 if (!c_chmask && !p_chmask) {
3028 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
3029 f->name);
3030 return false;
3031 }
3032 return true;
3033 }
3034
3035 if ((f->c_chmask < 0 && !c_chmask) ||
3036 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
3037 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
3038 f->name);
3039 return false;
3040 }
3041 if ((f->p_chmask < 0 && !p_chmask) ||
3042 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
3043 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
3044 f->name);
3045 return false;
3046 }
3047 return true;
3048}
3049
3050/*
3051 * create mixer controls for UAC3 BADD profiles
3052 *
3053 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
3054 *
3055 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
3056 */
3057static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
3058 int ctrlif)
3059{
3060 struct usb_device *dev = mixer->chip->dev;
3061 struct usb_interface_assoc_descriptor *assoc;
3062 int badd_profile = mixer->chip->badd_profile;
3063 const struct uac3_badd_profile *f;
3064 const struct usbmix_ctl_map *map;
3065 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
3066 int i;
3067
3068 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
3069
3070 /* Detect BADD capture/playback channels from AS EP descriptors */
3071 for (i = 0; i < assoc->bInterfaceCount; i++) {
3072 int intf = assoc->bFirstInterface + i;
3073
3074 struct usb_interface *iface;
3075 struct usb_host_interface *alts;
3076 struct usb_interface_descriptor *altsd;
3077 unsigned int maxpacksize;
3078 char dir_in;
3079 int chmask, num;
3080
3081 if (intf == ctrlif)
3082 continue;
3083
3084 iface = usb_ifnum_to_if(dev, intf);
3085 if (!iface)
3086 continue;
3087
3088 num = iface->num_altsetting;
3089
3090 if (num < 2)
3091 return -EINVAL;
3092
3093 /*
3094 * The number of Channels in an AudioStreaming interface
3095 * and the audio sample bit resolution (16 bits or 24
3096 * bits) can be derived from the wMaxPacketSize field in
3097 * the Standard AS Audio Data Endpoint descriptor in
3098 * Alternate Setting 1
3099 */
3100 alts = &iface->altsetting[1];
3101 altsd = get_iface_desc(alts);
3102
3103 if (altsd->bNumEndpoints < 1)
3104 return -EINVAL;
3105
3106 /* check direction */
3107 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3108 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3109
3110 switch (maxpacksize) {
3111 default:
3112 usb_audio_err(mixer->chip,
3113 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3114 maxpacksize);
3115 return -EINVAL;
3116 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3117 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3118 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3119 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3120 chmask = 1;
3121 break;
3122 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3123 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3124 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3125 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3126 chmask = 3;
3127 break;
3128 }
3129
3130 if (dir_in)
3131 c_chmask = chmask;
3132 else
3133 p_chmask = chmask;
3134 }
3135
3136 usb_audio_dbg(mixer->chip,
3137 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3138 badd_profile, c_chmask, p_chmask);
3139
3140 /* check the mapping table */
3141 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3142 if (map->id == badd_profile)
3143 break;
3144 }
3145
3146 if (!map->id)
3147 return -EINVAL;
3148
3149 for (f = uac3_badd_profiles; f->name; f++) {
3150 if (badd_profile == f->subclass)
3151 break;
3152 }
3153 if (!f->name)
3154 return -EINVAL;
3155 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3156 return -EINVAL;
3157 st_chmask = f->st_chmask;
3158
3159 /* Playback */
3160 if (p_chmask) {
3161 /* Master channel, always writable */
3162 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3163 UAC3_BADD_FU_ID2, map->map);
3164 /* Mono/Stereo volume channels, always writable */
3165 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3166 UAC3_BADD_FU_ID2, map->map);
3167 }
3168
3169 /* Capture */
3170 if (c_chmask) {
3171 /* Master channel, always writable */
3172 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3173 UAC3_BADD_FU_ID5, map->map);
3174 /* Mono/Stereo volume channels, always writable */
3175 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3176 UAC3_BADD_FU_ID5, map->map);
3177 }
3178
3179 /* Side tone-mixing */
3180 if (st_chmask) {
3181 /* Master channel, always writable */
3182 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3183 UAC3_BADD_FU_ID7, map->map);
3184 /* Mono volume channel, always writable */
3185 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3186 UAC3_BADD_FU_ID7, map->map);
3187 }
3188
3189 /* Insertion Control */
3190 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3191 struct usb_audio_term iterm, oterm;
3192
3193 /* Input Term - Insertion control */
3194 memset(&iterm, 0, sizeof(iterm));
3195 iterm.id = UAC3_BADD_IT_ID4;
3196 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3197 build_connector_control(mixer, map->map, &iterm, true);
3198
3199 /* Output Term - Insertion control */
3200 memset(&oterm, 0, sizeof(oterm));
3201 oterm.id = UAC3_BADD_OT_ID3;
3202 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3203 build_connector_control(mixer, map->map, &oterm, false);
3204 }
3205
3206 return 0;
3207}
3208
3209/*
3210 * create mixer controls
3211 *
3212 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3213 */
3214static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3215{
3216 struct mixer_build state;
3217 int err;
3218 const struct usbmix_ctl_map *map;
3219 void *p;
3220
3221 memset(&state, 0, sizeof(state));
3222 state.chip = mixer->chip;
3223 state.mixer = mixer;
3224 state.buffer = mixer->hostif->extra;
3225 state.buflen = mixer->hostif->extralen;
3226
3227 /* check the mapping table */
3228 for (map = usbmix_ctl_maps; map->id; map++) {
3229 if (map->id == state.chip->usb_id) {
3230 state.map = map->map;
3231 state.selector_map = map->selector_map;
3232 mixer->connector_map = map->connector_map;
3233 break;
3234 }
3235 }
3236
3237 p = NULL;
3238 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3239 mixer->hostif->extralen,
3240 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3241 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3242 continue; /* skip invalid descriptor */
3243
3244 if (mixer->protocol == UAC_VERSION_1) {
3245 struct uac1_output_terminal_descriptor *desc = p;
3246
3247 /* mark terminal ID as visited */
3248 set_bit(desc->bTerminalID, state.unitbitmap);
3249 state.oterm.id = desc->bTerminalID;
3250 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3251 state.oterm.name = desc->iTerminal;
3252 err = parse_audio_unit(&state, desc->bSourceID);
3253 if (err < 0 && err != -EINVAL)
3254 return err;
3255 } else if (mixer->protocol == UAC_VERSION_2) {
3256 struct uac2_output_terminal_descriptor *desc = p;
3257
3258 /* mark terminal ID as visited */
3259 set_bit(desc->bTerminalID, state.unitbitmap);
3260 state.oterm.id = desc->bTerminalID;
3261 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3262 state.oterm.name = desc->iTerminal;
3263 err = parse_audio_unit(&state, desc->bSourceID);
3264 if (err < 0 && err != -EINVAL)
3265 return err;
3266
3267 /*
3268 * For UAC2, use the same approach to also add the
3269 * clock selectors
3270 */
3271 err = parse_audio_unit(&state, desc->bCSourceID);
3272 if (err < 0 && err != -EINVAL)
3273 return err;
3274
3275 if ((state.oterm.type & 0xff00) != 0x0100 &&
3276 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3277 UAC2_TE_CONNECTOR)) {
3278 build_connector_control(state.mixer, state.map,
3279 &state.oterm, false);
3280 }
3281 } else { /* UAC_VERSION_3 */
3282 struct uac3_output_terminal_descriptor *desc = p;
3283
3284 /* mark terminal ID as visited */
3285 set_bit(desc->bTerminalID, state.unitbitmap);
3286 state.oterm.id = desc->bTerminalID;
3287 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3288 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3289 err = parse_audio_unit(&state, desc->bSourceID);
3290 if (err < 0 && err != -EINVAL)
3291 return err;
3292
3293 /*
3294 * For UAC3, use the same approach to also add the
3295 * clock selectors
3296 */
3297 err = parse_audio_unit(&state, desc->bCSourceID);
3298 if (err < 0 && err != -EINVAL)
3299 return err;
3300
3301 if ((state.oterm.type & 0xff00) != 0x0100 &&
3302 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3303 UAC3_TE_INSERTION)) {
3304 build_connector_control(state.mixer, state.map,
3305 &state.oterm, false);
3306 }
3307 }
3308 }
3309
3310 return 0;
3311}
3312
3313static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3314 u8 *control, u8 *channel)
3315{
3316 const struct usbmix_connector_map *map = mixer->connector_map;
3317
3318 if (!map)
3319 return unitid;
3320
3321 for (; map->id; map++) {
3322 if (map->id == unitid) {
3323 if (control && map->control)
3324 *control = map->control;
3325 if (channel && map->channel)
3326 *channel = map->channel;
3327 return map->delegated_id;
3328 }
3329 }
3330 return unitid;
3331}
3332
3333void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3334{
3335 struct usb_mixer_elem_list *list;
3336
3337 unitid = delegate_notify(mixer, unitid, NULL, NULL);
3338
3339 for_each_mixer_elem(list, mixer, unitid) {
3340 struct usb_mixer_elem_info *info;
3341
3342 if (!list->is_std_info)
3343 continue;
3344 info = mixer_elem_list_to_info(list);
3345 /* invalidate cache, so the value is read from the device */
3346 info->cached = 0;
3347 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3348 &list->kctl->id);
3349 }
3350}
3351
3352static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3353 struct usb_mixer_elem_list *list)
3354{
3355 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3356 static const char * const val_types[] = {
3357 [USB_MIXER_BOOLEAN] = "BOOLEAN",
3358 [USB_MIXER_INV_BOOLEAN] = "INV_BOOLEAN",
3359 [USB_MIXER_S8] = "S8",
3360 [USB_MIXER_U8] = "U8",
3361 [USB_MIXER_S16] = "S16",
3362 [USB_MIXER_U16] = "U16",
3363 [USB_MIXER_S32] = "S32",
3364 [USB_MIXER_U32] = "U32",
3365 [USB_MIXER_BESPOKEN] = "BESPOKEN",
3366 };
3367 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3368 "channels=%i, type=\"%s\"\n", cval->head.id,
3369 cval->control, cval->cmask, cval->channels,
3370 val_types[cval->val_type]);
3371 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3372 cval->min, cval->max, cval->dBmin, cval->dBmax);
3373}
3374
3375static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3376 struct snd_info_buffer *buffer)
3377{
3378 struct snd_usb_audio *chip = entry->private_data;
3379 struct usb_mixer_interface *mixer;
3380 struct usb_mixer_elem_list *list;
3381 int unitid;
3382
3383 list_for_each_entry(mixer, &chip->mixer_list, list) {
3384 snd_iprintf(buffer,
3385 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3386 chip->usb_id, mixer_ctrl_intf(mixer),
3387 mixer->ignore_ctl_error);
3388 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3389 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3390 for_each_mixer_elem(list, mixer, unitid) {
3391 snd_iprintf(buffer, " Unit: %i\n", list->id);
3392 if (list->kctl)
3393 snd_iprintf(buffer,
3394 " Control: name=\"%s\", index=%i\n",
3395 list->kctl->id.name,
3396 list->kctl->id.index);
3397 if (list->dump)
3398 list->dump(buffer, list);
3399 }
3400 }
3401 }
3402}
3403
3404static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3405 int attribute, int value, int index)
3406{
3407 struct usb_mixer_elem_list *list;
3408 __u8 unitid = (index >> 8) & 0xff;
3409 __u8 control = (value >> 8) & 0xff;
3410 __u8 channel = value & 0xff;
3411 unsigned int count = 0;
3412
3413 if (channel >= MAX_CHANNELS) {
3414 usb_audio_dbg(mixer->chip,
3415 "%s(): bogus channel number %d\n",
3416 __func__, channel);
3417 return;
3418 }
3419
3420 unitid = delegate_notify(mixer, unitid, &control, &channel);
3421
3422 for_each_mixer_elem(list, mixer, unitid)
3423 count++;
3424
3425 if (count == 0)
3426 return;
3427
3428 for_each_mixer_elem(list, mixer, unitid) {
3429 struct usb_mixer_elem_info *info;
3430
3431 if (!list->kctl)
3432 continue;
3433 if (!list->is_std_info)
3434 continue;
3435
3436 info = mixer_elem_list_to_info(list);
3437 if (count > 1 && info->control != control)
3438 continue;
3439
3440 switch (attribute) {
3441 case UAC2_CS_CUR:
3442 /* invalidate cache, so the value is read from the device */
3443 if (channel)
3444 info->cached &= ~(1 << channel);
3445 else /* master channel */
3446 info->cached = 0;
3447
3448 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3449 &info->head.kctl->id);
3450 break;
3451
3452 case UAC2_CS_RANGE:
3453 /* TODO */
3454 break;
3455
3456 case UAC2_CS_MEM:
3457 /* TODO */
3458 break;
3459
3460 default:
3461 usb_audio_dbg(mixer->chip,
3462 "unknown attribute %d in interrupt\n",
3463 attribute);
3464 break;
3465 } /* switch */
3466 }
3467}
3468
3469static void snd_usb_mixer_interrupt(struct urb *urb)
3470{
3471 struct usb_mixer_interface *mixer = urb->context;
3472 int len = urb->actual_length;
3473 int ustatus = urb->status;
3474
3475 if (ustatus != 0)
3476 goto requeue;
3477
3478 if (mixer->protocol == UAC_VERSION_1) {
3479 struct uac1_status_word *status;
3480
3481 for (status = urb->transfer_buffer;
3482 len >= sizeof(*status);
3483 len -= sizeof(*status), status++) {
3484 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3485 status->bStatusType,
3486 status->bOriginator);
3487
3488 /* ignore any notifications not from the control interface */
3489 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3490 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3491 continue;
3492
3493 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3494 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3495 else
3496 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3497 }
3498 } else { /* UAC_VERSION_2 */
3499 struct uac2_interrupt_data_msg *msg;
3500
3501 for (msg = urb->transfer_buffer;
3502 len >= sizeof(*msg);
3503 len -= sizeof(*msg), msg++) {
3504 /* drop vendor specific and endpoint requests */
3505 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3506 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3507 continue;
3508
3509 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3510 le16_to_cpu(msg->wValue),
3511 le16_to_cpu(msg->wIndex));
3512 }
3513 }
3514
3515requeue:
3516 if (ustatus != -ENOENT &&
3517 ustatus != -ECONNRESET &&
3518 ustatus != -ESHUTDOWN) {
3519 urb->dev = mixer->chip->dev;
3520 usb_submit_urb(urb, GFP_ATOMIC);
3521 }
3522}
3523
3524/* create the handler for the optional status interrupt endpoint */
3525static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3526{
3527 struct usb_endpoint_descriptor *ep;
3528 void *transfer_buffer;
3529 int buffer_length;
3530 unsigned int epnum;
3531
3532 /* we need one interrupt input endpoint */
3533 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3534 return 0;
3535 ep = get_endpoint(mixer->hostif, 0);
3536 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3537 return 0;
3538
3539 epnum = usb_endpoint_num(ep);
3540 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3541 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3542 if (!transfer_buffer)
3543 return -ENOMEM;
3544 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3545 if (!mixer->urb) {
3546 kfree(transfer_buffer);
3547 return -ENOMEM;
3548 }
3549 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3550 usb_rcvintpipe(mixer->chip->dev, epnum),
3551 transfer_buffer, buffer_length,
3552 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3553 usb_submit_urb(mixer->urb, GFP_KERNEL);
3554 return 0;
3555}
3556
3557int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif)
3558{
3559 static const struct snd_device_ops dev_ops = {
3560 .dev_free = snd_usb_mixer_dev_free
3561 };
3562 struct usb_mixer_interface *mixer;
3563 int err;
3564
3565 strcpy(chip->card->mixername, "USB Mixer");
3566
3567 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3568 if (!mixer)
3569 return -ENOMEM;
3570 mixer->chip = chip;
3571 mixer->ignore_ctl_error = !!(chip->quirk_flags & QUIRK_FLAG_IGNORE_CTL_ERROR);
3572 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3573 GFP_KERNEL);
3574 if (!mixer->id_elems) {
3575 kfree(mixer);
3576 return -ENOMEM;
3577 }
3578
3579 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3580 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3581 case UAC_VERSION_1:
3582 default:
3583 mixer->protocol = UAC_VERSION_1;
3584 break;
3585 case UAC_VERSION_2:
3586 mixer->protocol = UAC_VERSION_2;
3587 break;
3588 case UAC_VERSION_3:
3589 mixer->protocol = UAC_VERSION_3;
3590 break;
3591 }
3592
3593 if (mixer->protocol == UAC_VERSION_3 &&
3594 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3595 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3596 if (err < 0)
3597 goto _error;
3598 } else {
3599 err = snd_usb_mixer_controls(mixer);
3600 if (err < 0)
3601 goto _error;
3602 }
3603
3604 err = snd_usb_mixer_status_create(mixer);
3605 if (err < 0)
3606 goto _error;
3607
3608 err = snd_usb_mixer_apply_create_quirk(mixer);
3609 if (err < 0)
3610 goto _error;
3611
3612 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3613 if (err < 0)
3614 goto _error;
3615
3616 if (list_empty(&chip->mixer_list))
3617 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3618 snd_usb_mixer_proc_read);
3619
3620 list_add(&mixer->list, &chip->mixer_list);
3621 return 0;
3622
3623_error:
3624 snd_usb_mixer_free(mixer);
3625 return err;
3626}
3627
3628void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3629{
3630 if (mixer->disconnected)
3631 return;
3632 if (mixer->urb)
3633 usb_kill_urb(mixer->urb);
3634 if (mixer->rc_urb)
3635 usb_kill_urb(mixer->rc_urb);
3636 if (mixer->private_free)
3637 mixer->private_free(mixer);
3638 mixer->disconnected = true;
3639}
3640
3641/* stop any bus activity of a mixer */
3642static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3643{
3644 usb_kill_urb(mixer->urb);
3645 usb_kill_urb(mixer->rc_urb);
3646}
3647
3648static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3649{
3650 int err;
3651
3652 if (mixer->urb) {
3653 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3654 if (err < 0)
3655 return err;
3656 }
3657
3658 return 0;
3659}
3660
3661int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3662{
3663 snd_usb_mixer_inactivate(mixer);
3664 if (mixer->private_suspend)
3665 mixer->private_suspend(mixer);
3666 return 0;
3667}
3668
3669static int restore_mixer_value(struct usb_mixer_elem_list *list)
3670{
3671 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3672 int c, err, idx;
3673
3674 if (cval->val_type == USB_MIXER_BESPOKEN)
3675 return 0;
3676
3677 if (cval->cmask) {
3678 idx = 0;
3679 for (c = 0; c < MAX_CHANNELS; c++) {
3680 if (!(cval->cmask & (1 << c)))
3681 continue;
3682 if (cval->cached & (1 << (c + 1))) {
3683 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3684 cval->cache_val[idx]);
3685 if (err < 0)
3686 break;
3687 }
3688 idx++;
3689 }
3690 } else {
3691 /* master */
3692 if (cval->cached)
3693 snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3694 }
3695
3696 return 0;
3697}
3698
3699int snd_usb_mixer_resume(struct usb_mixer_interface *mixer)
3700{
3701 struct usb_mixer_elem_list *list;
3702 int id, err;
3703
3704 /* restore cached mixer values */
3705 for (id = 0; id < MAX_ID_ELEMS; id++) {
3706 for_each_mixer_elem(list, mixer, id) {
3707 if (list->resume) {
3708 err = list->resume(list);
3709 if (err < 0)
3710 return err;
3711 }
3712 }
3713 }
3714
3715 snd_usb_mixer_resume_quirk(mixer);
3716
3717 return snd_usb_mixer_activate(mixer);
3718}
3719
3720void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3721 struct usb_mixer_interface *mixer,
3722 int unitid)
3723{
3724 list->mixer = mixer;
3725 list->id = unitid;
3726 list->dump = snd_usb_mixer_dump_cval;
3727 list->resume = restore_mixer_value;
3728}
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}