diff mbox

[v2,2/3] ASoC: pcm179x: Add I2C interface driver

Message ID 1453199388-8354-3-git-send-email-jacob@teenage.engineering (mailing list archive)
State New, archived
Headers show

Commit Message

Jacob Siverskog Jan. 19, 2016, 10:29 a.m. UTC
The PCM179x family supports both SPI and I2C. This patch adds support
for the I2C interface.

Reviewed-by: Johan Hovold <johan@kernel.org>
Signed-off-by: Jacob Siverskog <jacob@teenage.engineering>
---
 .../devicetree/bindings/sound/pcm179x.txt          | 11 ++-
 sound/soc/codecs/Kconfig                           |  9 +++
 sound/soc/codecs/Makefile                          |  2 +
 sound/soc/codecs/pcm179x-i2c.c                     | 82 ++++++++++++++++++++++
 4 files changed, 103 insertions(+), 1 deletion(-)
 create mode 100644 sound/soc/codecs/pcm179x-i2c.c

Comments

Michael Nazzareno Trimarchi Jan. 19, 2016, 10:50 a.m. UTC | #1
Hi Jacob

On Tue, Jan 19, 2016 at 11:29 AM, Jacob Siverskog
<jacob@teenage.engineering> wrote:
> The PCM179x family supports both SPI and I2C. This patch adds support
> for the I2C interface.
>
> Reviewed-by: Johan Hovold <johan@kernel.org>
> Signed-off-by: Jacob Siverskog <jacob@teenage.engineering>
> ---
>  .../devicetree/bindings/sound/pcm179x.txt          | 11 ++-
>  sound/soc/codecs/Kconfig                           |  9 +++
>  sound/soc/codecs/Makefile                          |  2 +
>  sound/soc/codecs/pcm179x-i2c.c                     | 82 ++++++++++++++++++++++
>  4 files changed, 103 insertions(+), 1 deletion(-)
>  create mode 100644 sound/soc/codecs/pcm179x-i2c.c
>
> diff --git a/Documentation/devicetree/bindings/sound/pcm179x.txt b/Documentation/devicetree/bindings/sound/pcm179x.txt
> index 4ae70d3..436c2b2 100644
> --- a/Documentation/devicetree/bindings/sound/pcm179x.txt
> +++ b/Documentation/devicetree/bindings/sound/pcm179x.txt
> @@ -1,6 +1,6 @@
>  Texas Instruments pcm179x DT bindings
>
> -This driver supports the SPI bus.
> +This driver supports both the I2C and SPI bus.
>
>  Required properties:
>
> @@ -9,6 +9,11 @@ Required properties:
>  For required properties on SPI, please consult
>  Documentation/devicetree/bindings/spi/spi-bus.txt
>
> +Required properties on I2C:
> +
> + - reg: the I2C address
> +
> +
>  Examples:
>
>         codec_spi: 1792a@0 {
> @@ -16,3 +21,7 @@ Examples:
>                 spi-max-frequency = <600000>;
>         };
>
> +       codec_i2c: 1792a@4c {
> +               compatible = "ti,pcm1792a";
> +               reg = <0x4c>;
> +       };
> diff --git a/sound/soc/codecs/Kconfig b/sound/soc/codecs/Kconfig
> index eaf13cb..45269cc 100644
> --- a/sound/soc/codecs/Kconfig
> +++ b/sound/soc/codecs/Kconfig
> @@ -87,6 +87,7 @@ config SND_SOC_ALL_CODECS
>         select SND_SOC_ML26124 if I2C
>         select SND_SOC_NAU8825 if I2C
>         select SND_SOC_PCM1681 if I2C
> +       select SND_SOC_PCM179X_I2C if I2C
>         select SND_SOC_PCM179X_SPI if SPI_MASTER
>         select SND_SOC_PCM3008
>         select SND_SOC_PCM3168A_I2C if I2C
> @@ -529,6 +530,14 @@ config SND_SOC_PCM1681
>  config SND_SOC_PCM179X
>         tristate
>
> +config SND_SOC_PCM179X_I2C
> +       tristate "Texas Instruments PCM179X CODEC family (I2C)"
> +       depends on I2C
> +       select SND_SOC_PCM179X
> +       help
> +         Enable support for Texas Instruments PCM179x CODEC family.
> +         Select this if your PCM179x is connected via an I2C bus.
> +
>  config SND_SOC_PCM179X_SPI
>         tristate "Texas Instruments PCM179X CODEC family (SPI)"
>         depends on SPI_MASTER
> diff --git a/sound/soc/codecs/Makefile b/sound/soc/codecs/Makefile
> index 56e94d8..9acd777 100644
> --- a/sound/soc/codecs/Makefile
> +++ b/sound/soc/codecs/Makefile
> @@ -81,6 +81,7 @@ snd-soc-ml26124-objs := ml26124.o
>  snd-soc-nau8825-objs := nau8825.o
>  snd-soc-pcm1681-objs := pcm1681.o
>  snd-soc-pcm179x-codec-objs := pcm179x.o
> +snd-soc-pcm179x-i2c-objs := pcm179x-i2c.o
>  snd-soc-pcm179x-spi-objs := pcm179x-spi.o
>  snd-soc-pcm3008-objs := pcm3008.o
>  snd-soc-pcm3168a-objs := pcm3168a.o
> @@ -286,6 +287,7 @@ obj-$(CONFIG_SND_SOC_ML26124)       += snd-soc-ml26124.o
>  obj-$(CONFIG_SND_SOC_NAU8825)   += snd-soc-nau8825.o
>  obj-$(CONFIG_SND_SOC_PCM1681)  += snd-soc-pcm1681.o
>  obj-$(CONFIG_SND_SOC_PCM179X)  += snd-soc-pcm179x-codec.o
> +obj-$(CONFIG_SND_SOC_PCM179X_I2C)      += snd-soc-pcm179x-i2c.o
>  obj-$(CONFIG_SND_SOC_PCM179X_SPI)      += snd-soc-pcm179x-spi.o
>  obj-$(CONFIG_SND_SOC_PCM3008)  += snd-soc-pcm3008.o
>  obj-$(CONFIG_SND_SOC_PCM3168A) += snd-soc-pcm3168a.o
> diff --git a/sound/soc/codecs/pcm179x-i2c.c b/sound/soc/codecs/pcm179x-i2c.c
> new file mode 100644
> index 0000000..5a5d61a
> --- /dev/null
> +++ b/sound/soc/codecs/pcm179x-i2c.c
> @@ -0,0 +1,82 @@
> +/*
> + * PCM179X ASoC I2C driver
> + *
> + * Copyright (c) Teenage Engineering AB 2016
> + *
> + *     Jacob Siverskog <jacob@teenage.engineering>
> + *
> + * 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.
> + */
> +
> +#include <linux/module.h>
> +#include <linux/of.h>
> +#include <linux/i2c.h>
> +#include <linux/regmap.h>
> +
> +#include "pcm179x.h"
> +
> +static int pcm179x_i2c_probe(struct i2c_client *client,
> +                             const struct i2c_device_id *id)
> +{
> +       struct pcm179x_private *pcm179x;
> +       int ret;
> +
> +       pcm179x = devm_kzalloc(&client->dev, sizeof(struct pcm179x_private),
> +                               GFP_KERNEL);
> +       if (!pcm179x)
> +               return -ENOMEM;
> +
> +       i2c_set_clientdata(client, pcm179x);
> +
> +       pcm179x->dev = &client->dev;
> +
> +       pcm179x->regmap = devm_regmap_init_i2c(client, &pcm179x_regmap_config);
> +       if (IS_ERR(pcm179x->regmap)) {
> +               ret = PTR_ERR(pcm179x->regmap);
> +               dev_err(&client->dev, "Failed to register regmap: %d\n", ret);
> +               return ret;
> +       }
> +

sound/soc/codecs/adau1781-spi.c

I like more how was done here for private data and codec data. What do
you think?

Michael

> +       return pcm179x_common_init(pcm179x);
> +}
> +
> +static int pcm179x_i2c_remove(struct i2c_client *client)
> +{
> +       return pcm179x_common_exit(i2c_get_clientdata(client));
> +}
> +
> +static const struct of_device_id pcm179x_of_match[] = {
> +       { .compatible = "ti,pcm1792a", },
> +       { }
> +};
> +MODULE_DEVICE_TABLE(of, pcm179x_of_match);
> +
> +static const struct i2c_device_id pcm179x_i2c_ids[] = {
> +       { "pcm179x", 0 },
> +       { }
> +};
> +MODULE_DEVICE_TABLE(i2c, pcm179x_i2c_ids);
> +
> +static struct i2c_driver pcm179x_i2c_driver = {
> +       .driver = {
> +               .name   = "pcm179x",
> +               .of_match_table = of_match_ptr(pcm179x_of_match),
> +       },
> +       .id_table       = pcm179x_i2c_ids,
> +       .probe          = pcm179x_i2c_probe,
> +       .remove         = pcm179x_i2c_remove,
> +};
> +
> +module_i2c_driver(pcm179x_i2c_driver);
> +
> +MODULE_DESCRIPTION("ASoC PCM179X I2C driver");
> +MODULE_AUTHOR("Jacob Siverskog <jacob@teenage.engineering>");
> +MODULE_LICENSE("GPL");
> --
> 2.7.0
>
Johan Hovold Jan. 19, 2016, 1:51 p.m. UTC | #2
On Tue, Jan 19, 2016 at 11:50:35AM +0100, Michael Trimarchi wrote:
> Hi Jacob
> 
> On Tue, Jan 19, 2016 at 11:29 AM, Jacob Siverskog
> <jacob@teenage.engineering> wrote:
> > The PCM179x family supports both SPI and I2C. This patch adds support
> > for the I2C interface.
> >
> > Reviewed-by: Johan Hovold <johan@kernel.org>
> > Signed-off-by: Jacob Siverskog <jacob@teenage.engineering>
> > ---

> > +static int pcm179x_i2c_probe(struct i2c_client *client,
> > +                             const struct i2c_device_id *id)
> > +{
> > +       struct pcm179x_private *pcm179x;
> > +       int ret;
> > +
> > +       pcm179x = devm_kzalloc(&client->dev, sizeof(struct pcm179x_private),
> > +                               GFP_KERNEL);
> > +       if (!pcm179x)
> > +               return -ENOMEM;
> > +
> > +       i2c_set_clientdata(client, pcm179x);
> > +
> > +       pcm179x->dev = &client->dev;
> > +
> > +       pcm179x->regmap = devm_regmap_init_i2c(client, &pcm179x_regmap_config);
> > +       if (IS_ERR(pcm179x->regmap)) {
> > +               ret = PTR_ERR(pcm179x->regmap);
> > +               dev_err(&client->dev, "Failed to register regmap: %d\n", ret);
> > +               return ret;
> > +       }
> > +
> 
> sound/soc/codecs/adau1781-spi.c
> 
> I like more how was done here for private data and codec data. What do
> you think?

Why do you prefer that?

Having a common_exit() to clean up whatever was done in common_init()
seems like a better design than open-coding this in both of the i2c and
spi drivers (if that's what you were referring to).

> > +       return pcm179x_common_init(pcm179x);
> > +}
> > +
> > +static int pcm179x_i2c_remove(struct i2c_client *client)
> > +{
> > +       return pcm179x_common_exit(i2c_get_clientdata(client));
> > +}

Thanks,
Johan
Michael Nazzareno Trimarchi Jan. 20, 2016, 4:58 a.m. UTC | #3
Hi

On Tue, Jan 19, 2016 at 2:51 PM, Johan Hovold <johan@kernel.org> wrote:
> On Tue, Jan 19, 2016 at 11:50:35AM +0100, Michael Trimarchi wrote:
>> Hi Jacob
>>
>> On Tue, Jan 19, 2016 at 11:29 AM, Jacob Siverskog
>> <jacob@teenage.engineering> wrote:
>> > The PCM179x family supports both SPI and I2C. This patch adds support
>> > for the I2C interface.
>> >
>> > Reviewed-by: Johan Hovold <johan@kernel.org>
>> > Signed-off-by: Jacob Siverskog <jacob@teenage.engineering>
>> > ---
>
>> > +static int pcm179x_i2c_probe(struct i2c_client *client,
>> > +                             const struct i2c_device_id *id)
>> > +{
>> > +       struct pcm179x_private *pcm179x;
>> > +       int ret;
>> > +
>> > +       pcm179x = devm_kzalloc(&client->dev, sizeof(struct pcm179x_private),
>> > +                               GFP_KERNEL);
>> > +       if (!pcm179x)
>> > +               return -ENOMEM;
>> > +
>> > +       i2c_set_clientdata(client, pcm179x);
>> > +
>> > +       pcm179x->dev = &client->dev;
>> > +
>> > +       pcm179x->regmap = devm_regmap_init_i2c(client, &pcm179x_regmap_config);
>> > +       if (IS_ERR(pcm179x->regmap)) {
>> > +               ret = PTR_ERR(pcm179x->regmap);
>> > +               dev_err(&client->dev, "Failed to register regmap: %d\n", ret);
>> > +               return ret;
>> > +       }
>> > +
>>
>> sound/soc/codecs/adau1781-spi.c
>>
>> I like more how was done here for private data and codec data. What do
>> you think?
>
> Why do you prefer that?
>
> Having a common_exit() to clean up whatever was done in common_init()
> seems like a better design than open-coding this in both of the i2c and
> spi drivers (if that's what you were referring to).
>

private data can be allocated in common code and you can pass the
regmap in the common init.
As I can understand in that way more common code is shared between i2c
and spi and make much
more clean and easy. I had a look very quick but I think that this was
the key point of that example

Michael

>> > +       return pcm179x_common_init(pcm179x);
>> > +}
>> > +
>> > +static int pcm179x_i2c_remove(struct i2c_client *client)
>> > +{
>> > +       return pcm179x_common_exit(i2c_get_clientdata(client));
>> > +}
>
> Thanks,
> Johan
Johan Hovold Jan. 20, 2016, 5:26 p.m. UTC | #4
On Wed, Jan 20, 2016 at 05:58:26AM +0100, Michael Trimarchi wrote:
> Hi
> 
> On Tue, Jan 19, 2016 at 2:51 PM, Johan Hovold <johan@kernel.org> wrote:
> > On Tue, Jan 19, 2016 at 11:50:35AM +0100, Michael Trimarchi wrote:
> >> Hi Jacob
> >>
> >> On Tue, Jan 19, 2016 at 11:29 AM, Jacob Siverskog
> >> <jacob@teenage.engineering> wrote:
> >> > The PCM179x family supports both SPI and I2C. This patch adds support
> >> > for the I2C interface.
> >> >
> >> > Reviewed-by: Johan Hovold <johan@kernel.org>
> >> > Signed-off-by: Jacob Siverskog <jacob@teenage.engineering>
> >> > ---
> >
> >> > +static int pcm179x_i2c_probe(struct i2c_client *client,
> >> > +                             const struct i2c_device_id *id)
> >> > +{
> >> > +       struct pcm179x_private *pcm179x;
> >> > +       int ret;
> >> > +
> >> > +       pcm179x = devm_kzalloc(&client->dev, sizeof(struct pcm179x_private),
> >> > +                               GFP_KERNEL);
> >> > +       if (!pcm179x)
> >> > +               return -ENOMEM;
> >> > +
> >> > +       i2c_set_clientdata(client, pcm179x);
> >> > +
> >> > +       pcm179x->dev = &client->dev;
> >> > +
> >> > +       pcm179x->regmap = devm_regmap_init_i2c(client, &pcm179x_regmap_config);
> >> > +       if (IS_ERR(pcm179x->regmap)) {
> >> > +               ret = PTR_ERR(pcm179x->regmap);
> >> > +               dev_err(&client->dev, "Failed to register regmap: %d\n", ret);
> >> > +               return ret;
> >> > +       }
> >> > +
> >>
> >> sound/soc/codecs/adau1781-spi.c
> >>
> >> I like more how was done here for private data and codec data. What do
> >> you think?
> >
> > Why do you prefer that?
> >
> > Having a common_exit() to clean up whatever was done in common_init()
> > seems like a better design than open-coding this in both of the i2c and
> > spi drivers (if that's what you were referring to).
> >
> 
> private data can be allocated in common code and you can pass the
> regmap in the common init.
> As I can understand in that way more common code is shared between i2c
> and spi and make much
> more clean and easy. I had a look very quick but I think that this was
> the key point of that example

You're right, and this seems to be how the other codec drivers do this
(unlike mfd for example). Some have a shared remove function, while most
call snd_soc_unregister_codec from the driver's remove callback, which
was what I found a bit odd as registration was done by the common init
code.

Thanks,
Johan
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/pcm179x.txt b/Documentation/devicetree/bindings/sound/pcm179x.txt
index 4ae70d3..436c2b2 100644
--- a/Documentation/devicetree/bindings/sound/pcm179x.txt
+++ b/Documentation/devicetree/bindings/sound/pcm179x.txt
@@ -1,6 +1,6 @@ 
 Texas Instruments pcm179x DT bindings
 
-This driver supports the SPI bus.
+This driver supports both the I2C and SPI bus.
 
 Required properties:
 
@@ -9,6 +9,11 @@  Required properties:
 For required properties on SPI, please consult
 Documentation/devicetree/bindings/spi/spi-bus.txt
 
+Required properties on I2C:
+
+ - reg: the I2C address
+
+
 Examples:
 
 	codec_spi: 1792a@0 {
@@ -16,3 +21,7 @@  Examples:
 		spi-max-frequency = <600000>;
 	};
 
+	codec_i2c: 1792a@4c {
+		compatible = "ti,pcm1792a";
+		reg = <0x4c>;
+	};
diff --git a/sound/soc/codecs/Kconfig b/sound/soc/codecs/Kconfig
index eaf13cb..45269cc 100644
--- a/sound/soc/codecs/Kconfig
+++ b/sound/soc/codecs/Kconfig
@@ -87,6 +87,7 @@  config SND_SOC_ALL_CODECS
 	select SND_SOC_ML26124 if I2C
 	select SND_SOC_NAU8825 if I2C
 	select SND_SOC_PCM1681 if I2C
+	select SND_SOC_PCM179X_I2C if I2C
 	select SND_SOC_PCM179X_SPI if SPI_MASTER
 	select SND_SOC_PCM3008
 	select SND_SOC_PCM3168A_I2C if I2C
@@ -529,6 +530,14 @@  config SND_SOC_PCM1681
 config SND_SOC_PCM179X
 	tristate
 
+config SND_SOC_PCM179X_I2C
+	tristate "Texas Instruments PCM179X CODEC family (I2C)"
+	depends on I2C
+	select SND_SOC_PCM179X
+	help
+	  Enable support for Texas Instruments PCM179x CODEC family.
+	  Select this if your PCM179x is connected via an I2C bus.
+
 config SND_SOC_PCM179X_SPI
 	tristate "Texas Instruments PCM179X CODEC family (SPI)"
 	depends on SPI_MASTER
diff --git a/sound/soc/codecs/Makefile b/sound/soc/codecs/Makefile
index 56e94d8..9acd777 100644
--- a/sound/soc/codecs/Makefile
+++ b/sound/soc/codecs/Makefile
@@ -81,6 +81,7 @@  snd-soc-ml26124-objs := ml26124.o
 snd-soc-nau8825-objs := nau8825.o
 snd-soc-pcm1681-objs := pcm1681.o
 snd-soc-pcm179x-codec-objs := pcm179x.o
+snd-soc-pcm179x-i2c-objs := pcm179x-i2c.o
 snd-soc-pcm179x-spi-objs := pcm179x-spi.o
 snd-soc-pcm3008-objs := pcm3008.o
 snd-soc-pcm3168a-objs := pcm3168a.o
@@ -286,6 +287,7 @@  obj-$(CONFIG_SND_SOC_ML26124)	+= snd-soc-ml26124.o
 obj-$(CONFIG_SND_SOC_NAU8825)   += snd-soc-nau8825.o
 obj-$(CONFIG_SND_SOC_PCM1681)	+= snd-soc-pcm1681.o
 obj-$(CONFIG_SND_SOC_PCM179X)	+= snd-soc-pcm179x-codec.o
+obj-$(CONFIG_SND_SOC_PCM179X_I2C)	+= snd-soc-pcm179x-i2c.o
 obj-$(CONFIG_SND_SOC_PCM179X_SPI)	+= snd-soc-pcm179x-spi.o
 obj-$(CONFIG_SND_SOC_PCM3008)	+= snd-soc-pcm3008.o
 obj-$(CONFIG_SND_SOC_PCM3168A)	+= snd-soc-pcm3168a.o
diff --git a/sound/soc/codecs/pcm179x-i2c.c b/sound/soc/codecs/pcm179x-i2c.c
new file mode 100644
index 0000000..5a5d61a
--- /dev/null
+++ b/sound/soc/codecs/pcm179x-i2c.c
@@ -0,0 +1,82 @@ 
+/*
+ * PCM179X ASoC I2C driver
+ *
+ * Copyright (c) Teenage Engineering AB 2016
+ *
+ *     Jacob Siverskog <jacob@teenage.engineering>
+ *
+ * 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.
+ */
+
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/i2c.h>
+#include <linux/regmap.h>
+
+#include "pcm179x.h"
+
+static int pcm179x_i2c_probe(struct i2c_client *client,
+			      const struct i2c_device_id *id)
+{
+	struct pcm179x_private *pcm179x;
+	int ret;
+
+	pcm179x = devm_kzalloc(&client->dev, sizeof(struct pcm179x_private),
+				GFP_KERNEL);
+	if (!pcm179x)
+		return -ENOMEM;
+
+	i2c_set_clientdata(client, pcm179x);
+
+	pcm179x->dev = &client->dev;
+
+	pcm179x->regmap = devm_regmap_init_i2c(client, &pcm179x_regmap_config);
+	if (IS_ERR(pcm179x->regmap)) {
+		ret = PTR_ERR(pcm179x->regmap);
+		dev_err(&client->dev, "Failed to register regmap: %d\n", ret);
+		return ret;
+	}
+
+	return pcm179x_common_init(pcm179x);
+}
+
+static int pcm179x_i2c_remove(struct i2c_client *client)
+{
+	return pcm179x_common_exit(i2c_get_clientdata(client));
+}
+
+static const struct of_device_id pcm179x_of_match[] = {
+	{ .compatible = "ti,pcm1792a", },
+	{ }
+};
+MODULE_DEVICE_TABLE(of, pcm179x_of_match);
+
+static const struct i2c_device_id pcm179x_i2c_ids[] = {
+	{ "pcm179x", 0 },
+	{ }
+};
+MODULE_DEVICE_TABLE(i2c, pcm179x_i2c_ids);
+
+static struct i2c_driver pcm179x_i2c_driver = {
+	.driver = {
+		.name	= "pcm179x",
+		.of_match_table = of_match_ptr(pcm179x_of_match),
+	},
+	.id_table	= pcm179x_i2c_ids,
+	.probe		= pcm179x_i2c_probe,
+	.remove		= pcm179x_i2c_remove,
+};
+
+module_i2c_driver(pcm179x_i2c_driver);
+
+MODULE_DESCRIPTION("ASoC PCM179X I2C driver");
+MODULE_AUTHOR("Jacob Siverskog <jacob@teenage.engineering>");
+MODULE_LICENSE("GPL");