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