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