ASoC: dwc: Add device tree support to designware I2S

PATCH Applied Andrew Jackson 3 participants 12 messages Dec 30, 2014

Subsystems (3)

Device tree bindings Sound ASoC

lore

Share & tools

lore

Andrew Jackson

author

2014-12-30 10:55 UTC #0 lore raw

v5 cover ASoC: dwc: Add device tree support to designware I2S

From: Andrew Jackson <[email protected]>

This patch set extends the DesignWare I2S driver to provide device tree support and fixes a couple of small faults.

Changes v4->v5
+ Remove all clk_put calls [Andrew Jackson]
+ Call clk_disable_unprepare [Andrew Jackson]

Changes v3->v4
+ Drop applied patches
+ Use combined function to prepare clock [Mark Brown]
+ Use managed clock resources to avoid clk_put [Mark Brown]
+ Read configuration prameters from hardware for both platform data and device tree [Mark Brown]
+ Re-order patch sequence [Mark Brown]
+ Change union name to avoid future collisions [Mark Brown]
+ Check return code from clk_set_rate [Mark Brown]
+ Check parametsrs read from hardware agaist array limits and add further comments [Mark Brown]
+ Add of_match_ptr [Mark Brown]

Changes v2->v3
+ Drop applied patch
+ Flush FIFOs in prepare rather than hw_params [Lars-Peter Clausen]

Changes v1->v2
+ Drop negative use count patch [Mark Brown]
+ Remove unnecessary debug print messages [Lars-Peter Clausen]
+ Rewrite iteration as for loop rather than do...while [Mark Brown]
+ Reorder patches to send fixes first [Mark Brown]
+ Simplify device tree code [Mark Brown]
+ Split device tree patch in two [Mark Brown]
+ Expand explanatory comment on channel configuration [Rajeev Kumar]

Arnd: I've not forgotten about updating the spear entries and
will submit as a separate patch.

Andrew Jackson (6):
ASoC: dwc: Switch to managed clock resource
ASoC: dwc: Prepare clock before use
ASoC: dwc: Read I2S block configuration from registers
ASoC: dwc: Register components with managed interface
ASoC: dwc: Add documentation for I2S DT
ASoC: dwc: Add devicetree support for Designware I2S

 .../devicetree/bindings/sound/designware-i2s.txt   |   31 +++
 sound/soc/dwc/Kconfig                              |    1 +
 sound/soc/dwc/designware_i2s.c                     |  283 ++++++++++++++++----
 3 files changed, 263 insertions(+), 52 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/designware-i2s.txt

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

Andrew Jackson

author

2014-12-30 10:55 UTC #1 lore raw

PATCH v5 1/6 ASoC: dwc: Switch to managed clock resource

From: Andrew Jackson <[email protected]>

Simplify error handling during probe by using managed clock resources.

Signed-off-by Andrew Jackson <[email protected]>

---
 sound/soc/dwc/designware_i2s.c |   10 ++--------
 1 files changed, 2 insertions(+), 8 deletions(-)

sound/soc/dwc/designware_i2s.c +2 -8

index 06d3a34..5e9d163 100644
@@ -407,13 +407,13 @@ static int dw_i2s_probe(struct platform_device *pdev)
 
 	dev->capability = pdata->cap;
 	dev->i2s_clk_cfg = pdata->i2s_clk_cfg;
-	dev->clk = clk_get(&pdev->dev, NULL);
+	dev->clk = devm_clk_get(&pdev->dev, NULL);
 	if (IS_ERR(dev->clk))
 		return  PTR_ERR(dev->clk);
 
 	ret = clk_enable(dev->clk);
 	if (ret < 0)
-		goto err_clk_put;
+		return ret;
 
 	dev_set_drvdata(&pdev->dev, dev);
 	ret = snd_soc_register_component(&pdev->dev, &dw_i2s_component,

@@ -427,19 +427,13 @@ static int dw_i2s_probe(struct platform_device *pdev)
 
 err_clk_disable:
 	clk_disable(dev->clk);
-err_clk_put:
-	clk_put(dev->clk);
 	return ret;
 }
 
 static int dw_i2s_remove(struct platform_device *pdev)
 {
-	struct dw_i2s_dev *dev = dev_get_drvdata(&pdev->dev);
-
 	snd_soc_unregister_component(&pdev->dev);
 
-	clk_put(dev->clk);
-
 	return 0;
 }

Signature · 1 line

1.7.1

Mark Brown

maintainer Applied

2014-12-30 16:49 UTC #2 lore raw

Re: [PATCH v5 1/6] ASoC: dwc: Switch to managed clock resource

Quoted 4 lines · Andrew Jackson

From: Andrew Jackson <[email protected]>
Simplify error handling during probe by using managed clock resources.

Applied, thanks.

Andrew Jackson

author

2014-12-30 10:55 UTC #3 lore raw

PATCH v5 2/6 ASoC: dwc: Prepare clock before use

In reply to Andrew Jackson

From: Andrew Jackson <[email protected]>

Some I2S clocks may require some time to get the clock ready for operation and so need to be prepared before they are enabled. So, prepare the clock as well as enabling it, but combine the two through clk_prepare_enable.

Signed-off-by Andrew Jackson <[email protected]>

---
 sound/soc/dwc/designware_i2s.c |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)

sound/soc/dwc/designware_i2s.c +5 -2

index 5e9d163..08608c1 100644
@@ -411,7 +411,7 @@ static int dw_i2s_probe(struct platform_device *pdev)
 	if (IS_ERR(dev->clk))
 		return  PTR_ERR(dev->clk);
 
-	ret = clk_enable(dev->clk);
+	ret = clk_prepare_enable(dev->clk);
 	if (ret < 0)
 		return ret;

@@ -426,13 +426,16 @@ static int dw_i2s_probe(struct platform_device *pdev)
 	return 0;
 
 err_clk_disable:
-	clk_disable(dev->clk);
+	clk_disable_unprepare(dev->clk);
 	return ret;
 }
 
 static int dw_i2s_remove(struct platform_device *pdev)
 {
+	struct dw_i2s_dev *dev = dev_get_drvdata(&pdev->dev);
+
 	snd_soc_unregister_component(&pdev->dev);
+	clk_disable_unprepare(dev->clk);
 
 	return 0;
 }

Signature · 1 line

1.7.1

Sergei Shtylyov

2014-12-30 12:39 UTC #4 lore raw

Re: [PATCH v5 2/6] ASoC: dwc: Prepare clock before use

Hello.

Quoted 16 lines · Andrew Jackson

From: Andrew Jackson <[email protected]>
Some I2S clocks may require some time to get the clock ready for operation and so need to be prepared before they are enabled. So, prepare the clock as well as enabling it, but combine the two through clk_prepare_enable.
Signed-off-by Andrew Jackson <[email protected]>
---
  sound/soc/dwc/designware_i2s.c |    7 +++++--
  1 files changed, 5 insertions(+), 2 deletions(-)
sound/soc/dwc/designware_i2s.c +0 -0
index 5e9d163..08608c1 100644

[...]

Quoted 1 line

sound/soc/dwc/designware_i2s.c +0 -0
@@ -426,13 +426,16 @@ static int dw_i2s_probe(struct platform_device *pdev)

[...]

sound/soc/dwc/designware_i2s.c static int dw_i2s_probe(struct platform_device *pdev) · line 435

Quoted 3 lines

  static int dw_i2s_remove(struct platform_device *pdev)
  {

sound/soc/dwc/designware_i2s.c +1 -0

+	struct dw_i2s_dev *dev = dev_get_drvdata(&pdev->dev);

Why not just platform_get_drvdata(pdev)?

[...]

WBR, Sergei

Mark Brown

maintainer

2014-12-30 16:51 UTC #5 lore raw

Re: [PATCH v5 2/6] ASoC: dwc: Prepare clock before use

In reply to Andrew Jackson

Quoted 6 lines · Andrew Jackson

From: Andrew Jackson <[email protected]>
Some I2S clocks may require some time to get the clock ready for operation and so need to be prepared before they are enabled. So, prepare the clock as well as enabling it, but combine the two through clk_prepare_enable.

Applied, though the changelog is inaccurate - the need to do things outside of hardirq context is the reason the common clock API has a prepare stage but it's just a flat out requirement of the common clock API to prepare clocks.

Andrew Jackson

author

2014-12-30 10:55 UTC #6 lore raw

PATCH v5 3/6 ASoC: dwc: Read I2S block configuration from registers

In reply to Andrew Jackson

From: Andrew Jackson <[email protected]>

The I2S block provides component parameter registers which describe how the block is instantiated. Use these registers to extract the block's configuration rather than relying on platform data.

Signed-off-by Andrew Jackson <[email protected]>

---
 sound/soc/dwc/designware_i2s.c |   96 +++++++++++++++++++++++++++++++++++----
 1 files changed, 86 insertions(+), 10 deletions(-)

sound/soc/dwc/designware_i2s.c +86 ~~-10~~

index 08608c1..b3e7567 100644
@@ -54,6 +54,31 @@
 #define I2S_COMP_VERSION	0x01F8
 #define I2S_COMP_TYPE		0x01FC
 
+/*
+ * Component parameter register fields - define the I2S block's
+ * configuration.
+ */
+#define	COMP1_TX_WORDSIZE_3(r)	(((r) & GENMASK(27, 25)) >> 25)
+#define	COMP1_TX_WORDSIZE_2(r)	(((r) & GENMASK(24, 22)) >> 22)
+#define	COMP1_TX_WORDSIZE_1(r)	(((r) & GENMASK(21, 19)) >> 19)
+#define	COMP1_TX_WORDSIZE_0(r)	(((r) & GENMASK(18, 16)) >> 16)
+#define	COMP1_TX_CHANNELS(r)	(((r) & GENMASK(10, 9)) >> 9)
+#define	COMP1_RX_CHANNELS(r)	(((r) & GENMASK(8, 7)) >> 7)
+#define	COMP1_RX_ENABLED(r)	(((r) & BIT(6)) >> 6)
+#define	COMP1_TX_ENABLED(r)	(((r) & BIT(5)) >> 5)
+#define	COMP1_MODE_EN(r)	(((r) & BIT(4)) >> 4)
+#define	COMP1_FIFO_DEPTH_GLOBAL(r)	(((r) & GENMASK(3, 2)) >> 2)
+#define	COMP1_APB_DATA_WIDTH(r)	(((r) & GENMASK(1, 0)) >> 0)
+
+#define	COMP2_RX_WORDSIZE_3(r)	(((r) & GENMASK(12, 10)) >> 10)
+#define	COMP2_RX_WORDSIZE_2(r)	(((r) & GENMASK(9, 7)) >> 7)
+#define	COMP2_RX_WORDSIZE_1(r)	(((r) & GENMASK(5, 3)) >> 3)
+#define	COMP2_RX_WORDSIZE_0(r)	(((r) & GENMASK(2, 0)) >> 0)
+
+/* Number of entries in WORDSIZE and DATA_WIDTH parameter registers */
+#define	COMP_MAX_WORDSIZE	(1 << 3)
+#define	COMP_MAX_DATA_WIDTH	(1 << 2)
+
 #define MAX_CHANNEL_NUM		8
 #define MIN_CHANNEL_NUM		2

@@ -335,11 +360,50 @@ static int dw_i2s_resume(struct snd_soc_dai *dai)
 #define dw_i2s_resume	NULL
 #endif
 
-static void dw_configure_dai_by_pd(struct dw_i2s_dev *dev,
+/*
+ * The following tables allow a direct lookup of various parameters
+ * defined in the I2S block's configuration in terms of sound system
+ * parameters.  Each table is sized to the number of entries possible
+ * according to the number of configuration bits describing an I2S
+ * block parameter.
+ */
+
+/* Width of (DMA) bus */
+static const u32 bus_widths[COMP_MAX_DATA_WIDTH] = {
+	DMA_SLAVE_BUSWIDTH_1_BYTE,
+	DMA_SLAVE_BUSWIDTH_2_BYTES,
+	DMA_SLAVE_BUSWIDTH_4_BYTES,
+	DMA_SLAVE_BUSWIDTH_UNDEFINED
+};
+
+/* PCM format to support channel resolution */
+static const u32 formats[COMP_MAX_WORDSIZE] = {
+	SNDRV_PCM_FMTBIT_S16_LE,
+	SNDRV_PCM_FMTBIT_S16_LE,
+	SNDRV_PCM_FMTBIT_S24_LE,
+	SNDRV_PCM_FMTBIT_S24_LE,
+	SNDRV_PCM_FMTBIT_S32_LE,
+	0,
+	0,
+	0
+};
+
+static int dw_configure_dai_by_pd(struct dw_i2s_dev *dev,
 				   struct snd_soc_dai_driver *dw_i2s_dai,
 				   struct resource *res,
 				   const struct i2s_platform_data *pdata)
 {
+	/*
+	 * Read component parameter registers to extract
+	 * the I2S block's configuration.
+	 */
+	u32 comp1 = i2s_read_reg(dev->i2s_base, I2S_COMP_PARAM_1);
+	u32 comp2 = i2s_read_reg(dev->i2s_base, I2S_COMP_PARAM_2);
+	u32 idx = COMP1_APB_DATA_WIDTH(comp1);
+
+	if (WARN_ON(idx >= ARRAY_SIZE(bus_widths)))
+		return -EINVAL;
+
 	/* Set DMA slaves info */
 
 	dev->play_dma_data.data = pdata->play_dma_data;

@@ -348,26 +412,36 @@ static void dw_configure_dai_by_pd(struct dw_i2s_dev *dev,
 	dev->capture_dma_data.addr = res->start + I2S_RXDMA;
 	dev->play_dma_data.max_burst = 16;
 	dev->capture_dma_data.max_burst = 16;
-	dev->play_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES;
-	dev->capture_dma_data.addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES;
+	dev->play_dma_data.addr_width = bus_widths[idx];
+	dev->capture_dma_data.addr_width = bus_widths[idx];
 	dev->play_dma_data.filter = pdata->filter;
 	dev->capture_dma_data.filter = pdata->filter;
 
-	if (pdata->cap & DWC_I2S_PLAY) {
+	if (COMP1_TX_ENABLED(comp1)) {
 		dev_dbg(dev->dev, " designware: play supported\n");
+		idx = COMP1_TX_WORDSIZE_0(comp1);
+		if (WARN_ON(idx >= ARRAY_SIZE(formats)))
+			return -EINVAL;
 		dw_i2s_dai->playback.channels_min = MIN_CHANNEL_NUM;
-		dw_i2s_dai->playback.channels_max = pdata->channel;
-		dw_i2s_dai->playback.formats = pdata->snd_fmts;
+		dw_i2s_dai->playback.channels_max =
+				1 << (COMP1_TX_CHANNELS(comp1) + 1);
+		dw_i2s_dai->playback.formats = formats[idx];
 		dw_i2s_dai->playback.rates = pdata->snd_rates;
 	}
 
-	if (pdata->cap & DWC_I2S_RECORD) {
+	if (COMP1_RX_ENABLED(comp1)) {
 		dev_dbg(dev->dev, "designware: record supported\n");
+		idx = COMP2_RX_WORDSIZE_0(comp2);
+		if (WARN_ON(idx >= ARRAY_SIZE(formats)))
+			return -EINVAL;
 		dw_i2s_dai->capture.channels_min = MIN_CHANNEL_NUM;
-		dw_i2s_dai->capture.channels_max = pdata->channel;
-		dw_i2s_dai->capture.formats = pdata->snd_fmts;
+		dw_i2s_dai->capture.channels_max =
+				1 << (COMP1_RX_CHANNELS(comp1) + 1);
+		dw_i2s_dai->capture.formats = formats[idx];
 		dw_i2s_dai->capture.rates = pdata->snd_rates;
 	}
+
+	return 0;
 }
 
 static int dw_i2s_probe(struct platform_device *pdev)

@@ -403,7 +477,9 @@ static int dw_i2s_probe(struct platform_device *pdev)
 		return PTR_ERR(dev->i2s_base);
 
 	dev->dev = &pdev->dev;
-	dw_configure_dai_by_pd(dev, dw_i2s_dai, res, pdata);
+	ret = dw_configure_dai_by_pd(dev, dw_i2s_dai, res, pdata);
+	if (ret < 0)
+		return ret;
 
 	dev->capability = pdata->cap;
 	dev->i2s_clk_cfg = pdata->i2s_clk_cfg;

Signature · 1 line

1.7.1

Andrew Jackson

author

2014-12-30 10:55 UTC #7 lore raw

PATCH v5 4/6 ASoC: dwc: Register components with managed interface

In reply to Andrew Jackson

From: Andrew Jackson <[email protected]>

Signed-off-by Andrew Jackson <[email protected]>

---
 sound/soc/dwc/designware_i2s.c |    3 +--
 1 files changed, 1 insertions(+), 2 deletions(-)

sound/soc/dwc/designware_i2s.c +1 -2

index b3e7567..e1c0e2c 100644
@@ -492,7 +492,7 @@ static int dw_i2s_probe(struct platform_device *pdev)
 		return ret;
 
 	dev_set_drvdata(&pdev->dev, dev);
-	ret = snd_soc_register_component(&pdev->dev, &dw_i2s_component,
+	ret = devm_snd_soc_register_component(&pdev->dev, &dw_i2s_component,
 					 dw_i2s_dai, 1);
 	if (ret != 0) {
 		dev_err(&pdev->dev, "not able to register dai\n");

@@ -510,7 +510,6 @@ static int dw_i2s_remove(struct platform_device *pdev)
 {
 	struct dw_i2s_dev *dev = dev_get_drvdata(&pdev->dev);
 
-	snd_soc_unregister_component(&pdev->dev);
 	clk_disable_unprepare(dev->clk);
 
 	return 0;

Signature · 1 line

1.7.1

Andrew Jackson

author

2014-12-30 10:55 UTC #8 lore raw

PATCH v5 5/6 ASoC: dwc: Add documentation for I2S DT

In reply to Andrew Jackson

From: Andrew Jackson <[email protected]>

Add documentation for Designware I2S hardware block. The block requires one clock (for audio sampling) and DMA channels for receive and transmit.

Signed-off-by Andrew Jackson <[email protected]>

---
 .../devicetree/bindings/sound/designware-i2s.txt   |   31 ++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/designware-i2s.txt

Documentation/devicetree/bindings/sound/designware-i2s.txt new file +31 -0

new file mode 100644
index 0000000..7bb5424
@@ -0,0 +1,31 @@
+DesignWare I2S controller
+
+Required properties:
+ - compatible : Must be "snps,designware-i2s"
+ - reg : Must contain the I2S core's registers location and length
+ - clocks : Pairs of phandle and specifier referencing the controller's
+   clocks. The controller expects one clock: the clock used as the sampling
+   rate reference clock sample.
+ - clock-names : "i2sclk" for the sample rate reference clock.
+ - dmas: Pairs of phandle and specifier for the DMA channels that are used by
+   the core. The core expects one or two dma channels: one for transmit and
+   one for receive.
+ - dma-names : "tx" for the transmit channel, "rx" for the receive channel.
+
+For more details on the 'dma', 'dma-names', 'clock' and 'clock-names'
+properties please check:
+	* resource-names.txt
+	* clock/clock-bindings.txt
+	* dma/dma.txt
+
+Example:
+
+	soc_i2s: i2s@7ff90000 {
+		compatible = "snps,designware-i2s";
+		reg = <0x0 0x7ff90000 0x0 0x1000>;
+		clocks = <&scpi_i2sclk 0>;
+		clock-names = "i2sclk";
+		#sound-dai-cells = <0>;
+		dmas = <&dma0 5>;
+		dma-names = "tx";
+	};

Signature · 1 line

1.7.1

Mark Brown

maintainer Applied

2014-12-30 16:52 UTC #9 lore raw

Re: [PATCH v5 5/6] ASoC: dwc: Add documentation for I2S DT

Quoted 4 lines · Andrew Jackson

From: Andrew Jackson <[email protected]>
Add documentation for Designware I2S hardware block. The block requires one clock (for audio sampling) and DMA channels for receive and transmit.

Applied, thanks.

Andrew Jackson

author

2014-12-30 10:55 UTC #10 lore raw

PATCH v5 6/6 ASoC: dwc: Add devicetree support for Designware I2S

In reply to Andrew Jackson

From: Andrew Jackson <[email protected]>

Allow the driver to be configured through a device tree rather than platform data.

Signed-off-by Andrew Jackson <[email protected]>

---
 sound/soc/dwc/Kconfig          |    1 +
 sound/soc/dwc/designware_i2s.c |  193 +++++++++++++++++++++++++++++++---------
 2 files changed, 151 insertions(+), 43 deletions(-)

sound/soc/dwc/Kconfig +1 -0

index e334900..d50e085 100644
@@ -1,6 +1,7 @@
 config SND_DESIGNWARE_I2S
 	tristate "Synopsys I2S Device Driver"
 	depends on CLKDEV_LOOKUP
+	select SND_SOC_GENERIC_DMAENGINE_PCM
 	help
 	 Say Y or M if you want to add support for I2S driver for
 	 Synopsys desigwnware I2S device. The device supports upto

sound/soc/dwc/designware_i2s.c +150 ~~-43~~

289 lines not on this page · raw message

Signature · 1 line

1.7.1

Mark Brown

maintainer

2014-12-30 16:53 UTC #11 lore raw

Re: [PATCH v5 6/6] ASoC: dwc: Add devicetree support for Designware I2S

Quoted 4 lines · Andrew Jackson

From: Andrew Jackson <[email protected]>
Allow the driver to be configured through a device tree rather than platform data.

Applied but...

sound/soc/dwc/designware_i2s.c static int dw_i2s_remove(struct platform_device *pdev) · line 629

Quoted 3 lines

sound/soc/dwc/designware_i2s.c +3 -0

+#ifdef CONFIG_OF
+		.of_match_table = of_match_ptr(dw_i2s_of_match),
+#endif

...the whole point of of_match_ptr() is that it avoids the need for the ifdef, please send a followup removing them.