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