[2/2] ASoC: tas5756m: Add DT binding document
diff mbox series

Message ID 20200118092315.10384-2-charles-antoine.couret@essensium.com
State New
Headers show
Series
  • [1/2] ASoC: add TAS5756m driver
Related show

Commit Message

Couret Charles-Antoine Jan. 18, 2020, 9:23 a.m. UTC
Document the bindings for the tas5756m driver.
---
 .../devicetree/bindings/sound/tas5756m.txt    | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/tas5756m.txt

Comments

Rob Herring Jan. 22, 2020, 4:15 p.m. UTC | #1
On Sat, Jan 18, 2020 at 10:23:15AM +0100, Charles-Antoine Couret wrote:
> Document the bindings for the tas5756m driver.
> ---
>  .../devicetree/bindings/sound/tas5756m.txt    | 25 +++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/tas5756m.txt

Can you make this a DT schema.

> 
> diff --git a/Documentation/devicetree/bindings/sound/tas5756m.txt b/Documentation/devicetree/bindings/sound/tas5756m.txt
> new file mode 100644
> index 000000000000..293eaf20d008
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/tas5756m.txt
> @@ -0,0 +1,25 @@
> +TAS5756M audio CODEC
> +
> +Required properties:
> +
> +  - compatible: should be one of the following:
> +    - "ti,tas5756m"
> +    - "ti,tas5754m"
> +  - reg: the I2C address of the device for I2C.
> +
> +Optional properties:
> +
> +  - mute-gpio : GPIO wired to the mute pin.

mute-gpios is the preferred form.

> +  - hybridflow : an integer between 1 and 9 to select the HybridFlow program.
> +      if not supplied default DSP program is used.

Needs a vendor prefix.

Is this something fixed for the life of a board or something users would 
want to change at runtime?

> +
> +Example:
> +
> +	tas5756m: tas5756m@4c {
> +		compatible = "ti,tas5756m";
> +		reg = <0x4c>;
> +		#sound-dai-cells = <0>;

Not documented.

> +
> +		hybridflow = <6>;
> +		mute-gpio = <&gpio1 11 GPIO_ACTIVE_LOW>;
> +	};
> -- 
> 2.24.1
>
Rob Herring Jan. 22, 2020, 4:16 p.m. UTC | #2
On Sat, Jan 18, 2020 at 10:23:15AM +0100, Charles-Antoine Couret wrote:
> Document the bindings for the tas5756m driver.

Also, checkpatch.pl reports your S-o-b is missing.

> ---
>  .../devicetree/bindings/sound/tas5756m.txt    | 25 +++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/tas5756m.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/tas5756m.txt b/Documentation/devicetree/bindings/sound/tas5756m.txt
> new file mode 100644
> index 000000000000..293eaf20d008
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/tas5756m.txt
> @@ -0,0 +1,25 @@
> +TAS5756M audio CODEC
> +
> +Required properties:
> +
> +  - compatible: should be one of the following:
> +    - "ti,tas5756m"
> +    - "ti,tas5754m"
> +  - reg: the I2C address of the device for I2C.
> +
> +Optional properties:
> +
> +  - mute-gpio : GPIO wired to the mute pin.
> +  - hybridflow : an integer between 1 and 9 to select the HybridFlow program.
> +      if not supplied default DSP program is used.
> +
> +Example:
> +
> +	tas5756m: tas5756m@4c {
> +		compatible = "ti,tas5756m";
> +		reg = <0x4c>;
> +		#sound-dai-cells = <0>;
> +
> +		hybridflow = <6>;
> +		mute-gpio = <&gpio1 11 GPIO_ACTIVE_LOW>;
> +	};
> -- 
> 2.24.1
>
Couret Charles-Antoine Jan. 22, 2020, 9:23 p.m. UTC | #3
Le 22/01/2020 à 17:15, Rob Herring a écrit :

> Can you make this a DT schema.
Ok, thank you for the notice.
>> +Optional properties:
>> +
>> +  - mute-gpio : GPIO wired to the mute pin.
> mute-gpios is the preferred form.
I will fix it.
>> +  - hybridflow : an integer between 1 and 9 to select the HybridFlow program.
>> +      if not supplied default DSP program is used.
> Needs a vendor prefix.
>
> Is this something fixed for the life of a board or something users would
> want to change at runtime?

This shouldn't be changed on runtime. It is possible but it does not 
make sense to me.

Firstly we have to stop the device before switching the hybridflow.

Then it changes the available ALSA commands at runtime. The hybridflow 
must be chosen to match requirements of the speaker behind (like 2.1, 
woofer or tweeter).


Thank you for your advices.

Regards,

Charles-Antoine Couret

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/sound/tas5756m.txt b/Documentation/devicetree/bindings/sound/tas5756m.txt
new file mode 100644
index 000000000000..293eaf20d008
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/tas5756m.txt
@@ -0,0 +1,25 @@ 
+TAS5756M audio CODEC
+
+Required properties:
+
+  - compatible: should be one of the following:
+    - "ti,tas5756m"
+    - "ti,tas5754m"
+  - reg: the I2C address of the device for I2C.
+
+Optional properties:
+
+  - mute-gpio : GPIO wired to the mute pin.
+  - hybridflow : an integer between 1 and 9 to select the HybridFlow program.
+      if not supplied default DSP program is used.
+
+Example:
+
+	tas5756m: tas5756m@4c {
+		compatible = "ti,tas5756m";
+		reg = <0x4c>;
+		#sound-dai-cells = <0>;
+
+		hybridflow = <6>;
+		mute-gpio = <&gpio1 11 GPIO_ACTIVE_LOW>;
+	};