blob: f2d74d654b3c3302b6dbe353ae8be95484c16ccf [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"
Raimonds Cicans4d1a70d2006-05-05 09:49:53 +020064
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +010065#define MAX_ID_ELEMS 256
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067struct usb_audio_term {
68 int id;
69 int type;
70 int channels;
71 unsigned int chconfig;
72 int name;
73};
74
75struct usbmix_name_map;
76
Takashi Iwai86e07d32005-11-17 15:08:02 +010077struct mixer_build {
78 struct snd_usb_audio *chip;
Clemens Ladisch84957a82005-04-29 16:23:13 +020079 struct usb_mixer_interface *mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 unsigned char *buffer;
81 unsigned int buflen;
Jaroslav Kysela291186e2010-02-16 11:55:18 +010082 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
Takashi Iwai86e07d32005-11-17 15:08:02 +010083 struct usb_audio_term oterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 const struct usbmix_name_map *map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +020085 const struct usbmix_selector_map *selector_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086};
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088enum {
89 USB_MIXER_BOOLEAN,
90 USB_MIXER_INV_BOOLEAN,
91 USB_MIXER_S8,
92 USB_MIXER_U8,
93 USB_MIXER_S16,
94 USB_MIXER_U16,
95};
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -080098/*E-mu 0202(0404) eXtension Unit(XU) control*/
99enum {
100 USB_XU_CLOCK_RATE = 0xe301,
101 USB_XU_CLOCK_SOURCE = 0xe302,
102 USB_XU_DIGITAL_IO_STATUS = 0xe303,
103 USB_XU_DEVICE_OPTIONS = 0xe304,
104 USB_XU_DIRECT_MONITORING = 0xe305,
105 USB_XU_METERING = 0xe306
106};
107enum {
108 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
109 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
110 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
111 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
112};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114/*
115 * manual mapping of mixer names
116 * if the mixer topology is too complicated and the parsed names are
117 * ambiguous, add the entries in usbmixer_maps.c.
118 */
Daniel Mackf0b5e632010-03-11 21:13:23 +0100119#include "mixer_maps.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100121static const struct usbmix_name_map *
122find_map(struct mixer_build *state, int unitid, int control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100124 const struct usbmix_name_map *p = state->map;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100126 if (!p)
127 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 for (p = state->map; p->id; p++) {
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100130 if (p->id == unitid &&
131 (!control || !p->control || control == p->control))
132 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100134 return NULL;
135}
136
137/* get the mapped name if the unit matches */
138static int
139check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
140{
141 if (!p || !p->name)
142 return 0;
143
144 buflen--;
145 return strlcpy(buf, p->name, buflen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147
148/* check whether the control should be ignored */
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100149static inline int
150check_ignored_ctl(const struct usbmix_name_map *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100152 if (!p || p->name || p->dB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 return 0;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100154 return 1;
155}
156
157/* dB mapping */
158static inline void check_mapped_dB(const struct usbmix_name_map *p,
159 struct usb_mixer_elem_info *cval)
160{
161 if (p && p->dB) {
162 cval->dBmin = p->dB->min;
163 cval->dBmax = p->dB->max;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165}
166
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200167/* get the mapped selector source name */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100168static int check_mapped_selector_name(struct mixer_build *state, int unitid,
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200169 int index, char *buf, int buflen)
170{
171 const struct usbmix_selector_map *p;
172
173 if (! state->selector_map)
174 return 0;
175 for (p = state->selector_map; p->id; p++) {
176 if (p->id == unitid && index < p->count)
177 return strlcpy(buf, p->names[index], buflen);
178 }
179 return 0;
180}
181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182/*
183 * find an audio control unit with the given unit id
184 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100185static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186{
Daniel Mack67e1daa2010-05-31 13:35:43 +0200187 /* we just parse the header */
188 struct uac_feature_unit_descriptor *hdr = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Daniel Mack67e1daa2010-05-31 13:35:43 +0200190 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
191 USB_DT_CS_INTERFACE)) != NULL) {
192 if (hdr->bLength >= 4 &&
193 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
194 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
195 hdr->bUnitID == unit)
196 return hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 }
Daniel Mack67e1daa2010-05-31 13:35:43 +0200198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 return NULL;
200}
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202/*
203 * copy a string with the given id
204 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100205static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206{
207 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
208 buf[len] = 0;
209 return len;
210}
211
212/*
213 * convert from the byte/word on usb descriptor to the zero-based integer
214 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100215static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
217 switch (cval->val_type) {
218 case USB_MIXER_BOOLEAN:
219 return !!val;
220 case USB_MIXER_INV_BOOLEAN:
221 return !val;
222 case USB_MIXER_U8:
223 val &= 0xff;
224 break;
225 case USB_MIXER_S8:
226 val &= 0xff;
227 if (val >= 0x80)
228 val -= 0x100;
229 break;
230 case USB_MIXER_U16:
231 val &= 0xffff;
232 break;
233 case USB_MIXER_S16:
234 val &= 0xffff;
235 if (val >= 0x8000)
236 val -= 0x10000;
237 break;
238 }
239 return val;
240}
241
242/*
243 * convert from the zero-based int to the byte/word for usb descriptor
244 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100245static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246{
247 switch (cval->val_type) {
248 case USB_MIXER_BOOLEAN:
249 return !!val;
250 case USB_MIXER_INV_BOOLEAN:
251 return !val;
252 case USB_MIXER_S8:
253 case USB_MIXER_U8:
254 return val & 0xff;
255 case USB_MIXER_S16:
256 case USB_MIXER_U16:
257 return val & 0xffff;
258 }
259 return 0; /* not reached */
260}
261
Takashi Iwai86e07d32005-11-17 15:08:02 +0100262static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
264 if (! cval->res)
265 cval->res = 1;
266 if (val < cval->min)
267 return 0;
Takashi Iwai14790f12006-03-28 17:58:28 +0200268 else if (val >= cval->max)
269 return (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 else
271 return (val - cval->min) / cval->res;
272}
273
Takashi Iwai86e07d32005-11-17 15:08:02 +0100274static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275{
276 if (val < 0)
277 return cval->min;
278 if (! cval->res)
279 cval->res = 1;
280 val *= cval->res;
281 val += cval->min;
282 if (val > cval->max)
283 return cval->max;
284 return val;
285}
286
287
288/*
289 * retrieve a mixer value
290 */
291
Daniel Mack23caaf12010-03-11 21:13:25 +0100292static 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 -0700293{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200294 struct snd_usb_audio *chip = cval->mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 unsigned char buf[2];
296 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
297 int timeout = 10;
298
299 while (timeout-- > 0) {
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200300 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200302 validx, snd_usb_ctrl_intf(chip) | (cval->id << 8),
Thomas Reitmayra04395e2007-05-15 11:47:48 +0200303 buf, val_len, 100) >= val_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
305 return 0;
306 }
307 }
Clemens Ladisch84957a82005-04-29 16:23:13 +0200308 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Takashi Iwaib415ec72010-06-24 08:07:28 +0200309 request, validx, snd_usb_ctrl_intf(chip) | (cval->id << 8), cval->val_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 return -EINVAL;
311}
312
Daniel Mack23caaf12010-03-11 21:13:25 +0100313static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
314{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200315 struct snd_usb_audio *chip = cval->mixer->chip;
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200316 unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */
Daniel Mack23caaf12010-03-11 21:13:25 +0100317 unsigned char *val;
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200318 int ret, size;
Daniel Mack23caaf12010-03-11 21:13:25 +0100319 __u8 bRequest;
320
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200321 if (request == UAC_GET_CUR) {
322 bRequest = UAC2_CS_CUR;
323 size = sizeof(__u16);
324 } else {
325 bRequest = UAC2_CS_RANGE;
326 size = sizeof(buf);
327 }
328
329 memset(buf, 0, sizeof(buf));
Daniel Mack23caaf12010-03-11 21:13:25 +0100330
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200331 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
Daniel Mack23caaf12010-03-11 21:13:25 +0100332 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200333 validx, snd_usb_ctrl_intf(chip) | (cval->id << 8),
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200334 buf, size, 1000);
Daniel Mack23caaf12010-03-11 21:13:25 +0100335
336 if (ret < 0) {
Daniel Mack09414202010-05-31 13:35:44 +0200337 snd_printk(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200338 request, validx, snd_usb_ctrl_intf(chip) | (cval->id << 8), cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100339 return ret;
340 }
341
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200342 /* FIXME: how should we handle multiple triplets here? */
343
Daniel Mack23caaf12010-03-11 21:13:25 +0100344 switch (request) {
345 case UAC_GET_CUR:
346 val = buf;
347 break;
348 case UAC_GET_MIN:
349 val = buf + sizeof(__u16);
350 break;
351 case UAC_GET_MAX:
352 val = buf + sizeof(__u16) * 2;
353 break;
354 case UAC_GET_RES:
355 val = buf + sizeof(__u16) * 3;
356 break;
357 default:
358 return -EINVAL;
359 }
360
361 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
362
363 return 0;
364}
365
366static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
367{
368 return (cval->mixer->protocol == UAC_VERSION_1) ?
369 get_ctl_value_v1(cval, request, validx, value_ret) :
370 get_ctl_value_v2(cval, request, validx, value_ret);
371}
372
Takashi Iwai86e07d32005-11-17 15:08:02 +0100373static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100375 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376}
377
378/* channel = 0: master, 1 = first channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100379static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
380 int channel, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100382 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
384
Takashi Iwai641b4872009-01-15 17:05:24 +0100385static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
386 int channel, int index, int *value)
387{
388 int err;
389
390 if (cval->cached & (1 << channel)) {
391 *value = cval->cache_val[index];
392 return 0;
393 }
394 err = get_cur_mix_raw(cval, channel, value);
395 if (err < 0) {
396 if (!cval->mixer->ignore_ctl_error)
Daniel Mack23caaf12010-03-11 21:13:25 +0100397 snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
Takashi Iwai641b4872009-01-15 17:05:24 +0100398 cval->control, channel, err);
399 return err;
400 }
401 cval->cached |= 1 << channel;
402 cval->cache_val[index] = *value;
403 return 0;
404}
405
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/*
408 * set a mixer value
409 */
410
Daniel Mack7b1eda22010-03-11 21:13:22 +0100411int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
412 int request, int validx, int value_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200414 struct snd_usb_audio *chip = cval->mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 unsigned char buf[2];
Daniel Mack23caaf12010-03-11 21:13:25 +0100416 int val_len, timeout = 10;
417
418 if (cval->mixer->protocol == UAC_VERSION_1) {
419 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
420 } else { /* UAC_VERSION_2 */
421 /* audio class v2 controls are always 2 bytes in size */
422 val_len = sizeof(__u16);
423
424 /* FIXME */
425 if (request != UAC_SET_CUR) {
426 snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
427 return -EINVAL;
428 }
429
430 request = UAC2_CS_CUR;
431 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
433 value_set = convert_bytes_value(cval, value_set);
434 buf[0] = value_set & 0xff;
435 buf[1] = (value_set >> 8) & 0xff;
Viral Mehtacf3f9132009-04-03 13:08:14 +0530436 while (timeout-- > 0)
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200437 if (snd_usb_ctl_msg(chip->dev,
438 usb_sndctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200440 validx, snd_usb_ctrl_intf(chip) | (cval->id << 8),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 buf, val_len, 100) >= 0)
442 return 0;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200443 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 +0200444 request, validx, snd_usb_ctrl_intf(chip) | (cval->id << 8), cval->val_type, buf[0], buf[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 return -EINVAL;
446}
447
Takashi Iwai86e07d32005-11-17 15:08:02 +0100448static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
Daniel Mack7b1eda22010-03-11 21:13:22 +0100450 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451}
452
Takashi Iwai641b4872009-01-15 17:05:24 +0100453static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
454 int index, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
Takashi Iwai641b4872009-01-15 17:05:24 +0100456 int err;
Daniel Macka6a33252010-05-31 13:35:37 +0200457 unsigned int read_only = (channel == 0) ?
458 cval->master_readonly :
459 cval->ch_readonly & (1 << (channel - 1));
460
461 if (read_only) {
462 snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
463 __func__, channel, cval->control);
464 return 0;
465 }
466
Daniel Mack7b1eda22010-03-11 21:13:22 +0100467 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
Takashi Iwai641b4872009-01-15 17:05:24 +0100468 value);
469 if (err < 0)
470 return err;
471 cval->cached |= 1 << channel;
472 cval->cache_val[index] = value;
473 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474}
475
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200476/*
477 * TLV callback for mixer volume controls
478 */
479static int mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
480 unsigned int size, unsigned int __user *_tlv)
481{
482 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Takashi Iwaib8e1c732009-06-16 14:04:37 +0200483 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200484
485 if (size < sizeof(scale))
486 return -ENOMEM;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100487 scale[2] = cval->dBmin;
488 scale[3] = cval->dBmax;
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200489 if (copy_to_user(_tlv, scale, sizeof(scale)))
490 return -EFAULT;
491 return 0;
492}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
494/*
495 * parser routines begin here...
496 */
497
Takashi Iwai86e07d32005-11-17 15:08:02 +0100498static int parse_audio_unit(struct mixer_build *state, int unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500
501/*
502 * check if the input/output channel routing is enabled on the given bitmap.
503 * used for mixer unit parser
504 */
505static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
506{
507 int idx = ich * num_outs + och;
508 return bmap[idx >> 3] & (0x80 >> (idx & 7));
509}
510
511
512/*
513 * add an alsa control element
514 * search and increment the index until an empty slot is found.
515 *
516 * if failed, give up and free the control instance.
517 */
518
Takashi Iwai86e07d32005-11-17 15:08:02 +0100519static int add_control_to_empty(struct mixer_build *state, struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100521 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200523
524 while (snd_ctl_find_id(state->chip->card, &kctl->id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 kctl->id.index++;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200526 if ((err = snd_ctl_add(state->chip->card, kctl)) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200528 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 }
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200530 cval->elem_id = &kctl->id;
531 cval->next_id_elem = state->mixer->id_elems[cval->id];
532 state->mixer->id_elems[cval->id] = cval;
533 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
536
537/*
538 * get a terminal name string
539 */
540
541static struct iterm_name_combo {
542 int type;
543 char *name;
544} iterm_names[] = {
545 { 0x0300, "Output" },
546 { 0x0301, "Speaker" },
547 { 0x0302, "Headphone" },
548 { 0x0303, "HMD Audio" },
549 { 0x0304, "Desktop Speaker" },
550 { 0x0305, "Room Speaker" },
551 { 0x0306, "Com Speaker" },
552 { 0x0307, "LFE" },
553 { 0x0600, "External In" },
554 { 0x0601, "Analog In" },
555 { 0x0602, "Digital In" },
556 { 0x0603, "Line" },
557 { 0x0604, "Legacy In" },
558 { 0x0605, "IEC958 In" },
559 { 0x0606, "1394 DA Stream" },
560 { 0x0607, "1394 DV Stream" },
561 { 0x0700, "Embedded" },
562 { 0x0701, "Noise Source" },
563 { 0x0702, "Equalization Noise" },
564 { 0x0703, "CD" },
565 { 0x0704, "DAT" },
566 { 0x0705, "DCC" },
567 { 0x0706, "MiniDisk" },
568 { 0x0707, "Analog Tape" },
569 { 0x0708, "Phonograph" },
570 { 0x0709, "VCR Audio" },
571 { 0x070a, "Video Disk Audio" },
572 { 0x070b, "DVD Audio" },
573 { 0x070c, "TV Tuner Audio" },
574 { 0x070d, "Satellite Rec Audio" },
575 { 0x070e, "Cable Tuner Audio" },
576 { 0x070f, "DSS Audio" },
577 { 0x0710, "Radio Receiver" },
578 { 0x0711, "Radio Transmitter" },
579 { 0x0712, "Multi-Track Recorder" },
580 { 0x0713, "Synthesizer" },
581 { 0 },
582};
583
Takashi Iwai86e07d32005-11-17 15:08:02 +0100584static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 unsigned char *name, int maxlen, int term_only)
586{
587 struct iterm_name_combo *names;
588
589 if (iterm->name)
590 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
591
592 /* virtual type - not a real terminal */
593 if (iterm->type >> 16) {
594 if (term_only)
595 return 0;
596 switch (iterm->type >> 16) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100597 case UAC_SELECTOR_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 strcpy(name, "Selector"); return 8;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200599 case UAC1_PROCESSING_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 strcpy(name, "Process Unit"); return 12;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200601 case UAC1_EXTENSION_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 strcpy(name, "Ext Unit"); return 8;
Daniel Mackde48c7b2010-02-22 23:49:13 +0100603 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 strcpy(name, "Mixer"); return 5;
605 default:
606 return sprintf(name, "Unit %d", iterm->id);
607 }
608 }
609
610 switch (iterm->type & 0xff00) {
611 case 0x0100:
612 strcpy(name, "PCM"); return 3;
613 case 0x0200:
614 strcpy(name, "Mic"); return 3;
615 case 0x0400:
616 strcpy(name, "Headset"); return 7;
617 case 0x0500:
618 strcpy(name, "Phone"); return 5;
619 }
620
621 for (names = iterm_names; names->type; names++)
622 if (names->type == iterm->type) {
623 strcpy(name, names->name);
624 return strlen(names->name);
625 }
626 return 0;
627}
628
629
630/*
631 * parse the source unit recursively until it reaches to a terminal
632 * or a branched unit.
633 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100634static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Daniel Mack09414202010-05-31 13:35:44 +0200636 int err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100637 void *p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 memset(term, 0, sizeof(*term));
640 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100641 unsigned char *hdr = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100643 switch (hdr[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100644 case UAC_INPUT_TERMINAL:
Daniel Mack23caaf12010-03-11 21:13:25 +0100645 if (state->mixer->protocol == UAC_VERSION_1) {
646 struct uac_input_terminal_descriptor *d = p1;
647 term->type = le16_to_cpu(d->wTerminalType);
648 term->channels = d->bNrChannels;
649 term->chconfig = le16_to_cpu(d->wChannelConfig);
650 term->name = d->iTerminal;
651 } else { /* UAC_VERSION_2 */
652 struct uac2_input_terminal_descriptor *d = p1;
653 term->type = le16_to_cpu(d->wTerminalType);
654 term->channels = d->bNrChannels;
655 term->chconfig = le32_to_cpu(d->bmChannelConfig);
656 term->name = d->iTerminal;
Daniel Mack09414202010-05-31 13:35:44 +0200657
658 /* call recursively to get the clock selectors */
659 err = check_input_term(state, d->bCSourceID, term);
660 if (err < 0)
661 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100662 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100664 case UAC_FEATURE_UNIT: {
665 /* the header is the same for v1 and v2 */
666 struct uac_feature_unit_descriptor *d = p1;
Daniel Mack5e688882010-05-08 11:24:56 +0200667 id = d->bSourceID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 break; /* continue to parse */
Daniel Mack23caaf12010-03-11 21:13:25 +0100669 }
670 case UAC_MIXER_UNIT: {
671 struct uac_mixer_unit_descriptor *d = p1;
672 term->type = d->bDescriptorSubtype << 16; /* virtual type */
673 term->channels = uac_mixer_unit_bNrChannels(d);
674 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
675 term->name = uac_mixer_unit_iMixer(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100677 }
Daniel Mack09414202010-05-31 13:35:44 +0200678 case UAC_SELECTOR_UNIT:
679 case UAC2_CLOCK_SELECTOR: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100680 struct uac_selector_unit_descriptor *d = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 /* call recursively to retrieve the channel info */
Daniel Mack23caaf12010-03-11 21:13:25 +0100682 if (check_input_term(state, d->baSourceID[0], term) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 return -ENODEV;
Daniel Mack23caaf12010-03-11 21:13:25 +0100684 term->type = d->bDescriptorSubtype << 16; /* virtual type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100686 term->name = uac_selector_unit_iSelector(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100688 }
Daniel Mack69da9bc2010-06-16 17:57:28 +0200689 case UAC1_PROCESSING_UNIT:
690 case UAC1_EXTENSION_UNIT: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100691 struct uac_processing_unit_descriptor *d = p1;
692 if (d->bNrInPins) {
693 id = d->baSourceID[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 break; /* continue to parse */
695 }
Daniel Mack23caaf12010-03-11 21:13:25 +0100696 term->type = d->bDescriptorSubtype << 16; /* virtual type */
697 term->channels = uac_processing_unit_bNrChannels(d);
698 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
699 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100701 }
Daniel Mack09414202010-05-31 13:35:44 +0200702 case UAC2_CLOCK_SOURCE: {
703 struct uac_clock_source_descriptor *d = p1;
704 term->type = d->bDescriptorSubtype << 16; /* virtual type */
705 term->id = id;
706 term->name = d->iClockSource;
707 return 0;
708 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 default:
710 return -ENODEV;
711 }
712 }
713 return -ENODEV;
714}
715
716
717/*
718 * Feature Unit
719 */
720
721/* feature unit control information */
722struct usb_feature_control_info {
723 const char *name;
724 unsigned int type; /* control type (mute, volume, etc.) */
725};
726
727static struct usb_feature_control_info audio_feature_info[] = {
Daniel Mack2e0281d2010-05-31 13:35:42 +0200728 { "Mute", USB_MIXER_INV_BOOLEAN },
729 { "Volume", USB_MIXER_S16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 { "Tone Control - Bass", USB_MIXER_S8 },
731 { "Tone Control - Mid", USB_MIXER_S8 },
732 { "Tone Control - Treble", USB_MIXER_S8 },
733 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
Daniel Mack2e0281d2010-05-31 13:35:42 +0200734 { "Auto Gain Control", USB_MIXER_BOOLEAN },
735 { "Delay Control", USB_MIXER_U16 },
736 { "Bass Boost", USB_MIXER_BOOLEAN },
737 { "Loudness", USB_MIXER_BOOLEAN },
738 /* UAC2 specific */
739 { "Input Gain Control", USB_MIXER_U16 },
740 { "Input Gain Pad Control", USB_MIXER_BOOLEAN },
741 { "Phase Inverter Control", USB_MIXER_BOOLEAN },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742};
743
744
745/* private_free callback */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100746static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
Jesper Juhl4d572772005-05-30 17:30:32 +0200748 kfree(kctl->private_data);
749 kctl->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750}
751
752
753/*
754 * interface to ALSA control for feature/mixer units
755 */
756
757/*
758 * retrieve the minimum and maximum values for the specified control
759 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100760static int get_min_max(struct usb_mixer_elem_info *cval, int default_min)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
762 /* for failsafe */
763 cval->min = default_min;
764 cval->max = cval->min + 1;
765 cval->res = 1;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100766 cval->dBmin = cval->dBmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
768 if (cval->val_type == USB_MIXER_BOOLEAN ||
769 cval->val_type == USB_MIXER_INV_BOOLEAN) {
770 cval->initialized = 1;
771 } else {
772 int minchn = 0;
773 if (cval->cmask) {
774 int i;
775 for (i = 0; i < MAX_CHANNELS; i++)
776 if (cval->cmask & (1 << i)) {
777 minchn = i + 1;
778 break;
779 }
780 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100781 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
782 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +0200783 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
Takashi Iwai1a4e34e2010-09-16 07:42:34 +0200784 cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 return -EINVAL;
786 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100787 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 cval->res = 1;
789 } else {
790 int last_valid_res = cval->res;
791
792 while (cval->res > 1) {
Daniel Mack7b1eda22010-03-11 21:13:22 +0100793 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
794 (cval->control << 8) | minchn, cval->res / 2) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 break;
796 cval->res /= 2;
797 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100798 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 cval->res = last_valid_res;
800 }
801 if (cval->res == 0)
802 cval->res = 1;
Takashi Iwai14790f12006-03-28 17:58:28 +0200803
804 /* Additional checks for the proper resolution
805 *
806 * Some devices report smaller resolutions than actually
807 * reacting. They don't return errors but simply clip
808 * to the lower aligned value.
809 */
810 if (cval->min + cval->res < cval->max) {
811 int last_valid_res = cval->res;
812 int saved, test, check;
Takashi Iwai641b4872009-01-15 17:05:24 +0100813 get_cur_mix_raw(cval, minchn, &saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200814 for (;;) {
815 test = saved;
816 if (test < cval->max)
817 test += cval->res;
818 else
819 test -= cval->res;
820 if (test < cval->min || test > cval->max ||
Takashi Iwai641b4872009-01-15 17:05:24 +0100821 set_cur_mix_value(cval, minchn, 0, test) ||
822 get_cur_mix_raw(cval, minchn, &check)) {
Takashi Iwai14790f12006-03-28 17:58:28 +0200823 cval->res = last_valid_res;
824 break;
825 }
826 if (test == check)
827 break;
828 cval->res *= 2;
829 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100830 set_cur_mix_value(cval, minchn, 0, saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200831 }
832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 cval->initialized = 1;
834 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100835
836 /* USB descriptions contain the dB scale in 1/256 dB unit
837 * while ALSA TLV contains in 1/100 dB unit
838 */
839 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
840 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
841 if (cval->dBmin > cval->dBmax) {
842 /* something is wrong; assume it's either from/to 0dB */
843 if (cval->dBmin < 0)
844 cval->dBmax = 0;
845 else if (cval->dBmin > 0)
846 cval->dBmin = 0;
847 if (cval->dBmin > cval->dBmax) {
848 /* totally crap, return an error */
849 return -EINVAL;
850 }
851 }
852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 return 0;
854}
855
856
857/* get a feature/mixer unit info */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100858static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100860 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
862 if (cval->val_type == USB_MIXER_BOOLEAN ||
863 cval->val_type == USB_MIXER_INV_BOOLEAN)
864 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
865 else
866 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
867 uinfo->count = cval->channels;
868 if (cval->val_type == USB_MIXER_BOOLEAN ||
869 cval->val_type == USB_MIXER_INV_BOOLEAN) {
870 uinfo->value.integer.min = 0;
871 uinfo->value.integer.max = 1;
872 } else {
873 if (! cval->initialized)
874 get_min_max(cval, 0);
875 uinfo->value.integer.min = 0;
Takashi Iwai14790f12006-03-28 17:58:28 +0200876 uinfo->value.integer.max =
877 (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 }
879 return 0;
880}
881
882/* get the current value from feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100883static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100885 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 int c, cnt, val, err;
887
Takashi Iwai641b4872009-01-15 17:05:24 +0100888 ucontrol->value.integer.value[0] = cval->min;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 if (cval->cmask) {
890 cnt = 0;
891 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +0100892 if (!(cval->cmask & (1 << c)))
893 continue;
894 err = get_cur_mix_value(cval, c + 1, cnt, &val);
895 if (err < 0)
896 return cval->mixer->ignore_ctl_error ? 0 : err;
897 val = get_relative_value(cval, val);
898 ucontrol->value.integer.value[cnt] = val;
899 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100901 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 } else {
903 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100904 err = get_cur_mix_value(cval, 0, 0, &val);
905 if (err < 0)
906 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 val = get_relative_value(cval, val);
908 ucontrol->value.integer.value[0] = val;
909 }
910 return 0;
911}
912
913/* put the current value to feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100914static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100916 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 int c, cnt, val, oval, err;
918 int changed = 0;
919
920 if (cval->cmask) {
921 cnt = 0;
922 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +0100923 if (!(cval->cmask & (1 << c)))
924 continue;
925 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
926 if (err < 0)
927 return cval->mixer->ignore_ctl_error ? 0 : err;
928 val = ucontrol->value.integer.value[cnt];
929 val = get_abs_value(cval, val);
930 if (oval != val) {
931 set_cur_mix_value(cval, c + 1, cnt, val);
932 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100934 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 }
936 } else {
937 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100938 err = get_cur_mix_value(cval, 0, 0, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 if (err < 0)
Takashi Iwai641b4872009-01-15 17:05:24 +0100940 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 val = ucontrol->value.integer.value[0];
942 val = get_abs_value(cval, val);
943 if (val != oval) {
Takashi Iwai641b4872009-01-15 17:05:24 +0100944 set_cur_mix_value(cval, 0, 0, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 changed = 1;
946 }
947 }
948 return changed;
949}
950
Takashi Iwai86e07d32005-11-17 15:08:02 +0100951static struct snd_kcontrol_new usb_feature_unit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
953 .name = "", /* will be filled later manually */
954 .info = mixer_ctl_feature_info,
955 .get = mixer_ctl_feature_get,
956 .put = mixer_ctl_feature_put,
957};
958
Daniel Mack23caaf12010-03-11 21:13:25 +0100959/* the read-only variant */
960static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
961 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
962 .name = "", /* will be filled later manually */
963 .info = mixer_ctl_feature_info,
964 .get = mixer_ctl_feature_get,
965 .put = NULL,
966};
967
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968
969/*
970 * build a feature control
971 */
972
Takashi Iwai08d1e632009-10-02 14:06:08 +0200973static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
974{
975 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
976}
977
Daniel Mack99fc8642010-03-11 21:13:24 +0100978static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 unsigned int ctl_mask, int control,
Daniel Mack23caaf12010-03-11 21:13:25 +0100980 struct usb_audio_term *iterm, int unitid,
Daniel Macka6a33252010-05-31 13:35:37 +0200981 int readonly_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982{
Daniel Mack99fc8642010-03-11 21:13:24 +0100983 struct uac_feature_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 unsigned int len = 0;
985 int mapped_name = 0;
Daniel Mack99fc8642010-03-11 21:13:24 +0100986 int nameid = uac_feature_unit_iFeature(desc);
Takashi Iwai86e07d32005-11-17 15:08:02 +0100987 struct snd_kcontrol *kctl;
988 struct usb_mixer_elem_info *cval;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100989 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
991 control++; /* change from zero-based to 1-based value */
992
Daniel Mack65f25da2010-05-31 13:35:41 +0200993 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 /* FIXME: not supported yet */
995 return;
996 }
997
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100998 map = find_map(state, unitid, control);
999 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 return;
1001
Takashi Iwai561b2202005-09-09 14:22:34 +02001002 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 if (! cval) {
1004 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1005 return;
1006 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001007 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 cval->id = unitid;
1009 cval->control = control;
1010 cval->cmask = ctl_mask;
1011 cval->val_type = audio_feature_info[control-1].type;
Daniel Macka6a33252010-05-31 13:35:37 +02001012 if (ctl_mask == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 cval->channels = 1; /* master channel */
Daniel Macka6a33252010-05-31 13:35:37 +02001014 cval->master_readonly = readonly_mask;
1015 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 int i, c = 0;
1017 for (i = 0; i < 16; i++)
1018 if (ctl_mask & (1 << i))
1019 c++;
1020 cval->channels = c;
Daniel Macka6a33252010-05-31 13:35:37 +02001021 cval->ch_readonly = readonly_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 }
1023
1024 /* get min/max values */
1025 get_min_max(cval, 0);
1026
Daniel Macka6a33252010-05-31 13:35:37 +02001027 /* if all channels in the mask are marked read-only, make the control
1028 * read-only. set_cur_mix_value() will check the mask again and won't
1029 * issue write commands to read-only channels. */
1030 if (cval->channels == readonly_mask)
Daniel Mack23caaf12010-03-11 21:13:25 +01001031 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1032 else
1033 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1034
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 if (! kctl) {
1036 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1037 kfree(cval);
1038 return;
1039 }
1040 kctl->private_free = usb_mixer_elem_free;
1041
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001042 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 mapped_name = len != 0;
1044 if (! len && nameid)
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001045 len = snd_usb_copy_string_desc(state, nameid,
1046 kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
1048 switch (control) {
Daniel Mack65f25da2010-05-31 13:35:41 +02001049 case UAC_FU_MUTE:
1050 case UAC_FU_VOLUME:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 /* determine the control name. the rule is:
1052 * - if a name id is given in descriptor, use it.
1053 * - if the connected input can be determined, then use the name
1054 * of terminal type.
1055 * - if the connected output can be determined, use it.
1056 * - otherwise, anonymous name.
1057 */
1058 if (! len) {
1059 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1060 if (! len)
1061 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1062 if (! len)
1063 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1064 "Feature %d", unitid);
1065 }
1066 /* determine the stream direction:
1067 * if the connected output is USB stream, then it's likely a
1068 * capture stream. otherwise it should be playback (hopefully :)
1069 */
1070 if (! mapped_name && ! (state->oterm.type >> 16)) {
1071 if ((state->oterm.type & 0xff00) == 0x0100) {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001072 len = append_ctl_name(kctl, " Capture");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 } else {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001074 len = append_ctl_name(kctl, " Playback");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 }
1076 }
Daniel Mack65f25da2010-05-31 13:35:41 +02001077 append_ctl_name(kctl, control == UAC_FU_MUTE ?
Takashi Iwai08d1e632009-10-02 14:06:08 +02001078 " Switch" : " Volume");
Daniel Mack65f25da2010-05-31 13:35:41 +02001079 if (control == UAC_FU_VOLUME) {
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +02001080 kctl->tlv.c = mixer_vol_tlv;
1081 kctl->vd[0].access |=
1082 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1083 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001084 check_mapped_dB(map, cval);
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +02001085 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 break;
1087
1088 default:
1089 if (! len)
1090 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1091 sizeof(kctl->id.name));
1092 break;
1093 }
1094
Alexey Fisher2cf313e2009-07-22 14:57:54 +02001095 /* volume control quirks */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02001096 switch (state->chip->usb_id) {
1097 case USB_ID(0x0471, 0x0101):
1098 case USB_ID(0x0471, 0x0104):
1099 case USB_ID(0x0471, 0x0105):
1100 case USB_ID(0x0672, 0x1041):
Alexey Fisher2cf313e2009-07-22 14:57:54 +02001101 /* quirk for UDA1321/N101.
1102 * note that detection between firmware 2.1.1.7 (N101)
1103 * and later 2.1.1.21 is not very clear from datasheets.
1104 * I hope that the min value is -15360 for newer firmware --jk
1105 */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02001106 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1107 cval->min == -15616) {
Alexey Fisher2cf313e2009-07-22 14:57:54 +02001108 snd_printk(KERN_INFO
1109 "set volume quirk for UDA1321/N101 chip\n");
Clemens Ladisch27d10f52005-05-02 08:51:26 +02001110 cval->max = -256;
1111 }
Alexey Fisher2cf313e2009-07-22 14:57:54 +02001112 break;
1113
1114 case USB_ID(0x046d, 0x09a4):
1115 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1116 snd_printk(KERN_INFO
1117 "set volume quirk for QuickCam E3500\n");
1118 cval->min = 6080;
1119 cval->max = 8768;
1120 cval->res = 192;
1121 }
1122 break;
1123
Alexey Fishera5c7d792010-06-23 14:17:09 +02001124 case USB_ID(0x046d, 0x0809):
1125 case USB_ID(0x046d, 0x0991):
1126 /* Most audio usb devices lie about volume resolution.
1127 * Most Logitech webcams have res = 384.
1128 * Proboly there is some logitech magic behind this number --fishor
1129 */
1130 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1131 snd_printk(KERN_INFO
1132 "set resolution quirk: cval->res = 384\n");
1133 cval->res = 384;
1134 }
1135 break;
1136
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 }
1138
1139 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1140 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001141 add_control_to_empty(state, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142}
1143
1144
1145
1146/*
1147 * parse a feature unit
1148 *
1149 * most of controlls are defined here.
1150 */
Daniel Mack28e1b772010-02-22 23:49:09 +01001151static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152{
1153 int channels, i, j;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001154 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 unsigned int master_bits, first_ch_bits;
1156 int err, csize;
Daniel Mack23caaf12010-03-11 21:13:25 +01001157 struct uac_feature_unit_descriptor *hdr = _ftr;
1158 __u8 *bmaControls;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
Daniel Mack23caaf12010-03-11 21:13:25 +01001160 if (state->mixer->protocol == UAC_VERSION_1) {
1161 csize = hdr->bControlSize;
1162 channels = (hdr->bLength - 7) / csize - 1;
1163 bmaControls = hdr->bmaControls;
1164 } else {
1165 struct uac2_feature_unit_descriptor *ftr = _ftr;
1166 csize = 4;
Daniel Macke8d0fee2010-05-27 20:15:14 +02001167 channels = (hdr->bLength - 6) / 4 - 1;
Daniel Mack23caaf12010-03-11 21:13:25 +01001168 bmaControls = ftr->bmaControls;
1169 }
1170
1171 if (hdr->bLength < 7 || !csize || hdr->bLength < 7 + csize) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01001172 snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 return -EINVAL;
1174 }
1175
1176 /* parse the source unit */
Daniel Mack23caaf12010-03-11 21:13:25 +01001177 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 return err;
1179
1180 /* determine the input source type and name */
Daniel Mack23caaf12010-03-11 21:13:25 +01001181 if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 return -EINVAL;
1183
Daniel Mack23caaf12010-03-11 21:13:25 +01001184 master_bits = snd_usb_combine_bytes(bmaControls, csize);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001185 /* master configuration quirks */
1186 switch (state->chip->usb_id) {
1187 case USB_ID(0x08bb, 0x2702):
1188 snd_printk(KERN_INFO
1189 "usbmixer: master volume quirk for PCM2702 chip\n");
1190 /* disable non-functional volume control */
Daniel Mack65f25da2010-05-31 13:35:41 +02001191 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001192 break;
1193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 if (channels > 0)
Daniel Mack23caaf12010-03-11 21:13:25 +01001195 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 else
1197 first_ch_bits = 0;
Daniel Mack23caaf12010-03-11 21:13:25 +01001198
1199 if (state->mixer->protocol == UAC_VERSION_1) {
1200 /* check all control types */
1201 for (i = 0; i < 10; i++) {
1202 unsigned int ch_bits = 0;
1203 for (j = 0; j < channels; j++) {
1204 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1205 if (mask & (1 << i))
1206 ch_bits |= (1 << j);
1207 }
1208 /* audio class v1 controls are never read-only */
1209 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1210 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1211 if (master_bits & (1 << i))
1212 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001214 } else { /* UAC_VERSION_2 */
1215 for (i = 0; i < 30/2; i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001216 unsigned int ch_bits = 0;
1217 unsigned int ch_read_only = 0;
1218
1219 for (j = 0; j < channels; j++) {
1220 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001221 if (uac2_control_is_readable(mask, i)) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001222 ch_bits |= (1 << j);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001223 if (!uac2_control_is_writeable(mask, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001224 ch_read_only |= (1 << j);
1225 }
1226 }
1227
Daniel Macka6a33252010-05-31 13:35:37 +02001228 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1229 * are marked read-only in the descriptors. Otherwise, the control will be
1230 * reported as writeable, but the driver will not actually issue a write
1231 * command for read-only channels */
Daniel Mack23caaf12010-03-11 21:13:25 +01001232 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
Daniel Macka6a33252010-05-31 13:35:37 +02001233 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001234 if (uac2_control_is_readable(master_bits, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001235 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001236 !uac2_control_is_writeable(master_bits, i));
Daniel Mack23caaf12010-03-11 21:13:25 +01001237 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 }
1239
1240 return 0;
1241}
1242
1243
1244/*
1245 * Mixer Unit
1246 */
1247
1248/*
1249 * build a mixer unit control
1250 *
1251 * the callbacks are identical with feature unit.
1252 * input channel number (zero based) is given in control field instead.
1253 */
1254
Daniel Mack99fc8642010-03-11 21:13:24 +01001255static void build_mixer_unit_ctl(struct mixer_build *state,
1256 struct uac_mixer_unit_descriptor *desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 int in_pin, int in_ch, int unitid,
Takashi Iwai86e07d32005-11-17 15:08:02 +01001258 struct usb_audio_term *iterm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001260 struct usb_mixer_elem_info *cval;
Daniel Mack99fc8642010-03-11 21:13:24 +01001261 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 unsigned int i, len;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001263 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001264 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001266 map = find_map(state, unitid, 0);
1267 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 return;
1269
Takashi Iwai561b2202005-09-09 14:22:34 +02001270 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 if (! cval)
1272 return;
1273
Clemens Ladisch84957a82005-04-29 16:23:13 +02001274 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 cval->id = unitid;
1276 cval->control = in_ch + 1; /* based on 1 */
1277 cval->val_type = USB_MIXER_S16;
1278 for (i = 0; i < num_outs; i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001279 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 cval->cmask |= (1 << i);
1281 cval->channels++;
1282 }
1283 }
1284
1285 /* get min/max values */
1286 get_min_max(cval, 0);
1287
1288 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1289 if (! kctl) {
1290 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1291 kfree(cval);
1292 return;
1293 }
1294 kctl->private_free = usb_mixer_elem_free;
1295
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001296 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 if (! len)
1298 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1299 if (! len)
1300 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
Takashi Iwai08d1e632009-10-02 14:06:08 +02001301 append_ctl_name(kctl, " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
1303 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1304 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001305 add_control_to_empty(state, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306}
1307
1308
1309/*
1310 * parse a mixer unit
1311 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001312static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313{
Daniel Mack99fc8642010-03-11 21:13:24 +01001314 struct uac_mixer_unit_descriptor *desc = raw_desc;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001315 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 int input_pins, num_ins, num_outs;
1317 int pin, ich, err;
1318
Daniel Mack99fc8642010-03-11 21:13:24 +01001319 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1321 return -EINVAL;
1322 }
1323 /* no bmControls field (e.g. Maya44) -> ignore */
Daniel Mack99fc8642010-03-11 21:13:24 +01001324 if (desc->bLength <= 10 + input_pins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1326 return 0;
1327 }
1328
1329 num_ins = 0;
1330 ich = 0;
1331 for (pin = 0; pin < input_pins; pin++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001332 err = parse_audio_unit(state, desc->baSourceID[pin]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 if (err < 0)
1334 return err;
Daniel Mack99fc8642010-03-11 21:13:24 +01001335 err = check_input_term(state, desc->baSourceID[pin], &iterm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 if (err < 0)
1337 return err;
1338 num_ins += iterm.channels;
1339 for (; ich < num_ins; ++ich) {
1340 int och, ich_has_controls = 0;
1341
1342 for (och = 0; och < num_outs; ++och) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001343 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 ich, och, num_outs)) {
1345 ich_has_controls = 1;
1346 break;
1347 }
1348 }
1349 if (ich_has_controls)
1350 build_mixer_unit_ctl(state, desc, pin, ich,
1351 unitid, &iterm);
1352 }
1353 }
1354 return 0;
1355}
1356
1357
1358/*
1359 * Processing Unit / Extension Unit
1360 */
1361
1362/* get callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001363static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001365 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 int err, val;
1367
1368 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001369 if (err < 0 && cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 ucontrol->value.integer.value[0] = cval->min;
1371 return 0;
1372 }
1373 if (err < 0)
1374 return err;
1375 val = get_relative_value(cval, val);
1376 ucontrol->value.integer.value[0] = val;
1377 return 0;
1378}
1379
1380/* put callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001381static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001383 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 int val, oval, err;
1385
1386 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1387 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001388 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 return 0;
1390 return err;
1391 }
1392 val = ucontrol->value.integer.value[0];
1393 val = get_abs_value(cval, val);
1394 if (val != oval) {
1395 set_cur_ctl_value(cval, cval->control << 8, val);
1396 return 1;
1397 }
1398 return 0;
1399}
1400
1401/* alsa control interface for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001402static struct snd_kcontrol_new mixer_procunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1404 .name = "", /* will be filled later */
1405 .info = mixer_ctl_feature_info,
1406 .get = mixer_ctl_procunit_get,
1407 .put = mixer_ctl_procunit_put,
1408};
1409
1410
1411/*
1412 * predefined data for processing units
1413 */
1414struct procunit_value_info {
1415 int control;
1416 char *suffix;
1417 int val_type;
1418 int min_value;
1419};
1420
1421struct procunit_info {
1422 int type;
1423 char *name;
1424 struct procunit_value_info *values;
1425};
1426
1427static struct procunit_value_info updown_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001428 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1429 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 { 0 }
1431};
1432static struct procunit_value_info prologic_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001433 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1434 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 { 0 }
1436};
1437static struct procunit_value_info threed_enh_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001438 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1439 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 { 0 }
1441};
1442static struct procunit_value_info reverb_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001443 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1444 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1445 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1446 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 { 0 }
1448};
1449static struct procunit_value_info chorus_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001450 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1451 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1452 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1453 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 { 0 }
1455};
1456static struct procunit_value_info dcr_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001457 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1458 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1459 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1460 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1461 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1462 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 { 0 }
1464};
1465
1466static struct procunit_info procunits[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001467 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1468 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1469 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1470 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1471 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1472 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 { 0 },
1474};
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001475/*
1476 * predefined data for extension units
1477 */
1478static struct procunit_value_info clock_rate_xu_info[] = {
Daniel Macke213e9c2010-05-11 18:13:50 +02001479 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1480 { 0 }
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001481};
1482static struct procunit_value_info clock_source_xu_info[] = {
1483 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1484 { 0 }
1485};
1486static struct procunit_value_info spdif_format_xu_info[] = {
1487 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1488 { 0 }
1489};
1490static struct procunit_value_info soft_limit_xu_info[] = {
1491 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1492 { 0 }
1493};
1494static struct procunit_info extunits[] = {
1495 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1496 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1497 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1498 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1499 { 0 }
1500};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501/*
1502 * build a processing/extension unit
1503 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001504static 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 -07001505{
Daniel Mack99fc8642010-03-11 21:13:24 +01001506 struct uac_processing_unit_descriptor *desc = raw_desc;
1507 int num_ins = desc->bNrInPins;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001508 struct usb_mixer_elem_info *cval;
1509 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 int i, err, nameid, type, len;
1511 struct procunit_info *info;
1512 struct procunit_value_info *valinfo;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001513 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 static struct procunit_value_info default_value_info[] = {
1515 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1516 { 0 }
1517 };
1518 static struct procunit_info default_info = {
1519 0, NULL, default_value_info
1520 };
1521
Daniel Mack23caaf12010-03-11 21:13:25 +01001522 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1523 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1525 return -EINVAL;
1526 }
1527
1528 for (i = 0; i < num_ins; i++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001529 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 return err;
1531 }
1532
Daniel Mack99fc8642010-03-11 21:13:24 +01001533 type = le16_to_cpu(desc->wProcessType);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 for (info = list; info && info->type; info++)
1535 if (info->type == type)
1536 break;
1537 if (! info || ! info->type)
1538 info = &default_info;
1539
1540 for (valinfo = info->values; valinfo->control; valinfo++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001541 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
Daniel Mack99fc8642010-03-11 21:13:24 +01001542
1543 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 continue;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001545 map = find_map(state, unitid, valinfo->control);
1546 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 continue;
Takashi Iwai561b2202005-09-09 14:22:34 +02001548 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 if (! cval) {
1550 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1551 return -ENOMEM;
1552 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001553 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 cval->id = unitid;
1555 cval->control = valinfo->control;
1556 cval->val_type = valinfo->val_type;
1557 cval->channels = 1;
1558
1559 /* get min/max values */
Daniel Mack65f25da2010-05-31 13:35:41 +02001560 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001561 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 /* FIXME: hard-coded */
1563 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001564 cval->max = control_spec[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 cval->res = 1;
1566 cval->initialized = 1;
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001567 } else {
1568 if (type == USB_XU_CLOCK_RATE) {
1569 /* E-Mu USB 0404/0202/TrackerPre
1570 * samplerate control quirk
1571 */
1572 cval->min = 0;
1573 cval->max = 5;
1574 cval->res = 1;
1575 cval->initialized = 1;
1576 } else
1577 get_min_max(cval, valinfo->min_value);
1578 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579
1580 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1581 if (! kctl) {
1582 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1583 kfree(cval);
1584 return -ENOMEM;
1585 }
1586 kctl->private_free = usb_mixer_elem_free;
1587
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001588 if (check_mapped_name(map, kctl->id.name,
1589 sizeof(kctl->id.name)))
1590 /* nothing */ ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 else if (info->name)
1592 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1593 else {
Daniel Mack23caaf12010-03-11 21:13:25 +01001594 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 len = 0;
1596 if (nameid)
1597 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1598 if (! len)
1599 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1600 }
Takashi Iwai08d1e632009-10-02 14:06:08 +02001601 append_ctl_name(kctl, " ");
1602 append_ctl_name(kctl, valinfo->suffix);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
1604 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1605 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001606 if ((err = add_control_to_empty(state, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 return err;
1608 }
1609 return 0;
1610}
1611
1612
Daniel Mack99fc8642010-03-11 21:13:24 +01001613static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614{
Daniel Mack99fc8642010-03-11 21:13:24 +01001615 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616}
1617
Daniel Mack99fc8642010-03-11 21:13:24 +01001618static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619{
Daniel Mack99fc8642010-03-11 21:13:24 +01001620 /* Note that we parse extension units with processing unit descriptors.
1621 * That's ok as the layout is the same */
1622 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623}
1624
1625
1626/*
1627 * Selector Unit
1628 */
1629
1630/* info callback for selector unit
1631 * use an enumerator type for routing
1632 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001633static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001635 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 char **itemlist = (char **)kcontrol->private_value;
1637
Takashi Iwai5e246b82008-08-08 17:12:47 +02001638 if (snd_BUG_ON(!itemlist))
1639 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1641 uinfo->count = 1;
1642 uinfo->value.enumerated.items = cval->max;
Dan Carpenter26e34e92010-09-16 20:13:47 +02001643 if (uinfo->value.enumerated.item >= cval->max)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 uinfo->value.enumerated.item = cval->max - 1;
Dan Carpenter26e34e92010-09-16 20:13:47 +02001645 strlcpy(uinfo->value.enumerated.name, itemlist[uinfo->value.enumerated.item],
1646 sizeof(uinfo->value.enumerated.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 return 0;
1648}
1649
1650/* get callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001651static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001653 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 int val, err;
1655
Daniel Mack09414202010-05-31 13:35:44 +02001656 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001658 if (cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 ucontrol->value.enumerated.item[0] = 0;
1660 return 0;
1661 }
1662 return err;
1663 }
1664 val = get_relative_value(cval, val);
1665 ucontrol->value.enumerated.item[0] = val;
1666 return 0;
1667}
1668
1669/* put callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001670static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001672 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 int val, oval, err;
1674
Daniel Mack09414202010-05-31 13:35:44 +02001675 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001677 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 return 0;
1679 return err;
1680 }
1681 val = ucontrol->value.enumerated.item[0];
1682 val = get_abs_value(cval, val);
1683 if (val != oval) {
Daniel Mack09414202010-05-31 13:35:44 +02001684 set_cur_ctl_value(cval, cval->control << 8, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 return 1;
1686 }
1687 return 0;
1688}
1689
1690/* alsa control interface for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001691static struct snd_kcontrol_new mixer_selectunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1693 .name = "", /* will be filled later */
1694 .info = mixer_ctl_selector_info,
1695 .get = mixer_ctl_selector_get,
1696 .put = mixer_ctl_selector_put,
1697};
1698
1699
1700/* private free callback.
1701 * free both private_data and private_value
1702 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001703static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704{
1705 int i, num_ins = 0;
1706
1707 if (kctl->private_data) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001708 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 num_ins = cval->max;
1710 kfree(cval);
1711 kctl->private_data = NULL;
1712 }
1713 if (kctl->private_value) {
1714 char **itemlist = (char **)kctl->private_value;
1715 for (i = 0; i < num_ins; i++)
1716 kfree(itemlist[i]);
1717 kfree(itemlist);
1718 kctl->private_value = 0;
1719 }
1720}
1721
1722/*
1723 * parse a selector unit
1724 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001725static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726{
Daniel Mack99fc8642010-03-11 21:13:24 +01001727 struct uac_selector_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 unsigned int i, nameid, len;
1729 int err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001730 struct usb_mixer_elem_info *cval;
1731 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001732 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 char **namelist;
1734
Daniel Mack99fc8642010-03-11 21:13:24 +01001735 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1737 return -EINVAL;
1738 }
1739
Daniel Mack99fc8642010-03-11 21:13:24 +01001740 for (i = 0; i < desc->bNrInPins; i++) {
1741 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 return err;
1743 }
1744
Daniel Mack99fc8642010-03-11 21:13:24 +01001745 if (desc->bNrInPins == 1) /* only one ? nonsense! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 return 0;
1747
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001748 map = find_map(state, unitid, 0);
1749 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 return 0;
1751
Takashi Iwai561b2202005-09-09 14:22:34 +02001752 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 if (! cval) {
1754 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1755 return -ENOMEM;
1756 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001757 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 cval->id = unitid;
1759 cval->val_type = USB_MIXER_U8;
1760 cval->channels = 1;
1761 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001762 cval->max = desc->bNrInPins;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 cval->res = 1;
1764 cval->initialized = 1;
1765
Daniel Mack09414202010-05-31 13:35:44 +02001766 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1767 cval->control = UAC2_CX_CLOCK_SELECTOR;
1768 else
1769 cval->control = 0;
1770
Daniel Mack99fc8642010-03-11 21:13:24 +01001771 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 if (! namelist) {
1773 snd_printk(KERN_ERR "cannot malloc\n");
1774 kfree(cval);
1775 return -ENOMEM;
1776 }
1777#define MAX_ITEM_NAME_LEN 64
Daniel Mack99fc8642010-03-11 21:13:24 +01001778 for (i = 0; i < desc->bNrInPins; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001779 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 len = 0;
1781 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1782 if (! namelist[i]) {
1783 snd_printk(KERN_ERR "cannot malloc\n");
Mariusz Kozlowski7fbe3ca2007-01-08 11:25:30 +01001784 while (i--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 kfree(namelist[i]);
1786 kfree(namelist);
1787 kfree(cval);
1788 return -ENOMEM;
1789 }
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02001790 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1791 MAX_ITEM_NAME_LEN);
Daniel Mack99fc8642010-03-11 21:13:24 +01001792 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1794 if (! len)
1795 sprintf(namelist[i], "Input %d", i);
1796 }
1797
1798 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1799 if (! kctl) {
1800 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
Jesper Juhl878b4782006-03-20 11:27:13 +01001801 kfree(namelist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 kfree(cval);
1803 return -ENOMEM;
1804 }
1805 kctl->private_value = (unsigned long)namelist;
1806 kctl->private_free = usb_mixer_selector_elem_free;
1807
Daniel Mack99fc8642010-03-11 21:13:24 +01001808 nameid = uac_selector_unit_iSelector(desc);
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001809 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 if (len)
1811 ;
1812 else if (nameid)
1813 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1814 else {
1815 len = get_term_name(state, &state->oterm,
1816 kctl->id.name, sizeof(kctl->id.name), 0);
1817 if (! len)
1818 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1819
Daniel Mack09414202010-05-31 13:35:44 +02001820 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1821 append_ctl_name(kctl, " Clock Source");
1822 else if ((state->oterm.type & 0xff00) == 0x0100)
Takashi Iwai08d1e632009-10-02 14:06:08 +02001823 append_ctl_name(kctl, " Capture Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 else
Takashi Iwai08d1e632009-10-02 14:06:08 +02001825 append_ctl_name(kctl, " Playback Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 }
1827
1828 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
Daniel Mack99fc8642010-03-11 21:13:24 +01001829 cval->id, kctl->id.name, desc->bNrInPins);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001830 if ((err = add_control_to_empty(state, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 return err;
1832
1833 return 0;
1834}
1835
1836
1837/*
1838 * parse an audio unit recursively
1839 */
1840
Takashi Iwai86e07d32005-11-17 15:08:02 +01001841static int parse_audio_unit(struct mixer_build *state, int unitid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842{
1843 unsigned char *p1;
1844
1845 if (test_and_set_bit(unitid, state->unitbitmap))
1846 return 0; /* the unit already visited */
1847
1848 p1 = find_audio_control_unit(state, unitid);
1849 if (!p1) {
1850 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1851 return -EINVAL;
1852 }
1853
1854 switch (p1[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01001855 case UAC_INPUT_TERMINAL:
Daniel Mack09414202010-05-31 13:35:44 +02001856 case UAC2_CLOCK_SOURCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 return 0; /* NOP */
Daniel Mackde48c7b2010-02-22 23:49:13 +01001858 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 return parse_audio_mixer_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01001860 case UAC_SELECTOR_UNIT:
Daniel Mack09414202010-05-31 13:35:44 +02001861 case UAC2_CLOCK_SELECTOR:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 return parse_audio_selector_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01001863 case UAC_FEATURE_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 return parse_audio_feature_unit(state, unitid, p1);
Daniel Mack69da9bc2010-06-16 17:57:28 +02001865 case UAC1_PROCESSING_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01001866 /* UAC2_EFFECT_UNIT has the same value */
1867 if (state->mixer->protocol == UAC_VERSION_1)
1868 return parse_audio_processing_unit(state, unitid, p1);
1869 else
1870 return 0; /* FIXME - effect units not implemented yet */
Daniel Mack69da9bc2010-06-16 17:57:28 +02001871 case UAC1_EXTENSION_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01001872 /* UAC2_PROCESSING_UNIT_V2 has the same value */
1873 if (state->mixer->protocol == UAC_VERSION_1)
1874 return parse_audio_extension_unit(state, unitid, p1);
1875 else /* UAC_VERSION_2 */
1876 return parse_audio_processing_unit(state, unitid, p1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 default:
1878 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1879 return -EINVAL;
1880 }
1881}
1882
Clemens Ladisch84957a82005-04-29 16:23:13 +02001883static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1884{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02001885 kfree(mixer->id_elems);
1886 if (mixer->urb) {
1887 kfree(mixer->urb->transfer_buffer);
1888 usb_free_urb(mixer->urb);
1889 }
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01001890 usb_free_urb(mixer->rc_urb);
Clemens Ladischb259b102005-04-29 16:29:28 +02001891 kfree(mixer->rc_setup_packet);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001892 kfree(mixer);
1893}
1894
Takashi Iwai86e07d32005-11-17 15:08:02 +01001895static int snd_usb_mixer_dev_free(struct snd_device *device)
Clemens Ladisch84957a82005-04-29 16:23:13 +02001896{
1897 struct usb_mixer_interface *mixer = device->device_data;
1898 snd_usb_mixer_free(mixer);
1899 return 0;
1900}
1901
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902/*
1903 * create mixer controls
1904 *
Daniel Mackde48c7b2010-02-22 23:49:13 +01001905 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 */
Clemens Ladisch84957a82005-04-29 16:23:13 +02001907static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001909 struct mixer_build state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 int err;
1911 const struct usbmix_ctl_map *map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02001912 struct usb_host_interface *hostif;
Daniel Mack23caaf12010-03-11 21:13:25 +01001913 void *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02001915 hostif = mixer->chip->ctrl_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 memset(&state, 0, sizeof(state));
Clemens Ladisch84957a82005-04-29 16:23:13 +02001917 state.chip = mixer->chip;
1918 state.mixer = mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 state.buffer = hostif->extra;
1920 state.buflen = hostif->extralen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921
1922 /* check the mapping table */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02001923 for (map = usbmix_ctl_maps; map->id; map++) {
1924 if (map->id == state.chip->usb_id) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 state.map = map->map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02001926 state.selector_map = map->selector_map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02001927 mixer->ignore_ctl_error = map->ignore_ctl_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 break;
1929 }
1930 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931
Daniel Mack23caaf12010-03-11 21:13:25 +01001932 p = NULL;
1933 while ((p = snd_usb_find_csint_desc(hostif->extra, hostif->extralen, p, UAC_OUTPUT_TERMINAL)) != NULL) {
1934 if (mixer->protocol == UAC_VERSION_1) {
Daniel Mack69da9bc2010-06-16 17:57:28 +02001935 struct uac1_output_terminal_descriptor *desc = p;
Daniel Mack23caaf12010-03-11 21:13:25 +01001936
1937 if (desc->bLength < sizeof(*desc))
1938 continue; /* invalid descriptor? */
1939 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
1940 state.oterm.id = desc->bTerminalID;
1941 state.oterm.type = le16_to_cpu(desc->wTerminalType);
1942 state.oterm.name = desc->iTerminal;
1943 err = parse_audio_unit(&state, desc->bSourceID);
1944 if (err < 0)
1945 return err;
1946 } else { /* UAC_VERSION_2 */
1947 struct uac2_output_terminal_descriptor *desc = p;
1948
1949 if (desc->bLength < sizeof(*desc))
1950 continue; /* invalid descriptor? */
1951 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
1952 state.oterm.id = desc->bTerminalID;
1953 state.oterm.type = le16_to_cpu(desc->wTerminalType);
1954 state.oterm.name = desc->iTerminal;
1955 err = parse_audio_unit(&state, desc->bSourceID);
1956 if (err < 0)
1957 return err;
Daniel Mack09414202010-05-31 13:35:44 +02001958
1959 /* for UAC2, use the same approach to also add the clock selectors */
1960 err = parse_audio_unit(&state, desc->bCSourceID);
1961 if (err < 0)
1962 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +01001963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 return 0;
1967}
Clemens Ladisch84957a82005-04-29 16:23:13 +02001968
Daniel Mack7b1eda22010-03-11 21:13:22 +01001969void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02001970{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001971 struct usb_mixer_elem_info *info;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02001972
1973 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
1974 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1975 info->elem_id);
1976}
1977
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01001978static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
1979 int unitid,
1980 struct usb_mixer_elem_info *cval)
1981{
1982 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
1983 "S8", "U8", "S16", "U16"};
1984 snd_iprintf(buffer, " Unit: %i\n", unitid);
1985 if (cval->elem_id)
1986 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
1987 cval->elem_id->name, cval->elem_id->index);
1988 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
1989 "channels=%i, type=\"%s\"\n", cval->id,
1990 cval->control, cval->cmask, cval->channels,
1991 val_types[cval->val_type]);
1992 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
1993 cval->min, cval->max, cval->dBmin, cval->dBmax);
1994}
1995
1996static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
1997 struct snd_info_buffer *buffer)
1998{
1999 struct snd_usb_audio *chip = entry->private_data;
2000 struct usb_mixer_interface *mixer;
2001 struct usb_mixer_elem_info *cval;
2002 int unitid;
2003
2004 list_for_each_entry(mixer, &chip->mixer_list, list) {
2005 snd_iprintf(buffer,
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002006 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002007 chip->usb_id, snd_usb_ctrl_intf(chip),
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002008 mixer->ignore_ctl_error);
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002009 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2010 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2011 for (cval = mixer->id_elems[unitid]; cval;
2012 cval = cval->next_id_elem)
2013 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2014 }
2015 }
2016}
2017
Daniel Macke213e9c2010-05-11 18:13:50 +02002018static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2019 int attribute, int value, int index)
2020{
2021 struct usb_mixer_elem_info *info;
2022 __u8 unitid = (index >> 8) & 0xff;
2023 __u8 control = (value >> 8) & 0xff;
2024 __u8 channel = value & 0xff;
2025
2026 if (channel >= MAX_CHANNELS) {
2027 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2028 __func__, channel);
2029 return;
2030 }
2031
2032 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2033 if (info->control != control)
2034 continue;
2035
2036 switch (attribute) {
2037 case UAC2_CS_CUR:
2038 /* invalidate cache, so the value is read from the device */
2039 if (channel)
2040 info->cached &= ~(1 << channel);
2041 else /* master channel */
2042 info->cached = 0;
2043
2044 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2045 info->elem_id);
2046 break;
2047
2048 case UAC2_CS_RANGE:
2049 /* TODO */
2050 break;
2051
2052 case UAC2_CS_MEM:
2053 /* TODO */
2054 break;
2055
2056 default:
2057 snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2058 attribute);
2059 break;
2060 } /* switch */
2061 }
2062}
2063
2064static void snd_usb_mixer_interrupt(struct urb *urb)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002065{
2066 struct usb_mixer_interface *mixer = urb->context;
Daniel Macke213e9c2010-05-11 18:13:50 +02002067 int len = urb->actual_length;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002068
Daniel Macke213e9c2010-05-11 18:13:50 +02002069 if (urb->status != 0)
2070 goto requeue;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002071
Daniel Macke213e9c2010-05-11 18:13:50 +02002072 if (mixer->protocol == UAC_VERSION_1) {
2073 struct uac1_status_word *status;
2074
2075 for (status = urb->transfer_buffer;
2076 len >= sizeof(*status);
2077 len -= sizeof(*status), status++) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002078 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
Daniel Macke213e9c2010-05-11 18:13:50 +02002079 status->bStatusType,
2080 status->bOriginator);
2081
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002082 /* ignore any notifications not from the control interface */
Daniel Macke213e9c2010-05-11 18:13:50 +02002083 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2084 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002085 continue;
Daniel Macke213e9c2010-05-11 18:13:50 +02002086
2087 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2088 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
Clemens Ladischb259b102005-04-29 16:29:28 +02002089 else
Daniel Macke213e9c2010-05-11 18:13:50 +02002090 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2091 }
2092 } else { /* UAC_VERSION_2 */
2093 struct uac2_interrupt_data_msg *msg;
2094
2095 for (msg = urb->transfer_buffer;
2096 len >= sizeof(*msg);
2097 len -= sizeof(*msg), msg++) {
2098 /* drop vendor specific and endpoint requests */
2099 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2100 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2101 continue;
2102
2103 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2104 le16_to_cpu(msg->wValue),
2105 le16_to_cpu(msg->wIndex));
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002106 }
2107 }
Daniel Macke213e9c2010-05-11 18:13:50 +02002108
2109requeue:
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002110 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
2111 urb->dev = mixer->chip->dev;
2112 usb_submit_urb(urb, GFP_ATOMIC);
2113 }
2114}
2115
2116/* create the handler for the optional status interrupt endpoint */
2117static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2118{
2119 struct usb_host_interface *hostif;
2120 struct usb_endpoint_descriptor *ep;
2121 void *transfer_buffer;
2122 int buffer_length;
2123 unsigned int epnum;
2124
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002125 hostif = mixer->chip->ctrl_intf;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002126 /* we need one interrupt input endpoint */
2127 if (get_iface_desc(hostif)->bNumEndpoints < 1)
2128 return 0;
2129 ep = get_endpoint(hostif, 0);
Julia Lawall913ae5a2009-01-03 17:54:53 +01002130 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002131 return 0;
2132
Julia Lawall42a6e662008-12-29 11:23:02 +01002133 epnum = usb_endpoint_num(ep);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002134 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2135 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2136 if (!transfer_buffer)
2137 return -ENOMEM;
2138 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2139 if (!mixer->urb) {
2140 kfree(transfer_buffer);
2141 return -ENOMEM;
2142 }
2143 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2144 usb_rcvintpipe(mixer->chip->dev, epnum),
2145 transfer_buffer, buffer_length,
Daniel Macke213e9c2010-05-11 18:13:50 +02002146 snd_usb_mixer_interrupt, mixer, ep->bInterval);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002147 usb_submit_urb(mixer->urb, GFP_KERNEL);
2148 return 0;
2149}
2150
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002151int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2152 int ignore_error)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002153{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002154 static struct snd_device_ops dev_ops = {
Clemens Ladisch84957a82005-04-29 16:23:13 +02002155 .dev_free = snd_usb_mixer_dev_free
2156 };
2157 struct usb_mixer_interface *mixer;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002158 struct snd_info_entry *entry;
Daniel Mack7b8a0432010-02-22 23:49:12 +01002159 struct usb_host_interface *host_iface;
Daniel Mack23caaf12010-03-11 21:13:25 +01002160 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002161
2162 strcpy(chip->card->mixername, "USB Mixer");
2163
Takashi Iwai561b2202005-09-09 14:22:34 +02002164 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002165 if (!mixer)
2166 return -ENOMEM;
2167 mixer->chip = chip;
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002168 mixer->ignore_ctl_error = ignore_error;
Jaroslav Kysela291186e2010-02-16 11:55:18 +01002169 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2170 GFP_KERNEL);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002171 if (!mixer->id_elems) {
2172 kfree(mixer);
2173 return -ENOMEM;
2174 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02002175
Daniel Mack7b8a0432010-02-22 23:49:12 +01002176 host_iface = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
Clemens Ladischa2acad82010-09-03 10:53:11 +02002177 switch (get_iface_desc(host_iface)->bInterfaceProtocol) {
2178 case UAC_VERSION_1:
2179 default:
2180 mixer->protocol = UAC_VERSION_1;
2181 break;
2182 case UAC_VERSION_2:
2183 mixer->protocol = UAC_VERSION_2;
2184 break;
2185 }
Daniel Mack7b8a0432010-02-22 23:49:12 +01002186
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002187 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002188 (err = snd_usb_mixer_status_create(mixer)) < 0)
2189 goto _error;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002190
Daniel Mack7b1eda22010-03-11 21:13:22 +01002191 snd_usb_mixer_apply_create_quirk(mixer);
Clemens Ladisch468b8fd2009-07-13 11:39:29 +02002192
Clemens Ladisch84957a82005-04-29 16:23:13 +02002193 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002194 if (err < 0)
2195 goto _error;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002196
2197 if (list_empty(&chip->mixer_list) &&
2198 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2199 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2200
Clemens Ladisch84957a82005-04-29 16:23:13 +02002201 list_add(&mixer->list, &chip->mixer_list);
2202 return 0;
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002203
2204_error:
2205 snd_usb_mixer_free(mixer);
2206 return err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002207}
2208
2209void snd_usb_mixer_disconnect(struct list_head *p)
2210{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002211 struct usb_mixer_interface *mixer;
Daniel Mack7b1eda22010-03-11 21:13:22 +01002212
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002213 mixer = list_entry(p, struct usb_mixer_interface, list);
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002214 usb_kill_urb(mixer->urb);
2215 usb_kill_urb(mixer->rc_urb);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002216}