[v2,1/6] dt-bindings: sound: Document jz4740-codec bindings

Message ID 20190207133143.5232-1-paul@crapouillou.net
State Not Applicable
Headers show
Series
  • [v2,1/6] dt-bindings: sound: Document jz4740-codec bindings
Related show

Checks

Context Check Description
robh/checkpatch success

Commit Message

Paul Cercueil Feb. 7, 2019, 1:31 p.m.
Add documentation about how to probe the jz4740-codec driver from
devicetree.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
---

Changes:

v2: No change

 .../bindings/sound/ingenic,jz4740-codec.txt          | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/ingenic,jz4740-codec.txt

Comments

Mark Brown Feb. 7, 2019, 2 p.m. | #1
On Thu, Feb 07, 2019 at 10:31:38AM -0300, Paul Cercueil wrote:
> Add documentation about how to probe the jz4740-codec driver from
> devicetree.

Please do not submit new versions of already applied patches, please
submit incremental updates to the existing code.  Modifying existing
commits creates problems for other users building on top of those
commits so it's best practice to only change pubished git commits if
absolutely essential.
Paul Cercueil Feb. 7, 2019, 2:17 p.m. | #2
Hi Mark,

On Thu, Feb 7, 2019 at 11:00 AM, Mark Brown <broonie@kernel.org> wrote:
> On Thu, Feb 07, 2019 at 10:31:38AM -0300, Paul Cercueil wrote:
>>  Add documentation about how to probe the jz4740-codec driver from
>>  devicetree.
> 
> Please do not submit new versions of already applied patches, please
> submit incremental updates to the existing code.  Modifying existing
> commits creates problems for other users building on top of those
> commits so it's best practice to only change pubished git commits if
> absolutely essential.

Well you only applied patch 6/6, didn't you? I only see this one in your
tree.

-Paul
Mark Brown Feb. 7, 2019, 3:22 p.m. | #3
On Thu, Feb 07, 2019 at 11:17:37AM -0300, Paul Cercueil wrote:

> Well you only applied patch 6/6, didn't you? I only see this one in your
> tree.

Hrm, yeah.  Wonder what happened there...

Patch

diff --git a/Documentation/devicetree/bindings/sound/ingenic,jz4740-codec.txt b/Documentation/devicetree/bindings/sound/ingenic,jz4740-codec.txt
new file mode 100644
index 000000000000..1ffcade87e7b
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/ingenic,jz4740-codec.txt
@@ -0,0 +1,20 @@ 
+Ingenic JZ4740 codec controller
+
+Required properties:
+- compatible : "ingenic,jz4740-codec"
+- reg : codec registers location and length
+- clocks : phandle to the AIC clock.
+- clock-names: must be set to "aic".
+- #sound-dai-cells: Must be set to 0.
+
+Example:
+
+codec: audio-codec@10020080 {
+	compatible = "ingenic,jz4740-codec";
+	reg = <0x10020080 0x8>;
+
+	#sound-dai-cells = <0>;
+
+	clocks = <&cgu JZ4740_CLK_AIC>;
+	clock-names = "aic";
+};