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