korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-15 08:14:15 +08:00
Code Issues Packages Projects Releases Wiki Activity
28dbd1611f
linux/sound/soc/codecs/tas5086.c
Dan Carpenter 28dbd1611f ASoC: tas5086: signedness bug in tas5086_hw_params() 
"val" has to be signed for the error handling to work.

Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
Acked-by: Daniel Mack <zonque@gmail.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
2013-03-13 11:08:56 +00:00

592 lines
16 KiB
C
Raw Blame History

/*
* TAS5086 ASoC codec driver
*
* Copyright (c) 2013 Daniel Mack <zonque@gmail.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* TODO:
* - implement DAPM and input muxing
* - implement modulation limit
* - implement non-default PWM start
*
* Note that this chip has a very unusual register layout, specifically
* because the registers are of unequal size, and multi-byte registers
* require bulk writes to take effect. Regmap does not support that kind
* of devices.
*
* Currently, the driver does not touch any of the registers >= 0x20, so
* it doesn't matter because the entire map can be accessed as 8-bit
* array. In case more features will be added in the future
* that require access to higher registers, the entire regmap H/W I/O
* routines have to be open-coded.
*/
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/delay.h>
#include <linux/gpio.h>
#include <linux/i2c.h>
#include <linux/regmap.h>
#include <linux/spi/spi.h>
#include <linux/of_device.h>
#include <linux/of_gpio.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/tlv.h>
#include <sound/tas5086.h>
#define TAS5086_PCM_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | \
SNDRV_PCM_FMTBIT_S20_3LE | \
SNDRV_PCM_FMTBIT_S24_3LE)
#define TAS5086_PCM_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | \
SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 | \
SNDRV_PCM_RATE_192000)
/*
* TAS5086 registers
*/
#define TAS5086_CLOCK_CONTROL 0x00 /* Clock control register */
#define TAS5086_CLOCK_RATE(val) (val << 5)
#define TAS5086_CLOCK_RATE_MASK (0x7 << 5)
#define TAS5086_CLOCK_RATIO(val) (val << 2)
#define TAS5086_CLOCK_RATIO_MASK (0x7 << 2)
#define TAS5086_CLOCK_SCLK_RATIO_48 (1 << 1)
#define TAS5086_CLOCK_VALID (1 << 0)
#define TAS5086_DEEMPH_MASK 0x03
#define TAS5086_SOFT_MUTE_ALL 0x3f
#define TAS5086_DEV_ID 0x01 /* Device ID register */
#define TAS5086_ERROR_STATUS 0x02 /* Error status register */
#define TAS5086_SYS_CONTROL_1 0x03 /* System control register 1 */
#define TAS5086_SERIAL_DATA_IF 0x04 /* Serial data interface register */
#define TAS5086_SYS_CONTROL_2 0x05 /* System control register 2 */
#define TAS5086_SOFT_MUTE 0x06 /* Soft mute register */
#define TAS5086_MASTER_VOL 0x07 /* Master volume */
#define TAS5086_CHANNEL_VOL(X) (0x08 + (X)) /* Channel 1-6 volume */
#define TAS5086_VOLUME_CONTROL 0x09 /* Volume control register */
#define TAS5086_MOD_LIMIT 0x10 /* Modulation limit register */
#define TAS5086_PWM_START 0x18 /* PWM start register */
#define TAS5086_SURROUND 0x19 /* Surround register */
#define TAS5086_SPLIT_CAP_CHARGE 0x1a /* Split cap charge period register */
#define TAS5086_OSC_TRIM 0x1b /* Oscillator trim register */
#define TAS5086_BKNDERR 0x1c
/*
* Default TAS5086 power-up configuration
*/
static const struct reg_default tas5086_reg_defaults[] = {
{ 0x00, 0x6c },
{ 0x01, 0x03 },
{ 0x02, 0x00 },
{ 0x03, 0xa0 },
{ 0x04, 0x05 },
{ 0x05, 0x60 },
{ 0x06, 0x00 },
{ 0x07, 0xff },
{ 0x08, 0x30 },
{ 0x09, 0x30 },
{ 0x0a, 0x30 },
{ 0x0b, 0x30 },
{ 0x0c, 0x30 },
{ 0x0d, 0x30 },
{ 0x0e, 0xb1 },
{ 0x0f, 0x00 },
{ 0x10, 0x02 },
{ 0x11, 0x00 },
{ 0x12, 0x00 },
{ 0x13, 0x00 },
{ 0x14, 0x00 },
{ 0x15, 0x00 },
{ 0x16, 0x00 },
{ 0x17, 0x00 },
{ 0x18, 0x3f },
{ 0x19, 0x00 },
{ 0x1a, 0x18 },
{ 0x1b, 0x82 },
{ 0x1c, 0x05 },
};
static bool tas5086_accessible_reg(struct device *dev, unsigned int reg)
{
return !((reg == 0x0f) || (reg >= 0x11 && reg <= 0x17));
}
static bool tas5086_volatile_reg(struct device *dev, unsigned int reg)
{
switch (reg) {
case TAS5086_DEV_ID:
case TAS5086_ERROR_STATUS:
return true;
}
return false;
}
static bool tas5086_writeable_reg(struct device *dev, unsigned int reg)
{
return tas5086_accessible_reg(dev, reg) && (reg != TAS5086_DEV_ID);
}
struct tas5086_private {
struct regmap *regmap;
unsigned int mclk, sclk;
unsigned int format;
bool deemph;
/* Current sample rate for de-emphasis control */
int rate;
/* GPIO driving Reset pin, if any */
int gpio_nreset;
};
static int tas5086_deemph[] = { 0, 32000, 44100, 48000 };
static int tas5086_set_deemph(struct snd_soc_codec *codec)
{
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
int i, val = 0;
if (priv->deemph)
for (i = 0; i < ARRAY_SIZE(tas5086_deemph); i++)
if (tas5086_deemph[i] == priv->rate)
val = i;
return regmap_update_bits(priv->regmap, TAS5086_SYS_CONTROL_1,
TAS5086_DEEMPH_MASK, val);
}
static int tas5086_get_deemph(struct snd_kcontrol *kcontrol,
struct snd_ctl_elem_value *ucontrol)
{
struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
ucontrol->value.enumerated.item[0] = priv->deemph;
return 0;
}
static int tas5086_put_deemph(struct snd_kcontrol *kcontrol,
struct snd_ctl_elem_value *ucontrol)
{
struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
priv->deemph = ucontrol->value.enumerated.item[0];
return tas5086_set_deemph(codec);
}
static int tas5086_set_dai_sysclk(struct snd_soc_dai *codec_dai,
int clk_id, unsigned int freq, int dir)
{
struct snd_soc_codec *codec = codec_dai->codec;
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
switch (clk_id) {
case TAS5086_CLK_IDX_MCLK:
priv->mclk = freq;
break;
case TAS5086_CLK_IDX_SCLK:
priv->sclk = freq;
break;
}
return 0;
}
static int tas5086_set_dai_fmt(struct snd_soc_dai *codec_dai,
unsigned int format)
{
struct snd_soc_codec *codec = codec_dai->codec;
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
/* The TAS5086 can only be slave to all clocks */
if ((format & SND_SOC_DAIFMT_MASTER_MASK) != SND_SOC_DAIFMT_CBS_CFS) {
dev_err(codec->dev, "Invalid clocking mode\n");
return -EINVAL;
}
/* we need to refer to the data format from hw_params() */
priv->format = format;
return 0;
}
static const int tas5086_sample_rates[] = {
32000, 38000, 44100, 48000, 88200, 96000, 176400, 192000
};
static const int tas5086_ratios[] = {
64, 128, 192, 256, 384, 512
};
static int index_in_array(const int *array, int len, int needle)
{
int i;
for (i = 0; i < len; i++)
if (array[i] == needle)
return i;
return -ENOENT;
}
static int tas5086_hw_params(struct snd_pcm_substream *substream,
struct snd_pcm_hw_params *params,
struct snd_soc_dai *dai)
{
struct snd_soc_codec *codec = dai->codec;
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
int val;
int ret;
priv->rate = params_rate(params);
/* Look up the sample rate and refer to the offset in the list */
val = index_in_array(tas5086_sample_rates,
ARRAY_SIZE(tas5086_sample_rates), priv->rate);
if (val < 0) {
dev_err(codec->dev, "Invalid sample rate\n");
return -EINVAL;
}
ret = regmap_update_bits(priv->regmap, TAS5086_CLOCK_CONTROL,
TAS5086_CLOCK_RATE_MASK,
TAS5086_CLOCK_RATE(val));
if (ret < 0)
return ret;
/* MCLK / Fs ratio */
val = index_in_array(tas5086_ratios, ARRAY_SIZE(tas5086_ratios),
priv->mclk / priv->rate);
if (val < 0) {
dev_err(codec->dev, "Inavlid MCLK / Fs ratio\n");
return -EINVAL;
}
ret = regmap_update_bits(priv->regmap, TAS5086_CLOCK_CONTROL,
TAS5086_CLOCK_RATIO_MASK,
TAS5086_CLOCK_RATIO(val));
if (ret < 0)
return ret;
ret = regmap_update_bits(priv->regmap, TAS5086_CLOCK_CONTROL,
TAS5086_CLOCK_SCLK_RATIO_48,
(priv->sclk == 48 * priv->rate) ?
TAS5086_CLOCK_SCLK_RATIO_48 : 0);
if (ret < 0)
return ret;
/*
* The chip has a very unituitive register mapping and muxes information
* about data format and sample depth into the same register, but not on
* a logical bit-boundary. Hence, we have to refer to the format passed
* in the set_dai_fmt() callback and set up everything from here.
*
* First, determine the 'base' value, using the format ...
*/
switch (priv->format & SND_SOC_DAIFMT_FORMAT_MASK) {
case SND_SOC_DAIFMT_RIGHT_J:
val = 0x00;
break;
case SND_SOC_DAIFMT_I2S:
val = 0x03;
break;
case SND_SOC_DAIFMT_LEFT_J:
val = 0x06;
break;
default:
dev_err(codec->dev, "Invalid DAI format\n");
return -EINVAL;
}
/* ... then add the offset for the sample bit depth. */
switch (params_format(params)) {
case SNDRV_PCM_FORMAT_S16_LE:
val += 0;
break;
case SNDRV_PCM_FORMAT_S20_3LE:
val += 1;
break;
case SNDRV_PCM_FORMAT_S24_3LE:
val += 2;
break;
default:
dev_err(codec->dev, "Invalid bit width\n");
return -EINVAL;
};
ret = regmap_write(priv->regmap, TAS5086_SERIAL_DATA_IF, val);
if (ret < 0)
return ret;
/* clock is considered valid now */
ret = regmap_update_bits(priv->regmap, TAS5086_CLOCK_CONTROL,
TAS5086_CLOCK_VALID, TAS5086_CLOCK_VALID);
if (ret < 0)
return ret;
return tas5086_set_deemph(codec);
}
static int tas5086_mute_stream(struct snd_soc_dai *dai, int mute, int stream)
{
struct snd_soc_codec *codec = dai->codec;
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
unsigned int val = 0;
if (mute)
val = TAS5086_SOFT_MUTE_ALL;
return regmap_write(priv->regmap, TAS5086_SOFT_MUTE, val);
}
/* TAS5086 controls */
static const DECLARE_TLV_DB_SCALE(tas5086_dac_tlv, -10350, 50, 1);
static const struct snd_kcontrol_new tas5086_controls[] = {
SOC_SINGLE_TLV("Master Playback Volume", TAS5086_MASTER_VOL,
0, 0xff, 1, tas5086_dac_tlv),
SOC_DOUBLE_R_TLV("Channel 1/2 Playback Volume",
TAS5086_CHANNEL_VOL(0), TAS5086_CHANNEL_VOL(1),
0, 0xff, 1, tas5086_dac_tlv),
SOC_DOUBLE_R_TLV("Channel 3/4 Playback Volume",
TAS5086_CHANNEL_VOL(2), TAS5086_CHANNEL_VOL(3),
0, 0xff, 1, tas5086_dac_tlv),
SOC_DOUBLE_R_TLV("Channel 5/6 Playback Volume",
TAS5086_CHANNEL_VOL(4), TAS5086_CHANNEL_VOL(5),
0, 0xff, 1, tas5086_dac_tlv),
SOC_SINGLE_BOOL_EXT("De-emphasis Switch", 0,
tas5086_get_deemph, tas5086_put_deemph),
};
static const struct snd_soc_dai_ops tas5086_dai_ops = {
.hw_params = tas5086_hw_params,
.set_sysclk = tas5086_set_dai_sysclk,
.set_fmt = tas5086_set_dai_fmt,
.mute_stream = tas5086_mute_stream,
};
static struct snd_soc_dai_driver tas5086_dai = {
.name = "tas5086-hifi",
.playback = {
.stream_name = "Playback",
.channels_min = 2,
.channels_max = 6,
.rates = TAS5086_PCM_RATES,
.formats = TAS5086_PCM_FORMATS,
},
.ops = &tas5086_dai_ops,
};
#ifdef CONFIG_PM
static int tas5086_soc_resume(struct snd_soc_codec *codec)
{
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
/* Restore codec state */
return regcache_sync(priv->regmap);
}
#else
#define tas5086_soc_resume NULL
#endif /* CONFIG_PM */
#ifdef CONFIG_OF
static const struct of_device_id tas5086_dt_ids[] = {
{ .compatible = "ti,tas5086", },
{ }
};
MODULE_DEVICE_TABLE(of, tas5086_dt_ids);
#endif
/* charge period values in microseconds */
static const int tas5086_charge_period[] = {
13000, 16900, 23400, 31200, 41600, 54600, 72800, 96200,
130000, 156000, 234000, 312000, 416000, 546000, 728000, 962000,
1300000, 169000, 2340000, 3120000, 4160000, 5460000, 7280000, 9620000,
};
static int tas5086_probe(struct snd_soc_codec *codec)
{
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
int charge_period = 1300000; /* hardware default is 1300 ms */
int i, ret;
if (of_match_device(of_match_ptr(tas5086_dt_ids), codec->dev)) {
struct device_node *of_node = codec->dev->of_node;
of_property_read_u32(of_node, "ti,charge-period", &charge_period);
}
/* lookup and set split-capacitor charge period */
if (charge_period == 0) {
regmap_write(priv->regmap, TAS5086_SPLIT_CAP_CHARGE, 0);
} else {
i = index_in_array(tas5086_charge_period,
ARRAY_SIZE(tas5086_charge_period),
charge_period);
if (i >= 0)
regmap_write(priv->regmap, TAS5086_SPLIT_CAP_CHARGE,
i + 0x08);
else
dev_warn(codec->dev,
"Invalid split-cap charge period of %d ns.\n",
charge_period);
}
/* enable factory trim */
ret = regmap_write(priv->regmap, TAS5086_OSC_TRIM, 0x00);
if (ret < 0)
return ret;
/* start all channels */
ret = regmap_write(priv->regmap, TAS5086_SYS_CONTROL_2, 0x20);
if (ret < 0)
return ret;
/* set master volume to 0 dB */
ret = regmap_write(priv->regmap, TAS5086_MASTER_VOL, 0x30);
if (ret < 0)
return ret;
/* mute all channels for now */
ret = regmap_write(priv->regmap, TAS5086_SOFT_MUTE,
TAS5086_SOFT_MUTE_ALL);
if (ret < 0)
return ret;
return 0;
}
static int tas5086_remove(struct snd_soc_codec *codec)
{
struct tas5086_private *priv = snd_soc_codec_get_drvdata(codec);
if (gpio_is_valid(priv->gpio_nreset))
/* Set codec to the reset state */
gpio_set_value(priv->gpio_nreset, 0);
return 0;
};
static struct snd_soc_codec_driver soc_codec_dev_tas5086 = {
.probe = tas5086_probe,
.remove = tas5086_remove,
.resume = tas5086_soc_resume,
.controls = tas5086_controls,
.num_controls = ARRAY_SIZE(tas5086_controls),
};
static const struct i2c_device_id tas5086_i2c_id[] = {
{ "tas5086", 0 },
{ }
};
MODULE_DEVICE_TABLE(i2c, tas5086_i2c_id);
static const struct regmap_config tas5086_regmap = {
.reg_bits = 8,
.val_bits = 8,
.max_register = ARRAY_SIZE(tas5086_reg_defaults),
.reg_defaults = tas5086_reg_defaults,
.num_reg_defaults = ARRAY_SIZE(tas5086_reg_defaults),
.cache_type = REGCACHE_RBTREE,
.volatile_reg = tas5086_volatile_reg,
.writeable_reg = tas5086_writeable_reg,
.readable_reg = tas5086_accessible_reg,
};
static int tas5086_i2c_probe(struct i2c_client *i2c,
const struct i2c_device_id *id)
{
struct tas5086_private *priv;
struct device *dev = &i2c->dev;
int gpio_nreset = -EINVAL;
int i, ret;
priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
if (!priv)
return -ENOMEM;
priv->regmap = devm_regmap_init_i2c(i2c, &tas5086_regmap);
if (IS_ERR(priv->regmap)) {
ret = PTR_ERR(priv->regmap);
dev_err(&i2c->dev, "Failed to create regmap: %d\n", ret);
return ret;
}
i2c_set_clientdata(i2c, priv);
if (of_match_device(of_match_ptr(tas5086_dt_ids), dev)) {
struct device_node *of_node = dev->of_node;
gpio_nreset = of_get_named_gpio(of_node, "reset-gpio", 0);
}
if (gpio_is_valid(gpio_nreset))
if (devm_gpio_request(dev, gpio_nreset, "TAS5086 Reset"))
gpio_nreset = -EINVAL;
if (gpio_is_valid(gpio_nreset)) {
/* Reset codec - minimum assertion time is 400ns */
gpio_direction_output(gpio_nreset, 0);
udelay(1);
gpio_set_value(gpio_nreset, 1);
/* Codec needs ~15ms to wake up */
msleep(15);
}
priv->gpio_nreset = gpio_nreset;
/* The TAS5086 always returns 0x03 in its TAS5086_DEV_ID register */
ret = regmap_read(priv->regmap, TAS5086_DEV_ID, &i);
if (ret < 0)
return ret;
if (i != 0x3) {
dev_err(dev,
"Failed to identify TAS5086 codec (got %02x)\n", i);
return -ENODEV;
}
return snd_soc_register_codec(&i2c->dev, &soc_codec_dev_tas5086,
&tas5086_dai, 1);
}
static int tas5086_i2c_remove(struct i2c_client *i2c)
{
snd_soc_unregister_codec(&i2c->dev);
return 0;
}
static struct i2c_driver tas5086_i2c_driver = {
.driver = {
.name = "tas5086",
.owner = THIS_MODULE,
.of_match_table = of_match_ptr(tas5086_dt_ids),
},
.id_table = tas5086_i2c_id,
.probe = tas5086_i2c_probe,
.remove = tas5086_i2c_remove,
};
module_i2c_driver(tas5086_i2c_driver);
MODULE_AUTHOR("Daniel Mack <zonque@gmail.com>");
MODULE_DESCRIPTION("Texas Instruments TAS5086 ALSA SoC Codec Driver");
MODULE_LICENSE("GPL");
Reference in New Issue View Git Blame Copy Permalink