blob: 4eacbe2e2d64cc43ab1d830e513d70802bce15ae [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) {
Felix Homannd34bf142012-04-23 20:24:27 +0200809 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
810 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
811 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
812 snd_printk(KERN_INFO
813 "usb-audio: set quirk for FTU Effect Duration\n");
814 cval->min = 0x0000;
815 cval->max = 0x7f00;
816 cval->res = 0x0100;
817 break;
818 }
819 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
820 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
821 snd_printk(KERN_INFO
822 "usb-audio: set quirks for FTU Effect Feedback/Volume\n");
823 cval->min = 0x00;
824 cval->max = 0x7f;
825 break;
826 }
827 break;
828
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100829 case USB_ID(0x0471, 0x0101):
830 case USB_ID(0x0471, 0x0104):
831 case USB_ID(0x0471, 0x0105):
832 case USB_ID(0x0672, 0x1041):
833 /* quirk for UDA1321/N101.
834 * note that detection between firmware 2.1.1.7 (N101)
835 * and later 2.1.1.21 is not very clear from datasheets.
836 * I hope that the min value is -15360 for newer firmware --jk
837 */
838 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
839 cval->min == -15616) {
840 snd_printk(KERN_INFO
841 "set volume quirk for UDA1321/N101 chip\n");
842 cval->max = -256;
843 }
844 break;
845
846 case USB_ID(0x046d, 0x09a4):
847 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
848 snd_printk(KERN_INFO
849 "set volume quirk for QuickCam E3500\n");
850 cval->min = 6080;
851 cval->max = 8768;
852 cval->res = 192;
853 }
854 break;
855
856 case USB_ID(0x046d, 0x0808):
857 case USB_ID(0x046d, 0x0809):
Alexey Fisher55c00082011-11-09 11:39:24 +0100858 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100859 case USB_ID(0x046d, 0x0991):
860 /* Most audio usb devices lie about volume resolution.
861 * Most Logitech webcams have res = 384.
862 * Proboly there is some logitech magic behind this number --fishor
863 */
864 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
865 snd_printk(KERN_INFO
866 "set resolution quirk: cval->res = 384\n");
867 cval->res = 384;
868 }
869 break;
870
871 }
872}
873
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874/*
875 * retrieve the minimum and maximum values for the specified control
876 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100877static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
878 int default_min, struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879{
880 /* for failsafe */
881 cval->min = default_min;
882 cval->max = cval->min + 1;
883 cval->res = 1;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100884 cval->dBmin = cval->dBmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
886 if (cval->val_type == USB_MIXER_BOOLEAN ||
887 cval->val_type == USB_MIXER_INV_BOOLEAN) {
888 cval->initialized = 1;
889 } else {
890 int minchn = 0;
891 if (cval->cmask) {
892 int i;
893 for (i = 0; i < MAX_CHANNELS; i++)
894 if (cval->cmask & (1 << i)) {
895 minchn = i + 1;
896 break;
897 }
898 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100899 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
900 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +0200901 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
Takashi Iwai1a4e34e2010-09-16 07:42:34 +0200902 cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 return -EINVAL;
904 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100905 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 cval->res = 1;
907 } else {
908 int last_valid_res = cval->res;
909
910 while (cval->res > 1) {
Daniel Mack7b1eda22010-03-11 21:13:22 +0100911 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
912 (cval->control << 8) | minchn, cval->res / 2) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 break;
914 cval->res /= 2;
915 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100916 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 cval->res = last_valid_res;
918 }
919 if (cval->res == 0)
920 cval->res = 1;
Takashi Iwai14790f12006-03-28 17:58:28 +0200921
922 /* Additional checks for the proper resolution
923 *
924 * Some devices report smaller resolutions than actually
925 * reacting. They don't return errors but simply clip
926 * to the lower aligned value.
927 */
928 if (cval->min + cval->res < cval->max) {
929 int last_valid_res = cval->res;
930 int saved, test, check;
Takashi Iwai641b4872009-01-15 17:05:24 +0100931 get_cur_mix_raw(cval, minchn, &saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200932 for (;;) {
933 test = saved;
934 if (test < cval->max)
935 test += cval->res;
936 else
937 test -= cval->res;
938 if (test < cval->min || test > cval->max ||
Takashi Iwai641b4872009-01-15 17:05:24 +0100939 set_cur_mix_value(cval, minchn, 0, test) ||
940 get_cur_mix_raw(cval, minchn, &check)) {
Takashi Iwai14790f12006-03-28 17:58:28 +0200941 cval->res = last_valid_res;
942 break;
943 }
944 if (test == check)
945 break;
946 cval->res *= 2;
947 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100948 set_cur_mix_value(cval, minchn, 0, saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200949 }
950
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 cval->initialized = 1;
952 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100953
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100954 if (kctl)
955 volume_control_quirks(cval, kctl);
956
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100957 /* USB descriptions contain the dB scale in 1/256 dB unit
958 * while ALSA TLV contains in 1/100 dB unit
959 */
960 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
961 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
962 if (cval->dBmin > cval->dBmax) {
963 /* something is wrong; assume it's either from/to 0dB */
964 if (cval->dBmin < 0)
965 cval->dBmax = 0;
966 else if (cval->dBmin > 0)
967 cval->dBmin = 0;
968 if (cval->dBmin > cval->dBmax) {
969 /* totally crap, return an error */
970 return -EINVAL;
971 }
972 }
973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 return 0;
975}
976
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100977#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978
979/* get a feature/mixer unit info */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100980static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100982 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
984 if (cval->val_type == USB_MIXER_BOOLEAN ||
985 cval->val_type == USB_MIXER_INV_BOOLEAN)
986 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
987 else
988 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
989 uinfo->count = cval->channels;
990 if (cval->val_type == USB_MIXER_BOOLEAN ||
991 cval->val_type == USB_MIXER_INV_BOOLEAN) {
992 uinfo->value.integer.min = 0;
993 uinfo->value.integer.max = 1;
994 } else {
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +0200995 if (!cval->initialized) {
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100996 get_min_max_with_quirks(cval, 0, kcontrol);
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +0200997 if (cval->initialized && cval->dBmin >= cval->dBmax) {
998 kcontrol->vd[0].access &=
999 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1000 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1001 snd_ctl_notify(cval->mixer->chip->card,
1002 SNDRV_CTL_EVENT_MASK_INFO,
1003 &kcontrol->id);
1004 }
1005 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 uinfo->value.integer.min = 0;
Takashi Iwai14790f12006-03-28 17:58:28 +02001007 uinfo->value.integer.max =
1008 (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 }
1010 return 0;
1011}
1012
1013/* get the current value from feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001014static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001016 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 int c, cnt, val, err;
1018
Takashi Iwai641b4872009-01-15 17:05:24 +01001019 ucontrol->value.integer.value[0] = cval->min;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 if (cval->cmask) {
1021 cnt = 0;
1022 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001023 if (!(cval->cmask & (1 << c)))
1024 continue;
1025 err = get_cur_mix_value(cval, c + 1, cnt, &val);
1026 if (err < 0)
1027 return cval->mixer->ignore_ctl_error ? 0 : err;
1028 val = get_relative_value(cval, val);
1029 ucontrol->value.integer.value[cnt] = val;
1030 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001032 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 } else {
1034 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +01001035 err = get_cur_mix_value(cval, 0, 0, &val);
1036 if (err < 0)
1037 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 val = get_relative_value(cval, val);
1039 ucontrol->value.integer.value[0] = val;
1040 }
1041 return 0;
1042}
1043
1044/* put the current value to feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001045static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001047 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 int c, cnt, val, oval, err;
1049 int changed = 0;
1050
1051 if (cval->cmask) {
1052 cnt = 0;
1053 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001054 if (!(cval->cmask & (1 << c)))
1055 continue;
1056 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
1057 if (err < 0)
1058 return cval->mixer->ignore_ctl_error ? 0 : err;
1059 val = ucontrol->value.integer.value[cnt];
1060 val = get_abs_value(cval, val);
1061 if (oval != val) {
1062 set_cur_mix_value(cval, c + 1, cnt, val);
1063 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001065 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 }
1067 } else {
1068 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +01001069 err = get_cur_mix_value(cval, 0, 0, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 if (err < 0)
Takashi Iwai641b4872009-01-15 17:05:24 +01001071 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 val = ucontrol->value.integer.value[0];
1073 val = get_abs_value(cval, val);
1074 if (val != oval) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001075 set_cur_mix_value(cval, 0, 0, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 changed = 1;
1077 }
1078 }
1079 return changed;
1080}
1081
Takashi Iwai86e07d32005-11-17 15:08:02 +01001082static struct snd_kcontrol_new usb_feature_unit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1084 .name = "", /* will be filled later manually */
1085 .info = mixer_ctl_feature_info,
1086 .get = mixer_ctl_feature_get,
1087 .put = mixer_ctl_feature_put,
1088};
1089
Daniel Mack23caaf12010-03-11 21:13:25 +01001090/* the read-only variant */
1091static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1092 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1093 .name = "", /* will be filled later manually */
1094 .info = mixer_ctl_feature_info,
1095 .get = mixer_ctl_feature_get,
1096 .put = NULL,
1097};
1098
Daniel Mack9e386582011-05-25 09:09:01 +02001099/* This symbol is exported in order to allow the mixer quirks to
1100 * hook up to the standard feature unit control mechanism */
1101struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
1103/*
1104 * build a feature control
1105 */
1106
Takashi Iwai08d1e632009-10-02 14:06:08 +02001107static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1108{
1109 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1110}
1111
Daniel Mack99fc8642010-03-11 21:13:24 +01001112static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 unsigned int ctl_mask, int control,
Daniel Mack23caaf12010-03-11 21:13:25 +01001114 struct usb_audio_term *iterm, int unitid,
Daniel Macka6a33252010-05-31 13:35:37 +02001115 int readonly_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116{
Daniel Mack99fc8642010-03-11 21:13:24 +01001117 struct uac_feature_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 unsigned int len = 0;
1119 int mapped_name = 0;
Daniel Mack99fc8642010-03-11 21:13:24 +01001120 int nameid = uac_feature_unit_iFeature(desc);
Takashi Iwai86e07d32005-11-17 15:08:02 +01001121 struct snd_kcontrol *kctl;
1122 struct usb_mixer_elem_info *cval;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001123 const struct usbmix_name_map *map;
Alexey Fisher80aceff2011-03-10 14:53:38 +01001124 unsigned int range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
1126 control++; /* change from zero-based to 1-based value */
1127
Daniel Mack65f25da2010-05-31 13:35:41 +02001128 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 /* FIXME: not supported yet */
1130 return;
1131 }
1132
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001133 map = find_map(state, unitid, control);
1134 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 return;
1136
Takashi Iwai561b2202005-09-09 14:22:34 +02001137 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 if (! cval) {
1139 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1140 return;
1141 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001142 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 cval->id = unitid;
1144 cval->control = control;
1145 cval->cmask = ctl_mask;
1146 cval->val_type = audio_feature_info[control-1].type;
Daniel Macka6a33252010-05-31 13:35:37 +02001147 if (ctl_mask == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 cval->channels = 1; /* master channel */
Daniel Macka6a33252010-05-31 13:35:37 +02001149 cval->master_readonly = readonly_mask;
1150 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 int i, c = 0;
1152 for (i = 0; i < 16; i++)
1153 if (ctl_mask & (1 << i))
1154 c++;
1155 cval->channels = c;
Daniel Macka6a33252010-05-31 13:35:37 +02001156 cval->ch_readonly = readonly_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 }
1158
Daniel Macka6a33252010-05-31 13:35:37 +02001159 /* if all channels in the mask are marked read-only, make the control
1160 * read-only. set_cur_mix_value() will check the mask again and won't
1161 * issue write commands to read-only channels. */
1162 if (cval->channels == readonly_mask)
Daniel Mack23caaf12010-03-11 21:13:25 +01001163 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1164 else
1165 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1166
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 if (! kctl) {
1168 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1169 kfree(cval);
1170 return;
1171 }
1172 kctl->private_free = usb_mixer_elem_free;
1173
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001174 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 mapped_name = len != 0;
1176 if (! len && nameid)
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001177 len = snd_usb_copy_string_desc(state, nameid,
1178 kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179
1180 switch (control) {
Daniel Mack65f25da2010-05-31 13:35:41 +02001181 case UAC_FU_MUTE:
1182 case UAC_FU_VOLUME:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 /* determine the control name. the rule is:
1184 * - if a name id is given in descriptor, use it.
1185 * - if the connected input can be determined, then use the name
1186 * of terminal type.
1187 * - if the connected output can be determined, use it.
1188 * - otherwise, anonymous name.
1189 */
1190 if (! len) {
1191 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1192 if (! len)
1193 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1194 if (! len)
1195 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1196 "Feature %d", unitid);
1197 }
1198 /* determine the stream direction:
1199 * if the connected output is USB stream, then it's likely a
1200 * capture stream. otherwise it should be playback (hopefully :)
1201 */
1202 if (! mapped_name && ! (state->oterm.type >> 16)) {
1203 if ((state->oterm.type & 0xff00) == 0x0100) {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001204 len = append_ctl_name(kctl, " Capture");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 } else {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001206 len = append_ctl_name(kctl, " Playback");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 }
1208 }
Daniel Mack65f25da2010-05-31 13:35:41 +02001209 append_ctl_name(kctl, control == UAC_FU_MUTE ?
Takashi Iwai08d1e632009-10-02 14:06:08 +02001210 " Switch" : " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 default:
1213 if (! len)
1214 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1215 sizeof(kctl->id.name));
1216 break;
1217 }
1218
Takashi Iwaie1825342012-05-14 17:11:06 +02001219 /* get min/max values */
1220 get_min_max_with_quirks(cval, 0, kctl);
1221
1222 if (control == UAC_FU_VOLUME) {
1223 check_mapped_dB(map, cval);
1224 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1225 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1226 kctl->vd[0].access |=
1227 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1228 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1229 }
1230 }
1231
Alexey Fisher80aceff2011-03-10 14:53:38 +01001232 range = (cval->max - cval->min) / cval->res;
1233 /* Are there devices with volume range more than 255? I use a bit more
1234 * to be sure. 384 is a resolution magic number found on Logitech
1235 * devices. It will definitively catch all buggy Logitech devices.
1236 */
1237 if (range > 384) {
1238 snd_printk(KERN_WARNING "usb_audio: Warning! Unlikely big "
1239 "volume range (=%u), cval->res is probably wrong.",
1240 range);
1241 snd_printk(KERN_WARNING "usb_audio: [%d] FU [%s] ch = %d, "
1242 "val = %d/%d/%d", cval->id,
1243 kctl->id.name, cval->channels,
1244 cval->min, cval->max, cval->res);
1245 }
1246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1248 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
Daniel Mackef9d5972011-05-25 09:09:00 +02001249 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250}
1251
1252
1253
1254/*
1255 * parse a feature unit
1256 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001257 * most of controls are defined here.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 */
Daniel Mack28e1b772010-02-22 23:49:09 +01001259static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260{
1261 int channels, i, j;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001262 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 unsigned int master_bits, first_ch_bits;
1264 int err, csize;
Daniel Mack23caaf12010-03-11 21:13:25 +01001265 struct uac_feature_unit_descriptor *hdr = _ftr;
1266 __u8 *bmaControls;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Daniel Mack23caaf12010-03-11 21:13:25 +01001268 if (state->mixer->protocol == UAC_VERSION_1) {
1269 csize = hdr->bControlSize;
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001270 if (!csize) {
1271 snd_printdd(KERN_ERR "usbaudio: unit %u: "
1272 "invalid bControlSize == 0\n", unitid);
1273 return -EINVAL;
1274 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001275 channels = (hdr->bLength - 7) / csize - 1;
1276 bmaControls = hdr->bmaControls;
1277 } else {
1278 struct uac2_feature_unit_descriptor *ftr = _ftr;
1279 csize = 4;
Daniel Macke8d0fee2010-05-27 20:15:14 +02001280 channels = (hdr->bLength - 6) / 4 - 1;
Daniel Mack23caaf12010-03-11 21:13:25 +01001281 bmaControls = ftr->bmaControls;
1282 }
1283
1284 if (hdr->bLength < 7 || !csize || hdr->bLength < 7 + csize) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01001285 snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 return -EINVAL;
1287 }
1288
1289 /* parse the source unit */
Daniel Mack23caaf12010-03-11 21:13:25 +01001290 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 return err;
1292
1293 /* determine the input source type and name */
Daniel Mack23caaf12010-03-11 21:13:25 +01001294 if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 return -EINVAL;
1296
Daniel Mack23caaf12010-03-11 21:13:25 +01001297 master_bits = snd_usb_combine_bytes(bmaControls, csize);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001298 /* master configuration quirks */
1299 switch (state->chip->usb_id) {
1300 case USB_ID(0x08bb, 0x2702):
1301 snd_printk(KERN_INFO
1302 "usbmixer: master volume quirk for PCM2702 chip\n");
1303 /* disable non-functional volume control */
Daniel Mack65f25da2010-05-31 13:35:41 +02001304 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001305 break;
David Henningssonc1051432012-09-20 10:20:41 +02001306 case USB_ID(0x1130, 0xf211):
1307 snd_printk(KERN_INFO
1308 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1309 /* disable non-functional volume control */
1310 channels = 0;
1311 break;
1312
Javier Kohen0c3cee52009-11-17 15:36:13 +01001313 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 if (channels > 0)
Daniel Mack23caaf12010-03-11 21:13:25 +01001315 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 else
1317 first_ch_bits = 0;
Daniel Mack23caaf12010-03-11 21:13:25 +01001318
1319 if (state->mixer->protocol == UAC_VERSION_1) {
1320 /* check all control types */
1321 for (i = 0; i < 10; i++) {
1322 unsigned int ch_bits = 0;
1323 for (j = 0; j < channels; j++) {
1324 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1325 if (mask & (1 << i))
1326 ch_bits |= (1 << j);
1327 }
1328 /* audio class v1 controls are never read-only */
1329 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1330 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1331 if (master_bits & (1 << i))
1332 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001334 } else { /* UAC_VERSION_2 */
Takashi Iwaid09c06c2011-10-13 08:19:09 +02001335 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001336 unsigned int ch_bits = 0;
1337 unsigned int ch_read_only = 0;
1338
1339 for (j = 0; j < channels; j++) {
1340 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001341 if (uac2_control_is_readable(mask, i)) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001342 ch_bits |= (1 << j);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001343 if (!uac2_control_is_writeable(mask, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001344 ch_read_only |= (1 << j);
1345 }
1346 }
1347
Daniel Macka6a33252010-05-31 13:35:37 +02001348 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1349 * are marked read-only in the descriptors. Otherwise, the control will be
1350 * reported as writeable, but the driver will not actually issue a write
1351 * command for read-only channels */
Daniel Mack23caaf12010-03-11 21:13:25 +01001352 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
Daniel Macka6a33252010-05-31 13:35:37 +02001353 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001354 if (uac2_control_is_readable(master_bits, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001355 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001356 !uac2_control_is_writeable(master_bits, i));
Daniel Mack23caaf12010-03-11 21:13:25 +01001357 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 }
1359
1360 return 0;
1361}
1362
1363
1364/*
1365 * Mixer Unit
1366 */
1367
1368/*
1369 * build a mixer unit control
1370 *
1371 * the callbacks are identical with feature unit.
1372 * input channel number (zero based) is given in control field instead.
1373 */
1374
Daniel Mack99fc8642010-03-11 21:13:24 +01001375static void build_mixer_unit_ctl(struct mixer_build *state,
1376 struct uac_mixer_unit_descriptor *desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 int in_pin, int in_ch, int unitid,
Takashi Iwai86e07d32005-11-17 15:08:02 +01001378 struct usb_audio_term *iterm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001380 struct usb_mixer_elem_info *cval;
Daniel Mack99fc8642010-03-11 21:13:24 +01001381 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 unsigned int i, len;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001383 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001384 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001386 map = find_map(state, unitid, 0);
1387 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 return;
1389
Takashi Iwai561b2202005-09-09 14:22:34 +02001390 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 if (! cval)
1392 return;
1393
Clemens Ladisch84957a82005-04-29 16:23:13 +02001394 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 cval->id = unitid;
1396 cval->control = in_ch + 1; /* based on 1 */
1397 cval->val_type = USB_MIXER_S16;
1398 for (i = 0; i < num_outs; i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001399 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 cval->cmask |= (1 << i);
1401 cval->channels++;
1402 }
1403 }
1404
1405 /* get min/max values */
1406 get_min_max(cval, 0);
1407
1408 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1409 if (! kctl) {
1410 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1411 kfree(cval);
1412 return;
1413 }
1414 kctl->private_free = usb_mixer_elem_free;
1415
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001416 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 if (! len)
1418 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1419 if (! len)
1420 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
Takashi Iwai08d1e632009-10-02 14:06:08 +02001421 append_ctl_name(kctl, " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
1423 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1424 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001425 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426}
1427
1428
1429/*
1430 * parse a mixer unit
1431 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001432static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433{
Daniel Mack99fc8642010-03-11 21:13:24 +01001434 struct uac_mixer_unit_descriptor *desc = raw_desc;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001435 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 int input_pins, num_ins, num_outs;
1437 int pin, ich, err;
1438
Daniel Mack99fc8642010-03-11 21:13:24 +01001439 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1441 return -EINVAL;
1442 }
1443 /* no bmControls field (e.g. Maya44) -> ignore */
Daniel Mack99fc8642010-03-11 21:13:24 +01001444 if (desc->bLength <= 10 + input_pins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1446 return 0;
1447 }
1448
1449 num_ins = 0;
1450 ich = 0;
1451 for (pin = 0; pin < input_pins; pin++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001452 err = parse_audio_unit(state, desc->baSourceID[pin]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 if (err < 0)
Mark Hills284a8dd2012-04-14 17:19:23 +01001454 continue;
Daniel Mack99fc8642010-03-11 21:13:24 +01001455 err = check_input_term(state, desc->baSourceID[pin], &iterm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 if (err < 0)
1457 return err;
1458 num_ins += iterm.channels;
1459 for (; ich < num_ins; ++ich) {
1460 int och, ich_has_controls = 0;
1461
1462 for (och = 0; och < num_outs; ++och) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001463 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 ich, och, num_outs)) {
1465 ich_has_controls = 1;
1466 break;
1467 }
1468 }
1469 if (ich_has_controls)
1470 build_mixer_unit_ctl(state, desc, pin, ich,
1471 unitid, &iterm);
1472 }
1473 }
1474 return 0;
1475}
1476
1477
1478/*
1479 * Processing Unit / Extension Unit
1480 */
1481
1482/* get callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001483static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001485 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 int err, val;
1487
1488 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001489 if (err < 0 && cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 ucontrol->value.integer.value[0] = cval->min;
1491 return 0;
1492 }
1493 if (err < 0)
1494 return err;
1495 val = get_relative_value(cval, val);
1496 ucontrol->value.integer.value[0] = val;
1497 return 0;
1498}
1499
1500/* put callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001501static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001503 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 int val, oval, err;
1505
1506 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1507 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001508 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 return 0;
1510 return err;
1511 }
1512 val = ucontrol->value.integer.value[0];
1513 val = get_abs_value(cval, val);
1514 if (val != oval) {
1515 set_cur_ctl_value(cval, cval->control << 8, val);
1516 return 1;
1517 }
1518 return 0;
1519}
1520
1521/* alsa control interface for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001522static struct snd_kcontrol_new mixer_procunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1524 .name = "", /* will be filled later */
1525 .info = mixer_ctl_feature_info,
1526 .get = mixer_ctl_procunit_get,
1527 .put = mixer_ctl_procunit_put,
1528};
1529
1530
1531/*
1532 * predefined data for processing units
1533 */
1534struct procunit_value_info {
1535 int control;
1536 char *suffix;
1537 int val_type;
1538 int min_value;
1539};
1540
1541struct procunit_info {
1542 int type;
1543 char *name;
1544 struct procunit_value_info *values;
1545};
1546
1547static struct procunit_value_info updown_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001548 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1549 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 { 0 }
1551};
1552static struct procunit_value_info prologic_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001553 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1554 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 { 0 }
1556};
1557static struct procunit_value_info threed_enh_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001558 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1559 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 { 0 }
1561};
1562static struct procunit_value_info reverb_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001563 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1564 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1565 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1566 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 { 0 }
1568};
1569static struct procunit_value_info chorus_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001570 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1571 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1572 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1573 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 { 0 }
1575};
1576static struct procunit_value_info dcr_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001577 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1578 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1579 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1580 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1581 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1582 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 { 0 }
1584};
1585
1586static struct procunit_info procunits[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001587 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1588 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1589 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1590 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1591 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1592 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 { 0 },
1594};
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001595/*
1596 * predefined data for extension units
1597 */
1598static struct procunit_value_info clock_rate_xu_info[] = {
Daniel Macke213e9c2010-05-11 18:13:50 +02001599 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1600 { 0 }
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001601};
1602static struct procunit_value_info clock_source_xu_info[] = {
1603 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1604 { 0 }
1605};
1606static struct procunit_value_info spdif_format_xu_info[] = {
1607 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1608 { 0 }
1609};
1610static struct procunit_value_info soft_limit_xu_info[] = {
1611 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1612 { 0 }
1613};
1614static struct procunit_info extunits[] = {
1615 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1616 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1617 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1618 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1619 { 0 }
1620};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621/*
1622 * build a processing/extension unit
1623 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001624static 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 -07001625{
Daniel Mack99fc8642010-03-11 21:13:24 +01001626 struct uac_processing_unit_descriptor *desc = raw_desc;
1627 int num_ins = desc->bNrInPins;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001628 struct usb_mixer_elem_info *cval;
1629 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 int i, err, nameid, type, len;
1631 struct procunit_info *info;
1632 struct procunit_value_info *valinfo;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001633 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 static struct procunit_value_info default_value_info[] = {
1635 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1636 { 0 }
1637 };
1638 static struct procunit_info default_info = {
1639 0, NULL, default_value_info
1640 };
1641
Daniel Mack23caaf12010-03-11 21:13:25 +01001642 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1643 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1645 return -EINVAL;
1646 }
1647
1648 for (i = 0; i < num_ins; i++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001649 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 return err;
1651 }
1652
Daniel Mack99fc8642010-03-11 21:13:24 +01001653 type = le16_to_cpu(desc->wProcessType);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 for (info = list; info && info->type; info++)
1655 if (info->type == type)
1656 break;
1657 if (! info || ! info->type)
1658 info = &default_info;
1659
1660 for (valinfo = info->values; valinfo->control; valinfo++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001661 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
Daniel Mack99fc8642010-03-11 21:13:24 +01001662
1663 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 continue;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001665 map = find_map(state, unitid, valinfo->control);
1666 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 continue;
Takashi Iwai561b2202005-09-09 14:22:34 +02001668 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 if (! cval) {
1670 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1671 return -ENOMEM;
1672 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001673 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 cval->id = unitid;
1675 cval->control = valinfo->control;
1676 cval->val_type = valinfo->val_type;
1677 cval->channels = 1;
1678
1679 /* get min/max values */
Daniel Mack65f25da2010-05-31 13:35:41 +02001680 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001681 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 /* FIXME: hard-coded */
1683 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001684 cval->max = control_spec[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 cval->res = 1;
1686 cval->initialized = 1;
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001687 } else {
1688 if (type == USB_XU_CLOCK_RATE) {
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -05001689 /* E-Mu USB 0404/0202/TrackerPre/0204
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001690 * samplerate control quirk
1691 */
1692 cval->min = 0;
1693 cval->max = 5;
1694 cval->res = 1;
1695 cval->initialized = 1;
1696 } else
1697 get_min_max(cval, valinfo->min_value);
1698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
1700 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1701 if (! kctl) {
1702 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1703 kfree(cval);
1704 return -ENOMEM;
1705 }
1706 kctl->private_free = usb_mixer_elem_free;
1707
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001708 if (check_mapped_name(map, kctl->id.name,
1709 sizeof(kctl->id.name)))
1710 /* nothing */ ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 else if (info->name)
1712 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1713 else {
Daniel Mack23caaf12010-03-11 21:13:25 +01001714 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 len = 0;
1716 if (nameid)
1717 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1718 if (! len)
1719 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1720 }
Takashi Iwai08d1e632009-10-02 14:06:08 +02001721 append_ctl_name(kctl, " ");
1722 append_ctl_name(kctl, valinfo->suffix);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
1724 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1725 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001726 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 return err;
1728 }
1729 return 0;
1730}
1731
1732
Daniel Mack99fc8642010-03-11 21:13:24 +01001733static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734{
Daniel Mack99fc8642010-03-11 21:13:24 +01001735 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736}
1737
Daniel Mack99fc8642010-03-11 21:13:24 +01001738static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739{
Daniel Mack99fc8642010-03-11 21:13:24 +01001740 /* Note that we parse extension units with processing unit descriptors.
1741 * That's ok as the layout is the same */
1742 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743}
1744
1745
1746/*
1747 * Selector Unit
1748 */
1749
1750/* info callback for selector unit
1751 * use an enumerator type for routing
1752 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001753static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001755 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001756 const char **itemlist = (const char **)kcontrol->private_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757
Takashi Iwai5e246b82008-08-08 17:12:47 +02001758 if (snd_BUG_ON(!itemlist))
1759 return -EINVAL;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001760 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761}
1762
1763/* get callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001764static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001766 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 int val, err;
1768
Daniel Mack09414202010-05-31 13:35:44 +02001769 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001771 if (cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 ucontrol->value.enumerated.item[0] = 0;
1773 return 0;
1774 }
1775 return err;
1776 }
1777 val = get_relative_value(cval, val);
1778 ucontrol->value.enumerated.item[0] = val;
1779 return 0;
1780}
1781
1782/* put callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001783static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001785 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 int val, oval, err;
1787
Daniel Mack09414202010-05-31 13:35:44 +02001788 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001790 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 return 0;
1792 return err;
1793 }
1794 val = ucontrol->value.enumerated.item[0];
1795 val = get_abs_value(cval, val);
1796 if (val != oval) {
Daniel Mack09414202010-05-31 13:35:44 +02001797 set_cur_ctl_value(cval, cval->control << 8, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 return 1;
1799 }
1800 return 0;
1801}
1802
1803/* alsa control interface for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001804static struct snd_kcontrol_new mixer_selectunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1806 .name = "", /* will be filled later */
1807 .info = mixer_ctl_selector_info,
1808 .get = mixer_ctl_selector_get,
1809 .put = mixer_ctl_selector_put,
1810};
1811
1812
1813/* private free callback.
1814 * free both private_data and private_value
1815 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001816static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817{
1818 int i, num_ins = 0;
1819
1820 if (kctl->private_data) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001821 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 num_ins = cval->max;
1823 kfree(cval);
1824 kctl->private_data = NULL;
1825 }
1826 if (kctl->private_value) {
1827 char **itemlist = (char **)kctl->private_value;
1828 for (i = 0; i < num_ins; i++)
1829 kfree(itemlist[i]);
1830 kfree(itemlist);
1831 kctl->private_value = 0;
1832 }
1833}
1834
1835/*
1836 * parse a selector unit
1837 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001838static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839{
Daniel Mack99fc8642010-03-11 21:13:24 +01001840 struct uac_selector_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 unsigned int i, nameid, len;
1842 int err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001843 struct usb_mixer_elem_info *cval;
1844 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001845 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 char **namelist;
1847
Daniel Mack99fc8642010-03-11 21:13:24 +01001848 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1850 return -EINVAL;
1851 }
1852
Daniel Mack99fc8642010-03-11 21:13:24 +01001853 for (i = 0; i < desc->bNrInPins; i++) {
1854 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 return err;
1856 }
1857
Daniel Mack99fc8642010-03-11 21:13:24 +01001858 if (desc->bNrInPins == 1) /* only one ? nonsense! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 return 0;
1860
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001861 map = find_map(state, unitid, 0);
1862 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 return 0;
1864
Takashi Iwai561b2202005-09-09 14:22:34 +02001865 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 if (! cval) {
1867 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1868 return -ENOMEM;
1869 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001870 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 cval->id = unitid;
1872 cval->val_type = USB_MIXER_U8;
1873 cval->channels = 1;
1874 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001875 cval->max = desc->bNrInPins;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 cval->res = 1;
1877 cval->initialized = 1;
1878
Daniel Mack09414202010-05-31 13:35:44 +02001879 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1880 cval->control = UAC2_CX_CLOCK_SELECTOR;
1881 else
1882 cval->control = 0;
1883
Daniel Mack99fc8642010-03-11 21:13:24 +01001884 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 if (! namelist) {
1886 snd_printk(KERN_ERR "cannot malloc\n");
1887 kfree(cval);
1888 return -ENOMEM;
1889 }
1890#define MAX_ITEM_NAME_LEN 64
Daniel Mack99fc8642010-03-11 21:13:24 +01001891 for (i = 0; i < desc->bNrInPins; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001892 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 len = 0;
1894 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1895 if (! namelist[i]) {
1896 snd_printk(KERN_ERR "cannot malloc\n");
Mariusz Kozlowski7fbe3ca2007-01-08 11:25:30 +01001897 while (i--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 kfree(namelist[i]);
1899 kfree(namelist);
1900 kfree(cval);
1901 return -ENOMEM;
1902 }
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02001903 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1904 MAX_ITEM_NAME_LEN);
Daniel Mack99fc8642010-03-11 21:13:24 +01001905 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1907 if (! len)
1908 sprintf(namelist[i], "Input %d", i);
1909 }
1910
1911 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1912 if (! kctl) {
1913 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
Jesper Juhl878b4782006-03-20 11:27:13 +01001914 kfree(namelist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 kfree(cval);
1916 return -ENOMEM;
1917 }
1918 kctl->private_value = (unsigned long)namelist;
1919 kctl->private_free = usb_mixer_selector_elem_free;
1920
Daniel Mack99fc8642010-03-11 21:13:24 +01001921 nameid = uac_selector_unit_iSelector(desc);
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001922 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 if (len)
1924 ;
1925 else if (nameid)
1926 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1927 else {
1928 len = get_term_name(state, &state->oterm,
1929 kctl->id.name, sizeof(kctl->id.name), 0);
1930 if (! len)
1931 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1932
Daniel Mack09414202010-05-31 13:35:44 +02001933 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1934 append_ctl_name(kctl, " Clock Source");
1935 else if ((state->oterm.type & 0xff00) == 0x0100)
Takashi Iwai08d1e632009-10-02 14:06:08 +02001936 append_ctl_name(kctl, " Capture Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 else
Takashi Iwai08d1e632009-10-02 14:06:08 +02001938 append_ctl_name(kctl, " Playback Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 }
1940
1941 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
Daniel Mack99fc8642010-03-11 21:13:24 +01001942 cval->id, kctl->id.name, desc->bNrInPins);
Daniel Mackef9d5972011-05-25 09:09:00 +02001943 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 return err;
1945
1946 return 0;
1947}
1948
1949
1950/*
1951 * parse an audio unit recursively
1952 */
1953
Takashi Iwai86e07d32005-11-17 15:08:02 +01001954static int parse_audio_unit(struct mixer_build *state, int unitid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955{
1956 unsigned char *p1;
1957
1958 if (test_and_set_bit(unitid, state->unitbitmap))
1959 return 0; /* the unit already visited */
1960
1961 p1 = find_audio_control_unit(state, unitid);
1962 if (!p1) {
1963 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1964 return -EINVAL;
1965 }
1966
1967 switch (p1[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01001968 case UAC_INPUT_TERMINAL:
Daniel Mack09414202010-05-31 13:35:44 +02001969 case UAC2_CLOCK_SOURCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 return 0; /* NOP */
Daniel Mackde48c7b2010-02-22 23:49:13 +01001971 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 return parse_audio_mixer_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01001973 case UAC_SELECTOR_UNIT:
Daniel Mack09414202010-05-31 13:35:44 +02001974 case UAC2_CLOCK_SELECTOR:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 return parse_audio_selector_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01001976 case UAC_FEATURE_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 return parse_audio_feature_unit(state, unitid, p1);
Daniel Mack69da9bc2010-06-16 17:57:28 +02001978 case UAC1_PROCESSING_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01001979 /* UAC2_EFFECT_UNIT has the same value */
1980 if (state->mixer->protocol == UAC_VERSION_1)
1981 return parse_audio_processing_unit(state, unitid, p1);
1982 else
1983 return 0; /* FIXME - effect units not implemented yet */
Daniel Mack69da9bc2010-06-16 17:57:28 +02001984 case UAC1_EXTENSION_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01001985 /* UAC2_PROCESSING_UNIT_V2 has the same value */
1986 if (state->mixer->protocol == UAC_VERSION_1)
1987 return parse_audio_extension_unit(state, unitid, p1);
1988 else /* UAC_VERSION_2 */
1989 return parse_audio_processing_unit(state, unitid, p1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 default:
1991 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1992 return -EINVAL;
1993 }
1994}
1995
Clemens Ladisch84957a82005-04-29 16:23:13 +02001996static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1997{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02001998 kfree(mixer->id_elems);
1999 if (mixer->urb) {
2000 kfree(mixer->urb->transfer_buffer);
2001 usb_free_urb(mixer->urb);
2002 }
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002003 usb_free_urb(mixer->rc_urb);
Clemens Ladischb259b102005-04-29 16:29:28 +02002004 kfree(mixer->rc_setup_packet);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002005 kfree(mixer);
2006}
2007
Takashi Iwai86e07d32005-11-17 15:08:02 +01002008static int snd_usb_mixer_dev_free(struct snd_device *device)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002009{
2010 struct usb_mixer_interface *mixer = device->device_data;
2011 snd_usb_mixer_free(mixer);
2012 return 0;
2013}
2014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015/*
2016 * create mixer controls
2017 *
Daniel Mackde48c7b2010-02-22 23:49:13 +01002018 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 */
Clemens Ladisch84957a82005-04-29 16:23:13 +02002020static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002022 struct mixer_build state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 int err;
2024 const struct usbmix_ctl_map *map;
Daniel Mack23caaf12010-03-11 21:13:25 +01002025 void *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 memset(&state, 0, sizeof(state));
Clemens Ladisch84957a82005-04-29 16:23:13 +02002028 state.chip = mixer->chip;
2029 state.mixer = mixer;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002030 state.buffer = mixer->hostif->extra;
2031 state.buflen = mixer->hostif->extralen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032
2033 /* check the mapping table */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002034 for (map = usbmix_ctl_maps; map->id; map++) {
2035 if (map->id == state.chip->usb_id) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 state.map = map->map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002037 state.selector_map = map->selector_map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002038 mixer->ignore_ctl_error = map->ignore_ctl_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 break;
2040 }
2041 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Daniel Mack23caaf12010-03-11 21:13:25 +01002043 p = NULL;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002044 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen,
2045 p, UAC_OUTPUT_TERMINAL)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +01002046 if (mixer->protocol == UAC_VERSION_1) {
Daniel Mack69da9bc2010-06-16 17:57:28 +02002047 struct uac1_output_terminal_descriptor *desc = p;
Daniel Mack23caaf12010-03-11 21:13:25 +01002048
2049 if (desc->bLength < sizeof(*desc))
2050 continue; /* invalid descriptor? */
2051 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2052 state.oterm.id = desc->bTerminalID;
2053 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2054 state.oterm.name = desc->iTerminal;
2055 err = parse_audio_unit(&state, desc->bSourceID);
2056 if (err < 0)
2057 return err;
2058 } else { /* UAC_VERSION_2 */
2059 struct uac2_output_terminal_descriptor *desc = p;
2060
2061 if (desc->bLength < sizeof(*desc))
2062 continue; /* invalid descriptor? */
2063 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2064 state.oterm.id = desc->bTerminalID;
2065 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2066 state.oterm.name = desc->iTerminal;
2067 err = parse_audio_unit(&state, desc->bSourceID);
2068 if (err < 0)
2069 return err;
Daniel Mack09414202010-05-31 13:35:44 +02002070
2071 /* for UAC2, use the same approach to also add the clock selectors */
2072 err = parse_audio_unit(&state, desc->bCSourceID);
2073 if (err < 0)
2074 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +01002075 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 }
Daniel Mack23caaf12010-03-11 21:13:25 +01002077
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 return 0;
2079}
Clemens Ladisch84957a82005-04-29 16:23:13 +02002080
Daniel Mack7b1eda22010-03-11 21:13:22 +01002081void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002082{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002083 struct usb_mixer_elem_info *info;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002084
2085 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
2086 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2087 info->elem_id);
2088}
2089
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002090static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2091 int unitid,
2092 struct usb_mixer_elem_info *cval)
2093{
2094 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2095 "S8", "U8", "S16", "U16"};
2096 snd_iprintf(buffer, " Unit: %i\n", unitid);
2097 if (cval->elem_id)
2098 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
2099 cval->elem_id->name, cval->elem_id->index);
2100 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2101 "channels=%i, type=\"%s\"\n", cval->id,
2102 cval->control, cval->cmask, cval->channels,
2103 val_types[cval->val_type]);
2104 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2105 cval->min, cval->max, cval->dBmin, cval->dBmax);
2106}
2107
2108static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2109 struct snd_info_buffer *buffer)
2110{
2111 struct snd_usb_audio *chip = entry->private_data;
2112 struct usb_mixer_interface *mixer;
2113 struct usb_mixer_elem_info *cval;
2114 int unitid;
2115
2116 list_for_each_entry(mixer, &chip->mixer_list, list) {
2117 snd_iprintf(buffer,
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002118 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002119 chip->usb_id, snd_usb_ctrl_intf(chip),
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002120 mixer->ignore_ctl_error);
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002121 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2122 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2123 for (cval = mixer->id_elems[unitid]; cval;
2124 cval = cval->next_id_elem)
2125 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2126 }
2127 }
2128}
2129
Daniel Macke213e9c2010-05-11 18:13:50 +02002130static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2131 int attribute, int value, int index)
2132{
2133 struct usb_mixer_elem_info *info;
2134 __u8 unitid = (index >> 8) & 0xff;
2135 __u8 control = (value >> 8) & 0xff;
2136 __u8 channel = value & 0xff;
2137
2138 if (channel >= MAX_CHANNELS) {
2139 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2140 __func__, channel);
2141 return;
2142 }
2143
2144 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2145 if (info->control != control)
2146 continue;
2147
2148 switch (attribute) {
2149 case UAC2_CS_CUR:
2150 /* invalidate cache, so the value is read from the device */
2151 if (channel)
2152 info->cached &= ~(1 << channel);
2153 else /* master channel */
2154 info->cached = 0;
2155
2156 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2157 info->elem_id);
2158 break;
2159
2160 case UAC2_CS_RANGE:
2161 /* TODO */
2162 break;
2163
2164 case UAC2_CS_MEM:
2165 /* TODO */
2166 break;
2167
2168 default:
2169 snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2170 attribute);
2171 break;
2172 } /* switch */
2173 }
2174}
2175
2176static void snd_usb_mixer_interrupt(struct urb *urb)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002177{
2178 struct usb_mixer_interface *mixer = urb->context;
Daniel Macke213e9c2010-05-11 18:13:50 +02002179 int len = urb->actual_length;
Oliver Neukumedf7de32011-03-11 13:19:43 +01002180 int ustatus = urb->status;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002181
Oliver Neukumedf7de32011-03-11 13:19:43 +01002182 if (ustatus != 0)
Daniel Macke213e9c2010-05-11 18:13:50 +02002183 goto requeue;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002184
Daniel Macke213e9c2010-05-11 18:13:50 +02002185 if (mixer->protocol == UAC_VERSION_1) {
2186 struct uac1_status_word *status;
2187
2188 for (status = urb->transfer_buffer;
2189 len >= sizeof(*status);
2190 len -= sizeof(*status), status++) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002191 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
Daniel Macke213e9c2010-05-11 18:13:50 +02002192 status->bStatusType,
2193 status->bOriginator);
2194
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002195 /* ignore any notifications not from the control interface */
Daniel Macke213e9c2010-05-11 18:13:50 +02002196 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2197 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002198 continue;
Daniel Macke213e9c2010-05-11 18:13:50 +02002199
2200 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2201 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
Clemens Ladischb259b102005-04-29 16:29:28 +02002202 else
Daniel Macke213e9c2010-05-11 18:13:50 +02002203 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2204 }
2205 } else { /* UAC_VERSION_2 */
2206 struct uac2_interrupt_data_msg *msg;
2207
2208 for (msg = urb->transfer_buffer;
2209 len >= sizeof(*msg);
2210 len -= sizeof(*msg), msg++) {
2211 /* drop vendor specific and endpoint requests */
2212 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2213 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2214 continue;
2215
2216 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2217 le16_to_cpu(msg->wValue),
2218 le16_to_cpu(msg->wIndex));
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002219 }
2220 }
Daniel Macke213e9c2010-05-11 18:13:50 +02002221
2222requeue:
Oliver Neukumedf7de32011-03-11 13:19:43 +01002223 if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002224 urb->dev = mixer->chip->dev;
2225 usb_submit_urb(urb, GFP_ATOMIC);
2226 }
2227}
2228
Oliver Neukumedf7de32011-03-11 13:19:43 +01002229/* stop any bus activity of a mixer */
2230void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2231{
2232 usb_kill_urb(mixer->urb);
2233 usb_kill_urb(mixer->rc_urb);
2234}
2235
2236int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2237{
2238 int err;
2239
2240 if (mixer->urb) {
2241 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2242 if (err < 0)
2243 return err;
2244 }
2245
2246 return 0;
2247}
2248
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002249/* create the handler for the optional status interrupt endpoint */
2250static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2251{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002252 struct usb_endpoint_descriptor *ep;
2253 void *transfer_buffer;
2254 int buffer_length;
2255 unsigned int epnum;
2256
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002257 /* we need one interrupt input endpoint */
Daniel Mack1faa5d02011-08-04 15:56:28 +02002258 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002259 return 0;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002260 ep = get_endpoint(mixer->hostif, 0);
Julia Lawall913ae5a2009-01-03 17:54:53 +01002261 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002262 return 0;
2263
Julia Lawall42a6e662008-12-29 11:23:02 +01002264 epnum = usb_endpoint_num(ep);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002265 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2266 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2267 if (!transfer_buffer)
2268 return -ENOMEM;
2269 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2270 if (!mixer->urb) {
2271 kfree(transfer_buffer);
2272 return -ENOMEM;
2273 }
2274 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2275 usb_rcvintpipe(mixer->chip->dev, epnum),
2276 transfer_buffer, buffer_length,
Daniel Macke213e9c2010-05-11 18:13:50 +02002277 snd_usb_mixer_interrupt, mixer, ep->bInterval);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002278 usb_submit_urb(mixer->urb, GFP_KERNEL);
2279 return 0;
2280}
2281
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002282int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2283 int ignore_error)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002284{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002285 static struct snd_device_ops dev_ops = {
Clemens Ladisch84957a82005-04-29 16:23:13 +02002286 .dev_free = snd_usb_mixer_dev_free
2287 };
2288 struct usb_mixer_interface *mixer;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002289 struct snd_info_entry *entry;
Daniel Mack23caaf12010-03-11 21:13:25 +01002290 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002291
2292 strcpy(chip->card->mixername, "USB Mixer");
2293
Takashi Iwai561b2202005-09-09 14:22:34 +02002294 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002295 if (!mixer)
2296 return -ENOMEM;
2297 mixer->chip = chip;
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002298 mixer->ignore_ctl_error = ignore_error;
Jaroslav Kysela291186e2010-02-16 11:55:18 +01002299 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2300 GFP_KERNEL);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002301 if (!mixer->id_elems) {
2302 kfree(mixer);
2303 return -ENOMEM;
2304 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02002305
Daniel Mack1faa5d02011-08-04 15:56:28 +02002306 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2307 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +02002308 case UAC_VERSION_1:
2309 default:
2310 mixer->protocol = UAC_VERSION_1;
2311 break;
2312 case UAC_VERSION_2:
2313 mixer->protocol = UAC_VERSION_2;
2314 break;
2315 }
Daniel Mack7b8a0432010-02-22 23:49:12 +01002316
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002317 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002318 (err = snd_usb_mixer_status_create(mixer)) < 0)
2319 goto _error;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002320
Daniel Mack7b1eda22010-03-11 21:13:22 +01002321 snd_usb_mixer_apply_create_quirk(mixer);
Clemens Ladisch468b8fd2009-07-13 11:39:29 +02002322
Clemens Ladisch84957a82005-04-29 16:23:13 +02002323 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002324 if (err < 0)
2325 goto _error;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002326
2327 if (list_empty(&chip->mixer_list) &&
2328 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2329 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2330
Clemens Ladisch84957a82005-04-29 16:23:13 +02002331 list_add(&mixer->list, &chip->mixer_list);
2332 return 0;
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002333
2334_error:
2335 snd_usb_mixer_free(mixer);
2336 return err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002337}
2338
2339void snd_usb_mixer_disconnect(struct list_head *p)
2340{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002341 struct usb_mixer_interface *mixer;
Daniel Mack7b1eda22010-03-11 21:13:22 +01002342
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002343 mixer = list_entry(p, struct usb_mixer_interface, list);
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002344 usb_kill_urb(mixer->urb);
2345 usb_kill_urb(mixer->rc_urb);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002346}