diff mbox

[V3,02/10] ASoC: qcom: Document MAX98357A bindings

Message ID 1419439330-2303-3-git-send-email-kwestfie@codeaurora.org
State Needs Review / ACK, archived
Headers show

Checks

Context Check Description
robh/checkpatch warning total: 1 errors, 0 warnings, 0 lines checked
robh/patch-applied success

Commit Message

Kenneth Westfield Dec. 24, 2014, 4:42 p.m. UTC 
From: Kenneth Westfield <kwestfie@codeaurora.org>

Add documentation to the sound directory of the
device-tree bindings for the Maxim MAX98357A audio
codec driver.

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

Comments

Mark Brown Dec. 29, 2014, 4:07 p.m. UTC | #1 
On Wed, Dec 24, 2014 at 08:42:02AM -0800, Kenneth Westfield wrote:
> From: Kenneth Westfield <kwestfie@codeaurora.org>
> 
> Add documentation to the sound directory of the
> device-tree bindings for the Maxim MAX98357A audio
> codec driver.

Your subject line says "qcom" but this isn't a Qualcomm thing...

> +Required properties:
> +- compatible  : "maxim,max98357a"
> +- sdmode-gpios: Phandle to the GPIO specifier for the GPIO -> DAC SDMODE pin

> +max98357a {
> +	compatible = "maxim,max98357a";
> +	sdmode-gpios = <&qcom_pinmux 25 0>;

A GPIO specifier is not a phandle (as your example shows).  Just say
it's a GPIO specifier.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/max98357a.txt b/Documentation/devicetree/bindings/sound/max98357a.txt
new file mode 100644
index 0000000000000000000000000000000000000000..718e9578d42d522db15fc41a42a96eca327ac641
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/max98357a.txt
@@ -0,0 +1,14 @@ 
+Maxim MAX98357A audio DAC
+
+This node models the Maxim MAX98357A DAC as a codec DAI.
+
+Required properties:
+- compatible  : "maxim,max98357a"
+- sdmode-gpios: Phandle to the GPIO specifier for the GPIO -> DAC SDMODE pin
+
+Example:
+
+max98357a {
+	compatible = "maxim,max98357a";
+	sdmode-gpios = <&qcom_pinmux 25 0>;
+};