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