[alsa-devel] [PATCH 0/2] ASoC: Add support for MikroElektronika PROTO codec
This patchset is based on Florian's initial PROTO driver: https://lkml.org/lkml/2013/5/22/342
My changes made the driver more generic, so that we could connect other I2S CPU DAIs, by using device-tree.
Tested with sama5d2 I2S driver.
Codrin Ciubotariu (2): ASoC: Add driver for PROTO Audio CODEC (with a WM8731) ASoC: mikroe-proto: dt-bindings: add DT bindings for PROTO board
.../bindings/sound/mikroe,mikroe-proto.txt | 23 +++ .../devicetree/bindings/vendor-prefixes.txt | 1 + sound/soc/atmel/Kconfig | 7 + sound/soc/atmel/Makefile | 2 + sound/soc/atmel/mikroe-proto.c | 189 ++++++++++++++++++ 5 files changed, 222 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/mikroe,mikroe-proto.txt create mode 100644 sound/soc/atmel/mikroe-proto.c
Add support for the MikroElektronika PROTO audio codec board.
URL to the audio chip: http://www.mikroe.com/add-on-boards/audio-voice/audio-codec-proto/
Signed-off-by: Florian Meier florian.meier@koalo.de Signed-off-by: Codrin Ciubotariu codrin.ciubotariu@microchip.com --- sound/soc/atmel/Kconfig | 7 ++ sound/soc/atmel/Makefile | 2 + sound/soc/atmel/mikroe-proto.c | 189 +++++++++++++++++++++++++++++++++ 3 files changed, 198 insertions(+) create mode 100644 sound/soc/atmel/mikroe-proto.c
diff --git a/sound/soc/atmel/Kconfig b/sound/soc/atmel/Kconfig index 539ef33e670a..fbf4d3e42c18 100644 --- a/sound/soc/atmel/Kconfig +++ b/sound/soc/atmel/Kconfig @@ -97,4 +97,11 @@ config SND_ATMEL_SOC_I2S help Say Y or M if you want to add support for Atmel ASoc driver for boards using I2S. + +config SND_SOC_MIKROE_PROTO + tristate "Support for Mikroe-PROTO board" + depends on OF + select SND_SOC_WM8731 + help + Say Y or M if you want to add support for Audio Codec Board PROTO (WM8731). endif diff --git a/sound/soc/atmel/Makefile b/sound/soc/atmel/Makefile index cd87cb4bcff5..9f41bfa0fea3 100644 --- a/sound/soc/atmel/Makefile +++ b/sound/soc/atmel/Makefile @@ -17,6 +17,7 @@ snd-soc-sam9x5-wm8731-objs := sam9x5_wm8731.o snd-atmel-soc-classd-objs := atmel-classd.o snd-atmel-soc-pdmic-objs := atmel-pdmic.o snd-atmel-soc-tse850-pcm5142-objs := tse850-pcm5142.o +snd-soc-mikroe-proto-objs := mikroe-proto.o
obj-$(CONFIG_SND_AT91_SOC_SAM9G20_WM8731) += snd-soc-sam9g20-wm8731.o obj-$(CONFIG_SND_ATMEL_SOC_WM8904) += snd-atmel-soc-wm8904.o @@ -24,3 +25,4 @@ obj-$(CONFIG_SND_AT91_SOC_SAM9X5_WM8731) += snd-soc-sam9x5-wm8731.o obj-$(CONFIG_SND_ATMEL_SOC_CLASSD) += snd-atmel-soc-classd.o obj-$(CONFIG_SND_ATMEL_SOC_PDMIC) += snd-atmel-soc-pdmic.o obj-$(CONFIG_SND_ATMEL_SOC_TSE850_PCM5142) += snd-atmel-soc-tse850-pcm5142.o +obj-$(CONFIG_SND_SOC_MIKROE_PROTO) += snd-soc-mikroe-proto.o diff --git a/sound/soc/atmel/mikroe-proto.c b/sound/soc/atmel/mikroe-proto.c new file mode 100644 index 000000000000..9d9dc1c8ac6b --- /dev/null +++ b/sound/soc/atmel/mikroe-proto.c @@ -0,0 +1,189 @@ +/* + * ASoC driver for PROTO AudioCODEC (with a WM8731) + * + * Author: Florian Meier, koalo@koalo.de + * Copyright 2013 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + */ + +#include <linux/module.h> +#include <linux/platform_device.h> + +#include <sound/core.h> +#include <sound/pcm.h> +#include <sound/soc.h> +#include <sound/jack.h> + +#include "../codecs/wm8731.h" + +#define XTAL_RATE 12288000 /* This is fixed on this board */ + +static const unsigned int wm8731_rates_12288000[] = { + 8000, 32000, 48000, 96000, +}; + +static struct snd_pcm_hw_constraint_list wm8731_constraints_12288000 = { + .list = wm8731_rates_12288000, + .count = ARRAY_SIZE(wm8731_rates_12288000), +}; + +static int snd_proto_startup(struct snd_pcm_substream *substream) +{ + /* Setup constraints, because there is a 12.288 MHz XTAL on the board */ + snd_pcm_hw_constraint_list(substream->runtime, 0, + SNDRV_PCM_HW_PARAM_RATE, + &wm8731_constraints_12288000); + return 0; +} + +/* machine stream operations */ +static struct snd_soc_ops snd_proto_ops = { + .startup = snd_proto_startup, +}; + +static int snd_proto_init(struct snd_soc_pcm_runtime *rtd) +{ + struct snd_soc_codec *codec = rtd->codec; + struct snd_soc_dai *codec_dai = rtd->codec_dai; + + /* Set proto sysclk */ + int ret = snd_soc_dai_set_sysclk(codec_dai, WM8731_SYSCLK_XTAL, + XTAL_RATE, SND_SOC_CLOCK_IN); + if (ret < 0) { + dev_err(codec->dev, "Failed to set WM8731 SYSCLK: %d\n", ret); + return ret; + } + + return 0; +} + +static const struct snd_soc_dapm_widget snd_proto_widget[] = { + SND_SOC_DAPM_MIC("Microphone Jack", NULL), + SND_SOC_DAPM_HP("Headphone Jack", NULL), +}; + +static const struct snd_soc_dapm_route snd_proto_route[] = { + /* speaker connected to LHPOUT/RHPOUT */ + {"Headphone Jack", NULL, "LHPOUT"}, + {"Headphone Jack", NULL, "RHPOUT"}, + + /* mic is connected to Mic Jack, with WM8731 Mic Bias */ + {"MICIN", NULL, "Mic Bias"}, + {"Mic Bias", NULL, "Microphone Jack"}, +}; + +/* audio machine driver */ +static struct snd_soc_card snd_proto = { + .name = "snd_mikroe_proto", + .owner = THIS_MODULE, + .dapm_widgets = snd_proto_widget, + .num_dapm_widgets = ARRAY_SIZE(snd_proto_widget), + .dapm_routes = snd_proto_route, + .num_dapm_routes = ARRAY_SIZE(snd_proto_route), +}; + +static int snd_proto_probe(struct platform_device *pdev) +{ + struct snd_soc_dai_link *dai; + struct device_node *np = pdev->dev.of_node; + struct device_node *codec_np, *cpu_np; + struct device_node *bitclkmaster = NULL; + struct device_node *framemaster = NULL; + unsigned int dai_fmt; + int ret = 0; + + if (!np) { + dev_err(&pdev->dev, "No device node supplied\n"); + return -EINVAL; + } + + snd_proto.dev = &pdev->dev; + ret = snd_soc_of_parse_card_name(&snd_proto, "model"); + if (ret) + return ret; + + dai = devm_kzalloc(&pdev->dev, sizeof(*dai), GFP_KERNEL); + if (!dai) + return -ENOMEM; + + snd_proto.dai_link = dai; + snd_proto.num_links = 1; + + dai->name = "WM8731"; + dai->stream_name = "WM8731 HiFi"; + dai->codec_dai_name = "wm8731-hifi"; + dai->init = &snd_proto_init; + dai->ops = &snd_proto_ops; + + codec_np = of_parse_phandle(np, "audio-codec", 0); + if (!codec_np) { + dev_err(&pdev->dev, "audio-codec node missing\n"); + return -EINVAL; + } + dai->codec_of_node = codec_np; + + cpu_np = of_parse_phandle(np, "i2s-controller", 0); + if (!cpu_np) { + dev_err(&pdev->dev, "i2s-controller missing\n"); + return -EINVAL; + } + dai->cpu_of_node = cpu_np; + dai->platform_of_node = cpu_np; + + dai_fmt = snd_soc_of_parse_daifmt(np, NULL, + &bitclkmaster, &framemaster); + if (bitclkmaster != framemaster) { + dev_err(&pdev->dev, "Must be the same bitclock and frame master\n"); + return -EINVAL; + } + if (bitclkmaster) { + dai_fmt &= ~SND_SOC_DAIFMT_MASTER_MASK; + if (codec_np == bitclkmaster) + dai_fmt |= SND_SOC_DAIFMT_CBM_CFM; + else + dai_fmt |= SND_SOC_DAIFMT_CBS_CFS; + } + of_node_put(bitclkmaster); + of_node_put(framemaster); + dai->dai_fmt = dai_fmt; + + of_node_put(codec_np); + of_node_put(cpu_np); + + ret = snd_soc_register_card(&snd_proto); + if (ret && ret != -EPROBE_DEFER) + dev_err(&pdev->dev, + "snd_soc_register_card() failed: %d\n", ret); + + return ret; +} + +static int snd_proto_remove(struct platform_device *pdev) +{ + return snd_soc_unregister_card(&snd_proto); +} + +static const struct of_device_id snd_proto_of_match[] = { + { .compatible = "mikroe,mikroe-proto", }, + {}, +}; +MODULE_DEVICE_TABLE(of, snd_proto_of_match); + +static struct platform_driver snd_proto_driver = { + .driver = { + .name = "snd-mikroe-proto", + .owner = THIS_MODULE, + .of_match_table = snd_proto_of_match, + }, + .probe = snd_proto_probe, + .remove = snd_proto_remove, +}; + +module_platform_driver(snd_proto_driver); + +MODULE_AUTHOR("Florian Meier"); +MODULE_DESCRIPTION("ASoC Driver for PROTO board (WM8731)"); +MODULE_LICENSE("GPL");
On Wed, Aug 29, 2018 at 05:47:26PM +0300, Codrin Ciubotariu wrote:
+static const unsigned int wm8731_rates_12288000[] = {
- 8000, 32000, 48000, 96000,
+};
+static struct snd_pcm_hw_constraint_list wm8731_constraints_12288000 = {
- .list = wm8731_rates_12288000,
- .count = ARRAY_SIZE(wm8731_rates_12288000),
+};
+static int snd_proto_startup(struct snd_pcm_substream *substream) +{
- /* Setup constraints, because there is a 12.288 MHz XTAL on the board */
- snd_pcm_hw_constraint_list(substream->runtime, 0,
SNDRV_PCM_HW_PARAM_RATE,
&wm8731_constraints_12288000);
- return 0;
+}
This bit is better added to the CODEC driver since it'll apply to any system where there's this clock rate (someone else could come in and add other rates, no need to do that yourself though it'd be nice of course).
That also has the nice bonus that with that I think you'd be able to use the graph card rather than a custom driver?
On 29.08.2018 17:53, Mark Brown wrote:
On Wed, Aug 29, 2018 at 05:47:26PM +0300, Codrin Ciubotariu wrote:
+static const unsigned int wm8731_rates_12288000[] = {
- 8000, 32000, 48000, 96000,
+};
+static struct snd_pcm_hw_constraint_list wm8731_constraints_12288000 = {
- .list = wm8731_rates_12288000,
- .count = ARRAY_SIZE(wm8731_rates_12288000),
+};
+static int snd_proto_startup(struct snd_pcm_substream *substream) +{
- /* Setup constraints, because there is a 12.288 MHz XTAL on the board */
- snd_pcm_hw_constraint_list(substream->runtime, 0,
SNDRV_PCM_HW_PARAM_RATE,
&wm8731_constraints_12288000);
- return 0;
+}
This bit is better added to the CODEC driver since it'll apply to any system where there's this clock rate (someone else could come in and add other rates, no need to do that yourself though it'd be nice of course).
I could do it.
That also has the nice bonus that with that I think you'd be able to use the graph card rather than a custom driver?
The main reason for adding a custom driver and not using graph/simple card is the snd_soc_dai_set_sysclk(codec_dai, WM8731_SYSCLK_XTAL, XTAL_RATE, SND_SOC_CLOCK_IN) call. This enables the oscillator found in the wm8731 codec. Since WM8731_SYSCLK_XTAL is not 0, we can't use system-clock-frequency DT property to set it.
Best regards, Codrin
On Wed, Aug 29, 2018 at 06:20:59PM +0300, Codrin Ciubotariu wrote:
On 29.08.2018 17:53, Mark Brown wrote:
That also has the nice bonus that with that I think you'd be able to use the graph card rather than a custom driver?
The main reason for adding a custom driver and not using graph/simple card is the snd_soc_dai_set_sysclk(codec_dai, WM8731_SYSCLK_XTAL, XTAL_RATE, SND_SOC_CLOCK_IN) call. This enables the oscillator found in the wm8731 codec. Since WM8731_SYSCLK_XTAL is not 0, we can't use system-clock-frequency DT property to set it.
Right, that'd be more substantial surgery on the driver to change the DT binding so that it's got a clock provider in it; it'd be nice to do but it's a bit much to make it a blocker so the machine driver is OK.
On 29.08.2018 18:20, Codrin Ciubotariu wrote:
On 29.08.2018 17:53, Mark Brown wrote:
On Wed, Aug 29, 2018 at 05:47:26PM +0300, Codrin Ciubotariu wrote:
+static const unsigned int wm8731_rates_12288000[] = { + 8000, 32000, 48000, 96000, +};
+static struct snd_pcm_hw_constraint_list wm8731_constraints_12288000 = { + .list = wm8731_rates_12288000, + .count = ARRAY_SIZE(wm8731_rates_12288000), +};
+static int snd_proto_startup(struct snd_pcm_substream *substream) +{ + /* Setup constraints, because there is a 12.288 MHz XTAL on the board */ + snd_pcm_hw_constraint_list(substream->runtime, 0, + SNDRV_PCM_HW_PARAM_RATE, + &wm8731_constraints_12288000); + return 0; +}
This bit is better added to the CODEC driver since it'll apply to any system where there's this clock rate (someone else could come in and add other rates, no need to do that yourself though it'd be nice of course).
I could do it.
It looks like these constraints are already in the wm8731 driver. I will wait for more comments and then I will send a v2 without this part.
Thanks and best regards, Codrin
Hi Codrin,
Thank you for the patch! Yet something to improve:
[auto build test ERROR on at91/at91-next] [also build test ERROR on v4.19-rc1 next-20180829] [if your patch is applied to the wrong git tree, please drop us a note to help improve the system]
url: https://github.com/0day-ci/linux/commits/Codrin-Ciubotariu/ASoC-Add-driver-f... base: https://git.kernel.org/pub/scm/linux/kernel/git/nferre/linux-at91.git at91-next config: i386-allmodconfig (attached as .config) compiler: gcc-7 (Debian 7.3.0-16) 7.3.0 reproduce: # save the attached .config to linux build tree make ARCH=i386
All errors (new ones prefixed by >>):
sound/soc/atmel/mikroe-proto.c: In function 'snd_proto_init':
sound/soc/atmel/mikroe-proto.c:49:35: error: 'struct snd_soc_pcm_runtime' has no member named 'codec'
struct snd_soc_codec *codec = rtd->codec; ^~
sound/soc/atmel/mikroe-proto.c:56:16: error: dereferencing pointer to incomplete type 'struct snd_soc_codec'
dev_err(codec->dev, "Failed to set WM8731 SYSCLK: %d\n", ret); ^~
vim +49 sound/soc/atmel/mikroe-proto.c
46 47 static int snd_proto_init(struct snd_soc_pcm_runtime *rtd) 48 {
49 struct snd_soc_codec *codec = rtd->codec;
50 struct snd_soc_dai *codec_dai = rtd->codec_dai; 51 52 /* Set proto sysclk */ 53 int ret = snd_soc_dai_set_sysclk(codec_dai, WM8731_SYSCLK_XTAL, 54 XTAL_RATE, SND_SOC_CLOCK_IN); 55 if (ret < 0) {
56 dev_err(codec->dev, "Failed to set WM8731 SYSCLK: %d\n", ret);
57 return ret; 58 } 59 60 return 0; 61 } 62
--- 0-DAY kernel test infrastructure Open Source Technology Center https://lists.01.org/pipermail/kbuild-all Intel Corporation
Hi Codrin,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on at91/at91-next] [also build test WARNING on v4.19-rc1 next-20180830] [if your patch is applied to the wrong git tree, please drop us a note to help improve the system]
url: https://github.com/0day-ci/linux/commits/Codrin-Ciubotariu/ASoC-Add-driver-f... base: https://git.kernel.org/pub/scm/linux/kernel/git/nferre/linux-at91.git at91-next
coccinelle warnings: (new ones prefixed by >>)
sound/soc/atmel/mikroe-proto.c:178:3-8: No need to set .owner here. The core will do it.
Please review and possibly fold the followup patch.
--- 0-DAY kernel test infrastructure Open Source Technology Center https://lists.01.org/pipermail/kbuild-all Intel Corporation
From: kbuild test robot fengguang.wu@intel.com
sound/soc/atmel/mikroe-proto.c:178:3-8: No need to set .owner here. The core will do it.
Remove .owner field if calls are used which set it automatically
Generated by: scripts/coccinelle/api/platform_no_drv_owner.cocci
Fixes: 395c2cec021d ("ASoC: Add driver for PROTO Audio CODEC (with a WM8731)") CC: Codrin Ciubotariu codrin.ciubotariu@microchip.com Signed-off-by: kbuild test robot fengguang.wu@intel.com ---
url: https://github.com/0day-ci/linux/commits/Codrin-Ciubotariu/ASoC-Add-driver-f... base: https://git.kernel.org/pub/scm/linux/kernel/git/nferre/linux-at91.git at91-next
mikroe-proto.c | 1 - 1 file changed, 1 deletion(-)
--- a/sound/soc/atmel/mikroe-proto.c +++ b/sound/soc/atmel/mikroe-proto.c @@ -175,7 +175,6 @@ MODULE_DEVICE_TABLE(of, snd_proto_of_mat static struct platform_driver snd_proto_driver = { .driver = { .name = "snd-mikroe-proto", - .owner = THIS_MODULE, .of_match_table = snd_proto_of_match, }, .probe = snd_proto_probe,
DT binding documentation for this new ASoC driver.
Signed-off-by: Codrin Ciubotariu codrin.ciubotariu@microchip.com --- .../bindings/sound/mikroe,mikroe-proto.txt | 23 +++++++++++++++++++ .../devicetree/bindings/vendor-prefixes.txt | 1 + 2 files changed, 24 insertions(+) create mode 100644 Documentation/devicetree/bindings/sound/mikroe,mikroe-proto.txt
diff --git a/Documentation/devicetree/bindings/sound/mikroe,mikroe-proto.txt b/Documentation/devicetree/bindings/sound/mikroe,mikroe-proto.txt new file mode 100644 index 000000000000..912f8fae11c5 --- /dev/null +++ b/Documentation/devicetree/bindings/sound/mikroe,mikroe-proto.txt @@ -0,0 +1,23 @@ +Mikroe-PROTO audio board + +Required properties: + - compatible: "mikroe,mikroe-proto" + - dai-format: Must be "i2s". + - i2s-controller: The phandle of the I2S controller. + - audio-codec: The phandle of the WM8731 audio codec. +Optional properties: + - model: The user-visible name of this sound complex. + - bitclock-master: Indicates dai-link bit clock master; for details see simple-card.txt (1). + - frame-master: Indicates dai-link frame master; for details see simple-card.txt (1). + +(1) : There must be the same master for both bit and frame clocks. + +Example: + sound { + compatible = "mikroe,mikroe-proto"; + model = "wm8731 @ sama5d2_xplained"; + i2s-controller = <&i2s0>; + audio-codec = <&wm8731>; + dai-format = "i2s"; + }; +}; diff --git a/Documentation/devicetree/bindings/vendor-prefixes.txt b/Documentation/devicetree/bindings/vendor-prefixes.txt index f4a98c85340a..8ac3ec1f36e5 100644 --- a/Documentation/devicetree/bindings/vendor-prefixes.txt +++ b/Documentation/devicetree/bindings/vendor-prefixes.txt @@ -210,6 +210,7 @@ micron Micron Technology Inc. minix MINIX Technology Ltd. miramems MiraMEMS Sensing Technology Co., Ltd. mitsubishi Mitsubishi Electric Corporation +mikroe MikroElektronika d.o.o. mosaixtech Mosaix Technologies, Inc. motorola Motorola, Inc. moxa Moxa Inc.
participants (4)
-
Codrin Ciubotariu
-
kbuild test robot
-
kbuild test robot
-
Mark Brown