]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - sound/usb/mixer.c
Merge tag 'v4.8' into next
[mirror_ubuntu-artful-kernel.git] / sound / usb / mixer.c
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
55 #include <sound/core.h>
56 #include <sound/control.h>
57 #include <sound/hwdep.h>
58 #include <sound/info.h>
59 #include <sound/tlv.h>
60
61 #include "usbaudio.h"
62 #include "mixer.h"
63 #include "helper.h"
64 #include "mixer_quirks.h"
65 #include "power.h"
66
67 #define MAX_ID_ELEMS 256
68
69 struct usb_audio_term {
70 int id;
71 int type;
72 int channels;
73 unsigned int chconfig;
74 int name;
75 };
76
77 struct usbmix_name_map;
78
79 struct mixer_build {
80 struct snd_usb_audio *chip;
81 struct usb_mixer_interface *mixer;
82 unsigned char *buffer;
83 unsigned int buflen;
84 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
85 struct usb_audio_term oterm;
86 const struct usbmix_name_map *map;
87 const struct usbmix_selector_map *selector_map;
88 };
89
90 /*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
91 enum {
92 USB_XU_CLOCK_RATE = 0xe301,
93 USB_XU_CLOCK_SOURCE = 0xe302,
94 USB_XU_DIGITAL_IO_STATUS = 0xe303,
95 USB_XU_DEVICE_OPTIONS = 0xe304,
96 USB_XU_DIRECT_MONITORING = 0xe305,
97 USB_XU_METERING = 0xe306
98 };
99 enum {
100 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
101 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
102 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
103 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
104 };
105
106 /*
107 * manual mapping of mixer names
108 * if the mixer topology is too complicated and the parsed names are
109 * ambiguous, add the entries in usbmixer_maps.c.
110 */
111 #include "mixer_maps.c"
112
113 static const struct usbmix_name_map *
114 find_map(struct mixer_build *state, int unitid, int control)
115 {
116 const struct usbmix_name_map *p = state->map;
117
118 if (!p)
119 return NULL;
120
121 for (p = state->map; p->id; p++) {
122 if (p->id == unitid &&
123 (!control || !p->control || control == p->control))
124 return p;
125 }
126 return NULL;
127 }
128
129 /* get the mapped name if the unit matches */
130 static int
131 check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
132 {
133 if (!p || !p->name)
134 return 0;
135
136 buflen--;
137 return strlcpy(buf, p->name, buflen);
138 }
139
140 /* ignore the error value if ignore_ctl_error flag is set */
141 #define filter_error(cval, err) \
142 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
143
144 /* check whether the control should be ignored */
145 static inline int
146 check_ignored_ctl(const struct usbmix_name_map *p)
147 {
148 if (!p || p->name || p->dB)
149 return 0;
150 return 1;
151 }
152
153 /* dB mapping */
154 static inline void check_mapped_dB(const struct usbmix_name_map *p,
155 struct usb_mixer_elem_info *cval)
156 {
157 if (p && p->dB) {
158 cval->dBmin = p->dB->min;
159 cval->dBmax = p->dB->max;
160 cval->initialized = 1;
161 }
162 }
163
164 /* get the mapped selector source name */
165 static int check_mapped_selector_name(struct mixer_build *state, int unitid,
166 int index, char *buf, int buflen)
167 {
168 const struct usbmix_selector_map *p;
169
170 if (!state->selector_map)
171 return 0;
172 for (p = state->selector_map; p->id; p++) {
173 if (p->id == unitid && index < p->count)
174 return strlcpy(buf, p->names[index], buflen);
175 }
176 return 0;
177 }
178
179 /*
180 * find an audio control unit with the given unit id
181 */
182 static void *find_audio_control_unit(struct mixer_build *state,
183 unsigned char unit)
184 {
185 /* we just parse the header */
186 struct uac_feature_unit_descriptor *hdr = NULL;
187
188 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
189 USB_DT_CS_INTERFACE)) != NULL) {
190 if (hdr->bLength >= 4 &&
191 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
192 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
193 hdr->bUnitID == unit)
194 return hdr;
195 }
196
197 return NULL;
198 }
199
200 /*
201 * copy a string with the given id
202 */
203 static int snd_usb_copy_string_desc(struct mixer_build *state,
204 int index, char *buf, int maxlen)
205 {
206 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
207 buf[len] = 0;
208 return len;
209 }
210
211 /*
212 * convert from the byte/word on usb descriptor to the zero-based integer
213 */
214 static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
215 {
216 switch (cval->val_type) {
217 case USB_MIXER_BOOLEAN:
218 return !!val;
219 case USB_MIXER_INV_BOOLEAN:
220 return !val;
221 case USB_MIXER_U8:
222 val &= 0xff;
223 break;
224 case USB_MIXER_S8:
225 val &= 0xff;
226 if (val >= 0x80)
227 val -= 0x100;
228 break;
229 case USB_MIXER_U16:
230 val &= 0xffff;
231 break;
232 case USB_MIXER_S16:
233 val &= 0xffff;
234 if (val >= 0x8000)
235 val -= 0x10000;
236 break;
237 }
238 return val;
239 }
240
241 /*
242 * convert from the zero-based int to the byte/word for usb descriptor
243 */
244 static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
245 {
246 switch (cval->val_type) {
247 case USB_MIXER_BOOLEAN:
248 return !!val;
249 case USB_MIXER_INV_BOOLEAN:
250 return !val;
251 case USB_MIXER_S8:
252 case USB_MIXER_U8:
253 return val & 0xff;
254 case USB_MIXER_S16:
255 case USB_MIXER_U16:
256 return val & 0xffff;
257 }
258 return 0; /* not reached */
259 }
260
261 static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
262 {
263 if (!cval->res)
264 cval->res = 1;
265 if (val < cval->min)
266 return 0;
267 else if (val >= cval->max)
268 return (cval->max - cval->min + cval->res - 1) / cval->res;
269 else
270 return (val - cval->min) / cval->res;
271 }
272
273 static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
274 {
275 if (val < 0)
276 return cval->min;
277 if (!cval->res)
278 cval->res = 1;
279 val *= cval->res;
280 val += cval->min;
281 if (val > cval->max)
282 return cval->max;
283 return val;
284 }
285
286 static int uac2_ctl_value_size(int val_type)
287 {
288 switch (val_type) {
289 case USB_MIXER_S32:
290 case USB_MIXER_U32:
291 return 4;
292 case USB_MIXER_S16:
293 case USB_MIXER_U16:
294 return 2;
295 default:
296 return 1;
297 }
298 return 0; /* unreachable */
299 }
300
301
302 /*
303 * retrieve a mixer value
304 */
305
306 static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
307 int validx, int *value_ret)
308 {
309 struct snd_usb_audio *chip = cval->head.mixer->chip;
310 unsigned char buf[2];
311 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
312 int timeout = 10;
313 int idx = 0, err;
314
315 err = snd_usb_lock_shutdown(chip);
316 if (err < 0)
317 return -EIO;
318
319 while (timeout-- > 0) {
320 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
321 if (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) >= val_len) {
324 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
325 err = 0;
326 goto out;
327 }
328 }
329 usb_audio_dbg(chip,
330 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
331 request, validx, idx, cval->val_type);
332 err = -EINVAL;
333
334 out:
335 snd_usb_unlock_shutdown(chip);
336 return err;
337 }
338
339 static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
340 int validx, int *value_ret)
341 {
342 struct snd_usb_audio *chip = cval->head.mixer->chip;
343 unsigned char buf[4 + 3 * sizeof(__u32)]; /* enough space for one range */
344 unsigned char *val;
345 int idx = 0, ret, size;
346 __u8 bRequest;
347
348 if (request == UAC_GET_CUR) {
349 bRequest = UAC2_CS_CUR;
350 size = uac2_ctl_value_size(cval->val_type);
351 } else {
352 bRequest = UAC2_CS_RANGE;
353 size = sizeof(buf);
354 }
355
356 memset(buf, 0, sizeof(buf));
357
358 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
359 if (ret)
360 goto error;
361
362 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
363 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
364 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
365 validx, idx, buf, size);
366 snd_usb_unlock_shutdown(chip);
367
368 if (ret < 0) {
369 error:
370 usb_audio_err(chip,
371 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
372 request, validx, idx, cval->val_type);
373 return ret;
374 }
375
376 /* FIXME: how should we handle multiple triplets here? */
377
378 switch (request) {
379 case UAC_GET_CUR:
380 val = buf;
381 break;
382 case UAC_GET_MIN:
383 val = buf + sizeof(__u16);
384 break;
385 case UAC_GET_MAX:
386 val = buf + sizeof(__u16) * 2;
387 break;
388 case UAC_GET_RES:
389 val = buf + sizeof(__u16) * 3;
390 break;
391 default:
392 return -EINVAL;
393 }
394
395 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
396
397 return 0;
398 }
399
400 static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
401 int validx, int *value_ret)
402 {
403 validx += cval->idx_off;
404
405 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
406 get_ctl_value_v1(cval, request, validx, value_ret) :
407 get_ctl_value_v2(cval, request, validx, value_ret);
408 }
409
410 static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
411 int validx, int *value)
412 {
413 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
414 }
415
416 /* channel = 0: master, 1 = first channel */
417 static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
418 int channel, int *value)
419 {
420 return get_ctl_value(cval, UAC_GET_CUR,
421 (cval->control << 8) | channel,
422 value);
423 }
424
425 int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
426 int channel, int index, int *value)
427 {
428 int err;
429
430 if (cval->cached & (1 << channel)) {
431 *value = cval->cache_val[index];
432 return 0;
433 }
434 err = get_cur_mix_raw(cval, channel, value);
435 if (err < 0) {
436 if (!cval->head.mixer->ignore_ctl_error)
437 usb_audio_dbg(cval->head.mixer->chip,
438 "cannot get current value for control %d ch %d: err = %d\n",
439 cval->control, channel, err);
440 return err;
441 }
442 cval->cached |= 1 << channel;
443 cval->cache_val[index] = *value;
444 return 0;
445 }
446
447 /*
448 * set a mixer value
449 */
450
451 int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
452 int request, int validx, int value_set)
453 {
454 struct snd_usb_audio *chip = cval->head.mixer->chip;
455 unsigned char buf[4];
456 int idx = 0, val_len, err, timeout = 10;
457
458 validx += cval->idx_off;
459
460 if (cval->head.mixer->protocol == UAC_VERSION_1) {
461 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
462 } else { /* UAC_VERSION_2 */
463 val_len = uac2_ctl_value_size(cval->val_type);
464
465 /* FIXME */
466 if (request != UAC_SET_CUR) {
467 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
468 return -EINVAL;
469 }
470
471 request = UAC2_CS_CUR;
472 }
473
474 value_set = convert_bytes_value(cval, value_set);
475 buf[0] = value_set & 0xff;
476 buf[1] = (value_set >> 8) & 0xff;
477 buf[2] = (value_set >> 16) & 0xff;
478 buf[3] = (value_set >> 24) & 0xff;
479
480 err = snd_usb_lock_shutdown(chip);
481 if (err < 0)
482 return -EIO;
483
484 while (timeout-- > 0) {
485 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
486 if (snd_usb_ctl_msg(chip->dev,
487 usb_sndctrlpipe(chip->dev, 0), request,
488 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
489 validx, idx, buf, val_len) >= 0) {
490 err = 0;
491 goto out;
492 }
493 }
494 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
495 request, validx, idx, cval->val_type, buf[0], buf[1]);
496 err = -EINVAL;
497
498 out:
499 snd_usb_unlock_shutdown(chip);
500 return err;
501 }
502
503 static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
504 int validx, int value)
505 {
506 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
507 }
508
509 int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
510 int index, int value)
511 {
512 int err;
513 unsigned int read_only = (channel == 0) ?
514 cval->master_readonly :
515 cval->ch_readonly & (1 << (channel - 1));
516
517 if (read_only) {
518 usb_audio_dbg(cval->head.mixer->chip,
519 "%s(): channel %d of control %d is read_only\n",
520 __func__, channel, cval->control);
521 return 0;
522 }
523
524 err = snd_usb_mixer_set_ctl_value(cval,
525 UAC_SET_CUR, (cval->control << 8) | channel,
526 value);
527 if (err < 0)
528 return err;
529 cval->cached |= 1 << channel;
530 cval->cache_val[index] = value;
531 return 0;
532 }
533
534 /*
535 * TLV callback for mixer volume controls
536 */
537 int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
538 unsigned int size, unsigned int __user *_tlv)
539 {
540 struct usb_mixer_elem_info *cval = kcontrol->private_data;
541 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
542
543 if (size < sizeof(scale))
544 return -ENOMEM;
545 scale[2] = cval->dBmin;
546 scale[3] = cval->dBmax;
547 if (copy_to_user(_tlv, scale, sizeof(scale)))
548 return -EFAULT;
549 return 0;
550 }
551
552 /*
553 * parser routines begin here...
554 */
555
556 static int parse_audio_unit(struct mixer_build *state, int unitid);
557
558
559 /*
560 * check if the input/output channel routing is enabled on the given bitmap.
561 * used for mixer unit parser
562 */
563 static int check_matrix_bitmap(unsigned char *bmap,
564 int ich, int och, int num_outs)
565 {
566 int idx = ich * num_outs + och;
567 return bmap[idx >> 3] & (0x80 >> (idx & 7));
568 }
569
570 /*
571 * add an alsa control element
572 * search and increment the index until an empty slot is found.
573 *
574 * if failed, give up and free the control instance.
575 */
576
577 int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
578 struct snd_kcontrol *kctl)
579 {
580 struct usb_mixer_interface *mixer = list->mixer;
581 int err;
582
583 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
584 kctl->id.index++;
585 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
586 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
587 err);
588 return err;
589 }
590 list->kctl = kctl;
591 list->next_id_elem = mixer->id_elems[list->id];
592 mixer->id_elems[list->id] = list;
593 return 0;
594 }
595
596 /*
597 * get a terminal name string
598 */
599
600 static struct iterm_name_combo {
601 int type;
602 char *name;
603 } iterm_names[] = {
604 { 0x0300, "Output" },
605 { 0x0301, "Speaker" },
606 { 0x0302, "Headphone" },
607 { 0x0303, "HMD Audio" },
608 { 0x0304, "Desktop Speaker" },
609 { 0x0305, "Room Speaker" },
610 { 0x0306, "Com Speaker" },
611 { 0x0307, "LFE" },
612 { 0x0600, "External In" },
613 { 0x0601, "Analog In" },
614 { 0x0602, "Digital In" },
615 { 0x0603, "Line" },
616 { 0x0604, "Legacy In" },
617 { 0x0605, "IEC958 In" },
618 { 0x0606, "1394 DA Stream" },
619 { 0x0607, "1394 DV Stream" },
620 { 0x0700, "Embedded" },
621 { 0x0701, "Noise Source" },
622 { 0x0702, "Equalization Noise" },
623 { 0x0703, "CD" },
624 { 0x0704, "DAT" },
625 { 0x0705, "DCC" },
626 { 0x0706, "MiniDisk" },
627 { 0x0707, "Analog Tape" },
628 { 0x0708, "Phonograph" },
629 { 0x0709, "VCR Audio" },
630 { 0x070a, "Video Disk Audio" },
631 { 0x070b, "DVD Audio" },
632 { 0x070c, "TV Tuner Audio" },
633 { 0x070d, "Satellite Rec Audio" },
634 { 0x070e, "Cable Tuner Audio" },
635 { 0x070f, "DSS Audio" },
636 { 0x0710, "Radio Receiver" },
637 { 0x0711, "Radio Transmitter" },
638 { 0x0712, "Multi-Track Recorder" },
639 { 0x0713, "Synthesizer" },
640 { 0 },
641 };
642
643 static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
644 unsigned char *name, int maxlen, int term_only)
645 {
646 struct iterm_name_combo *names;
647
648 if (iterm->name)
649 return snd_usb_copy_string_desc(state, iterm->name,
650 name, maxlen);
651
652 /* virtual type - not a real terminal */
653 if (iterm->type >> 16) {
654 if (term_only)
655 return 0;
656 switch (iterm->type >> 16) {
657 case UAC_SELECTOR_UNIT:
658 strcpy(name, "Selector");
659 return 8;
660 case UAC1_PROCESSING_UNIT:
661 strcpy(name, "Process Unit");
662 return 12;
663 case UAC1_EXTENSION_UNIT:
664 strcpy(name, "Ext Unit");
665 return 8;
666 case UAC_MIXER_UNIT:
667 strcpy(name, "Mixer");
668 return 5;
669 default:
670 return sprintf(name, "Unit %d", iterm->id);
671 }
672 }
673
674 switch (iterm->type & 0xff00) {
675 case 0x0100:
676 strcpy(name, "PCM");
677 return 3;
678 case 0x0200:
679 strcpy(name, "Mic");
680 return 3;
681 case 0x0400:
682 strcpy(name, "Headset");
683 return 7;
684 case 0x0500:
685 strcpy(name, "Phone");
686 return 5;
687 }
688
689 for (names = iterm_names; names->type; names++) {
690 if (names->type == iterm->type) {
691 strcpy(name, names->name);
692 return strlen(names->name);
693 }
694 }
695
696 return 0;
697 }
698
699 /*
700 * parse the source unit recursively until it reaches to a terminal
701 * or a branched unit.
702 */
703 static int check_input_term(struct mixer_build *state, int id,
704 struct usb_audio_term *term)
705 {
706 int err;
707 void *p1;
708
709 memset(term, 0, sizeof(*term));
710 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
711 unsigned char *hdr = p1;
712 term->id = id;
713 switch (hdr[2]) {
714 case UAC_INPUT_TERMINAL:
715 if (state->mixer->protocol == UAC_VERSION_1) {
716 struct uac_input_terminal_descriptor *d = p1;
717 term->type = le16_to_cpu(d->wTerminalType);
718 term->channels = d->bNrChannels;
719 term->chconfig = le16_to_cpu(d->wChannelConfig);
720 term->name = d->iTerminal;
721 } else { /* UAC_VERSION_2 */
722 struct uac2_input_terminal_descriptor *d = p1;
723
724 /* call recursively to verify that the
725 * referenced clock entity is valid */
726 err = check_input_term(state, d->bCSourceID, term);
727 if (err < 0)
728 return err;
729
730 /* save input term properties after recursion,
731 * to ensure they are not overriden by the
732 * recursion calls */
733 term->id = id;
734 term->type = le16_to_cpu(d->wTerminalType);
735 term->channels = d->bNrChannels;
736 term->chconfig = le32_to_cpu(d->bmChannelConfig);
737 term->name = d->iTerminal;
738 }
739 return 0;
740 case UAC_FEATURE_UNIT: {
741 /* the header is the same for v1 and v2 */
742 struct uac_feature_unit_descriptor *d = p1;
743 id = d->bSourceID;
744 break; /* continue to parse */
745 }
746 case UAC_MIXER_UNIT: {
747 struct uac_mixer_unit_descriptor *d = p1;
748 term->type = d->bDescriptorSubtype << 16; /* virtual type */
749 term->channels = uac_mixer_unit_bNrChannels(d);
750 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
751 term->name = uac_mixer_unit_iMixer(d);
752 return 0;
753 }
754 case UAC_SELECTOR_UNIT:
755 case UAC2_CLOCK_SELECTOR: {
756 struct uac_selector_unit_descriptor *d = p1;
757 /* call recursively to retrieve the channel info */
758 err = check_input_term(state, d->baSourceID[0], term);
759 if (err < 0)
760 return err;
761 term->type = d->bDescriptorSubtype << 16; /* virtual type */
762 term->id = id;
763 term->name = uac_selector_unit_iSelector(d);
764 return 0;
765 }
766 case UAC1_PROCESSING_UNIT:
767 case UAC1_EXTENSION_UNIT:
768 /* UAC2_PROCESSING_UNIT_V2 */
769 /* UAC2_EFFECT_UNIT */
770 case UAC2_EXTENSION_UNIT_V2: {
771 struct uac_processing_unit_descriptor *d = p1;
772
773 if (state->mixer->protocol == UAC_VERSION_2 &&
774 hdr[2] == UAC2_EFFECT_UNIT) {
775 /* UAC2/UAC1 unit IDs overlap here in an
776 * uncompatible way. Ignore this unit for now.
777 */
778 return 0;
779 }
780
781 if (d->bNrInPins) {
782 id = d->baSourceID[0];
783 break; /* continue to parse */
784 }
785 term->type = d->bDescriptorSubtype << 16; /* virtual type */
786 term->channels = uac_processing_unit_bNrChannels(d);
787 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
788 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
789 return 0;
790 }
791 case UAC2_CLOCK_SOURCE: {
792 struct uac_clock_source_descriptor *d = p1;
793 term->type = d->bDescriptorSubtype << 16; /* virtual type */
794 term->id = id;
795 term->name = d->iClockSource;
796 return 0;
797 }
798 default:
799 return -ENODEV;
800 }
801 }
802 return -ENODEV;
803 }
804
805 /*
806 * Feature Unit
807 */
808
809 /* feature unit control information */
810 struct usb_feature_control_info {
811 const char *name;
812 int type; /* data type for uac1 */
813 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
814 };
815
816 static struct usb_feature_control_info audio_feature_info[] = {
817 { "Mute", USB_MIXER_INV_BOOLEAN, -1 },
818 { "Volume", USB_MIXER_S16, -1 },
819 { "Tone Control - Bass", USB_MIXER_S8, -1 },
820 { "Tone Control - Mid", USB_MIXER_S8, -1 },
821 { "Tone Control - Treble", USB_MIXER_S8, -1 },
822 { "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
823 { "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
824 { "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
825 { "Bass Boost", USB_MIXER_BOOLEAN, -1 },
826 { "Loudness", USB_MIXER_BOOLEAN, -1 },
827 /* UAC2 specific */
828 { "Input Gain Control", USB_MIXER_S16, -1 },
829 { "Input Gain Pad Control", USB_MIXER_S16, -1 },
830 { "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
831 };
832
833 /* private_free callback */
834 void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
835 {
836 kfree(kctl->private_data);
837 kctl->private_data = NULL;
838 }
839
840 /*
841 * interface to ALSA control for feature/mixer units
842 */
843
844 /* volume control quirks */
845 static void volume_control_quirks(struct usb_mixer_elem_info *cval,
846 struct snd_kcontrol *kctl)
847 {
848 struct snd_usb_audio *chip = cval->head.mixer->chip;
849 switch (chip->usb_id) {
850 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
851 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
852 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
853 cval->min = 0x0000;
854 cval->max = 0xffff;
855 cval->res = 0x00e6;
856 break;
857 }
858 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
859 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
860 cval->min = 0x00;
861 cval->max = 0xff;
862 break;
863 }
864 if (strstr(kctl->id.name, "Effect Return") != NULL) {
865 cval->min = 0xb706;
866 cval->max = 0xff7b;
867 cval->res = 0x0073;
868 break;
869 }
870 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
871 (strstr(kctl->id.name, "Effect Send") != NULL)) {
872 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
873 cval->max = 0xfcfe;
874 cval->res = 0x0073;
875 }
876 break;
877
878 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
879 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
880 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
881 usb_audio_info(chip,
882 "set quirk for FTU Effect Duration\n");
883 cval->min = 0x0000;
884 cval->max = 0x7f00;
885 cval->res = 0x0100;
886 break;
887 }
888 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
889 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
890 usb_audio_info(chip,
891 "set quirks for FTU Effect Feedback/Volume\n");
892 cval->min = 0x00;
893 cval->max = 0x7f;
894 break;
895 }
896 break;
897
898 case USB_ID(0x0471, 0x0101):
899 case USB_ID(0x0471, 0x0104):
900 case USB_ID(0x0471, 0x0105):
901 case USB_ID(0x0672, 0x1041):
902 /* quirk for UDA1321/N101.
903 * note that detection between firmware 2.1.1.7 (N101)
904 * and later 2.1.1.21 is not very clear from datasheets.
905 * I hope that the min value is -15360 for newer firmware --jk
906 */
907 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
908 cval->min == -15616) {
909 usb_audio_info(chip,
910 "set volume quirk for UDA1321/N101 chip\n");
911 cval->max = -256;
912 }
913 break;
914
915 case USB_ID(0x046d, 0x09a4):
916 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
917 usb_audio_info(chip,
918 "set volume quirk for QuickCam E3500\n");
919 cval->min = 6080;
920 cval->max = 8768;
921 cval->res = 192;
922 }
923 break;
924
925 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
926 case USB_ID(0x046d, 0x0808):
927 case USB_ID(0x046d, 0x0809):
928 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
929 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
930 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
931 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
932 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
933 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
934 case USB_ID(0x046d, 0x0991):
935 /* Most audio usb devices lie about volume resolution.
936 * Most Logitech webcams have res = 384.
937 * Proboly there is some logitech magic behind this number --fishor
938 */
939 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
940 usb_audio_info(chip,
941 "set resolution quirk: cval->res = 384\n");
942 cval->res = 384;
943 }
944 break;
945 }
946 }
947
948 /*
949 * retrieve the minimum and maximum values for the specified control
950 */
951 static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
952 int default_min, struct snd_kcontrol *kctl)
953 {
954 /* for failsafe */
955 cval->min = default_min;
956 cval->max = cval->min + 1;
957 cval->res = 1;
958 cval->dBmin = cval->dBmax = 0;
959
960 if (cval->val_type == USB_MIXER_BOOLEAN ||
961 cval->val_type == USB_MIXER_INV_BOOLEAN) {
962 cval->initialized = 1;
963 } else {
964 int minchn = 0;
965 if (cval->cmask) {
966 int i;
967 for (i = 0; i < MAX_CHANNELS; i++)
968 if (cval->cmask & (1 << i)) {
969 minchn = i + 1;
970 break;
971 }
972 }
973 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
974 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
975 usb_audio_err(cval->head.mixer->chip,
976 "%d:%d: cannot get min/max values for control %d (id %d)\n",
977 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
978 cval->control, cval->head.id);
979 return -EINVAL;
980 }
981 if (get_ctl_value(cval, UAC_GET_RES,
982 (cval->control << 8) | minchn,
983 &cval->res) < 0) {
984 cval->res = 1;
985 } else {
986 int last_valid_res = cval->res;
987
988 while (cval->res > 1) {
989 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
990 (cval->control << 8) | minchn,
991 cval->res / 2) < 0)
992 break;
993 cval->res /= 2;
994 }
995 if (get_ctl_value(cval, UAC_GET_RES,
996 (cval->control << 8) | minchn, &cval->res) < 0)
997 cval->res = last_valid_res;
998 }
999 if (cval->res == 0)
1000 cval->res = 1;
1001
1002 /* Additional checks for the proper resolution
1003 *
1004 * Some devices report smaller resolutions than actually
1005 * reacting. They don't return errors but simply clip
1006 * to the lower aligned value.
1007 */
1008 if (cval->min + cval->res < cval->max) {
1009 int last_valid_res = cval->res;
1010 int saved, test, check;
1011 get_cur_mix_raw(cval, minchn, &saved);
1012 for (;;) {
1013 test = saved;
1014 if (test < cval->max)
1015 test += cval->res;
1016 else
1017 test -= cval->res;
1018 if (test < cval->min || test > cval->max ||
1019 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1020 get_cur_mix_raw(cval, minchn, &check)) {
1021 cval->res = last_valid_res;
1022 break;
1023 }
1024 if (test == check)
1025 break;
1026 cval->res *= 2;
1027 }
1028 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1029 }
1030
1031 cval->initialized = 1;
1032 }
1033
1034 if (kctl)
1035 volume_control_quirks(cval, kctl);
1036
1037 /* USB descriptions contain the dB scale in 1/256 dB unit
1038 * while ALSA TLV contains in 1/100 dB unit
1039 */
1040 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1041 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1042 if (cval->dBmin > cval->dBmax) {
1043 /* something is wrong; assume it's either from/to 0dB */
1044 if (cval->dBmin < 0)
1045 cval->dBmax = 0;
1046 else if (cval->dBmin > 0)
1047 cval->dBmin = 0;
1048 if (cval->dBmin > cval->dBmax) {
1049 /* totally crap, return an error */
1050 return -EINVAL;
1051 }
1052 }
1053
1054 return 0;
1055 }
1056
1057 #define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
1058
1059 /* get a feature/mixer unit info */
1060 static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1061 struct snd_ctl_elem_info *uinfo)
1062 {
1063 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1064
1065 if (cval->val_type == USB_MIXER_BOOLEAN ||
1066 cval->val_type == USB_MIXER_INV_BOOLEAN)
1067 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1068 else
1069 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1070 uinfo->count = cval->channels;
1071 if (cval->val_type == USB_MIXER_BOOLEAN ||
1072 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1073 uinfo->value.integer.min = 0;
1074 uinfo->value.integer.max = 1;
1075 } else {
1076 if (!cval->initialized) {
1077 get_min_max_with_quirks(cval, 0, kcontrol);
1078 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1079 kcontrol->vd[0].access &=
1080 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1081 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1082 snd_ctl_notify(cval->head.mixer->chip->card,
1083 SNDRV_CTL_EVENT_MASK_INFO,
1084 &kcontrol->id);
1085 }
1086 }
1087 uinfo->value.integer.min = 0;
1088 uinfo->value.integer.max =
1089 (cval->max - cval->min + cval->res - 1) / cval->res;
1090 }
1091 return 0;
1092 }
1093
1094 /* get the current value from feature/mixer unit */
1095 static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1096 struct snd_ctl_elem_value *ucontrol)
1097 {
1098 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1099 int c, cnt, val, err;
1100
1101 ucontrol->value.integer.value[0] = cval->min;
1102 if (cval->cmask) {
1103 cnt = 0;
1104 for (c = 0; c < MAX_CHANNELS; c++) {
1105 if (!(cval->cmask & (1 << c)))
1106 continue;
1107 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1108 if (err < 0)
1109 return filter_error(cval, err);
1110 val = get_relative_value(cval, val);
1111 ucontrol->value.integer.value[cnt] = val;
1112 cnt++;
1113 }
1114 return 0;
1115 } else {
1116 /* master channel */
1117 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1118 if (err < 0)
1119 return filter_error(cval, err);
1120 val = get_relative_value(cval, val);
1121 ucontrol->value.integer.value[0] = val;
1122 }
1123 return 0;
1124 }
1125
1126 /* put the current value to feature/mixer unit */
1127 static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1128 struct snd_ctl_elem_value *ucontrol)
1129 {
1130 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1131 int c, cnt, val, oval, err;
1132 int changed = 0;
1133
1134 if (cval->cmask) {
1135 cnt = 0;
1136 for (c = 0; c < MAX_CHANNELS; c++) {
1137 if (!(cval->cmask & (1 << c)))
1138 continue;
1139 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1140 if (err < 0)
1141 return filter_error(cval, err);
1142 val = ucontrol->value.integer.value[cnt];
1143 val = get_abs_value(cval, val);
1144 if (oval != val) {
1145 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1146 changed = 1;
1147 }
1148 cnt++;
1149 }
1150 } else {
1151 /* master channel */
1152 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1153 if (err < 0)
1154 return filter_error(cval, err);
1155 val = ucontrol->value.integer.value[0];
1156 val = get_abs_value(cval, val);
1157 if (val != oval) {
1158 snd_usb_set_cur_mix_value(cval, 0, 0, val);
1159 changed = 1;
1160 }
1161 }
1162 return changed;
1163 }
1164
1165 static struct snd_kcontrol_new usb_feature_unit_ctl = {
1166 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1167 .name = "", /* will be filled later manually */
1168 .info = mixer_ctl_feature_info,
1169 .get = mixer_ctl_feature_get,
1170 .put = mixer_ctl_feature_put,
1171 };
1172
1173 /* the read-only variant */
1174 static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1175 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1176 .name = "", /* will be filled later manually */
1177 .info = mixer_ctl_feature_info,
1178 .get = mixer_ctl_feature_get,
1179 .put = NULL,
1180 };
1181
1182 /*
1183 * This symbol is exported in order to allow the mixer quirks to
1184 * hook up to the standard feature unit control mechanism
1185 */
1186 struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1187
1188 /*
1189 * build a feature control
1190 */
1191 static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1192 {
1193 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1194 }
1195
1196 /*
1197 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1198 * rename it to "Headphone". We determine if something is a headphone
1199 * similar to how udev determines form factor.
1200 */
1201 static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1202 struct snd_card *card)
1203 {
1204 const char *names_to_check[] = {
1205 "Headset", "headset", "Headphone", "headphone", NULL};
1206 const char **s;
1207 bool found = false;
1208
1209 if (strcmp("Speaker", kctl->id.name))
1210 return;
1211
1212 for (s = names_to_check; *s; s++)
1213 if (strstr(card->shortname, *s)) {
1214 found = true;
1215 break;
1216 }
1217
1218 if (!found)
1219 return;
1220
1221 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1222 }
1223
1224 static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1225 unsigned int ctl_mask, int control,
1226 struct usb_audio_term *iterm, int unitid,
1227 int readonly_mask)
1228 {
1229 struct uac_feature_unit_descriptor *desc = raw_desc;
1230 struct usb_feature_control_info *ctl_info;
1231 unsigned int len = 0;
1232 int mapped_name = 0;
1233 int nameid = uac_feature_unit_iFeature(desc);
1234 struct snd_kcontrol *kctl;
1235 struct usb_mixer_elem_info *cval;
1236 const struct usbmix_name_map *map;
1237 unsigned int range;
1238
1239 control++; /* change from zero-based to 1-based value */
1240
1241 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1242 /* FIXME: not supported yet */
1243 return;
1244 }
1245
1246 map = find_map(state, unitid, control);
1247 if (check_ignored_ctl(map))
1248 return;
1249
1250 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1251 if (!cval)
1252 return;
1253 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1254 cval->control = control;
1255 cval->cmask = ctl_mask;
1256 ctl_info = &audio_feature_info[control-1];
1257 if (state->mixer->protocol == UAC_VERSION_1)
1258 cval->val_type = ctl_info->type;
1259 else /* UAC_VERSION_2 */
1260 cval->val_type = ctl_info->type_uac2 >= 0 ?
1261 ctl_info->type_uac2 : ctl_info->type;
1262
1263 if (ctl_mask == 0) {
1264 cval->channels = 1; /* master channel */
1265 cval->master_readonly = readonly_mask;
1266 } else {
1267 int i, c = 0;
1268 for (i = 0; i < 16; i++)
1269 if (ctl_mask & (1 << i))
1270 c++;
1271 cval->channels = c;
1272 cval->ch_readonly = readonly_mask;
1273 }
1274
1275 /*
1276 * If all channels in the mask are marked read-only, make the control
1277 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1278 * issue write commands to read-only channels.
1279 */
1280 if (cval->channels == readonly_mask)
1281 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1282 else
1283 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1284
1285 if (!kctl) {
1286 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1287 kfree(cval);
1288 return;
1289 }
1290 kctl->private_free = snd_usb_mixer_elem_free;
1291
1292 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1293 mapped_name = len != 0;
1294 if (!len && nameid)
1295 len = snd_usb_copy_string_desc(state, nameid,
1296 kctl->id.name, sizeof(kctl->id.name));
1297
1298 switch (control) {
1299 case UAC_FU_MUTE:
1300 case UAC_FU_VOLUME:
1301 /*
1302 * determine the control name. the rule is:
1303 * - if a name id is given in descriptor, use it.
1304 * - if the connected input can be determined, then use the name
1305 * of terminal type.
1306 * - if the connected output can be determined, use it.
1307 * - otherwise, anonymous name.
1308 */
1309 if (!len) {
1310 len = get_term_name(state, iterm, kctl->id.name,
1311 sizeof(kctl->id.name), 1);
1312 if (!len)
1313 len = get_term_name(state, &state->oterm,
1314 kctl->id.name,
1315 sizeof(kctl->id.name), 1);
1316 if (!len)
1317 snprintf(kctl->id.name, sizeof(kctl->id.name),
1318 "Feature %d", unitid);
1319 }
1320
1321 if (!mapped_name)
1322 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1323
1324 /*
1325 * determine the stream direction:
1326 * if the connected output is USB stream, then it's likely a
1327 * capture stream. otherwise it should be playback (hopefully :)
1328 */
1329 if (!mapped_name && !(state->oterm.type >> 16)) {
1330 if ((state->oterm.type & 0xff00) == 0x0100)
1331 append_ctl_name(kctl, " Capture");
1332 else
1333 append_ctl_name(kctl, " Playback");
1334 }
1335 append_ctl_name(kctl, control == UAC_FU_MUTE ?
1336 " Switch" : " Volume");
1337 break;
1338 default:
1339 if (!len)
1340 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1341 sizeof(kctl->id.name));
1342 break;
1343 }
1344
1345 /* get min/max values */
1346 get_min_max_with_quirks(cval, 0, kctl);
1347
1348 if (control == UAC_FU_VOLUME) {
1349 check_mapped_dB(map, cval);
1350 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1351 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1352 kctl->vd[0].access |=
1353 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1354 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1355 }
1356 }
1357
1358 snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1359
1360 range = (cval->max - cval->min) / cval->res;
1361 /*
1362 * Are there devices with volume range more than 255? I use a bit more
1363 * to be sure. 384 is a resolution magic number found on Logitech
1364 * devices. It will definitively catch all buggy Logitech devices.
1365 */
1366 if (range > 384) {
1367 usb_audio_warn(state->chip,
1368 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1369 range);
1370 usb_audio_warn(state->chip,
1371 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1372 cval->head.id, kctl->id.name, cval->channels,
1373 cval->min, cval->max, cval->res);
1374 }
1375
1376 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1377 cval->head.id, kctl->id.name, cval->channels,
1378 cval->min, cval->max, cval->res);
1379 snd_usb_mixer_add_control(&cval->head, kctl);
1380 }
1381
1382 static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1383 void *_ftr)
1384 {
1385 struct uac_clock_source_descriptor *hdr = _ftr;
1386 struct usb_mixer_elem_info *cval;
1387 struct snd_kcontrol *kctl;
1388 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1389 int ret;
1390
1391 if (state->mixer->protocol != UAC_VERSION_2)
1392 return -EINVAL;
1393
1394 if (hdr->bLength != sizeof(*hdr)) {
1395 usb_audio_dbg(state->chip,
1396 "Bogus clock source descriptor length of %d, ignoring.\n",
1397 hdr->bLength);
1398 return 0;
1399 }
1400
1401 /*
1402 * The only property of this unit we are interested in is the
1403 * clock source validity. If that isn't readable, just bail out.
1404 */
1405 if (!uac2_control_is_readable(hdr->bmControls,
1406 ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1407 return 0;
1408
1409 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1410 if (!cval)
1411 return -ENOMEM;
1412
1413 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1414
1415 cval->min = 0;
1416 cval->max = 1;
1417 cval->channels = 1;
1418 cval->val_type = USB_MIXER_BOOLEAN;
1419 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1420
1421 if (uac2_control_is_writeable(hdr->bmControls,
1422 ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1423 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1424 else {
1425 cval->master_readonly = 1;
1426 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1427 }
1428
1429 if (!kctl) {
1430 kfree(cval);
1431 return -ENOMEM;
1432 }
1433
1434 kctl->private_free = snd_usb_mixer_elem_free;
1435 ret = snd_usb_copy_string_desc(state, hdr->iClockSource,
1436 name, sizeof(name));
1437 if (ret > 0)
1438 snprintf(kctl->id.name, sizeof(kctl->id.name),
1439 "%s Validity", name);
1440 else
1441 snprintf(kctl->id.name, sizeof(kctl->id.name),
1442 "Clock Source %d Validity", hdr->bClockID);
1443
1444 return snd_usb_mixer_add_control(&cval->head, kctl);
1445 }
1446
1447 /*
1448 * parse a feature unit
1449 *
1450 * most of controls are defined here.
1451 */
1452 static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1453 void *_ftr)
1454 {
1455 int channels, i, j;
1456 struct usb_audio_term iterm;
1457 unsigned int master_bits, first_ch_bits;
1458 int err, csize;
1459 struct uac_feature_unit_descriptor *hdr = _ftr;
1460 __u8 *bmaControls;
1461
1462 if (state->mixer->protocol == UAC_VERSION_1) {
1463 csize = hdr->bControlSize;
1464 if (!csize) {
1465 usb_audio_dbg(state->chip,
1466 "unit %u: invalid bControlSize == 0\n",
1467 unitid);
1468 return -EINVAL;
1469 }
1470 channels = (hdr->bLength - 7) / csize - 1;
1471 bmaControls = hdr->bmaControls;
1472 if (hdr->bLength < 7 + csize) {
1473 usb_audio_err(state->chip,
1474 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1475 unitid);
1476 return -EINVAL;
1477 }
1478 } else {
1479 struct uac2_feature_unit_descriptor *ftr = _ftr;
1480 csize = 4;
1481 channels = (hdr->bLength - 6) / 4 - 1;
1482 bmaControls = ftr->bmaControls;
1483 if (hdr->bLength < 6 + csize) {
1484 usb_audio_err(state->chip,
1485 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1486 unitid);
1487 return -EINVAL;
1488 }
1489 }
1490
1491 /* parse the source unit */
1492 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1493 return err;
1494
1495 /* determine the input source type and name */
1496 err = check_input_term(state, hdr->bSourceID, &iterm);
1497 if (err < 0)
1498 return err;
1499
1500 master_bits = snd_usb_combine_bytes(bmaControls, csize);
1501 /* master configuration quirks */
1502 switch (state->chip->usb_id) {
1503 case USB_ID(0x08bb, 0x2702):
1504 usb_audio_info(state->chip,
1505 "usbmixer: master volume quirk for PCM2702 chip\n");
1506 /* disable non-functional volume control */
1507 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1508 break;
1509 case USB_ID(0x1130, 0xf211):
1510 usb_audio_info(state->chip,
1511 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1512 /* disable non-functional volume control */
1513 channels = 0;
1514 break;
1515
1516 }
1517 if (channels > 0)
1518 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1519 else
1520 first_ch_bits = 0;
1521
1522 if (state->mixer->protocol == UAC_VERSION_1) {
1523 /* check all control types */
1524 for (i = 0; i < 10; i++) {
1525 unsigned int ch_bits = 0;
1526 for (j = 0; j < channels; j++) {
1527 unsigned int mask;
1528
1529 mask = snd_usb_combine_bytes(bmaControls +
1530 csize * (j+1), csize);
1531 if (mask & (1 << i))
1532 ch_bits |= (1 << j);
1533 }
1534 /* audio class v1 controls are never read-only */
1535
1536 /*
1537 * The first channel must be set
1538 * (for ease of programming).
1539 */
1540 if (ch_bits & 1)
1541 build_feature_ctl(state, _ftr, ch_bits, i,
1542 &iterm, unitid, 0);
1543 if (master_bits & (1 << i))
1544 build_feature_ctl(state, _ftr, 0, i, &iterm,
1545 unitid, 0);
1546 }
1547 } else { /* UAC_VERSION_2 */
1548 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1549 unsigned int ch_bits = 0;
1550 unsigned int ch_read_only = 0;
1551
1552 for (j = 0; j < channels; j++) {
1553 unsigned int mask;
1554
1555 mask = snd_usb_combine_bytes(bmaControls +
1556 csize * (j+1), csize);
1557 if (uac2_control_is_readable(mask, i)) {
1558 ch_bits |= (1 << j);
1559 if (!uac2_control_is_writeable(mask, i))
1560 ch_read_only |= (1 << j);
1561 }
1562 }
1563
1564 /*
1565 * NOTE: build_feature_ctl() will mark the control
1566 * read-only if all channels are marked read-only in
1567 * the descriptors. Otherwise, the control will be
1568 * reported as writeable, but the driver will not
1569 * actually issue a write command for read-only
1570 * channels.
1571 */
1572
1573 /*
1574 * The first channel must be set
1575 * (for ease of programming).
1576 */
1577 if (ch_bits & 1)
1578 build_feature_ctl(state, _ftr, ch_bits, i,
1579 &iterm, unitid, ch_read_only);
1580 if (uac2_control_is_readable(master_bits, i))
1581 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1582 !uac2_control_is_writeable(master_bits, i));
1583 }
1584 }
1585
1586 return 0;
1587 }
1588
1589 /*
1590 * Mixer Unit
1591 */
1592
1593 /*
1594 * build a mixer unit control
1595 *
1596 * the callbacks are identical with feature unit.
1597 * input channel number (zero based) is given in control field instead.
1598 */
1599 static void build_mixer_unit_ctl(struct mixer_build *state,
1600 struct uac_mixer_unit_descriptor *desc,
1601 int in_pin, int in_ch, int unitid,
1602 struct usb_audio_term *iterm)
1603 {
1604 struct usb_mixer_elem_info *cval;
1605 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1606 unsigned int i, len;
1607 struct snd_kcontrol *kctl;
1608 const struct usbmix_name_map *map;
1609
1610 map = find_map(state, unitid, 0);
1611 if (check_ignored_ctl(map))
1612 return;
1613
1614 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1615 if (!cval)
1616 return;
1617
1618 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1619 cval->control = in_ch + 1; /* based on 1 */
1620 cval->val_type = USB_MIXER_S16;
1621 for (i = 0; i < num_outs; i++) {
1622 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1623
1624 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
1625 cval->cmask |= (1 << i);
1626 cval->channels++;
1627 }
1628 }
1629
1630 /* get min/max values */
1631 get_min_max(cval, 0);
1632
1633 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1634 if (!kctl) {
1635 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
1636 kfree(cval);
1637 return;
1638 }
1639 kctl->private_free = snd_usb_mixer_elem_free;
1640
1641 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1642 if (!len)
1643 len = get_term_name(state, iterm, kctl->id.name,
1644 sizeof(kctl->id.name), 0);
1645 if (!len)
1646 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1647 append_ctl_name(kctl, " Volume");
1648
1649 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
1650 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1651 snd_usb_mixer_add_control(&cval->head, kctl);
1652 }
1653
1654 /*
1655 * parse a mixer unit
1656 */
1657 static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1658 void *raw_desc)
1659 {
1660 struct uac_mixer_unit_descriptor *desc = raw_desc;
1661 struct usb_audio_term iterm;
1662 int input_pins, num_ins, num_outs;
1663 int pin, ich, err;
1664
1665 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1666 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1667 usb_audio_err(state->chip,
1668 "invalid MIXER UNIT descriptor %d\n",
1669 unitid);
1670 return -EINVAL;
1671 }
1672
1673 num_ins = 0;
1674 ich = 0;
1675 for (pin = 0; pin < input_pins; pin++) {
1676 err = parse_audio_unit(state, desc->baSourceID[pin]);
1677 if (err < 0)
1678 continue;
1679 /* no bmControls field (e.g. Maya44) -> ignore */
1680 if (desc->bLength <= 10 + input_pins)
1681 continue;
1682 err = check_input_term(state, desc->baSourceID[pin], &iterm);
1683 if (err < 0)
1684 return err;
1685 num_ins += iterm.channels;
1686 for (; ich < num_ins; ich++) {
1687 int och, ich_has_controls = 0;
1688
1689 for (och = 0; och < num_outs; och++) {
1690 __u8 *c = uac_mixer_unit_bmControls(desc,
1691 state->mixer->protocol);
1692
1693 if (check_matrix_bitmap(c, ich, och, num_outs)) {
1694 ich_has_controls = 1;
1695 break;
1696 }
1697 }
1698 if (ich_has_controls)
1699 build_mixer_unit_ctl(state, desc, pin, ich,
1700 unitid, &iterm);
1701 }
1702 }
1703 return 0;
1704 }
1705
1706 /*
1707 * Processing Unit / Extension Unit
1708 */
1709
1710 /* get callback for processing/extension unit */
1711 static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1712 struct snd_ctl_elem_value *ucontrol)
1713 {
1714 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1715 int err, val;
1716
1717 err = get_cur_ctl_value(cval, cval->control << 8, &val);
1718 if (err < 0) {
1719 ucontrol->value.integer.value[0] = cval->min;
1720 return filter_error(cval, err);
1721 }
1722 val = get_relative_value(cval, val);
1723 ucontrol->value.integer.value[0] = val;
1724 return 0;
1725 }
1726
1727 /* put callback for processing/extension unit */
1728 static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1729 struct snd_ctl_elem_value *ucontrol)
1730 {
1731 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1732 int val, oval, err;
1733
1734 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1735 if (err < 0)
1736 return filter_error(cval, err);
1737 val = ucontrol->value.integer.value[0];
1738 val = get_abs_value(cval, val);
1739 if (val != oval) {
1740 set_cur_ctl_value(cval, cval->control << 8, val);
1741 return 1;
1742 }
1743 return 0;
1744 }
1745
1746 /* alsa control interface for processing/extension unit */
1747 static struct snd_kcontrol_new mixer_procunit_ctl = {
1748 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1749 .name = "", /* will be filled later */
1750 .info = mixer_ctl_feature_info,
1751 .get = mixer_ctl_procunit_get,
1752 .put = mixer_ctl_procunit_put,
1753 };
1754
1755 /*
1756 * predefined data for processing units
1757 */
1758 struct procunit_value_info {
1759 int control;
1760 char *suffix;
1761 int val_type;
1762 int min_value;
1763 };
1764
1765 struct procunit_info {
1766 int type;
1767 char *name;
1768 struct procunit_value_info *values;
1769 };
1770
1771 static struct procunit_value_info updown_proc_info[] = {
1772 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1773 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1774 { 0 }
1775 };
1776 static struct procunit_value_info prologic_proc_info[] = {
1777 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1778 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1779 { 0 }
1780 };
1781 static struct procunit_value_info threed_enh_proc_info[] = {
1782 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1783 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1784 { 0 }
1785 };
1786 static struct procunit_value_info reverb_proc_info[] = {
1787 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1788 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1789 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1790 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1791 { 0 }
1792 };
1793 static struct procunit_value_info chorus_proc_info[] = {
1794 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1795 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1796 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1797 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1798 { 0 }
1799 };
1800 static struct procunit_value_info dcr_proc_info[] = {
1801 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1802 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1803 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1804 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1805 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1806 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1807 { 0 }
1808 };
1809
1810 static struct procunit_info procunits[] = {
1811 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1812 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1813 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1814 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1815 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1816 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1817 { 0 },
1818 };
1819 /*
1820 * predefined data for extension units
1821 */
1822 static struct procunit_value_info clock_rate_xu_info[] = {
1823 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1824 { 0 }
1825 };
1826 static struct procunit_value_info clock_source_xu_info[] = {
1827 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1828 { 0 }
1829 };
1830 static struct procunit_value_info spdif_format_xu_info[] = {
1831 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1832 { 0 }
1833 };
1834 static struct procunit_value_info soft_limit_xu_info[] = {
1835 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1836 { 0 }
1837 };
1838 static struct procunit_info extunits[] = {
1839 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1840 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1841 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1842 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1843 { 0 }
1844 };
1845
1846 /*
1847 * build a processing/extension unit
1848 */
1849 static int build_audio_procunit(struct mixer_build *state, int unitid,
1850 void *raw_desc, struct procunit_info *list,
1851 char *name)
1852 {
1853 struct uac_processing_unit_descriptor *desc = raw_desc;
1854 int num_ins = desc->bNrInPins;
1855 struct usb_mixer_elem_info *cval;
1856 struct snd_kcontrol *kctl;
1857 int i, err, nameid, type, len;
1858 struct procunit_info *info;
1859 struct procunit_value_info *valinfo;
1860 const struct usbmix_name_map *map;
1861 static struct procunit_value_info default_value_info[] = {
1862 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1863 { 0 }
1864 };
1865 static struct procunit_info default_info = {
1866 0, NULL, default_value_info
1867 };
1868
1869 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1870 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1871 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
1872 return -EINVAL;
1873 }
1874
1875 for (i = 0; i < num_ins; i++) {
1876 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1877 return err;
1878 }
1879
1880 type = le16_to_cpu(desc->wProcessType);
1881 for (info = list; info && info->type; info++)
1882 if (info->type == type)
1883 break;
1884 if (!info || !info->type)
1885 info = &default_info;
1886
1887 for (valinfo = info->values; valinfo->control; valinfo++) {
1888 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1889
1890 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1891 continue;
1892 map = find_map(state, unitid, valinfo->control);
1893 if (check_ignored_ctl(map))
1894 continue;
1895 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1896 if (!cval)
1897 return -ENOMEM;
1898 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
1899 cval->control = valinfo->control;
1900 cval->val_type = valinfo->val_type;
1901 cval->channels = 1;
1902
1903 /* get min/max values */
1904 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1905 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1906 /* FIXME: hard-coded */
1907 cval->min = 1;
1908 cval->max = control_spec[0];
1909 cval->res = 1;
1910 cval->initialized = 1;
1911 } else {
1912 if (type == USB_XU_CLOCK_RATE) {
1913 /*
1914 * E-Mu USB 0404/0202/TrackerPre/0204
1915 * samplerate control quirk
1916 */
1917 cval->min = 0;
1918 cval->max = 5;
1919 cval->res = 1;
1920 cval->initialized = 1;
1921 } else
1922 get_min_max(cval, valinfo->min_value);
1923 }
1924
1925 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1926 if (!kctl) {
1927 kfree(cval);
1928 return -ENOMEM;
1929 }
1930 kctl->private_free = snd_usb_mixer_elem_free;
1931
1932 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
1933 /* nothing */ ;
1934 } else if (info->name) {
1935 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1936 } else {
1937 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1938 len = 0;
1939 if (nameid)
1940 len = snd_usb_copy_string_desc(state, nameid,
1941 kctl->id.name,
1942 sizeof(kctl->id.name));
1943 if (!len)
1944 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1945 }
1946 append_ctl_name(kctl, " ");
1947 append_ctl_name(kctl, valinfo->suffix);
1948
1949 usb_audio_dbg(state->chip,
1950 "[%d] PU [%s] ch = %d, val = %d/%d\n",
1951 cval->head.id, kctl->id.name, cval->channels,
1952 cval->min, cval->max);
1953
1954 err = snd_usb_mixer_add_control(&cval->head, kctl);
1955 if (err < 0)
1956 return err;
1957 }
1958 return 0;
1959 }
1960
1961 static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
1962 void *raw_desc)
1963 {
1964 return build_audio_procunit(state, unitid, raw_desc,
1965 procunits, "Processing Unit");
1966 }
1967
1968 static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
1969 void *raw_desc)
1970 {
1971 /*
1972 * Note that we parse extension units with processing unit descriptors.
1973 * That's ok as the layout is the same.
1974 */
1975 return build_audio_procunit(state, unitid, raw_desc,
1976 extunits, "Extension Unit");
1977 }
1978
1979 /*
1980 * Selector Unit
1981 */
1982
1983 /*
1984 * info callback for selector unit
1985 * use an enumerator type for routing
1986 */
1987 static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
1988 struct snd_ctl_elem_info *uinfo)
1989 {
1990 struct usb_mixer_elem_info *cval = kcontrol->private_data;
1991 const char **itemlist = (const char **)kcontrol->private_value;
1992
1993 if (snd_BUG_ON(!itemlist))
1994 return -EINVAL;
1995 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
1996 }
1997
1998 /* get callback for selector unit */
1999 static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2000 struct snd_ctl_elem_value *ucontrol)
2001 {
2002 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2003 int val, err;
2004
2005 err = get_cur_ctl_value(cval, cval->control << 8, &val);
2006 if (err < 0) {
2007 ucontrol->value.enumerated.item[0] = 0;
2008 return filter_error(cval, err);
2009 }
2010 val = get_relative_value(cval, val);
2011 ucontrol->value.enumerated.item[0] = val;
2012 return 0;
2013 }
2014
2015 /* put callback for selector unit */
2016 static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2017 struct snd_ctl_elem_value *ucontrol)
2018 {
2019 struct usb_mixer_elem_info *cval = kcontrol->private_data;
2020 int val, oval, err;
2021
2022 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2023 if (err < 0)
2024 return filter_error(cval, err);
2025 val = ucontrol->value.enumerated.item[0];
2026 val = get_abs_value(cval, val);
2027 if (val != oval) {
2028 set_cur_ctl_value(cval, cval->control << 8, val);
2029 return 1;
2030 }
2031 return 0;
2032 }
2033
2034 /* alsa control interface for selector unit */
2035 static struct snd_kcontrol_new mixer_selectunit_ctl = {
2036 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2037 .name = "", /* will be filled later */
2038 .info = mixer_ctl_selector_info,
2039 .get = mixer_ctl_selector_get,
2040 .put = mixer_ctl_selector_put,
2041 };
2042
2043 /*
2044 * private free callback.
2045 * free both private_data and private_value
2046 */
2047 static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2048 {
2049 int i, num_ins = 0;
2050
2051 if (kctl->private_data) {
2052 struct usb_mixer_elem_info *cval = kctl->private_data;
2053 num_ins = cval->max;
2054 kfree(cval);
2055 kctl->private_data = NULL;
2056 }
2057 if (kctl->private_value) {
2058 char **itemlist = (char **)kctl->private_value;
2059 for (i = 0; i < num_ins; i++)
2060 kfree(itemlist[i]);
2061 kfree(itemlist);
2062 kctl->private_value = 0;
2063 }
2064 }
2065
2066 /*
2067 * parse a selector unit
2068 */
2069 static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2070 void *raw_desc)
2071 {
2072 struct uac_selector_unit_descriptor *desc = raw_desc;
2073 unsigned int i, nameid, len;
2074 int err;
2075 struct usb_mixer_elem_info *cval;
2076 struct snd_kcontrol *kctl;
2077 const struct usbmix_name_map *map;
2078 char **namelist;
2079
2080 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
2081 usb_audio_err(state->chip,
2082 "invalid SELECTOR UNIT descriptor %d\n", unitid);
2083 return -EINVAL;
2084 }
2085
2086 for (i = 0; i < desc->bNrInPins; i++) {
2087 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
2088 return err;
2089 }
2090
2091 if (desc->bNrInPins == 1) /* only one ? nonsense! */
2092 return 0;
2093
2094 map = find_map(state, unitid, 0);
2095 if (check_ignored_ctl(map))
2096 return 0;
2097
2098 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2099 if (!cval)
2100 return -ENOMEM;
2101 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2102 cval->val_type = USB_MIXER_U8;
2103 cval->channels = 1;
2104 cval->min = 1;
2105 cval->max = desc->bNrInPins;
2106 cval->res = 1;
2107 cval->initialized = 1;
2108
2109 if (state->mixer->protocol == UAC_VERSION_1)
2110 cval->control = 0;
2111 else /* UAC_VERSION_2 */
2112 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2113 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
2114
2115 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
2116 if (!namelist) {
2117 kfree(cval);
2118 return -ENOMEM;
2119 }
2120 #define MAX_ITEM_NAME_LEN 64
2121 for (i = 0; i < desc->bNrInPins; i++) {
2122 struct usb_audio_term iterm;
2123 len = 0;
2124 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2125 if (!namelist[i]) {
2126 while (i--)
2127 kfree(namelist[i]);
2128 kfree(namelist);
2129 kfree(cval);
2130 return -ENOMEM;
2131 }
2132 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2133 MAX_ITEM_NAME_LEN);
2134 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2135 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2136 if (! len)
2137 sprintf(namelist[i], "Input %u", i);
2138 }
2139
2140 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2141 if (! kctl) {
2142 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2143 kfree(namelist);
2144 kfree(cval);
2145 return -ENOMEM;
2146 }
2147 kctl->private_value = (unsigned long)namelist;
2148 kctl->private_free = usb_mixer_selector_elem_free;
2149
2150 nameid = uac_selector_unit_iSelector(desc);
2151 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2152 if (len)
2153 ;
2154 else if (nameid)
2155 snd_usb_copy_string_desc(state, nameid, kctl->id.name,
2156 sizeof(kctl->id.name));
2157 else {
2158 len = get_term_name(state, &state->oterm,
2159 kctl->id.name, sizeof(kctl->id.name), 0);
2160 if (!len)
2161 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2162
2163 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2164 append_ctl_name(kctl, " Clock Source");
2165 else if ((state->oterm.type & 0xff00) == 0x0100)
2166 append_ctl_name(kctl, " Capture Source");
2167 else
2168 append_ctl_name(kctl, " Playback Source");
2169 }
2170
2171 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2172 cval->head.id, kctl->id.name, desc->bNrInPins);
2173 return snd_usb_mixer_add_control(&cval->head, kctl);
2174 }
2175
2176 /*
2177 * parse an audio unit recursively
2178 */
2179
2180 static int parse_audio_unit(struct mixer_build *state, int unitid)
2181 {
2182 unsigned char *p1;
2183
2184 if (test_and_set_bit(unitid, state->unitbitmap))
2185 return 0; /* the unit already visited */
2186
2187 p1 = find_audio_control_unit(state, unitid);
2188 if (!p1) {
2189 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2190 return -EINVAL;
2191 }
2192
2193 switch (p1[2]) {
2194 case UAC_INPUT_TERMINAL:
2195 return 0; /* NOP */
2196 case UAC_MIXER_UNIT:
2197 return parse_audio_mixer_unit(state, unitid, p1);
2198 case UAC2_CLOCK_SOURCE:
2199 return parse_clock_source_unit(state, unitid, p1);
2200 case UAC_SELECTOR_UNIT:
2201 case UAC2_CLOCK_SELECTOR:
2202 return parse_audio_selector_unit(state, unitid, p1);
2203 case UAC_FEATURE_UNIT:
2204 return parse_audio_feature_unit(state, unitid, p1);
2205 case UAC1_PROCESSING_UNIT:
2206 /* UAC2_EFFECT_UNIT has the same value */
2207 if (state->mixer->protocol == UAC_VERSION_1)
2208 return parse_audio_processing_unit(state, unitid, p1);
2209 else
2210 return 0; /* FIXME - effect units not implemented yet */
2211 case UAC1_EXTENSION_UNIT:
2212 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2213 if (state->mixer->protocol == UAC_VERSION_1)
2214 return parse_audio_extension_unit(state, unitid, p1);
2215 else /* UAC_VERSION_2 */
2216 return parse_audio_processing_unit(state, unitid, p1);
2217 case UAC2_EXTENSION_UNIT_V2:
2218 return parse_audio_extension_unit(state, unitid, p1);
2219 default:
2220 usb_audio_err(state->chip,
2221 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2222 return -EINVAL;
2223 }
2224 }
2225
2226 static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2227 {
2228 kfree(mixer->id_elems);
2229 if (mixer->urb) {
2230 kfree(mixer->urb->transfer_buffer);
2231 usb_free_urb(mixer->urb);
2232 }
2233 usb_free_urb(mixer->rc_urb);
2234 kfree(mixer->rc_setup_packet);
2235 kfree(mixer);
2236 }
2237
2238 static int snd_usb_mixer_dev_free(struct snd_device *device)
2239 {
2240 struct usb_mixer_interface *mixer = device->device_data;
2241 snd_usb_mixer_free(mixer);
2242 return 0;
2243 }
2244
2245 /*
2246 * create mixer controls
2247 *
2248 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
2249 */
2250 static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
2251 {
2252 struct mixer_build state;
2253 int err;
2254 const struct usbmix_ctl_map *map;
2255 void *p;
2256
2257 memset(&state, 0, sizeof(state));
2258 state.chip = mixer->chip;
2259 state.mixer = mixer;
2260 state.buffer = mixer->hostif->extra;
2261 state.buflen = mixer->hostif->extralen;
2262
2263 /* check the mapping table */
2264 for (map = usbmix_ctl_maps; map->id; map++) {
2265 if (map->id == state.chip->usb_id) {
2266 state.map = map->map;
2267 state.selector_map = map->selector_map;
2268 mixer->ignore_ctl_error = map->ignore_ctl_error;
2269 break;
2270 }
2271 }
2272
2273 p = NULL;
2274 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2275 mixer->hostif->extralen,
2276 p, UAC_OUTPUT_TERMINAL)) != NULL) {
2277 if (mixer->protocol == UAC_VERSION_1) {
2278 struct uac1_output_terminal_descriptor *desc = p;
2279
2280 if (desc->bLength < sizeof(*desc))
2281 continue; /* invalid descriptor? */
2282 /* mark terminal ID as visited */
2283 set_bit(desc->bTerminalID, state.unitbitmap);
2284 state.oterm.id = desc->bTerminalID;
2285 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2286 state.oterm.name = desc->iTerminal;
2287 err = parse_audio_unit(&state, desc->bSourceID);
2288 if (err < 0 && err != -EINVAL)
2289 return err;
2290 } else { /* UAC_VERSION_2 */
2291 struct uac2_output_terminal_descriptor *desc = p;
2292
2293 if (desc->bLength < sizeof(*desc))
2294 continue; /* invalid descriptor? */
2295 /* mark terminal ID as visited */
2296 set_bit(desc->bTerminalID, state.unitbitmap);
2297 state.oterm.id = desc->bTerminalID;
2298 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2299 state.oterm.name = desc->iTerminal;
2300 err = parse_audio_unit(&state, desc->bSourceID);
2301 if (err < 0 && err != -EINVAL)
2302 return err;
2303
2304 /*
2305 * For UAC2, use the same approach to also add the
2306 * clock selectors
2307 */
2308 err = parse_audio_unit(&state, desc->bCSourceID);
2309 if (err < 0 && err != -EINVAL)
2310 return err;
2311 }
2312 }
2313
2314 return 0;
2315 }
2316
2317 void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
2318 {
2319 struct usb_mixer_elem_list *list;
2320
2321 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2322 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2323 &list->kctl->id);
2324 }
2325
2326 static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2327 struct usb_mixer_elem_list *list)
2328 {
2329 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2330 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2331 "S8", "U8", "S16", "U16"};
2332 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2333 "channels=%i, type=\"%s\"\n", cval->head.id,
2334 cval->control, cval->cmask, cval->channels,
2335 val_types[cval->val_type]);
2336 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2337 cval->min, cval->max, cval->dBmin, cval->dBmax);
2338 }
2339
2340 static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2341 struct snd_info_buffer *buffer)
2342 {
2343 struct snd_usb_audio *chip = entry->private_data;
2344 struct usb_mixer_interface *mixer;
2345 struct usb_mixer_elem_list *list;
2346 int unitid;
2347
2348 list_for_each_entry(mixer, &chip->mixer_list, list) {
2349 snd_iprintf(buffer,
2350 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2351 chip->usb_id, snd_usb_ctrl_intf(chip),
2352 mixer->ignore_ctl_error);
2353 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2354 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2355 for (list = mixer->id_elems[unitid]; list;
2356 list = list->next_id_elem) {
2357 snd_iprintf(buffer, " Unit: %i\n", list->id);
2358 if (list->kctl)
2359 snd_iprintf(buffer,
2360 " Control: name=\"%s\", index=%i\n",
2361 list->kctl->id.name,
2362 list->kctl->id.index);
2363 if (list->dump)
2364 list->dump(buffer, list);
2365 }
2366 }
2367 }
2368 }
2369
2370 static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2371 int attribute, int value, int index)
2372 {
2373 struct usb_mixer_elem_list *list;
2374 __u8 unitid = (index >> 8) & 0xff;
2375 __u8 control = (value >> 8) & 0xff;
2376 __u8 channel = value & 0xff;
2377 unsigned int count = 0;
2378
2379 if (channel >= MAX_CHANNELS) {
2380 usb_audio_dbg(mixer->chip,
2381 "%s(): bogus channel number %d\n",
2382 __func__, channel);
2383 return;
2384 }
2385
2386 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2387 count++;
2388
2389 if (count == 0)
2390 return;
2391
2392 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2393 struct usb_mixer_elem_info *info;
2394
2395 if (!list->kctl)
2396 continue;
2397
2398 info = (struct usb_mixer_elem_info *)list;
2399 if (count > 1 && info->control != control)
2400 continue;
2401
2402 switch (attribute) {
2403 case UAC2_CS_CUR:
2404 /* invalidate cache, so the value is read from the device */
2405 if (channel)
2406 info->cached &= ~(1 << channel);
2407 else /* master channel */
2408 info->cached = 0;
2409
2410 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2411 &info->head.kctl->id);
2412 break;
2413
2414 case UAC2_CS_RANGE:
2415 /* TODO */
2416 break;
2417
2418 case UAC2_CS_MEM:
2419 /* TODO */
2420 break;
2421
2422 default:
2423 usb_audio_dbg(mixer->chip,
2424 "unknown attribute %d in interrupt\n",
2425 attribute);
2426 break;
2427 } /* switch */
2428 }
2429 }
2430
2431 static void snd_usb_mixer_interrupt(struct urb *urb)
2432 {
2433 struct usb_mixer_interface *mixer = urb->context;
2434 int len = urb->actual_length;
2435 int ustatus = urb->status;
2436
2437 if (ustatus != 0)
2438 goto requeue;
2439
2440 if (mixer->protocol == UAC_VERSION_1) {
2441 struct uac1_status_word *status;
2442
2443 for (status = urb->transfer_buffer;
2444 len >= sizeof(*status);
2445 len -= sizeof(*status), status++) {
2446 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
2447 status->bStatusType,
2448 status->bOriginator);
2449
2450 /* ignore any notifications not from the control interface */
2451 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2452 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2453 continue;
2454
2455 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2456 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2457 else
2458 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2459 }
2460 } else { /* UAC_VERSION_2 */
2461 struct uac2_interrupt_data_msg *msg;
2462
2463 for (msg = urb->transfer_buffer;
2464 len >= sizeof(*msg);
2465 len -= sizeof(*msg), msg++) {
2466 /* drop vendor specific and endpoint requests */
2467 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2468 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2469 continue;
2470
2471 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2472 le16_to_cpu(msg->wValue),
2473 le16_to_cpu(msg->wIndex));
2474 }
2475 }
2476
2477 requeue:
2478 if (ustatus != -ENOENT &&
2479 ustatus != -ECONNRESET &&
2480 ustatus != -ESHUTDOWN) {
2481 urb->dev = mixer->chip->dev;
2482 usb_submit_urb(urb, GFP_ATOMIC);
2483 }
2484 }
2485
2486 /* create the handler for the optional status interrupt endpoint */
2487 static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2488 {
2489 struct usb_endpoint_descriptor *ep;
2490 void *transfer_buffer;
2491 int buffer_length;
2492 unsigned int epnum;
2493
2494 /* we need one interrupt input endpoint */
2495 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
2496 return 0;
2497 ep = get_endpoint(mixer->hostif, 0);
2498 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2499 return 0;
2500
2501 epnum = usb_endpoint_num(ep);
2502 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2503 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2504 if (!transfer_buffer)
2505 return -ENOMEM;
2506 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2507 if (!mixer->urb) {
2508 kfree(transfer_buffer);
2509 return -ENOMEM;
2510 }
2511 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2512 usb_rcvintpipe(mixer->chip->dev, epnum),
2513 transfer_buffer, buffer_length,
2514 snd_usb_mixer_interrupt, mixer, ep->bInterval);
2515 usb_submit_urb(mixer->urb, GFP_KERNEL);
2516 return 0;
2517 }
2518
2519 int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2520 int ignore_error)
2521 {
2522 static struct snd_device_ops dev_ops = {
2523 .dev_free = snd_usb_mixer_dev_free
2524 };
2525 struct usb_mixer_interface *mixer;
2526 struct snd_info_entry *entry;
2527 int err;
2528
2529 strcpy(chip->card->mixername, "USB Mixer");
2530
2531 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2532 if (!mixer)
2533 return -ENOMEM;
2534 mixer->chip = chip;
2535 mixer->ignore_ctl_error = ignore_error;
2536 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2537 GFP_KERNEL);
2538 if (!mixer->id_elems) {
2539 kfree(mixer);
2540 return -ENOMEM;
2541 }
2542
2543 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2544 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
2545 case UAC_VERSION_1:
2546 default:
2547 mixer->protocol = UAC_VERSION_1;
2548 break;
2549 case UAC_VERSION_2:
2550 mixer->protocol = UAC_VERSION_2;
2551 break;
2552 }
2553
2554 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2555 (err = snd_usb_mixer_status_create(mixer)) < 0)
2556 goto _error;
2557
2558 snd_usb_mixer_apply_create_quirk(mixer);
2559
2560 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
2561 if (err < 0)
2562 goto _error;
2563
2564 if (list_empty(&chip->mixer_list) &&
2565 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2566 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2567
2568 list_add(&mixer->list, &chip->mixer_list);
2569 return 0;
2570
2571 _error:
2572 snd_usb_mixer_free(mixer);
2573 return err;
2574 }
2575
2576 void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
2577 {
2578 usb_kill_urb(mixer->urb);
2579 usb_kill_urb(mixer->rc_urb);
2580 }
2581
2582 #ifdef CONFIG_PM
2583 /* stop any bus activity of a mixer */
2584 static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2585 {
2586 usb_kill_urb(mixer->urb);
2587 usb_kill_urb(mixer->rc_urb);
2588 }
2589
2590 static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2591 {
2592 int err;
2593
2594 if (mixer->urb) {
2595 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2596 if (err < 0)
2597 return err;
2598 }
2599
2600 return 0;
2601 }
2602
2603 int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2604 {
2605 snd_usb_mixer_inactivate(mixer);
2606 return 0;
2607 }
2608
2609 static int restore_mixer_value(struct usb_mixer_elem_list *list)
2610 {
2611 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
2612 int c, err, idx;
2613
2614 if (cval->cmask) {
2615 idx = 0;
2616 for (c = 0; c < MAX_CHANNELS; c++) {
2617 if (!(cval->cmask & (1 << c)))
2618 continue;
2619 if (cval->cached & (1 << (c + 1))) {
2620 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
2621 cval->cache_val[idx]);
2622 if (err < 0)
2623 return err;
2624 }
2625 idx++;
2626 }
2627 } else {
2628 /* master */
2629 if (cval->cached) {
2630 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
2631 if (err < 0)
2632 return err;
2633 }
2634 }
2635
2636 return 0;
2637 }
2638
2639 int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2640 {
2641 struct usb_mixer_elem_list *list;
2642 int id, err;
2643
2644 if (reset_resume) {
2645 /* restore cached mixer values */
2646 for (id = 0; id < MAX_ID_ELEMS; id++) {
2647 for (list = mixer->id_elems[id]; list;
2648 list = list->next_id_elem) {
2649 if (list->resume) {
2650 err = list->resume(list);
2651 if (err < 0)
2652 return err;
2653 }
2654 }
2655 }
2656 }
2657
2658 return snd_usb_mixer_activate(mixer);
2659 }
2660 #endif
2661
2662 void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2663 struct usb_mixer_interface *mixer,
2664 int unitid)
2665 {
2666 list->mixer = mixer;
2667 list->id = unitid;
2668 list->dump = snd_usb_mixer_dump_cval;
2669 #ifdef CONFIG_PM
2670 list->resume = restore_mixer_value;
2671 #endif
2672 }