[1/2] ASoC: lochnagar: Add device tree binding document

Commit Message

Charles Keepax March 20, 2019, 2:28 p.m. UTC

Lochnagar is an evaluation and development board for Cirrus
Logic Smart CODEC and Amp devices. It allows the connection of
most Cirrus Logic devices on mini-cards, as well as allowing
connection of various application processor systems to provide a
full evaluation platform. This driver supports the board
controller chip on the Lochnagar board.

Signed-off-by: Charles Keepax <[e-mail]>
---
 .../devicetree/bindings/sound/cirrus,lochnagar.txt | 39 ++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/cirrus,lochnagar.txt

Comments

Mark Brown March 20, 2019, 4:52 p.m. UTC | #1

On Wed, Mar 20, 2019 at 02:28:12PM +0000, Charles Keepax wrote:

> +  - clock-names : Must include the following clocks:
> +      "ln-sound-mclk" Master clock source for the sound card, should
> +      normally be set to LOCHNAGAR_SOUNDCARD_MCLK provided by the
> +      Lochnagar clock driver.

Why the namespacing on the clock name here?

Charles Keepax March 20, 2019, 5:05 p.m. UTC | #2

On Wed, Mar 20, 2019 at 04:52:51PM +0000, Mark Brown wrote:
> On Wed, Mar 20, 2019 at 02:28:12PM +0000, Charles Keepax wrote:
> 
> > +  - clock-names : Must include the following clocks:
> > +      "ln-sound-mclk" Master clock source for the sound card, should
> > +      normally be set to LOCHNAGAR_SOUNDCARD_MCLK provided by the
> > +      Lochnagar clock driver.
> 
> Why the namespacing on the clock name here?

I think this is just a hang over from when these clocks were not
handled through DT and thus had to have the same name as was used
in the clock driver. Agree it is redundant now and will remove,
maybe even just mclk should be fine I guess, as the sound is
kinda redundant as well.

Thanks,
Charles

Patch

diff --git a/Documentation/devicetree/bindings/sound/cirrus,lochnagar.txt b/Documentation/devicetree/bindings/sound/cirrus,lochnagar.txt
new file mode 100644
index 0000000000000..fba5fb53a2f90
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/cirrus,lochnagar.txt
@@ -0,0 +1,39 @@ 
+Cirrus Logic Lochnagar Audio Development Board
+
+Lochnagar is an evaluation and development board for Cirrus Logic
+Smart CODEC and Amp devices. It allows the connection of most Cirrus
+Logic devices on mini-cards, as well as allowing connection of
+various application processor systems to provide a full evaluation
+platform.  Audio system topology, clocking and power can all be
+controlled through the Lochnagar, allowing the device under test
+to be used in a variety of possible use cases.
+
+This binding document describes the binding for the audio portion
+of the driver.
+
+This binding must be part of the Lochnagar MFD binding:
+  [4] ../mfd/cirrus,lochnagar.txt
+
+Required properties:
+
+  - compatible : One of the following strings:
+                 "cirrus,lochnagar2-soundcard"
+
+  - #sound-dai-cells : Must be set to 1.
+
+  - clocks : Contains an entry for each entry in clock-names.
+  - clock-names : Must include the following clocks:
+      "ln-sound-mclk" Master clock source for the sound card, should
+      normally be set to LOCHNAGAR_SOUNDCARD_MCLK provided by the
+      Lochnagar clock driver.
+
+Example:
+
+lochnagar-sc {
+	compatible = "cirrus,lochnagar2-soundcard";
+
+	#sound-dai-cells = <1>;
+
+	clocks = <&lochnagar_clk LOCHNAGAR_SOUNDCARD_MCLK>;
+	clock-names = "ln-soundcard-mclk";
+};