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