2 * ak4535.c -- AK4535 ALSA Soc Audio driver
4 * Copyright 2005 Openedhand Ltd.
6 * Author: Richard Purdie <richard@openedhand.com>
8 * Based on wm8753.c by Liam Girdwood
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
20 #include <linux/i2c.h>
21 #include <linux/platform_device.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/initval.h>
31 #define AUDIO_NAME "ak4535"
32 #define AK4535_VERSION "0.3"
34 struct snd_soc_codec_device soc_codec_dev_ak4535;
36 /* codec private data */
42 * ak4535 register cache
44 static const u16 ak4535_reg[AK4535_CACHEREGNUM] = {
45 0x0000, 0x0080, 0x0000, 0x0003,
46 0x0002, 0x0000, 0x0011, 0x0001,
47 0x0000, 0x0040, 0x0036, 0x0010,
48 0x0000, 0x0000, 0x0057, 0x0000,
52 * read ak4535 register cache
54 static inline unsigned int ak4535_read_reg_cache(struct snd_soc_codec *codec,
57 u16 *cache = codec->reg_cache;
58 if (reg >= AK4535_CACHEREGNUM)
63 static inline unsigned int ak4535_read(struct snd_soc_codec *codec,
69 if (codec->hw_write(codec->control_data, &data, 1) != 1)
72 if (codec->hw_read(codec->control_data, &data, 1) != 1)
79 * write ak4535 register cache
81 static inline void ak4535_write_reg_cache(struct snd_soc_codec *codec,
82 u16 reg, unsigned int value)
84 u16 *cache = codec->reg_cache;
85 if (reg >= AK4535_CACHEREGNUM)
91 * write to the AK4535 register space
93 static int ak4535_write(struct snd_soc_codec *codec, unsigned int reg,
99 * D15..D8 AK4535 register offset
100 * D7...D0 register data
102 data[0] = reg & 0xff;
103 data[1] = value & 0xff;
105 ak4535_write_reg_cache(codec, reg, value);
106 if (codec->hw_write(codec->control_data, data, 2) == 2)
112 static int ak4535_sync(struct snd_soc_codec *codec)
114 u16 *cache = codec->reg_cache;
117 for (i = 0; i < AK4535_CACHEREGNUM; i++)
118 r |= ak4535_write(codec, i, cache[i]);
123 static const char *ak4535_mono_gain[] = {"+6dB", "-17dB"};
124 static const char *ak4535_mono_out[] = {"(L + R)/2", "Hi-Z"};
125 static const char *ak4535_hp_out[] = {"Stereo", "Mono"};
126 static const char *ak4535_deemp[] = {"44.1kHz", "Off", "48kHz", "32kHz"};
127 static const char *ak4535_mic_select[] = {"Internal", "External"};
129 static const struct soc_enum ak4535_enum[] = {
130 SOC_ENUM_SINGLE(AK4535_SIG1, 7, 2, ak4535_mono_gain),
131 SOC_ENUM_SINGLE(AK4535_SIG1, 6, 2, ak4535_mono_out),
132 SOC_ENUM_SINGLE(AK4535_MODE2, 2, 2, ak4535_hp_out),
133 SOC_ENUM_SINGLE(AK4535_DAC, 0, 4, ak4535_deemp),
134 SOC_ENUM_SINGLE(AK4535_MIC, 1, 2, ak4535_mic_select),
137 static const struct snd_kcontrol_new ak4535_snd_controls[] = {
138 SOC_SINGLE("ALC2 Switch", AK4535_SIG1, 1, 1, 0),
139 SOC_ENUM("Mono 1 Output", ak4535_enum[1]),
140 SOC_ENUM("Mono 1 Gain", ak4535_enum[0]),
141 SOC_ENUM("Headphone Output", ak4535_enum[2]),
142 SOC_ENUM("Playback Deemphasis", ak4535_enum[3]),
143 SOC_SINGLE("Bass Volume", AK4535_DAC, 2, 3, 0),
144 SOC_SINGLE("Mic Boost (+20dB) Switch", AK4535_MIC, 0, 1, 0),
145 SOC_ENUM("Mic Select", ak4535_enum[4]),
146 SOC_SINGLE("ALC Operation Time", AK4535_TIMER, 0, 3, 0),
147 SOC_SINGLE("ALC Recovery Time", AK4535_TIMER, 2, 3, 0),
148 SOC_SINGLE("ALC ZC Time", AK4535_TIMER, 4, 3, 0),
149 SOC_SINGLE("ALC 1 Switch", AK4535_ALC1, 5, 1, 0),
150 SOC_SINGLE("ALC 2 Switch", AK4535_ALC1, 6, 1, 0),
151 SOC_SINGLE("ALC Volume", AK4535_ALC2, 0, 127, 0),
152 SOC_SINGLE("Capture Volume", AK4535_PGA, 0, 127, 0),
153 SOC_SINGLE("Left Playback Volume", AK4535_LATT, 0, 127, 1),
154 SOC_SINGLE("Right Playback Volume", AK4535_RATT, 0, 127, 1),
155 SOC_SINGLE("AUX Bypass Volume", AK4535_VOL, 0, 15, 0),
156 SOC_SINGLE("Mic Sidetone Volume", AK4535_VOL, 4, 7, 0),
159 /* add non dapm controls */
160 static int ak4535_add_controls(struct snd_soc_codec *codec)
164 for (i = 0; i < ARRAY_SIZE(ak4535_snd_controls); i++) {
165 err = snd_ctl_add(codec->card,
166 snd_soc_cnew(&ak4535_snd_controls[i], codec, NULL));
175 static const struct snd_kcontrol_new ak4535_mono1_mixer_controls[] = {
176 SOC_DAPM_SINGLE("Mic Sidetone Switch", AK4535_SIG1, 4, 1, 0),
177 SOC_DAPM_SINGLE("Mono Playback Switch", AK4535_SIG1, 5, 1, 0),
181 static const struct snd_kcontrol_new ak4535_stereo_mixer_controls[] = {
182 SOC_DAPM_SINGLE("Mic Sidetone Switch", AK4535_SIG2, 4, 1, 0),
183 SOC_DAPM_SINGLE("Playback Switch", AK4535_SIG2, 7, 1, 0),
184 SOC_DAPM_SINGLE("Aux Bypass Switch", AK4535_SIG2, 5, 1, 0),
188 static const struct snd_kcontrol_new ak4535_input_mixer_controls[] = {
189 SOC_DAPM_SINGLE("Mic Capture Switch", AK4535_MIC, 2, 1, 0),
190 SOC_DAPM_SINGLE("Aux Capture Switch", AK4535_MIC, 5, 1, 0),
194 static const struct snd_kcontrol_new ak4535_input_mux_control =
195 SOC_DAPM_ENUM("Input Select", ak4535_enum[4]);
198 static const struct snd_kcontrol_new ak4535_hpl_control =
199 SOC_DAPM_SINGLE("Switch", AK4535_SIG2, 1, 1, 1);
202 static const struct snd_kcontrol_new ak4535_hpr_control =
203 SOC_DAPM_SINGLE("Switch", AK4535_SIG2, 0, 1, 1);
206 static const struct snd_kcontrol_new ak4535_mono2_control =
207 SOC_DAPM_SINGLE("Switch", AK4535_SIG1, 0, 1, 0);
209 /* Line out switch */
210 static const struct snd_kcontrol_new ak4535_line_control =
211 SOC_DAPM_SINGLE("Switch", AK4535_SIG2, 6, 1, 0);
213 /* ak4535 dapm widgets */
214 static const struct snd_soc_dapm_widget ak4535_dapm_widgets[] = {
215 SND_SOC_DAPM_MIXER("Stereo Mixer", SND_SOC_NOPM, 0, 0,
216 &ak4535_stereo_mixer_controls[0],
217 ARRAY_SIZE(ak4535_stereo_mixer_controls)),
218 SND_SOC_DAPM_MIXER("Mono1 Mixer", SND_SOC_NOPM, 0, 0,
219 &ak4535_mono1_mixer_controls[0],
220 ARRAY_SIZE(ak4535_mono1_mixer_controls)),
221 SND_SOC_DAPM_MIXER("Input Mixer", SND_SOC_NOPM, 0, 0,
222 &ak4535_input_mixer_controls[0],
223 ARRAY_SIZE(ak4535_input_mixer_controls)),
224 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0,
225 &ak4535_input_mux_control),
226 SND_SOC_DAPM_DAC("DAC", "Playback", AK4535_PM2, 0, 0),
227 SND_SOC_DAPM_SWITCH("Mono 2 Enable", SND_SOC_NOPM, 0, 0,
228 &ak4535_mono2_control),
229 /* speaker powersave bit */
230 SND_SOC_DAPM_PGA("Speaker Enable", AK4535_MODE2, 0, 0, NULL, 0),
231 SND_SOC_DAPM_SWITCH("Line Out Enable", SND_SOC_NOPM, 0, 0,
232 &ak4535_line_control),
233 SND_SOC_DAPM_SWITCH("Left HP Enable", SND_SOC_NOPM, 0, 0,
234 &ak4535_hpl_control),
235 SND_SOC_DAPM_SWITCH("Right HP Enable", SND_SOC_NOPM, 0, 0,
236 &ak4535_hpr_control),
237 SND_SOC_DAPM_OUTPUT("LOUT"),
238 SND_SOC_DAPM_OUTPUT("HPL"),
239 SND_SOC_DAPM_OUTPUT("ROUT"),
240 SND_SOC_DAPM_OUTPUT("HPR"),
241 SND_SOC_DAPM_OUTPUT("SPP"),
242 SND_SOC_DAPM_OUTPUT("SPN"),
243 SND_SOC_DAPM_OUTPUT("MOUT1"),
244 SND_SOC_DAPM_OUTPUT("MOUT2"),
245 SND_SOC_DAPM_OUTPUT("MICOUT"),
246 SND_SOC_DAPM_ADC("ADC", "Capture", AK4535_PM1, 0, 0),
247 SND_SOC_DAPM_PGA("Spk Amp", AK4535_PM2, 3, 0, NULL, 0),
248 SND_SOC_DAPM_PGA("HP R Amp", AK4535_PM2, 1, 0, NULL, 0),
249 SND_SOC_DAPM_PGA("HP L Amp", AK4535_PM2, 2, 0, NULL, 0),
250 SND_SOC_DAPM_PGA("Mic", AK4535_PM1, 1, 0, NULL, 0),
251 SND_SOC_DAPM_PGA("Line Out", AK4535_PM1, 4, 0, NULL, 0),
252 SND_SOC_DAPM_PGA("Mono Out", AK4535_PM1, 3, 0, NULL, 0),
253 SND_SOC_DAPM_PGA("AUX In", AK4535_PM1, 2, 0, NULL, 0),
255 SND_SOC_DAPM_MICBIAS("Mic Int Bias", AK4535_MIC, 3, 0),
256 SND_SOC_DAPM_MICBIAS("Mic Ext Bias", AK4535_MIC, 4, 0),
257 SND_SOC_DAPM_INPUT("MICIN"),
258 SND_SOC_DAPM_INPUT("MICEXT"),
259 SND_SOC_DAPM_INPUT("AUX"),
260 SND_SOC_DAPM_INPUT("MIN"),
261 SND_SOC_DAPM_INPUT("AIN"),
264 static const struct snd_soc_dapm_route audio_map[] = {
266 {"Stereo Mixer", "Playback Switch", "DAC"},
267 {"Stereo Mixer", "Mic Sidetone Switch", "Mic"},
268 {"Stereo Mixer", "Aux Bypass Switch", "AUX In"},
271 {"Mono1 Mixer", "Mic Sidetone Switch", "Mic"},
272 {"Mono1 Mixer", "Mono Playback Switch", "DAC"},
275 {"Mic", NULL, "AIN"},
276 {"Input Mux", "Internal", "Mic Int Bias"},
277 {"Input Mux", "External", "Mic Ext Bias"},
278 {"Mic Int Bias", NULL, "MICIN"},
279 {"Mic Ext Bias", NULL, "MICEXT"},
280 {"MICOUT", NULL, "Input Mux"},
283 {"LOUT", NULL, "Line Out Enable"},
284 {"ROUT", NULL, "Line Out Enable"},
285 {"Line Out Enable", "Switch", "Line Out"},
286 {"Line Out", NULL, "Stereo Mixer"},
289 {"MOUT1", NULL, "Mono Out"},
290 {"Mono Out", NULL, "Mono1 Mixer"},
293 {"HPL", NULL, "Left HP Enable"},
294 {"Left HP Enable", "Switch", "HP L Amp"},
295 {"HP L Amp", NULL, "Stereo Mixer"},
298 {"HPR", NULL, "Right HP Enable"},
299 {"Right HP Enable", "Switch", "HP R Amp"},
300 {"HP R Amp", NULL, "Stereo Mixer"},
303 {"SPP", NULL, "Speaker Enable"},
304 {"SPN", NULL, "Speaker Enable"},
305 {"Speaker Enable", "Switch", "Spk Amp"},
306 {"Spk Amp", NULL, "MIN"},
309 {"MOUT2", NULL, "Mono 2 Enable"},
310 {"Mono 2 Enable", "Switch", "Stereo Mixer"},
313 {"Aux In", NULL, "AUX"},
316 {"ADC", NULL, "Input Mixer"},
317 {"Input Mixer", "Mic Capture Switch", "Mic"},
318 {"Input Mixer", "Aux Capture Switch", "Aux In"},
321 static int ak4535_add_widgets(struct snd_soc_codec *codec)
323 snd_soc_dapm_new_controls(codec, ak4535_dapm_widgets,
324 ARRAY_SIZE(ak4535_dapm_widgets));
326 snd_soc_dapm_add_routes(codec, audio_map, ARRAY_SIZE(audio_map));
328 snd_soc_dapm_new_widgets(codec);
332 static int ak4535_set_dai_sysclk(struct snd_soc_dai *codec_dai,
333 int clk_id, unsigned int freq, int dir)
335 struct snd_soc_codec *codec = codec_dai->codec;
336 struct ak4535_priv *ak4535 = codec->private_data;
338 ak4535->sysclk = freq;
342 static int ak4535_hw_params(struct snd_pcm_substream *substream,
343 struct snd_pcm_hw_params *params)
345 struct snd_soc_pcm_runtime *rtd = substream->private_data;
346 struct snd_soc_device *socdev = rtd->socdev;
347 struct snd_soc_codec *codec = socdev->codec;
348 struct ak4535_priv *ak4535 = codec->private_data;
349 u8 mode2 = ak4535_read_reg_cache(codec, AK4535_MODE2) & ~(0x3 << 5);
350 int rate = params_rate(params), fs = 256;
353 fs = ak4535->sysclk / rate;
368 ak4535_write(codec, AK4535_MODE2, mode2);
372 static int ak4535_set_dai_fmt(struct snd_soc_dai *codec_dai,
375 struct snd_soc_codec *codec = codec_dai->codec;
378 /* interface format */
379 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
380 case SND_SOC_DAIFMT_I2S:
383 case SND_SOC_DAIFMT_LEFT_J:
390 /* use 32 fs for BCLK to save power */
393 ak4535_write(codec, AK4535_MODE1, mode1);
397 static int ak4535_mute(struct snd_soc_dai *dai, int mute)
399 struct snd_soc_codec *codec = dai->codec;
400 u16 mute_reg = ak4535_read_reg_cache(codec, AK4535_DAC) & 0xffdf;
402 ak4535_write(codec, AK4535_DAC, mute_reg);
404 ak4535_write(codec, AK4535_DAC, mute_reg | 0x20);
408 static int ak4535_set_bias_level(struct snd_soc_codec *codec,
409 enum snd_soc_bias_level level)
414 case SND_SOC_BIAS_ON:
415 ak4535_mute(codec->dai, 0);
417 case SND_SOC_BIAS_PREPARE:
418 ak4535_mute(codec->dai, 1);
420 case SND_SOC_BIAS_STANDBY:
421 i = ak4535_read_reg_cache(codec, AK4535_PM1);
422 ak4535_write(codec, AK4535_PM1, i | 0x80);
423 i = ak4535_read_reg_cache(codec, AK4535_PM2);
424 ak4535_write(codec, AK4535_PM2, i & (~0x80));
426 case SND_SOC_BIAS_OFF:
427 i = ak4535_read_reg_cache(codec, AK4535_PM1);
428 ak4535_write(codec, AK4535_PM1, i & (~0x80));
431 codec->bias_level = level;
435 #define AK4535_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
436 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
437 SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
439 struct snd_soc_dai ak4535_dai = {
442 .stream_name = "Playback",
445 .rates = AK4535_RATES,
446 .formats = SNDRV_PCM_FMTBIT_S16_LE,},
448 .stream_name = "Capture",
451 .rates = AK4535_RATES,
452 .formats = SNDRV_PCM_FMTBIT_S16_LE,},
454 .hw_params = ak4535_hw_params,
457 .set_fmt = ak4535_set_dai_fmt,
458 .digital_mute = ak4535_mute,
459 .set_sysclk = ak4535_set_dai_sysclk,
462 EXPORT_SYMBOL_GPL(ak4535_dai);
464 static int ak4535_suspend(struct platform_device *pdev, pm_message_t state)
466 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
467 struct snd_soc_codec *codec = socdev->codec;
469 ak4535_set_bias_level(codec, SND_SOC_BIAS_OFF);
473 static int ak4535_resume(struct platform_device *pdev)
475 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
476 struct snd_soc_codec *codec = socdev->codec;
478 ak4535_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
479 ak4535_set_bias_level(codec, codec->suspend_bias_level);
484 * initialise the AK4535 driver
485 * register the mixer and dsp interfaces with the kernel
487 static int ak4535_init(struct snd_soc_device *socdev)
489 struct snd_soc_codec *codec = socdev->codec;
492 codec->name = "AK4535";
493 codec->owner = THIS_MODULE;
494 codec->read = ak4535_read_reg_cache;
495 codec->write = ak4535_write;
496 codec->set_bias_level = ak4535_set_bias_level;
497 codec->dai = &ak4535_dai;
499 codec->reg_cache_size = ARRAY_SIZE(ak4535_reg);
500 codec->reg_cache = kmemdup(ak4535_reg, sizeof(ak4535_reg), GFP_KERNEL);
502 if (codec->reg_cache == NULL)
506 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
508 printk(KERN_ERR "ak4535: failed to create pcms\n");
512 /* power on device */
513 ak4535_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
515 ak4535_add_controls(codec);
516 ak4535_add_widgets(codec);
517 ret = snd_soc_register_card(socdev);
519 printk(KERN_ERR "ak4535: failed to register card\n");
526 snd_soc_free_pcms(socdev);
527 snd_soc_dapm_free(socdev);
529 kfree(codec->reg_cache);
534 static struct snd_soc_device *ak4535_socdev;
536 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
538 #define I2C_DRIVERID_AK4535 0xfefe /* liam - need a proper id */
540 static unsigned short normal_i2c[] = { 0, I2C_CLIENT_END };
542 /* Magic definition of all other variables and things */
545 static struct i2c_driver ak4535_i2c_driver;
546 static struct i2c_client client_template;
548 /* If the i2c layer weren't so broken, we could pass this kind of data
550 static int ak4535_codec_probe(struct i2c_adapter *adap, int addr, int kind)
552 struct snd_soc_device *socdev = ak4535_socdev;
553 struct ak4535_setup_data *setup = socdev->codec_data;
554 struct snd_soc_codec *codec = socdev->codec;
555 struct i2c_client *i2c;
558 if (addr != setup->i2c_address)
561 client_template.adapter = adap;
562 client_template.addr = addr;
564 i2c = kmemdup(&client_template, sizeof(client_template), GFP_KERNEL);
568 i2c_set_clientdata(i2c, codec);
569 codec->control_data = i2c;
571 ret = i2c_attach_client(i2c);
573 printk(KERN_ERR "failed to attach codec at addr %x\n", addr);
577 ret = ak4535_init(socdev);
579 printk(KERN_ERR "failed to initialise AK4535\n");
589 static int ak4535_i2c_detach(struct i2c_client *client)
591 struct snd_soc_codec *codec = i2c_get_clientdata(client);
592 i2c_detach_client(client);
593 kfree(codec->reg_cache);
598 static int ak4535_i2c_attach(struct i2c_adapter *adap)
600 return i2c_probe(adap, &addr_data, ak4535_codec_probe);
603 /* corgi i2c codec control layer */
604 static struct i2c_driver ak4535_i2c_driver = {
606 .name = "AK4535 I2C Codec",
607 .owner = THIS_MODULE,
609 .id = I2C_DRIVERID_AK4535,
610 .attach_adapter = ak4535_i2c_attach,
611 .detach_client = ak4535_i2c_detach,
615 static struct i2c_client client_template = {
617 .driver = &ak4535_i2c_driver,
621 static int ak4535_probe(struct platform_device *pdev)
623 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
624 struct ak4535_setup_data *setup;
625 struct snd_soc_codec *codec;
626 struct ak4535_priv *ak4535;
629 printk(KERN_INFO "AK4535 Audio Codec %s", AK4535_VERSION);
631 setup = socdev->codec_data;
632 codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
636 ak4535 = kzalloc(sizeof(struct ak4535_priv), GFP_KERNEL);
637 if (ak4535 == NULL) {
642 codec->private_data = ak4535;
643 socdev->codec = codec;
644 mutex_init(&codec->mutex);
645 INIT_LIST_HEAD(&codec->dapm_widgets);
646 INIT_LIST_HEAD(&codec->dapm_paths);
648 ak4535_socdev = socdev;
649 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
650 if (setup->i2c_address) {
651 normal_i2c[0] = setup->i2c_address;
652 codec->hw_write = (hw_write_t)i2c_master_send;
653 codec->hw_read = (hw_read_t)i2c_master_recv;
654 ret = i2c_add_driver(&ak4535_i2c_driver);
656 printk(KERN_ERR "can't add i2c driver");
659 /* Add other interfaces here */
663 kfree(codec->private_data);
669 /* power down chip */
670 static int ak4535_remove(struct platform_device *pdev)
672 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
673 struct snd_soc_codec *codec = socdev->codec;
675 if (codec->control_data)
676 ak4535_set_bias_level(codec, SND_SOC_BIAS_OFF);
678 snd_soc_free_pcms(socdev);
679 snd_soc_dapm_free(socdev);
680 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
681 i2c_del_driver(&ak4535_i2c_driver);
683 kfree(codec->private_data);
689 struct snd_soc_codec_device soc_codec_dev_ak4535 = {
690 .probe = ak4535_probe,
691 .remove = ak4535_remove,
692 .suspend = ak4535_suspend,
693 .resume = ak4535_resume,
695 EXPORT_SYMBOL_GPL(soc_codec_dev_ak4535);
697 MODULE_DESCRIPTION("Soc AK4535 driver");
698 MODULE_AUTHOR("Richard Purdie");
699 MODULE_LICENSE("GPL");