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