blob: fe56c9da38e9e6c78cdd6706f09e9639d8a502ab [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;
Oliver Neukum88a85162011-03-11 14:51:12 +0100290 int 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 while (timeout-- > 0) {
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200296 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200298 validx, snd_usb_ctrl_intf(chip) | (cval->id << 8),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200299 buf, val_len) >= val_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
Oliver Neukum88a85162011-03-11 14:51:12 +0100301 snd_usb_autosuspend(cval->mixer->chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 return 0;
303 }
304 }
Oliver Neukum88a85162011-03-11 14:51:12 +0100305 snd_usb_autosuspend(cval->mixer->chip);
Clemens Ladisch84957a82005-04-29 16:23:13 +0200306 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Takashi Iwaib415ec72010-06-24 08:07:28 +0200307 request, validx, snd_usb_ctrl_intf(chip) | (cval->id << 8), cval->val_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 return -EINVAL;
309}
310
Daniel Mack23caaf12010-03-11 21:13:25 +0100311static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
312{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200313 struct snd_usb_audio *chip = cval->mixer->chip;
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200314 unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */
Daniel Mack23caaf12010-03-11 21:13:25 +0100315 unsigned char *val;
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200316 int ret, size;
Daniel Mack23caaf12010-03-11 21:13:25 +0100317 __u8 bRequest;
318
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200319 if (request == UAC_GET_CUR) {
320 bRequest = UAC2_CS_CUR;
321 size = sizeof(__u16);
322 } else {
323 bRequest = UAC2_CS_RANGE;
324 size = sizeof(buf);
325 }
326
327 memset(buf, 0, sizeof(buf));
Daniel Mack23caaf12010-03-11 21:13:25 +0100328
Oliver Neukum88a85162011-03-11 14:51:12 +0100329 ret = snd_usb_autoresume(chip) ? -EIO : 0;
330 if (ret)
331 goto error;
332
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200333 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
Daniel Mack23caaf12010-03-11 21:13:25 +0100334 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200335 validx, snd_usb_ctrl_intf(chip) | (cval->id << 8),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200336 buf, size);
Oliver Neukum88a85162011-03-11 14:51:12 +0100337 snd_usb_autosuspend(chip);
Daniel Mack23caaf12010-03-11 21:13:25 +0100338
339 if (ret < 0) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100340error:
Daniel Mack09414202010-05-31 13:35:44 +0200341 snd_printk(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200342 request, validx, snd_usb_ctrl_intf(chip) | (cval->id << 8), cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100343 return ret;
344 }
345
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200346 /* FIXME: how should we handle multiple triplets here? */
347
Daniel Mack23caaf12010-03-11 21:13:25 +0100348 switch (request) {
349 case UAC_GET_CUR:
350 val = buf;
351 break;
352 case UAC_GET_MIN:
353 val = buf + sizeof(__u16);
354 break;
355 case UAC_GET_MAX:
356 val = buf + sizeof(__u16) * 2;
357 break;
358 case UAC_GET_RES:
359 val = buf + sizeof(__u16) * 3;
360 break;
361 default:
362 return -EINVAL;
363 }
364
365 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
366
367 return 0;
368}
369
370static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
371{
372 return (cval->mixer->protocol == UAC_VERSION_1) ?
373 get_ctl_value_v1(cval, request, validx, value_ret) :
374 get_ctl_value_v2(cval, request, validx, value_ret);
375}
376
Takashi Iwai86e07d32005-11-17 15:08:02 +0100377static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100379 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380}
381
382/* channel = 0: master, 1 = first channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100383static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
384 int channel, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100386 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387}
388
Takashi Iwai641b4872009-01-15 17:05:24 +0100389static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
390 int channel, int index, int *value)
391{
392 int err;
393
394 if (cval->cached & (1 << channel)) {
395 *value = cval->cache_val[index];
396 return 0;
397 }
398 err = get_cur_mix_raw(cval, channel, value);
399 if (err < 0) {
400 if (!cval->mixer->ignore_ctl_error)
Daniel Mack23caaf12010-03-11 21:13:25 +0100401 snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
Takashi Iwai641b4872009-01-15 17:05:24 +0100402 cval->control, channel, err);
403 return err;
404 }
405 cval->cached |= 1 << channel;
406 cval->cache_val[index] = *value;
407 return 0;
408}
409
410
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411/*
412 * set a mixer value
413 */
414
Daniel Mack7b1eda22010-03-11 21:13:22 +0100415int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
416 int request, int validx, int value_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200418 struct snd_usb_audio *chip = cval->mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 unsigned char buf[2];
Oliver Neukum88a85162011-03-11 14:51:12 +0100420 int val_len, err, timeout = 10;
Daniel Mack23caaf12010-03-11 21:13:25 +0100421
422 if (cval->mixer->protocol == UAC_VERSION_1) {
423 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
424 } else { /* UAC_VERSION_2 */
425 /* audio class v2 controls are always 2 bytes in size */
426 val_len = sizeof(__u16);
427
428 /* FIXME */
429 if (request != UAC_SET_CUR) {
430 snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
431 return -EINVAL;
432 }
433
434 request = UAC2_CS_CUR;
435 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437 value_set = convert_bytes_value(cval, value_set);
438 buf[0] = value_set & 0xff;
439 buf[1] = (value_set >> 8) & 0xff;
Oliver Neukum88a85162011-03-11 14:51:12 +0100440 err = snd_usb_autoresume(chip);
441 if (err < 0)
442 return -EIO;
Viral Mehtacf3f9132009-04-03 13:08:14 +0530443 while (timeout-- > 0)
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200444 if (snd_usb_ctl_msg(chip->dev,
445 usb_sndctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200447 validx, snd_usb_ctrl_intf(chip) | (cval->id << 8),
Clemens Ladisch17d900c2011-09-26 21:15:27 +0200448 buf, val_len) >= 0) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100449 snd_usb_autosuspend(chip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 return 0;
Oliver Neukum88a85162011-03-11 14:51:12 +0100451 }
452 snd_usb_autosuspend(chip);
Clemens Ladisch84957a82005-04-29 16:23:13 +0200453 snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200454 request, validx, snd_usb_ctrl_intf(chip) | (cval->id << 8), cval->val_type, buf[0], buf[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 return -EINVAL;
456}
457
Takashi Iwai86e07d32005-11-17 15:08:02 +0100458static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459{
Daniel Mack7b1eda22010-03-11 21:13:22 +0100460 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461}
462
Takashi Iwai641b4872009-01-15 17:05:24 +0100463static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
464 int index, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465{
Takashi Iwai641b4872009-01-15 17:05:24 +0100466 int err;
Daniel Macka6a33252010-05-31 13:35:37 +0200467 unsigned int read_only = (channel == 0) ?
468 cval->master_readonly :
469 cval->ch_readonly & (1 << (channel - 1));
470
471 if (read_only) {
472 snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
473 __func__, channel, cval->control);
474 return 0;
475 }
476
Daniel Mack7b1eda22010-03-11 21:13:22 +0100477 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
Takashi Iwai641b4872009-01-15 17:05:24 +0100478 value);
479 if (err < 0)
480 return err;
481 cval->cached |= 1 << channel;
482 cval->cache_val[index] = value;
483 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484}
485
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200486/*
487 * TLV callback for mixer volume controls
488 */
Felix Homann285de9c2012-04-23 20:24:24 +0200489int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200490 unsigned int size, unsigned int __user *_tlv)
491{
492 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Takashi Iwaib8e1c732009-06-16 14:04:37 +0200493 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200494
495 if (size < sizeof(scale))
496 return -ENOMEM;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100497 scale[2] = cval->dBmin;
498 scale[3] = cval->dBmax;
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200499 if (copy_to_user(_tlv, scale, sizeof(scale)))
500 return -EFAULT;
501 return 0;
502}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
504/*
505 * parser routines begin here...
506 */
507
Takashi Iwai86e07d32005-11-17 15:08:02 +0100508static int parse_audio_unit(struct mixer_build *state, int unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
510
511/*
512 * check if the input/output channel routing is enabled on the given bitmap.
513 * used for mixer unit parser
514 */
515static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
516{
517 int idx = ich * num_outs + och;
518 return bmap[idx >> 3] & (0x80 >> (idx & 7));
519}
520
521
522/*
523 * add an alsa control element
524 * search and increment the index until an empty slot is found.
525 *
526 * if failed, give up and free the control instance.
527 */
528
Daniel Mackef9d5972011-05-25 09:09:00 +0200529int snd_usb_mixer_add_control(struct usb_mixer_interface *mixer,
530 struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100532 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200534
Daniel Mackef9d5972011-05-25 09:09:00 +0200535 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 kctl->id.index++;
Daniel Mackef9d5972011-05-25 09:09:00 +0200537 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200539 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 }
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200541 cval->elem_id = &kctl->id;
Daniel Mackef9d5972011-05-25 09:09:00 +0200542 cval->next_id_elem = mixer->id_elems[cval->id];
543 mixer->id_elems[cval->id] = cval;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200544 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545}
546
547
548/*
549 * get a terminal name string
550 */
551
552static struct iterm_name_combo {
553 int type;
554 char *name;
555} iterm_names[] = {
556 { 0x0300, "Output" },
557 { 0x0301, "Speaker" },
558 { 0x0302, "Headphone" },
559 { 0x0303, "HMD Audio" },
560 { 0x0304, "Desktop Speaker" },
561 { 0x0305, "Room Speaker" },
562 { 0x0306, "Com Speaker" },
563 { 0x0307, "LFE" },
564 { 0x0600, "External In" },
565 { 0x0601, "Analog In" },
566 { 0x0602, "Digital In" },
567 { 0x0603, "Line" },
568 { 0x0604, "Legacy In" },
569 { 0x0605, "IEC958 In" },
570 { 0x0606, "1394 DA Stream" },
571 { 0x0607, "1394 DV Stream" },
572 { 0x0700, "Embedded" },
573 { 0x0701, "Noise Source" },
574 { 0x0702, "Equalization Noise" },
575 { 0x0703, "CD" },
576 { 0x0704, "DAT" },
577 { 0x0705, "DCC" },
578 { 0x0706, "MiniDisk" },
579 { 0x0707, "Analog Tape" },
580 { 0x0708, "Phonograph" },
581 { 0x0709, "VCR Audio" },
582 { 0x070a, "Video Disk Audio" },
583 { 0x070b, "DVD Audio" },
584 { 0x070c, "TV Tuner Audio" },
585 { 0x070d, "Satellite Rec Audio" },
586 { 0x070e, "Cable Tuner Audio" },
587 { 0x070f, "DSS Audio" },
588 { 0x0710, "Radio Receiver" },
589 { 0x0711, "Radio Transmitter" },
590 { 0x0712, "Multi-Track Recorder" },
591 { 0x0713, "Synthesizer" },
592 { 0 },
593};
594
Takashi Iwai86e07d32005-11-17 15:08:02 +0100595static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 unsigned char *name, int maxlen, int term_only)
597{
598 struct iterm_name_combo *names;
599
600 if (iterm->name)
601 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
602
603 /* virtual type - not a real terminal */
604 if (iterm->type >> 16) {
605 if (term_only)
606 return 0;
607 switch (iterm->type >> 16) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100608 case UAC_SELECTOR_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 strcpy(name, "Selector"); return 8;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200610 case UAC1_PROCESSING_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 strcpy(name, "Process Unit"); return 12;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200612 case UAC1_EXTENSION_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 strcpy(name, "Ext Unit"); return 8;
Daniel Mackde48c7b2010-02-22 23:49:13 +0100614 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 strcpy(name, "Mixer"); return 5;
616 default:
617 return sprintf(name, "Unit %d", iterm->id);
618 }
619 }
620
621 switch (iterm->type & 0xff00) {
622 case 0x0100:
623 strcpy(name, "PCM"); return 3;
624 case 0x0200:
625 strcpy(name, "Mic"); return 3;
626 case 0x0400:
627 strcpy(name, "Headset"); return 7;
628 case 0x0500:
629 strcpy(name, "Phone"); return 5;
630 }
631
632 for (names = iterm_names; names->type; names++)
633 if (names->type == iterm->type) {
634 strcpy(name, names->name);
635 return strlen(names->name);
636 }
637 return 0;
638}
639
640
641/*
642 * parse the source unit recursively until it reaches to a terminal
643 * or a branched unit.
644 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100645static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
Daniel Mack09414202010-05-31 13:35:44 +0200647 int err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100648 void *p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
650 memset(term, 0, sizeof(*term));
651 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100652 unsigned char *hdr = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100654 switch (hdr[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100655 case UAC_INPUT_TERMINAL:
Daniel Mack23caaf12010-03-11 21:13:25 +0100656 if (state->mixer->protocol == UAC_VERSION_1) {
657 struct uac_input_terminal_descriptor *d = p1;
658 term->type = le16_to_cpu(d->wTerminalType);
659 term->channels = d->bNrChannels;
660 term->chconfig = le16_to_cpu(d->wChannelConfig);
661 term->name = d->iTerminal;
662 } else { /* UAC_VERSION_2 */
663 struct uac2_input_terminal_descriptor *d = p1;
664 term->type = le16_to_cpu(d->wTerminalType);
665 term->channels = d->bNrChannels;
666 term->chconfig = le32_to_cpu(d->bmChannelConfig);
667 term->name = d->iTerminal;
Daniel Mack09414202010-05-31 13:35:44 +0200668
669 /* call recursively to get the clock selectors */
670 err = check_input_term(state, d->bCSourceID, term);
671 if (err < 0)
672 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100673 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100675 case UAC_FEATURE_UNIT: {
676 /* the header is the same for v1 and v2 */
677 struct uac_feature_unit_descriptor *d = p1;
Daniel Mack5e688882010-05-08 11:24:56 +0200678 id = d->bSourceID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 break; /* continue to parse */
Daniel Mack23caaf12010-03-11 21:13:25 +0100680 }
681 case UAC_MIXER_UNIT: {
682 struct uac_mixer_unit_descriptor *d = p1;
683 term->type = d->bDescriptorSubtype << 16; /* virtual type */
684 term->channels = uac_mixer_unit_bNrChannels(d);
685 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
686 term->name = uac_mixer_unit_iMixer(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100688 }
Daniel Mack09414202010-05-31 13:35:44 +0200689 case UAC_SELECTOR_UNIT:
690 case UAC2_CLOCK_SELECTOR: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100691 struct uac_selector_unit_descriptor *d = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 /* call recursively to retrieve the channel info */
Daniel Mack23caaf12010-03-11 21:13:25 +0100693 if (check_input_term(state, d->baSourceID[0], term) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 return -ENODEV;
Daniel Mack23caaf12010-03-11 21:13:25 +0100695 term->type = d->bDescriptorSubtype << 16; /* virtual type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100697 term->name = uac_selector_unit_iSelector(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100699 }
Daniel Mack69da9bc2010-06-16 17:57:28 +0200700 case UAC1_PROCESSING_UNIT:
701 case UAC1_EXTENSION_UNIT: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100702 struct uac_processing_unit_descriptor *d = p1;
703 if (d->bNrInPins) {
704 id = d->baSourceID[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 break; /* continue to parse */
706 }
Daniel Mack23caaf12010-03-11 21:13:25 +0100707 term->type = d->bDescriptorSubtype << 16; /* virtual type */
708 term->channels = uac_processing_unit_bNrChannels(d);
709 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
710 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100712 }
Daniel Mack09414202010-05-31 13:35:44 +0200713 case UAC2_CLOCK_SOURCE: {
714 struct uac_clock_source_descriptor *d = p1;
715 term->type = d->bDescriptorSubtype << 16; /* virtual type */
716 term->id = id;
717 term->name = d->iClockSource;
718 return 0;
719 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 default:
721 return -ENODEV;
722 }
723 }
724 return -ENODEV;
725}
726
727
728/*
729 * Feature Unit
730 */
731
732/* feature unit control information */
733struct usb_feature_control_info {
734 const char *name;
735 unsigned int type; /* control type (mute, volume, etc.) */
736};
737
738static struct usb_feature_control_info audio_feature_info[] = {
Daniel Mack2e0281d2010-05-31 13:35:42 +0200739 { "Mute", USB_MIXER_INV_BOOLEAN },
740 { "Volume", USB_MIXER_S16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 { "Tone Control - Bass", USB_MIXER_S8 },
742 { "Tone Control - Mid", USB_MIXER_S8 },
743 { "Tone Control - Treble", USB_MIXER_S8 },
744 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
Daniel Mack2e0281d2010-05-31 13:35:42 +0200745 { "Auto Gain Control", USB_MIXER_BOOLEAN },
746 { "Delay Control", USB_MIXER_U16 },
747 { "Bass Boost", USB_MIXER_BOOLEAN },
748 { "Loudness", USB_MIXER_BOOLEAN },
749 /* UAC2 specific */
750 { "Input Gain Control", USB_MIXER_U16 },
751 { "Input Gain Pad Control", USB_MIXER_BOOLEAN },
752 { "Phase Inverter Control", USB_MIXER_BOOLEAN },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753};
754
755
756/* private_free callback */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100757static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
Jesper Juhl4d572772005-05-30 17:30:32 +0200759 kfree(kctl->private_data);
760 kctl->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761}
762
763
764/*
765 * interface to ALSA control for feature/mixer units
766 */
767
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100768/* volume control quirks */
769static void volume_control_quirks(struct usb_mixer_elem_info *cval,
770 struct snd_kcontrol *kctl)
771{
772 switch (cval->mixer->chip->usb_id) {
Felix Homannd34bf142012-04-23 20:24:27 +0200773 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
774 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
775 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
776 snd_printk(KERN_INFO
777 "usb-audio: set quirk for FTU Effect Duration\n");
778 cval->min = 0x0000;
779 cval->max = 0x7f00;
780 cval->res = 0x0100;
781 break;
782 }
783 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
784 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
785 snd_printk(KERN_INFO
786 "usb-audio: set quirks for FTU Effect Feedback/Volume\n");
787 cval->min = 0x00;
788 cval->max = 0x7f;
789 break;
790 }
791 break;
792
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100793 case USB_ID(0x0471, 0x0101):
794 case USB_ID(0x0471, 0x0104):
795 case USB_ID(0x0471, 0x0105):
796 case USB_ID(0x0672, 0x1041):
797 /* quirk for UDA1321/N101.
798 * note that detection between firmware 2.1.1.7 (N101)
799 * and later 2.1.1.21 is not very clear from datasheets.
800 * I hope that the min value is -15360 for newer firmware --jk
801 */
802 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
803 cval->min == -15616) {
804 snd_printk(KERN_INFO
805 "set volume quirk for UDA1321/N101 chip\n");
806 cval->max = -256;
807 }
808 break;
809
810 case USB_ID(0x046d, 0x09a4):
811 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
812 snd_printk(KERN_INFO
813 "set volume quirk for QuickCam E3500\n");
814 cval->min = 6080;
815 cval->max = 8768;
816 cval->res = 192;
817 }
818 break;
819
820 case USB_ID(0x046d, 0x0808):
821 case USB_ID(0x046d, 0x0809):
Alexey Fisher55c00082011-11-09 11:39:24 +0100822 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100823 case USB_ID(0x046d, 0x0991):
824 /* Most audio usb devices lie about volume resolution.
825 * Most Logitech webcams have res = 384.
826 * Proboly there is some logitech magic behind this number --fishor
827 */
828 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
829 snd_printk(KERN_INFO
830 "set resolution quirk: cval->res = 384\n");
831 cval->res = 384;
832 }
833 break;
834
835 }
836}
837
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838/*
839 * retrieve the minimum and maximum values for the specified control
840 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100841static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
842 int default_min, struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843{
844 /* for failsafe */
845 cval->min = default_min;
846 cval->max = cval->min + 1;
847 cval->res = 1;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100848 cval->dBmin = cval->dBmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
850 if (cval->val_type == USB_MIXER_BOOLEAN ||
851 cval->val_type == USB_MIXER_INV_BOOLEAN) {
852 cval->initialized = 1;
853 } else {
854 int minchn = 0;
855 if (cval->cmask) {
856 int i;
857 for (i = 0; i < MAX_CHANNELS; i++)
858 if (cval->cmask & (1 << i)) {
859 minchn = i + 1;
860 break;
861 }
862 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100863 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
864 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +0200865 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
Takashi Iwai1a4e34e2010-09-16 07:42:34 +0200866 cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 return -EINVAL;
868 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100869 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 cval->res = 1;
871 } else {
872 int last_valid_res = cval->res;
873
874 while (cval->res > 1) {
Daniel Mack7b1eda22010-03-11 21:13:22 +0100875 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
876 (cval->control << 8) | minchn, cval->res / 2) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 break;
878 cval->res /= 2;
879 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100880 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 cval->res = last_valid_res;
882 }
883 if (cval->res == 0)
884 cval->res = 1;
Takashi Iwai14790f12006-03-28 17:58:28 +0200885
886 /* Additional checks for the proper resolution
887 *
888 * Some devices report smaller resolutions than actually
889 * reacting. They don't return errors but simply clip
890 * to the lower aligned value.
891 */
892 if (cval->min + cval->res < cval->max) {
893 int last_valid_res = cval->res;
894 int saved, test, check;
Takashi Iwai641b4872009-01-15 17:05:24 +0100895 get_cur_mix_raw(cval, minchn, &saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200896 for (;;) {
897 test = saved;
898 if (test < cval->max)
899 test += cval->res;
900 else
901 test -= cval->res;
902 if (test < cval->min || test > cval->max ||
Takashi Iwai641b4872009-01-15 17:05:24 +0100903 set_cur_mix_value(cval, minchn, 0, test) ||
904 get_cur_mix_raw(cval, minchn, &check)) {
Takashi Iwai14790f12006-03-28 17:58:28 +0200905 cval->res = last_valid_res;
906 break;
907 }
908 if (test == check)
909 break;
910 cval->res *= 2;
911 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100912 set_cur_mix_value(cval, minchn, 0, saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200913 }
914
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 cval->initialized = 1;
916 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100917
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100918 if (kctl)
919 volume_control_quirks(cval, kctl);
920
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100921 /* USB descriptions contain the dB scale in 1/256 dB unit
922 * while ALSA TLV contains in 1/100 dB unit
923 */
924 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
925 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
926 if (cval->dBmin > cval->dBmax) {
927 /* something is wrong; assume it's either from/to 0dB */
928 if (cval->dBmin < 0)
929 cval->dBmax = 0;
930 else if (cval->dBmin > 0)
931 cval->dBmin = 0;
932 if (cval->dBmin > cval->dBmax) {
933 /* totally crap, return an error */
934 return -EINVAL;
935 }
936 }
937
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 return 0;
939}
940
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100941#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
943/* get a feature/mixer unit info */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100944static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100946 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
948 if (cval->val_type == USB_MIXER_BOOLEAN ||
949 cval->val_type == USB_MIXER_INV_BOOLEAN)
950 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
951 else
952 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
953 uinfo->count = cval->channels;
954 if (cval->val_type == USB_MIXER_BOOLEAN ||
955 cval->val_type == USB_MIXER_INV_BOOLEAN) {
956 uinfo->value.integer.min = 0;
957 uinfo->value.integer.max = 1;
958 } else {
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +0200959 if (!cval->initialized) {
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100960 get_min_max_with_quirks(cval, 0, kcontrol);
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +0200961 if (cval->initialized && cval->dBmin >= cval->dBmax) {
962 kcontrol->vd[0].access &=
963 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
964 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
965 snd_ctl_notify(cval->mixer->chip->card,
966 SNDRV_CTL_EVENT_MASK_INFO,
967 &kcontrol->id);
968 }
969 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 uinfo->value.integer.min = 0;
Takashi Iwai14790f12006-03-28 17:58:28 +0200971 uinfo->value.integer.max =
972 (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 }
974 return 0;
975}
976
977/* get the current value from feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100978static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100980 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 int c, cnt, val, err;
982
Takashi Iwai641b4872009-01-15 17:05:24 +0100983 ucontrol->value.integer.value[0] = cval->min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 if (cval->cmask) {
985 cnt = 0;
986 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +0100987 if (!(cval->cmask & (1 << c)))
988 continue;
989 err = get_cur_mix_value(cval, c + 1, cnt, &val);
990 if (err < 0)
991 return cval->mixer->ignore_ctl_error ? 0 : err;
992 val = get_relative_value(cval, val);
993 ucontrol->value.integer.value[cnt] = val;
994 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100996 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 } else {
998 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100999 err = get_cur_mix_value(cval, 0, 0, &val);
1000 if (err < 0)
1001 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 val = get_relative_value(cval, val);
1003 ucontrol->value.integer.value[0] = val;
1004 }
1005 return 0;
1006}
1007
1008/* put the current value to feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001009static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001011 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 int c, cnt, val, oval, err;
1013 int changed = 0;
1014
1015 if (cval->cmask) {
1016 cnt = 0;
1017 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001018 if (!(cval->cmask & (1 << c)))
1019 continue;
1020 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
1021 if (err < 0)
1022 return cval->mixer->ignore_ctl_error ? 0 : err;
1023 val = ucontrol->value.integer.value[cnt];
1024 val = get_abs_value(cval, val);
1025 if (oval != val) {
1026 set_cur_mix_value(cval, c + 1, cnt, val);
1027 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001029 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 }
1031 } else {
1032 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +01001033 err = get_cur_mix_value(cval, 0, 0, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 if (err < 0)
Takashi Iwai641b4872009-01-15 17:05:24 +01001035 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 val = ucontrol->value.integer.value[0];
1037 val = get_abs_value(cval, val);
1038 if (val != oval) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001039 set_cur_mix_value(cval, 0, 0, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 changed = 1;
1041 }
1042 }
1043 return changed;
1044}
1045
Takashi Iwai86e07d32005-11-17 15:08:02 +01001046static struct snd_kcontrol_new usb_feature_unit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1048 .name = "", /* will be filled later manually */
1049 .info = mixer_ctl_feature_info,
1050 .get = mixer_ctl_feature_get,
1051 .put = mixer_ctl_feature_put,
1052};
1053
Daniel Mack23caaf12010-03-11 21:13:25 +01001054/* the read-only variant */
1055static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1056 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1057 .name = "", /* will be filled later manually */
1058 .info = mixer_ctl_feature_info,
1059 .get = mixer_ctl_feature_get,
1060 .put = NULL,
1061};
1062
Daniel Mack9e386582011-05-25 09:09:01 +02001063/* This symbol is exported in order to allow the mixer quirks to
1064 * hook up to the standard feature unit control mechanism */
1065struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
1067/*
1068 * build a feature control
1069 */
1070
Takashi Iwai08d1e632009-10-02 14:06:08 +02001071static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1072{
1073 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1074}
1075
Daniel Mack99fc8642010-03-11 21:13:24 +01001076static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 unsigned int ctl_mask, int control,
Daniel Mack23caaf12010-03-11 21:13:25 +01001078 struct usb_audio_term *iterm, int unitid,
Daniel Macka6a33252010-05-31 13:35:37 +02001079 int readonly_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080{
Daniel Mack99fc8642010-03-11 21:13:24 +01001081 struct uac_feature_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 unsigned int len = 0;
1083 int mapped_name = 0;
Daniel Mack99fc8642010-03-11 21:13:24 +01001084 int nameid = uac_feature_unit_iFeature(desc);
Takashi Iwai86e07d32005-11-17 15:08:02 +01001085 struct snd_kcontrol *kctl;
1086 struct usb_mixer_elem_info *cval;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001087 const struct usbmix_name_map *map;
Alexey Fisher80aceff2011-03-10 14:53:38 +01001088 unsigned int range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
1090 control++; /* change from zero-based to 1-based value */
1091
Daniel Mack65f25da2010-05-31 13:35:41 +02001092 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 /* FIXME: not supported yet */
1094 return;
1095 }
1096
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001097 map = find_map(state, unitid, control);
1098 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 return;
1100
Takashi Iwai561b2202005-09-09 14:22:34 +02001101 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 if (! cval) {
1103 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1104 return;
1105 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001106 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 cval->id = unitid;
1108 cval->control = control;
1109 cval->cmask = ctl_mask;
1110 cval->val_type = audio_feature_info[control-1].type;
Daniel Macka6a33252010-05-31 13:35:37 +02001111 if (ctl_mask == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 cval->channels = 1; /* master channel */
Daniel Macka6a33252010-05-31 13:35:37 +02001113 cval->master_readonly = readonly_mask;
1114 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 int i, c = 0;
1116 for (i = 0; i < 16; i++)
1117 if (ctl_mask & (1 << i))
1118 c++;
1119 cval->channels = c;
Daniel Macka6a33252010-05-31 13:35:37 +02001120 cval->ch_readonly = readonly_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 }
1122
Daniel Macka6a33252010-05-31 13:35:37 +02001123 /* if all channels in the mask are marked read-only, make the control
1124 * read-only. set_cur_mix_value() will check the mask again and won't
1125 * issue write commands to read-only channels. */
1126 if (cval->channels == readonly_mask)
Daniel Mack23caaf12010-03-11 21:13:25 +01001127 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1128 else
1129 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 if (! kctl) {
1132 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1133 kfree(cval);
1134 return;
1135 }
1136 kctl->private_free = usb_mixer_elem_free;
1137
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001138 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 mapped_name = len != 0;
1140 if (! len && nameid)
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001141 len = snd_usb_copy_string_desc(state, nameid,
1142 kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
1144 switch (control) {
Daniel Mack65f25da2010-05-31 13:35:41 +02001145 case UAC_FU_MUTE:
1146 case UAC_FU_VOLUME:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 /* determine the control name. the rule is:
1148 * - if a name id is given in descriptor, use it.
1149 * - if the connected input can be determined, then use the name
1150 * of terminal type.
1151 * - if the connected output can be determined, use it.
1152 * - otherwise, anonymous name.
1153 */
1154 if (! len) {
1155 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1156 if (! len)
1157 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1158 if (! len)
1159 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1160 "Feature %d", unitid);
1161 }
1162 /* determine the stream direction:
1163 * if the connected output is USB stream, then it's likely a
1164 * capture stream. otherwise it should be playback (hopefully :)
1165 */
1166 if (! mapped_name && ! (state->oterm.type >> 16)) {
1167 if ((state->oterm.type & 0xff00) == 0x0100) {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001168 len = append_ctl_name(kctl, " Capture");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 } else {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001170 len = append_ctl_name(kctl, " Playback");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 }
1172 }
Daniel Mack65f25da2010-05-31 13:35:41 +02001173 append_ctl_name(kctl, control == UAC_FU_MUTE ?
Takashi Iwai08d1e632009-10-02 14:06:08 +02001174 " Switch" : " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 default:
1177 if (! len)
1178 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1179 sizeof(kctl->id.name));
1180 break;
1181 }
1182
Takashi Iwaie1825342012-05-14 17:11:06 +02001183 /* get min/max values */
1184 get_min_max_with_quirks(cval, 0, kctl);
1185
1186 if (control == UAC_FU_VOLUME) {
1187 check_mapped_dB(map, cval);
1188 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1189 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1190 kctl->vd[0].access |=
1191 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1192 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1193 }
1194 }
1195
Alexey Fisher80aceff2011-03-10 14:53:38 +01001196 range = (cval->max - cval->min) / cval->res;
1197 /* Are there devices with volume range more than 255? I use a bit more
1198 * to be sure. 384 is a resolution magic number found on Logitech
1199 * devices. It will definitively catch all buggy Logitech devices.
1200 */
1201 if (range > 384) {
1202 snd_printk(KERN_WARNING "usb_audio: Warning! Unlikely big "
1203 "volume range (=%u), cval->res is probably wrong.",
1204 range);
1205 snd_printk(KERN_WARNING "usb_audio: [%d] FU [%s] ch = %d, "
1206 "val = %d/%d/%d", cval->id,
1207 kctl->id.name, cval->channels,
1208 cval->min, cval->max, cval->res);
1209 }
1210
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1212 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
Daniel Mackef9d5972011-05-25 09:09:00 +02001213 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214}
1215
1216
1217
1218/*
1219 * parse a feature unit
1220 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001221 * most of controls are defined here.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 */
Daniel Mack28e1b772010-02-22 23:49:09 +01001223static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224{
1225 int channels, i, j;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001226 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 unsigned int master_bits, first_ch_bits;
1228 int err, csize;
Daniel Mack23caaf12010-03-11 21:13:25 +01001229 struct uac_feature_unit_descriptor *hdr = _ftr;
1230 __u8 *bmaControls;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231
Daniel Mack23caaf12010-03-11 21:13:25 +01001232 if (state->mixer->protocol == UAC_VERSION_1) {
1233 csize = hdr->bControlSize;
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001234 if (!csize) {
1235 snd_printdd(KERN_ERR "usbaudio: unit %u: "
1236 "invalid bControlSize == 0\n", unitid);
1237 return -EINVAL;
1238 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001239 channels = (hdr->bLength - 7) / csize - 1;
1240 bmaControls = hdr->bmaControls;
1241 } else {
1242 struct uac2_feature_unit_descriptor *ftr = _ftr;
1243 csize = 4;
Daniel Macke8d0fee2010-05-27 20:15:14 +02001244 channels = (hdr->bLength - 6) / 4 - 1;
Daniel Mack23caaf12010-03-11 21:13:25 +01001245 bmaControls = ftr->bmaControls;
1246 }
1247
1248 if (hdr->bLength < 7 || !csize || hdr->bLength < 7 + csize) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01001249 snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 return -EINVAL;
1251 }
1252
1253 /* parse the source unit */
Daniel Mack23caaf12010-03-11 21:13:25 +01001254 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 return err;
1256
1257 /* determine the input source type and name */
Daniel Mack23caaf12010-03-11 21:13:25 +01001258 if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 return -EINVAL;
1260
Daniel Mack23caaf12010-03-11 21:13:25 +01001261 master_bits = snd_usb_combine_bytes(bmaControls, csize);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001262 /* master configuration quirks */
1263 switch (state->chip->usb_id) {
1264 case USB_ID(0x08bb, 0x2702):
1265 snd_printk(KERN_INFO
1266 "usbmixer: master volume quirk for PCM2702 chip\n");
1267 /* disable non-functional volume control */
Daniel Mack65f25da2010-05-31 13:35:41 +02001268 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001269 break;
David Henningssonc1051432012-09-20 10:20:41 +02001270 case USB_ID(0x1130, 0xf211):
1271 snd_printk(KERN_INFO
1272 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1273 /* disable non-functional volume control */
1274 channels = 0;
1275 break;
1276
Javier Kohen0c3cee52009-11-17 15:36:13 +01001277 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 if (channels > 0)
Daniel Mack23caaf12010-03-11 21:13:25 +01001279 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 else
1281 first_ch_bits = 0;
Daniel Mack23caaf12010-03-11 21:13:25 +01001282
1283 if (state->mixer->protocol == UAC_VERSION_1) {
1284 /* check all control types */
1285 for (i = 0; i < 10; i++) {
1286 unsigned int ch_bits = 0;
1287 for (j = 0; j < channels; j++) {
1288 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1289 if (mask & (1 << i))
1290 ch_bits |= (1 << j);
1291 }
1292 /* audio class v1 controls are never read-only */
1293 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1294 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1295 if (master_bits & (1 << i))
1296 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001298 } else { /* UAC_VERSION_2 */
Takashi Iwaid09c06c2011-10-13 08:19:09 +02001299 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001300 unsigned int ch_bits = 0;
1301 unsigned int ch_read_only = 0;
1302
1303 for (j = 0; j < channels; j++) {
1304 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001305 if (uac2_control_is_readable(mask, i)) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001306 ch_bits |= (1 << j);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001307 if (!uac2_control_is_writeable(mask, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001308 ch_read_only |= (1 << j);
1309 }
1310 }
1311
Daniel Macka6a33252010-05-31 13:35:37 +02001312 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1313 * are marked read-only in the descriptors. Otherwise, the control will be
1314 * reported as writeable, but the driver will not actually issue a write
1315 * command for read-only channels */
Daniel Mack23caaf12010-03-11 21:13:25 +01001316 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
Daniel Macka6a33252010-05-31 13:35:37 +02001317 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001318 if (uac2_control_is_readable(master_bits, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001319 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001320 !uac2_control_is_writeable(master_bits, i));
Daniel Mack23caaf12010-03-11 21:13:25 +01001321 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 }
1323
1324 return 0;
1325}
1326
1327
1328/*
1329 * Mixer Unit
1330 */
1331
1332/*
1333 * build a mixer unit control
1334 *
1335 * the callbacks are identical with feature unit.
1336 * input channel number (zero based) is given in control field instead.
1337 */
1338
Daniel Mack99fc8642010-03-11 21:13:24 +01001339static void build_mixer_unit_ctl(struct mixer_build *state,
1340 struct uac_mixer_unit_descriptor *desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 int in_pin, int in_ch, int unitid,
Takashi Iwai86e07d32005-11-17 15:08:02 +01001342 struct usb_audio_term *iterm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001344 struct usb_mixer_elem_info *cval;
Daniel Mack99fc8642010-03-11 21:13:24 +01001345 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 unsigned int i, len;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001347 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001348 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001350 map = find_map(state, unitid, 0);
1351 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 return;
1353
Takashi Iwai561b2202005-09-09 14:22:34 +02001354 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 if (! cval)
1356 return;
1357
Clemens Ladisch84957a82005-04-29 16:23:13 +02001358 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 cval->id = unitid;
1360 cval->control = in_ch + 1; /* based on 1 */
1361 cval->val_type = USB_MIXER_S16;
1362 for (i = 0; i < num_outs; i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001363 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 cval->cmask |= (1 << i);
1365 cval->channels++;
1366 }
1367 }
1368
1369 /* get min/max values */
1370 get_min_max(cval, 0);
1371
1372 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1373 if (! kctl) {
1374 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1375 kfree(cval);
1376 return;
1377 }
1378 kctl->private_free = usb_mixer_elem_free;
1379
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001380 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 if (! len)
1382 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1383 if (! len)
1384 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
Takashi Iwai08d1e632009-10-02 14:06:08 +02001385 append_ctl_name(kctl, " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
1387 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1388 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001389 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390}
1391
1392
1393/*
1394 * parse a mixer unit
1395 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001396static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397{
Daniel Mack99fc8642010-03-11 21:13:24 +01001398 struct uac_mixer_unit_descriptor *desc = raw_desc;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001399 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 int input_pins, num_ins, num_outs;
1401 int pin, ich, err;
1402
Daniel Mack99fc8642010-03-11 21:13:24 +01001403 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1405 return -EINVAL;
1406 }
1407 /* no bmControls field (e.g. Maya44) -> ignore */
Daniel Mack99fc8642010-03-11 21:13:24 +01001408 if (desc->bLength <= 10 + input_pins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1410 return 0;
1411 }
1412
1413 num_ins = 0;
1414 ich = 0;
1415 for (pin = 0; pin < input_pins; pin++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001416 err = parse_audio_unit(state, desc->baSourceID[pin]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 if (err < 0)
Mark Hills284a8dd2012-04-14 17:19:23 +01001418 continue;
Daniel Mack99fc8642010-03-11 21:13:24 +01001419 err = check_input_term(state, desc->baSourceID[pin], &iterm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 if (err < 0)
1421 return err;
1422 num_ins += iterm.channels;
1423 for (; ich < num_ins; ++ich) {
1424 int och, ich_has_controls = 0;
1425
1426 for (och = 0; och < num_outs; ++och) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001427 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 ich, och, num_outs)) {
1429 ich_has_controls = 1;
1430 break;
1431 }
1432 }
1433 if (ich_has_controls)
1434 build_mixer_unit_ctl(state, desc, pin, ich,
1435 unitid, &iterm);
1436 }
1437 }
1438 return 0;
1439}
1440
1441
1442/*
1443 * Processing Unit / Extension Unit
1444 */
1445
1446/* get callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001447static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001449 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 int err, val;
1451
1452 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001453 if (err < 0 && cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 ucontrol->value.integer.value[0] = cval->min;
1455 return 0;
1456 }
1457 if (err < 0)
1458 return err;
1459 val = get_relative_value(cval, val);
1460 ucontrol->value.integer.value[0] = val;
1461 return 0;
1462}
1463
1464/* put callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001465static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001467 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 int val, oval, err;
1469
1470 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1471 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001472 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 return 0;
1474 return err;
1475 }
1476 val = ucontrol->value.integer.value[0];
1477 val = get_abs_value(cval, val);
1478 if (val != oval) {
1479 set_cur_ctl_value(cval, cval->control << 8, val);
1480 return 1;
1481 }
1482 return 0;
1483}
1484
1485/* alsa control interface for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001486static struct snd_kcontrol_new mixer_procunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1488 .name = "", /* will be filled later */
1489 .info = mixer_ctl_feature_info,
1490 .get = mixer_ctl_procunit_get,
1491 .put = mixer_ctl_procunit_put,
1492};
1493
1494
1495/*
1496 * predefined data for processing units
1497 */
1498struct procunit_value_info {
1499 int control;
1500 char *suffix;
1501 int val_type;
1502 int min_value;
1503};
1504
1505struct procunit_info {
1506 int type;
1507 char *name;
1508 struct procunit_value_info *values;
1509};
1510
1511static struct procunit_value_info updown_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001512 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1513 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 { 0 }
1515};
1516static struct procunit_value_info prologic_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001517 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1518 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 { 0 }
1520};
1521static struct procunit_value_info threed_enh_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001522 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1523 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 { 0 }
1525};
1526static struct procunit_value_info reverb_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001527 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1528 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1529 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1530 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 { 0 }
1532};
1533static struct procunit_value_info chorus_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001534 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1535 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1536 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1537 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 { 0 }
1539};
1540static struct procunit_value_info dcr_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001541 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1542 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1543 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1544 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1545 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1546 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 { 0 }
1548};
1549
1550static struct procunit_info procunits[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001551 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1552 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1553 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1554 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1555 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1556 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 { 0 },
1558};
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001559/*
1560 * predefined data for extension units
1561 */
1562static struct procunit_value_info clock_rate_xu_info[] = {
Daniel Macke213e9c2010-05-11 18:13:50 +02001563 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1564 { 0 }
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001565};
1566static struct procunit_value_info clock_source_xu_info[] = {
1567 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1568 { 0 }
1569};
1570static struct procunit_value_info spdif_format_xu_info[] = {
1571 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1572 { 0 }
1573};
1574static struct procunit_value_info soft_limit_xu_info[] = {
1575 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1576 { 0 }
1577};
1578static struct procunit_info extunits[] = {
1579 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1580 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1581 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1582 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1583 { 0 }
1584};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585/*
1586 * build a processing/extension unit
1587 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001588static 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 -07001589{
Daniel Mack99fc8642010-03-11 21:13:24 +01001590 struct uac_processing_unit_descriptor *desc = raw_desc;
1591 int num_ins = desc->bNrInPins;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001592 struct usb_mixer_elem_info *cval;
1593 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 int i, err, nameid, type, len;
1595 struct procunit_info *info;
1596 struct procunit_value_info *valinfo;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001597 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 static struct procunit_value_info default_value_info[] = {
1599 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1600 { 0 }
1601 };
1602 static struct procunit_info default_info = {
1603 0, NULL, default_value_info
1604 };
1605
Daniel Mack23caaf12010-03-11 21:13:25 +01001606 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1607 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1609 return -EINVAL;
1610 }
1611
1612 for (i = 0; i < num_ins; i++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001613 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 return err;
1615 }
1616
Daniel Mack99fc8642010-03-11 21:13:24 +01001617 type = le16_to_cpu(desc->wProcessType);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 for (info = list; info && info->type; info++)
1619 if (info->type == type)
1620 break;
1621 if (! info || ! info->type)
1622 info = &default_info;
1623
1624 for (valinfo = info->values; valinfo->control; valinfo++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001625 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
Daniel Mack99fc8642010-03-11 21:13:24 +01001626
1627 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 continue;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001629 map = find_map(state, unitid, valinfo->control);
1630 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 continue;
Takashi Iwai561b2202005-09-09 14:22:34 +02001632 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 if (! cval) {
1634 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1635 return -ENOMEM;
1636 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001637 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 cval->id = unitid;
1639 cval->control = valinfo->control;
1640 cval->val_type = valinfo->val_type;
1641 cval->channels = 1;
1642
1643 /* get min/max values */
Daniel Mack65f25da2010-05-31 13:35:41 +02001644 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001645 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 /* FIXME: hard-coded */
1647 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001648 cval->max = control_spec[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 cval->res = 1;
1650 cval->initialized = 1;
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001651 } else {
1652 if (type == USB_XU_CLOCK_RATE) {
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -05001653 /* E-Mu USB 0404/0202/TrackerPre/0204
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001654 * samplerate control quirk
1655 */
1656 cval->min = 0;
1657 cval->max = 5;
1658 cval->res = 1;
1659 cval->initialized = 1;
1660 } else
1661 get_min_max(cval, valinfo->min_value);
1662 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
1664 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1665 if (! kctl) {
1666 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1667 kfree(cval);
1668 return -ENOMEM;
1669 }
1670 kctl->private_free = usb_mixer_elem_free;
1671
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001672 if (check_mapped_name(map, kctl->id.name,
1673 sizeof(kctl->id.name)))
1674 /* nothing */ ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 else if (info->name)
1676 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1677 else {
Daniel Mack23caaf12010-03-11 21:13:25 +01001678 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 len = 0;
1680 if (nameid)
1681 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1682 if (! len)
1683 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1684 }
Takashi Iwai08d1e632009-10-02 14:06:08 +02001685 append_ctl_name(kctl, " ");
1686 append_ctl_name(kctl, valinfo->suffix);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
1688 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1689 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001690 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 return err;
1692 }
1693 return 0;
1694}
1695
1696
Daniel Mack99fc8642010-03-11 21:13:24 +01001697static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698{
Daniel Mack99fc8642010-03-11 21:13:24 +01001699 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700}
1701
Daniel Mack99fc8642010-03-11 21:13:24 +01001702static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703{
Daniel Mack99fc8642010-03-11 21:13:24 +01001704 /* Note that we parse extension units with processing unit descriptors.
1705 * That's ok as the layout is the same */
1706 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707}
1708
1709
1710/*
1711 * Selector Unit
1712 */
1713
1714/* info callback for selector unit
1715 * use an enumerator type for routing
1716 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001717static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001719 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001720 const char **itemlist = (const char **)kcontrol->private_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
Takashi Iwai5e246b82008-08-08 17:12:47 +02001722 if (snd_BUG_ON(!itemlist))
1723 return -EINVAL;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001724 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725}
1726
1727/* get callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001728static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001730 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 int val, err;
1732
Daniel Mack09414202010-05-31 13:35:44 +02001733 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001735 if (cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 ucontrol->value.enumerated.item[0] = 0;
1737 return 0;
1738 }
1739 return err;
1740 }
1741 val = get_relative_value(cval, val);
1742 ucontrol->value.enumerated.item[0] = val;
1743 return 0;
1744}
1745
1746/* put callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001747static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001749 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 int val, oval, err;
1751
Daniel Mack09414202010-05-31 13:35:44 +02001752 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001754 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 return 0;
1756 return err;
1757 }
1758 val = ucontrol->value.enumerated.item[0];
1759 val = get_abs_value(cval, val);
1760 if (val != oval) {
Daniel Mack09414202010-05-31 13:35:44 +02001761 set_cur_ctl_value(cval, cval->control << 8, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 return 1;
1763 }
1764 return 0;
1765}
1766
1767/* alsa control interface for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001768static struct snd_kcontrol_new mixer_selectunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1770 .name = "", /* will be filled later */
1771 .info = mixer_ctl_selector_info,
1772 .get = mixer_ctl_selector_get,
1773 .put = mixer_ctl_selector_put,
1774};
1775
1776
1777/* private free callback.
1778 * free both private_data and private_value
1779 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001780static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781{
1782 int i, num_ins = 0;
1783
1784 if (kctl->private_data) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001785 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 num_ins = cval->max;
1787 kfree(cval);
1788 kctl->private_data = NULL;
1789 }
1790 if (kctl->private_value) {
1791 char **itemlist = (char **)kctl->private_value;
1792 for (i = 0; i < num_ins; i++)
1793 kfree(itemlist[i]);
1794 kfree(itemlist);
1795 kctl->private_value = 0;
1796 }
1797}
1798
1799/*
1800 * parse a selector unit
1801 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001802static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803{
Daniel Mack99fc8642010-03-11 21:13:24 +01001804 struct uac_selector_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 unsigned int i, nameid, len;
1806 int err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001807 struct usb_mixer_elem_info *cval;
1808 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001809 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 char **namelist;
1811
Daniel Mack99fc8642010-03-11 21:13:24 +01001812 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1814 return -EINVAL;
1815 }
1816
Daniel Mack99fc8642010-03-11 21:13:24 +01001817 for (i = 0; i < desc->bNrInPins; i++) {
1818 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 return err;
1820 }
1821
Daniel Mack99fc8642010-03-11 21:13:24 +01001822 if (desc->bNrInPins == 1) /* only one ? nonsense! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 return 0;
1824
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001825 map = find_map(state, unitid, 0);
1826 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 return 0;
1828
Takashi Iwai561b2202005-09-09 14:22:34 +02001829 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 if (! cval) {
1831 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1832 return -ENOMEM;
1833 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001834 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 cval->id = unitid;
1836 cval->val_type = USB_MIXER_U8;
1837 cval->channels = 1;
1838 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001839 cval->max = desc->bNrInPins;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 cval->res = 1;
1841 cval->initialized = 1;
1842
Daniel Mack09414202010-05-31 13:35:44 +02001843 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1844 cval->control = UAC2_CX_CLOCK_SELECTOR;
1845 else
1846 cval->control = 0;
1847
Daniel Mack99fc8642010-03-11 21:13:24 +01001848 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 if (! namelist) {
1850 snd_printk(KERN_ERR "cannot malloc\n");
1851 kfree(cval);
1852 return -ENOMEM;
1853 }
1854#define MAX_ITEM_NAME_LEN 64
Daniel Mack99fc8642010-03-11 21:13:24 +01001855 for (i = 0; i < desc->bNrInPins; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001856 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 len = 0;
1858 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1859 if (! namelist[i]) {
1860 snd_printk(KERN_ERR "cannot malloc\n");
Mariusz Kozlowski7fbe3ca2007-01-08 11:25:30 +01001861 while (i--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 kfree(namelist[i]);
1863 kfree(namelist);
1864 kfree(cval);
1865 return -ENOMEM;
1866 }
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02001867 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1868 MAX_ITEM_NAME_LEN);
Daniel Mack99fc8642010-03-11 21:13:24 +01001869 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1871 if (! len)
1872 sprintf(namelist[i], "Input %d", i);
1873 }
1874
1875 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1876 if (! kctl) {
1877 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
Jesper Juhl878b4782006-03-20 11:27:13 +01001878 kfree(namelist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 kfree(cval);
1880 return -ENOMEM;
1881 }
1882 kctl->private_value = (unsigned long)namelist;
1883 kctl->private_free = usb_mixer_selector_elem_free;
1884
Daniel Mack99fc8642010-03-11 21:13:24 +01001885 nameid = uac_selector_unit_iSelector(desc);
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001886 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 if (len)
1888 ;
1889 else if (nameid)
1890 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1891 else {
1892 len = get_term_name(state, &state->oterm,
1893 kctl->id.name, sizeof(kctl->id.name), 0);
1894 if (! len)
1895 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1896
Daniel Mack09414202010-05-31 13:35:44 +02001897 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1898 append_ctl_name(kctl, " Clock Source");
1899 else if ((state->oterm.type & 0xff00) == 0x0100)
Takashi Iwai08d1e632009-10-02 14:06:08 +02001900 append_ctl_name(kctl, " Capture Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 else
Takashi Iwai08d1e632009-10-02 14:06:08 +02001902 append_ctl_name(kctl, " Playback Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 }
1904
1905 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
Daniel Mack99fc8642010-03-11 21:13:24 +01001906 cval->id, kctl->id.name, desc->bNrInPins);
Daniel Mackef9d5972011-05-25 09:09:00 +02001907 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 return err;
1909
1910 return 0;
1911}
1912
1913
1914/*
1915 * parse an audio unit recursively
1916 */
1917
Takashi Iwai86e07d32005-11-17 15:08:02 +01001918static int parse_audio_unit(struct mixer_build *state, int unitid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919{
1920 unsigned char *p1;
1921
1922 if (test_and_set_bit(unitid, state->unitbitmap))
1923 return 0; /* the unit already visited */
1924
1925 p1 = find_audio_control_unit(state, unitid);
1926 if (!p1) {
1927 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1928 return -EINVAL;
1929 }
1930
1931 switch (p1[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01001932 case UAC_INPUT_TERMINAL:
Daniel Mack09414202010-05-31 13:35:44 +02001933 case UAC2_CLOCK_SOURCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 return 0; /* NOP */
Daniel Mackde48c7b2010-02-22 23:49:13 +01001935 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 return parse_audio_mixer_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01001937 case UAC_SELECTOR_UNIT:
Daniel Mack09414202010-05-31 13:35:44 +02001938 case UAC2_CLOCK_SELECTOR:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 return parse_audio_selector_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01001940 case UAC_FEATURE_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 return parse_audio_feature_unit(state, unitid, p1);
Daniel Mack69da9bc2010-06-16 17:57:28 +02001942 case UAC1_PROCESSING_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01001943 /* UAC2_EFFECT_UNIT has the same value */
1944 if (state->mixer->protocol == UAC_VERSION_1)
1945 return parse_audio_processing_unit(state, unitid, p1);
1946 else
1947 return 0; /* FIXME - effect units not implemented yet */
Daniel Mack69da9bc2010-06-16 17:57:28 +02001948 case UAC1_EXTENSION_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01001949 /* UAC2_PROCESSING_UNIT_V2 has the same value */
1950 if (state->mixer->protocol == UAC_VERSION_1)
1951 return parse_audio_extension_unit(state, unitid, p1);
1952 else /* UAC_VERSION_2 */
1953 return parse_audio_processing_unit(state, unitid, p1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 default:
1955 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1956 return -EINVAL;
1957 }
1958}
1959
Clemens Ladisch84957a82005-04-29 16:23:13 +02001960static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1961{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02001962 kfree(mixer->id_elems);
1963 if (mixer->urb) {
1964 kfree(mixer->urb->transfer_buffer);
1965 usb_free_urb(mixer->urb);
1966 }
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01001967 usb_free_urb(mixer->rc_urb);
Clemens Ladischb259b102005-04-29 16:29:28 +02001968 kfree(mixer->rc_setup_packet);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001969 kfree(mixer);
1970}
1971
Takashi Iwai86e07d32005-11-17 15:08:02 +01001972static int snd_usb_mixer_dev_free(struct snd_device *device)
Clemens Ladisch84957a82005-04-29 16:23:13 +02001973{
1974 struct usb_mixer_interface *mixer = device->device_data;
1975 snd_usb_mixer_free(mixer);
1976 return 0;
1977}
1978
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979/*
1980 * create mixer controls
1981 *
Daniel Mackde48c7b2010-02-22 23:49:13 +01001982 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 */
Clemens Ladisch84957a82005-04-29 16:23:13 +02001984static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001986 struct mixer_build state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 int err;
1988 const struct usbmix_ctl_map *map;
Daniel Mack23caaf12010-03-11 21:13:25 +01001989 void *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 memset(&state, 0, sizeof(state));
Clemens Ladisch84957a82005-04-29 16:23:13 +02001992 state.chip = mixer->chip;
1993 state.mixer = mixer;
Daniel Mack1faa5d02011-08-04 15:56:28 +02001994 state.buffer = mixer->hostif->extra;
1995 state.buflen = mixer->hostif->extralen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996
1997 /* check the mapping table */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02001998 for (map = usbmix_ctl_maps; map->id; map++) {
1999 if (map->id == state.chip->usb_id) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 state.map = map->map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002001 state.selector_map = map->selector_map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002002 mixer->ignore_ctl_error = map->ignore_ctl_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 break;
2004 }
2005 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Daniel Mack23caaf12010-03-11 21:13:25 +01002007 p = NULL;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002008 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen,
2009 p, UAC_OUTPUT_TERMINAL)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +01002010 if (mixer->protocol == UAC_VERSION_1) {
Daniel Mack69da9bc2010-06-16 17:57:28 +02002011 struct uac1_output_terminal_descriptor *desc = p;
Daniel Mack23caaf12010-03-11 21:13:25 +01002012
2013 if (desc->bLength < sizeof(*desc))
2014 continue; /* invalid descriptor? */
2015 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2016 state.oterm.id = desc->bTerminalID;
2017 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2018 state.oterm.name = desc->iTerminal;
2019 err = parse_audio_unit(&state, desc->bSourceID);
2020 if (err < 0)
2021 return err;
2022 } else { /* UAC_VERSION_2 */
2023 struct uac2_output_terminal_descriptor *desc = p;
2024
2025 if (desc->bLength < sizeof(*desc))
2026 continue; /* invalid descriptor? */
2027 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2028 state.oterm.id = desc->bTerminalID;
2029 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2030 state.oterm.name = desc->iTerminal;
2031 err = parse_audio_unit(&state, desc->bSourceID);
2032 if (err < 0)
2033 return err;
Daniel Mack09414202010-05-31 13:35:44 +02002034
2035 /* for UAC2, use the same approach to also add the clock selectors */
2036 err = parse_audio_unit(&state, desc->bCSourceID);
2037 if (err < 0)
2038 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +01002039 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 }
Daniel Mack23caaf12010-03-11 21:13:25 +01002041
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 return 0;
2043}
Clemens Ladisch84957a82005-04-29 16:23:13 +02002044
Daniel Mack7b1eda22010-03-11 21:13:22 +01002045void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002046{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002047 struct usb_mixer_elem_info *info;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002048
2049 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
2050 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2051 info->elem_id);
2052}
2053
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002054static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2055 int unitid,
2056 struct usb_mixer_elem_info *cval)
2057{
2058 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2059 "S8", "U8", "S16", "U16"};
2060 snd_iprintf(buffer, " Unit: %i\n", unitid);
2061 if (cval->elem_id)
2062 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
2063 cval->elem_id->name, cval->elem_id->index);
2064 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2065 "channels=%i, type=\"%s\"\n", cval->id,
2066 cval->control, cval->cmask, cval->channels,
2067 val_types[cval->val_type]);
2068 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2069 cval->min, cval->max, cval->dBmin, cval->dBmax);
2070}
2071
2072static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2073 struct snd_info_buffer *buffer)
2074{
2075 struct snd_usb_audio *chip = entry->private_data;
2076 struct usb_mixer_interface *mixer;
2077 struct usb_mixer_elem_info *cval;
2078 int unitid;
2079
2080 list_for_each_entry(mixer, &chip->mixer_list, list) {
2081 snd_iprintf(buffer,
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002082 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002083 chip->usb_id, snd_usb_ctrl_intf(chip),
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002084 mixer->ignore_ctl_error);
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002085 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2086 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2087 for (cval = mixer->id_elems[unitid]; cval;
2088 cval = cval->next_id_elem)
2089 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2090 }
2091 }
2092}
2093
Daniel Macke213e9c2010-05-11 18:13:50 +02002094static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2095 int attribute, int value, int index)
2096{
2097 struct usb_mixer_elem_info *info;
2098 __u8 unitid = (index >> 8) & 0xff;
2099 __u8 control = (value >> 8) & 0xff;
2100 __u8 channel = value & 0xff;
2101
2102 if (channel >= MAX_CHANNELS) {
2103 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2104 __func__, channel);
2105 return;
2106 }
2107
2108 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2109 if (info->control != control)
2110 continue;
2111
2112 switch (attribute) {
2113 case UAC2_CS_CUR:
2114 /* invalidate cache, so the value is read from the device */
2115 if (channel)
2116 info->cached &= ~(1 << channel);
2117 else /* master channel */
2118 info->cached = 0;
2119
2120 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2121 info->elem_id);
2122 break;
2123
2124 case UAC2_CS_RANGE:
2125 /* TODO */
2126 break;
2127
2128 case UAC2_CS_MEM:
2129 /* TODO */
2130 break;
2131
2132 default:
2133 snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2134 attribute);
2135 break;
2136 } /* switch */
2137 }
2138}
2139
2140static void snd_usb_mixer_interrupt(struct urb *urb)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002141{
2142 struct usb_mixer_interface *mixer = urb->context;
Daniel Macke213e9c2010-05-11 18:13:50 +02002143 int len = urb->actual_length;
Oliver Neukumedf7de32011-03-11 13:19:43 +01002144 int ustatus = urb->status;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002145
Oliver Neukumedf7de32011-03-11 13:19:43 +01002146 if (ustatus != 0)
Daniel Macke213e9c2010-05-11 18:13:50 +02002147 goto requeue;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002148
Daniel Macke213e9c2010-05-11 18:13:50 +02002149 if (mixer->protocol == UAC_VERSION_1) {
2150 struct uac1_status_word *status;
2151
2152 for (status = urb->transfer_buffer;
2153 len >= sizeof(*status);
2154 len -= sizeof(*status), status++) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002155 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
Daniel Macke213e9c2010-05-11 18:13:50 +02002156 status->bStatusType,
2157 status->bOriginator);
2158
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002159 /* ignore any notifications not from the control interface */
Daniel Macke213e9c2010-05-11 18:13:50 +02002160 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2161 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002162 continue;
Daniel Macke213e9c2010-05-11 18:13:50 +02002163
2164 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2165 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
Clemens Ladischb259b102005-04-29 16:29:28 +02002166 else
Daniel Macke213e9c2010-05-11 18:13:50 +02002167 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2168 }
2169 } else { /* UAC_VERSION_2 */
2170 struct uac2_interrupt_data_msg *msg;
2171
2172 for (msg = urb->transfer_buffer;
2173 len >= sizeof(*msg);
2174 len -= sizeof(*msg), msg++) {
2175 /* drop vendor specific and endpoint requests */
2176 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2177 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2178 continue;
2179
2180 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2181 le16_to_cpu(msg->wValue),
2182 le16_to_cpu(msg->wIndex));
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002183 }
2184 }
Daniel Macke213e9c2010-05-11 18:13:50 +02002185
2186requeue:
Oliver Neukumedf7de32011-03-11 13:19:43 +01002187 if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002188 urb->dev = mixer->chip->dev;
2189 usb_submit_urb(urb, GFP_ATOMIC);
2190 }
2191}
2192
Oliver Neukumedf7de32011-03-11 13:19:43 +01002193/* stop any bus activity of a mixer */
2194void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2195{
2196 usb_kill_urb(mixer->urb);
2197 usb_kill_urb(mixer->rc_urb);
2198}
2199
2200int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2201{
2202 int err;
2203
2204 if (mixer->urb) {
2205 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2206 if (err < 0)
2207 return err;
2208 }
2209
2210 return 0;
2211}
2212
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002213/* create the handler for the optional status interrupt endpoint */
2214static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2215{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002216 struct usb_endpoint_descriptor *ep;
2217 void *transfer_buffer;
2218 int buffer_length;
2219 unsigned int epnum;
2220
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002221 /* we need one interrupt input endpoint */
Daniel Mack1faa5d02011-08-04 15:56:28 +02002222 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002223 return 0;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002224 ep = get_endpoint(mixer->hostif, 0);
Julia Lawall913ae5a2009-01-03 17:54:53 +01002225 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002226 return 0;
2227
Julia Lawall42a6e662008-12-29 11:23:02 +01002228 epnum = usb_endpoint_num(ep);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002229 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2230 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2231 if (!transfer_buffer)
2232 return -ENOMEM;
2233 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2234 if (!mixer->urb) {
2235 kfree(transfer_buffer);
2236 return -ENOMEM;
2237 }
2238 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2239 usb_rcvintpipe(mixer->chip->dev, epnum),
2240 transfer_buffer, buffer_length,
Daniel Macke213e9c2010-05-11 18:13:50 +02002241 snd_usb_mixer_interrupt, mixer, ep->bInterval);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002242 usb_submit_urb(mixer->urb, GFP_KERNEL);
2243 return 0;
2244}
2245
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002246int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2247 int ignore_error)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002248{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002249 static struct snd_device_ops dev_ops = {
Clemens Ladisch84957a82005-04-29 16:23:13 +02002250 .dev_free = snd_usb_mixer_dev_free
2251 };
2252 struct usb_mixer_interface *mixer;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002253 struct snd_info_entry *entry;
Daniel Mack23caaf12010-03-11 21:13:25 +01002254 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002255
2256 strcpy(chip->card->mixername, "USB Mixer");
2257
Takashi Iwai561b2202005-09-09 14:22:34 +02002258 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002259 if (!mixer)
2260 return -ENOMEM;
2261 mixer->chip = chip;
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002262 mixer->ignore_ctl_error = ignore_error;
Jaroslav Kysela291186e2010-02-16 11:55:18 +01002263 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2264 GFP_KERNEL);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002265 if (!mixer->id_elems) {
2266 kfree(mixer);
2267 return -ENOMEM;
2268 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02002269
Daniel Mack1faa5d02011-08-04 15:56:28 +02002270 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2271 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +02002272 case UAC_VERSION_1:
2273 default:
2274 mixer->protocol = UAC_VERSION_1;
2275 break;
2276 case UAC_VERSION_2:
2277 mixer->protocol = UAC_VERSION_2;
2278 break;
2279 }
Daniel Mack7b8a0432010-02-22 23:49:12 +01002280
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002281 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002282 (err = snd_usb_mixer_status_create(mixer)) < 0)
2283 goto _error;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002284
Daniel Mack7b1eda22010-03-11 21:13:22 +01002285 snd_usb_mixer_apply_create_quirk(mixer);
Clemens Ladisch468b8fd2009-07-13 11:39:29 +02002286
Clemens Ladisch84957a82005-04-29 16:23:13 +02002287 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002288 if (err < 0)
2289 goto _error;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002290
2291 if (list_empty(&chip->mixer_list) &&
2292 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2293 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2294
Clemens Ladisch84957a82005-04-29 16:23:13 +02002295 list_add(&mixer->list, &chip->mixer_list);
2296 return 0;
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002297
2298_error:
2299 snd_usb_mixer_free(mixer);
2300 return err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002301}
2302
2303void snd_usb_mixer_disconnect(struct list_head *p)
2304{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002305 struct usb_mixer_interface *mixer;
Daniel Mack7b1eda22010-03-11 21:13:22 +01002306
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002307 mixer = list_entry(p, struct usb_mixer_interface, list);
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002308 usb_kill_urb(mixer->urb);
2309 usb_kill_urb(mixer->rc_urb);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002310}