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