2 * Copyright (c) by Jaroslav Kysela <perex@suse.cz>
3 * Universal routines for AK4531 codec
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <sound/driver.h>
23 #include <linux/delay.h>
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <linux/mutex.h>
28 #include <sound/core.h>
29 #include <sound/ak4531_codec.h>
30 #include <sound/tlv.h>
32 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
33 MODULE_DESCRIPTION("Universal routines for AK4531 codec");
34 MODULE_LICENSE("GPL");
37 static void snd_ak4531_proc_init(struct snd_card *card, struct snd_ak4531 *ak4531);
39 #define snd_ak4531_proc_init(card,ak)
48 static void snd_ak4531_dump(struct snd_ak4531 *ak4531)
52 for (idx = 0; idx < 0x19; idx++)
53 printk("ak4531 0x%x: 0x%x\n", idx, ak4531->regs[idx]);
62 #define AK4531_SINGLE(xname, xindex, reg, shift, mask, invert) \
63 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
64 .info = snd_ak4531_info_single, \
65 .get = snd_ak4531_get_single, .put = snd_ak4531_put_single, \
66 .private_value = reg | (shift << 16) | (mask << 24) | (invert << 22) }
67 #define AK4531_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
68 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
69 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
70 .name = xname, .index = xindex, \
71 .info = snd_ak4531_info_single, \
72 .get = snd_ak4531_get_single, .put = snd_ak4531_put_single, \
73 .private_value = reg | (shift << 16) | (mask << 24) | (invert << 22), \
74 .tlv = { .p = (xtlv) } }
76 static int snd_ak4531_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
78 int mask = (kcontrol->private_value >> 24) & 0xff;
80 uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
82 uinfo->value.integer.min = 0;
83 uinfo->value.integer.max = mask;
87 static int snd_ak4531_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
89 struct snd_ak4531 *ak4531 = snd_kcontrol_chip(kcontrol);
90 int reg = kcontrol->private_value & 0xff;
91 int shift = (kcontrol->private_value >> 16) & 0x07;
92 int mask = (kcontrol->private_value >> 24) & 0xff;
93 int invert = (kcontrol->private_value >> 22) & 1;
96 mutex_lock(&ak4531->reg_mutex);
97 val = (ak4531->regs[reg] >> shift) & mask;
98 mutex_unlock(&ak4531->reg_mutex);
102 ucontrol->value.integer.value[0] = val;
106 static int snd_ak4531_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
108 struct snd_ak4531 *ak4531 = snd_kcontrol_chip(kcontrol);
109 int reg = kcontrol->private_value & 0xff;
110 int shift = (kcontrol->private_value >> 16) & 0x07;
111 int mask = (kcontrol->private_value >> 24) & 0xff;
112 int invert = (kcontrol->private_value >> 22) & 1;
116 val = ucontrol->value.integer.value[0] & mask;
121 mutex_lock(&ak4531->reg_mutex);
122 val = (ak4531->regs[reg] & ~(mask << shift)) | val;
123 change = val != ak4531->regs[reg];
124 ak4531->write(ak4531, reg, ak4531->regs[reg] = val);
125 mutex_unlock(&ak4531->reg_mutex);
129 #define AK4531_DOUBLE(xname, xindex, left_reg, right_reg, left_shift, right_shift, mask, invert) \
130 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
131 .info = snd_ak4531_info_double, \
132 .get = snd_ak4531_get_double, .put = snd_ak4531_put_double, \
133 .private_value = left_reg | (right_reg << 8) | (left_shift << 16) | (right_shift << 19) | (mask << 24) | (invert << 22) }
134 #define AK4531_DOUBLE_TLV(xname, xindex, left_reg, right_reg, left_shift, right_shift, mask, invert, xtlv) \
135 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
136 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
137 .name = xname, .index = xindex, \
138 .info = snd_ak4531_info_double, \
139 .get = snd_ak4531_get_double, .put = snd_ak4531_put_double, \
140 .private_value = left_reg | (right_reg << 8) | (left_shift << 16) | (right_shift << 19) | (mask << 24) | (invert << 22), \
141 .tlv = { .p = (xtlv) } }
143 static int snd_ak4531_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
145 int mask = (kcontrol->private_value >> 24) & 0xff;
147 uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
149 uinfo->value.integer.min = 0;
150 uinfo->value.integer.max = mask;
154 static int snd_ak4531_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
156 struct snd_ak4531 *ak4531 = snd_kcontrol_chip(kcontrol);
157 int left_reg = kcontrol->private_value & 0xff;
158 int right_reg = (kcontrol->private_value >> 8) & 0xff;
159 int left_shift = (kcontrol->private_value >> 16) & 0x07;
160 int right_shift = (kcontrol->private_value >> 19) & 0x07;
161 int mask = (kcontrol->private_value >> 24) & 0xff;
162 int invert = (kcontrol->private_value >> 22) & 1;
165 mutex_lock(&ak4531->reg_mutex);
166 left = (ak4531->regs[left_reg] >> left_shift) & mask;
167 right = (ak4531->regs[right_reg] >> right_shift) & mask;
168 mutex_unlock(&ak4531->reg_mutex);
171 right = mask - right;
173 ucontrol->value.integer.value[0] = left;
174 ucontrol->value.integer.value[1] = right;
178 static int snd_ak4531_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
180 struct snd_ak4531 *ak4531 = snd_kcontrol_chip(kcontrol);
181 int left_reg = kcontrol->private_value & 0xff;
182 int right_reg = (kcontrol->private_value >> 8) & 0xff;
183 int left_shift = (kcontrol->private_value >> 16) & 0x07;
184 int right_shift = (kcontrol->private_value >> 19) & 0x07;
185 int mask = (kcontrol->private_value >> 24) & 0xff;
186 int invert = (kcontrol->private_value >> 22) & 1;
190 left = ucontrol->value.integer.value[0] & mask;
191 right = ucontrol->value.integer.value[1] & mask;
194 right = mask - right;
197 right <<= right_shift;
198 mutex_lock(&ak4531->reg_mutex);
199 if (left_reg == right_reg) {
200 left = (ak4531->regs[left_reg] & ~((mask << left_shift) | (mask << right_shift))) | left | right;
201 change = left != ak4531->regs[left_reg];
202 ak4531->write(ak4531, left_reg, ak4531->regs[left_reg] = left);
204 left = (ak4531->regs[left_reg] & ~(mask << left_shift)) | left;
205 right = (ak4531->regs[right_reg] & ~(mask << right_shift)) | right;
206 change = left != ak4531->regs[left_reg] || right != ak4531->regs[right_reg];
207 ak4531->write(ak4531, left_reg, ak4531->regs[left_reg] = left);
208 ak4531->write(ak4531, right_reg, ak4531->regs[right_reg] = right);
210 mutex_unlock(&ak4531->reg_mutex);
214 #define AK4531_INPUT_SW(xname, xindex, reg1, reg2, left_shift, right_shift) \
215 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
216 .info = snd_ak4531_info_input_sw, \
217 .get = snd_ak4531_get_input_sw, .put = snd_ak4531_put_input_sw, \
218 .private_value = reg1 | (reg2 << 8) | (left_shift << 16) | (right_shift << 24) }
220 static int snd_ak4531_info_input_sw(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
222 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
224 uinfo->value.integer.min = 0;
225 uinfo->value.integer.max = 1;
229 static int snd_ak4531_get_input_sw(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
231 struct snd_ak4531 *ak4531 = snd_kcontrol_chip(kcontrol);
232 int reg1 = kcontrol->private_value & 0xff;
233 int reg2 = (kcontrol->private_value >> 8) & 0xff;
234 int left_shift = (kcontrol->private_value >> 16) & 0x0f;
235 int right_shift = (kcontrol->private_value >> 24) & 0x0f;
237 mutex_lock(&ak4531->reg_mutex);
238 ucontrol->value.integer.value[0] = (ak4531->regs[reg1] >> left_shift) & 1;
239 ucontrol->value.integer.value[1] = (ak4531->regs[reg2] >> left_shift) & 1;
240 ucontrol->value.integer.value[2] = (ak4531->regs[reg1] >> right_shift) & 1;
241 ucontrol->value.integer.value[3] = (ak4531->regs[reg2] >> right_shift) & 1;
242 mutex_unlock(&ak4531->reg_mutex);
246 static int snd_ak4531_put_input_sw(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
248 struct snd_ak4531 *ak4531 = snd_kcontrol_chip(kcontrol);
249 int reg1 = kcontrol->private_value & 0xff;
250 int reg2 = (kcontrol->private_value >> 8) & 0xff;
251 int left_shift = (kcontrol->private_value >> 16) & 0x0f;
252 int right_shift = (kcontrol->private_value >> 24) & 0x0f;
256 mutex_lock(&ak4531->reg_mutex);
257 val1 = ak4531->regs[reg1] & ~((1 << left_shift) | (1 << right_shift));
258 val2 = ak4531->regs[reg2] & ~((1 << left_shift) | (1 << right_shift));
259 val1 |= (ucontrol->value.integer.value[0] & 1) << left_shift;
260 val2 |= (ucontrol->value.integer.value[1] & 1) << left_shift;
261 val1 |= (ucontrol->value.integer.value[2] & 1) << right_shift;
262 val2 |= (ucontrol->value.integer.value[3] & 1) << right_shift;
263 change = val1 != ak4531->regs[reg1] || val2 != ak4531->regs[reg2];
264 ak4531->write(ak4531, reg1, ak4531->regs[reg1] = val1);
265 ak4531->write(ak4531, reg2, ak4531->regs[reg2] = val2);
266 mutex_unlock(&ak4531->reg_mutex);
270 static const DECLARE_TLV_DB_SCALE(db_scale_master, -6200, 200, 0);
271 static const DECLARE_TLV_DB_SCALE(db_scale_mono, -2800, 400, 0);
272 static const DECLARE_TLV_DB_SCALE(db_scale_input, -5000, 200, 0);
274 static struct snd_kcontrol_new snd_ak4531_controls[] = {
276 AK4531_DOUBLE_TLV("Master Playback Switch", 0,
277 AK4531_LMASTER, AK4531_RMASTER, 7, 7, 1, 1,
279 AK4531_DOUBLE("Master Playback Volume", 0, AK4531_LMASTER, AK4531_RMASTER, 0, 0, 0x1f, 1),
281 AK4531_SINGLE_TLV("Master Mono Playback Switch", 0, AK4531_MONO_OUT, 7, 1, 1,
283 AK4531_SINGLE("Master Mono Playback Volume", 0, AK4531_MONO_OUT, 0, 0x07, 1),
285 AK4531_DOUBLE("PCM Switch", 0, AK4531_LVOICE, AK4531_RVOICE, 7, 7, 1, 1),
286 AK4531_DOUBLE_TLV("PCM Volume", 0, AK4531_LVOICE, AK4531_RVOICE, 0, 0, 0x1f, 1,
288 AK4531_DOUBLE("PCM Playback Switch", 0, AK4531_OUT_SW2, AK4531_OUT_SW2, 3, 2, 1, 0),
289 AK4531_DOUBLE("PCM Capture Switch", 0, AK4531_LIN_SW2, AK4531_RIN_SW2, 2, 2, 1, 0),
291 AK4531_DOUBLE("PCM Switch", 1, AK4531_LFM, AK4531_RFM, 7, 7, 1, 1),
292 AK4531_DOUBLE_TLV("PCM Volume", 1, AK4531_LFM, AK4531_RFM, 0, 0, 0x1f, 1,
294 AK4531_DOUBLE("PCM Playback Switch", 1, AK4531_OUT_SW1, AK4531_OUT_SW1, 6, 5, 1, 0),
295 AK4531_INPUT_SW("PCM Capture Route", 1, AK4531_LIN_SW1, AK4531_RIN_SW1, 6, 5),
297 AK4531_DOUBLE("CD Switch", 0, AK4531_LCD, AK4531_RCD, 7, 7, 1, 1),
298 AK4531_DOUBLE_TLV("CD Volume", 0, AK4531_LCD, AK4531_RCD, 0, 0, 0x1f, 1,
300 AK4531_DOUBLE("CD Playback Switch", 0, AK4531_OUT_SW1, AK4531_OUT_SW1, 2, 1, 1, 0),
301 AK4531_INPUT_SW("CD Capture Route", 0, AK4531_LIN_SW1, AK4531_RIN_SW1, 2, 1),
303 AK4531_DOUBLE("Line Switch", 0, AK4531_LLINE, AK4531_RLINE, 7, 7, 1, 1),
304 AK4531_DOUBLE_TLV("Line Volume", 0, AK4531_LLINE, AK4531_RLINE, 0, 0, 0x1f, 1,
306 AK4531_DOUBLE("Line Playback Switch", 0, AK4531_OUT_SW1, AK4531_OUT_SW1, 4, 3, 1, 0),
307 AK4531_INPUT_SW("Line Capture Route", 0, AK4531_LIN_SW1, AK4531_RIN_SW1, 4, 3),
309 AK4531_DOUBLE("Aux Switch", 0, AK4531_LAUXA, AK4531_RAUXA, 7, 7, 1, 1),
310 AK4531_DOUBLE_TLV("Aux Volume", 0, AK4531_LAUXA, AK4531_RAUXA, 0, 0, 0x1f, 1,
312 AK4531_DOUBLE("Aux Playback Switch", 0, AK4531_OUT_SW2, AK4531_OUT_SW2, 5, 4, 1, 0),
313 AK4531_INPUT_SW("Aux Capture Route", 0, AK4531_LIN_SW2, AK4531_RIN_SW2, 4, 3),
315 AK4531_SINGLE("Mono Switch", 0, AK4531_MONO1, 7, 1, 1),
316 AK4531_SINGLE_TLV("Mono Volume", 0, AK4531_MONO1, 0, 0x1f, 1, db_scale_input),
317 AK4531_SINGLE("Mono Playback Switch", 0, AK4531_OUT_SW2, 0, 1, 0),
318 AK4531_DOUBLE("Mono Capture Switch", 0, AK4531_LIN_SW2, AK4531_RIN_SW2, 0, 0, 1, 0),
320 AK4531_SINGLE("Mono Switch", 1, AK4531_MONO2, 7, 1, 1),
321 AK4531_SINGLE_TLV("Mono Volume", 1, AK4531_MONO2, 0, 0x1f, 1, db_scale_input),
322 AK4531_SINGLE("Mono Playback Switch", 1, AK4531_OUT_SW2, 1, 1, 0),
323 AK4531_DOUBLE("Mono Capture Switch", 1, AK4531_LIN_SW2, AK4531_RIN_SW2, 1, 1, 1, 0),
325 AK4531_SINGLE_TLV("Mic Volume", 0, AK4531_MIC, 0, 0x1f, 1, db_scale_input),
326 AK4531_SINGLE("Mic Switch", 0, AK4531_MIC, 7, 1, 1),
327 AK4531_SINGLE("Mic Playback Switch", 0, AK4531_OUT_SW1, 0, 1, 0),
328 AK4531_DOUBLE("Mic Capture Switch", 0, AK4531_LIN_SW1, AK4531_RIN_SW1, 0, 0, 1, 0),
330 AK4531_DOUBLE("Mic Bypass Capture Switch", 0, AK4531_LIN_SW2, AK4531_RIN_SW2, 7, 7, 1, 0),
331 AK4531_DOUBLE("Mono1 Bypass Capture Switch", 0, AK4531_LIN_SW2, AK4531_RIN_SW2, 6, 6, 1, 0),
332 AK4531_DOUBLE("Mono2 Bypass Capture Switch", 0, AK4531_LIN_SW2, AK4531_RIN_SW2, 5, 5, 1, 0),
334 AK4531_SINGLE("AD Input Select", 0, AK4531_AD_IN, 0, 1, 0),
335 AK4531_SINGLE("Mic Boost (+30dB)", 0, AK4531_MIC_GAIN, 0, 1, 0)
338 static int snd_ak4531_free(struct snd_ak4531 *ak4531)
341 if (ak4531->private_free)
342 ak4531->private_free(ak4531);
348 static int snd_ak4531_dev_free(struct snd_device *device)
350 struct snd_ak4531 *ak4531 = device->device_data;
351 return snd_ak4531_free(ak4531);
354 static u8 snd_ak4531_initial_map[0x19 + 1] = {
355 0x9f, /* 00: Master Volume Lch */
356 0x9f, /* 01: Master Volume Rch */
357 0x9f, /* 02: Voice Volume Lch */
358 0x9f, /* 03: Voice Volume Rch */
359 0x9f, /* 04: FM Volume Lch */
360 0x9f, /* 05: FM Volume Rch */
361 0x9f, /* 06: CD Audio Volume Lch */
362 0x9f, /* 07: CD Audio Volume Rch */
363 0x9f, /* 08: Line Volume Lch */
364 0x9f, /* 09: Line Volume Rch */
365 0x9f, /* 0a: Aux Volume Lch */
366 0x9f, /* 0b: Aux Volume Rch */
367 0x9f, /* 0c: Mono1 Volume */
368 0x9f, /* 0d: Mono2 Volume */
369 0x9f, /* 0e: Mic Volume */
370 0x87, /* 0f: Mono-out Volume */
371 0x00, /* 10: Output Mixer SW1 */
372 0x00, /* 11: Output Mixer SW2 */
373 0x00, /* 12: Lch Input Mixer SW1 */
374 0x00, /* 13: Rch Input Mixer SW1 */
375 0x00, /* 14: Lch Input Mixer SW2 */
376 0x00, /* 15: Rch Input Mixer SW2 */
377 0x00, /* 16: Reset & Power Down */
378 0x00, /* 17: Clock Select */
379 0x00, /* 18: AD Input Select */
380 0x01 /* 19: Mic Amp Setup */
383 int snd_ak4531_mixer(struct snd_card *card, struct snd_ak4531 *_ak4531,
384 struct snd_ak4531 **rak4531)
388 struct snd_ak4531 *ak4531;
389 static struct snd_device_ops ops = {
390 .dev_free = snd_ak4531_dev_free,
393 snd_assert(rak4531 != NULL, return -EINVAL);
395 snd_assert(card != NULL && _ak4531 != NULL, return -EINVAL);
396 ak4531 = kzalloc(sizeof(*ak4531), GFP_KERNEL);
400 mutex_init(&ak4531->reg_mutex);
401 if ((err = snd_component_add(card, "AK4531")) < 0) {
402 snd_ak4531_free(ak4531);
405 strcpy(card->mixername, "Asahi Kasei AK4531");
406 ak4531->write(ak4531, AK4531_RESET, 0x03); /* no RST, PD */
408 ak4531->write(ak4531, AK4531_CLOCK, 0x00); /* CODEC ADC and CODEC DAC use {LR,B}CLK2 and run off LRCLK2 PLL */
409 for (idx = 0; idx <= 0x19; idx++) {
410 if (idx == AK4531_RESET || idx == AK4531_CLOCK)
412 ak4531->write(ak4531, idx, ak4531->regs[idx] = snd_ak4531_initial_map[idx]); /* recording source is mixer */
414 for (idx = 0; idx < ARRAY_SIZE(snd_ak4531_controls); idx++) {
415 if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_ak4531_controls[idx], ak4531))) < 0) {
416 snd_ak4531_free(ak4531);
420 snd_ak4531_proc_init(card, ak4531);
421 if ((err = snd_device_new(card, SNDRV_DEV_CODEC, ak4531, &ops)) < 0) {
422 snd_ak4531_free(ak4531);
427 snd_ak4531_dump(ak4531);
437 void snd_ak4531_suspend(struct snd_ak4531 *ak4531)
440 ak4531->write(ak4531, AK4531_LMASTER, 0x9f);
441 ak4531->write(ak4531, AK4531_RMASTER, 0x9f);
443 ak4531->write(ak4531, AK4531_RESET, 0x01);
446 void snd_ak4531_resume(struct snd_ak4531 *ak4531)
451 ak4531->write(ak4531, AK4531_RESET, 0x03);
453 ak4531->write(ak4531, AK4531_CLOCK, 0x00);
454 /* restore mixer registers */
455 for (idx = 0; idx <= 0x19; idx++) {
456 if (idx == AK4531_RESET || idx == AK4531_CLOCK)
458 ak4531->write(ak4531, idx, ak4531->regs[idx]);
463 #ifdef CONFIG_PROC_FS
468 static void snd_ak4531_proc_read(struct snd_info_entry *entry,
469 struct snd_info_buffer *buffer)
471 struct snd_ak4531 *ak4531 = entry->private_data;
473 snd_iprintf(buffer, "Asahi Kasei AK4531\n\n");
474 snd_iprintf(buffer, "Recording source : %s\n"
476 ak4531->regs[AK4531_AD_IN] & 1 ? "external" : "mixer",
477 ak4531->regs[AK4531_MIC_GAIN] & 1 ? "+30dB" : "+0dB");
480 static void snd_ak4531_proc_init(struct snd_card *card, struct snd_ak4531 *ak4531)
482 struct snd_info_entry *entry;
484 if (! snd_card_proc_new(card, "ak4531", &entry))
485 snd_info_set_text_ops(entry, ak4531, snd_ak4531_proc_read);
489 EXPORT_SYMBOL(snd_ak4531_mixer);
491 EXPORT_SYMBOL(snd_ak4531_suspend);
492 EXPORT_SYMBOL(snd_ak4531_resume);
499 static int __init alsa_ak4531_init(void)
504 static void __exit alsa_ak4531_exit(void)
508 module_init(alsa_ak4531_init)
509 module_exit(alsa_ak4531_exit)