[alsa-devel] [Patch V5 04/12] ASoC: qcom: Document IPQ806X-MAX89357A bindings

[Kenneth Westfield]

From: Kenneth Westfield <kwestfie at codeaurora.org>

Add documentation to the sound directory of the
device-tree bindings for the IPQ806x-MAX98357A
soundcard.

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

diff --git a/Documentation/devicetree/bindings/sound/qcom,ipq806x-max98357a.txt b/Documentation/devicetree/bindings/sound/qcom,ipq806x-max98357a.txt
new file mode 100644
index 0000000000000000000000000000000000000000..54c6211ce34ab8eb5c764df516c875694eeab3cb
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/qcom,ipq806x-max98357a.txt
@@ -0,0 +1,24 @@
+* Qualcomm Technologies IPQ806x-MAX98357A SoundCard
+
+This node models a soundcard for boards with the Qualcomm Technologies IPQ806x
+SOC connected to a MAX98357A DAC via I2S.
+
+Required properties:
+
+- compatible	: "qcom,ipq806x-max98357a"
+- qcom,model	: The user-visible name of this sound card.
+- cpu		: Phandle of the CPU DAI
+- codec		: Phandle of the codec DAI
+- codec-dai	: Name of the codec DAI which must be selected from one of the
+		  following entries:
+			* max98357a
+
+Example:
+
+sound {
+	compatible = "qcom,ipq806x-max98357a";
+	model = "ipq806x-max98357a";
+	cpu = <&lpass_cpu>;
+	codec = <&max98357a>;
+	codec-dai = "max98357a";
+};
-- 
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project