]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - sound/usb/mixer.c
projects / mirror_ubuntu-jammy-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
ALSA: usb-audio: Drop bogus dB range in too low level
[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 /* get the connectors status and report it as boolean type */
1450 static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1451 struct snd_ctl_elem_value *ucontrol)
1452 {
1453 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1454 struct snd_usb_audio *chip = cval->head.mixer->chip;
1455 int idx = 0, validx, ret, val;
1456
1457 validx = cval->control << 8 | 0;
1458
1459 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1460 if (ret)
1461 goto error;
1462
1463 idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1464 if (cval->head.mixer->protocol == UAC_VERSION_2) {
1465 struct uac2_connectors_ctl_blk uac2_conn;
1466
1467 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1468 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1469 validx, idx, &uac2_conn, sizeof(uac2_conn));
1470 val = !!uac2_conn.bNrChannels;
1471 } else { /* UAC_VERSION_3 */
1472 struct uac3_insertion_ctl_blk uac3_conn;
1473
1474 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1475 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1476 validx, idx, &uac3_conn, sizeof(uac3_conn));
1477 val = !!uac3_conn.bmConInserted;
1478 }
1479
1480 snd_usb_unlock_shutdown(chip);
1481
1482 if (ret < 0) {
1483 if (strstr(kcontrol->id.name, "Speaker")) {
1484 ucontrol->value.integer.value[0] = 1;
1485 return 0;
1486 }
1487 error:
1488 usb_audio_err(chip,
1489 "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1490 UAC_GET_CUR, validx, idx, cval->val_type);
1491 return filter_error(cval, ret);
1492 }
1493
1494 ucontrol->value.integer.value[0] = val;
1495 return 0;
1496 }
1497
1498 static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1499 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1500 .name = "", /* will be filled later manually */
1501 .info = mixer_ctl_feature_info,
1502 .get = mixer_ctl_feature_get,
1503 .put = mixer_ctl_feature_put,
1504 };
1505
1506 /* the read-only variant */
1507 static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1508 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1509 .name = "", /* will be filled later manually */
1510 .info = mixer_ctl_feature_info,
1511 .get = mixer_ctl_feature_get,
1512 .put = NULL,
1513 };
1514
1515 /*
1516 * A control which shows the boolean value from reading a UAC control on
1517 * the master channel.
1518 */
1519 static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1520 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1521 .name = "", /* will be filled later manually */
1522 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1523 .info = snd_ctl_boolean_mono_info,
1524 .get = mixer_ctl_master_bool_get,
1525 .put = NULL,
1526 };
1527
1528 static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1529 .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1530 .name = "", /* will be filled later manually */
1531 .access = SNDRV_CTL_ELEM_ACCESS_READ,
1532 .info = snd_ctl_boolean_mono_info,
1533 .get = mixer_ctl_connector_get,
1534 .put = NULL,
1535 };
1536
1537 /*
1538 * This symbol is exported in order to allow the mixer quirks to
1539 * hook up to the standard feature unit control mechanism
1540 */
1541 const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1542
1543 /*
1544 * build a feature control
1545 */
1546 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1547 {
1548 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1549 }
1550
1551 /*
1552 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1553 * rename it to "Headphone". We determine if something is a headphone
1554 * similar to how udev determines form factor.
1555 */
1556 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1557 struct snd_card *card)
1558 {
1559 const char *names_to_check[] = {
1560 "Headset", "headset", "Headphone", "headphone", NULL};
1561 const char **s;
1562 bool found = false;
1563
1564 if (strcmp("Speaker", kctl->id.name))
1565 return;
1566
1567 for (s = names_to_check; *s; s++)
1568 if (strstr(card->shortname, *s)) {
1569 found = true;
1570 break;
1571 }
1572
1573 if (!found)
1574 return;
1575
1576 strscpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1577 }
1578
1579 static const struct usb_feature_control_info *get_feature_control_info(int control)
1580 {
1581 int i;
1582
1583 for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1584 if (audio_feature_info[i].control == control)
1585 return &audio_feature_info[i];
1586 }
1587 return NULL;
1588 }
1589
1590 static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1591 const struct usbmix_name_map *imap,
1592 unsigned int ctl_mask, int control,
1593 struct usb_audio_term *iterm,
1594 struct usb_audio_term *oterm,
1595 int unitid, int nameid, int readonly_mask)
1596 {
1597 const struct usb_feature_control_info *ctl_info;
1598 unsigned int len = 0;
1599 int mapped_name = 0;
1600 struct snd_kcontrol *kctl;
1601 struct usb_mixer_elem_info *cval;
1602 const struct usbmix_name_map *map;
1603 unsigned int range;
1604
1605 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1606 /* FIXME: not supported yet */
1607 return;
1608 }
1609
1610 map = find_map(imap, unitid, control);
1611 if (check_ignored_ctl(map))
1612 return;
1613
1614 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1615 if (!cval)
1616 return;
1617 snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1618 cval->control = control;
1619 cval->cmask = ctl_mask;
1620
1621 ctl_info = get_feature_control_info(control);
1622 if (!ctl_info) {
1623 usb_mixer_elem_info_free(cval);
1624 return;
1625 }
1626 if (mixer->protocol == UAC_VERSION_1)
1627 cval->val_type = ctl_info->type;
1628 else /* UAC_VERSION_2 */
1629 cval->val_type = ctl_info->type_uac2 >= 0 ?
1630 ctl_info->type_uac2 : ctl_info->type;
1631
1632 if (ctl_mask == 0) {
1633 cval->channels = 1; /* master channel */
1634 cval->master_readonly = readonly_mask;
1635 } else {
1636 int i, c = 0;
1637 for (i = 0; i < 16; i++)
1638 if (ctl_mask & (1 << i))
1639 c++;
1640 cval->channels = c;
1641 cval->ch_readonly = readonly_mask;
1642 }
1643
1644 /*
1645 * If all channels in the mask are marked read-only, make the control
1646 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1647 * issue write commands to read-only channels.
1648 */
1649 if (cval->channels == readonly_mask)
1650 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1651 else
1652 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1653
1654 if (!kctl) {
1655 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1656 usb_mixer_elem_info_free(cval);
1657 return;
1658 }
1659 kctl->private_free = snd_usb_mixer_elem_free;
1660
1661 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1662 mapped_name = len != 0;
1663 if (!len && nameid)
1664 len = snd_usb_copy_string_desc(mixer->chip, nameid,
1665 kctl->id.name, sizeof(kctl->id.name));
1666
1667 switch (control) {
1668 case UAC_FU_MUTE:
1669 case UAC_FU_VOLUME:
1670 /*
1671 * determine the control name. the rule is:
1672 * - if a name id is given in descriptor, use it.
1673 * - if the connected input can be determined, then use the name
1674 * of terminal type.
1675 * - if the connected output can be determined, use it.
1676 * - otherwise, anonymous name.
1677 */
1678 if (!len) {
1679 if (iterm)
1680 len = get_term_name(mixer->chip, iterm,
1681 kctl->id.name,
1682 sizeof(kctl->id.name), 1);
1683 if (!len && oterm)
1684 len = get_term_name(mixer->chip, oterm,
1685 kctl->id.name,
1686 sizeof(kctl->id.name), 1);
1687 if (!len)
1688 snprintf(kctl->id.name, sizeof(kctl->id.name),
1689 "Feature %d", unitid);
1690 }
1691
1692 if (!mapped_name)
1693 check_no_speaker_on_headset(kctl, mixer->chip->card);
1694
1695 /*
1696 * determine the stream direction:
1697 * if the connected output is USB stream, then it's likely a
1698 * capture stream. otherwise it should be playback (hopefully :)
1699 */
1700 if (!mapped_name && oterm && !(oterm->type >> 16)) {
1701 if ((oterm->type & 0xff00) == 0x0100)
1702 append_ctl_name(kctl, " Capture");
1703 else
1704 append_ctl_name(kctl, " Playback");
1705 }
1706 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1707 " Switch" : " Volume");
1708 break;
1709 default:
1710 if (!len)
1711 strscpy(kctl->id.name, audio_feature_info[control-1].name,
1712 sizeof(kctl->id.name));
1713 break;
1714 }
1715
1716 /* get min/max values */
1717 get_min_max_with_quirks(cval, 0, kctl);
1718
1719 /* skip a bogus volume range */
1720 if (cval->max <= cval->min) {
1721 usb_audio_dbg(mixer->chip,
1722 "[%d] FU [%s] skipped due to invalid volume\n",
1723 cval->head.id, kctl->id.name);
1724 snd_ctl_free_one(kctl);
1725 return;
1726 }
1727
1728
1729 if (control == UAC_FU_VOLUME) {
1730 check_mapped_dB(map, cval);
1731 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1732 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1733 kctl->vd[0].access |=
1734 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1735 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1736 }
1737 }
1738
1739 snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1740
1741 range = (cval->max - cval->min) / cval->res;
1742 /*
1743 * Are there devices with volume range more than 255? I use a bit more
1744 * to be sure. 384 is a resolution magic number found on Logitech
1745 * devices. It will definitively catch all buggy Logitech devices.
1746 */
1747 if (range > 384) {
1748 usb_audio_warn(mixer->chip,
1749 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1750 range);
1751 usb_audio_warn(mixer->chip,
1752 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1753 cval->head.id, kctl->id.name, cval->channels,
1754 cval->min, cval->max, cval->res);
1755 }
1756
1757 usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1758 cval->head.id, kctl->id.name, cval->channels,
1759 cval->min, cval->max, cval->res);
1760 snd_usb_mixer_add_control(&cval->head, kctl);
1761 }
1762
1763 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1764 unsigned int ctl_mask, int control,
1765 struct usb_audio_term *iterm, int unitid,
1766 int readonly_mask)
1767 {
1768 struct uac_feature_unit_descriptor *desc = raw_desc;
1769 int nameid = uac_feature_unit_iFeature(desc);
1770
1771 __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1772 iterm, &state->oterm, unitid, nameid, readonly_mask);
1773 }
1774
1775 static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1776 unsigned int ctl_mask, int control, int unitid,
1777 const struct usbmix_name_map *badd_map)
1778 {
1779 __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1780 NULL, NULL, unitid, 0, 0);
1781 }
1782
1783 static void get_connector_control_name(struct usb_mixer_interface *mixer,
1784 struct usb_audio_term *term,
1785 bool is_input, char *name, int name_size)
1786 {
1787 int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1788
1789 if (name_len == 0)
1790 strscpy(name, "Unknown", name_size);
1791
1792 /*
1793 * sound/core/ctljack.c has a convention of naming jack controls
1794 * by ending in " Jack". Make it slightly more useful by
1795 * indicating Input or Output after the terminal name.
1796 */
1797 if (is_input)
1798 strlcat(name, " - Input Jack", name_size);
1799 else
1800 strlcat(name, " - Output Jack", name_size);
1801 }
1802
1803 /* Build a mixer control for a UAC connector control (jack-detect) */
1804 static void build_connector_control(struct usb_mixer_interface *mixer,
1805 const struct usbmix_name_map *imap,
1806 struct usb_audio_term *term, bool is_input)
1807 {
1808 struct snd_kcontrol *kctl;
1809 struct usb_mixer_elem_info *cval;
1810 const struct usbmix_name_map *map;
1811
1812 map = find_map(imap, term->id, 0);
1813 if (check_ignored_ctl(map))
1814 return;
1815
1816 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1817 if (!cval)
1818 return;
1819 snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1820 /*
1821 * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1822 * number of channels connected.
1823 *
1824 * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1825 * following byte(s) specifies which connectors are inserted.
1826 *
1827 * This boolean ctl will simply report if any channels are connected
1828 * or not.
1829 */
1830 if (mixer->protocol == UAC_VERSION_2)
1831 cval->control = UAC2_TE_CONNECTOR;
1832 else /* UAC_VERSION_3 */
1833 cval->control = UAC3_TE_INSERTION;
1834
1835 cval->val_type = USB_MIXER_BOOLEAN;
1836 cval->channels = 1; /* report true if any channel is connected */
1837 cval->min = 0;
1838 cval->max = 1;
1839 kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1840 if (!kctl) {
1841 usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1842 usb_mixer_elem_info_free(cval);
1843 return;
1844 }
1845
1846 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1847 strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1848 else
1849 get_connector_control_name(mixer, term, is_input, kctl->id.name,
1850 sizeof(kctl->id.name));
1851 kctl->private_free = snd_usb_mixer_elem_free;
1852 snd_usb_mixer_add_control(&cval->head, kctl);
1853 }
1854
1855 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1856 void *_ftr)
1857 {
1858 struct uac_clock_source_descriptor *hdr = _ftr;
1859 struct usb_mixer_elem_info *cval;
1860 struct snd_kcontrol *kctl;
1861 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1862 int ret;
1863
1864 if (state->mixer->protocol != UAC_VERSION_2)
1865 return -EINVAL;
1866
1867 /*
1868 * The only property of this unit we are interested in is the
1869 * clock source validity. If that isn't readable, just bail out.
1870 */
1871 if (!uac_v2v3_control_is_readable(hdr->bmControls,
1872 UAC2_CS_CONTROL_CLOCK_VALID))
1873 return 0;
1874
1875 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1876 if (!cval)
1877 return -ENOMEM;
1878
1879 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1880
1881 cval->min = 0;
1882 cval->max = 1;
1883 cval->channels = 1;
1884 cval->val_type = USB_MIXER_BOOLEAN;
1885 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1886
1887 cval->master_readonly = 1;
1888 /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1889 kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1890
1891 if (!kctl) {
1892 usb_mixer_elem_info_free(cval);
1893 return -ENOMEM;
1894 }
1895
1896 kctl->private_free = snd_usb_mixer_elem_free;
1897 ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1898 name, sizeof(name));
1899 if (ret > 0)
1900 snprintf(kctl->id.name, sizeof(kctl->id.name),
1901 "%s Validity", name);
1902 else
1903 snprintf(kctl->id.name, sizeof(kctl->id.name),
1904 "Clock Source %d Validity", hdr->bClockID);
1905
1906 return snd_usb_mixer_add_control(&cval->head, kctl);
1907 }
1908
1909 /*
1910 * parse a feature unit
1911 *
1912 * most of controls are defined here.
1913 */
1914 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1915 void *_ftr)
1916 {
1917 int channels, i, j;
1918 struct usb_audio_term iterm;
1919 unsigned int master_bits;
1920 int err, csize;
1921 struct uac_feature_unit_descriptor *hdr = _ftr;
1922 __u8 *bmaControls;
1923
1924 if (state->mixer->protocol == UAC_VERSION_1) {
1925 csize = hdr->bControlSize;
1926 channels = (hdr->bLength - 7) / csize - 1;
1927 bmaControls = hdr->bmaControls;
1928 } else if (state->mixer->protocol == UAC_VERSION_2) {
1929 struct uac2_feature_unit_descriptor *ftr = _ftr;
1930 csize = 4;
1931 channels = (hdr->bLength - 6) / 4 - 1;
1932 bmaControls = ftr->bmaControls;
1933 } else { /* UAC_VERSION_3 */
1934 struct uac3_feature_unit_descriptor *ftr = _ftr;
1935
1936 csize = 4;
1937 channels = (ftr->bLength - 7) / 4 - 1;
1938 bmaControls = ftr->bmaControls;
1939 }
1940
1941 /* parse the source unit */
1942 err = parse_audio_unit(state, hdr->bSourceID);
1943 if (err < 0)
1944 return err;
1945
1946 /* determine the input source type and name */
1947 err = check_input_term(state, hdr->bSourceID, &iterm);
1948 if (err < 0)
1949 return err;
1950
1951 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1952 /* master configuration quirks */
1953 switch (state->chip->usb_id) {
1954 case USB_ID(0x08bb, 0x2702):
1955 usb_audio_info(state->chip,
1956 "usbmixer: master volume quirk for PCM2702 chip\n");
1957 /* disable non-functional volume control */
1958 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1959 break;
1960 case USB_ID(0x1130, 0xf211):
1961 usb_audio_info(state->chip,
1962 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1963 /* disable non-functional volume control */
1964 channels = 0;
1965 break;
1966
1967 }
1968
1969 if (state->mixer->protocol == UAC_VERSION_1) {
1970 /* check all control types */
1971 for (i = 0; i < 10; i++) {
1972 unsigned int ch_bits = 0;
1973 int control = audio_feature_info[i].control;
1974
1975 for (j = 0; j < channels; j++) {
1976 unsigned int mask;
1977
1978 mask = snd_usb_combine_bytes(bmaControls +
1979 csize * (j+1), csize);
1980 if (mask & (1 << i))
1981 ch_bits |= (1 << j);
1982 }
1983 /* audio class v1 controls are never read-only */
1984
1985 /*
1986 * The first channel must be set
1987 * (for ease of programming).
1988 */
1989 if (ch_bits & 1)
1990 build_feature_ctl(state, _ftr, ch_bits, control,
1991 &iterm, unitid, 0);
1992 if (master_bits & (1 << i))
1993 build_feature_ctl(state, _ftr, 0, control,
1994 &iterm, unitid, 0);
1995 }
1996 } else { /* UAC_VERSION_2/3 */
1997 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1998 unsigned int ch_bits = 0;
1999 unsigned int ch_read_only = 0;
2000 int control = audio_feature_info[i].control;
2001
2002 for (j = 0; j < channels; j++) {
2003 unsigned int mask;
2004
2005 mask = snd_usb_combine_bytes(bmaControls +
2006 csize * (j+1), csize);
2007 if (uac_v2v3_control_is_readable(mask, control)) {
2008 ch_bits |= (1 << j);
2009 if (!uac_v2v3_control_is_writeable(mask, control))
2010 ch_read_only |= (1 << j);
2011 }
2012 }
2013
2014 /*
2015 * NOTE: build_feature_ctl() will mark the control
2016 * read-only if all channels are marked read-only in
2017 * the descriptors. Otherwise, the control will be
2018 * reported as writeable, but the driver will not
2019 * actually issue a write command for read-only
2020 * channels.
2021 */
2022
2023 /*
2024 * The first channel must be set
2025 * (for ease of programming).
2026 */
2027 if (ch_bits & 1)
2028 build_feature_ctl(state, _ftr, ch_bits, control,
2029 &iterm, unitid, ch_read_only);
2030 if (uac_v2v3_control_is_readable(master_bits, control))
2031 build_feature_ctl(state, _ftr, 0, control,
2032 &iterm, unitid,
2033 !uac_v2v3_control_is_writeable(master_bits,
2034 control));
2035 }
2036 }
2037
2038 return 0;
2039 }
2040
2041 /*
2042 * Mixer Unit
2043 */
2044
2045 /* check whether the given in/out overflows bmMixerControls matrix */
2046 static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2047 int protocol, int num_ins, int num_outs)
2048 {
2049 u8 *hdr = (u8 *)desc;
2050 u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2051 size_t rest; /* remaining bytes after bmMixerControls */
2052
2053 switch (protocol) {
2054 case UAC_VERSION_1:
2055 default:
2056 rest = 1; /* iMixer */
2057 break;
2058 case UAC_VERSION_2:
2059 rest = 2; /* bmControls + iMixer */
2060 break;
2061 case UAC_VERSION_3:
2062 rest = 6; /* bmControls + wMixerDescrStr */
2063 break;
2064 }
2065
2066 /* overflow? */
2067 return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2068 }
2069
2070 /*
2071 * build a mixer unit control
2072 *
2073 * the callbacks are identical with feature unit.
2074 * input channel number (zero based) is given in control field instead.
2075 */
2076 static void build_mixer_unit_ctl(struct mixer_build *state,
2077 struct uac_mixer_unit_descriptor *desc,
2078 int in_pin, int in_ch, int num_outs,
2079 int unitid, struct usb_audio_term *iterm)
2080 {
2081 struct usb_mixer_elem_info *cval;
2082 unsigned int i, len;
2083 struct snd_kcontrol *kctl;
2084 const struct usbmix_name_map *map;
2085
2086 map = find_map(state->map, unitid, 0);
2087 if (check_ignored_ctl(map))
2088 return;
2089
2090 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2091 if (!cval)
2092 return;
2093
2094 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2095 cval->control = in_ch + 1; /* based on 1 */
2096 cval->val_type = USB_MIXER_S16;
2097 for (i = 0; i < num_outs; i++) {
2098 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2099
2100 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2101 cval->cmask |= (1 << i);
2102 cval->channels++;
2103 }
2104 }
2105
2106 /* get min/max values */
2107 get_min_max(cval, 0);
2108
2109 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2110 if (!kctl) {
2111 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2112 usb_mixer_elem_info_free(cval);
2113 return;
2114 }
2115 kctl->private_free = snd_usb_mixer_elem_free;
2116
2117 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2118 if (!len)
2119 len = get_term_name(state->chip, iterm, kctl->id.name,
2120 sizeof(kctl->id.name), 0);
2121 if (!len)
2122 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2123 append_ctl_name(kctl, " Volume");
2124
2125 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2126 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2127 snd_usb_mixer_add_control(&cval->head, kctl);
2128 }
2129
2130 static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2131 void *raw_desc)
2132 {
2133 struct usb_audio_term iterm;
2134 unsigned int control, bmctls, term_id;
2135
2136 if (state->mixer->protocol == UAC_VERSION_2) {
2137 struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2138 control = UAC2_TE_CONNECTOR;
2139 term_id = d_v2->bTerminalID;
2140 bmctls = le16_to_cpu(d_v2->bmControls);
2141 } else if (state->mixer->protocol == UAC_VERSION_3) {
2142 struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2143 control = UAC3_TE_INSERTION;
2144 term_id = d_v3->bTerminalID;
2145 bmctls = le32_to_cpu(d_v3->bmControls);
2146 } else {
2147 return 0; /* UAC1. No Insertion control */
2148 }
2149
2150 check_input_term(state, term_id, &iterm);
2151
2152 /* Check for jack detection. */
2153 if ((iterm.type & 0xff00) != 0x0100 &&
2154 uac_v2v3_control_is_readable(bmctls, control))
2155 build_connector_control(state->mixer, state->map, &iterm, true);
2156
2157 return 0;
2158 }
2159
2160 /*
2161 * parse a mixer unit
2162 */
2163 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2164 void *raw_desc)
2165 {
2166 struct uac_mixer_unit_descriptor *desc = raw_desc;
2167 struct usb_audio_term iterm;
2168 int input_pins, num_ins, num_outs;
2169 int pin, ich, err;
2170
2171 err = uac_mixer_unit_get_channels(state, desc);
2172 if (err < 0) {
2173 usb_audio_err(state->chip,
2174 "invalid MIXER UNIT descriptor %d\n",
2175 unitid);
2176 return err;
2177 }
2178
2179 num_outs = err;
2180 input_pins = desc->bNrInPins;
2181
2182 num_ins = 0;
2183 ich = 0;
2184 for (pin = 0; pin < input_pins; pin++) {
2185 err = parse_audio_unit(state, desc->baSourceID[pin]);
2186 if (err < 0)
2187 continue;
2188 /* no bmControls field (e.g. Maya44) -> ignore */
2189 if (!num_outs)
2190 continue;
2191 err = check_input_term(state, desc->baSourceID[pin], &iterm);
2192 if (err < 0)
2193 return err;
2194 num_ins += iterm.channels;
2195 if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2196 num_ins, num_outs))
2197 break;
2198 for (; ich < num_ins; ich++) {
2199 int och, ich_has_controls = 0;
2200
2201 for (och = 0; och < num_outs; och++) {
2202 __u8 *c = uac_mixer_unit_bmControls(desc,
2203 state->mixer->protocol);
2204
2205 if (check_matrix_bitmap(c, ich, och, num_outs)) {
2206 ich_has_controls = 1;
2207 break;
2208 }
2209 }
2210 if (ich_has_controls)
2211 build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2212 unitid, &iterm);
2213 }
2214 }
2215 return 0;
2216 }
2217
2218 /*
2219 * Processing Unit / Extension Unit
2220 */
2221
2222 /* get callback for processing/extension unit */
2223 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2224 struct snd_ctl_elem_value *ucontrol)
2225 {
2226 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2227 int err, val;
2228
2229 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2230 if (err < 0) {
2231 ucontrol->value.integer.value[0] = cval->min;
2232 return filter_error(cval, err);
2233 }
2234 val = get_relative_value(cval, val);
2235 ucontrol->value.integer.value[0] = val;
2236 return 0;
2237 }
2238
2239 /* put callback for processing/extension unit */
2240 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2241 struct snd_ctl_elem_value *ucontrol)
2242 {
2243 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2244 int val, oval, err;
2245
2246 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2247 if (err < 0)
2248 return filter_error(cval, err);
2249 val = ucontrol->value.integer.value[0];
2250 val = get_abs_value(cval, val);
2251 if (val != oval) {
2252 set_cur_ctl_value(cval, cval->control << 8, val);
2253 return 1;
2254 }
2255 return 0;
2256 }
2257
2258 /* alsa control interface for processing/extension unit */
2259 static const struct snd_kcontrol_new mixer_procunit_ctl = {
2260 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2261 .name = "", /* will be filled later */
2262 .info = mixer_ctl_feature_info,
2263 .get = mixer_ctl_procunit_get,
2264 .put = mixer_ctl_procunit_put,
2265 };
2266
2267 /*
2268 * predefined data for processing units
2269 */
2270 struct procunit_value_info {
2271 int control;
2272 const char *suffix;
2273 int val_type;
2274 int min_value;
2275 };
2276
2277 struct procunit_info {
2278 int type;
2279 char *name;
2280 const struct procunit_value_info *values;
2281 };
2282
2283 static const struct procunit_value_info undefined_proc_info[] = {
2284 { 0x00, "Control Undefined", 0 },
2285 { 0 }
2286 };
2287
2288 static const struct procunit_value_info updown_proc_info[] = {
2289 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2290 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2291 { 0 }
2292 };
2293 static const struct procunit_value_info prologic_proc_info[] = {
2294 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2295 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2296 { 0 }
2297 };
2298 static const struct procunit_value_info threed_enh_proc_info[] = {
2299 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2300 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2301 { 0 }
2302 };
2303 static const struct procunit_value_info reverb_proc_info[] = {
2304 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2305 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2306 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2307 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2308 { 0 }
2309 };
2310 static const struct procunit_value_info chorus_proc_info[] = {
2311 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2312 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2313 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2314 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2315 { 0 }
2316 };
2317 static const struct procunit_value_info dcr_proc_info[] = {
2318 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2319 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2320 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2321 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2322 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2323 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2324 { 0 }
2325 };
2326
2327 static const struct procunit_info procunits[] = {
2328 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2329 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2330 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2331 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2332 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2333 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2334 { 0 },
2335 };
2336
2337 static const struct procunit_value_info uac3_updown_proc_info[] = {
2338 { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2339 { 0 }
2340 };
2341 static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2342 { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2343 { 0 }
2344 };
2345
2346 static const struct procunit_info uac3_procunits[] = {
2347 { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2348 { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2349 { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2350 { 0 },
2351 };
2352
2353 /*
2354 * predefined data for extension units
2355 */
2356 static const struct procunit_value_info clock_rate_xu_info[] = {
2357 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2358 { 0 }
2359 };
2360 static const struct procunit_value_info clock_source_xu_info[] = {
2361 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2362 { 0 }
2363 };
2364 static const struct procunit_value_info spdif_format_xu_info[] = {
2365 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2366 { 0 }
2367 };
2368 static const struct procunit_value_info soft_limit_xu_info[] = {
2369 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2370 { 0 }
2371 };
2372 static const struct procunit_info extunits[] = {
2373 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2374 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2375 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2376 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2377 { 0 }
2378 };
2379
2380 /*
2381 * build a processing/extension unit
2382 */
2383 static int build_audio_procunit(struct mixer_build *state, int unitid,
2384 void *raw_desc, const struct procunit_info *list,
2385 bool extension_unit)
2386 {
2387 struct uac_processing_unit_descriptor *desc = raw_desc;
2388 int num_ins;
2389 struct usb_mixer_elem_info *cval;
2390 struct snd_kcontrol *kctl;
2391 int i, err, nameid, type, len, val;
2392 const struct procunit_info *info;
2393 const struct procunit_value_info *valinfo;
2394 const struct usbmix_name_map *map;
2395 static const struct procunit_value_info default_value_info[] = {
2396 { 0x01, "Switch", USB_MIXER_BOOLEAN },
2397 { 0 }
2398 };
2399 static const struct procunit_info default_info = {
2400 0, NULL, default_value_info
2401 };
2402 const char *name = extension_unit ?
2403 "Extension Unit" : "Processing Unit";
2404
2405 num_ins = desc->bNrInPins;
2406 for (i = 0; i < num_ins; i++) {
2407 err = parse_audio_unit(state, desc->baSourceID[i]);
2408 if (err < 0)
2409 return err;
2410 }
2411
2412 type = le16_to_cpu(desc->wProcessType);
2413 for (info = list; info && info->type; info++)
2414 if (info->type == type)
2415 break;
2416 if (!info || !info->type)
2417 info = &default_info;
2418
2419 for (valinfo = info->values; valinfo->control; valinfo++) {
2420 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2421
2422 if (state->mixer->protocol == UAC_VERSION_1) {
2423 if (!(controls[valinfo->control / 8] &
2424 (1 << ((valinfo->control % 8) - 1))))
2425 continue;
2426 } else { /* UAC_VERSION_2/3 */
2427 if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2428 valinfo->control))
2429 continue;
2430 }
2431
2432 map = find_map(state->map, unitid, valinfo->control);
2433 if (check_ignored_ctl(map))
2434 continue;
2435 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2436 if (!cval)
2437 return -ENOMEM;
2438 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2439 cval->control = valinfo->control;
2440 cval->val_type = valinfo->val_type;
2441 cval->channels = 1;
2442
2443 if (state->mixer->protocol > UAC_VERSION_1 &&
2444 !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2445 valinfo->control))
2446 cval->master_readonly = 1;
2447
2448 /* get min/max values */
2449 switch (type) {
2450 case UAC_PROCESS_UP_DOWNMIX: {
2451 bool mode_sel = false;
2452
2453 switch (state->mixer->protocol) {
2454 case UAC_VERSION_1:
2455 case UAC_VERSION_2:
2456 default:
2457 if (cval->control == UAC_UD_MODE_SELECT)
2458 mode_sel = true;
2459 break;
2460 case UAC_VERSION_3:
2461 if (cval->control == UAC3_UD_MODE_SELECT)
2462 mode_sel = true;
2463 break;
2464 }
2465
2466 if (mode_sel) {
2467 __u8 *control_spec = uac_processing_unit_specific(desc,
2468 state->mixer->protocol);
2469 cval->min = 1;
2470 cval->max = control_spec[0];
2471 cval->res = 1;
2472 cval->initialized = 1;
2473 break;
2474 }
2475
2476 get_min_max(cval, valinfo->min_value);
2477 break;
2478 }
2479 case USB_XU_CLOCK_RATE:
2480 /*
2481 * E-Mu USB 0404/0202/TrackerPre/0204
2482 * samplerate control quirk
2483 */
2484 cval->min = 0;
2485 cval->max = 5;
2486 cval->res = 1;
2487 cval->initialized = 1;
2488 break;
2489 default:
2490 get_min_max(cval, valinfo->min_value);
2491 break;
2492 }
2493
2494 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2495 if (err < 0) {
2496 usb_mixer_elem_info_free(cval);
2497 return -EINVAL;
2498 }
2499
2500 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2501 if (!kctl) {
2502 usb_mixer_elem_info_free(cval);
2503 return -ENOMEM;
2504 }
2505 kctl->private_free = snd_usb_mixer_elem_free;
2506
2507 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2508 /* nothing */ ;
2509 } else if (info->name) {
2510 strscpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2511 } else {
2512 if (extension_unit)
2513 nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2514 else
2515 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2516 len = 0;
2517 if (nameid)
2518 len = snd_usb_copy_string_desc(state->chip,
2519 nameid,
2520 kctl->id.name,
2521 sizeof(kctl->id.name));
2522 if (!len)
2523 strscpy(kctl->id.name, name, sizeof(kctl->id.name));
2524 }
2525 append_ctl_name(kctl, " ");
2526 append_ctl_name(kctl, valinfo->suffix);
2527
2528 usb_audio_dbg(state->chip,
2529 "[%d] PU [%s] ch = %d, val = %d/%d\n",
2530 cval->head.id, kctl->id.name, cval->channels,
2531 cval->min, cval->max);
2532
2533 err = snd_usb_mixer_add_control(&cval->head, kctl);
2534 if (err < 0)
2535 return err;
2536 }
2537 return 0;
2538 }
2539
2540 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2541 void *raw_desc)
2542 {
2543 switch (state->mixer->protocol) {
2544 case UAC_VERSION_1:
2545 case UAC_VERSION_2:
2546 default:
2547 return build_audio_procunit(state, unitid, raw_desc,
2548 procunits, false);
2549 case UAC_VERSION_3:
2550 return build_audio_procunit(state, unitid, raw_desc,
2551 uac3_procunits, false);
2552 }
2553 }
2554
2555 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2556 void *raw_desc)
2557 {
2558 /*
2559 * Note that we parse extension units with processing unit descriptors.
2560 * That's ok as the layout is the same.
2561 */
2562 return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2563 }
2564
2565 /*
2566 * Selector Unit
2567 */
2568
2569 /*
2570 * info callback for selector unit
2571 * use an enumerator type for routing
2572 */
2573 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2574 struct snd_ctl_elem_info *uinfo)
2575 {
2576 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2577 const char **itemlist = (const char **)kcontrol->private_value;
2578
2579 if (snd_BUG_ON(!itemlist))
2580 return -EINVAL;
2581 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2582 }
2583
2584 /* get callback for selector unit */
2585 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2586 struct snd_ctl_elem_value *ucontrol)
2587 {
2588 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2589 int val, err;
2590
2591 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2592 if (err < 0) {
2593 ucontrol->value.enumerated.item[0] = 0;
2594 return filter_error(cval, err);
2595 }
2596 val = get_relative_value(cval, val);
2597 ucontrol->value.enumerated.item[0] = val;
2598 return 0;
2599 }
2600
2601 /* put callback for selector unit */
2602 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2603 struct snd_ctl_elem_value *ucontrol)
2604 {
2605 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2606 int val, oval, err;
2607
2608 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2609 if (err < 0)
2610 return filter_error(cval, err);
2611 val = ucontrol->value.enumerated.item[0];
2612 val = get_abs_value(cval, val);
2613 if (val != oval) {
2614 set_cur_ctl_value(cval, cval->control << 8, val);
2615 return 1;
2616 }
2617 return 0;
2618 }
2619
2620 /* alsa control interface for selector unit */
2621 static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2622 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2623 .name = "", /* will be filled later */
2624 .info = mixer_ctl_selector_info,
2625 .get = mixer_ctl_selector_get,
2626 .put = mixer_ctl_selector_put,
2627 };
2628
2629 /*
2630 * private free callback.
2631 * free both private_data and private_value
2632 */
2633 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2634 {
2635 int i, num_ins = 0;
2636
2637 if (kctl->private_data) {
2638 struct usb_mixer_elem_info *cval = kctl->private_data;
2639 num_ins = cval->max;
2640 usb_mixer_elem_info_free(cval);
2641 kctl->private_data = NULL;
2642 }
2643 if (kctl->private_value) {
2644 char **itemlist = (char **)kctl->private_value;
2645 for (i = 0; i < num_ins; i++)
2646 kfree(itemlist[i]);
2647 kfree(itemlist);
2648 kctl->private_value = 0;
2649 }
2650 }
2651
2652 /*
2653 * parse a selector unit
2654 */
2655 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2656 void *raw_desc)
2657 {
2658 struct uac_selector_unit_descriptor *desc = raw_desc;
2659 unsigned int i, nameid, len;
2660 int err;
2661 struct usb_mixer_elem_info *cval;
2662 struct snd_kcontrol *kctl;
2663 const struct usbmix_name_map *map;
2664 char **namelist;
2665
2666 for (i = 0; i < desc->bNrInPins; i++) {
2667 err = parse_audio_unit(state, desc->baSourceID[i]);
2668 if (err < 0)
2669 return err;
2670 }
2671
2672 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2673 return 0;
2674
2675 map = find_map(state->map, unitid, 0);
2676 if (check_ignored_ctl(map))
2677 return 0;
2678
2679 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2680 if (!cval)
2681 return -ENOMEM;
2682 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2683 cval->val_type = USB_MIXER_U8;
2684 cval->channels = 1;
2685 cval->min = 1;
2686 cval->max = desc->bNrInPins;
2687 cval->res = 1;
2688 cval->initialized = 1;
2689
2690 switch (state->mixer->protocol) {
2691 case UAC_VERSION_1:
2692 default:
2693 cval->control = 0;
2694 break;
2695 case UAC_VERSION_2:
2696 case UAC_VERSION_3:
2697 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2698 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2699 cval->control = UAC2_CX_CLOCK_SELECTOR;
2700 else /* UAC2/3_SELECTOR_UNIT */
2701 cval->control = UAC2_SU_SELECTOR;
2702 break;
2703 }
2704
2705 namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2706 if (!namelist) {
2707 err = -ENOMEM;
2708 goto error_cval;
2709 }
2710 #define MAX_ITEM_NAME_LEN 64
2711 for (i = 0; i < desc->bNrInPins; i++) {
2712 struct usb_audio_term iterm;
2713 len = 0;
2714 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2715 if (!namelist[i]) {
2716 err = -ENOMEM;
2717 goto error_name;
2718 }
2719 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2720 MAX_ITEM_NAME_LEN);
2721 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2722 len = get_term_name(state->chip, &iterm, namelist[i],
2723 MAX_ITEM_NAME_LEN, 0);
2724 if (! len)
2725 sprintf(namelist[i], "Input %u", i);
2726 }
2727
2728 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2729 if (! kctl) {
2730 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2731 err = -ENOMEM;
2732 goto error_name;
2733 }
2734 kctl->private_value = (unsigned long)namelist;
2735 kctl->private_free = usb_mixer_selector_elem_free;
2736
2737 /* check the static mapping table at first */
2738 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2739 if (!len) {
2740 /* no mapping ? */
2741 switch (state->mixer->protocol) {
2742 case UAC_VERSION_1:
2743 case UAC_VERSION_2:
2744 default:
2745 /* if iSelector is given, use it */
2746 nameid = uac_selector_unit_iSelector(desc);
2747 if (nameid)
2748 len = snd_usb_copy_string_desc(state->chip,
2749 nameid, kctl->id.name,
2750 sizeof(kctl->id.name));
2751 break;
2752 case UAC_VERSION_3:
2753 /* TODO: Class-Specific strings not yet supported */
2754 break;
2755 }
2756
2757 /* ... or pick up the terminal name at next */
2758 if (!len)
2759 len = get_term_name(state->chip, &state->oterm,
2760 kctl->id.name, sizeof(kctl->id.name), 0);
2761 /* ... or use the fixed string "USB" as the last resort */
2762 if (!len)
2763 strscpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2764
2765 /* and add the proper suffix */
2766 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2767 desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2768 append_ctl_name(kctl, " Clock Source");
2769 else if ((state->oterm.type & 0xff00) == 0x0100)
2770 append_ctl_name(kctl, " Capture Source");
2771 else
2772 append_ctl_name(kctl, " Playback Source");
2773 }
2774
2775 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2776 cval->head.id, kctl->id.name, desc->bNrInPins);
2777 return snd_usb_mixer_add_control(&cval->head, kctl);
2778
2779 error_name:
2780 for (i = 0; i < desc->bNrInPins; i++)
2781 kfree(namelist[i]);
2782 kfree(namelist);
2783 error_cval:
2784 usb_mixer_elem_info_free(cval);
2785 return err;
2786 }
2787
2788 /*
2789 * parse an audio unit recursively
2790 */
2791
2792 static int parse_audio_unit(struct mixer_build *state, int unitid)
2793 {
2794 unsigned char *p1;
2795 int protocol = state->mixer->protocol;
2796
2797 if (test_and_set_bit(unitid, state->unitbitmap))
2798 return 0; /* the unit already visited */
2799
2800 p1 = find_audio_control_unit(state, unitid);
2801 if (!p1) {
2802 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2803 return -EINVAL;
2804 }
2805
2806 if (!snd_usb_validate_audio_desc(p1, protocol)) {
2807 usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2808 return 0; /* skip invalid unit */
2809 }
2810
2811 switch (PTYPE(protocol, p1[2])) {
2812 case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2813 case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2814 case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2815 return parse_audio_input_terminal(state, unitid, p1);
2816 case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2817 case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2818 case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2819 return parse_audio_mixer_unit(state, unitid, p1);
2820 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2821 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2822 return parse_clock_source_unit(state, unitid, p1);
2823 case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2824 case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2825 case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2826 case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2827 case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2828 return parse_audio_selector_unit(state, unitid, p1);
2829 case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2830 case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2831 case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2832 return parse_audio_feature_unit(state, unitid, p1);
2833 case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2834 case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2835 case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2836 return parse_audio_processing_unit(state, unitid, p1);
2837 case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2838 case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2839 case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2840 return parse_audio_extension_unit(state, unitid, p1);
2841 case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2842 case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2843 return 0; /* FIXME - effect units not implemented yet */
2844 default:
2845 usb_audio_err(state->chip,
2846 "unit %u: unexpected type 0x%02x\n",
2847 unitid, p1[2]);
2848 return -EINVAL;
2849 }
2850 }
2851
2852 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2853 {
2854 /* kill pending URBs */
2855 snd_usb_mixer_disconnect(mixer);
2856
2857 kfree(mixer->id_elems);
2858 if (mixer->urb) {
2859 kfree(mixer->urb->transfer_buffer);
2860 usb_free_urb(mixer->urb);
2861 }
2862 usb_free_urb(mixer->rc_urb);
2863 kfree(mixer->rc_setup_packet);
2864 kfree(mixer);
2865 }
2866
2867 static int snd_usb_mixer_dev_free(struct snd_device *device)
2868 {
2869 struct usb_mixer_interface *mixer = device->device_data;
2870 snd_usb_mixer_free(mixer);
2871 return 0;
2872 }
2873
2874 /* UAC3 predefined channels configuration */
2875 struct uac3_badd_profile {
2876 int subclass;
2877 const char *name;
2878 int c_chmask; /* capture channels mask */
2879 int p_chmask; /* playback channels mask */
2880 int st_chmask; /* side tone mixing channel mask */
2881 };
2882
2883 static const struct uac3_badd_profile uac3_badd_profiles[] = {
2884 {
2885 /*
2886 * BAIF, BAOF or combination of both
2887 * IN: Mono or Stereo cfg, Mono alt possible
2888 * OUT: Mono or Stereo cfg, Mono alt possible
2889 */
2890 .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2891 .name = "GENERIC IO",
2892 .c_chmask = -1, /* dynamic channels */
2893 .p_chmask = -1, /* dynamic channels */
2894 },
2895 {
2896 /* BAOF; Stereo only cfg, Mono alt possible */
2897 .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2898 .name = "HEADPHONE",
2899 .p_chmask = 3,
2900 },
2901 {
2902 /* BAOF; Mono or Stereo cfg, Mono alt possible */
2903 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2904 .name = "SPEAKER",
2905 .p_chmask = -1, /* dynamic channels */
2906 },
2907 {
2908 /* BAIF; Mono or Stereo cfg, Mono alt possible */
2909 .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2910 .name = "MICROPHONE",
2911 .c_chmask = -1, /* dynamic channels */
2912 },
2913 {
2914 /*
2915 * BAIOF topology
2916 * IN: Mono only
2917 * OUT: Mono or Stereo cfg, Mono alt possible
2918 */
2919 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2920 .name = "HEADSET",
2921 .c_chmask = 1,
2922 .p_chmask = -1, /* dynamic channels */
2923 .st_chmask = 1,
2924 },
2925 {
2926 /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2927 .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2928 .name = "HEADSET ADAPTER",
2929 .c_chmask = 1,
2930 .p_chmask = 3,
2931 .st_chmask = 1,
2932 },
2933 {
2934 /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2935 .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2936 .name = "SPEAKERPHONE",
2937 .c_chmask = 1,
2938 .p_chmask = 1,
2939 },
2940 { 0 } /* terminator */
2941 };
2942
2943 static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2944 const struct uac3_badd_profile *f,
2945 int c_chmask, int p_chmask)
2946 {
2947 /*
2948 * If both playback/capture channels are dynamic, make sure
2949 * at least one channel is present
2950 */
2951 if (f->c_chmask < 0 && f->p_chmask < 0) {
2952 if (!c_chmask && !p_chmask) {
2953 usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2954 f->name);
2955 return false;
2956 }
2957 return true;
2958 }
2959
2960 if ((f->c_chmask < 0 && !c_chmask) ||
2961 (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2962 usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2963 f->name);
2964 return false;
2965 }
2966 if ((f->p_chmask < 0 && !p_chmask) ||
2967 (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2968 usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2969 f->name);
2970 return false;
2971 }
2972 return true;
2973 }
2974
2975 /*
2976 * create mixer controls for UAC3 BADD profiles
2977 *
2978 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2979 *
2980 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2981 */
2982 static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2983 int ctrlif)
2984 {
2985 struct usb_device *dev = mixer->chip->dev;
2986 struct usb_interface_assoc_descriptor *assoc;
2987 int badd_profile = mixer->chip->badd_profile;
2988 const struct uac3_badd_profile *f;
2989 const struct usbmix_ctl_map *map;
2990 int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2991 int i;
2992
2993 assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2994
2995 /* Detect BADD capture/playback channels from AS EP descriptors */
2996 for (i = 0; i < assoc->bInterfaceCount; i++) {
2997 int intf = assoc->bFirstInterface + i;
2998
2999 struct usb_interface *iface;
3000 struct usb_host_interface *alts;
3001 struct usb_interface_descriptor *altsd;
3002 unsigned int maxpacksize;
3003 char dir_in;
3004 int chmask, num;
3005
3006 if (intf == ctrlif)
3007 continue;
3008
3009 iface = usb_ifnum_to_if(dev, intf);
3010 if (!iface)
3011 continue;
3012
3013 num = iface->num_altsetting;
3014
3015 if (num < 2)
3016 return -EINVAL;
3017
3018 /*
3019 * The number of Channels in an AudioStreaming interface
3020 * and the audio sample bit resolution (16 bits or 24
3021 * bits) can be derived from the wMaxPacketSize field in
3022 * the Standard AS Audio Data Endpoint descriptor in
3023 * Alternate Setting 1
3024 */
3025 alts = &iface->altsetting[1];
3026 altsd = get_iface_desc(alts);
3027
3028 if (altsd->bNumEndpoints < 1)
3029 return -EINVAL;
3030
3031 /* check direction */
3032 dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3033 maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3034
3035 switch (maxpacksize) {
3036 default:
3037 usb_audio_err(mixer->chip,
3038 "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3039 maxpacksize);
3040 return -EINVAL;
3041 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3042 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3043 case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3044 case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3045 chmask = 1;
3046 break;
3047 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3048 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3049 case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3050 case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3051 chmask = 3;
3052 break;
3053 }
3054
3055 if (dir_in)
3056 c_chmask = chmask;
3057 else
3058 p_chmask = chmask;
3059 }
3060
3061 usb_audio_dbg(mixer->chip,
3062 "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3063 badd_profile, c_chmask, p_chmask);
3064
3065 /* check the mapping table */
3066 for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3067 if (map->id == badd_profile)
3068 break;
3069 }
3070
3071 if (!map->id)
3072 return -EINVAL;
3073
3074 for (f = uac3_badd_profiles; f->name; f++) {
3075 if (badd_profile == f->subclass)
3076 break;
3077 }
3078 if (!f->name)
3079 return -EINVAL;
3080 if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3081 return -EINVAL;
3082 st_chmask = f->st_chmask;
3083
3084 /* Playback */
3085 if (p_chmask) {
3086 /* Master channel, always writable */
3087 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3088 UAC3_BADD_FU_ID2, map->map);
3089 /* Mono/Stereo volume channels, always writable */
3090 build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3091 UAC3_BADD_FU_ID2, map->map);
3092 }
3093
3094 /* Capture */
3095 if (c_chmask) {
3096 /* Master channel, always writable */
3097 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3098 UAC3_BADD_FU_ID5, map->map);
3099 /* Mono/Stereo volume channels, always writable */
3100 build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3101 UAC3_BADD_FU_ID5, map->map);
3102 }
3103
3104 /* Side tone-mixing */
3105 if (st_chmask) {
3106 /* Master channel, always writable */
3107 build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3108 UAC3_BADD_FU_ID7, map->map);
3109 /* Mono volume channel, always writable */
3110 build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3111 UAC3_BADD_FU_ID7, map->map);
3112 }
3113
3114 /* Insertion Control */
3115 if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3116 struct usb_audio_term iterm, oterm;
3117
3118 /* Input Term - Insertion control */
3119 memset(&iterm, 0, sizeof(iterm));
3120 iterm.id = UAC3_BADD_IT_ID4;
3121 iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3122 build_connector_control(mixer, map->map, &iterm, true);
3123
3124 /* Output Term - Insertion control */
3125 memset(&oterm, 0, sizeof(oterm));
3126 oterm.id = UAC3_BADD_OT_ID3;
3127 oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3128 build_connector_control(mixer, map->map, &oterm, false);
3129 }
3130
3131 return 0;
3132 }
3133
3134 /*
3135 * create mixer controls
3136 *
3137 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3138 */
3139 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3140 {
3141 struct mixer_build state;
3142 int err;
3143 const struct usbmix_ctl_map *map;
3144 void *p;
3145
3146 memset(&state, 0, sizeof(state));
3147 state.chip = mixer->chip;
3148 state.mixer = mixer;
3149 state.buffer = mixer->hostif->extra;
3150 state.buflen = mixer->hostif->extralen;
3151
3152 /* check the mapping table */
3153 for (map = usbmix_ctl_maps; map->id; map++) {
3154 if (map->id == state.chip->usb_id) {
3155 state.map = map->map;
3156 state.selector_map = map->selector_map;
3157 mixer->connector_map = map->connector_map;
3158 mixer->ignore_ctl_error |= map->ignore_ctl_error;
3159 break;
3160 }
3161 }
3162
3163 p = NULL;
3164 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3165 mixer->hostif->extralen,
3166 p, UAC_OUTPUT_TERMINAL)) != NULL) {
3167 if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3168 continue; /* skip invalid descriptor */
3169
3170 if (mixer->protocol == UAC_VERSION_1) {
3171 struct uac1_output_terminal_descriptor *desc = p;
3172
3173 /* mark terminal ID as visited */
3174 set_bit(desc->bTerminalID, state.unitbitmap);
3175 state.oterm.id = desc->bTerminalID;
3176 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3177 state.oterm.name = desc->iTerminal;
3178 err = parse_audio_unit(&state, desc->bSourceID);
3179 if (err < 0 && err != -EINVAL)
3180 return err;
3181 } else if (mixer->protocol == UAC_VERSION_2) {
3182 struct uac2_output_terminal_descriptor *desc = p;
3183
3184 /* mark terminal ID as visited */
3185 set_bit(desc->bTerminalID, state.unitbitmap);
3186 state.oterm.id = desc->bTerminalID;
3187 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3188 state.oterm.name = desc->iTerminal;
3189 err = parse_audio_unit(&state, desc->bSourceID);
3190 if (err < 0 && err != -EINVAL)
3191 return err;
3192
3193 /*
3194 * For UAC2, use the same approach to also add the
3195 * clock selectors
3196 */
3197 err = parse_audio_unit(&state, desc->bCSourceID);
3198 if (err < 0 && err != -EINVAL)
3199 return err;
3200
3201 if ((state.oterm.type & 0xff00) != 0x0100 &&
3202 uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3203 UAC2_TE_CONNECTOR)) {
3204 build_connector_control(state.mixer, state.map,
3205 &state.oterm, false);
3206 }
3207 } else { /* UAC_VERSION_3 */
3208 struct uac3_output_terminal_descriptor *desc = p;
3209
3210 /* mark terminal ID as visited */
3211 set_bit(desc->bTerminalID, state.unitbitmap);
3212 state.oterm.id = desc->bTerminalID;
3213 state.oterm.type = le16_to_cpu(desc->wTerminalType);
3214 state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3215 err = parse_audio_unit(&state, desc->bSourceID);
3216 if (err < 0 && err != -EINVAL)
3217 return err;
3218
3219 /*
3220 * For UAC3, use the same approach to also add the
3221 * clock selectors
3222 */
3223 err = parse_audio_unit(&state, desc->bCSourceID);
3224 if (err < 0 && err != -EINVAL)
3225 return err;
3226
3227 if ((state.oterm.type & 0xff00) != 0x0100 &&
3228 uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3229 UAC3_TE_INSERTION)) {
3230 build_connector_control(state.mixer, state.map,
3231 &state.oterm, false);
3232 }
3233 }
3234 }
3235
3236 return 0;
3237 }
3238
3239 static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3240 u8 *control, u8 *channel)
3241 {
3242 const struct usbmix_connector_map *map = mixer->connector_map;
3243
3244 if (!map)
3245 return unitid;
3246
3247 for (; map->id; map++) {
3248 if (map->id == unitid) {
3249 if (control && map->control)
3250 *control = map->control;
3251 if (channel && map->channel)
3252 *channel = map->channel;
3253 return map->delegated_id;
3254 }
3255 }
3256 return unitid;
3257 }
3258
3259 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3260 {
3261 struct usb_mixer_elem_list *list;
3262
3263 unitid = delegate_notify(mixer, unitid, NULL, NULL);
3264
3265 for_each_mixer_elem(list, mixer, unitid) {
3266 struct usb_mixer_elem_info *info;
3267
3268 if (!list->is_std_info)
3269 continue;
3270 info = mixer_elem_list_to_info(list);
3271 /* invalidate cache, so the value is read from the device */
3272 info->cached = 0;
3273 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3274 &list->kctl->id);
3275 }
3276 }
3277
3278 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3279 struct usb_mixer_elem_list *list)
3280 {
3281 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3282 static const char * const val_types[] = {"BOOLEAN", "INV_BOOLEAN",
3283 "S8", "U8", "S16", "U16"};
3284 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
3285 "channels=%i, type=\"%s\"\n", cval->head.id,
3286 cval->control, cval->cmask, cval->channels,
3287 val_types[cval->val_type]);
3288 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3289 cval->min, cval->max, cval->dBmin, cval->dBmax);
3290 }
3291
3292 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3293 struct snd_info_buffer *buffer)
3294 {
3295 struct snd_usb_audio *chip = entry->private_data;
3296 struct usb_mixer_interface *mixer;
3297 struct usb_mixer_elem_list *list;
3298 int unitid;
3299
3300 list_for_each_entry(mixer, &chip->mixer_list, list) {
3301 snd_iprintf(buffer,
3302 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3303 chip->usb_id, mixer_ctrl_intf(mixer),
3304 mixer->ignore_ctl_error);
3305 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3306 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3307 for_each_mixer_elem(list, mixer, unitid) {
3308 snd_iprintf(buffer, " Unit: %i\n", list->id);
3309 if (list->kctl)
3310 snd_iprintf(buffer,
3311 " Control: name=\"%s\", index=%i\n",
3312 list->kctl->id.name,
3313 list->kctl->id.index);
3314 if (list->dump)
3315 list->dump(buffer, list);
3316 }
3317 }
3318 }
3319 }
3320
3321 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3322 int attribute, int value, int index)
3323 {
3324 struct usb_mixer_elem_list *list;
3325 __u8 unitid = (index >> 8) & 0xff;
3326 __u8 control = (value >> 8) & 0xff;
3327 __u8 channel = value & 0xff;
3328 unsigned int count = 0;
3329
3330 if (channel >= MAX_CHANNELS) {
3331 usb_audio_dbg(mixer->chip,
3332 "%s(): bogus channel number %d\n",
3333 __func__, channel);
3334 return;
3335 }
3336
3337 unitid = delegate_notify(mixer, unitid, &control, &channel);
3338
3339 for_each_mixer_elem(list, mixer, unitid)
3340 count++;
3341
3342 if (count == 0)
3343 return;
3344
3345 for_each_mixer_elem(list, mixer, unitid) {
3346 struct usb_mixer_elem_info *info;
3347
3348 if (!list->kctl)
3349 continue;
3350 if (!list->is_std_info)
3351 continue;
3352
3353 info = mixer_elem_list_to_info(list);
3354 if (count > 1 && info->control != control)
3355 continue;
3356
3357 switch (attribute) {
3358 case UAC2_CS_CUR:
3359 /* invalidate cache, so the value is read from the device */
3360 if (channel)
3361 info->cached &= ~(1 << channel);
3362 else /* master channel */
3363 info->cached = 0;
3364
3365 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3366 &info->head.kctl->id);
3367 break;
3368
3369 case UAC2_CS_RANGE:
3370 /* TODO */
3371 break;
3372
3373 case UAC2_CS_MEM:
3374 /* TODO */
3375 break;
3376
3377 default:
3378 usb_audio_dbg(mixer->chip,
3379 "unknown attribute %d in interrupt\n",
3380 attribute);
3381 break;
3382 } /* switch */
3383 }
3384 }
3385
3386 static void snd_usb_mixer_interrupt(struct urb *urb)
3387 {
3388 struct usb_mixer_interface *mixer = urb->context;
3389 int len = urb->actual_length;
3390 int ustatus = urb->status;
3391
3392 if (ustatus != 0)
3393 goto requeue;
3394
3395 if (mixer->protocol == UAC_VERSION_1) {
3396 struct uac1_status_word *status;
3397
3398 for (status = urb->transfer_buffer;
3399 len >= sizeof(*status);
3400 len -= sizeof(*status), status++) {
3401 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3402 status->bStatusType,
3403 status->bOriginator);
3404
3405 /* ignore any notifications not from the control interface */
3406 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3407 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3408 continue;
3409
3410 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3411 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3412 else
3413 snd_usb_mixer_notify_id(mixer, status->bOriginator);
3414 }
3415 } else { /* UAC_VERSION_2 */
3416 struct uac2_interrupt_data_msg *msg;
3417
3418 for (msg = urb->transfer_buffer;
3419 len >= sizeof(*msg);
3420 len -= sizeof(*msg), msg++) {
3421 /* drop vendor specific and endpoint requests */
3422 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3423 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3424 continue;
3425
3426 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3427 le16_to_cpu(msg->wValue),
3428 le16_to_cpu(msg->wIndex));
3429 }
3430 }
3431
3432 requeue:
3433 if (ustatus != -ENOENT &&
3434 ustatus != -ECONNRESET &&
3435 ustatus != -ESHUTDOWN) {
3436 urb->dev = mixer->chip->dev;
3437 usb_submit_urb(urb, GFP_ATOMIC);
3438 }
3439 }
3440
3441 /* create the handler for the optional status interrupt endpoint */
3442 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3443 {
3444 struct usb_endpoint_descriptor *ep;
3445 void *transfer_buffer;
3446 int buffer_length;
3447 unsigned int epnum;
3448
3449 /* we need one interrupt input endpoint */
3450 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3451 return 0;
3452 ep = get_endpoint(mixer->hostif, 0);
3453 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3454 return 0;
3455
3456 epnum = usb_endpoint_num(ep);
3457 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3458 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3459 if (!transfer_buffer)
3460 return -ENOMEM;
3461 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3462 if (!mixer->urb) {
3463 kfree(transfer_buffer);
3464 return -ENOMEM;
3465 }
3466 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3467 usb_rcvintpipe(mixer->chip->dev, epnum),
3468 transfer_buffer, buffer_length,
3469 snd_usb_mixer_interrupt, mixer, ep->bInterval);
3470 usb_submit_urb(mixer->urb, GFP_KERNEL);
3471 return 0;
3472 }
3473
3474 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3475 int ignore_error)
3476 {
3477 static const struct snd_device_ops dev_ops = {
3478 .dev_free = snd_usb_mixer_dev_free
3479 };
3480 struct usb_mixer_interface *mixer;
3481 int err;
3482
3483 strcpy(chip->card->mixername, "USB Mixer");
3484
3485 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3486 if (!mixer)
3487 return -ENOMEM;
3488 mixer->chip = chip;
3489 mixer->ignore_ctl_error = ignore_error;
3490 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3491 GFP_KERNEL);
3492 if (!mixer->id_elems) {
3493 kfree(mixer);
3494 return -ENOMEM;
3495 }
3496
3497 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3498 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3499 case UAC_VERSION_1:
3500 default:
3501 mixer->protocol = UAC_VERSION_1;
3502 break;
3503 case UAC_VERSION_2:
3504 mixer->protocol = UAC_VERSION_2;
3505 break;
3506 case UAC_VERSION_3:
3507 mixer->protocol = UAC_VERSION_3;
3508 break;
3509 }
3510
3511 if (mixer->protocol == UAC_VERSION_3 &&
3512 chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3513 err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3514 if (err < 0)
3515 goto _error;
3516 } else {
3517 err = snd_usb_mixer_controls(mixer);
3518 if (err < 0)
3519 goto _error;
3520 }
3521
3522 err = snd_usb_mixer_status_create(mixer);
3523 if (err < 0)
3524 goto _error;
3525
3526 err = snd_usb_mixer_apply_create_quirk(mixer);
3527 if (err < 0)
3528 goto _error;
3529
3530 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3531 if (err < 0)
3532 goto _error;
3533
3534 if (list_empty(&chip->mixer_list))
3535 snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3536 snd_usb_mixer_proc_read);
3537
3538 list_add(&mixer->list, &chip->mixer_list);
3539 return 0;
3540
3541 _error:
3542 snd_usb_mixer_free(mixer);
3543 return err;
3544 }
3545
3546 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3547 {
3548 if (mixer->disconnected)
3549 return;
3550 if (mixer->urb)
3551 usb_kill_urb(mixer->urb);
3552 if (mixer->rc_urb)
3553 usb_kill_urb(mixer->rc_urb);
3554 if (mixer->private_free)
3555 mixer->private_free(mixer);
3556 mixer->disconnected = true;
3557 }
3558
3559 #ifdef CONFIG_PM
3560 /* stop any bus activity of a mixer */
3561 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3562 {
3563 usb_kill_urb(mixer->urb);
3564 usb_kill_urb(mixer->rc_urb);
3565 }
3566
3567 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3568 {
3569 int err;
3570
3571 if (mixer->urb) {
3572 err = usb_submit_urb(mixer->urb, GFP_NOIO);
3573 if (err < 0)
3574 return err;
3575 }
3576
3577 return 0;
3578 }
3579
3580 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3581 {
3582 snd_usb_mixer_inactivate(mixer);
3583 if (mixer->private_suspend)
3584 mixer->private_suspend(mixer);
3585 return 0;
3586 }
3587
3588 static int restore_mixer_value(struct usb_mixer_elem_list *list)
3589 {
3590 struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3591 int c, err, idx;
3592
3593 if (cval->cmask) {
3594 idx = 0;
3595 for (c = 0; c < MAX_CHANNELS; c++) {
3596 if (!(cval->cmask & (1 << c)))
3597 continue;
3598 if (cval->cached & (1 << (c + 1))) {
3599 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3600 cval->cache_val[idx]);
3601 if (err < 0)
3602 return err;
3603 }
3604 idx++;
3605 }
3606 } else {
3607 /* master */
3608 if (cval->cached) {
3609 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3610 if (err < 0)
3611 return err;
3612 }
3613 }
3614
3615 return 0;
3616 }
3617
3618 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3619 {
3620 struct usb_mixer_elem_list *list;
3621 int id, err;
3622
3623 if (reset_resume) {
3624 /* restore cached mixer values */
3625 for (id = 0; id < MAX_ID_ELEMS; id++) {
3626 for_each_mixer_elem(list, mixer, id) {
3627 if (list->resume) {
3628 err = list->resume(list);
3629 if (err < 0)
3630 return err;
3631 }
3632 }
3633 }
3634 }
3635
3636 snd_usb_mixer_resume_quirk(mixer);
3637
3638 return snd_usb_mixer_activate(mixer);
3639 }
3640 #endif
3641
3642 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3643 struct usb_mixer_interface *mixer,
3644 int unitid)
3645 {
3646 list->mixer = mixer;
3647 list->id = unitid;
3648 list->dump = snd_usb_mixer_dump_cval;
3649 #ifdef CONFIG_PM
3650 list->resume = restore_mixer_value;
3651 #endif
3652 }
Ubuntu Jammy Linux kernel mirror