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