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