diff mbox

[V7,03/10] ASoC: qcom: Document Storm bindings

Message ID 1425428519-12224-4-git-send-email-kwestfie@codeaurora.org (mailing list archive)
State New, archived
Headers show

Commit Message

Kenneth Westfield March 4, 2015, 12:21 a.m. UTC 
From: Kenneth Westfield <kwestfie@codeaurora.org>

Add documentation to the sound directory of the
device-tree bindings for the soundcard of the
Storm board.

Signed-off-by: Kenneth Westfield <kwestfie@codeaurora.org>
Acked-by: Banajit Goswami <bgoswami@codeaurora.org>
---
 Documentation/devicetree/bindings/sound/storm.txt | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/storm.txt

Comments

Mark Brown March 6, 2015, 11:18 a.m. UTC | #1 
On Tue, Mar 03, 2015 at 04:21:52PM -0800, Kenneth Westfield wrote:

> +Required properties:
> +
> +- compatible	: "google,storm"

I'm not convinced about this compatible - it's the name of the entire
machine from the looks of it which means it'll collide with any other
similar machine driver type things needed on the board.  Adding an
-audio or something on the end of the name should cover it unless anyone
has any other bright ideas.

Ideally we'd be able to load drivers off the machine identifier that we
already have but nobody seems to want to do that so...
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/storm.txt b/Documentation/devicetree/bindings/sound/storm.txt
new file mode 100644
index 0000000000000000000000000000000000000000..2a308e9c4cd3f9550c0b7078200a14a787f02858
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/storm.txt
@@ -0,0 +1,23 @@ 
+* Sound complex for Storm boards
+
+Models a soundcard for Storm boards with the Qualcomm Technologies IPQ806x SOC
+connected to a MAX98357A DAC via I2S.
+
+Required properties:
+
+- compatible	: "google,storm"
+- cpu		: Phandle of the CPU DAI
+- codec		: Phandle of the codec DAI
+
+Optional properties:
+
+- qcom,model	: The user-visible name of this sound card.
+
+Example:
+
+sound {
+	compatible = "google,storm";
+	qcom,model = "ipq806x-storm";
+	cpu = <&lpass_cpu>;
+	codec = <&max98357a>;
+};