blob: e6d4ff9fd992015453c93746ec5018901bcdd008 [file] [log] [blame]
Timur Tabib0c813c2007-07-31 18:18:44 +02001/*
2 * CS4270 ALSA SoC (ASoC) codec driver
3 *
4 * Author: Timur Tabi <timur@freescale.com>
5 *
Timur Tabiff7bf022009-01-30 11:14:49 -06006 * Copyright 2007-2009 Freescale Semiconductor, Inc. This file is licensed
7 * under the terms of the GNU General Public License version 2. This
8 * program is licensed "as is" without any warranty of any kind, whether
9 * express or implied.
Timur Tabib0c813c2007-07-31 18:18:44 +020010 *
11 * This is an ASoC device driver for the Cirrus Logic CS4270 codec.
12 *
13 * Current features/limitations:
14 *
Daniel Mackb191f632009-03-08 17:51:52 +010015 * - Software mode is supported. Stand-alone mode is not supported.
16 * - Only I2C is supported, not SPI
17 * - Support for master and slave mode
18 * - The machine driver's 'startup' function must call
19 * cs4270_set_dai_sysclk() with the value of MCLK.
20 * - Only I2S and left-justified modes are supported
Daniel Mack5e7c0342009-05-06 01:26:01 +020021 * - Power management is supported
Timur Tabib0c813c2007-07-31 18:18:44 +020022 */
23
24#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/slab.h>
Timur Tabib0c813c2007-07-31 18:18:44 +020026#include <sound/core.h>
27#include <sound/soc.h>
28#include <sound/initval.h>
29#include <linux/i2c.h>
Daniel Mack5e7c0342009-05-06 01:26:01 +020030#include <linux/delay.h>
Daniel Mackffbfd332009-11-30 17:56:11 +010031#include <linux/regulator/consumer.h>
Daniel Mack85d07e42012-07-25 15:28:34 +020032#include <linux/of_device.h>
Daniel Mack02286192012-07-25 15:28:35 +020033#include <linux/of_gpio.h>
Timur Tabib0c813c2007-07-31 18:18:44 +020034
Timur Tabib0c813c2007-07-31 18:18:44 +020035/*
36 * The codec isn't really big-endian or little-endian, since the I2S
37 * interface requires data to be sent serially with the MSbit first.
38 * However, to support BE and LE I2S devices, we specify both here. That
39 * way, ALSA will always match the bit patterns.
40 */
41#define CS4270_FORMATS (SNDRV_PCM_FMTBIT_S8 | \
42 SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE | \
43 SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE | \
44 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE | \
45 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_3BE | \
46 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE)
47
Timur Tabib0c813c2007-07-31 18:18:44 +020048/* CS4270 registers addresses */
49#define CS4270_CHIPID 0x01 /* Chip ID */
50#define CS4270_PWRCTL 0x02 /* Power Control */
51#define CS4270_MODE 0x03 /* Mode Control */
52#define CS4270_FORMAT 0x04 /* Serial Format, ADC/DAC Control */
53#define CS4270_TRANS 0x05 /* Transition Control */
54#define CS4270_MUTE 0x06 /* Mute Control */
55#define CS4270_VOLA 0x07 /* DAC Channel A Volume Control */
56#define CS4270_VOLB 0x08 /* DAC Channel B Volume Control */
57
58#define CS4270_FIRSTREG 0x01
59#define CS4270_LASTREG 0x08
60#define CS4270_NUMREGS (CS4270_LASTREG - CS4270_FIRSTREG + 1)
Daniel Mack80ab8812009-05-05 11:25:00 +020061#define CS4270_I2C_INCR 0x80
Timur Tabib0c813c2007-07-31 18:18:44 +020062
63/* Bit masks for the CS4270 registers */
64#define CS4270_CHIPID_ID 0xF0
65#define CS4270_CHIPID_REV 0x0F
66#define CS4270_PWRCTL_FREEZE 0x80
67#define CS4270_PWRCTL_PDN_ADC 0x20
68#define CS4270_PWRCTL_PDN_DAC 0x02
69#define CS4270_PWRCTL_PDN 0x01
Daniel Mack5e7c0342009-05-06 01:26:01 +020070#define CS4270_PWRCTL_PDN_ALL \
71 (CS4270_PWRCTL_PDN_ADC | CS4270_PWRCTL_PDN_DAC | CS4270_PWRCTL_PDN)
Timur Tabib0c813c2007-07-31 18:18:44 +020072#define CS4270_MODE_SPEED_MASK 0x30
73#define CS4270_MODE_1X 0x00
74#define CS4270_MODE_2X 0x10
75#define CS4270_MODE_4X 0x20
76#define CS4270_MODE_SLAVE 0x30
77#define CS4270_MODE_DIV_MASK 0x0E
78#define CS4270_MODE_DIV1 0x00
79#define CS4270_MODE_DIV15 0x02
80#define CS4270_MODE_DIV2 0x04
81#define CS4270_MODE_DIV3 0x06
82#define CS4270_MODE_DIV4 0x08
83#define CS4270_MODE_POPGUARD 0x01
84#define CS4270_FORMAT_FREEZE_A 0x80
85#define CS4270_FORMAT_FREEZE_B 0x40
86#define CS4270_FORMAT_LOOPBACK 0x20
87#define CS4270_FORMAT_DAC_MASK 0x18
88#define CS4270_FORMAT_DAC_LJ 0x00
89#define CS4270_FORMAT_DAC_I2S 0x08
90#define CS4270_FORMAT_DAC_RJ16 0x18
91#define CS4270_FORMAT_DAC_RJ24 0x10
92#define CS4270_FORMAT_ADC_MASK 0x01
93#define CS4270_FORMAT_ADC_LJ 0x00
94#define CS4270_FORMAT_ADC_I2S 0x01
95#define CS4270_TRANS_ONE_VOL 0x80
96#define CS4270_TRANS_SOFT 0x40
97#define CS4270_TRANS_ZERO 0x20
98#define CS4270_TRANS_INV_ADC_A 0x08
99#define CS4270_TRANS_INV_ADC_B 0x10
100#define CS4270_TRANS_INV_DAC_A 0x02
101#define CS4270_TRANS_INV_DAC_B 0x04
102#define CS4270_TRANS_DEEMPH 0x01
103#define CS4270_MUTE_AUTO 0x20
104#define CS4270_MUTE_ADC_A 0x08
105#define CS4270_MUTE_ADC_B 0x10
106#define CS4270_MUTE_POLARITY 0x04
107#define CS4270_MUTE_DAC_A 0x01
108#define CS4270_MUTE_DAC_B 0x02
109
Timur Tabi11b8fca2011-01-10 13:28:32 -0600110/* Power-on default values for the registers
111 *
112 * This array contains the power-on default values of the registers, with the
113 * exception of the "CHIPID" register (01h). The lower four bits of that
114 * register contain the hardware revision, so it is treated as volatile.
Timur Tabi11b8fca2011-01-10 13:28:32 -0600115 */
Mark Brown1ca65172012-09-10 12:57:03 +0800116static const struct reg_default cs4270_reg_defaults[] = {
117 { 2, 0x00 },
118 { 3, 0x30 },
119 { 4, 0x00 },
120 { 5, 0x60 },
121 { 6, 0x20 },
122 { 7, 0x00 },
123 { 8, 0x00 },
Timur Tabi11b8fca2011-01-10 13:28:32 -0600124};
125
Daniel Mackffbfd332009-11-30 17:56:11 +0100126static const char *supply_names[] = {
127 "va", "vd", "vlc"
128};
129
Timur Tabi0db4d072009-01-23 16:31:19 -0600130/* Private data for the CS4270 */
131struct cs4270_private {
Mark Brown1ca65172012-09-10 12:57:03 +0800132 struct regmap *regmap;
Timur Tabi0db4d072009-01-23 16:31:19 -0600133 unsigned int mclk; /* Input frequency of the MCLK pin */
134 unsigned int mode; /* The mode (I2S or left-justified) */
Daniel Mack4eae0802009-02-25 14:37:21 +0100135 unsigned int slave_mode;
Daniel Mack1a4ba052009-04-24 16:37:45 +0200136 unsigned int manual_mute;
Daniel Mackffbfd332009-11-30 17:56:11 +0100137
138 /* power domain regulators */
139 struct regulator_bulk_data supplies[ARRAY_SIZE(supply_names)];
Timur Tabi0db4d072009-01-23 16:31:19 -0600140};
141
Mark Brown782fbab2013-08-11 12:29:07 +0100142static const struct snd_soc_dapm_widget cs4270_dapm_widgets[] = {
143SND_SOC_DAPM_INPUT("AINL"),
144SND_SOC_DAPM_INPUT("AINR"),
145
146SND_SOC_DAPM_OUTPUT("AOUTL"),
147SND_SOC_DAPM_OUTPUT("AOUTR"),
148};
149
150static const struct snd_soc_dapm_route cs4270_dapm_routes[] = {
151 { "Capture", NULL, "AINA" },
152 { "Capture", NULL, "AINB" },
153
154 { "AOUTA", NULL, "Playback" },
155 { "AOUTB", NULL, "Playback" },
156};
157
Timur Tabiff7bf022009-01-30 11:14:49 -0600158/**
159 * struct cs4270_mode_ratios - clock ratio tables
160 * @ratio: the ratio of MCLK to the sample rate
161 * @speed_mode: the Speed Mode bits to set in the Mode Control register for
162 * this ratio
163 * @mclk: the Ratio Select bits to set in the Mode Control register for this
164 * ratio
Timur Tabi84323952007-12-18 15:42:53 +0100165 *
166 * The data for this chart is taken from Table 5 of the CS4270 reference
167 * manual.
168 *
169 * This table is used to determine how to program the Mode Control register.
170 * It is also used by cs4270_set_dai_sysclk() to tell ALSA which sampling
171 * rates the CS4270 currently supports.
172 *
Timur Tabiff7bf022009-01-30 11:14:49 -0600173 * @speed_mode is the corresponding bit pattern to be written to the
Timur Tabi84323952007-12-18 15:42:53 +0100174 * MODE bits of the Mode Control Register
175 *
Timur Tabiff7bf022009-01-30 11:14:49 -0600176 * @mclk is the corresponding bit pattern to be wirten to the MCLK bits of
Timur Tabi84323952007-12-18 15:42:53 +0100177 * the Mode Control Register.
178 *
179 * In situations where a single ratio is represented by multiple speed
180 * modes, we favor the slowest speed. E.g, for a ratio of 128, we pick
181 * double-speed instead of quad-speed. However, the CS4270 errata states
Timur Tabiff7bf022009-01-30 11:14:49 -0600182 * that divide-By-1.5 can cause failures, so we avoid that mode where
Timur Tabi84323952007-12-18 15:42:53 +0100183 * possible.
184 *
Timur Tabiff7bf022009-01-30 11:14:49 -0600185 * Errata: There is an errata for the CS4270 where divide-by-1.5 does not
186 * work if Vd is 3.3V. If this effects you, select the
Timur Tabi84323952007-12-18 15:42:53 +0100187 * CONFIG_SND_SOC_CS4270_VD33_ERRATA Kconfig option, and the driver will
188 * never select any sample rates that require divide-by-1.5.
189 */
Timur Tabiff7bf022009-01-30 11:14:49 -0600190struct cs4270_mode_ratios {
Timur Tabi84323952007-12-18 15:42:53 +0100191 unsigned int ratio;
192 u8 speed_mode;
193 u8 mclk;
Timur Tabiff7bf022009-01-30 11:14:49 -0600194};
195
Timur Tabid9fb7fb2009-02-02 14:50:45 -0600196static struct cs4270_mode_ratios cs4270_mode_ratios[] = {
Timur Tabi84323952007-12-18 15:42:53 +0100197 {64, CS4270_MODE_4X, CS4270_MODE_DIV1},
198#ifndef CONFIG_SND_SOC_CS4270_VD33_ERRATA
199 {96, CS4270_MODE_4X, CS4270_MODE_DIV15},
200#endif
201 {128, CS4270_MODE_2X, CS4270_MODE_DIV1},
202 {192, CS4270_MODE_4X, CS4270_MODE_DIV3},
203 {256, CS4270_MODE_1X, CS4270_MODE_DIV1},
204 {384, CS4270_MODE_2X, CS4270_MODE_DIV3},
205 {512, CS4270_MODE_1X, CS4270_MODE_DIV2},
206 {768, CS4270_MODE_1X, CS4270_MODE_DIV3},
207 {1024, CS4270_MODE_1X, CS4270_MODE_DIV4}
208};
209
210/* The number of MCLK/LRCK ratios supported by the CS4270 */
211#define NUM_MCLK_RATIOS ARRAY_SIZE(cs4270_mode_ratios)
212
Mark Brown1ca65172012-09-10 12:57:03 +0800213static bool cs4270_reg_is_readable(struct device *dev, unsigned int reg)
Timur Tabi11b8fca2011-01-10 13:28:32 -0600214{
215 return (reg >= CS4270_FIRSTREG) && (reg <= CS4270_LASTREG);
216}
217
Mark Brown1ca65172012-09-10 12:57:03 +0800218static bool cs4270_reg_is_volatile(struct device *dev, unsigned int reg)
Timur Tabi11b8fca2011-01-10 13:28:32 -0600219{
220 /* Unreadable registers are considered volatile */
221 if ((reg < CS4270_FIRSTREG) || (reg > CS4270_LASTREG))
222 return 1;
223
224 return reg == CS4270_CHIPID;
225}
226
Timur Tabiff7bf022009-01-30 11:14:49 -0600227/**
228 * cs4270_set_dai_sysclk - determine the CS4270 samples rates.
229 * @codec_dai: the codec DAI
230 * @clk_id: the clock ID (ignored)
231 * @freq: the MCLK input frequency
232 * @dir: the clock direction (ignored)
Timur Tabi84323952007-12-18 15:42:53 +0100233 *
Timur Tabiff7bf022009-01-30 11:14:49 -0600234 * This function is used to tell the codec driver what the input MCLK
235 * frequency is.
Timur Tabi84323952007-12-18 15:42:53 +0100236 *
237 * The value of MCLK is used to determine which sample rates are supported
238 * by the CS4270. The ratio of MCLK / Fs must be equal to one of nine
Timur Tabiff7bf022009-01-30 11:14:49 -0600239 * supported values - 64, 96, 128, 192, 256, 384, 512, 768, and 1024.
Timur Tabi84323952007-12-18 15:42:53 +0100240 *
241 * This function calculates the nine ratios and determines which ones match
242 * a standard sample rate. If there's a match, then it is added to the list
Timur Tabiff7bf022009-01-30 11:14:49 -0600243 * of supported sample rates.
Timur Tabi84323952007-12-18 15:42:53 +0100244 *
245 * This function must be called by the machine driver's 'startup' function,
246 * otherwise the list of supported sample rates will not be available in
247 * time for ALSA.
Daniel Mack6aababd2010-01-15 17:36:48 +0100248 *
249 * For setups with variable MCLKs, pass 0 as 'freq' argument. This will cause
250 * theoretically possible sample rates to be enabled. Call it again with a
251 * proper value set one the external clock is set (most probably you would do
252 * that from a machine's driver 'hw_param' hook.
Timur Tabi84323952007-12-18 15:42:53 +0100253 */
Liam Girdwoode550e172008-07-07 16:07:52 +0100254static int cs4270_set_dai_sysclk(struct snd_soc_dai *codec_dai,
Timur Tabi84323952007-12-18 15:42:53 +0100255 int clk_id, unsigned int freq, int dir)
256{
257 struct snd_soc_codec *codec = codec_dai->codec;
Mark Brownb2c812e2010-04-14 15:35:19 +0900258 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Timur Tabi84323952007-12-18 15:42:53 +0100259
260 cs4270->mclk = freq;
Timur Tabi84323952007-12-18 15:42:53 +0100261 return 0;
262}
263
Timur Tabiff7bf022009-01-30 11:14:49 -0600264/**
265 * cs4270_set_dai_fmt - configure the codec for the selected audio format
266 * @codec_dai: the codec DAI
267 * @format: a SND_SOC_DAIFMT_x value indicating the data format
Timur Tabi84323952007-12-18 15:42:53 +0100268 *
269 * This function takes a bitmask of SND_SOC_DAIFMT_x bits and programs the
270 * codec accordingly.
271 *
272 * Currently, this function only supports SND_SOC_DAIFMT_I2S and
273 * SND_SOC_DAIFMT_LEFT_J. The CS4270 codec also supports right-justified
274 * data for playback only, but ASoC currently does not support different
275 * formats for playback vs. record.
276 */
Liam Girdwoode550e172008-07-07 16:07:52 +0100277static int cs4270_set_dai_fmt(struct snd_soc_dai *codec_dai,
Timur Tabi84323952007-12-18 15:42:53 +0100278 unsigned int format)
279{
280 struct snd_soc_codec *codec = codec_dai->codec;
Mark Brownb2c812e2010-04-14 15:35:19 +0900281 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Timur Tabi84323952007-12-18 15:42:53 +0100282
Daniel Mack4eae0802009-02-25 14:37:21 +0100283 /* set DAI format */
Timur Tabi84323952007-12-18 15:42:53 +0100284 switch (format & SND_SOC_DAIFMT_FORMAT_MASK) {
285 case SND_SOC_DAIFMT_I2S:
286 case SND_SOC_DAIFMT_LEFT_J:
287 cs4270->mode = format & SND_SOC_DAIFMT_FORMAT_MASK;
288 break;
289 default:
Timur Tabia6c255e2009-02-02 15:08:29 -0600290 dev_err(codec->dev, "invalid dai format\n");
Axel Linac601552011-10-06 07:29:56 +0800291 return -EINVAL;
Timur Tabi84323952007-12-18 15:42:53 +0100292 }
293
Daniel Mack4eae0802009-02-25 14:37:21 +0100294 /* set master/slave audio interface */
295 switch (format & SND_SOC_DAIFMT_MASTER_MASK) {
296 case SND_SOC_DAIFMT_CBS_CFS:
297 cs4270->slave_mode = 1;
298 break;
299 case SND_SOC_DAIFMT_CBM_CFM:
300 cs4270->slave_mode = 0;
301 break;
Daniel Mack4eae0802009-02-25 14:37:21 +0100302 default:
Daniel Mackff09d492009-02-28 13:21:03 +0100303 /* all other modes are unsupported by the hardware */
Axel Linac601552011-10-06 07:29:56 +0800304 dev_err(codec->dev, "Unknown master/slave configuration\n");
305 return -EINVAL;
Daniel Mack4eae0802009-02-25 14:37:21 +0100306 }
307
Axel Linac601552011-10-06 07:29:56 +0800308 return 0;
Timur Tabi84323952007-12-18 15:42:53 +0100309}
310
Timur Tabiff7bf022009-01-30 11:14:49 -0600311/**
Timur Tabiff7bf022009-01-30 11:14:49 -0600312 * cs4270_hw_params - program the CS4270 with the given hardware parameters.
313 * @substream: the audio stream
314 * @params: the hardware parameters to set
315 * @dai: the SOC DAI (ignored)
Timur Tabib0c813c2007-07-31 18:18:44 +0200316 *
Timur Tabiff7bf022009-01-30 11:14:49 -0600317 * This function programs the hardware with the values provided.
318 * Specifically, the sample rate and the data format.
319 *
320 * The .ops functions are used to provide board-specific data, like input
321 * frequencies, to this driver. This function takes that information,
Timur Tabib0c813c2007-07-31 18:18:44 +0200322 * combines it with the hardware parameters provided, and programs the
323 * hardware accordingly.
324 */
325static int cs4270_hw_params(struct snd_pcm_substream *substream,
Mark Browndee89c42008-11-18 22:11:38 +0000326 struct snd_pcm_hw_params *params,
327 struct snd_soc_dai *dai)
Timur Tabib0c813c2007-07-31 18:18:44 +0200328{
Mark Browne6968a12012-04-04 15:58:16 +0100329 struct snd_soc_codec *codec = dai->codec;
Mark Brownb2c812e2010-04-14 15:35:19 +0900330 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Roel Kluine34ba212008-04-17 18:58:34 +0200331 int ret;
Timur Tabib0c813c2007-07-31 18:18:44 +0200332 unsigned int i;
333 unsigned int rate;
334 unsigned int ratio;
335 int reg;
336
337 /* Figure out which MCLK/LRCK ratio to use */
338
339 rate = params_rate(params); /* Sampling rate, in Hz */
340 ratio = cs4270->mclk / rate; /* MCLK/LRCK ratio */
341
Timur Tabi9dbd6272007-08-01 12:22:07 +0200342 for (i = 0; i < NUM_MCLK_RATIOS; i++) {
Timur Tabi84323952007-12-18 15:42:53 +0100343 if (cs4270_mode_ratios[i].ratio == ratio)
Timur Tabib0c813c2007-07-31 18:18:44 +0200344 break;
345 }
346
Timur Tabi9dbd6272007-08-01 12:22:07 +0200347 if (i == NUM_MCLK_RATIOS) {
Timur Tabib0c813c2007-07-31 18:18:44 +0200348 /* We did not find a matching ratio */
Timur Tabia6c255e2009-02-02 15:08:29 -0600349 dev_err(codec->dev, "could not find matching ratio\n");
Timur Tabib0c813c2007-07-31 18:18:44 +0200350 return -EINVAL;
351 }
352
Timur Tabid5e9ba12009-02-03 11:09:32 -0600353 /* Set the sample rate */
Timur Tabib0c813c2007-07-31 18:18:44 +0200354
355 reg = snd_soc_read(codec, CS4270_MODE);
356 reg &= ~(CS4270_MODE_SPEED_MASK | CS4270_MODE_DIV_MASK);
Daniel Mack4eae0802009-02-25 14:37:21 +0100357 reg |= cs4270_mode_ratios[i].mclk;
358
359 if (cs4270->slave_mode)
360 reg |= CS4270_MODE_SLAVE;
361 else
362 reg |= cs4270_mode_ratios[i].speed_mode;
Timur Tabib0c813c2007-07-31 18:18:44 +0200363
364 ret = snd_soc_write(codec, CS4270_MODE, reg);
365 if (ret < 0) {
Timur Tabia6c255e2009-02-02 15:08:29 -0600366 dev_err(codec->dev, "i2c write failed\n");
Timur Tabib0c813c2007-07-31 18:18:44 +0200367 return ret;
368 }
369
Timur Tabid5e9ba12009-02-03 11:09:32 -0600370 /* Set the DAI format */
Timur Tabib0c813c2007-07-31 18:18:44 +0200371
372 reg = snd_soc_read(codec, CS4270_FORMAT);
373 reg &= ~(CS4270_FORMAT_DAC_MASK | CS4270_FORMAT_ADC_MASK);
374
375 switch (cs4270->mode) {
376 case SND_SOC_DAIFMT_I2S:
377 reg |= CS4270_FORMAT_DAC_I2S | CS4270_FORMAT_ADC_I2S;
378 break;
379 case SND_SOC_DAIFMT_LEFT_J:
380 reg |= CS4270_FORMAT_DAC_LJ | CS4270_FORMAT_ADC_LJ;
381 break;
382 default:
Timur Tabia6c255e2009-02-02 15:08:29 -0600383 dev_err(codec->dev, "unknown dai format\n");
Timur Tabib0c813c2007-07-31 18:18:44 +0200384 return -EINVAL;
385 }
386
387 ret = snd_soc_write(codec, CS4270_FORMAT, reg);
388 if (ret < 0) {
Timur Tabia6c255e2009-02-02 15:08:29 -0600389 dev_err(codec->dev, "i2c write failed\n");
Timur Tabib0c813c2007-07-31 18:18:44 +0200390 return ret;
391 }
392
Timur Tabib0c813c2007-07-31 18:18:44 +0200393 return ret;
394}
395
Timur Tabiff7bf022009-01-30 11:14:49 -0600396/**
Daniel Mack1a4ba052009-04-24 16:37:45 +0200397 * cs4270_dai_mute - enable/disable the CS4270 external mute
Timur Tabiff7bf022009-01-30 11:14:49 -0600398 * @dai: the SOC DAI
399 * @mute: 0 = disable mute, 1 = enable mute
Timur Tabib0c813c2007-07-31 18:18:44 +0200400 *
401 * This function toggles the mute bits in the MUTE register. The CS4270's
402 * mute capability is intended for external muting circuitry, so if the
403 * board does not have the MUTEA or MUTEB pins connected to such circuitry,
404 * then this function will do nothing.
405 */
Daniel Mack1a4ba052009-04-24 16:37:45 +0200406static int cs4270_dai_mute(struct snd_soc_dai *dai, int mute)
Timur Tabib0c813c2007-07-31 18:18:44 +0200407{
408 struct snd_soc_codec *codec = dai->codec;
Mark Brownb2c812e2010-04-14 15:35:19 +0900409 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Timur Tabib0c813c2007-07-31 18:18:44 +0200410 int reg6;
411
412 reg6 = snd_soc_read(codec, CS4270_MUTE);
413
414 if (mute)
Timur Tabid5e9ba12009-02-03 11:09:32 -0600415 reg6 |= CS4270_MUTE_DAC_A | CS4270_MUTE_DAC_B;
Daniel Mack1a4ba052009-04-24 16:37:45 +0200416 else {
Timur Tabid5e9ba12009-02-03 11:09:32 -0600417 reg6 &= ~(CS4270_MUTE_DAC_A | CS4270_MUTE_DAC_B);
Daniel Mack1a4ba052009-04-24 16:37:45 +0200418 reg6 |= cs4270->manual_mute;
419 }
Timur Tabib0c813c2007-07-31 18:18:44 +0200420
421 return snd_soc_write(codec, CS4270_MUTE, reg6);
422}
Timur Tabib0c813c2007-07-31 18:18:44 +0200423
Daniel Mack1a4ba052009-04-24 16:37:45 +0200424/**
425 * cs4270_soc_put_mute - put callback for the 'Master Playback switch'
426 * alsa control.
427 * @kcontrol: mixer control
428 * @ucontrol: control element information
429 *
430 * This function basically passes the arguments on to the generic
431 * snd_soc_put_volsw() function and saves the mute information in
432 * our private data structure. This is because we want to prevent
433 * cs4270_dai_mute() neglecting the user's decision to manually
434 * mute the codec's output.
435 *
436 * Returns 0 for success.
437 */
438static int cs4270_soc_put_mute(struct snd_kcontrol *kcontrol,
439 struct snd_ctl_elem_value *ucontrol)
440{
Lars-Peter Clausenea53bf72014-03-18 09:02:04 +0100441 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
Mark Brownb2c812e2010-04-14 15:35:19 +0900442 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Daniel Mack1a4ba052009-04-24 16:37:45 +0200443 int left = !ucontrol->value.integer.value[0];
444 int right = !ucontrol->value.integer.value[1];
445
446 cs4270->manual_mute = (left ? CS4270_MUTE_DAC_A : 0) |
447 (right ? CS4270_MUTE_DAC_B : 0);
448
449 return snd_soc_put_volsw(kcontrol, ucontrol);
450}
451
Timur Tabib0c813c2007-07-31 18:18:44 +0200452/* A list of non-DAPM controls that the CS4270 supports */
453static const struct snd_kcontrol_new cs4270_snd_controls[] = {
454 SOC_DOUBLE_R("Master Playback Volume",
Timur Tabid5e9ba12009-02-03 11:09:32 -0600455 CS4270_VOLA, CS4270_VOLB, 0, 0xFF, 1),
456 SOC_SINGLE("Digital Sidetone Switch", CS4270_FORMAT, 5, 1, 0),
457 SOC_SINGLE("Soft Ramp Switch", CS4270_TRANS, 6, 1, 0),
458 SOC_SINGLE("Zero Cross Switch", CS4270_TRANS, 5, 1, 0),
Daniel Mack7e1aa1d2009-10-29 02:24:32 +0100459 SOC_SINGLE("De-emphasis filter", CS4270_TRANS, 0, 1, 0),
Timur Tabid5e9ba12009-02-03 11:09:32 -0600460 SOC_SINGLE("Popguard Switch", CS4270_MODE, 0, 1, 1),
461 SOC_SINGLE("Auto-Mute Switch", CS4270_MUTE, 5, 1, 0),
Daniel Mack1a4ba052009-04-24 16:37:45 +0200462 SOC_DOUBLE("Master Capture Switch", CS4270_MUTE, 3, 4, 1, 1),
463 SOC_DOUBLE_EXT("Master Playback Switch", CS4270_MUTE, 0, 1, 1, 1,
464 snd_soc_get_volsw, cs4270_soc_put_mute),
Timur Tabib0c813c2007-07-31 18:18:44 +0200465};
466
Lars-Peter Clausen85e76522011-11-23 11:40:40 +0100467static const struct snd_soc_dai_ops cs4270_dai_ops = {
Eric Miao6335d052009-03-03 09:41:00 +0800468 .hw_params = cs4270_hw_params,
469 .set_sysclk = cs4270_set_dai_sysclk,
470 .set_fmt = cs4270_set_dai_fmt,
Daniel Mack1a4ba052009-04-24 16:37:45 +0200471 .digital_mute = cs4270_dai_mute,
Eric Miao6335d052009-03-03 09:41:00 +0800472};
473
Mark Brown5c758482010-10-06 16:18:17 -0700474static struct snd_soc_dai_driver cs4270_dai = {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000475 .name = "cs4270-hifi",
Timur Tabib0c813c2007-07-31 18:18:44 +0200476 .playback = {
477 .stream_name = "Playback",
Fabio Estevamf76fe052012-09-18 13:03:54 -0300478 .channels_min = 2,
Timur Tabib0c813c2007-07-31 18:18:44 +0200479 .channels_max = 2,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000480 .rates = SNDRV_PCM_RATE_CONTINUOUS,
481 .rate_min = 4000,
482 .rate_max = 216000,
Timur Tabib0c813c2007-07-31 18:18:44 +0200483 .formats = CS4270_FORMATS,
484 },
485 .capture = {
486 .stream_name = "Capture",
Fabio Estevamf76fe052012-09-18 13:03:54 -0300487 .channels_min = 2,
Timur Tabib0c813c2007-07-31 18:18:44 +0200488 .channels_max = 2,
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000489 .rates = SNDRV_PCM_RATE_CONTINUOUS,
490 .rate_min = 4000,
491 .rate_max = 216000,
Timur Tabib0c813c2007-07-31 18:18:44 +0200492 .formats = CS4270_FORMATS,
493 },
Eric Miao6335d052009-03-03 09:41:00 +0800494 .ops = &cs4270_dai_ops,
Timur Tabib0c813c2007-07-31 18:18:44 +0200495};
Timur Tabib0c813c2007-07-31 18:18:44 +0200496
Timur Tabiff7bf022009-01-30 11:14:49 -0600497/**
498 * cs4270_probe - ASoC probe function
499 * @pdev: platform device
500 *
501 * This function is called when ASoC has all the pieces it needs to
502 * instantiate a sound driver.
Timur Tabi04eb0932009-01-29 14:28:37 -0600503 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000504static int cs4270_probe(struct snd_soc_codec *codec)
Timur Tabi04eb0932009-01-29 14:28:37 -0600505{
Mark Brownb2c812e2010-04-14 15:35:19 +0900506 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Mark Brownb61d6d42012-09-10 12:53:12 +0800507 int ret;
Timur Tabi04eb0932009-01-29 14:28:37 -0600508
Timur Tabid5e9ba12009-02-03 11:09:32 -0600509 /* Disable auto-mute. This feature appears to be buggy. In some
510 * situations, auto-mute will not deactivate when it should, so we want
511 * this feature disabled by default. An application (e.g. alsactl) can
512 * re-enabled it by using the controls.
513 */
Timur Tabi11b8fca2011-01-10 13:28:32 -0600514 ret = snd_soc_update_bits(codec, CS4270_MUTE, CS4270_MUTE_AUTO, 0);
Timur Tabid5e9ba12009-02-03 11:09:32 -0600515 if (ret < 0) {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000516 dev_err(codec->dev, "i2c write failed\n");
Timur Tabid5e9ba12009-02-03 11:09:32 -0600517 return ret;
518 }
519
520 /* Disable automatic volume control. The hardware enables, and it
521 * causes volume change commands to be delayed, sometimes until after
522 * playback has started. An application (e.g. alsactl) can
523 * re-enabled it by using the controls.
524 */
Timur Tabi11b8fca2011-01-10 13:28:32 -0600525 ret = snd_soc_update_bits(codec, CS4270_TRANS,
526 CS4270_TRANS_SOFT | CS4270_TRANS_ZERO, 0);
Timur Tabid5e9ba12009-02-03 11:09:32 -0600527 if (ret < 0) {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000528 dev_err(codec->dev, "i2c write failed\n");
Timur Tabid5e9ba12009-02-03 11:09:32 -0600529 return ret;
530 }
531
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000532 ret = regulator_bulk_enable(ARRAY_SIZE(cs4270->supplies),
533 cs4270->supplies);
Jean Delvaree3145df2008-09-30 11:40:37 +0200534
Timur Tabib0c813c2007-07-31 18:18:44 +0200535 return ret;
536}
537
Timur Tabiff7bf022009-01-30 11:14:49 -0600538/**
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000539 * cs4270_remove - ASoC remove function
540 * @pdev: platform device
Timur Tabiff7bf022009-01-30 11:14:49 -0600541 *
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000542 * This function is the counterpart to cs4270_probe().
Timur Tabiff7bf022009-01-30 11:14:49 -0600543 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000544static int cs4270_remove(struct snd_soc_codec *codec)
Timur Tabib0c813c2007-07-31 18:18:44 +0200545{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000546 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Timur Tabib0c813c2007-07-31 18:18:44 +0200547
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000548 regulator_bulk_disable(ARRAY_SIZE(cs4270->supplies), cs4270->supplies);
Timur Tabib0c813c2007-07-31 18:18:44 +0200549
Timur Tabi0db4d072009-01-23 16:31:19 -0600550 return 0;
Timur Tabi0db4d072009-01-23 16:31:19 -0600551};
Timur Tabi0db4d072009-01-23 16:31:19 -0600552
Daniel Mack5e7c0342009-05-06 01:26:01 +0200553#ifdef CONFIG_PM
554
555/* This suspend/resume implementation can handle both - a simple standby
556 * where the codec remains powered, and a full suspend, where the voltage
557 * domain the codec is connected to is teared down and/or any other hardware
558 * reset condition is asserted.
559 *
560 * The codec's own power saving features are enabled in the suspend callback,
561 * and all registers are written back to the hardware when resuming.
562 */
563
Lars-Peter Clausen84b315e2011-12-02 10:18:28 +0100564static int cs4270_soc_suspend(struct snd_soc_codec *codec)
Daniel Mack15b5bda2009-08-05 20:50:43 +0200565{
Mark Brownb2c812e2010-04-14 15:35:19 +0900566 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Daniel Mackffbfd332009-11-30 17:56:11 +0100567 int reg, ret;
Daniel Mack15b5bda2009-08-05 20:50:43 +0200568
Daniel Mackffbfd332009-11-30 17:56:11 +0100569 reg = snd_soc_read(codec, CS4270_PWRCTL) | CS4270_PWRCTL_PDN_ALL;
570 if (reg < 0)
571 return reg;
572
573 ret = snd_soc_write(codec, CS4270_PWRCTL, reg);
574 if (ret < 0)
575 return ret;
576
577 regulator_bulk_disable(ARRAY_SIZE(cs4270->supplies),
578 cs4270->supplies);
579
580 return 0;
Daniel Mack15b5bda2009-08-05 20:50:43 +0200581}
582
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000583static int cs4270_soc_resume(struct snd_soc_codec *codec)
Daniel Mack15b5bda2009-08-05 20:50:43 +0200584{
Mark Brownb2c812e2010-04-14 15:35:19 +0900585 struct cs4270_private *cs4270 = snd_soc_codec_get_drvdata(codec);
Mark Brownab92d092012-03-19 16:15:43 +0000586 int reg, ret;
Daniel Mack5e7c0342009-05-06 01:26:01 +0200587
Mark Brownab92d092012-03-19 16:15:43 +0000588 ret = regulator_bulk_enable(ARRAY_SIZE(cs4270->supplies),
589 cs4270->supplies);
590 if (ret != 0)
591 return ret;
Daniel Mackffbfd332009-11-30 17:56:11 +0100592
Daniel Mack5e7c0342009-05-06 01:26:01 +0200593 /* In case the device was put to hard reset during sleep, we need to
594 * wait 500ns here before any I2C communication. */
595 ndelay(500);
596
597 /* first restore the entire register cache ... */
Mark Brown1ca65172012-09-10 12:57:03 +0800598 regcache_sync(cs4270->regmap);
Daniel Mack5e7c0342009-05-06 01:26:01 +0200599
600 /* ... then disable the power-down bits */
601 reg = snd_soc_read(codec, CS4270_PWRCTL);
602 reg &= ~CS4270_PWRCTL_PDN_ALL;
603
604 return snd_soc_write(codec, CS4270_PWRCTL, reg);
605}
606#else
Daniel Mack15b5bda2009-08-05 20:50:43 +0200607#define cs4270_soc_suspend NULL
608#define cs4270_soc_resume NULL
Daniel Mack5e7c0342009-05-06 01:26:01 +0200609#endif /* CONFIG_PM */
610
Timur Tabiff7bf022009-01-30 11:14:49 -0600611/*
Daniel Mackb6f7d7c2011-05-25 09:53:12 +0200612 * ASoC codec driver structure
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000613 */
Timur Tabi11b8fca2011-01-10 13:28:32 -0600614static const struct snd_soc_codec_driver soc_codec_device_cs4270 = {
615 .probe = cs4270_probe,
616 .remove = cs4270_remove,
617 .suspend = cs4270_soc_suspend,
618 .resume = cs4270_soc_resume,
Mark Brown19ace0e2012-09-10 12:48:11 +0800619
620 .controls = cs4270_snd_controls,
621 .num_controls = ARRAY_SIZE(cs4270_snd_controls),
Mark Brown782fbab2013-08-11 12:29:07 +0100622 .dapm_widgets = cs4270_dapm_widgets,
623 .num_dapm_widgets = ARRAY_SIZE(cs4270_dapm_widgets),
624 .dapm_routes = cs4270_dapm_routes,
625 .num_dapm_routes = ARRAY_SIZE(cs4270_dapm_routes),
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000626};
627
Daniel Mack85d07e42012-07-25 15:28:34 +0200628/*
629 * cs4270_of_match - the device tree bindings
630 */
631static const struct of_device_id cs4270_of_match[] = {
632 { .compatible = "cirrus,cs4270", },
633 { }
634};
635MODULE_DEVICE_TABLE(of, cs4270_of_match);
636
Mark Brown1ca65172012-09-10 12:57:03 +0800637static const struct regmap_config cs4270_regmap = {
638 .reg_bits = 8,
639 .val_bits = 8,
640 .max_register = CS4270_LASTREG,
641 .reg_defaults = cs4270_reg_defaults,
642 .num_reg_defaults = ARRAY_SIZE(cs4270_reg_defaults),
643 .cache_type = REGCACHE_RBTREE,
644
645 .readable_reg = cs4270_reg_is_readable,
646 .volatile_reg = cs4270_reg_is_volatile,
647};
648
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000649/**
650 * cs4270_i2c_probe - initialize the I2C interface of the CS4270
651 * @i2c_client: the I2C client object
652 * @id: the I2C device ID (ignored)
653 *
654 * This function is called whenever the I2C subsystem finds a device that
655 * matches the device ID given via a prior call to i2c_add_driver().
656 */
657static int cs4270_i2c_probe(struct i2c_client *i2c_client,
658 const struct i2c_device_id *id)
659{
Daniel Mack02286192012-07-25 15:28:35 +0200660 struct device_node *np = i2c_client->dev.of_node;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000661 struct cs4270_private *cs4270;
Mark Brown1ca65172012-09-10 12:57:03 +0800662 unsigned int val;
Mark Brownb61d6d42012-09-10 12:53:12 +0800663 int ret, i;
664
665 cs4270 = devm_kzalloc(&i2c_client->dev, sizeof(struct cs4270_private),
666 GFP_KERNEL);
Sachin Kamat0e0327f2014-06-20 15:28:57 +0530667 if (!cs4270)
Mark Brownb61d6d42012-09-10 12:53:12 +0800668 return -ENOMEM;
Mark Brownb61d6d42012-09-10 12:53:12 +0800669
670 /* get the power supply regulators */
671 for (i = 0; i < ARRAY_SIZE(supply_names); i++)
672 cs4270->supplies[i].supply = supply_names[i];
673
674 ret = devm_regulator_bulk_get(&i2c_client->dev,
675 ARRAY_SIZE(cs4270->supplies),
676 cs4270->supplies);
677 if (ret < 0)
678 return ret;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000679
Daniel Mack02286192012-07-25 15:28:35 +0200680 /* See if we have a way to bring the codec out of reset */
681 if (np) {
682 enum of_gpio_flags flags;
683 int gpio = of_get_named_gpio_flags(np, "reset-gpio", 0, &flags);
684
685 if (gpio_is_valid(gpio)) {
686 ret = devm_gpio_request_one(&i2c_client->dev, gpio,
687 flags & OF_GPIO_ACTIVE_LOW ?
688 GPIOF_OUT_INIT_LOW : GPIOF_OUT_INIT_HIGH,
689 "cs4270 reset");
690 if (ret < 0)
691 return ret;
692 }
693 }
694
Mark Brown1ca65172012-09-10 12:57:03 +0800695 cs4270->regmap = devm_regmap_init_i2c(i2c_client, &cs4270_regmap);
696 if (IS_ERR(cs4270->regmap))
697 return PTR_ERR(cs4270->regmap);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000698
Mark Brown1ca65172012-09-10 12:57:03 +0800699 /* Verify that we have a CS4270 */
700 ret = regmap_read(cs4270->regmap, CS4270_CHIPID, &val);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000701 if (ret < 0) {
702 dev_err(&i2c_client->dev, "failed to read i2c at addr %X\n",
703 i2c_client->addr);
704 return ret;
705 }
706 /* The top four bits of the chip ID should be 1100. */
Mark Brown1ca65172012-09-10 12:57:03 +0800707 if ((val & 0xF0) != 0xC0) {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000708 dev_err(&i2c_client->dev, "device at addr %X is not a CS4270\n",
709 i2c_client->addr);
710 return -ENODEV;
711 }
712
713 dev_info(&i2c_client->dev, "found device at i2c address %X\n",
714 i2c_client->addr);
Mark Brown1ca65172012-09-10 12:57:03 +0800715 dev_info(&i2c_client->dev, "hardware revision %X\n", val & 0xF);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000716
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000717 i2c_set_clientdata(i2c_client, cs4270);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000718
719 ret = snd_soc_register_codec(&i2c_client->dev,
720 &soc_codec_device_cs4270, &cs4270_dai, 1);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000721 return ret;
722}
723
724/**
725 * cs4270_i2c_remove - remove an I2C device
726 * @i2c_client: the I2C client object
727 *
728 * This function is the counterpart to cs4270_i2c_probe().
729 */
730static int cs4270_i2c_remove(struct i2c_client *i2c_client)
731{
732 snd_soc_unregister_codec(&i2c_client->dev);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000733 return 0;
734}
735
736/*
737 * cs4270_id - I2C device IDs supported by this driver
738 */
Axel Lin79a54ea2011-03-04 15:22:03 +0800739static const struct i2c_device_id cs4270_id[] = {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000740 {"cs4270", 0},
741 {}
742};
743MODULE_DEVICE_TABLE(i2c, cs4270_id);
744
745/*
Timur Tabiff7bf022009-01-30 11:14:49 -0600746 * cs4270_i2c_driver - I2C device identification
747 *
748 * This structure tells the I2C subsystem how to identify and support a
749 * given I2C device type.
750 */
Timur Tabi0db4d072009-01-23 16:31:19 -0600751static struct i2c_driver cs4270_i2c_driver = {
752 .driver = {
Shawn Guo64902b22012-02-24 22:09:38 +0800753 .name = "cs4270",
Timur Tabi0db4d072009-01-23 16:31:19 -0600754 .owner = THIS_MODULE,
Daniel Mack85d07e42012-07-25 15:28:34 +0200755 .of_match_table = cs4270_of_match,
Timur Tabi0db4d072009-01-23 16:31:19 -0600756 },
757 .id_table = cs4270_id,
758 .probe = cs4270_i2c_probe,
759 .remove = cs4270_i2c_remove,
760};
761
Sachin Kamat5e383f52012-08-06 17:25:41 +0530762module_i2c_driver(cs4270_i2c_driver);
Mark Brown64089b82008-12-08 19:17:58 +0000763
Timur Tabib0c813c2007-07-31 18:18:44 +0200764MODULE_AUTHOR("Timur Tabi <timur@freescale.com>");
765MODULE_DESCRIPTION("Cirrus Logic CS4270 ALSA SoC Codec Driver");
766MODULE_LICENSE("GPL");