blob: e90daf8cdaa8726f8311092636461a9fee10b187 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Daniel Mack157a57b2010-06-16 17:57:30 +020029/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#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>
Daniel Mack28e1b772010-02-22 23:49:09 +010051#include <linux/usb/audio.h>
Daniel Mack23caaf12010-03-11 21:13:25 +010052#include <linux/usb/audio-v2.h>
Daniel Mack28e1b772010-02-22 23:49:09 +010053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <sound/core.h>
55#include <sound/control.h>
Clemens Ladischb259b102005-04-29 16:29:28 +020056#include <sound/hwdep.h>
Clemens Ladischaafad562005-05-10 14:47:38 +020057#include <sound/info.h>
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +020058#include <sound/tlv.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60#include "usbaudio.h"
Daniel Mackf0b5e632010-03-11 21:13:23 +010061#include "mixer.h"
Daniel Macke5779992010-03-04 19:46:13 +010062#include "helper.h"
Daniel Mack7b1eda22010-03-11 21:13:22 +010063#include "mixer_quirks.h"
Oliver Neukum88a85162011-03-11 14:51:12 +010064#include "power.h"
Raimonds Cicans4d1a70d2006-05-05 09:49:53 +020065
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +010066#define MAX_ID_ELEMS 256
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068struct usb_audio_term {
69 int id;
70 int type;
71 int channels;
72 unsigned int chconfig;
73 int name;
74};
75
76struct usbmix_name_map;
77
Takashi Iwai86e07d32005-11-17 15:08:02 +010078struct mixer_build {
79 struct snd_usb_audio *chip;
Clemens Ladisch84957a82005-04-29 16:23:13 +020080 struct usb_mixer_interface *mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 unsigned char *buffer;
82 unsigned int buflen;
Jaroslav Kysela291186e2010-02-16 11:55:18 +010083 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
Takashi Iwai86e07d32005-11-17 15:08:02 +010084 struct usb_audio_term oterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 const struct usbmix_name_map *map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +020086 const struct usbmix_selector_map *selector_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087};
88
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -050089/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -080090enum {
91 USB_XU_CLOCK_RATE = 0xe301,
92 USB_XU_CLOCK_SOURCE = 0xe302,
93 USB_XU_DIGITAL_IO_STATUS = 0xe303,
94 USB_XU_DEVICE_OPTIONS = 0xe304,
95 USB_XU_DIRECT_MONITORING = 0xe305,
96 USB_XU_METERING = 0xe306
97};
98enum {
99 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
100 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
101 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
102 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
103};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105/*
106 * manual mapping of mixer names
107 * if the mixer topology is too complicated and the parsed names are
108 * ambiguous, add the entries in usbmixer_maps.c.
109 */
Daniel Mackf0b5e632010-03-11 21:13:23 +0100110#include "mixer_maps.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100112static const struct usbmix_name_map *
113find_map(struct mixer_build *state, int unitid, int control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100115 const struct usbmix_name_map *p = state->map;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100117 if (!p)
118 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 for (p = state->map; p->id; p++) {
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100121 if (p->id == unitid &&
122 (!control || !p->control || control == p->control))
123 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100125 return NULL;
126}
127
128/* get the mapped name if the unit matches */
129static int
130check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
131{
132 if (!p || !p->name)
133 return 0;
134
135 buflen--;
136 return strlcpy(buf, p->name, buflen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137}
138
139/* check whether the control should be ignored */
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100140static inline int
141check_ignored_ctl(const struct usbmix_name_map *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100143 if (!p || p->name || p->dB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 return 0;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100145 return 1;
146}
147
148/* dB mapping */
149static inline void check_mapped_dB(const struct usbmix_name_map *p,
150 struct usb_mixer_elem_info *cval)
151{
152 if (p && p->dB) {
153 cval->dBmin = p->dB->min;
154 cval->dBmax = p->dB->max;
Takashi Iwai38b65192011-08-19 07:55:10 +0200155 cval->initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200159/* get the mapped selector source name */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100160static int check_mapped_selector_name(struct mixer_build *state, int unitid,
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200161 int index, char *buf, int buflen)
162{
163 const struct usbmix_selector_map *p;
164
165 if (! state->selector_map)
166 return 0;
167 for (p = state->selector_map; p->id; p++) {
168 if (p->id == unitid && index < p->count)
169 return strlcpy(buf, p->names[index], buflen);
170 }
171 return 0;
172}
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174/*
175 * find an audio control unit with the given unit id
176 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100177static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178{
Daniel Mack67e1daa2010-05-31 13:35:43 +0200179 /* we just parse the header */
180 struct uac_feature_unit_descriptor *hdr = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Daniel Mack67e1daa2010-05-31 13:35:43 +0200182 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
183 USB_DT_CS_INTERFACE)) != NULL) {
184 if (hdr->bLength >= 4 &&
185 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
186 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
187 hdr->bUnitID == unit)
188 return hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 }
Daniel Mack67e1daa2010-05-31 13:35:43 +0200190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 return NULL;
192}
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194/*
195 * copy a string with the given id
196 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100197static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198{
199 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
200 buf[len] = 0;
201 return len;
202}
203
204/*
205 * convert from the byte/word on usb descriptor to the zero-based integer
206 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100207static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 switch (cval->val_type) {
210 case USB_MIXER_BOOLEAN:
211 return !!val;
212 case USB_MIXER_INV_BOOLEAN:
213 return !val;
214 case USB_MIXER_U8:
215 val &= 0xff;
216 break;
217 case USB_MIXER_S8:
218 val &= 0xff;
219 if (val >= 0x80)
220 val -= 0x100;
221 break;
222 case USB_MIXER_U16:
223 val &= 0xffff;
224 break;
225 case USB_MIXER_S16:
226 val &= 0xffff;
227 if (val >= 0x8000)
228 val -= 0x10000;
229 break;
230 }
231 return val;
232}
233
234/*
235 * convert from the zero-based int to the byte/word for usb descriptor
236 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100237static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
239 switch (cval->val_type) {
240 case USB_MIXER_BOOLEAN:
241 return !!val;
242 case USB_MIXER_INV_BOOLEAN:
243 return !val;
244 case USB_MIXER_S8:
245 case USB_MIXER_U8:
246 return val & 0xff;
247 case USB_MIXER_S16:
248 case USB_MIXER_U16:
249 return val & 0xffff;
250 }
251 return 0; /* not reached */
252}
253
Takashi Iwai86e07d32005-11-17 15:08:02 +0100254static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255{
256 if (! cval->res)
257 cval->res = 1;
258 if (val < cval->min)
259 return 0;
Takashi Iwai14790f12006-03-28 17:58:28 +0200260 else if (val >= cval->max)
261 return (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 else
263 return (val - cval->min) / cval->res;
264}
265
Takashi Iwai86e07d32005-11-17 15:08:02 +0100266static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
268 if (val < 0)
269 return cval->min;
270 if (! cval->res)
271 cval->res = 1;
272 val *= cval->res;
273 val += cval->min;
274 if (val > cval->max)
275 return cval->max;
276 return val;
277}
278
279
280/*
281 * retrieve a mixer value
282 */
283
Daniel Mack23caaf12010-03-11 21:13:25 +0100284static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200286 struct snd_usb_audio *chip = cval->mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 unsigned char buf[2];
288 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
289 int timeout = 10;
Takashi Iwai978520b2012-10-12 15:12:55 +0200290 int idx = 0, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Oliver Neukum88a85162011-03-11 14:51:12 +0100292 err = snd_usb_autoresume(cval->mixer->chip);
293 if (err < 0)
294 return -EIO;
Takashi Iwai34f3c892012-10-15 12:16:02 +0200295 down_read(&chip->shutdown_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 while (timeout-- > 0) {
Takashi Iwai978520b2012-10-12 15:12:55 +0200297 if (chip->shutdown)
298 break;
299 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200300 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200302 validx, idx, buf, val_len) >= val_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
Takashi Iwai978520b2012-10-12 15:12:55 +0200304 err = 0;
305 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 }
307 }
Clemens Ladisch84957a82005-04-29 16:23:13 +0200308 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Takashi Iwai978520b2012-10-12 15:12:55 +0200309 request, validx, idx, cval->val_type);
310 err = -EINVAL;
311
312 out:
Takashi Iwai34f3c892012-10-15 12:16:02 +0200313 up_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200314 snd_usb_autosuspend(cval->mixer->chip);
315 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316}
317
Daniel Mack23caaf12010-03-11 21:13:25 +0100318static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
319{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200320 struct snd_usb_audio *chip = cval->mixer->chip;
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200321 unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */
Daniel Mack23caaf12010-03-11 21:13:25 +0100322 unsigned char *val;
Takashi Iwai978520b2012-10-12 15:12:55 +0200323 int idx = 0, ret, size;
Daniel Mack23caaf12010-03-11 21:13:25 +0100324 __u8 bRequest;
325
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200326 if (request == UAC_GET_CUR) {
327 bRequest = UAC2_CS_CUR;
328 size = sizeof(__u16);
329 } else {
330 bRequest = UAC2_CS_RANGE;
331 size = sizeof(buf);
332 }
333
334 memset(buf, 0, sizeof(buf));
Daniel Mack23caaf12010-03-11 21:13:25 +0100335
Oliver Neukum88a85162011-03-11 14:51:12 +0100336 ret = snd_usb_autoresume(chip) ? -EIO : 0;
337 if (ret)
338 goto error;
339
Takashi Iwai34f3c892012-10-15 12:16:02 +0200340 down_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200341 if (chip->shutdown)
342 ret = -ENODEV;
343 else {
344 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
345 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
Daniel Mack23caaf12010-03-11 21:13:25 +0100346 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200347 validx, idx, buf, size);
348 }
Takashi Iwai34f3c892012-10-15 12:16:02 +0200349 up_read(&chip->shutdown_rwsem);
Oliver Neukum88a85162011-03-11 14:51:12 +0100350 snd_usb_autosuspend(chip);
Daniel Mack23caaf12010-03-11 21:13:25 +0100351
352 if (ret < 0) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100353error:
Daniel Mack09414202010-05-31 13:35:44 +0200354 snd_printk(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Takashi Iwai978520b2012-10-12 15:12:55 +0200355 request, validx, idx, cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100356 return ret;
357 }
358
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200359 /* FIXME: how should we handle multiple triplets here? */
360
Daniel Mack23caaf12010-03-11 21:13:25 +0100361 switch (request) {
362 case UAC_GET_CUR:
363 val = buf;
364 break;
365 case UAC_GET_MIN:
366 val = buf + sizeof(__u16);
367 break;
368 case UAC_GET_MAX:
369 val = buf + sizeof(__u16) * 2;
370 break;
371 case UAC_GET_RES:
372 val = buf + sizeof(__u16) * 3;
373 break;
374 default:
375 return -EINVAL;
376 }
377
378 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
379
380 return 0;
381}
382
383static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
384{
Eldad Zack9f814102012-11-28 23:55:35 +0100385 validx += cval->idx_off;
386
Daniel Mack23caaf12010-03-11 21:13:25 +0100387 return (cval->mixer->protocol == UAC_VERSION_1) ?
388 get_ctl_value_v1(cval, request, validx, value_ret) :
389 get_ctl_value_v2(cval, request, validx, value_ret);
390}
391
Takashi Iwai86e07d32005-11-17 15:08:02 +0100392static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100394 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395}
396
397/* channel = 0: master, 1 = first channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100398static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
399 int channel, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100401 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402}
403
Takashi Iwai641b4872009-01-15 17:05:24 +0100404static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
405 int channel, int index, int *value)
406{
407 int err;
408
409 if (cval->cached & (1 << channel)) {
410 *value = cval->cache_val[index];
411 return 0;
412 }
413 err = get_cur_mix_raw(cval, channel, value);
414 if (err < 0) {
415 if (!cval->mixer->ignore_ctl_error)
Daniel Mack23caaf12010-03-11 21:13:25 +0100416 snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
Takashi Iwai641b4872009-01-15 17:05:24 +0100417 cval->control, channel, err);
418 return err;
419 }
420 cval->cached |= 1 << channel;
421 cval->cache_val[index] = *value;
422 return 0;
423}
424
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426/*
427 * set a mixer value
428 */
429
Daniel Mack7b1eda22010-03-11 21:13:22 +0100430int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
431 int request, int validx, int value_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200433 struct snd_usb_audio *chip = cval->mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 unsigned char buf[2];
Takashi Iwai978520b2012-10-12 15:12:55 +0200435 int idx = 0, val_len, err, timeout = 10;
Daniel Mack23caaf12010-03-11 21:13:25 +0100436
Eldad Zack9f814102012-11-28 23:55:35 +0100437 validx += cval->idx_off;
438
Daniel Mack23caaf12010-03-11 21:13:25 +0100439 if (cval->mixer->protocol == UAC_VERSION_1) {
440 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
441 } else { /* UAC_VERSION_2 */
442 /* audio class v2 controls are always 2 bytes in size */
443 val_len = sizeof(__u16);
444
445 /* FIXME */
446 if (request != UAC_SET_CUR) {
447 snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
448 return -EINVAL;
449 }
450
451 request = UAC2_CS_CUR;
452 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
454 value_set = convert_bytes_value(cval, value_set);
455 buf[0] = value_set & 0xff;
456 buf[1] = (value_set >> 8) & 0xff;
Oliver Neukum88a85162011-03-11 14:51:12 +0100457 err = snd_usb_autoresume(chip);
458 if (err < 0)
459 return -EIO;
Takashi Iwai34f3c892012-10-15 12:16:02 +0200460 down_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200461 while (timeout-- > 0) {
462 if (chip->shutdown)
463 break;
464 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200465 if (snd_usb_ctl_msg(chip->dev,
466 usb_sndctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
Takashi Iwai978520b2012-10-12 15:12:55 +0200468 validx, idx, buf, val_len) >= 0) {
469 err = 0;
470 goto out;
Oliver Neukum88a85162011-03-11 14:51:12 +0100471 }
Takashi Iwai978520b2012-10-12 15:12:55 +0200472 }
Clemens Ladisch84957a82005-04-29 16:23:13 +0200473 snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
Takashi Iwai978520b2012-10-12 15:12:55 +0200474 request, validx, idx, cval->val_type, buf[0], buf[1]);
475 err = -EINVAL;
476
477 out:
Takashi Iwai34f3c892012-10-15 12:16:02 +0200478 up_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200479 snd_usb_autosuspend(chip);
480 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481}
482
Takashi Iwai86e07d32005-11-17 15:08:02 +0100483static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
Daniel Mack7b1eda22010-03-11 21:13:22 +0100485 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
Takashi Iwai641b4872009-01-15 17:05:24 +0100488static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
489 int index, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Takashi Iwai641b4872009-01-15 17:05:24 +0100491 int err;
Daniel Macka6a33252010-05-31 13:35:37 +0200492 unsigned int read_only = (channel == 0) ?
493 cval->master_readonly :
494 cval->ch_readonly & (1 << (channel - 1));
495
496 if (read_only) {
497 snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
498 __func__, channel, cval->control);
499 return 0;
500 }
501
Daniel Mack7b1eda22010-03-11 21:13:22 +0100502 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
Takashi Iwai641b4872009-01-15 17:05:24 +0100503 value);
504 if (err < 0)
505 return err;
506 cval->cached |= 1 << channel;
507 cval->cache_val[index] = value;
508 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509}
510
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200511/*
512 * TLV callback for mixer volume controls
513 */
Felix Homann285de9c2012-04-23 20:24:24 +0200514int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200515 unsigned int size, unsigned int __user *_tlv)
516{
517 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Takashi Iwaib8e1c732009-06-16 14:04:37 +0200518 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200519
520 if (size < sizeof(scale))
521 return -ENOMEM;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100522 scale[2] = cval->dBmin;
523 scale[3] = cval->dBmax;
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200524 if (copy_to_user(_tlv, scale, sizeof(scale)))
525 return -EFAULT;
526 return 0;
527}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529/*
530 * parser routines begin here...
531 */
532
Takashi Iwai86e07d32005-11-17 15:08:02 +0100533static int parse_audio_unit(struct mixer_build *state, int unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
535
536/*
537 * check if the input/output channel routing is enabled on the given bitmap.
538 * used for mixer unit parser
539 */
540static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
541{
542 int idx = ich * num_outs + och;
543 return bmap[idx >> 3] & (0x80 >> (idx & 7));
544}
545
546
547/*
548 * add an alsa control element
549 * search and increment the index until an empty slot is found.
550 *
551 * if failed, give up and free the control instance.
552 */
553
Daniel Mackef9d5972011-05-25 09:09:00 +0200554int snd_usb_mixer_add_control(struct usb_mixer_interface *mixer,
555 struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100557 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200559
Daniel Mackef9d5972011-05-25 09:09:00 +0200560 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 kctl->id.index++;
Daniel Mackef9d5972011-05-25 09:09:00 +0200562 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200564 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200566 cval->elem_id = &kctl->id;
Daniel Mackef9d5972011-05-25 09:09:00 +0200567 cval->next_id_elem = mixer->id_elems[cval->id];
568 mixer->id_elems[cval->id] = cval;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200569 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570}
571
572
573/*
574 * get a terminal name string
575 */
576
577static struct iterm_name_combo {
578 int type;
579 char *name;
580} iterm_names[] = {
581 { 0x0300, "Output" },
582 { 0x0301, "Speaker" },
583 { 0x0302, "Headphone" },
584 { 0x0303, "HMD Audio" },
585 { 0x0304, "Desktop Speaker" },
586 { 0x0305, "Room Speaker" },
587 { 0x0306, "Com Speaker" },
588 { 0x0307, "LFE" },
589 { 0x0600, "External In" },
590 { 0x0601, "Analog In" },
591 { 0x0602, "Digital In" },
592 { 0x0603, "Line" },
593 { 0x0604, "Legacy In" },
594 { 0x0605, "IEC958 In" },
595 { 0x0606, "1394 DA Stream" },
596 { 0x0607, "1394 DV Stream" },
597 { 0x0700, "Embedded" },
598 { 0x0701, "Noise Source" },
599 { 0x0702, "Equalization Noise" },
600 { 0x0703, "CD" },
601 { 0x0704, "DAT" },
602 { 0x0705, "DCC" },
603 { 0x0706, "MiniDisk" },
604 { 0x0707, "Analog Tape" },
605 { 0x0708, "Phonograph" },
606 { 0x0709, "VCR Audio" },
607 { 0x070a, "Video Disk Audio" },
608 { 0x070b, "DVD Audio" },
609 { 0x070c, "TV Tuner Audio" },
610 { 0x070d, "Satellite Rec Audio" },
611 { 0x070e, "Cable Tuner Audio" },
612 { 0x070f, "DSS Audio" },
613 { 0x0710, "Radio Receiver" },
614 { 0x0711, "Radio Transmitter" },
615 { 0x0712, "Multi-Track Recorder" },
616 { 0x0713, "Synthesizer" },
617 { 0 },
618};
619
Takashi Iwai86e07d32005-11-17 15:08:02 +0100620static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 unsigned char *name, int maxlen, int term_only)
622{
623 struct iterm_name_combo *names;
624
625 if (iterm->name)
626 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
627
628 /* virtual type - not a real terminal */
629 if (iterm->type >> 16) {
630 if (term_only)
631 return 0;
632 switch (iterm->type >> 16) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100633 case UAC_SELECTOR_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 strcpy(name, "Selector"); return 8;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200635 case UAC1_PROCESSING_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 strcpy(name, "Process Unit"); return 12;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200637 case UAC1_EXTENSION_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 strcpy(name, "Ext Unit"); return 8;
Daniel Mackde48c7b2010-02-22 23:49:13 +0100639 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 strcpy(name, "Mixer"); return 5;
641 default:
642 return sprintf(name, "Unit %d", iterm->id);
643 }
644 }
645
646 switch (iterm->type & 0xff00) {
647 case 0x0100:
648 strcpy(name, "PCM"); return 3;
649 case 0x0200:
650 strcpy(name, "Mic"); return 3;
651 case 0x0400:
652 strcpy(name, "Headset"); return 7;
653 case 0x0500:
654 strcpy(name, "Phone"); return 5;
655 }
656
657 for (names = iterm_names; names->type; names++)
658 if (names->type == iterm->type) {
659 strcpy(name, names->name);
660 return strlen(names->name);
661 }
662 return 0;
663}
664
665
666/*
667 * parse the source unit recursively until it reaches to a terminal
668 * or a branched unit.
669 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100670static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671{
Daniel Mack09414202010-05-31 13:35:44 +0200672 int err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100673 void *p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 memset(term, 0, sizeof(*term));
676 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100677 unsigned char *hdr = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100679 switch (hdr[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100680 case UAC_INPUT_TERMINAL:
Daniel Mack23caaf12010-03-11 21:13:25 +0100681 if (state->mixer->protocol == UAC_VERSION_1) {
682 struct uac_input_terminal_descriptor *d = p1;
683 term->type = le16_to_cpu(d->wTerminalType);
684 term->channels = d->bNrChannels;
685 term->chconfig = le16_to_cpu(d->wChannelConfig);
686 term->name = d->iTerminal;
687 } else { /* UAC_VERSION_2 */
688 struct uac2_input_terminal_descriptor *d = p1;
689 term->type = le16_to_cpu(d->wTerminalType);
690 term->channels = d->bNrChannels;
691 term->chconfig = le32_to_cpu(d->bmChannelConfig);
692 term->name = d->iTerminal;
Daniel Mack09414202010-05-31 13:35:44 +0200693
694 /* call recursively to get the clock selectors */
695 err = check_input_term(state, d->bCSourceID, term);
696 if (err < 0)
697 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100700 case UAC_FEATURE_UNIT: {
701 /* the header is the same for v1 and v2 */
702 struct uac_feature_unit_descriptor *d = p1;
Daniel Mack5e688882010-05-08 11:24:56 +0200703 id = d->bSourceID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 break; /* continue to parse */
Daniel Mack23caaf12010-03-11 21:13:25 +0100705 }
706 case UAC_MIXER_UNIT: {
707 struct uac_mixer_unit_descriptor *d = p1;
708 term->type = d->bDescriptorSubtype << 16; /* virtual type */
709 term->channels = uac_mixer_unit_bNrChannels(d);
710 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
711 term->name = uac_mixer_unit_iMixer(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100713 }
Daniel Mack09414202010-05-31 13:35:44 +0200714 case UAC_SELECTOR_UNIT:
715 case UAC2_CLOCK_SELECTOR: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100716 struct uac_selector_unit_descriptor *d = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 /* call recursively to retrieve the channel info */
Daniel Mack23caaf12010-03-11 21:13:25 +0100718 if (check_input_term(state, d->baSourceID[0], term) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 return -ENODEV;
Daniel Mack23caaf12010-03-11 21:13:25 +0100720 term->type = d->bDescriptorSubtype << 16; /* virtual type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100722 term->name = uac_selector_unit_iSelector(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100724 }
Daniel Mack69da9bc2010-06-16 17:57:28 +0200725 case UAC1_PROCESSING_UNIT:
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100726 case UAC1_EXTENSION_UNIT:
727 /* UAC2_PROCESSING_UNIT_V2 */
728 /* UAC2_EFFECT_UNIT */ {
Daniel Mack23caaf12010-03-11 21:13:25 +0100729 struct uac_processing_unit_descriptor *d = p1;
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100730
731 if (state->mixer->protocol == UAC_VERSION_2 &&
732 hdr[2] == UAC2_EFFECT_UNIT) {
733 /* UAC2/UAC1 unit IDs overlap here in an
734 * uncompatible way. Ignore this unit for now.
735 */
736 return 0;
737 }
738
Daniel Mack23caaf12010-03-11 21:13:25 +0100739 if (d->bNrInPins) {
740 id = d->baSourceID[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 break; /* continue to parse */
742 }
Daniel Mack23caaf12010-03-11 21:13:25 +0100743 term->type = d->bDescriptorSubtype << 16; /* virtual type */
744 term->channels = uac_processing_unit_bNrChannels(d);
745 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
746 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100748 }
Daniel Mack09414202010-05-31 13:35:44 +0200749 case UAC2_CLOCK_SOURCE: {
750 struct uac_clock_source_descriptor *d = p1;
751 term->type = d->bDescriptorSubtype << 16; /* virtual type */
752 term->id = id;
753 term->name = d->iClockSource;
754 return 0;
755 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 default:
757 return -ENODEV;
758 }
759 }
760 return -ENODEV;
761}
762
763
764/*
765 * Feature Unit
766 */
767
768/* feature unit control information */
769struct usb_feature_control_info {
770 const char *name;
771 unsigned int type; /* control type (mute, volume, etc.) */
772};
773
774static struct usb_feature_control_info audio_feature_info[] = {
Daniel Mack2e0281d2010-05-31 13:35:42 +0200775 { "Mute", USB_MIXER_INV_BOOLEAN },
776 { "Volume", USB_MIXER_S16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 { "Tone Control - Bass", USB_MIXER_S8 },
778 { "Tone Control - Mid", USB_MIXER_S8 },
779 { "Tone Control - Treble", USB_MIXER_S8 },
780 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
Daniel Mack2e0281d2010-05-31 13:35:42 +0200781 { "Auto Gain Control", USB_MIXER_BOOLEAN },
782 { "Delay Control", USB_MIXER_U16 },
783 { "Bass Boost", USB_MIXER_BOOLEAN },
784 { "Loudness", USB_MIXER_BOOLEAN },
785 /* UAC2 specific */
786 { "Input Gain Control", USB_MIXER_U16 },
787 { "Input Gain Pad Control", USB_MIXER_BOOLEAN },
788 { "Phase Inverter Control", USB_MIXER_BOOLEAN },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789};
790
791
792/* private_free callback */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100793static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
Jesper Juhl4d572772005-05-30 17:30:32 +0200795 kfree(kctl->private_data);
796 kctl->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797}
798
799
800/*
801 * interface to ALSA control for feature/mixer units
802 */
803
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100804/* volume control quirks */
805static void volume_control_quirks(struct usb_mixer_elem_info *cval,
806 struct snd_kcontrol *kctl)
807{
808 switch (cval->mixer->chip->usb_id) {
Eldad Zackd50ed622012-11-28 23:55:39 +0100809 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
810 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
811 cval->min = 0x0000;
812 cval->max = 0xffff;
813 cval->res = 0x00e6;
814 break;
815 }
816 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
817 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
818 cval->min = 0x00;
819 cval->max = 0xff;
820 break;
821 }
822 if (strstr(kctl->id.name, "Effect Return") != NULL) {
823 cval->min = 0xb706;
824 cval->max = 0xff7b;
825 cval->res = 0x0073;
826 break;
827 }
828 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
829 (strstr(kctl->id.name, "Effect Send") != NULL)) {
830 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
831 cval->max = 0xfcfe;
832 cval->res = 0x0073;
833 }
834 break;
835
Felix Homannd34bf142012-04-23 20:24:27 +0200836 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
837 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
838 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
839 snd_printk(KERN_INFO
840 "usb-audio: set quirk for FTU Effect Duration\n");
841 cval->min = 0x0000;
842 cval->max = 0x7f00;
843 cval->res = 0x0100;
844 break;
845 }
846 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
847 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
848 snd_printk(KERN_INFO
849 "usb-audio: set quirks for FTU Effect Feedback/Volume\n");
850 cval->min = 0x00;
851 cval->max = 0x7f;
852 break;
853 }
854 break;
855
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100856 case USB_ID(0x0471, 0x0101):
857 case USB_ID(0x0471, 0x0104):
858 case USB_ID(0x0471, 0x0105):
859 case USB_ID(0x0672, 0x1041):
860 /* quirk for UDA1321/N101.
861 * note that detection between firmware 2.1.1.7 (N101)
862 * and later 2.1.1.21 is not very clear from datasheets.
863 * I hope that the min value is -15360 for newer firmware --jk
864 */
865 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
866 cval->min == -15616) {
867 snd_printk(KERN_INFO
868 "set volume quirk for UDA1321/N101 chip\n");
869 cval->max = -256;
870 }
871 break;
872
873 case USB_ID(0x046d, 0x09a4):
874 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
875 snd_printk(KERN_INFO
876 "set volume quirk for QuickCam E3500\n");
877 cval->min = 6080;
878 cval->max = 8768;
879 cval->res = 192;
880 }
881 break;
882
883 case USB_ID(0x046d, 0x0808):
884 case USB_ID(0x046d, 0x0809):
Alexey Fisher55c00082011-11-09 11:39:24 +0100885 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100886 case USB_ID(0x046d, 0x0991):
887 /* Most audio usb devices lie about volume resolution.
888 * Most Logitech webcams have res = 384.
889 * Proboly there is some logitech magic behind this number --fishor
890 */
891 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
892 snd_printk(KERN_INFO
893 "set resolution quirk: cval->res = 384\n");
894 cval->res = 384;
895 }
896 break;
897
898 }
899}
900
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901/*
902 * retrieve the minimum and maximum values for the specified control
903 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100904static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
905 int default_min, struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906{
907 /* for failsafe */
908 cval->min = default_min;
909 cval->max = cval->min + 1;
910 cval->res = 1;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100911 cval->dBmin = cval->dBmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
913 if (cval->val_type == USB_MIXER_BOOLEAN ||
914 cval->val_type == USB_MIXER_INV_BOOLEAN) {
915 cval->initialized = 1;
916 } else {
917 int minchn = 0;
918 if (cval->cmask) {
919 int i;
920 for (i = 0; i < MAX_CHANNELS; i++)
921 if (cval->cmask & (1 << i)) {
922 minchn = i + 1;
923 break;
924 }
925 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100926 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
927 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +0200928 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
Takashi Iwai1a4e34e2010-09-16 07:42:34 +0200929 cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 return -EINVAL;
931 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100932 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 cval->res = 1;
934 } else {
935 int last_valid_res = cval->res;
936
937 while (cval->res > 1) {
Daniel Mack7b1eda22010-03-11 21:13:22 +0100938 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
939 (cval->control << 8) | minchn, cval->res / 2) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 break;
941 cval->res /= 2;
942 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100943 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 cval->res = last_valid_res;
945 }
946 if (cval->res == 0)
947 cval->res = 1;
Takashi Iwai14790f12006-03-28 17:58:28 +0200948
949 /* Additional checks for the proper resolution
950 *
951 * Some devices report smaller resolutions than actually
952 * reacting. They don't return errors but simply clip
953 * to the lower aligned value.
954 */
955 if (cval->min + cval->res < cval->max) {
956 int last_valid_res = cval->res;
957 int saved, test, check;
Takashi Iwai641b4872009-01-15 17:05:24 +0100958 get_cur_mix_raw(cval, minchn, &saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200959 for (;;) {
960 test = saved;
961 if (test < cval->max)
962 test += cval->res;
963 else
964 test -= cval->res;
965 if (test < cval->min || test > cval->max ||
Takashi Iwai641b4872009-01-15 17:05:24 +0100966 set_cur_mix_value(cval, minchn, 0, test) ||
967 get_cur_mix_raw(cval, minchn, &check)) {
Takashi Iwai14790f12006-03-28 17:58:28 +0200968 cval->res = last_valid_res;
969 break;
970 }
971 if (test == check)
972 break;
973 cval->res *= 2;
974 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100975 set_cur_mix_value(cval, minchn, 0, saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200976 }
977
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 cval->initialized = 1;
979 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100980
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100981 if (kctl)
982 volume_control_quirks(cval, kctl);
983
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100984 /* USB descriptions contain the dB scale in 1/256 dB unit
985 * while ALSA TLV contains in 1/100 dB unit
986 */
987 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
988 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
989 if (cval->dBmin > cval->dBmax) {
990 /* something is wrong; assume it's either from/to 0dB */
991 if (cval->dBmin < 0)
992 cval->dBmax = 0;
993 else if (cval->dBmin > 0)
994 cval->dBmin = 0;
995 if (cval->dBmin > cval->dBmax) {
996 /* totally crap, return an error */
997 return -EINVAL;
998 }
999 }
1000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 return 0;
1002}
1003
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001004#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
1006/* get a feature/mixer unit info */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001007static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001009 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
1011 if (cval->val_type == USB_MIXER_BOOLEAN ||
1012 cval->val_type == USB_MIXER_INV_BOOLEAN)
1013 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1014 else
1015 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1016 uinfo->count = cval->channels;
1017 if (cval->val_type == USB_MIXER_BOOLEAN ||
1018 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1019 uinfo->value.integer.min = 0;
1020 uinfo->value.integer.max = 1;
1021 } else {
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001022 if (!cval->initialized) {
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001023 get_min_max_with_quirks(cval, 0, kcontrol);
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001024 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1025 kcontrol->vd[0].access &=
1026 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1027 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1028 snd_ctl_notify(cval->mixer->chip->card,
1029 SNDRV_CTL_EVENT_MASK_INFO,
1030 &kcontrol->id);
1031 }
1032 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 uinfo->value.integer.min = 0;
Takashi Iwai14790f12006-03-28 17:58:28 +02001034 uinfo->value.integer.max =
1035 (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 }
1037 return 0;
1038}
1039
1040/* get the current value from feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001041static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001043 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 int c, cnt, val, err;
1045
Takashi Iwai641b4872009-01-15 17:05:24 +01001046 ucontrol->value.integer.value[0] = cval->min;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 if (cval->cmask) {
1048 cnt = 0;
1049 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001050 if (!(cval->cmask & (1 << c)))
1051 continue;
1052 err = get_cur_mix_value(cval, c + 1, cnt, &val);
1053 if (err < 0)
1054 return cval->mixer->ignore_ctl_error ? 0 : err;
1055 val = get_relative_value(cval, val);
1056 ucontrol->value.integer.value[cnt] = val;
1057 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001059 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 } else {
1061 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +01001062 err = get_cur_mix_value(cval, 0, 0, &val);
1063 if (err < 0)
1064 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 val = get_relative_value(cval, val);
1066 ucontrol->value.integer.value[0] = val;
1067 }
1068 return 0;
1069}
1070
1071/* put the current value to feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001072static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001074 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 int c, cnt, val, oval, err;
1076 int changed = 0;
1077
1078 if (cval->cmask) {
1079 cnt = 0;
1080 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001081 if (!(cval->cmask & (1 << c)))
1082 continue;
1083 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
1084 if (err < 0)
1085 return cval->mixer->ignore_ctl_error ? 0 : err;
1086 val = ucontrol->value.integer.value[cnt];
1087 val = get_abs_value(cval, val);
1088 if (oval != val) {
1089 set_cur_mix_value(cval, c + 1, cnt, val);
1090 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001092 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
1094 } else {
1095 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +01001096 err = get_cur_mix_value(cval, 0, 0, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 if (err < 0)
Takashi Iwai641b4872009-01-15 17:05:24 +01001098 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 val = ucontrol->value.integer.value[0];
1100 val = get_abs_value(cval, val);
1101 if (val != oval) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001102 set_cur_mix_value(cval, 0, 0, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 changed = 1;
1104 }
1105 }
1106 return changed;
1107}
1108
Takashi Iwai86e07d32005-11-17 15:08:02 +01001109static struct snd_kcontrol_new usb_feature_unit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1111 .name = "", /* will be filled later manually */
1112 .info = mixer_ctl_feature_info,
1113 .get = mixer_ctl_feature_get,
1114 .put = mixer_ctl_feature_put,
1115};
1116
Daniel Mack23caaf12010-03-11 21:13:25 +01001117/* the read-only variant */
1118static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1119 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1120 .name = "", /* will be filled later manually */
1121 .info = mixer_ctl_feature_info,
1122 .get = mixer_ctl_feature_get,
1123 .put = NULL,
1124};
1125
Daniel Mack9e386582011-05-25 09:09:01 +02001126/* This symbol is exported in order to allow the mixer quirks to
1127 * hook up to the standard feature unit control mechanism */
1128struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
1130/*
1131 * build a feature control
1132 */
1133
Takashi Iwai08d1e632009-10-02 14:06:08 +02001134static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1135{
1136 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1137}
1138
David Henningsson9b4ef972012-11-23 13:48:55 +01001139/* A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1140 rename it to "Headphone". We determine if something is a headphone
1141 similar to how udev determines form factor. */
1142static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1143 struct snd_card *card)
1144{
1145 const char *names_to_check[] = {
1146 "Headset", "headset", "Headphone", "headphone", NULL};
1147 const char **s;
1148 bool found = 0;
1149
1150 if (strcmp("Speaker", kctl->id.name))
1151 return;
1152
1153 for (s = names_to_check; *s; s++)
1154 if (strstr(card->shortname, *s)) {
1155 found = 1;
1156 break;
1157 }
1158
1159 if (!found)
1160 return;
1161
1162 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1163}
1164
Daniel Mack99fc8642010-03-11 21:13:24 +01001165static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 unsigned int ctl_mask, int control,
Daniel Mack23caaf12010-03-11 21:13:25 +01001167 struct usb_audio_term *iterm, int unitid,
Daniel Macka6a33252010-05-31 13:35:37 +02001168 int readonly_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169{
Daniel Mack99fc8642010-03-11 21:13:24 +01001170 struct uac_feature_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 unsigned int len = 0;
1172 int mapped_name = 0;
Daniel Mack99fc8642010-03-11 21:13:24 +01001173 int nameid = uac_feature_unit_iFeature(desc);
Takashi Iwai86e07d32005-11-17 15:08:02 +01001174 struct snd_kcontrol *kctl;
1175 struct usb_mixer_elem_info *cval;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001176 const struct usbmix_name_map *map;
Alexey Fisher80aceff2011-03-10 14:53:38 +01001177 unsigned int range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
1179 control++; /* change from zero-based to 1-based value */
1180
Daniel Mack65f25da2010-05-31 13:35:41 +02001181 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 /* FIXME: not supported yet */
1183 return;
1184 }
1185
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001186 map = find_map(state, unitid, control);
1187 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 return;
1189
Takashi Iwai561b2202005-09-09 14:22:34 +02001190 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 if (! cval) {
1192 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1193 return;
1194 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001195 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 cval->id = unitid;
1197 cval->control = control;
1198 cval->cmask = ctl_mask;
1199 cval->val_type = audio_feature_info[control-1].type;
Daniel Macka6a33252010-05-31 13:35:37 +02001200 if (ctl_mask == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 cval->channels = 1; /* master channel */
Daniel Macka6a33252010-05-31 13:35:37 +02001202 cval->master_readonly = readonly_mask;
1203 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 int i, c = 0;
1205 for (i = 0; i < 16; i++)
1206 if (ctl_mask & (1 << i))
1207 c++;
1208 cval->channels = c;
Daniel Macka6a33252010-05-31 13:35:37 +02001209 cval->ch_readonly = readonly_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 }
1211
Daniel Macka6a33252010-05-31 13:35:37 +02001212 /* if all channels in the mask are marked read-only, make the control
1213 * read-only. set_cur_mix_value() will check the mask again and won't
1214 * issue write commands to read-only channels. */
1215 if (cval->channels == readonly_mask)
Daniel Mack23caaf12010-03-11 21:13:25 +01001216 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1217 else
1218 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1219
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 if (! kctl) {
1221 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1222 kfree(cval);
1223 return;
1224 }
1225 kctl->private_free = usb_mixer_elem_free;
1226
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001227 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 mapped_name = len != 0;
1229 if (! len && nameid)
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001230 len = snd_usb_copy_string_desc(state, nameid,
1231 kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
1233 switch (control) {
Daniel Mack65f25da2010-05-31 13:35:41 +02001234 case UAC_FU_MUTE:
1235 case UAC_FU_VOLUME:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 /* determine the control name. the rule is:
1237 * - if a name id is given in descriptor, use it.
1238 * - if the connected input can be determined, then use the name
1239 * of terminal type.
1240 * - if the connected output can be determined, use it.
1241 * - otherwise, anonymous name.
1242 */
1243 if (! len) {
1244 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1245 if (! len)
1246 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1247 if (! len)
1248 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1249 "Feature %d", unitid);
1250 }
David Henningsson9b4ef972012-11-23 13:48:55 +01001251
1252 if (!mapped_name)
1253 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1254
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 /* determine the stream direction:
1256 * if the connected output is USB stream, then it's likely a
1257 * capture stream. otherwise it should be playback (hopefully :)
1258 */
1259 if (! mapped_name && ! (state->oterm.type >> 16)) {
1260 if ((state->oterm.type & 0xff00) == 0x0100) {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001261 len = append_ctl_name(kctl, " Capture");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 } else {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001263 len = append_ctl_name(kctl, " Playback");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 }
1265 }
Daniel Mack65f25da2010-05-31 13:35:41 +02001266 append_ctl_name(kctl, control == UAC_FU_MUTE ?
Takashi Iwai08d1e632009-10-02 14:06:08 +02001267 " Switch" : " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 default:
1270 if (! len)
1271 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1272 sizeof(kctl->id.name));
1273 break;
1274 }
1275
Takashi Iwaie1825342012-05-14 17:11:06 +02001276 /* get min/max values */
1277 get_min_max_with_quirks(cval, 0, kctl);
1278
1279 if (control == UAC_FU_VOLUME) {
1280 check_mapped_dB(map, cval);
1281 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1282 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1283 kctl->vd[0].access |=
1284 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1285 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1286 }
1287 }
1288
Alexey Fisher80aceff2011-03-10 14:53:38 +01001289 range = (cval->max - cval->min) / cval->res;
1290 /* Are there devices with volume range more than 255? I use a bit more
1291 * to be sure. 384 is a resolution magic number found on Logitech
1292 * devices. It will definitively catch all buggy Logitech devices.
1293 */
1294 if (range > 384) {
1295 snd_printk(KERN_WARNING "usb_audio: Warning! Unlikely big "
1296 "volume range (=%u), cval->res is probably wrong.",
1297 range);
1298 snd_printk(KERN_WARNING "usb_audio: [%d] FU [%s] ch = %d, "
1299 "val = %d/%d/%d", cval->id,
1300 kctl->id.name, cval->channels,
1301 cval->min, cval->max, cval->res);
1302 }
1303
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1305 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
Daniel Mackef9d5972011-05-25 09:09:00 +02001306 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307}
1308
1309
1310
1311/*
1312 * parse a feature unit
1313 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001314 * most of controls are defined here.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 */
Daniel Mack28e1b772010-02-22 23:49:09 +01001316static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317{
1318 int channels, i, j;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001319 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 unsigned int master_bits, first_ch_bits;
1321 int err, csize;
Daniel Mack23caaf12010-03-11 21:13:25 +01001322 struct uac_feature_unit_descriptor *hdr = _ftr;
1323 __u8 *bmaControls;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
Daniel Mack23caaf12010-03-11 21:13:25 +01001325 if (state->mixer->protocol == UAC_VERSION_1) {
1326 csize = hdr->bControlSize;
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001327 if (!csize) {
1328 snd_printdd(KERN_ERR "usbaudio: unit %u: "
1329 "invalid bControlSize == 0\n", unitid);
1330 return -EINVAL;
1331 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001332 channels = (hdr->bLength - 7) / csize - 1;
1333 bmaControls = hdr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001334 if (hdr->bLength < 7 + csize) {
1335 snd_printk(KERN_ERR "usbaudio: unit %u: "
1336 "invalid UAC_FEATURE_UNIT descriptor\n",
1337 unitid);
1338 return -EINVAL;
1339 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001340 } else {
1341 struct uac2_feature_unit_descriptor *ftr = _ftr;
1342 csize = 4;
Daniel Macke8d0fee2010-05-27 20:15:14 +02001343 channels = (hdr->bLength - 6) / 4 - 1;
Daniel Mack23caaf12010-03-11 21:13:25 +01001344 bmaControls = ftr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001345 if (hdr->bLength < 6 + csize) {
1346 snd_printk(KERN_ERR "usbaudio: unit %u: "
1347 "invalid UAC_FEATURE_UNIT descriptor\n",
1348 unitid);
1349 return -EINVAL;
1350 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 }
1352
1353 /* parse the source unit */
Daniel Mack23caaf12010-03-11 21:13:25 +01001354 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 return err;
1356
1357 /* determine the input source type and name */
Daniel Mack23caaf12010-03-11 21:13:25 +01001358 if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 return -EINVAL;
1360
Daniel Mack23caaf12010-03-11 21:13:25 +01001361 master_bits = snd_usb_combine_bytes(bmaControls, csize);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001362 /* master configuration quirks */
1363 switch (state->chip->usb_id) {
1364 case USB_ID(0x08bb, 0x2702):
1365 snd_printk(KERN_INFO
1366 "usbmixer: master volume quirk for PCM2702 chip\n");
1367 /* disable non-functional volume control */
Daniel Mack65f25da2010-05-31 13:35:41 +02001368 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001369 break;
David Henningssonc1051432012-09-20 10:20:41 +02001370 case USB_ID(0x1130, 0xf211):
1371 snd_printk(KERN_INFO
1372 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1373 /* disable non-functional volume control */
1374 channels = 0;
1375 break;
1376
Javier Kohen0c3cee52009-11-17 15:36:13 +01001377 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 if (channels > 0)
Daniel Mack23caaf12010-03-11 21:13:25 +01001379 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 else
1381 first_ch_bits = 0;
Daniel Mack23caaf12010-03-11 21:13:25 +01001382
1383 if (state->mixer->protocol == UAC_VERSION_1) {
1384 /* check all control types */
1385 for (i = 0; i < 10; i++) {
1386 unsigned int ch_bits = 0;
1387 for (j = 0; j < channels; j++) {
1388 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1389 if (mask & (1 << i))
1390 ch_bits |= (1 << j);
1391 }
1392 /* audio class v1 controls are never read-only */
1393 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1394 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1395 if (master_bits & (1 << i))
1396 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001398 } else { /* UAC_VERSION_2 */
Takashi Iwaid09c06c2011-10-13 08:19:09 +02001399 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001400 unsigned int ch_bits = 0;
1401 unsigned int ch_read_only = 0;
1402
1403 for (j = 0; j < channels; j++) {
1404 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001405 if (uac2_control_is_readable(mask, i)) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001406 ch_bits |= (1 << j);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001407 if (!uac2_control_is_writeable(mask, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001408 ch_read_only |= (1 << j);
1409 }
1410 }
1411
Daniel Macka6a33252010-05-31 13:35:37 +02001412 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1413 * are marked read-only in the descriptors. Otherwise, the control will be
1414 * reported as writeable, but the driver will not actually issue a write
1415 * command for read-only channels */
Daniel Mack23caaf12010-03-11 21:13:25 +01001416 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
Daniel Macka6a33252010-05-31 13:35:37 +02001417 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001418 if (uac2_control_is_readable(master_bits, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001419 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001420 !uac2_control_is_writeable(master_bits, i));
Daniel Mack23caaf12010-03-11 21:13:25 +01001421 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 }
1423
1424 return 0;
1425}
1426
1427
1428/*
1429 * Mixer Unit
1430 */
1431
1432/*
1433 * build a mixer unit control
1434 *
1435 * the callbacks are identical with feature unit.
1436 * input channel number (zero based) is given in control field instead.
1437 */
1438
Daniel Mack99fc8642010-03-11 21:13:24 +01001439static void build_mixer_unit_ctl(struct mixer_build *state,
1440 struct uac_mixer_unit_descriptor *desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 int in_pin, int in_ch, int unitid,
Takashi Iwai86e07d32005-11-17 15:08:02 +01001442 struct usb_audio_term *iterm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001444 struct usb_mixer_elem_info *cval;
Daniel Mack99fc8642010-03-11 21:13:24 +01001445 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 unsigned int i, len;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001447 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001448 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001450 map = find_map(state, unitid, 0);
1451 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 return;
1453
Takashi Iwai561b2202005-09-09 14:22:34 +02001454 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 if (! cval)
1456 return;
1457
Clemens Ladisch84957a82005-04-29 16:23:13 +02001458 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 cval->id = unitid;
1460 cval->control = in_ch + 1; /* based on 1 */
1461 cval->val_type = USB_MIXER_S16;
1462 for (i = 0; i < num_outs; i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001463 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 cval->cmask |= (1 << i);
1465 cval->channels++;
1466 }
1467 }
1468
1469 /* get min/max values */
1470 get_min_max(cval, 0);
1471
1472 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1473 if (! kctl) {
1474 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1475 kfree(cval);
1476 return;
1477 }
1478 kctl->private_free = usb_mixer_elem_free;
1479
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001480 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 if (! len)
1482 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1483 if (! len)
1484 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
Takashi Iwai08d1e632009-10-02 14:06:08 +02001485 append_ctl_name(kctl, " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
1487 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1488 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001489 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490}
1491
1492
1493/*
1494 * parse a mixer unit
1495 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001496static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497{
Daniel Mack99fc8642010-03-11 21:13:24 +01001498 struct uac_mixer_unit_descriptor *desc = raw_desc;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001499 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 int input_pins, num_ins, num_outs;
1501 int pin, ich, err;
1502
Daniel Mack99fc8642010-03-11 21:13:24 +01001503 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1505 return -EINVAL;
1506 }
1507 /* no bmControls field (e.g. Maya44) -> ignore */
Daniel Mack99fc8642010-03-11 21:13:24 +01001508 if (desc->bLength <= 10 + input_pins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1510 return 0;
1511 }
1512
1513 num_ins = 0;
1514 ich = 0;
1515 for (pin = 0; pin < input_pins; pin++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001516 err = parse_audio_unit(state, desc->baSourceID[pin]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 if (err < 0)
Mark Hills284a8dd2012-04-14 17:19:23 +01001518 continue;
Daniel Mack99fc8642010-03-11 21:13:24 +01001519 err = check_input_term(state, desc->baSourceID[pin], &iterm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 if (err < 0)
1521 return err;
1522 num_ins += iterm.channels;
1523 for (; ich < num_ins; ++ich) {
1524 int och, ich_has_controls = 0;
1525
1526 for (och = 0; och < num_outs; ++och) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001527 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 ich, och, num_outs)) {
1529 ich_has_controls = 1;
1530 break;
1531 }
1532 }
1533 if (ich_has_controls)
1534 build_mixer_unit_ctl(state, desc, pin, ich,
1535 unitid, &iterm);
1536 }
1537 }
1538 return 0;
1539}
1540
1541
1542/*
1543 * Processing Unit / Extension Unit
1544 */
1545
1546/* get callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001547static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001549 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 int err, val;
1551
1552 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001553 if (err < 0 && cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 ucontrol->value.integer.value[0] = cval->min;
1555 return 0;
1556 }
1557 if (err < 0)
1558 return err;
1559 val = get_relative_value(cval, val);
1560 ucontrol->value.integer.value[0] = val;
1561 return 0;
1562}
1563
1564/* put callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001565static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001567 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 int val, oval, err;
1569
1570 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1571 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001572 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 return 0;
1574 return err;
1575 }
1576 val = ucontrol->value.integer.value[0];
1577 val = get_abs_value(cval, val);
1578 if (val != oval) {
1579 set_cur_ctl_value(cval, cval->control << 8, val);
1580 return 1;
1581 }
1582 return 0;
1583}
1584
1585/* alsa control interface for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001586static struct snd_kcontrol_new mixer_procunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1588 .name = "", /* will be filled later */
1589 .info = mixer_ctl_feature_info,
1590 .get = mixer_ctl_procunit_get,
1591 .put = mixer_ctl_procunit_put,
1592};
1593
1594
1595/*
1596 * predefined data for processing units
1597 */
1598struct procunit_value_info {
1599 int control;
1600 char *suffix;
1601 int val_type;
1602 int min_value;
1603};
1604
1605struct procunit_info {
1606 int type;
1607 char *name;
1608 struct procunit_value_info *values;
1609};
1610
1611static struct procunit_value_info updown_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001612 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1613 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 { 0 }
1615};
1616static struct procunit_value_info prologic_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001617 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1618 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 { 0 }
1620};
1621static struct procunit_value_info threed_enh_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001622 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1623 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 { 0 }
1625};
1626static struct procunit_value_info reverb_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001627 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1628 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1629 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1630 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 { 0 }
1632};
1633static struct procunit_value_info chorus_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001634 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1635 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1636 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1637 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 { 0 }
1639};
1640static struct procunit_value_info dcr_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001641 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1642 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1643 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1644 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1645 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1646 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 { 0 }
1648};
1649
1650static struct procunit_info procunits[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001651 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1652 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1653 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1654 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1655 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1656 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 { 0 },
1658};
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001659/*
1660 * predefined data for extension units
1661 */
1662static struct procunit_value_info clock_rate_xu_info[] = {
Daniel Macke213e9c2010-05-11 18:13:50 +02001663 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1664 { 0 }
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001665};
1666static struct procunit_value_info clock_source_xu_info[] = {
1667 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1668 { 0 }
1669};
1670static struct procunit_value_info spdif_format_xu_info[] = {
1671 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1672 { 0 }
1673};
1674static struct procunit_value_info soft_limit_xu_info[] = {
1675 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1676 { 0 }
1677};
1678static struct procunit_info extunits[] = {
1679 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1680 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1681 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1682 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1683 { 0 }
1684};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685/*
1686 * build a processing/extension unit
1687 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001688static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689{
Daniel Mack99fc8642010-03-11 21:13:24 +01001690 struct uac_processing_unit_descriptor *desc = raw_desc;
1691 int num_ins = desc->bNrInPins;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001692 struct usb_mixer_elem_info *cval;
1693 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 int i, err, nameid, type, len;
1695 struct procunit_info *info;
1696 struct procunit_value_info *valinfo;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001697 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 static struct procunit_value_info default_value_info[] = {
1699 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1700 { 0 }
1701 };
1702 static struct procunit_info default_info = {
1703 0, NULL, default_value_info
1704 };
1705
Daniel Mack23caaf12010-03-11 21:13:25 +01001706 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1707 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1709 return -EINVAL;
1710 }
1711
1712 for (i = 0; i < num_ins; i++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001713 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 return err;
1715 }
1716
Daniel Mack99fc8642010-03-11 21:13:24 +01001717 type = le16_to_cpu(desc->wProcessType);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 for (info = list; info && info->type; info++)
1719 if (info->type == type)
1720 break;
1721 if (! info || ! info->type)
1722 info = &default_info;
1723
1724 for (valinfo = info->values; valinfo->control; valinfo++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001725 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
Daniel Mack99fc8642010-03-11 21:13:24 +01001726
1727 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 continue;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001729 map = find_map(state, unitid, valinfo->control);
1730 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 continue;
Takashi Iwai561b2202005-09-09 14:22:34 +02001732 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 if (! cval) {
1734 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1735 return -ENOMEM;
1736 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001737 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 cval->id = unitid;
1739 cval->control = valinfo->control;
1740 cval->val_type = valinfo->val_type;
1741 cval->channels = 1;
1742
1743 /* get min/max values */
Daniel Mack65f25da2010-05-31 13:35:41 +02001744 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001745 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 /* FIXME: hard-coded */
1747 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001748 cval->max = control_spec[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 cval->res = 1;
1750 cval->initialized = 1;
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001751 } else {
1752 if (type == USB_XU_CLOCK_RATE) {
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -05001753 /* E-Mu USB 0404/0202/TrackerPre/0204
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001754 * samplerate control quirk
1755 */
1756 cval->min = 0;
1757 cval->max = 5;
1758 cval->res = 1;
1759 cval->initialized = 1;
1760 } else
1761 get_min_max(cval, valinfo->min_value);
1762 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
1764 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1765 if (! kctl) {
1766 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1767 kfree(cval);
1768 return -ENOMEM;
1769 }
1770 kctl->private_free = usb_mixer_elem_free;
1771
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001772 if (check_mapped_name(map, kctl->id.name,
1773 sizeof(kctl->id.name)))
1774 /* nothing */ ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 else if (info->name)
1776 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1777 else {
Daniel Mack23caaf12010-03-11 21:13:25 +01001778 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 len = 0;
1780 if (nameid)
1781 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1782 if (! len)
1783 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1784 }
Takashi Iwai08d1e632009-10-02 14:06:08 +02001785 append_ctl_name(kctl, " ");
1786 append_ctl_name(kctl, valinfo->suffix);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
1788 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1789 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001790 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 return err;
1792 }
1793 return 0;
1794}
1795
1796
Daniel Mack99fc8642010-03-11 21:13:24 +01001797static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798{
Daniel Mack99fc8642010-03-11 21:13:24 +01001799 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800}
1801
Daniel Mack99fc8642010-03-11 21:13:24 +01001802static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803{
Daniel Mack99fc8642010-03-11 21:13:24 +01001804 /* Note that we parse extension units with processing unit descriptors.
1805 * That's ok as the layout is the same */
1806 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807}
1808
1809
1810/*
1811 * Selector Unit
1812 */
1813
1814/* info callback for selector unit
1815 * use an enumerator type for routing
1816 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001817static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001819 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001820 const char **itemlist = (const char **)kcontrol->private_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
Takashi Iwai5e246b82008-08-08 17:12:47 +02001822 if (snd_BUG_ON(!itemlist))
1823 return -EINVAL;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001824 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825}
1826
1827/* get callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001828static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001830 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 int val, err;
1832
Daniel Mack09414202010-05-31 13:35:44 +02001833 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001835 if (cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 ucontrol->value.enumerated.item[0] = 0;
1837 return 0;
1838 }
1839 return err;
1840 }
1841 val = get_relative_value(cval, val);
1842 ucontrol->value.enumerated.item[0] = val;
1843 return 0;
1844}
1845
1846/* put callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001847static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001849 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 int val, oval, err;
1851
Daniel Mack09414202010-05-31 13:35:44 +02001852 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001854 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 return 0;
1856 return err;
1857 }
1858 val = ucontrol->value.enumerated.item[0];
1859 val = get_abs_value(cval, val);
1860 if (val != oval) {
Daniel Mack09414202010-05-31 13:35:44 +02001861 set_cur_ctl_value(cval, cval->control << 8, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 return 1;
1863 }
1864 return 0;
1865}
1866
1867/* alsa control interface for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001868static struct snd_kcontrol_new mixer_selectunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1870 .name = "", /* will be filled later */
1871 .info = mixer_ctl_selector_info,
1872 .get = mixer_ctl_selector_get,
1873 .put = mixer_ctl_selector_put,
1874};
1875
1876
1877/* private free callback.
1878 * free both private_data and private_value
1879 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001880static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881{
1882 int i, num_ins = 0;
1883
1884 if (kctl->private_data) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001885 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 num_ins = cval->max;
1887 kfree(cval);
1888 kctl->private_data = NULL;
1889 }
1890 if (kctl->private_value) {
1891 char **itemlist = (char **)kctl->private_value;
1892 for (i = 0; i < num_ins; i++)
1893 kfree(itemlist[i]);
1894 kfree(itemlist);
1895 kctl->private_value = 0;
1896 }
1897}
1898
1899/*
1900 * parse a selector unit
1901 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001902static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903{
Daniel Mack99fc8642010-03-11 21:13:24 +01001904 struct uac_selector_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 unsigned int i, nameid, len;
1906 int err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001907 struct usb_mixer_elem_info *cval;
1908 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001909 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 char **namelist;
1911
Daniel Mack99fc8642010-03-11 21:13:24 +01001912 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1914 return -EINVAL;
1915 }
1916
Daniel Mack99fc8642010-03-11 21:13:24 +01001917 for (i = 0; i < desc->bNrInPins; i++) {
1918 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 return err;
1920 }
1921
Daniel Mack99fc8642010-03-11 21:13:24 +01001922 if (desc->bNrInPins == 1) /* only one ? nonsense! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 return 0;
1924
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001925 map = find_map(state, unitid, 0);
1926 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 return 0;
1928
Takashi Iwai561b2202005-09-09 14:22:34 +02001929 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 if (! cval) {
1931 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1932 return -ENOMEM;
1933 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001934 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 cval->id = unitid;
1936 cval->val_type = USB_MIXER_U8;
1937 cval->channels = 1;
1938 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001939 cval->max = desc->bNrInPins;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 cval->res = 1;
1941 cval->initialized = 1;
1942
Daniel Mack09414202010-05-31 13:35:44 +02001943 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1944 cval->control = UAC2_CX_CLOCK_SELECTOR;
1945 else
1946 cval->control = 0;
1947
Daniel Mack99fc8642010-03-11 21:13:24 +01001948 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 if (! namelist) {
1950 snd_printk(KERN_ERR "cannot malloc\n");
1951 kfree(cval);
1952 return -ENOMEM;
1953 }
1954#define MAX_ITEM_NAME_LEN 64
Daniel Mack99fc8642010-03-11 21:13:24 +01001955 for (i = 0; i < desc->bNrInPins; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001956 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 len = 0;
1958 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1959 if (! namelist[i]) {
1960 snd_printk(KERN_ERR "cannot malloc\n");
Mariusz Kozlowski7fbe3ca2007-01-08 11:25:30 +01001961 while (i--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 kfree(namelist[i]);
1963 kfree(namelist);
1964 kfree(cval);
1965 return -ENOMEM;
1966 }
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02001967 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1968 MAX_ITEM_NAME_LEN);
Daniel Mack99fc8642010-03-11 21:13:24 +01001969 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1971 if (! len)
1972 sprintf(namelist[i], "Input %d", i);
1973 }
1974
1975 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1976 if (! kctl) {
1977 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
Jesper Juhl878b4782006-03-20 11:27:13 +01001978 kfree(namelist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 kfree(cval);
1980 return -ENOMEM;
1981 }
1982 kctl->private_value = (unsigned long)namelist;
1983 kctl->private_free = usb_mixer_selector_elem_free;
1984
Daniel Mack99fc8642010-03-11 21:13:24 +01001985 nameid = uac_selector_unit_iSelector(desc);
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001986 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 if (len)
1988 ;
1989 else if (nameid)
1990 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1991 else {
1992 len = get_term_name(state, &state->oterm,
1993 kctl->id.name, sizeof(kctl->id.name), 0);
1994 if (! len)
1995 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1996
Daniel Mack09414202010-05-31 13:35:44 +02001997 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1998 append_ctl_name(kctl, " Clock Source");
1999 else if ((state->oterm.type & 0xff00) == 0x0100)
Takashi Iwai08d1e632009-10-02 14:06:08 +02002000 append_ctl_name(kctl, " Capture Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 else
Takashi Iwai08d1e632009-10-02 14:06:08 +02002002 append_ctl_name(kctl, " Playback Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 }
2004
2005 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
Daniel Mack99fc8642010-03-11 21:13:24 +01002006 cval->id, kctl->id.name, desc->bNrInPins);
Daniel Mackef9d5972011-05-25 09:09:00 +02002007 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 return err;
2009
2010 return 0;
2011}
2012
2013
2014/*
2015 * parse an audio unit recursively
2016 */
2017
Takashi Iwai86e07d32005-11-17 15:08:02 +01002018static int parse_audio_unit(struct mixer_build *state, int unitid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019{
2020 unsigned char *p1;
2021
2022 if (test_and_set_bit(unitid, state->unitbitmap))
2023 return 0; /* the unit already visited */
2024
2025 p1 = find_audio_control_unit(state, unitid);
2026 if (!p1) {
2027 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
2028 return -EINVAL;
2029 }
2030
2031 switch (p1[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01002032 case UAC_INPUT_TERMINAL:
Daniel Mack09414202010-05-31 13:35:44 +02002033 case UAC2_CLOCK_SOURCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 return 0; /* NOP */
Daniel Mackde48c7b2010-02-22 23:49:13 +01002035 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 return parse_audio_mixer_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002037 case UAC_SELECTOR_UNIT:
Daniel Mack09414202010-05-31 13:35:44 +02002038 case UAC2_CLOCK_SELECTOR:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 return parse_audio_selector_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002040 case UAC_FEATURE_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 return parse_audio_feature_unit(state, unitid, p1);
Daniel Mack69da9bc2010-06-16 17:57:28 +02002042 case UAC1_PROCESSING_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002043 /* UAC2_EFFECT_UNIT has the same value */
2044 if (state->mixer->protocol == UAC_VERSION_1)
2045 return parse_audio_processing_unit(state, unitid, p1);
2046 else
2047 return 0; /* FIXME - effect units not implemented yet */
Daniel Mack69da9bc2010-06-16 17:57:28 +02002048 case UAC1_EXTENSION_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002049 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2050 if (state->mixer->protocol == UAC_VERSION_1)
2051 return parse_audio_extension_unit(state, unitid, p1);
2052 else /* UAC_VERSION_2 */
2053 return parse_audio_processing_unit(state, unitid, p1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 default:
2055 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2056 return -EINVAL;
2057 }
2058}
2059
Clemens Ladisch84957a82005-04-29 16:23:13 +02002060static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2061{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002062 kfree(mixer->id_elems);
2063 if (mixer->urb) {
2064 kfree(mixer->urb->transfer_buffer);
2065 usb_free_urb(mixer->urb);
2066 }
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002067 usb_free_urb(mixer->rc_urb);
Clemens Ladischb259b102005-04-29 16:29:28 +02002068 kfree(mixer->rc_setup_packet);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002069 kfree(mixer);
2070}
2071
Takashi Iwai86e07d32005-11-17 15:08:02 +01002072static int snd_usb_mixer_dev_free(struct snd_device *device)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002073{
2074 struct usb_mixer_interface *mixer = device->device_data;
2075 snd_usb_mixer_free(mixer);
2076 return 0;
2077}
2078
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079/*
2080 * create mixer controls
2081 *
Daniel Mackde48c7b2010-02-22 23:49:13 +01002082 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 */
Clemens Ladisch84957a82005-04-29 16:23:13 +02002084static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002086 struct mixer_build state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 int err;
2088 const struct usbmix_ctl_map *map;
Daniel Mack23caaf12010-03-11 21:13:25 +01002089 void *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 memset(&state, 0, sizeof(state));
Clemens Ladisch84957a82005-04-29 16:23:13 +02002092 state.chip = mixer->chip;
2093 state.mixer = mixer;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002094 state.buffer = mixer->hostif->extra;
2095 state.buflen = mixer->hostif->extralen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096
2097 /* check the mapping table */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002098 for (map = usbmix_ctl_maps; map->id; map++) {
2099 if (map->id == state.chip->usb_id) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 state.map = map->map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002101 state.selector_map = map->selector_map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002102 mixer->ignore_ctl_error = map->ignore_ctl_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 break;
2104 }
2105 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
Daniel Mack23caaf12010-03-11 21:13:25 +01002107 p = NULL;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002108 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen,
2109 p, UAC_OUTPUT_TERMINAL)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +01002110 if (mixer->protocol == UAC_VERSION_1) {
Daniel Mack69da9bc2010-06-16 17:57:28 +02002111 struct uac1_output_terminal_descriptor *desc = p;
Daniel Mack23caaf12010-03-11 21:13:25 +01002112
2113 if (desc->bLength < sizeof(*desc))
2114 continue; /* invalid descriptor? */
2115 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2116 state.oterm.id = desc->bTerminalID;
2117 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2118 state.oterm.name = desc->iTerminal;
2119 err = parse_audio_unit(&state, desc->bSourceID);
2120 if (err < 0)
2121 return err;
2122 } else { /* UAC_VERSION_2 */
2123 struct uac2_output_terminal_descriptor *desc = p;
2124
2125 if (desc->bLength < sizeof(*desc))
2126 continue; /* invalid descriptor? */
2127 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2128 state.oterm.id = desc->bTerminalID;
2129 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2130 state.oterm.name = desc->iTerminal;
2131 err = parse_audio_unit(&state, desc->bSourceID);
2132 if (err < 0)
2133 return err;
Daniel Mack09414202010-05-31 13:35:44 +02002134
2135 /* for UAC2, use the same approach to also add the clock selectors */
2136 err = parse_audio_unit(&state, desc->bCSourceID);
2137 if (err < 0)
2138 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +01002139 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 }
Daniel Mack23caaf12010-03-11 21:13:25 +01002141
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 return 0;
2143}
Clemens Ladisch84957a82005-04-29 16:23:13 +02002144
Daniel Mack7b1eda22010-03-11 21:13:22 +01002145void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002146{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002147 struct usb_mixer_elem_info *info;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002148
2149 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
2150 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2151 info->elem_id);
2152}
2153
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002154static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2155 int unitid,
2156 struct usb_mixer_elem_info *cval)
2157{
2158 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2159 "S8", "U8", "S16", "U16"};
2160 snd_iprintf(buffer, " Unit: %i\n", unitid);
2161 if (cval->elem_id)
2162 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
2163 cval->elem_id->name, cval->elem_id->index);
2164 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2165 "channels=%i, type=\"%s\"\n", cval->id,
2166 cval->control, cval->cmask, cval->channels,
2167 val_types[cval->val_type]);
2168 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2169 cval->min, cval->max, cval->dBmin, cval->dBmax);
2170}
2171
2172static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2173 struct snd_info_buffer *buffer)
2174{
2175 struct snd_usb_audio *chip = entry->private_data;
2176 struct usb_mixer_interface *mixer;
2177 struct usb_mixer_elem_info *cval;
2178 int unitid;
2179
2180 list_for_each_entry(mixer, &chip->mixer_list, list) {
2181 snd_iprintf(buffer,
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002182 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002183 chip->usb_id, snd_usb_ctrl_intf(chip),
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002184 mixer->ignore_ctl_error);
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002185 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2186 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2187 for (cval = mixer->id_elems[unitid]; cval;
2188 cval = cval->next_id_elem)
2189 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2190 }
2191 }
2192}
2193
Daniel Macke213e9c2010-05-11 18:13:50 +02002194static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2195 int attribute, int value, int index)
2196{
2197 struct usb_mixer_elem_info *info;
2198 __u8 unitid = (index >> 8) & 0xff;
2199 __u8 control = (value >> 8) & 0xff;
2200 __u8 channel = value & 0xff;
2201
2202 if (channel >= MAX_CHANNELS) {
2203 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2204 __func__, channel);
2205 return;
2206 }
2207
2208 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2209 if (info->control != control)
2210 continue;
2211
2212 switch (attribute) {
2213 case UAC2_CS_CUR:
2214 /* invalidate cache, so the value is read from the device */
2215 if (channel)
2216 info->cached &= ~(1 << channel);
2217 else /* master channel */
2218 info->cached = 0;
2219
2220 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2221 info->elem_id);
2222 break;
2223
2224 case UAC2_CS_RANGE:
2225 /* TODO */
2226 break;
2227
2228 case UAC2_CS_MEM:
2229 /* TODO */
2230 break;
2231
2232 default:
2233 snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2234 attribute);
2235 break;
2236 } /* switch */
2237 }
2238}
2239
2240static void snd_usb_mixer_interrupt(struct urb *urb)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002241{
2242 struct usb_mixer_interface *mixer = urb->context;
Daniel Macke213e9c2010-05-11 18:13:50 +02002243 int len = urb->actual_length;
Oliver Neukumedf7de32011-03-11 13:19:43 +01002244 int ustatus = urb->status;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002245
Oliver Neukumedf7de32011-03-11 13:19:43 +01002246 if (ustatus != 0)
Daniel Macke213e9c2010-05-11 18:13:50 +02002247 goto requeue;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002248
Daniel Macke213e9c2010-05-11 18:13:50 +02002249 if (mixer->protocol == UAC_VERSION_1) {
2250 struct uac1_status_word *status;
2251
2252 for (status = urb->transfer_buffer;
2253 len >= sizeof(*status);
2254 len -= sizeof(*status), status++) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002255 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
Daniel Macke213e9c2010-05-11 18:13:50 +02002256 status->bStatusType,
2257 status->bOriginator);
2258
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002259 /* ignore any notifications not from the control interface */
Daniel Macke213e9c2010-05-11 18:13:50 +02002260 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2261 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002262 continue;
Daniel Macke213e9c2010-05-11 18:13:50 +02002263
2264 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2265 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
Clemens Ladischb259b102005-04-29 16:29:28 +02002266 else
Daniel Macke213e9c2010-05-11 18:13:50 +02002267 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2268 }
2269 } else { /* UAC_VERSION_2 */
2270 struct uac2_interrupt_data_msg *msg;
2271
2272 for (msg = urb->transfer_buffer;
2273 len >= sizeof(*msg);
2274 len -= sizeof(*msg), msg++) {
2275 /* drop vendor specific and endpoint requests */
2276 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2277 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2278 continue;
2279
2280 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2281 le16_to_cpu(msg->wValue),
2282 le16_to_cpu(msg->wIndex));
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002283 }
2284 }
Daniel Macke213e9c2010-05-11 18:13:50 +02002285
2286requeue:
Oliver Neukumedf7de32011-03-11 13:19:43 +01002287 if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002288 urb->dev = mixer->chip->dev;
2289 usb_submit_urb(urb, GFP_ATOMIC);
2290 }
2291}
2292
Oliver Neukumedf7de32011-03-11 13:19:43 +01002293/* stop any bus activity of a mixer */
2294void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2295{
2296 usb_kill_urb(mixer->urb);
2297 usb_kill_urb(mixer->rc_urb);
2298}
2299
2300int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2301{
2302 int err;
2303
2304 if (mixer->urb) {
2305 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2306 if (err < 0)
2307 return err;
2308 }
2309
2310 return 0;
2311}
2312
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002313/* create the handler for the optional status interrupt endpoint */
2314static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2315{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002316 struct usb_endpoint_descriptor *ep;
2317 void *transfer_buffer;
2318 int buffer_length;
2319 unsigned int epnum;
2320
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002321 /* we need one interrupt input endpoint */
Daniel Mack1faa5d02011-08-04 15:56:28 +02002322 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002323 return 0;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002324 ep = get_endpoint(mixer->hostif, 0);
Julia Lawall913ae5a2009-01-03 17:54:53 +01002325 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002326 return 0;
2327
Julia Lawall42a6e662008-12-29 11:23:02 +01002328 epnum = usb_endpoint_num(ep);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002329 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2330 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2331 if (!transfer_buffer)
2332 return -ENOMEM;
2333 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2334 if (!mixer->urb) {
2335 kfree(transfer_buffer);
2336 return -ENOMEM;
2337 }
2338 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2339 usb_rcvintpipe(mixer->chip->dev, epnum),
2340 transfer_buffer, buffer_length,
Daniel Macke213e9c2010-05-11 18:13:50 +02002341 snd_usb_mixer_interrupt, mixer, ep->bInterval);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002342 usb_submit_urb(mixer->urb, GFP_KERNEL);
2343 return 0;
2344}
2345
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002346int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2347 int ignore_error)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002348{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002349 static struct snd_device_ops dev_ops = {
Clemens Ladisch84957a82005-04-29 16:23:13 +02002350 .dev_free = snd_usb_mixer_dev_free
2351 };
2352 struct usb_mixer_interface *mixer;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002353 struct snd_info_entry *entry;
Daniel Mack23caaf12010-03-11 21:13:25 +01002354 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002355
2356 strcpy(chip->card->mixername, "USB Mixer");
2357
Takashi Iwai561b2202005-09-09 14:22:34 +02002358 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002359 if (!mixer)
2360 return -ENOMEM;
2361 mixer->chip = chip;
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002362 mixer->ignore_ctl_error = ignore_error;
Jaroslav Kysela291186e2010-02-16 11:55:18 +01002363 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2364 GFP_KERNEL);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002365 if (!mixer->id_elems) {
2366 kfree(mixer);
2367 return -ENOMEM;
2368 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02002369
Daniel Mack1faa5d02011-08-04 15:56:28 +02002370 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2371 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +02002372 case UAC_VERSION_1:
2373 default:
2374 mixer->protocol = UAC_VERSION_1;
2375 break;
2376 case UAC_VERSION_2:
2377 mixer->protocol = UAC_VERSION_2;
2378 break;
2379 }
Daniel Mack7b8a0432010-02-22 23:49:12 +01002380
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002381 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002382 (err = snd_usb_mixer_status_create(mixer)) < 0)
2383 goto _error;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002384
Daniel Mack7b1eda22010-03-11 21:13:22 +01002385 snd_usb_mixer_apply_create_quirk(mixer);
Clemens Ladisch468b8fd2009-07-13 11:39:29 +02002386
Clemens Ladisch84957a82005-04-29 16:23:13 +02002387 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002388 if (err < 0)
2389 goto _error;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002390
2391 if (list_empty(&chip->mixer_list) &&
2392 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2393 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2394
Clemens Ladisch84957a82005-04-29 16:23:13 +02002395 list_add(&mixer->list, &chip->mixer_list);
2396 return 0;
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002397
2398_error:
2399 snd_usb_mixer_free(mixer);
2400 return err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002401}
2402
2403void snd_usb_mixer_disconnect(struct list_head *p)
2404{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002405 struct usb_mixer_interface *mixer;
Daniel Mack7b1eda22010-03-11 21:13:22 +01002406
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002407 mixer = list_entry(p, struct usb_mixer_interface, list);
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002408 usb_kill_urb(mixer->urb);
2409 usb_kill_urb(mixer->rc_urb);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002410}