diff mbox

[8/8] ASoC: samsung, tm2-audio DT binding documentation update

Message ID 20180205154403.13520-9-s.nawrocki@samsung.com (mailing list archive)
State Accepted
Commit 3a3ac1ea898399f14748a358dd33262c97a9a86b
Headers show

Commit Message

This patch documents additional entries of the audio-codec and
i2s-controller properties required for the HDMI audio support.

Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
---
 .../devicetree/bindings/sound/samsung,tm2-audio.txt        | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

Comments

Krzysztof Kozlowski Feb. 6, 2018, 1:05 p.m. UTC | #1
On Mon, Feb 5, 2018 at 4:44 PM, Sylwester Nawrocki
<s.nawrocki@samsung.com> wrote:
> This patch documents additional entries of the audio-codec and
> i2s-controller properties required for the HDMI audio support.
>
> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
> ---
>  .../devicetree/bindings/sound/samsung,tm2-audio.txt        | 14 +++++++++-----
>  1 file changed, 9 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
> index 94442e5673b3..f5ccc12ddc00 100644
> --- a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
> +++ b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
> @@ -4,9 +4,13 @@ Required properties:
>
>   - compatible           : "samsung,tm2-audio"
>   - model                : the user-visible name of this sound complex
> - - audio-codec          : the phandle of the wm5110 audio codec node,
> -                          as described in ../mfd/arizona.txt
> - - i2s-controller       : the phandle of the I2S controller
> + - audio-codec          : the first entry should be phandle of the wm5110 audio
> +                          codec node, as described in ../mfd/arizona.txt;
> +                          the second entry should be phandle of the HDMI

AFAIU, this property is still optional so the wording should be
different. Maybe just add "optional properties" paragraph?

Best regards,
Krzysztof

> +                          transmitter node
> + - i2s-controller       : the list of phandle and argument tuples pointing to
> +                          I2S controllers, the first entry should be I2S0 and
> +                          the second one I2S1
>   - audio-amplifier      : the phandle of the MAX98504 amplifier
>   - samsung,audio-routing : a list of the connections between audio components;
>                            each entry is a pair of strings, the first being the
> @@ -22,8 +26,8 @@ Example:
>
>  sound {
>         compatible = "samsung,tm2-audio";
> -       audio-codec = <&wm5110>;
> -       i2s-controller = <&i2s0>;
> +       audio-codec = <&wm5110>, <&hdmi>;
> +       i2s-controller = <&i2s0 0>, <&i2s1 0>;
>         audio-amplifier = <&max98504>;
>         mic-bias-gpios = <&gpr3 2 0>;
>         model = "wm5110";
> --
> 2.14.2
>
On 02/06/2018 02:05 PM, Krzysztof Kozlowski wrote:
> On Mon, Feb 5, 2018 at 4:44 PM, Sylwester Nawrocki
> <s.nawrocki@samsung.com> wrote:
>> This patch documents additional entries of the audio-codec and
>> i2s-controller properties required for the HDMI audio support.
>>
>> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
>> ---
>>  .../devicetree/bindings/sound/samsung,tm2-audio.txt        | 14 +++++++++-----
>>  1 file changed, 9 insertions(+), 5 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
>> index 94442e5673b3..f5ccc12ddc00 100644
>> --- a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
>> +++ b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
>> @@ -4,9 +4,13 @@ Required properties:
>>
>>   - compatible           : "samsung,tm2-audio"
>>   - model                : the user-visible name of this sound complex
>> - - audio-codec          : the phandle of the wm5110 audio codec node,
>> -                          as described in ../mfd/arizona.txt
>> - - i2s-controller       : the phandle of the I2S controller
>> + - audio-codec          : the first entry should be phandle of the wm5110 audio
>> +                          codec node, as described in ../mfd/arizona.txt;
>> +                          the second entry should be phandle of the HDMI
>
> AFAIU, this property is still optional so the wording should be
> different. Maybe just add "optional properties" paragraph?

I'd like to keep the second entries required in the documentation,
and the driver would still be handling the case with just single 
entries.
Rob Herring (Arm) Feb. 9, 2018, 2:39 a.m. UTC | #3
On Mon, Feb 05, 2018 at 04:44:03PM +0100, Sylwester Nawrocki wrote:
> This patch documents additional entries of the audio-codec and
> i2s-controller properties required for the HDMI audio support.
> 
> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
> ---
>  .../devicetree/bindings/sound/samsung,tm2-audio.txt        | 14 +++++++++-----
>  1 file changed, 9 insertions(+), 5 deletions(-)

Reviewed-by: Rob Herring <robh@kernel.org>
Krzysztof Kozlowski Feb. 12, 2018, 9:19 a.m. UTC | #4
On Wed, Feb 7, 2018 at 5:31 PM, Sylwester Nawrocki
<s.nawrocki@samsung.com> wrote:
> On 02/06/2018 02:05 PM, Krzysztof Kozlowski wrote:
>> On Mon, Feb 5, 2018 at 4:44 PM, Sylwester Nawrocki
>> <s.nawrocki@samsung.com> wrote:
>>> This patch documents additional entries of the audio-codec and
>>> i2s-controller properties required for the HDMI audio support.
>>>
>>> Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com>
>>> ---
>>>  .../devicetree/bindings/sound/samsung,tm2-audio.txt        | 14 +++++++++-----
>>>  1 file changed, 9 insertions(+), 5 deletions(-)
>>>
>>> diff --git a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
>>> index 94442e5673b3..f5ccc12ddc00 100644
>>> --- a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
>>> +++ b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
>>> @@ -4,9 +4,13 @@ Required properties:
>>>
>>>   - compatible           : "samsung,tm2-audio"
>>>   - model                : the user-visible name of this sound complex
>>> - - audio-codec          : the phandle of the wm5110 audio codec node,
>>> -                          as described in ../mfd/arizona.txt
>>> - - i2s-controller       : the phandle of the I2S controller
>>> + - audio-codec          : the first entry should be phandle of the wm5110 audio
>>> +                          codec node, as described in ../mfd/arizona.txt;
>>> +                          the second entry should be phandle of the HDMI
>>
>> AFAIU, this property is still optional so the wording should be
>> different. Maybe just add "optional properties" paragraph?
>
> I'd like to keep the second entries required in the documentation,
> and the driver would still be handling the case with just single
> entries.

I understand.
Acked-by: Krzysztof Kozlowski <krzk@kernel.org>

Best regards,
Krzysztof
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
index 94442e5673b3..f5ccc12ddc00 100644
--- a/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
+++ b/Documentation/devicetree/bindings/sound/samsung,tm2-audio.txt
@@ -4,9 +4,13 @@  Required properties:
 
  - compatible		 : "samsung,tm2-audio"
  - model		 : the user-visible name of this sound complex
- - audio-codec		 : the phandle of the wm5110 audio codec node,
-			   as described in ../mfd/arizona.txt
- - i2s-controller	 : the phandle of the I2S controller
+ - audio-codec		 : the first entry should be phandle of the wm5110 audio
+			   codec node, as described in ../mfd/arizona.txt;
+			   the second entry should be phandle of the HDMI
+			   transmitter node
+ - i2s-controller	 : the list of phandle and argument tuples pointing to
+			   I2S controllers, the first entry should be I2S0 and
+			   the second one I2S1
  - audio-amplifier	 : the phandle of the MAX98504 amplifier
  - samsung,audio-routing : a list of the connections between audio components;
 			   each entry is a pair of strings, the first being the
@@ -22,8 +26,8 @@  Example:
 
 sound {
 	compatible = "samsung,tm2-audio";
-	audio-codec = <&wm5110>;
-	i2s-controller = <&i2s0>;
+	audio-codec = <&wm5110>, <&hdmi>;
+	i2s-controller = <&i2s0 0>, <&i2s1 0>;
 	audio-amplifier = <&max98504>;
 	mic-bias-gpios = <&gpr3 2 0>;
 	model = "wm5110";