2 * Tascam US-16x08 ALSA driver
4 * Copyright (c) 2016 by Detlef Urban (onkel@paraair.de)
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
18 #include <linux/slab.h>
19 #include <linux/usb.h>
20 #include <linux/usb/audio-v2.h>
22 #include <sound/core.h>
23 #include <sound/control.h>
29 #include "mixer_us16x08.h"
31 /* USB control message templates */
32 static const char route_msg[] = {
35 0x03, /* input from master (0x02) or input from computer bus (0x03) */
38 0x01, /* input index (0x01/0x02 eq. left/right) or bus (0x01-0x08) */
46 0x01, /* output index (0x01-0x08) */
55 static const char mix_init_msg1[] = {
56 0x71, 0x01, 0x00, 0x00
59 static const char mix_init_msg2[] = {
60 0x62, 0x02, 0x00, 0x61, 0x02, 0x04, 0xb1, 0x01, 0x00, 0x00
63 static const char mix_msg_in[] = {
64 /* default message head, equal to all mixers */
65 0x61, 0x02, 0x04, 0x62, 0x02, 0x01,
66 0x81, /* 0x06: Controller ID */
68 0x00, /* 0x08: Value of common mixer */
73 static const char mix_msg_out[] = {
74 /* default message head, equal to all mixers */
75 0x61, 0x02, 0x02, 0x62, 0x02, 0x01,
76 0x81, /* 0x06: Controller ID */
78 0x00, /* 0x08: Value of common mixer */
83 static const char bypass_msg_out[] = {
86 0x01, /* on/off flag */
91 static const char bus_msg_out[] = {
94 0x01, /* on/off flag */
99 static const char comp_msg[] = {
100 /* default message head, equal to all mixers */
101 0x61, 0x02, 0x04, 0x62, 0x02, 0x01,
104 0xf0, /* 0x08: Threshold db (8) (e0 ... 00) (+-0dB -- -32dB) x-32 */
107 0x0a, /* 0x0b: Ratio (0a,0b,0d,0f,11,14,19,1e,23,28,32,3c,50,a0,ff) */
110 0x02, /* 0x0e: Attack (0x02 ... 0xc0) (2ms ... 200ms) */
113 0x01, /* 0x11: Release (0x01 ... 0x64) (10ms ... 1000ms) x*10 */
116 0x03, /* 0x14: gain (0 ... 20) (0dB .. 20dB) */
122 0x01, /* 0x1a: main Comp switch (0 ... 1) (off ... on)) */
127 static const char eqs_msq[] = {
128 /* default message head, equal to all mixers */
129 0x61, 0x02, 0x04, 0x62, 0x02, 0x01,
130 0x51, /* 0x06: Controller ID */
132 0x04, /* 0x08: EQ set num (0x01..0x04) (LOW, LOWMID, HIGHMID, HIGH)) */
135 0x0c, /* 0x0b: value dB (0 ... 12) (-12db .. +12db) x-6 */
138 0x0f, /* 0x0e: value freq (32-47) (1.7kHz..18kHz) */
141 0x02, /* 0x11: band width (0-6) (Q16-Q0.25) 2^x/4 (EQ xxMID only) */
144 0x01, /* 0x14: main EQ switch (0 ... 1) (off ... on)) */
149 /* compressor ratio map */
150 static const char ratio_map[] = {
151 0x0a, 0x0b, 0x0d, 0x0f, 0x11, 0x14, 0x19, 0x1e,
152 0x23, 0x28, 0x32, 0x3c, 0x50, 0xa0, 0xff
155 /* route enumeration names */
156 static const char *const route_names[] = {
157 "Master Left", "Master Right", "Output 1", "Output 2", "Output 3",
158 "Output 4", "Output 5", "Output 6", "Output 7", "Output 8",
161 static int snd_us16x08_recv_urb(struct snd_usb_audio *chip,
162 unsigned char *buf, int size)
165 mutex_lock(&chip->mutex);
166 snd_usb_ctl_msg(chip->dev,
167 usb_rcvctrlpipe(chip->dev, 0),
168 SND_US16X08_URB_METER_REQUEST,
169 SND_US16X08_URB_METER_REQUESTTYPE, 0, 0, buf, size);
170 mutex_unlock(&chip->mutex);
174 /* wrapper function to send prepared URB buffer to usb device. Return an error
175 * code if something went wrong
177 static int snd_us16x08_send_urb(struct snd_usb_audio *chip, char *buf, int size)
179 return snd_usb_ctl_msg(chip->dev, usb_sndctrlpipe(chip->dev, 0),
180 SND_US16X08_URB_REQUEST, SND_US16X08_URB_REQUESTTYPE,
184 static int snd_us16x08_route_info(struct snd_kcontrol *kcontrol,
185 struct snd_ctl_elem_info *uinfo)
187 return snd_ctl_enum_info(uinfo, 1, 10, route_names);
190 static int snd_us16x08_route_get(struct snd_kcontrol *kcontrol,
191 struct snd_ctl_elem_value *ucontrol)
193 struct usb_mixer_elem_info *elem = kcontrol->private_data;
194 int index = ucontrol->id.index;
196 /* route has no bias */
197 ucontrol->value.enumerated.item[0] = elem->cache_val[index];
202 static int snd_us16x08_route_put(struct snd_kcontrol *kcontrol,
203 struct snd_ctl_elem_value *ucontrol)
205 struct usb_mixer_elem_info *elem = kcontrol->private_data;
206 struct snd_usb_audio *chip = elem->head.mixer->chip;
207 int index = ucontrol->id.index;
208 char buf[sizeof(route_msg)];
209 int val, val_org, err;
211 /* get the new value (no bias for routes) */
212 val = ucontrol->value.enumerated.item[0];
215 if (val < 0 || val > 9)
218 /* prepare the message buffer from template */
219 memcpy(buf, route_msg, sizeof(route_msg));
222 /* input comes from a master channel */
226 /* input comes from a computer channel */
231 /* place new route selection in URB message */
232 buf[5] = (unsigned char) (val_org & 0x0f) + 1;
233 /* place route selector in URB message */
236 err = snd_us16x08_send_urb(chip, buf, sizeof(route_msg));
239 elem->cached |= 1 << index;
240 elem->cache_val[index] = val;
242 usb_audio_dbg(chip, "Failed to set routing, err:%d\n", err);
245 return err > 0 ? 1 : 0;
248 static int snd_us16x08_master_info(struct snd_kcontrol *kcontrol,
249 struct snd_ctl_elem_info *uinfo)
252 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
253 uinfo->value.integer.max = SND_US16X08_KCMAX(kcontrol);
254 uinfo->value.integer.min = SND_US16X08_KCMIN(kcontrol);
255 uinfo->value.integer.step = SND_US16X08_KCSTEP(kcontrol);
259 static int snd_us16x08_master_get(struct snd_kcontrol *kcontrol,
260 struct snd_ctl_elem_value *ucontrol)
262 struct usb_mixer_elem_info *elem = kcontrol->private_data;
263 int index = ucontrol->id.index;
265 ucontrol->value.integer.value[0] = elem->cache_val[index];
270 static int snd_us16x08_master_put(struct snd_kcontrol *kcontrol,
271 struct snd_ctl_elem_value *ucontrol)
273 struct usb_mixer_elem_info *elem = kcontrol->private_data;
274 struct snd_usb_audio *chip = elem->head.mixer->chip;
275 char buf[sizeof(mix_msg_out)];
277 int index = ucontrol->id.index;
279 /* new control value incl. bias*/
280 val = ucontrol->value.integer.value[0];
283 if (val < SND_US16X08_KCMIN(kcontrol)
284 || val > SND_US16X08_KCMAX(kcontrol))
287 /* prepare the message buffer from template */
288 memcpy(buf, mix_msg_out, sizeof(mix_msg_out));
290 buf[8] = val - SND_US16X08_KCBIAS(kcontrol);
291 buf[6] = elem->head.id;
293 /* place channel selector in URB message */
295 err = snd_us16x08_send_urb(chip, buf, sizeof(mix_msg_out));
298 elem->cached |= 1 << index;
299 elem->cache_val[index] = val;
301 usb_audio_dbg(chip, "Failed to set master, err:%d\n", err);
304 return err > 0 ? 1 : 0;
307 static int snd_us16x08_bus_put(struct snd_kcontrol *kcontrol,
308 struct snd_ctl_elem_value *ucontrol)
310 struct usb_mixer_elem_info *elem = kcontrol->private_data;
311 struct snd_usb_audio *chip = elem->head.mixer->chip;
312 char buf[sizeof(mix_msg_out)];
315 val = ucontrol->value.integer.value[0];
317 /* prepare the message buffer from template */
318 switch (elem->head.id) {
319 case SND_US16X08_ID_BYPASS:
320 memcpy(buf, bypass_msg_out, sizeof(bypass_msg_out));
322 err = snd_us16x08_send_urb(chip, buf, sizeof(bypass_msg_out));
324 case SND_US16X08_ID_BUSS_OUT:
325 memcpy(buf, bus_msg_out, sizeof(bus_msg_out));
327 err = snd_us16x08_send_urb(chip, buf, sizeof(bus_msg_out));
329 case SND_US16X08_ID_MUTE:
330 memcpy(buf, mix_msg_out, sizeof(mix_msg_out));
332 buf[6] = elem->head.id;
334 err = snd_us16x08_send_urb(chip, buf, sizeof(mix_msg_out));
340 elem->cache_val[0] = val;
342 usb_audio_dbg(chip, "Failed to set buss param, err:%d\n", err);
345 return err > 0 ? 1 : 0;
348 static int snd_us16x08_bus_get(struct snd_kcontrol *kcontrol,
349 struct snd_ctl_elem_value *ucontrol)
351 struct usb_mixer_elem_info *elem = kcontrol->private_data;
353 switch (elem->head.id) {
354 case SND_US16X08_ID_BUSS_OUT:
355 ucontrol->value.integer.value[0] = elem->cache_val[0];
357 case SND_US16X08_ID_BYPASS:
358 ucontrol->value.integer.value[0] = elem->cache_val[0];
360 case SND_US16X08_ID_MUTE:
361 ucontrol->value.integer.value[0] = elem->cache_val[0];
368 /* gets a current mixer value from common store */
369 static int snd_us16x08_channel_get(struct snd_kcontrol *kcontrol,
370 struct snd_ctl_elem_value *ucontrol)
372 struct usb_mixer_elem_info *elem = kcontrol->private_data;
373 int index = ucontrol->id.index;
375 ucontrol->value.integer.value[0] = elem->cache_val[index];
380 static int snd_us16x08_channel_put(struct snd_kcontrol *kcontrol,
381 struct snd_ctl_elem_value *ucontrol)
383 struct usb_mixer_elem_info *elem = kcontrol->private_data;
384 struct snd_usb_audio *chip = elem->head.mixer->chip;
385 char buf[sizeof(mix_msg_in)];
387 int index = ucontrol->id.index;
389 val = ucontrol->value.integer.value[0];
392 if (val < SND_US16X08_KCMIN(kcontrol)
393 || val > SND_US16X08_KCMAX(kcontrol))
396 /* prepare URB message from template */
397 memcpy(buf, mix_msg_in, sizeof(mix_msg_in));
399 /* add the bias to the new value */
400 buf[8] = val - SND_US16X08_KCBIAS(kcontrol);
401 buf[6] = elem->head.id;
404 err = snd_us16x08_send_urb(chip, buf, sizeof(mix_msg_in));
407 elem->cached |= 1 << index;
408 elem->cache_val[index] = val;
410 usb_audio_dbg(chip, "Failed to set channel, err:%d\n", err);
413 return err > 0 ? 1 : 0;
416 static int snd_us16x08_mix_info(struct snd_kcontrol *kcontrol,
417 struct snd_ctl_elem_info *uinfo)
420 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
421 uinfo->value.integer.max = SND_US16X08_KCMAX(kcontrol);
422 uinfo->value.integer.min = SND_US16X08_KCMIN(kcontrol);
423 uinfo->value.integer.step = SND_US16X08_KCSTEP(kcontrol);
427 static int snd_us16x08_comp_get(struct snd_kcontrol *kcontrol,
428 struct snd_ctl_elem_value *ucontrol)
430 struct usb_mixer_elem_info *elem = kcontrol->private_data;
431 struct snd_us16x08_comp_store *store = elem->private_data;
432 int index = ucontrol->id.index;
433 int val_idx = COMP_STORE_IDX(elem->head.id);
435 ucontrol->value.integer.value[0] = store->val[val_idx][index];
440 static int snd_us16x08_comp_put(struct snd_kcontrol *kcontrol,
441 struct snd_ctl_elem_value *ucontrol)
443 struct usb_mixer_elem_info *elem = kcontrol->private_data;
444 struct snd_usb_audio *chip = elem->head.mixer->chip;
445 struct snd_us16x08_comp_store *store = elem->private_data;
446 int index = ucontrol->id.index;
447 char buf[sizeof(comp_msg)];
451 val = ucontrol->value.integer.value[0];
454 if (val < SND_US16X08_KCMIN(kcontrol)
455 || val > SND_US16X08_KCMAX(kcontrol))
458 /* new control value incl. bias*/
459 val_idx = elem->head.id - SND_US16X08_ID_COMP_BASE;
461 store->val[val_idx][index] = ucontrol->value.integer.value[0];
463 /* prepare compressor URB message from template */
464 memcpy(buf, comp_msg, sizeof(comp_msg));
466 /* place comp values in message buffer watch bias! */
468 COMP_STORE_IDX(SND_US16X08_ID_COMP_THRESHOLD)][index]
469 - SND_US16X08_COMP_THRESHOLD_BIAS;
470 buf[11] = ratio_map[store->val[
471 COMP_STORE_IDX(SND_US16X08_ID_COMP_RATIO)][index]];
472 buf[14] = store->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_ATTACK)][index]
473 + SND_US16X08_COMP_ATTACK_BIAS;
474 buf[17] = store->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_RELEASE)][index]
475 + SND_US16X08_COMP_RELEASE_BIAS;
476 buf[20] = store->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_GAIN)][index];
477 buf[26] = store->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_SWITCH)][index];
479 /* place channel selector in message buffer */
482 err = snd_us16x08_send_urb(chip, buf, sizeof(comp_msg));
485 elem->cached |= 1 << index;
486 elem->cache_val[index] = val;
488 usb_audio_dbg(chip, "Failed to set compressor, err:%d\n", err);
494 static int snd_us16x08_eqswitch_get(struct snd_kcontrol *kcontrol,
495 struct snd_ctl_elem_value *ucontrol)
498 struct usb_mixer_elem_info *elem = kcontrol->private_data;
499 struct snd_us16x08_eq_store *store = elem->private_data;
500 int index = ucontrol->id.index;
502 /* get low switch from cache is enough, cause all bands are together */
503 val = store->val[EQ_STORE_BAND_IDX(elem->head.id)]
504 [EQ_STORE_PARAM_IDX(elem->head.id)][index];
505 ucontrol->value.integer.value[0] = val;
510 static int snd_us16x08_eqswitch_put(struct snd_kcontrol *kcontrol,
511 struct snd_ctl_elem_value *ucontrol)
513 struct usb_mixer_elem_info *elem = kcontrol->private_data;
514 struct snd_usb_audio *chip = elem->head.mixer->chip;
515 struct snd_us16x08_eq_store *store = elem->private_data;
516 int index = ucontrol->id.index;
517 char buf[sizeof(eqs_msq)];
521 /* new control value incl. bias*/
522 val = ucontrol->value.integer.value[0] + SND_US16X08_KCBIAS(kcontrol);
524 /* prepare URB message from EQ template */
525 memcpy(buf, eqs_msq, sizeof(eqs_msq));
527 /* place channel index in URB message */
529 for (b_idx = 0; b_idx < SND_US16X08_ID_EQ_BAND_COUNT; b_idx++) {
530 /* all four EQ bands have to be enabled/disabled in once */
532 buf[17] = store->val[b_idx][2][index];
533 buf[14] = store->val[b_idx][1][index];
534 buf[11] = store->val[b_idx][0][index];
536 err = snd_us16x08_send_urb(chip, buf, sizeof(eqs_msq));
539 store->val[b_idx][3][index] = val;
544 elem->cached |= 1 << index;
545 elem->cache_val[index] = val;
547 usb_audio_dbg(chip, "Failed to set eq switch, err:%d\n", err);
553 static int snd_us16x08_eq_get(struct snd_kcontrol *kcontrol,
554 struct snd_ctl_elem_value *ucontrol)
557 struct usb_mixer_elem_info *elem = kcontrol->private_data;
558 struct snd_us16x08_eq_store *store = elem->private_data;
559 int index = ucontrol->id.index;
560 int b_idx = EQ_STORE_BAND_IDX(elem->head.id) - 1;
561 int p_idx = EQ_STORE_PARAM_IDX(elem->head.id);
563 val = store->val[b_idx][p_idx][index];
565 ucontrol->value.integer.value[0] = val;
570 static int snd_us16x08_eq_put(struct snd_kcontrol *kcontrol,
571 struct snd_ctl_elem_value *ucontrol)
573 struct usb_mixer_elem_info *elem = kcontrol->private_data;
574 struct snd_usb_audio *chip = elem->head.mixer->chip;
575 struct snd_us16x08_eq_store *store = elem->private_data;
576 int index = ucontrol->id.index;
577 char buf[sizeof(eqs_msq)];
579 int b_idx = EQ_STORE_BAND_IDX(elem->head.id) - 1;
580 int p_idx = EQ_STORE_PARAM_IDX(elem->head.id);
582 val = ucontrol->value.integer.value[0];
585 if (val < SND_US16X08_KCMIN(kcontrol)
586 || val > SND_US16X08_KCMAX(kcontrol))
589 /* copy URB buffer from EQ template */
590 memcpy(buf, eqs_msq, sizeof(eqs_msq));
592 store->val[b_idx][p_idx][index] = val;
593 buf[20] = store->val[b_idx][3][index];
594 buf[17] = store->val[b_idx][2][index];
595 buf[14] = store->val[b_idx][1][index];
596 buf[11] = store->val[b_idx][0][index];
598 /* place channel index in URB buffer */
601 /* place EQ band in URB buffer */
604 err = snd_us16x08_send_urb(chip, buf, sizeof(eqs_msq));
607 /* store new value in EQ band cache */
608 elem->cached |= 1 << index;
609 elem->cache_val[index] = val;
611 usb_audio_dbg(chip, "Failed to set eq param, err:%d\n", err);
617 static int snd_us16x08_meter_info(struct snd_kcontrol *kcontrol,
618 struct snd_ctl_elem_info *uinfo)
621 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
622 uinfo->value.integer.max = 0x7FFF;
623 uinfo->value.integer.min = 0;
628 /* calculate compressor index for reduction level request */
629 static int snd_get_meter_comp_index(struct snd_us16x08_meter_store *store)
633 /* any channel active */
634 if (store->comp_active_index) {
635 /* check for stereo link */
636 if (store->comp_active_index & 0x20) {
637 /* reset comp_index to left channel*/
638 if (store->comp_index -
639 store->comp_active_index > 1)
641 store->comp_active_index;
643 ret = store->comp_index++ & 0x1F;
646 ret = store->comp_active_index;
649 /* skip channels with no compressor active */
650 while (!store->comp_store->val[
651 COMP_STORE_IDX(SND_US16X08_ID_COMP_SWITCH)]
652 [store->comp_index - 1]
653 && store->comp_index <= SND_US16X08_MAX_CHANNELS) {
656 ret = store->comp_index++;
657 if (store->comp_index > SND_US16X08_MAX_CHANNELS)
658 store->comp_index = 1;
663 /* retrieve the meter level values from URB message */
664 static void get_meter_levels_from_urb(int s,
665 struct snd_us16x08_meter_store *store,
668 int val = MUC2(meter_urb, s) + (MUC3(meter_urb, s) << 8);
670 if (MUA0(meter_urb, s) == 0x61 && MUA1(meter_urb, s) == 0x02 &&
671 MUA2(meter_urb, s) == 0x04 && MUB0(meter_urb, s) == 0x62) {
672 if (MUC0(meter_urb, s) == 0x72)
673 store->meter_level[MUB2(meter_urb, s) - 1] = val;
674 if (MUC0(meter_urb, s) == 0xb2)
675 store->comp_level[MUB2(meter_urb, s) - 1] = val;
677 if (MUA0(meter_urb, s) == 0x61 && MUA1(meter_urb, s) == 0x02 &&
678 MUA2(meter_urb, s) == 0x02 && MUB0(meter_urb, s) == 0x62)
679 store->master_level[MUB2(meter_urb, s) - 1] = val;
682 /* Function to retrieve current meter values from the device.
684 * The device needs to be polled for meter values with an initial
685 * requests. It will return with a sequence of different meter value
686 * packages. The first request (case 0:) initiate this meter response sequence.
687 * After the third response, an additional request can be placed,
688 * to retrieve compressor reduction level value for given channel. This round
689 * trip channel selector will skip all inactive compressors.
690 * A mixer can interrupt this round-trip by selecting one ore two (stereo-link)
693 static int snd_us16x08_meter_get(struct snd_kcontrol *kcontrol,
694 struct snd_ctl_elem_value *ucontrol)
697 struct usb_mixer_elem_info *elem = kcontrol->private_data;
698 struct snd_usb_audio *chip = elem->head.mixer->chip;
699 struct snd_us16x08_meter_store *store = elem->private_data;
701 char tmp[sizeof(mix_init_msg2)] = {0};
703 switch (kcontrol->private_value) {
705 snd_us16x08_send_urb(chip, (char *)mix_init_msg1,
706 sizeof(mix_init_msg1));
707 snd_us16x08_recv_urb(chip, meter_urb,
709 kcontrol->private_value++;
712 snd_us16x08_recv_urb(chip, meter_urb,
714 kcontrol->private_value++;
717 snd_us16x08_recv_urb(chip, meter_urb,
719 kcontrol->private_value++;
722 memcpy(tmp, mix_init_msg2, sizeof(mix_init_msg2));
723 tmp[2] = snd_get_meter_comp_index(store);
724 snd_us16x08_send_urb(chip, tmp, sizeof(mix_init_msg2));
725 snd_us16x08_recv_urb(chip, meter_urb,
727 kcontrol->private_value = 0;
731 for (set = 0; set < 6; set++)
732 get_meter_levels_from_urb(set, store, meter_urb);
734 for (i = 0; i < SND_US16X08_MAX_CHANNELS; i++) {
735 ucontrol->value.integer.value[i] =
736 store ? store->meter_level[i] : 0;
739 ucontrol->value.integer.value[i++] = store ? store->master_level[0] : 0;
740 ucontrol->value.integer.value[i++] = store ? store->master_level[1] : 0;
742 for (i = 2; i < SND_US16X08_MAX_CHANNELS + 2; i++)
743 ucontrol->value.integer.value[i + SND_US16X08_MAX_CHANNELS] =
744 store ? store->comp_level[i - 2] : 0;
749 static int snd_us16x08_meter_put(struct snd_kcontrol *kcontrol,
750 struct snd_ctl_elem_value *ucontrol)
752 struct usb_mixer_elem_info *elem = kcontrol->private_data;
753 struct snd_us16x08_meter_store *store = elem->private_data;
756 val = ucontrol->value.integer.value[0];
759 if (val < 0 || val >= SND_US16X08_MAX_CHANNELS)
762 store->comp_active_index = val;
763 store->comp_index = val;
768 static struct snd_kcontrol_new snd_us16x08_ch_boolean_ctl = {
769 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
770 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
772 .info = snd_us16x08_switch_info,
773 .get = snd_us16x08_channel_get,
774 .put = snd_us16x08_channel_put,
775 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 1)
778 static struct snd_kcontrol_new snd_us16x08_ch_int_ctl = {
779 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
780 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
782 .info = snd_us16x08_mix_info,
783 .get = snd_us16x08_channel_get,
784 .put = snd_us16x08_channel_put,
785 .private_value = SND_US16X08_KCSET(SND_US16X08_FADER_BIAS, 1, 0, 133)
788 static struct snd_kcontrol_new snd_us16x08_pan_int_ctl = {
789 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
790 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
792 .info = snd_us16x08_mix_info,
793 .get = snd_us16x08_channel_get,
794 .put = snd_us16x08_channel_put,
795 .private_value = SND_US16X08_KCSET(SND_US16X08_FADER_BIAS, 1, 0, 255)
798 static struct snd_kcontrol_new snd_us16x08_master_ctl = {
799 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
800 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
802 .info = snd_us16x08_master_info,
803 .get = snd_us16x08_master_get,
804 .put = snd_us16x08_master_put,
805 .private_value = SND_US16X08_KCSET(SND_US16X08_FADER_BIAS, 1, 0, 133)
808 static struct snd_kcontrol_new snd_us16x08_route_ctl = {
809 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
810 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
812 .info = snd_us16x08_route_info,
813 .get = snd_us16x08_route_get,
814 .put = snd_us16x08_route_put,
815 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 9)
818 static struct snd_kcontrol_new snd_us16x08_bus_ctl = {
819 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
820 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
822 .info = snd_us16x08_switch_info,
823 .get = snd_us16x08_bus_get,
824 .put = snd_us16x08_bus_put,
825 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 1)
828 static struct snd_kcontrol_new snd_us16x08_compswitch_ctl = {
829 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
830 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
832 .info = snd_us16x08_switch_info,
833 .get = snd_us16x08_comp_get,
834 .put = snd_us16x08_comp_put,
835 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 1)
838 static struct snd_kcontrol_new snd_us16x08_comp_threshold_ctl = {
839 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
840 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
842 .info = snd_us16x08_mix_info,
843 .get = snd_us16x08_comp_get,
844 .put = snd_us16x08_comp_put,
845 .private_value = SND_US16X08_KCSET(SND_US16X08_COMP_THRESHOLD_BIAS, 1,
849 static struct snd_kcontrol_new snd_us16x08_comp_ratio_ctl = {
850 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
851 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
853 .info = snd_us16x08_mix_info,
854 .get = snd_us16x08_comp_get,
855 .put = snd_us16x08_comp_put,
856 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0,
857 sizeof(ratio_map) - 1), /*max*/
860 static struct snd_kcontrol_new snd_us16x08_comp_gain_ctl = {
861 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
862 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
864 .info = snd_us16x08_mix_info,
865 .get = snd_us16x08_comp_get,
866 .put = snd_us16x08_comp_put,
867 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 0x14)
870 static struct snd_kcontrol_new snd_us16x08_comp_attack_ctl = {
871 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
872 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
874 .info = snd_us16x08_mix_info,
875 .get = snd_us16x08_comp_get,
876 .put = snd_us16x08_comp_put,
878 SND_US16X08_KCSET(SND_US16X08_COMP_ATTACK_BIAS, 1, 0, 0xc6),
881 static struct snd_kcontrol_new snd_us16x08_comp_release_ctl = {
882 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
883 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
885 .info = snd_us16x08_mix_info,
886 .get = snd_us16x08_comp_get,
887 .put = snd_us16x08_comp_put,
889 SND_US16X08_KCSET(SND_US16X08_COMP_RELEASE_BIAS, 1, 0, 0x63),
892 static struct snd_kcontrol_new snd_us16x08_eq_gain_ctl = {
893 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
894 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
896 .info = snd_us16x08_mix_info,
897 .get = snd_us16x08_eq_get,
898 .put = snd_us16x08_eq_put,
899 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 24),
902 static struct snd_kcontrol_new snd_us16x08_eq_low_freq_ctl = {
903 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
904 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
906 .info = snd_us16x08_mix_info,
907 .get = snd_us16x08_eq_get,
908 .put = snd_us16x08_eq_put,
909 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 0x1F),
912 static struct snd_kcontrol_new snd_us16x08_eq_mid_freq_ctl = {
913 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
914 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
916 .info = snd_us16x08_mix_info,
917 .get = snd_us16x08_eq_get,
918 .put = snd_us16x08_eq_put,
919 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 0x3F)
922 static struct snd_kcontrol_new snd_us16x08_eq_mid_width_ctl = {
923 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
924 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
926 .info = snd_us16x08_mix_info,
927 .get = snd_us16x08_eq_get,
928 .put = snd_us16x08_eq_put,
929 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 0x06)
932 static struct snd_kcontrol_new snd_us16x08_eq_high_freq_ctl = {
933 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
934 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
936 .info = snd_us16x08_mix_info,
937 .get = snd_us16x08_eq_get,
938 .put = snd_us16x08_eq_put,
940 SND_US16X08_KCSET(SND_US16X08_EQ_HIGHFREQ_BIAS, 1, 0, 0x1F)
943 static struct snd_kcontrol_new snd_us16x08_eq_switch_ctl = {
944 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
945 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
947 .info = snd_us16x08_switch_info,
948 .get = snd_us16x08_eqswitch_get,
949 .put = snd_us16x08_eqswitch_put,
950 .private_value = SND_US16X08_KCSET(SND_US16X08_NO_BIAS, 1, 0, 1)
953 static struct snd_kcontrol_new snd_us16x08_meter_ctl = {
954 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
955 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
957 .info = snd_us16x08_meter_info,
958 .get = snd_us16x08_meter_get,
959 .put = snd_us16x08_meter_put
962 /* control store preparation */
964 /* setup compressor store and assign default value */
965 static struct snd_us16x08_comp_store *snd_us16x08_create_comp_store(void)
968 struct snd_us16x08_comp_store *tmp;
970 tmp = kmalloc(sizeof(*tmp), GFP_KERNEL);
974 for (i = 0; i < SND_US16X08_MAX_CHANNELS; i++) {
975 tmp->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_THRESHOLD)][i]
977 tmp->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_RATIO)][i] = 0x00;
978 tmp->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_GAIN)][i] = 0x00;
979 tmp->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_SWITCH)][i] = 0x00;
980 tmp->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_ATTACK)][i] = 0x00;
981 tmp->val[COMP_STORE_IDX(SND_US16X08_ID_COMP_RELEASE)][i] = 0x00;
986 /* setup EQ store and assign default values */
987 static struct snd_us16x08_eq_store *snd_us16x08_create_eq_store(void)
990 struct snd_us16x08_eq_store *tmp;
992 tmp = kmalloc(sizeof(*tmp), GFP_KERNEL);
996 for (i = 0; i < SND_US16X08_MAX_CHANNELS; i++) {
997 for (b_idx = 0; b_idx < SND_US16X08_ID_EQ_BAND_COUNT; b_idx++) {
998 tmp->val[b_idx][0][i] = 0x0c;
999 tmp->val[b_idx][3][i] = 0x00;
1001 case 0: /* EQ Low */
1002 tmp->val[b_idx][1][i] = 0x05;
1003 tmp->val[b_idx][2][i] = 0xff;
1005 case 1: /* EQ Mid low */
1006 tmp->val[b_idx][1][i] = 0x0e;
1007 tmp->val[b_idx][2][i] = 0x02;
1009 case 2: /* EQ Mid High */
1010 tmp->val[b_idx][1][i] = 0x1b;
1011 tmp->val[b_idx][2][i] = 0x02;
1013 case 3: /* EQ High */
1014 tmp->val[b_idx][1][i] = 0x2f
1015 - SND_US16X08_EQ_HIGHFREQ_BIAS;
1016 tmp->val[b_idx][2][i] = 0xff;
1024 static struct snd_us16x08_meter_store *snd_us16x08_create_meter_store(void)
1026 struct snd_us16x08_meter_store *tmp;
1028 tmp = kzalloc(sizeof(*tmp), GFP_KERNEL);
1031 tmp->comp_index = 1;
1032 tmp->comp_active_index = 0;
1036 /* release elem->private_free as well; called only once for each *_store */
1037 static void elem_private_free(struct snd_kcontrol *kctl)
1039 struct usb_mixer_elem_info *elem = kctl->private_data;
1042 kfree(elem->private_data);
1044 kctl->private_data = NULL;
1047 static int add_new_ctl(struct usb_mixer_interface *mixer,
1048 const struct snd_kcontrol_new *ncontrol,
1049 int index, int val_type, int channels,
1050 const char *name, void *opt,
1051 bool do_private_free,
1052 struct usb_mixer_elem_info **elem_ret)
1054 struct snd_kcontrol *kctl;
1055 struct usb_mixer_elem_info *elem;
1058 usb_audio_dbg(mixer->chip, "us16x08 add mixer %s\n", name);
1060 elem = kzalloc(sizeof(*elem), GFP_KERNEL);
1064 elem->head.mixer = mixer;
1065 elem->head.resume = NULL;
1068 elem->head.id = index;
1069 elem->val_type = val_type;
1070 elem->channels = channels;
1071 elem->private_data = opt;
1073 kctl = snd_ctl_new1(ncontrol, elem);
1079 if (do_private_free)
1080 kctl->private_free = elem_private_free;
1082 kctl->private_free = snd_usb_mixer_elem_free;
1084 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1086 err = snd_usb_mixer_add_control(&elem->head, kctl);
1096 /* table of EQ controls */
1097 static const struct snd_us16x08_control_params eq_controls[] = {
1099 .kcontrol_new = &snd_us16x08_eq_switch_ctl,
1100 .control_id = SND_US16X08_ID_EQENABLE,
1101 .type = USB_MIXER_BOOLEAN,
1103 .name = "EQ Switch",
1106 .kcontrol_new = &snd_us16x08_eq_gain_ctl,
1107 .control_id = SND_US16X08_ID_EQLOWLEVEL,
1108 .type = USB_MIXER_U8,
1110 .name = "EQ Low Volume",
1113 .kcontrol_new = &snd_us16x08_eq_low_freq_ctl,
1114 .control_id = SND_US16X08_ID_EQLOWFREQ,
1115 .type = USB_MIXER_U8,
1117 .name = "EQ Low Frequence",
1119 { /* EQ mid low gain */
1120 .kcontrol_new = &snd_us16x08_eq_gain_ctl,
1121 .control_id = SND_US16X08_ID_EQLOWMIDLEVEL,
1122 .type = USB_MIXER_U8,
1124 .name = "EQ MidLow Volume",
1126 { /* EQ mid low freq */
1127 .kcontrol_new = &snd_us16x08_eq_mid_freq_ctl,
1128 .control_id = SND_US16X08_ID_EQLOWMIDFREQ,
1129 .type = USB_MIXER_U8,
1131 .name = "EQ MidLow Frequence",
1133 { /* EQ mid low Q */
1134 .kcontrol_new = &snd_us16x08_eq_mid_width_ctl,
1135 .control_id = SND_US16X08_ID_EQLOWMIDWIDTH,
1136 .type = USB_MIXER_U8,
1138 .name = "EQ MidQLow Q",
1140 { /* EQ mid high gain */
1141 .kcontrol_new = &snd_us16x08_eq_gain_ctl,
1142 .control_id = SND_US16X08_ID_EQHIGHMIDLEVEL,
1143 .type = USB_MIXER_U8,
1145 .name = "EQ MidHigh Volume",
1147 { /* EQ mid high freq */
1148 .kcontrol_new = &snd_us16x08_eq_mid_freq_ctl,
1149 .control_id = SND_US16X08_ID_EQHIGHMIDFREQ,
1150 .type = USB_MIXER_U8,
1152 .name = "EQ MidHigh Frequence",
1154 { /* EQ mid high Q */
1155 .kcontrol_new = &snd_us16x08_eq_mid_width_ctl,
1156 .control_id = SND_US16X08_ID_EQHIGHMIDWIDTH,
1157 .type = USB_MIXER_U8,
1159 .name = "EQ MidHigh Q",
1161 { /* EQ high gain */
1162 .kcontrol_new = &snd_us16x08_eq_gain_ctl,
1163 .control_id = SND_US16X08_ID_EQHIGHLEVEL,
1164 .type = USB_MIXER_U8,
1166 .name = "EQ High Volume",
1169 .kcontrol_new = &snd_us16x08_eq_high_freq_ctl,
1170 .control_id = SND_US16X08_ID_EQHIGHFREQ,
1171 .type = USB_MIXER_U8,
1173 .name = "EQ High Frequence",
1177 /* table of compressor controls */
1178 static const struct snd_us16x08_control_params comp_controls[] = {
1180 .kcontrol_new = &snd_us16x08_compswitch_ctl,
1181 .control_id = SND_US16X08_ID_COMP_SWITCH,
1182 .type = USB_MIXER_BOOLEAN,
1184 .name = "Compressor Switch",
1186 { /* Comp threshold */
1187 .kcontrol_new = &snd_us16x08_comp_threshold_ctl,
1188 .control_id = SND_US16X08_ID_COMP_THRESHOLD,
1189 .type = USB_MIXER_U8,
1191 .name = "Compressor Threshold Volume",
1194 .kcontrol_new = &snd_us16x08_comp_ratio_ctl,
1195 .control_id = SND_US16X08_ID_COMP_RATIO,
1196 .type = USB_MIXER_U8,
1198 .name = "Compressor Ratio",
1201 .kcontrol_new = &snd_us16x08_comp_attack_ctl,
1202 .control_id = SND_US16X08_ID_COMP_ATTACK,
1203 .type = USB_MIXER_U8,
1205 .name = "Compressor Attack",
1207 { /* Comp release */
1208 .kcontrol_new = &snd_us16x08_comp_release_ctl,
1209 .control_id = SND_US16X08_ID_COMP_RELEASE,
1210 .type = USB_MIXER_U8,
1212 .name = "Compressor Release",
1215 .kcontrol_new = &snd_us16x08_comp_gain_ctl,
1216 .control_id = SND_US16X08_ID_COMP_GAIN,
1217 .type = USB_MIXER_U8,
1219 .name = "Compressor Volume",
1223 /* table of channel controls */
1224 static const struct snd_us16x08_control_params channel_controls[] = {
1226 .kcontrol_new = &snd_us16x08_ch_boolean_ctl,
1227 .control_id = SND_US16X08_ID_PHASE,
1228 .type = USB_MIXER_BOOLEAN,
1230 .name = "Phase Switch",
1234 .kcontrol_new = &snd_us16x08_ch_int_ctl,
1235 .control_id = SND_US16X08_ID_FADER,
1236 .type = USB_MIXER_U8,
1238 .name = "Line Volume",
1242 .kcontrol_new = &snd_us16x08_ch_boolean_ctl,
1243 .control_id = SND_US16X08_ID_MUTE,
1244 .type = USB_MIXER_BOOLEAN,
1246 .name = "Mute Switch",
1250 .kcontrol_new = &snd_us16x08_pan_int_ctl,
1251 .control_id = SND_US16X08_ID_PAN,
1252 .type = USB_MIXER_U16,
1254 .name = "Pan Left-Right Volume",
1259 /* table of master controls */
1260 static const struct snd_us16x08_control_params master_controls[] = {
1262 .kcontrol_new = &snd_us16x08_master_ctl,
1263 .control_id = SND_US16X08_ID_FADER,
1264 .type = USB_MIXER_U8,
1266 .name = "Master Volume",
1270 .kcontrol_new = &snd_us16x08_bus_ctl,
1271 .control_id = SND_US16X08_ID_BYPASS,
1272 .type = USB_MIXER_BOOLEAN,
1274 .name = "DSP Bypass Switch",
1278 .kcontrol_new = &snd_us16x08_bus_ctl,
1279 .control_id = SND_US16X08_ID_BUSS_OUT,
1280 .type = USB_MIXER_BOOLEAN,
1282 .name = "Buss Out Switch",
1286 .kcontrol_new = &snd_us16x08_bus_ctl,
1287 .control_id = SND_US16X08_ID_MUTE,
1288 .type = USB_MIXER_BOOLEAN,
1290 .name = "Master Mute Switch",
1296 int snd_us16x08_controls_create(struct usb_mixer_interface *mixer)
1300 struct usb_mixer_elem_info *elem;
1301 struct snd_us16x08_comp_store *comp_store;
1302 struct snd_us16x08_meter_store *meter_store;
1303 struct snd_us16x08_eq_store *eq_store;
1305 /* just check for non-MIDI interface */
1306 if (mixer->hostif->desc.bInterfaceNumber == 3) {
1308 /* add routing control */
1309 err = add_new_ctl(mixer, &snd_us16x08_route_ctl,
1310 SND_US16X08_ID_ROUTE, USB_MIXER_U8, 8, "Line Out Route",
1311 NULL, false, &elem);
1313 usb_audio_dbg(mixer->chip,
1314 "Failed to create route control, err:%d\n",
1318 for (i = 0; i < 8; i++)
1319 elem->cache_val[i] = i < 2 ? i : i + 2;
1320 elem->cached = 0xff;
1322 /* create compressor mixer elements */
1323 comp_store = snd_us16x08_create_comp_store();
1327 /* add master controls */
1328 for (i = 0; i < ARRAY_SIZE(master_controls); i++) {
1330 err = add_new_ctl(mixer,
1331 master_controls[i].kcontrol_new,
1332 master_controls[i].control_id,
1333 master_controls[i].type,
1334 master_controls[i].num_channels,
1335 master_controls[i].name,
1337 i == 0, /* release comp_store only once */
1341 elem->cache_val[0] = master_controls[i].default_val;
1345 /* add channel controls */
1346 for (i = 0; i < ARRAY_SIZE(channel_controls); i++) {
1348 err = add_new_ctl(mixer,
1349 channel_controls[i].kcontrol_new,
1350 channel_controls[i].control_id,
1351 channel_controls[i].type,
1352 channel_controls[i].num_channels,
1353 channel_controls[i].name,
1358 for (j = 0; j < SND_US16X08_MAX_CHANNELS; j++) {
1359 elem->cache_val[j] =
1360 channel_controls[i].default_val;
1362 elem->cached = 0xffff;
1365 /* create eq store */
1366 eq_store = snd_us16x08_create_eq_store();
1370 /* add EQ controls */
1371 for (i = 0; i < ARRAY_SIZE(eq_controls); i++) {
1373 err = add_new_ctl(mixer,
1374 eq_controls[i].kcontrol_new,
1375 eq_controls[i].control_id,
1376 eq_controls[i].type,
1377 eq_controls[i].num_channels,
1378 eq_controls[i].name,
1380 i == 0, /* release eq_store only once */
1386 /* add compressor controls */
1387 for (i = 0; i < ARRAY_SIZE(comp_controls); i++) {
1389 err = add_new_ctl(mixer,
1390 comp_controls[i].kcontrol_new,
1391 comp_controls[i].control_id,
1392 comp_controls[i].type,
1393 comp_controls[i].num_channels,
1394 comp_controls[i].name,
1401 /* create meters store */
1402 meter_store = snd_us16x08_create_meter_store();
1406 /* meter function 'get' must access to compressor store
1407 * so place a reference here
1409 meter_store->comp_store = comp_store;
1410 err = add_new_ctl(mixer, &snd_us16x08_meter_ctl,
1411 SND_US16X08_ID_METER, USB_MIXER_U16, 0, "Level Meter",
1412 meter_store, true, NULL);