2 * CS4270 ALSA SoC (ASoC) codec driver
4 * Author: Timur Tabi <timur@freescale.com>
6 * 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
11 * This is an ASoC device driver for the Cirrus Logic CS4270 codec.
13 * Current features/limitations:
15 * - 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
21 * - Power management is supported
24 #include <linux/module.h>
25 #include <linux/platform_device.h>
26 #include <sound/core.h>
27 #include <sound/soc.h>
28 #include <sound/initval.h>
29 #include <linux/i2c.h>
30 #include <linux/delay.h>
31 #include <linux/regulator/consumer.h>
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.
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)
48 /* 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 */
58 #define CS4270_FIRSTREG 0x01
59 #define CS4270_LASTREG 0x08
60 #define CS4270_NUMREGS (CS4270_LASTREG - CS4270_FIRSTREG + 1)
61 #define CS4270_I2C_INCR 0x80
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
70 #define CS4270_PWRCTL_PDN_ALL \
71 (CS4270_PWRCTL_PDN_ADC | CS4270_PWRCTL_PDN_DAC | CS4270_PWRCTL_PDN)
72 #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
110 static const char *supply_names
[] = {
114 /* Private data for the CS4270 */
115 struct cs4270_private
{
116 struct snd_soc_codec codec
;
117 u8 reg_cache
[CS4270_NUMREGS
];
118 unsigned int mclk
; /* Input frequency of the MCLK pin */
119 unsigned int mode
; /* The mode (I2S or left-justified) */
120 unsigned int slave_mode
;
121 unsigned int manual_mute
;
123 /* power domain regulators */
124 struct regulator_bulk_data supplies
[ARRAY_SIZE(supply_names
)];
128 * struct cs4270_mode_ratios - clock ratio tables
129 * @ratio: the ratio of MCLK to the sample rate
130 * @speed_mode: the Speed Mode bits to set in the Mode Control register for
132 * @mclk: the Ratio Select bits to set in the Mode Control register for this
135 * The data for this chart is taken from Table 5 of the CS4270 reference
138 * This table is used to determine how to program the Mode Control register.
139 * It is also used by cs4270_set_dai_sysclk() to tell ALSA which sampling
140 * rates the CS4270 currently supports.
142 * @speed_mode is the corresponding bit pattern to be written to the
143 * MODE bits of the Mode Control Register
145 * @mclk is the corresponding bit pattern to be wirten to the MCLK bits of
146 * the Mode Control Register.
148 * In situations where a single ratio is represented by multiple speed
149 * modes, we favor the slowest speed. E.g, for a ratio of 128, we pick
150 * double-speed instead of quad-speed. However, the CS4270 errata states
151 * that divide-By-1.5 can cause failures, so we avoid that mode where
154 * Errata: There is an errata for the CS4270 where divide-by-1.5 does not
155 * work if Vd is 3.3V. If this effects you, select the
156 * CONFIG_SND_SOC_CS4270_VD33_ERRATA Kconfig option, and the driver will
157 * never select any sample rates that require divide-by-1.5.
159 struct cs4270_mode_ratios
{
165 static struct cs4270_mode_ratios cs4270_mode_ratios
[] = {
166 {64, CS4270_MODE_4X
, CS4270_MODE_DIV1
},
167 #ifndef CONFIG_SND_SOC_CS4270_VD33_ERRATA
168 {96, CS4270_MODE_4X
, CS4270_MODE_DIV15
},
170 {128, CS4270_MODE_2X
, CS4270_MODE_DIV1
},
171 {192, CS4270_MODE_4X
, CS4270_MODE_DIV3
},
172 {256, CS4270_MODE_1X
, CS4270_MODE_DIV1
},
173 {384, CS4270_MODE_2X
, CS4270_MODE_DIV3
},
174 {512, CS4270_MODE_1X
, CS4270_MODE_DIV2
},
175 {768, CS4270_MODE_1X
, CS4270_MODE_DIV3
},
176 {1024, CS4270_MODE_1X
, CS4270_MODE_DIV4
}
179 /* The number of MCLK/LRCK ratios supported by the CS4270 */
180 #define NUM_MCLK_RATIOS ARRAY_SIZE(cs4270_mode_ratios)
183 * cs4270_set_dai_sysclk - determine the CS4270 samples rates.
184 * @codec_dai: the codec DAI
185 * @clk_id: the clock ID (ignored)
186 * @freq: the MCLK input frequency
187 * @dir: the clock direction (ignored)
189 * This function is used to tell the codec driver what the input MCLK
192 * The value of MCLK is used to determine which sample rates are supported
193 * by the CS4270. The ratio of MCLK / Fs must be equal to one of nine
194 * supported values - 64, 96, 128, 192, 256, 384, 512, 768, and 1024.
196 * This function calculates the nine ratios and determines which ones match
197 * a standard sample rate. If there's a match, then it is added to the list
198 * of supported sample rates.
200 * This function must be called by the machine driver's 'startup' function,
201 * otherwise the list of supported sample rates will not be available in
204 * For setups with variable MCLKs, pass 0 as 'freq' argument. This will cause
205 * theoretically possible sample rates to be enabled. Call it again with a
206 * proper value set one the external clock is set (most probably you would do
207 * that from a machine's driver 'hw_param' hook.
209 static int cs4270_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
210 int clk_id
, unsigned int freq
, int dir
)
212 struct snd_soc_codec
*codec
= codec_dai
->codec
;
213 struct cs4270_private
*cs4270
= codec
->private_data
;
214 unsigned int rates
= 0;
215 unsigned int rate_min
= -1;
216 unsigned int rate_max
= 0;
222 for (i
= 0; i
< NUM_MCLK_RATIOS
; i
++) {
223 unsigned int rate
= freq
/ cs4270_mode_ratios
[i
].ratio
;
224 rates
|= snd_pcm_rate_to_rate_bit(rate
);
230 /* FIXME: soc should support a rate list */
231 rates
&= ~SNDRV_PCM_RATE_KNOT
;
234 dev_err(codec
->dev
, "could not find a valid sample rate\n");
238 /* enable all possible rates */
239 rates
= SNDRV_PCM_RATE_8000_192000
;
244 codec_dai
->playback
.rates
= rates
;
245 codec_dai
->playback
.rate_min
= rate_min
;
246 codec_dai
->playback
.rate_max
= rate_max
;
248 codec_dai
->capture
.rates
= rates
;
249 codec_dai
->capture
.rate_min
= rate_min
;
250 codec_dai
->capture
.rate_max
= rate_max
;
256 * cs4270_set_dai_fmt - configure the codec for the selected audio format
257 * @codec_dai: the codec DAI
258 * @format: a SND_SOC_DAIFMT_x value indicating the data format
260 * This function takes a bitmask of SND_SOC_DAIFMT_x bits and programs the
263 * Currently, this function only supports SND_SOC_DAIFMT_I2S and
264 * SND_SOC_DAIFMT_LEFT_J. The CS4270 codec also supports right-justified
265 * data for playback only, but ASoC currently does not support different
266 * formats for playback vs. record.
268 static int cs4270_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
271 struct snd_soc_codec
*codec
= codec_dai
->codec
;
272 struct cs4270_private
*cs4270
= codec
->private_data
;
276 switch (format
& SND_SOC_DAIFMT_FORMAT_MASK
) {
277 case SND_SOC_DAIFMT_I2S
:
278 case SND_SOC_DAIFMT_LEFT_J
:
279 cs4270
->mode
= format
& SND_SOC_DAIFMT_FORMAT_MASK
;
282 dev_err(codec
->dev
, "invalid dai format\n");
286 /* set master/slave audio interface */
287 switch (format
& SND_SOC_DAIFMT_MASTER_MASK
) {
288 case SND_SOC_DAIFMT_CBS_CFS
:
289 cs4270
->slave_mode
= 1;
291 case SND_SOC_DAIFMT_CBM_CFM
:
292 cs4270
->slave_mode
= 0;
295 /* all other modes are unsupported by the hardware */
303 * cs4270_fill_cache - pre-fill the CS4270 register cache.
304 * @codec: the codec for this CS4270
306 * This function fills in the CS4270 register cache by reading the register
307 * values from the hardware.
309 * This CS4270 registers are cached to avoid excessive I2C I/O operations.
310 * After the initial read to pre-fill the cache, the CS4270 never updates
311 * the register values, so we won't have a cache coherency problem.
313 * We use the auto-increment feature of the CS4270 to read all registers in
316 static int cs4270_fill_cache(struct snd_soc_codec
*codec
)
318 u8
*cache
= codec
->reg_cache
;
319 struct i2c_client
*i2c_client
= codec
->control_data
;
322 length
= i2c_smbus_read_i2c_block_data(i2c_client
,
323 CS4270_FIRSTREG
| CS4270_I2C_INCR
, CS4270_NUMREGS
, cache
);
325 if (length
!= CS4270_NUMREGS
) {
326 dev_err(codec
->dev
, "i2c read failure, addr=0x%x\n",
335 * cs4270_read_reg_cache - read from the CS4270 register cache.
336 * @codec: the codec for this CS4270
337 * @reg: the register to read
339 * This function returns the value for a given register. It reads only from
340 * the register cache, not the hardware itself.
342 * This CS4270 registers are cached to avoid excessive I2C I/O operations.
343 * After the initial read to pre-fill the cache, the CS4270 never updates
344 * the register values, so we won't have a cache coherency problem.
346 static unsigned int cs4270_read_reg_cache(struct snd_soc_codec
*codec
,
349 u8
*cache
= codec
->reg_cache
;
351 if ((reg
< CS4270_FIRSTREG
) || (reg
> CS4270_LASTREG
))
354 return cache
[reg
- CS4270_FIRSTREG
];
358 * cs4270_i2c_write - write to a CS4270 register via the I2C bus.
359 * @codec: the codec for this CS4270
360 * @reg: the register to write
361 * @value: the value to write to the register
363 * This function writes the given value to the given CS4270 register, and
364 * also updates the register cache.
366 * Note that we don't use the hw_write function pointer of snd_soc_codec.
367 * That's because it's too clunky: the hw_write_t prototype does not match
368 * i2c_smbus_write_byte_data(), and it's just another layer of overhead.
370 static int cs4270_i2c_write(struct snd_soc_codec
*codec
, unsigned int reg
,
373 u8
*cache
= codec
->reg_cache
;
375 if ((reg
< CS4270_FIRSTREG
) || (reg
> CS4270_LASTREG
))
378 /* Only perform an I2C operation if the new value is different */
379 if (cache
[reg
- CS4270_FIRSTREG
] != value
) {
380 struct i2c_client
*client
= codec
->control_data
;
381 if (i2c_smbus_write_byte_data(client
, reg
, value
)) {
382 dev_err(codec
->dev
, "i2c write failed\n");
386 /* We've written to the hardware, so update the cache */
387 cache
[reg
- CS4270_FIRSTREG
] = value
;
394 * cs4270_hw_params - program the CS4270 with the given hardware parameters.
395 * @substream: the audio stream
396 * @params: the hardware parameters to set
397 * @dai: the SOC DAI (ignored)
399 * This function programs the hardware with the values provided.
400 * Specifically, the sample rate and the data format.
402 * The .ops functions are used to provide board-specific data, like input
403 * frequencies, to this driver. This function takes that information,
404 * combines it with the hardware parameters provided, and programs the
405 * hardware accordingly.
407 static int cs4270_hw_params(struct snd_pcm_substream
*substream
,
408 struct snd_pcm_hw_params
*params
,
409 struct snd_soc_dai
*dai
)
411 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
412 struct snd_soc_device
*socdev
= rtd
->socdev
;
413 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
414 struct cs4270_private
*cs4270
= codec
->private_data
;
421 /* Figure out which MCLK/LRCK ratio to use */
423 rate
= params_rate(params
); /* Sampling rate, in Hz */
424 ratio
= cs4270
->mclk
/ rate
; /* MCLK/LRCK ratio */
426 for (i
= 0; i
< NUM_MCLK_RATIOS
; i
++) {
427 if (cs4270_mode_ratios
[i
].ratio
== ratio
)
431 if (i
== NUM_MCLK_RATIOS
) {
432 /* We did not find a matching ratio */
433 dev_err(codec
->dev
, "could not find matching ratio\n");
437 /* Set the sample rate */
439 reg
= snd_soc_read(codec
, CS4270_MODE
);
440 reg
&= ~(CS4270_MODE_SPEED_MASK
| CS4270_MODE_DIV_MASK
);
441 reg
|= cs4270_mode_ratios
[i
].mclk
;
443 if (cs4270
->slave_mode
)
444 reg
|= CS4270_MODE_SLAVE
;
446 reg
|= cs4270_mode_ratios
[i
].speed_mode
;
448 ret
= snd_soc_write(codec
, CS4270_MODE
, reg
);
450 dev_err(codec
->dev
, "i2c write failed\n");
454 /* Set the DAI format */
456 reg
= snd_soc_read(codec
, CS4270_FORMAT
);
457 reg
&= ~(CS4270_FORMAT_DAC_MASK
| CS4270_FORMAT_ADC_MASK
);
459 switch (cs4270
->mode
) {
460 case SND_SOC_DAIFMT_I2S
:
461 reg
|= CS4270_FORMAT_DAC_I2S
| CS4270_FORMAT_ADC_I2S
;
463 case SND_SOC_DAIFMT_LEFT_J
:
464 reg
|= CS4270_FORMAT_DAC_LJ
| CS4270_FORMAT_ADC_LJ
;
467 dev_err(codec
->dev
, "unknown dai format\n");
471 ret
= snd_soc_write(codec
, CS4270_FORMAT
, reg
);
473 dev_err(codec
->dev
, "i2c write failed\n");
481 * cs4270_dai_mute - enable/disable the CS4270 external mute
483 * @mute: 0 = disable mute, 1 = enable mute
485 * This function toggles the mute bits in the MUTE register. The CS4270's
486 * mute capability is intended for external muting circuitry, so if the
487 * board does not have the MUTEA or MUTEB pins connected to such circuitry,
488 * then this function will do nothing.
490 static int cs4270_dai_mute(struct snd_soc_dai
*dai
, int mute
)
492 struct snd_soc_codec
*codec
= dai
->codec
;
493 struct cs4270_private
*cs4270
= codec
->private_data
;
496 reg6
= snd_soc_read(codec
, CS4270_MUTE
);
499 reg6
|= CS4270_MUTE_DAC_A
| CS4270_MUTE_DAC_B
;
501 reg6
&= ~(CS4270_MUTE_DAC_A
| CS4270_MUTE_DAC_B
);
502 reg6
|= cs4270
->manual_mute
;
505 return snd_soc_write(codec
, CS4270_MUTE
, reg6
);
509 * cs4270_soc_put_mute - put callback for the 'Master Playback switch'
511 * @kcontrol: mixer control
512 * @ucontrol: control element information
514 * This function basically passes the arguments on to the generic
515 * snd_soc_put_volsw() function and saves the mute information in
516 * our private data structure. This is because we want to prevent
517 * cs4270_dai_mute() neglecting the user's decision to manually
518 * mute the codec's output.
520 * Returns 0 for success.
522 static int cs4270_soc_put_mute(struct snd_kcontrol
*kcontrol
,
523 struct snd_ctl_elem_value
*ucontrol
)
525 struct snd_soc_codec
*codec
= snd_kcontrol_chip(kcontrol
);
526 struct cs4270_private
*cs4270
= codec
->private_data
;
527 int left
= !ucontrol
->value
.integer
.value
[0];
528 int right
= !ucontrol
->value
.integer
.value
[1];
530 cs4270
->manual_mute
= (left
? CS4270_MUTE_DAC_A
: 0) |
531 (right
? CS4270_MUTE_DAC_B
: 0);
533 return snd_soc_put_volsw(kcontrol
, ucontrol
);
536 /* A list of non-DAPM controls that the CS4270 supports */
537 static const struct snd_kcontrol_new cs4270_snd_controls
[] = {
538 SOC_DOUBLE_R("Master Playback Volume",
539 CS4270_VOLA
, CS4270_VOLB
, 0, 0xFF, 1),
540 SOC_SINGLE("Digital Sidetone Switch", CS4270_FORMAT
, 5, 1, 0),
541 SOC_SINGLE("Soft Ramp Switch", CS4270_TRANS
, 6, 1, 0),
542 SOC_SINGLE("Zero Cross Switch", CS4270_TRANS
, 5, 1, 0),
543 SOC_SINGLE("De-emphasis filter", CS4270_TRANS
, 0, 1, 0),
544 SOC_SINGLE("Popguard Switch", CS4270_MODE
, 0, 1, 1),
545 SOC_SINGLE("Auto-Mute Switch", CS4270_MUTE
, 5, 1, 0),
546 SOC_DOUBLE("Master Capture Switch", CS4270_MUTE
, 3, 4, 1, 1),
547 SOC_DOUBLE_EXT("Master Playback Switch", CS4270_MUTE
, 0, 1, 1, 1,
548 snd_soc_get_volsw
, cs4270_soc_put_mute
),
552 * cs4270_codec - global variable to store codec for the ASoC probe function
554 * If struct i2c_driver had a private_data field, we wouldn't need to use
555 * cs4270_codec. This is the only way to pass the codec structure from
556 * cs4270_i2c_probe() to cs4270_probe(). Unfortunately, there is no good
557 * way to synchronize these two functions. cs4270_i2c_probe() can be called
558 * multiple times before cs4270_probe() is called even once. So for now, we
559 * also only allow cs4270_i2c_probe() to be run once. That means that we do
560 * not support more than one cs4270 device in the system, at least for now.
562 static struct snd_soc_codec
*cs4270_codec
;
564 static struct snd_soc_dai_ops cs4270_dai_ops
= {
565 .hw_params
= cs4270_hw_params
,
566 .set_sysclk
= cs4270_set_dai_sysclk
,
567 .set_fmt
= cs4270_set_dai_fmt
,
568 .digital_mute
= cs4270_dai_mute
,
571 struct snd_soc_dai cs4270_dai
= {
574 .stream_name
= "Playback",
578 .formats
= CS4270_FORMATS
,
581 .stream_name
= "Capture",
585 .formats
= CS4270_FORMATS
,
587 .ops
= &cs4270_dai_ops
,
589 EXPORT_SYMBOL_GPL(cs4270_dai
);
592 * cs4270_probe - ASoC probe function
593 * @pdev: platform device
595 * This function is called when ASoC has all the pieces it needs to
596 * instantiate a sound driver.
598 static int cs4270_probe(struct platform_device
*pdev
)
600 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
601 struct snd_soc_codec
*codec
= cs4270_codec
;
602 struct cs4270_private
*cs4270
= codec
->private_data
;
605 /* Connect the codec to the socdev. snd_soc_new_pcms() needs this. */
606 socdev
->card
->codec
= codec
;
609 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
611 dev_err(codec
->dev
, "failed to create pcms\n");
615 /* Add the non-DAPM controls */
616 ret
= snd_soc_add_controls(codec
, cs4270_snd_controls
,
617 ARRAY_SIZE(cs4270_snd_controls
));
619 dev_err(codec
->dev
, "failed to add controls\n");
620 goto error_free_pcms
;
623 /* get the power supply regulators */
624 for (i
= 0; i
< ARRAY_SIZE(supply_names
); i
++)
625 cs4270
->supplies
[i
].supply
= supply_names
[i
];
627 ret
= regulator_bulk_get(codec
->dev
, ARRAY_SIZE(cs4270
->supplies
),
630 goto error_free_pcms
;
632 ret
= regulator_bulk_enable(ARRAY_SIZE(cs4270
->supplies
),
635 goto error_free_regulators
;
639 error_free_regulators
:
640 regulator_bulk_free(ARRAY_SIZE(cs4270
->supplies
),
644 snd_soc_free_pcms(socdev
);
650 * cs4270_remove - ASoC remove function
651 * @pdev: platform device
653 * This function is the counterpart to cs4270_probe().
655 static int cs4270_remove(struct platform_device
*pdev
)
657 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
658 struct snd_soc_codec
*codec
= cs4270_codec
;
659 struct cs4270_private
*cs4270
= codec
->private_data
;
661 snd_soc_free_pcms(socdev
);
662 regulator_bulk_disable(ARRAY_SIZE(cs4270
->supplies
), cs4270
->supplies
);
663 regulator_bulk_free(ARRAY_SIZE(cs4270
->supplies
), cs4270
->supplies
);
669 * cs4270_i2c_probe - initialize the I2C interface of the CS4270
670 * @i2c_client: the I2C client object
671 * @id: the I2C device ID (ignored)
673 * This function is called whenever the I2C subsystem finds a device that
674 * matches the device ID given via a prior call to i2c_add_driver().
676 static int cs4270_i2c_probe(struct i2c_client
*i2c_client
,
677 const struct i2c_device_id
*id
)
679 struct snd_soc_codec
*codec
;
680 struct cs4270_private
*cs4270
;
684 /* For now, we only support one cs4270 device in the system. See the
685 * comment for cs4270_codec.
688 dev_err(&i2c_client
->dev
, "ignoring CS4270 at addr %X\n",
690 dev_err(&i2c_client
->dev
, "only one per board allowed\n");
691 /* Should we return something other than ENODEV here? */
695 /* Verify that we have a CS4270 */
697 ret
= i2c_smbus_read_byte_data(i2c_client
, CS4270_CHIPID
);
699 dev_err(&i2c_client
->dev
, "failed to read i2c at addr %X\n",
703 /* The top four bits of the chip ID should be 1100. */
704 if ((ret
& 0xF0) != 0xC0) {
705 dev_err(&i2c_client
->dev
, "device at addr %X is not a CS4270\n",
710 dev_info(&i2c_client
->dev
, "found device at i2c address %X\n",
712 dev_info(&i2c_client
->dev
, "hardware revision %X\n", ret
& 0xF);
714 /* Allocate enough space for the snd_soc_codec structure
715 and our private data together. */
716 cs4270
= kzalloc(sizeof(struct cs4270_private
), GFP_KERNEL
);
718 dev_err(&i2c_client
->dev
, "could not allocate codec\n");
721 codec
= &cs4270
->codec
;
723 mutex_init(&codec
->mutex
);
724 INIT_LIST_HEAD(&codec
->dapm_widgets
);
725 INIT_LIST_HEAD(&codec
->dapm_paths
);
727 codec
->dev
= &i2c_client
->dev
;
728 codec
->name
= "CS4270";
729 codec
->owner
= THIS_MODULE
;
730 codec
->dai
= &cs4270_dai
;
732 codec
->private_data
= cs4270
;
733 codec
->control_data
= i2c_client
;
734 codec
->read
= cs4270_read_reg_cache
;
735 codec
->write
= cs4270_i2c_write
;
736 codec
->reg_cache
= cs4270
->reg_cache
;
737 codec
->reg_cache_size
= CS4270_NUMREGS
;
739 /* The I2C interface is set up, so pre-fill our register cache */
741 ret
= cs4270_fill_cache(codec
);
743 dev_err(&i2c_client
->dev
, "failed to fill register cache\n");
744 goto error_free_codec
;
747 /* Disable auto-mute. This feature appears to be buggy. In some
748 * situations, auto-mute will not deactivate when it should, so we want
749 * this feature disabled by default. An application (e.g. alsactl) can
750 * re-enabled it by using the controls.
753 reg
= cs4270_read_reg_cache(codec
, CS4270_MUTE
);
754 reg
&= ~CS4270_MUTE_AUTO
;
755 ret
= cs4270_i2c_write(codec
, CS4270_MUTE
, reg
);
757 dev_err(&i2c_client
->dev
, "i2c write failed\n");
761 /* Disable automatic volume control. The hardware enables, and it
762 * causes volume change commands to be delayed, sometimes until after
763 * playback has started. An application (e.g. alsactl) can
764 * re-enabled it by using the controls.
767 reg
= cs4270_read_reg_cache(codec
, CS4270_TRANS
);
768 reg
&= ~(CS4270_TRANS_SOFT
| CS4270_TRANS_ZERO
);
769 ret
= cs4270_i2c_write(codec
, CS4270_TRANS
, reg
);
771 dev_err(&i2c_client
->dev
, "i2c write failed\n");
775 /* Initialize the DAI. Normally, we'd prefer to have a kmalloc'd DAI
776 * structure for each CS4270 device, but the machine driver needs to
777 * have a pointer to the DAI structure, so for now it must be a global
780 cs4270_dai
.dev
= &i2c_client
->dev
;
782 /* Register the DAI. If all the other ASoC driver have already
783 * registered, then this will call our probe function, so
784 * cs4270_codec needs to be ready.
786 cs4270_codec
= codec
;
787 ret
= snd_soc_register_dai(&cs4270_dai
);
789 dev_err(&i2c_client
->dev
, "failed to register DAIe\n");
790 goto error_free_codec
;
793 i2c_set_clientdata(i2c_client
, cs4270
);
800 cs4270_dai
.dev
= NULL
;
806 * cs4270_i2c_remove - remove an I2C device
807 * @i2c_client: the I2C client object
809 * This function is the counterpart to cs4270_i2c_probe().
811 static int cs4270_i2c_remove(struct i2c_client
*i2c_client
)
813 struct cs4270_private
*cs4270
= i2c_get_clientdata(i2c_client
);
817 cs4270_dai
.dev
= NULL
;
823 * cs4270_id - I2C device IDs supported by this driver
825 static struct i2c_device_id cs4270_id
[] = {
829 MODULE_DEVICE_TABLE(i2c
, cs4270_id
);
833 /* This suspend/resume implementation can handle both - a simple standby
834 * where the codec remains powered, and a full suspend, where the voltage
835 * domain the codec is connected to is teared down and/or any other hardware
836 * reset condition is asserted.
838 * The codec's own power saving features are enabled in the suspend callback,
839 * and all registers are written back to the hardware when resuming.
842 static int cs4270_soc_suspend(struct platform_device
*pdev
, pm_message_t mesg
)
844 struct snd_soc_codec
*codec
= cs4270_codec
;
845 struct cs4270_private
*cs4270
= codec
->private_data
;
848 reg
= snd_soc_read(codec
, CS4270_PWRCTL
) | CS4270_PWRCTL_PDN_ALL
;
852 ret
= snd_soc_write(codec
, CS4270_PWRCTL
, reg
);
856 regulator_bulk_disable(ARRAY_SIZE(cs4270
->supplies
),
862 static int cs4270_soc_resume(struct platform_device
*pdev
)
864 struct snd_soc_codec
*codec
= cs4270_codec
;
865 struct cs4270_private
*cs4270
= codec
->private_data
;
866 struct i2c_client
*i2c_client
= codec
->control_data
;
869 regulator_bulk_enable(ARRAY_SIZE(cs4270
->supplies
),
872 /* In case the device was put to hard reset during sleep, we need to
873 * wait 500ns here before any I2C communication. */
876 /* first restore the entire register cache ... */
877 for (reg
= CS4270_FIRSTREG
; reg
<= CS4270_LASTREG
; reg
++) {
878 u8 val
= snd_soc_read(codec
, reg
);
880 if (i2c_smbus_write_byte_data(i2c_client
, reg
, val
)) {
881 dev_err(codec
->dev
, "i2c write failed\n");
886 /* ... then disable the power-down bits */
887 reg
= snd_soc_read(codec
, CS4270_PWRCTL
);
888 reg
&= ~CS4270_PWRCTL_PDN_ALL
;
890 return snd_soc_write(codec
, CS4270_PWRCTL
, reg
);
893 #define cs4270_soc_suspend NULL
894 #define cs4270_soc_resume NULL
895 #endif /* CONFIG_PM */
898 * cs4270_i2c_driver - I2C device identification
900 * This structure tells the I2C subsystem how to identify and support a
901 * given I2C device type.
903 static struct i2c_driver cs4270_i2c_driver
= {
906 .owner
= THIS_MODULE
,
908 .id_table
= cs4270_id
,
909 .probe
= cs4270_i2c_probe
,
910 .remove
= cs4270_i2c_remove
,
914 * ASoC codec device structure
916 * Assign this variable to the codec_dev field of the machine driver's
917 * snd_soc_device structure.
919 struct snd_soc_codec_device soc_codec_device_cs4270
= {
920 .probe
= cs4270_probe
,
921 .remove
= cs4270_remove
,
922 .suspend
= cs4270_soc_suspend
,
923 .resume
= cs4270_soc_resume
,
925 EXPORT_SYMBOL_GPL(soc_codec_device_cs4270
);
927 static int __init
cs4270_init(void)
929 pr_info("Cirrus Logic CS4270 ALSA SoC Codec Driver\n");
931 return i2c_add_driver(&cs4270_i2c_driver
);
933 module_init(cs4270_init
);
935 static void __exit
cs4270_exit(void)
937 i2c_del_driver(&cs4270_i2c_driver
);
939 module_exit(cs4270_exit
);
941 MODULE_AUTHOR("Timur Tabi <timur@freescale.com>");
942 MODULE_DESCRIPTION("Cirrus Logic CS4270 ALSA SoC Codec Driver");
943 MODULE_LICENSE("GPL");