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