]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - sound/usb/mixer.c
projects / mirror_ubuntu-jammy-kernel.git / blob
? search:


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