[alsa-devel] [PATCH] ASoC: add driver for max9768 amplifier
Signed-off-by: Wolfram Sang w.sang@pengutronix.de --- include/sound/max9768.h | 23 ++++ sound/soc/codecs/Kconfig | 4 + sound/soc/codecs/Makefile | 2 + sound/soc/codecs/max9768.c | 244 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 273 insertions(+), 0 deletions(-) create mode 100644 include/sound/max9768.h create mode 100644 sound/soc/codecs/max9768.c
diff --git a/include/sound/max9768.h b/include/sound/max9768.h new file mode 100644 index 0000000..f8f1639 --- /dev/null +++ b/include/sound/max9768.h @@ -0,0 +1,23 @@ +/* + * Platform data for MAX9768 + * Copyright (C) 2011, 2012 by Wolfram Sang, Pengutronix e.K. + * same licence as the driver + */ + +#ifndef __SOUND_MAX9768_PDATA_H__ +#define __SOUND_MAX9768_PDATA_H__ + +/** + * struct max9768_pdata - optional platform specific MAX9768 configuration + * @shdn_gpio: GPIO to SHDN pin. If not valid, pin must be hardwired HIGH + * @mute_gpio: GPIO to MUTE pin. If not valid, control for mute won't be added + * @flags: configuration flags, e.g. set classic PWM mode. + */ +struct max9768_pdata { + int shdn_gpio; + int mute_gpio; + unsigned flags; +#define MAX9768_FLAG_CLASSIC_PWM (1 << 0) +}; + +#endif /* __SOUND_MAX9768_PDATA_H__*/ diff --git a/sound/soc/codecs/Kconfig b/sound/soc/codecs/Kconfig index 7c205e7..a861014 100644 --- a/sound/soc/codecs/Kconfig +++ b/sound/soc/codecs/Kconfig @@ -37,6 +37,7 @@ config SND_SOC_ALL_CODECS select SND_SOC_DFBMCS320 select SND_SOC_JZ4740_CODEC select SND_SOC_LM4857 if I2C + select SND_SOC_MAX9768 if I2C select SND_SOC_MAX98088 if I2C select SND_SOC_MAX98095 if I2C select SND_SOC_MAX9850 if I2C @@ -425,6 +426,9 @@ config SND_SOC_WM9713 config SND_SOC_LM4857 tristate
+config SND_SOC_MAX9768 + tristate + config SND_SOC_MAX9877 tristate
diff --git a/sound/soc/codecs/Makefile b/sound/soc/codecs/Makefile index de80781..cf3555b 100644 --- a/sound/soc/codecs/Makefile +++ b/sound/soc/codecs/Makefile @@ -25,6 +25,7 @@ snd-soc-dmic-objs := dmic.o snd-soc-jz4740-codec-objs := jz4740.o snd-soc-l3-objs := l3.o snd-soc-lm4857-objs := lm4857.o +snd-soc-max9768-objs := max9768.o snd-soc-max98088-objs := max98088.o snd-soc-max98095-objs := max98095.o snd-soc-max9850-objs := max9850.o @@ -129,6 +130,7 @@ obj-$(CONFIG_SND_SOC_DMIC) += snd-soc-dmic.o obj-$(CONFIG_SND_SOC_L3) += snd-soc-l3.o obj-$(CONFIG_SND_SOC_LM4857) += snd-soc-lm4857.o obj-$(CONFIG_SND_SOC_JZ4740_CODEC) += snd-soc-jz4740-codec.o +obj-$(CONFIG_SND_SOC_MAX9768) += snd-soc-max9768.o obj-$(CONFIG_SND_SOC_MAX98088) += snd-soc-max98088.o obj-$(CONFIG_SND_SOC_MAX98095) += snd-soc-max98095.o obj-$(CONFIG_SND_SOC_MAX9850) += snd-soc-max9850.o diff --git a/sound/soc/codecs/max9768.c b/sound/soc/codecs/max9768.c new file mode 100644 index 0000000..bd57b45 --- /dev/null +++ b/sound/soc/codecs/max9768.c @@ -0,0 +1,244 @@ +/* + * MAX9768 AMP driver + * + * Copyright (C) 2011, 2012 by Wolfram Sang, Pengutronix e.K. + * based on lm4857.c by Lars-Peter Clausen et al. + * + * 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; version 2 of the License. + */ + +#include <linux/init.h> +#include <linux/module.h> +#include <linux/i2c.h> +#include <linux/slab.h> +#include <linux/gpio.h> + +#include <sound/core.h> +#include <sound/soc.h> +#include <sound/tlv.h> +#include <sound/max9768.h> + +/* The register offsets in the cache array */ +#define MAX9768_VOL 0 +#define MAX9768_CTRL 3 + +/* Commands */ +#define MAX9768_CTRL_PWM 0x15 +#define MAX9768_CTRL_FILTERLESS 0x16 + +struct max9768 { + struct i2c_client *client; + int mute_gpio; + int shdn_gpio; + u32 flags; +}; + +static const uint8_t max9768_default_regs[] = { + 0x00, 0x00, 0x00, MAX9768_CTRL_FILTERLESS, +}; + +static int max9768_write(struct snd_soc_codec *codec, unsigned int reg, + unsigned int value) +{ + uint8_t data; + int ret; + + ret = snd_soc_cache_write(codec, reg, value); + if (ret < 0) + return ret; + + data = (reg << 6) | value; + ret = i2c_smbus_write_byte(codec->control_data, data); + if (ret) + dev_err(codec->dev, "Failed to write register: %d\n", ret); + + return ret; +} + +static unsigned int max9768_read(struct snd_soc_codec *codec, + unsigned int reg) +{ + unsigned int val; + int ret; + + ret = snd_soc_cache_read(codec, reg, &val); + + return ret ?: val; +} + + +static int max9768_get_gpio(struct snd_kcontrol *kcontrol, + struct snd_ctl_elem_value *ucontrol) +{ + struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol); + struct max9768 *max9768 = snd_soc_codec_get_drvdata(codec); + int val = gpio_get_value_cansleep(max9768->mute_gpio); + + ucontrol->value.integer.value[0] = !val; + + return 0; +} + +static int max9768_set_gpio(struct snd_kcontrol *kcontrol, + struct snd_ctl_elem_value *ucontrol) +{ + struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol); + struct max9768 *max9768 = snd_soc_codec_get_drvdata(codec); + + gpio_set_value_cansleep(max9768->mute_gpio, !ucontrol->value.integer.value[0]); + + return 0; +} + +static const unsigned int volume_tlv[] = { + TLV_DB_RANGE_HEAD(43), + 0, 0, TLV_DB_SCALE_ITEM(-16150, 0, 0), + 1, 1, TLV_DB_SCALE_ITEM(-9280, 0, 0), + 2, 2, TLV_DB_SCALE_ITEM(-9030, 0, 0), + 3, 3, TLV_DB_SCALE_ITEM(-8680, 0, 0), + 4, 4, TLV_DB_SCALE_ITEM(-8430, 0, 0), + 5, 5, TLV_DB_SCALE_ITEM(-8080, 0, 0), + 6, 6, TLV_DB_SCALE_ITEM(-7830, 0, 0), + 7, 7, TLV_DB_SCALE_ITEM(-7470, 0, 0), + 8, 8, TLV_DB_SCALE_ITEM(-7220, 0, 0), + 9, 9, TLV_DB_SCALE_ITEM(-6870, 0, 0), + 10, 10, TLV_DB_SCALE_ITEM(-6620, 0, 0), + 11, 11, TLV_DB_SCALE_ITEM(-6270, 0, 0), + 12, 12, TLV_DB_SCALE_ITEM(-6020, 0, 0), + 13, 13, TLV_DB_SCALE_ITEM(-5670, 0, 0), + 14, 14, TLV_DB_SCALE_ITEM(-5420, 0, 0), + 15, 17, TLV_DB_SCALE_ITEM(-5060, 250, 0), + 18, 18, TLV_DB_SCALE_ITEM(-4370, 0, 0), + 19, 19, TLV_DB_SCALE_ITEM(-4210, 0, 0), + 20, 20, TLV_DB_SCALE_ITEM(-3960, 0, 0), + 21, 21, TLV_DB_SCALE_ITEM(-3760, 0, 0), + 22, 22, TLV_DB_SCALE_ITEM(-3600, 0, 0), + 23, 23, TLV_DB_SCALE_ITEM(-3340, 0, 0), + 24, 24, TLV_DB_SCALE_ITEM(-3150, 0, 0), + 25, 25, TLV_DB_SCALE_ITEM(-2980, 0, 0), + 26, 26, TLV_DB_SCALE_ITEM(-2720, 0, 0), + 27, 27, TLV_DB_SCALE_ITEM(-2520, 0, 0), + 28, 30, TLV_DB_SCALE_ITEM(-2350, 190, 0), + 31, 31, TLV_DB_SCALE_ITEM(-1750, 0, 0), + 32, 34, TLV_DB_SCALE_ITEM(-1640, 100, 0), + 35, 37, TLV_DB_SCALE_ITEM(-1310, 110, 0), + 38, 39, TLV_DB_SCALE_ITEM(-990, 100, 0), + 40, 40, TLV_DB_SCALE_ITEM(-710, 0, 0), + 41, 41, TLV_DB_SCALE_ITEM(-600, 0, 0), + 42, 42, TLV_DB_SCALE_ITEM(-500, 0, 0), + 43, 43, TLV_DB_SCALE_ITEM(-340, 0, 0), + 44, 44, TLV_DB_SCALE_ITEM(-190, 0, 0), + 45, 45, TLV_DB_SCALE_ITEM(-50, 0, 0), + 46, 46, TLV_DB_SCALE_ITEM(50, 0, 0), + 47, 50, TLV_DB_SCALE_ITEM(120, 40, 0), + 51, 57, TLV_DB_SCALE_ITEM(290, 50, 0), + 58, 58, TLV_DB_SCALE_ITEM(650, 0, 0), + 59, 62, TLV_DB_SCALE_ITEM(700, 60, 0), + 63, 63, TLV_DB_SCALE_ITEM(950, 0, 0), +}; + +static const struct snd_kcontrol_new max9768_volume[] = { + SOC_SINGLE_TLV("Playback Volume", MAX9768_VOL, 0, 63, 0, volume_tlv), +}; + +static const struct snd_kcontrol_new max9768_mute[] = { + SOC_SINGLE_BOOL_EXT("Mute Switch", 0, max9768_get_gpio, max9768_set_gpio), +}; + +static int max9768_probe(struct snd_soc_codec *codec) +{ + struct max9768 *max9768 = snd_soc_codec_get_drvdata(codec); + int ret; + + codec->control_data = max9768->client; + + if (max9768->flags & MAX9768_FLAG_CLASSIC_PWM) { + ret = snd_soc_write(codec, MAX9768_CTRL, MAX9768_CTRL_PWM); + if (ret) + return ret; + } + + ret = snd_soc_add_controls(codec, max9768_volume, + ARRAY_SIZE(max9768_volume)); + if (ret) + return ret; + + if (max9768->mute_gpio >= 0) { + ret = snd_soc_add_controls(codec, max9768_mute, + ARRAY_SIZE(max9768_mute)); + if (ret) + return ret; + } + + return 0; +} + +static struct snd_soc_codec_driver soc_codec_dev_max9768 = { + .write = max9768_write, + .read = max9768_read, + .probe = max9768_probe, + .reg_cache_size = ARRAY_SIZE(max9768_default_regs), + .reg_word_size = sizeof(uint8_t), + .reg_cache_default = max9768_default_regs, +}; + +static int __devinit max9768_i2c_probe(struct i2c_client *client, + const struct i2c_device_id *id) +{ + struct max9768 *max9768; + struct max9768_pdata *pdata = client->dev.platform_data; + int err; + + max9768 = devm_kzalloc(&client->dev, sizeof(*max9768), GFP_KERNEL); + if (!max9768) + return -ENOMEM; + + if (pdata) { + /* Mute on powerup to avoid clicks */ + err = gpio_request_one(pdata->mute_gpio, GPIOF_INIT_HIGH, "MAX9768 Mute"); + max9768->mute_gpio = err ?: pdata->mute_gpio; + + /* Activate chip, enabling I2C */ + err = gpio_request_one(pdata->shdn_gpio, GPIOF_INIT_HIGH, "MAX9768 Shutdown"); + max9768->shdn_gpio = err ?: pdata->shdn_gpio; + + max9768->flags = pdata->flags; + } else { + max9768->shdn_gpio = -EINVAL; + max9768->mute_gpio = -EINVAL; + } + + max9768->client = client; + i2c_set_clientdata(client, max9768); + + return snd_soc_register_codec(&client->dev, &soc_codec_dev_max9768, NULL, 0); +} + +static int __devexit max9768_i2c_remove(struct i2c_client *client) +{ + snd_soc_unregister_codec(&client->dev); + return 0; +} + +static const struct i2c_device_id max9768_i2c_id[] = { + { "max9768", 0 }, + { } +}; +MODULE_DEVICE_TABLE(i2c, max9768_i2c_id); + +static struct i2c_driver max9768_i2c_driver = { + .driver = { + .name = "max9768", + .owner = THIS_MODULE, + }, + .probe = max9768_i2c_probe, + .remove = __devexit_p(max9768_i2c_remove), + .id_table = max9768_i2c_id, +}; +module_i2c_driver(max9768_i2c_driver); + +MODULE_AUTHOR("Wolfram Sang w.sang@pengutronix.de"); +MODULE_DESCRIPTION("ASoC MAX9768 amplifier driver"); +MODULE_LICENSE("GPL v2");
On 01/18/2012 04:38 PM, Wolfram Sang wrote:
Signed-off-by: Wolfram Sang w.sang@pengutronix.de
[...]
diff --git a/sound/soc/codecs/max9768.c b/sound/soc/codecs/max9768.c new file mode 100644 index 0000000..bd57b45 --- /dev/null +++ b/sound/soc/codecs/max9768.c @@ -0,0 +1,244 @@ +/*
- MAX9768 AMP driver
- Copyright (C) 2011, 2012 by Wolfram Sang, Pengutronix e.K.
- based on lm4857.c by Lars-Peter Clausen et al.
That driver is a bit older, so some of the issues mentioned below also apply to that driver, I'll see if I can get it updated.
- 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; version 2 of the License.
- */
+#include <linux/init.h> +#include <linux/module.h> +#include <linux/i2c.h> +#include <linux/slab.h> +#include <linux/gpio.h>
+#include <sound/core.h> +#include <sound/soc.h> +#include <sound/tlv.h> +#include <sound/max9768.h>
+/* The register offsets in the cache array */ +#define MAX9768_VOL 0 +#define MAX9768_CTRL 3
+/* Commands */ +#define MAX9768_CTRL_PWM 0x15 +#define MAX9768_CTRL_FILTERLESS 0x16
+struct max9768 {
- struct i2c_client *client;
- int mute_gpio;
- int shdn_gpio;
The shutdown gpio is requested, but never used.
- u32 flags;
+};
+static const uint8_t max9768_default_regs[] = {
- 0x00, 0x00, 0x00, MAX9768_CTRL_FILTERLESS,
+};
+static int max9768_write(struct snd_soc_codec *codec, unsigned int reg,
unsigned int value)+{
- uint8_t data;
- int ret;
- ret = snd_soc_cache_write(codec, reg, value);
- if (ret < 0)
return ret;- data = (reg << 6) | value;
Adding support for this register type to regmap and use regmap then is the way to go. regmap should also be used for the cache instead of the legacy ASoC cache.
- ret = i2c_smbus_write_byte(codec->control_data, data);
- if (ret)
dev_err(codec->dev, "Failed to write register: %d\n", ret);- return ret;
+}
[...]
+static int max9768_probe(struct snd_soc_codec *codec) +{
- struct max9768 *max9768 = snd_soc_codec_get_drvdata(codec);
- int ret;
- codec->control_data = max9768->client;
- if (max9768->flags & MAX9768_FLAG_CLASSIC_PWM) {
ret = snd_soc_write(codec, MAX9768_CTRL, MAX9768_CTRL_PWM);if (ret)return ret;- }
- ret = snd_soc_add_controls(codec, max9768_volume,
ARRAY_SIZE(max9768_volume));- if (ret)
return ret;
Use the controls/num_controls fields of your codec_driver to register these controls.
- if (max9768->mute_gpio >= 0) {
ret = snd_soc_add_controls(codec, max9768_mute,ARRAY_SIZE(max9768_mute));if (ret)return ret;- }
- return 0;
+}
+static struct snd_soc_codec_driver soc_codec_dev_max9768 = {
max9768_codec_driver would be a better name.
- .write = max9768_write,
- .read = max9768_read,
- .probe = max9768_probe,
- .reg_cache_size = ARRAY_SIZE(max9768_default_regs),
- .reg_word_size = sizeof(uint8_t),
- .reg_cache_default = max9768_default_regs,
+};
+static int __devinit max9768_i2c_probe(struct i2c_client *client,
- const struct i2c_device_id *id)
+{
- struct max9768 *max9768;
- struct max9768_pdata *pdata = client->dev.platform_data;
- int err;
- max9768 = devm_kzalloc(&client->dev, sizeof(*max9768), GFP_KERNEL);
- if (!max9768)
return -ENOMEM;- if (pdata) {
/* Mute on powerup to avoid clicks */err = gpio_request_one(pdata->mute_gpio, GPIOF_INIT_HIGH, "MAX9768 Mute");max9768->mute_gpio = err ?: pdata->mute_gpio;/* Activate chip, enabling I2C */err = gpio_request_one(pdata->shdn_gpio, GPIOF_INIT_HIGH, "MAX9768 Shutdown");max9768->shdn_gpio = err ?: pdata->shdn_gpio;max9768->flags = pdata->flags;- } else {
max9768->shdn_gpio = -EINVAL;max9768->mute_gpio = -EINVAL;- }
- max9768->client = client;
- i2c_set_clientdata(client, max9768);
- return snd_soc_register_codec(&client->dev, &soc_codec_dev_max9768, NULL, 0);
GPIOs are not freed in case of an error.
+}
+static int __devexit max9768_i2c_remove(struct i2c_client *client) +{
- snd_soc_unregister_codec(&client->dev);
GPIOs are never freed.
- return 0;
+}
+struct max9768 {
- struct i2c_client *client;
- int mute_gpio;
- int shdn_gpio;
The shutdown gpio is requested, but never used.
It is initialized to HIGH, otherwise the chip won't do a thing. The pin can be later used for PM, but I don't need that now.
- ret = snd_soc_cache_write(codec, reg, value);
- if (ret < 0)
return ret;- data = (reg << 6) | value;
Adding support for this register type to regmap and use regmap then is the way to go. regmap should also be used for the cache instead of the legacy ASoC cache.
Okay, are you already at it? Otherwise I'll try adding this tomorrow.
- ret = snd_soc_add_controls(codec, max9768_volume,
ARRAY_SIZE(max9768_volume));- if (ret)
return ret;Use the controls/num_controls fields of your codec_driver to register these controls.
OK.
+static struct snd_soc_codec_driver soc_codec_dev_max9768 = {
max9768_codec_driver would be a better name.
OK.
- return snd_soc_register_codec(&client->dev, &soc_codec_dev_max9768, NULL, 0);
GPIOs are not freed in case of an error.
+}
+static int __devexit max9768_i2c_remove(struct i2c_client *client) +{
- snd_soc_unregister_codec(&client->dev);
GPIOs are never freed.
Eeeks, right, damn. Thanks!
Regards,
Wolfram
On 01/18/2012 08:26 PM, Wolfram Sang wrote:
- ret = snd_soc_cache_write(codec, reg, value);
- if (ret < 0)
return ret;- data = (reg << 6) | value;
Adding support for this register type to regmap and use regmap then is the way to go. regmap should also be used for the cache instead of the legacy ASoC cache.
Okay, are you already at it? Otherwise I'll try adding this tomorrow.
I won't have time for it before the weekend, so go ahead.
On Wed, Jan 18, 2012 at 04:38:28PM +0100, Wolfram Sang wrote:
+static int max9768_write(struct snd_soc_codec *codec, unsigned int reg,
unsigned int value)
Use regmap for register I/O please.
- data = (reg << 6) | value;
- ret = i2c_smbus_write_byte(codec->control_data, data);
You may need to add a new register format, but that shouldn't be too much work.
- if (max9768->flags & MAX9768_FLAG_CLASSIC_PWM) {
ret = snd_soc_write(codec, MAX9768_CTRL, MAX9768_CTRL_PWM);if (ret)return ret;- }
Some documentation on what this does would be nice. Is this something that might usefully be changed at runtime?
- ret = snd_soc_add_controls(codec, max9768_volume,
ARRAY_SIZE(max9768_volume));- if (ret)
return ret;
Use the controls field in the driver. I'd also expect to see some sort of DAPM support, even if it's just mapping out the pins. Since you're manually controlling the mute it'd be nice to make the unmute be (mute && power) to save on pops and clicks from the CODEC being amplified.
err = gpio_request_one(pdata->mute_gpio, GPIOF_INIT_HIGH, "MAX9768 Mute");max9768->mute_gpio = err ?: pdata->mute_gpio;
I really don't like the ternery operator at the best of times...
+static int max9768_write(struct snd_soc_codec *codec, unsigned int reg,
unsigned int value)Use regmap for register I/O please.
OK, currently negotiating this with Lars-Peter.
- if (max9768->flags & MAX9768_FLAG_CLASSIC_PWM) {
ret = snd_soc_write(codec, MAX9768_CTRL, MAX9768_CTRL_PWM);if (ret)return ret;- }
Some documentation on what this does would be nice. Is this something that might usefully be changed at runtime?
It only depends on the hardware design. Will a pointer to the section of the datasheet be enough for documentation?
- ret = snd_soc_add_controls(codec, max9768_volume,
ARRAY_SIZE(max9768_volume));- if (ret)
return ret;Use the controls field in the driver. I'd also expect to see some sort
Understood.
of DAPM support, even if it's just mapping out the pins. Since you're manually controlling the mute it'd be nice to make the unmute be (mute && power) to save on pops and clicks from the CODEC being amplified.
Sorry, not understood. Is there an example of what you mean here somewhere in the tree?
err = gpio_request_one(pdata->mute_gpio, GPIOF_INIT_HIGH, "MAX9768 Mute");max9768->mute_gpio = err ?: pdata->mute_gpio;I really don't like the ternery operator at the best of times...
Can we agree to disagree? It is so convenient here and saves a few lines.
Regards,
Wolfram
On Wed, Jan 18, 2012 at 08:33:20PM +0100, Wolfram Sang wrote:
Some documentation on what this does would be nice. Is this something that might usefully be changed at runtime?
It only depends on the hardware design. Will a pointer to the section of the datasheet be enough for documentation?
Yes.
of DAPM support, even if it's just mapping out the pins. Since you're manually controlling the mute it'd be nice to make the unmute be (mute && power) to save on pops and clicks from the CODEC being amplified.
Sorry, not understood. Is there an example of what you mean here somewhere in the tree?
The WM2000 is doing something sort of similar, though it's quite a bit more involved than just asserting a GPIO.
err = gpio_request_one(pdata->mute_gpio, GPIOF_INIT_HIGH, "MAX9768 Mute");max9768->mute_gpio = err ?: pdata->mute_gpio;
I really don't like the ternery operator at the best of times...
Can we agree to disagree? It is so convenient here and saves a few lines.
I'd rather not.
participants (3)
-
Lars-Peter Clausen -
Mark Brown -
Wolfram Sang