/* * CS4270 ALSA SoC (ASoC) codec driver * * Author: Timur Tabi <[email protected]> * * Copyright 2007-2009 Freescale Semiconductor, Inc. This file is licensed * under the terms of the GNU General Public License version 2. This * program is licensed "as is" without any warranty of any kind, whether * express or implied. * * This is an ASoC device driver for the Cirrus Logic CS4270 codec. * * Current features/limitations: * * - Software mode is supported. Stand-alone mode is not supported. * - Only I2C is supported, not SPI * - Support for master and slave mode * - The machine driver's 'startup' function must call * cs4270_set_dai_sysclk() with the value of MCLK. * - Only I2S and left-justified modes are supported * - Power management is supported */ #include <linux/mod_devicetable.h> #include <linux/module.h> #include <linux/slab.h> #include <sound/core.h> #include <sound/soc.h> #include <sound/initval.h> #include <linux/i2c.h> #include <linux/delay.h> #include <linux/regulator/consumer.h> #include <linux/gpio/consumer.h> #define CS4270_FORMATS … /* CS4270 registers addresses */ #define CS4270_CHIPID … #define CS4270_PWRCTL … #define CS4270_MODE … #define CS4270_FORMAT … #define CS4270_TRANS … #define CS4270_MUTE … #define CS4270_VOLA … #define CS4270_VOLB … #define CS4270_FIRSTREG … #define CS4270_LASTREG … #define CS4270_NUMREGS … #define CS4270_I2C_INCR … /* Bit masks for the CS4270 registers */ #define CS4270_CHIPID_ID … #define CS4270_CHIPID_REV … #define CS4270_PWRCTL_FREEZE … #define CS4270_PWRCTL_PDN_ADC … #define CS4270_PWRCTL_PDN_DAC … #define CS4270_PWRCTL_PDN … #define CS4270_PWRCTL_PDN_ALL … #define CS4270_MODE_SPEED_MASK … #define CS4270_MODE_1X … #define CS4270_MODE_2X … #define CS4270_MODE_4X … #define CS4270_MODE_SLAVE … #define CS4270_MODE_DIV_MASK … #define CS4270_MODE_DIV1 … #define CS4270_MODE_DIV15 … #define CS4270_MODE_DIV2 … #define CS4270_MODE_DIV3 … #define CS4270_MODE_DIV4 … #define CS4270_MODE_POPGUARD … #define CS4270_FORMAT_FREEZE_A … #define CS4270_FORMAT_FREEZE_B … #define CS4270_FORMAT_LOOPBACK … #define CS4270_FORMAT_DAC_MASK … #define CS4270_FORMAT_DAC_LJ … #define CS4270_FORMAT_DAC_I2S … #define CS4270_FORMAT_DAC_RJ16 … #define CS4270_FORMAT_DAC_RJ24 … #define CS4270_FORMAT_ADC_MASK … #define CS4270_FORMAT_ADC_LJ … #define CS4270_FORMAT_ADC_I2S … #define CS4270_TRANS_ONE_VOL … #define CS4270_TRANS_SOFT … #define CS4270_TRANS_ZERO … #define CS4270_TRANS_INV_ADC_A … #define CS4270_TRANS_INV_ADC_B … #define CS4270_TRANS_INV_DAC_A … #define CS4270_TRANS_INV_DAC_B … #define CS4270_TRANS_DEEMPH … #define CS4270_MUTE_AUTO … #define CS4270_MUTE_ADC_A … #define CS4270_MUTE_ADC_B … #define CS4270_MUTE_POLARITY … #define CS4270_MUTE_DAC_A … #define CS4270_MUTE_DAC_B … /* Power-on default values for the registers * * This array contains the power-on default values of the registers, with the * exception of the "CHIPID" register (01h). The lower four bits of that * register contain the hardware revision, so it is treated as volatile. */ static const struct reg_default cs4270_reg_defaults[] = …; static const char *supply_names[] = …; /* Private data for the CS4270 */ struct cs4270_private { … }; static const struct snd_soc_dapm_widget cs4270_dapm_widgets[] = …; static const struct snd_soc_dapm_route cs4270_dapm_routes[] = …; /** * struct cs4270_mode_ratios - clock ratio tables * @ratio: the ratio of MCLK to the sample rate * @speed_mode: the Speed Mode bits to set in the Mode Control register for * this ratio * @mclk: the Ratio Select bits to set in the Mode Control register for this * ratio * * The data for this chart is taken from Table 5 of the CS4270 reference * manual. * * This table is used to determine how to program the Mode Control register. * It is also used by cs4270_set_dai_sysclk() to tell ALSA which sampling * rates the CS4270 currently supports. * * @speed_mode is the corresponding bit pattern to be written to the * MODE bits of the Mode Control Register * * @mclk is the corresponding bit pattern to be wirten to the MCLK bits of * the Mode Control Register. * * In situations where a single ratio is represented by multiple speed * modes, we favor the slowest speed. E.g, for a ratio of 128, we pick * double-speed instead of quad-speed. However, the CS4270 errata states * that divide-By-1.5 can cause failures, so we avoid that mode where * possible. * * Errata: There is an errata for the CS4270 where divide-by-1.5 does not * work if Vd is 3.3V. If this effects you, select the * CONFIG_SND_SOC_CS4270_VD33_ERRATA Kconfig option, and the driver will * never select any sample rates that require divide-by-1.5. */ struct cs4270_mode_ratios { … }; static struct cs4270_mode_ratios cs4270_mode_ratios[] = …; /* The number of MCLK/LRCK ratios supported by the CS4270 */ #define NUM_MCLK_RATIOS … static bool cs4270_reg_is_readable(struct device *dev, unsigned int reg) { … } static bool cs4270_reg_is_volatile(struct device *dev, unsigned int reg) { … } /** * cs4270_set_dai_sysclk - determine the CS4270 samples rates. * @codec_dai: the codec DAI * @clk_id: the clock ID (ignored) * @freq: the MCLK input frequency * @dir: the clock direction (ignored) * * This function is used to tell the codec driver what the input MCLK * frequency is. * * The value of MCLK is used to determine which sample rates are supported * by the CS4270. The ratio of MCLK / Fs must be equal to one of nine * supported values - 64, 96, 128, 192, 256, 384, 512, 768, and 1024. * * This function calculates the nine ratios and determines which ones match * a standard sample rate. If there's a match, then it is added to the list * of supported sample rates. * * This function must be called by the machine driver's 'startup' function, * otherwise the list of supported sample rates will not be available in * time for ALSA. * * For setups with variable MCLKs, pass 0 as 'freq' argument. This will cause * theoretically possible sample rates to be enabled. Call it again with a * proper value set one the external clock is set (most probably you would do * that from a machine's driver 'hw_param' hook. */ static int cs4270_set_dai_sysclk(struct snd_soc_dai *codec_dai, int clk_id, unsigned int freq, int dir) { … } /** * cs4270_set_dai_fmt - configure the codec for the selected audio format * @codec_dai: the codec DAI * @format: a SND_SOC_DAIFMT_x value indicating the data format * * This function takes a bitmask of SND_SOC_DAIFMT_x bits and programs the * codec accordingly. * * Currently, this function only supports SND_SOC_DAIFMT_I2S and * SND_SOC_DAIFMT_LEFT_J. The CS4270 codec also supports right-justified * data for playback only, but ASoC currently does not support different * formats for playback vs. record. */ static int cs4270_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int format) { … } /** * cs4270_hw_params - program the CS4270 with the given hardware parameters. * @substream: the audio stream * @params: the hardware parameters to set * @dai: the SOC DAI (ignored) * * This function programs the hardware with the values provided. * Specifically, the sample rate and the data format. * * The .ops functions are used to provide board-specific data, like input * frequencies, to this driver. This function takes that information, * combines it with the hardware parameters provided, and programs the * hardware accordingly. */ static int cs4270_hw_params(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params, struct snd_soc_dai *dai) { … } /** * cs4270_dai_mute - enable/disable the CS4270 external mute * @dai: the SOC DAI * @mute: 0 = disable mute, 1 = enable mute * @direction: (ignored) * * This function toggles the mute bits in the MUTE register. The CS4270's * mute capability is intended for external muting circuitry, so if the * board does not have the MUTEA or MUTEB pins connected to such circuitry, * then this function will do nothing. */ static int cs4270_dai_mute(struct snd_soc_dai *dai, int mute, int direction) { … } /** * cs4270_soc_put_mute - put callback for the 'Master Playback switch' * alsa control. * @kcontrol: mixer control * @ucontrol: control element information * * This function basically passes the arguments on to the generic * snd_soc_put_volsw() function and saves the mute information in * our private data structure. This is because we want to prevent * cs4270_dai_mute() neglecting the user's decision to manually * mute the codec's output. * * Returns 0 for success. */ static int cs4270_soc_put_mute(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) { … } /* A list of non-DAPM controls that the CS4270 supports */ static const struct snd_kcontrol_new cs4270_snd_controls[] = …; static const struct snd_soc_dai_ops cs4270_dai_ops = …; static struct snd_soc_dai_driver cs4270_dai = …; /** * cs4270_probe - ASoC probe function * @component: ASoC component * * This function is called when ASoC has all the pieces it needs to * instantiate a sound driver. */ static int cs4270_probe(struct snd_soc_component *component) { … } /** * cs4270_remove - ASoC remove function * @component: ASoC component * * This function is the counterpart to cs4270_probe(). */ static void cs4270_remove(struct snd_soc_component *component) { struct cs4270_private *cs4270 = snd_soc_component_get_drvdata(component); regulator_bulk_disable(ARRAY_SIZE(cs4270->supplies), cs4270->supplies); }; #ifdef CONFIG_PM /* This suspend/resume implementation can handle both - a simple standby * where the codec remains powered, and a full suspend, where the voltage * domain the codec is connected to is teared down and/or any other hardware * reset condition is asserted. * * The codec's own power saving features are enabled in the suspend callback, * and all registers are written back to the hardware when resuming. */ static int cs4270_soc_suspend(struct snd_soc_component *component) { … } static int cs4270_soc_resume(struct snd_soc_component *component) { … } #else #define cs4270_soc_suspend … #define cs4270_soc_resume … #endif /* CONFIG_PM */ /* * ASoC codec driver structure */ static const struct snd_soc_component_driver soc_component_device_cs4270 = …; /* * cs4270_of_match - the device tree bindings */ static const struct of_device_id cs4270_of_match[] = …; MODULE_DEVICE_TABLE(of, cs4270_of_match); static const struct regmap_config cs4270_regmap = …; /** * cs4270_i2c_remove - deinitialize the I2C interface of the CS4270 * @i2c_client: the I2C client object * * This function puts the chip into low power mode when the i2c device * is removed. */ static void cs4270_i2c_remove(struct i2c_client *i2c_client) { … } /** * cs4270_i2c_probe - initialize the I2C interface of the CS4270 * @i2c_client: the I2C client object * * This function is called whenever the I2C subsystem finds a device that * matches the device ID given via a prior call to i2c_add_driver(). */ static int cs4270_i2c_probe(struct i2c_client *i2c_client) { … } /* * cs4270_id - I2C device IDs supported by this driver */ static const struct i2c_device_id cs4270_id[] = …; MODULE_DEVICE_TABLE(i2c, cs4270_id); /* * cs4270_i2c_driver - I2C device identification * * This structure tells the I2C subsystem how to identify and support a * given I2C device type. */ static struct i2c_driver cs4270_i2c_driver = …; module_i2c_driver(…) …; MODULE_AUTHOR(…) …; MODULE_DESCRIPTION(…) …; MODULE_LICENSE(…) …;
Codebase Browser
linux