2 * ak4642.c -- AK4642/AK4643 ALSA Soc Audio driver
4 * Copyright (C) 2009 Renesas Solutions Corp.
5 * Kuninori Morimoto <morimoto.kuninori@renesas.com>
7 * Based on wm8731.c by Richard Purdie
8 * Based on ak4535.c by Richard Purdie
9 * Based on wm8753.c by Liam Girdwood
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
18 * This is very simple driver.
19 * It can use headphone output / stereo input only
21 * AK4642 is not tested.
25 #include <linux/delay.h>
26 #include <linux/i2c.h>
27 #include <linux/platform_device.h>
28 #include <linux/slab.h>
29 #include <sound/soc.h>
30 #include <sound/initval.h>
31 #include <sound/tlv.h>
33 #define AK4642_VERSION "0.0.1"
73 #define AK4642_CACHEREGNUM 0x25
76 #define PMVCM (1 << 6) /* VCOM Power Management */
77 #define PMMIN (1 << 5) /* MIN Input Power Management */
78 #define PMDAC (1 << 2) /* DAC Power Management */
79 #define PMADL (1 << 0) /* MIC Amp Lch and ADC Lch Power Management */
82 #define HPMTN (1 << 6)
83 #define PMHPL (1 << 5)
84 #define PMHPR (1 << 4)
85 #define MS (1 << 3) /* master/slave select */
87 #define PMPLL (1 << 0)
89 #define PMHP_MASK (PMHPL | PMHPR)
90 #define PMHP PMHP_MASK
93 #define PMADR (1 << 0) /* MIC L / ADC R Power Management */
96 #define MINS (1 << 6) /* Switch from MIN to Speaker */
97 #define DACL (1 << 4) /* Switch from DAC to Stereo or Receiver */
98 #define PMMP (1 << 2) /* MPWR pin Power Management */
99 #define MGAIN0 (1 << 0) /* MIC amp gain*/
102 #define ZTM(param) ((param & 0x3) << 4) /* ALC Zoro Crossing TimeOut */
103 #define WTM(param) (((param & 0x4) << 4) | ((param & 0x3) << 2))
106 #define ALC (1 << 5) /* ALC Enable */
107 #define LMTH0 (1 << 0) /* ALC Limiter / Recovery Level */
110 #define PLL3 (1 << 7)
111 #define PLL2 (1 << 6)
112 #define PLL1 (1 << 5)
113 #define PLL0 (1 << 4)
114 #define PLL_MASK (PLL3 | PLL2 | PLL1 | PLL0)
116 #define BCKO_MASK (1 << 3)
117 #define BCKO_64 BCKO_MASK
119 #define DIF_MASK (3 << 0)
121 #define RIGHT_J (1 << 0)
122 #define LEFT_J (2 << 0)
130 #define FS_MASK (FS0 | FS1 | FS2 | FS3)
133 #define BST1 (1 << 3)
136 #define DACH (1 << 0)
139 * Playback Volume (table 39)
141 * max : 0x00 : +12.0 dB
143 * min : 0xFE : -115.0 dB
146 static const DECLARE_TLV_DB_SCALE(out_tlv, -11500, 50, 1);
148 static const struct snd_kcontrol_new ak4642_snd_controls[] = {
150 SOC_DOUBLE_R_TLV("Digital Playback Volume", L_DVC, R_DVC,
151 0, 0xFF, 1, out_tlv),
155 /* codec private data */
158 enum snd_soc_control_type control_type;
162 * ak4642 register cache
164 static const u8 ak4642_reg[AK4642_CACHEREGNUM] = {
165 0x00, 0x00, 0x01, 0x00,
166 0x02, 0x00, 0x00, 0x00,
167 0xe1, 0xe1, 0x18, 0x00,
168 0xe1, 0x18, 0x11, 0x08,
169 0x00, 0x00, 0x00, 0x00,
170 0x00, 0x00, 0x00, 0x00,
171 0x00, 0x00, 0x00, 0x00,
172 0x00, 0x00, 0x00, 0x00,
173 0x00, 0x00, 0x00, 0x00,
177 static int ak4642_dai_startup(struct snd_pcm_substream *substream,
178 struct snd_soc_dai *dai)
180 int is_play = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
181 struct snd_soc_codec *codec = dai->codec;
185 * start headphone output
188 * Audio I/F Format :MSB justified (ADC & DAC)
189 * Bass Boost Level : Middle
191 * This operation came from example code of
192 * "ASAHI KASEI AK4642" (japanese) manual p97.
194 snd_soc_update_bits(codec, MD_CTL4, DACH, DACH);
195 snd_soc_update_bits(codec, MD_CTL3, BST1, BST1);
196 snd_soc_write(codec, L_IVC, 0x91); /* volume */
197 snd_soc_write(codec, R_IVC, 0x91); /* volume */
198 snd_soc_update_bits(codec, PW_MGMT1, PMVCM | PMMIN | PMDAC,
199 PMVCM | PMMIN | PMDAC);
200 snd_soc_update_bits(codec, PW_MGMT2, PMHP_MASK, PMHP);
201 snd_soc_update_bits(codec, PW_MGMT2, HPMTN, HPMTN);
207 * Audio I/F Format:MSB justified (ADC & DAC)
210 * ALC setting:Refer to Table 35
213 * This operation came from example code of
214 * "ASAHI KASEI AK4642" (japanese) manual p94.
216 snd_soc_write(codec, SG_SL1, PMMP | MGAIN0);
217 snd_soc_write(codec, TIMER, ZTM(0x3) | WTM(0x3));
218 snd_soc_write(codec, ALC_CTL1, ALC | LMTH0);
219 snd_soc_update_bits(codec, PW_MGMT1, PMVCM | PMADL,
221 snd_soc_update_bits(codec, PW_MGMT3, PMADR, PMADR);
227 static void ak4642_dai_shutdown(struct snd_pcm_substream *substream,
228 struct snd_soc_dai *dai)
230 int is_play = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
231 struct snd_soc_codec *codec = dai->codec;
234 /* stop headphone output */
235 snd_soc_update_bits(codec, PW_MGMT2, HPMTN, 0);
236 snd_soc_update_bits(codec, PW_MGMT2, PMHP_MASK, 0);
237 snd_soc_update_bits(codec, PW_MGMT1, PMMIN | PMDAC, 0);
238 snd_soc_update_bits(codec, MD_CTL3, BST1, 0);
239 snd_soc_update_bits(codec, MD_CTL4, DACH, 0);
241 /* stop stereo input */
242 snd_soc_update_bits(codec, PW_MGMT1, PMADL, 0);
243 snd_soc_update_bits(codec, PW_MGMT3, PMADR, 0);
244 snd_soc_update_bits(codec, ALC_CTL1, ALC, 0);
248 static int ak4642_dai_set_sysclk(struct snd_soc_dai *codec_dai,
249 int clk_id, unsigned int freq, int dir)
251 struct snd_soc_codec *codec = codec_dai->codec;
265 pll = PLL2 | PLL1 | PLL0;
271 pll = PLL3 | PLL2 | PLL0;
276 snd_soc_update_bits(codec, MD_CTL1, PLL_MASK, pll);
281 static int ak4642_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
283 struct snd_soc_codec *codec = dai->codec;
287 data = MCKO | PMPLL; /* use MCKO */
290 /* set master/slave audio interface */
291 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
292 case SND_SOC_DAIFMT_CBM_CFM:
296 case SND_SOC_DAIFMT_CBS_CFS:
301 snd_soc_update_bits(codec, PW_MGMT2, MS | MCKO | PMPLL, data);
302 snd_soc_update_bits(codec, MD_CTL1, BCKO_MASK, bcko);
306 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
307 case SND_SOC_DAIFMT_LEFT_J:
310 case SND_SOC_DAIFMT_I2S:
314 * Please add RIGHT_J / DSP support here
320 snd_soc_update_bits(codec, MD_CTL1, DIF_MASK, data);
325 static int ak4642_dai_hw_params(struct snd_pcm_substream *substream,
326 struct snd_pcm_hw_params *params,
327 struct snd_soc_dai *dai)
329 struct snd_soc_codec *codec = dai->codec;
332 switch (params_rate(params)) {
352 rate = FS2 | FS1 | FS0;
358 rate = FS3 | FS2 | FS1;
364 rate = FS3 | FS2 | FS1 | FS0;
367 rate = FS3 | FS1 | FS0;
373 snd_soc_update_bits(codec, MD_CTL2, FS_MASK, rate);
378 static struct snd_soc_dai_ops ak4642_dai_ops = {
379 .startup = ak4642_dai_startup,
380 .shutdown = ak4642_dai_shutdown,
381 .set_sysclk = ak4642_dai_set_sysclk,
382 .set_fmt = ak4642_dai_set_fmt,
383 .hw_params = ak4642_dai_hw_params,
386 static struct snd_soc_dai_driver ak4642_dai = {
387 .name = "ak4642-hifi",
389 .stream_name = "Playback",
392 .rates = SNDRV_PCM_RATE_8000_48000,
393 .formats = SNDRV_PCM_FMTBIT_S16_LE },
395 .stream_name = "Capture",
398 .rates = SNDRV_PCM_RATE_8000_48000,
399 .formats = SNDRV_PCM_FMTBIT_S16_LE },
400 .ops = &ak4642_dai_ops,
401 .symmetric_rates = 1,
404 static int ak4642_resume(struct snd_soc_codec *codec)
406 snd_soc_cache_sync(codec);
411 static int ak4642_probe(struct snd_soc_codec *codec)
413 struct ak4642_priv *ak4642 = snd_soc_codec_get_drvdata(codec);
416 dev_info(codec->dev, "AK4642 Audio Codec %s", AK4642_VERSION);
418 ret = snd_soc_codec_set_cache_io(codec, 8, 8, ak4642->control_type);
420 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
424 snd_soc_add_controls(codec, ak4642_snd_controls,
425 ARRAY_SIZE(ak4642_snd_controls));
430 static struct snd_soc_codec_driver soc_codec_dev_ak4642 = {
431 .probe = ak4642_probe,
432 .resume = ak4642_resume,
433 .reg_cache_size = ARRAY_SIZE(ak4642_reg),
434 .reg_word_size = sizeof(u8),
435 .reg_cache_default = ak4642_reg,
438 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
439 static __devinit int ak4642_i2c_probe(struct i2c_client *i2c,
440 const struct i2c_device_id *id)
442 struct ak4642_priv *ak4642;
445 ak4642 = kzalloc(sizeof(struct ak4642_priv), GFP_KERNEL);
449 i2c_set_clientdata(i2c, ak4642);
450 ak4642->control_type = SND_SOC_I2C;
452 ret = snd_soc_register_codec(&i2c->dev,
453 &soc_codec_dev_ak4642, &ak4642_dai, 1);
459 static __devexit int ak4642_i2c_remove(struct i2c_client *client)
461 snd_soc_unregister_codec(&client->dev);
462 kfree(i2c_get_clientdata(client));
466 static const struct i2c_device_id ak4642_i2c_id[] = {
471 MODULE_DEVICE_TABLE(i2c, ak4642_i2c_id);
473 static struct i2c_driver ak4642_i2c_driver = {
475 .name = "ak4642-codec",
476 .owner = THIS_MODULE,
478 .probe = ak4642_i2c_probe,
479 .remove = __devexit_p(ak4642_i2c_remove),
480 .id_table = ak4642_i2c_id,
484 static int __init ak4642_modinit(void)
487 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
488 ret = i2c_add_driver(&ak4642_i2c_driver);
493 module_init(ak4642_modinit);
495 static void __exit ak4642_exit(void)
497 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
498 i2c_del_driver(&ak4642_i2c_driver);
502 module_exit(ak4642_exit);
504 MODULE_DESCRIPTION("Soc AK4642 driver");
505 MODULE_AUTHOR("Kuninori Morimoto <morimoto.kuninori@renesas.com>");
506 MODULE_LICENSE("GPL");