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