diff mbox

[v1,1/2] ASoC: Add DT bindings documentation for max98504 amplifier

Message ID 1466095238-9047-1-git-send-email-s.nawrocki@samsung.com (mailing list archive)
State New, archived
Headers show

Commit Message

Sylwester Nawrocki/Kernel \(PLT\) /SRPOL/Staff Engineer/Samsung Electronics June 16, 2016, 4:40 p.m. UTC 
This patch adds DT bindings documentation for Maxim MAX98504
speaker amplifier.

Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
---
Changes since initial version:
 - dropped all optional properties used for setting up TDM and
   speaker data source,
 - added regulator supply properties.
---
 .../devicetree/bindings/sound/max98504.txt         | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/max98504.txt

Comments

Rob Herring (Arm) June 20, 2016, 1:15 p.m. UTC | #1 
On Thu, Jun 16, 2016 at 06:40:37PM +0200, Sylwester Nawrocki wrote:
> This patch adds DT bindings documentation for Maxim MAX98504
> speaker amplifier.
> 
> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
> ---
> Changes since initial version:
>  - dropped all optional properties used for setting up TDM and
>    speaker data source,
>  - added regulator supply properties.
> ---
>  .../devicetree/bindings/sound/max98504.txt         | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/max98504.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/max98504.txt b/Documentation/devicetree/bindings/sound/max98504.txt
> new file mode 100644
> index 0000000..7aa5b93
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/max98504.txt
> @@ -0,0 +1,22 @@
> +Maxim MAX98504 class D mono speaker amplifier
> +
> +This device supports I2C control interface and an IRQ output signal. It features
> +a PCM and PDM digital audio interface (DAI) and a differential analog input.

Where's the IRQ in the binding?

> +
> +Required properties:
> +
> + - compatible : "maxim,max98504"
> + - reg : should contain the I2C slave device address
> + - DVDD-supply, DIOVDD-supply, PVDD-supply: power supplies for the device,
> +   as covered in Documentation/devicetree/bindings/regulator/regulator.txt
> +
> +Example:
> +
> + max98504: max98504@31 {
> +	compatible = "maxim,max98504";
> +	reg = <0x31>;
> +
> +	DVDD-supply = <&regulator>;
> +	DIOVDD-supply = <&regulator>;
> +	PVDD-supply = <&regulator>;
> +};
> -- 
> 1.9.1
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
Sylwester Nawrocki/Kernel \(PLT\) /SRPOL/Staff Engineer/Samsung Electronics June 20, 2016, 1:49 p.m. UTC | #2 
On 06/20/2016 03:15 PM, Rob Herring wrote:
>> diff --git a/Documentation/devicetree/bindings/sound/max98504.txt 
>> b/Documentation/devicetree/bindings/sound/max98504.txt
>> > new file mode 100644
>> > index 0000000..7aa5b93
>> > --- /dev/null
>> > +++ b/Documentation/devicetree/bindings/sound/max98504.txt
>> > @@ -0,0 +1,22 @@
>> > +Maxim MAX98504 class D mono speaker amplifier
>> > +
>> > +This device supports I2C control interface and an IRQ output signal. It features
>> > +a PCM and PDM digital audio interface (DAI) and a differential analog input.
>
> Where's the IRQ in the binding?

It seems I didn't do my homework and didn't add it here, even though
the driver currently uses the interrupt. I'll add something like this
in next iteration:

 - interrupts : should specify the interrupt the device is connected to,
   as described in ../interrupt-controller/interrupts.txt
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/max98504.txt b/Documentation/devicetree/bindings/sound/max98504.txt
new file mode 100644
index 0000000..7aa5b93
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/max98504.txt
@@ -0,0 +1,22 @@ 
+Maxim MAX98504 class D mono speaker amplifier
+
+This device supports I2C control interface and an IRQ output signal. It features
+a PCM and PDM digital audio interface (DAI) and a differential analog input.
+
+Required properties:
+
+ - compatible : "maxim,max98504"
+ - reg : should contain the I2C slave device address
+ - DVDD-supply, DIOVDD-supply, PVDD-supply: power supplies for the device,
+   as covered in Documentation/devicetree/bindings/regulator/regulator.txt
+
+Example:
+
+ max98504: max98504@31 {
+	compatible = "maxim,max98504";
+	reg = <0x31>;
+
+	DVDD-supply = <&regulator>;
+	DIOVDD-supply = <&regulator>;
+	PVDD-supply = <&regulator>;
+};