diff mbox series

[v2,1/9] ASoC: dt-bindings: rt5659: Update binding doc

Message ID 1611944866-29373-2-git-send-email-spujar@nvidia.com
State Accepted
Commit 6bbb859012e905736c852b518be16c653e451967
Headers show
Series [v2,1/9] ASoC: dt-bindings: rt5659: Update binding doc | expand

Commit Message

Sameer Pujar Jan. 29, 2021, 6:27 p.m. UTC
Update following in rt5659.txt binding doc
  - Add JD source for Intel HDA header: Commit 041e74b71491
    ("ASoC: rt5659: Add the support of Intel HDA Header")
    added driver support. Add missing info here.

  - sound-name-prefix: Used to prefix component widgets/kcontrols
    with given prefix.

  - ports: Helps to use the Codec with audio graph card

Signed-off-by: Sameer Pujar <spujar@nvidia.com>
Reported-by: Jon Hunter <jonathanh@nvidia.com>
Cc: Oder Chiou <oder_chiou@realtek.com>
Cc: Bard Liao <bardliao@realtek.com>
---
 Documentation/devicetree/bindings/sound/rt5659.txt | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Rob Herring (Arm) Feb. 5, 2021, 3:29 p.m. UTC | #1
On Fri, Jan 29, 2021 at 11:57:38PM +0530, Sameer Pujar wrote:
> Update following in rt5659.txt binding doc

>   - Add JD source for Intel HDA header: Commit 041e74b71491

>     ("ASoC: rt5659: Add the support of Intel HDA Header")

>     added driver support. Add missing info here.

> 

>   - sound-name-prefix: Used to prefix component widgets/kcontrols

>     with given prefix.

> 

>   - ports: Helps to use the Codec with audio graph card

> 

> Signed-off-by: Sameer Pujar <spujar@nvidia.com>

> Reported-by: Jon Hunter <jonathanh@nvidia.com>

> Cc: Oder Chiou <oder_chiou@realtek.com>

> Cc: Bard Liao <bardliao@realtek.com>

> ---

>  Documentation/devicetree/bindings/sound/rt5659.txt | 11 +++++++++++

>  1 file changed, 11 insertions(+)

> 

> diff --git a/Documentation/devicetree/bindings/sound/rt5659.txt b/Documentation/devicetree/bindings/sound/rt5659.txt

> index 56788f5..c473df5 100644

> --- a/Documentation/devicetree/bindings/sound/rt5659.txt

> +++ b/Documentation/devicetree/bindings/sound/rt5659.txt

> @@ -37,10 +37,21 @@ Optional properties:

>  - realtek,jd-src

>    0: No JD is used

>    1: using JD3 as JD source

> +  2: JD source for Intel HDA header

>  

>  - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.

>  - realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin.

>  

> +- sound-name-prefix: Please refer to name-prefix.txt

> +

> +- ports: A Codec may have a single or multiple I2S interfaces. These

> +  interfaces on Codec side can be described under 'ports' or 'port'.

> +  When the SoC or host device is connected to multiple interfaces of

> +  the Codec, the connectivity can be described using 'ports' property.

> +  If a single interface is used, then 'port' can be used. The usage

> +  depends on the platform or board design.

> +  Please refer to Documentation/devicetree/bindings/graph.txt


Please read what that file says now.

> +

>  Pins on the device (for linking into audio routes) for RT5659/RT5658:

>  

>    * DMIC L1

> -- 

> 2.7.4

>
Sameer Pujar Feb. 9, 2021, 1:21 p.m. UTC | #2
Hi Rob,

On 2/5/2021 8:59 PM, Rob Herring wrote:
> External email: Use caution opening links or attachments

>

>

> On Fri, Jan 29, 2021 at 11:57:38PM +0530, Sameer Pujar wrote:

>> Update following in rt5659.txt binding doc

>>    - Add JD source for Intel HDA header: Commit 041e74b71491

>>      ("ASoC: rt5659: Add the support of Intel HDA Header")

>>      added driver support. Add missing info here.

>>

>>    - sound-name-prefix: Used to prefix component widgets/kcontrols

>>      with given prefix.

>>

>>    - ports: Helps to use the Codec with audio graph card

>>

>> Signed-off-by: Sameer Pujar <spujar@nvidia.com>

>> Reported-by: Jon Hunter <jonathanh@nvidia.com>

>> Cc: Oder Chiou <oder_chiou@realtek.com>

>> Cc: Bard Liao <bardliao@realtek.com>

>> ---

>>   Documentation/devicetree/bindings/sound/rt5659.txt | 11 +++++++++++

>>   1 file changed, 11 insertions(+)

>>

>> diff --git a/Documentation/devicetree/bindings/sound/rt5659.txt b/Documentation/devicetree/bindings/sound/rt5659.txt

>> index 56788f5..c473df5 100644

>> --- a/Documentation/devicetree/bindings/sound/rt5659.txt

>> +++ b/Documentation/devicetree/bindings/sound/rt5659.txt

>> @@ -37,10 +37,21 @@ Optional properties:

>>   - realtek,jd-src

>>     0: No JD is used

>>     1: using JD3 as JD source

>> +  2: JD source for Intel HDA header

>>

>>   - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.

>>   - realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin.

>>

>> +- sound-name-prefix: Please refer to name-prefix.txt

>> +

>> +- ports: A Codec may have a single or multiple I2S interfaces. These

>> +  interfaces on Codec side can be described under 'ports' or 'port'.

>> +  When the SoC or host device is connected to multiple interfaces of

>> +  the Codec, the connectivity can be described using 'ports' property.

>> +  If a single interface is used, then 'port' can be used. The usage

>> +  depends on the platform or board design.

>> +  Please refer to Documentation/devicetree/bindings/graph.txt

> Please read what that file says now.


Sorry, I did not understand above comment. Can you please elaborate a 
bit more?
Thierry Reding Feb. 9, 2021, 7:19 p.m. UTC | #3
On Tue, Feb 09, 2021 at 06:51:58PM +0530, Sameer Pujar wrote:
> Hi Rob,

> 

> On 2/5/2021 8:59 PM, Rob Herring wrote:

> > External email: Use caution opening links or attachments

> > 

> > 

> > On Fri, Jan 29, 2021 at 11:57:38PM +0530, Sameer Pujar wrote:

> > > Update following in rt5659.txt binding doc

> > >    - Add JD source for Intel HDA header: Commit 041e74b71491

> > >      ("ASoC: rt5659: Add the support of Intel HDA Header")

> > >      added driver support. Add missing info here.

> > > 

> > >    - sound-name-prefix: Used to prefix component widgets/kcontrols

> > >      with given prefix.

> > > 

> > >    - ports: Helps to use the Codec with audio graph card

> > > 

> > > Signed-off-by: Sameer Pujar <spujar@nvidia.com>

> > > Reported-by: Jon Hunter <jonathanh@nvidia.com>

> > > Cc: Oder Chiou <oder_chiou@realtek.com>

> > > Cc: Bard Liao <bardliao@realtek.com>

> > > ---

> > >   Documentation/devicetree/bindings/sound/rt5659.txt | 11 +++++++++++

> > >   1 file changed, 11 insertions(+)

> > > 

> > > diff --git a/Documentation/devicetree/bindings/sound/rt5659.txt b/Documentation/devicetree/bindings/sound/rt5659.txt

> > > index 56788f5..c473df5 100644

> > > --- a/Documentation/devicetree/bindings/sound/rt5659.txt

> > > +++ b/Documentation/devicetree/bindings/sound/rt5659.txt

> > > @@ -37,10 +37,21 @@ Optional properties:

> > >   - realtek,jd-src

> > >     0: No JD is used

> > >     1: using JD3 as JD source

> > > +  2: JD source for Intel HDA header

> > > 

> > >   - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.

> > >   - realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin.

> > > 

> > > +- sound-name-prefix: Please refer to name-prefix.txt

> > > +

> > > +- ports: A Codec may have a single or multiple I2S interfaces. These

> > > +  interfaces on Codec side can be described under 'ports' or 'port'.

> > > +  When the SoC or host device is connected to multiple interfaces of

> > > +  the Codec, the connectivity can be described using 'ports' property.

> > > +  If a single interface is used, then 'port' can be used. The usage

> > > +  depends on the platform or board design.

> > > +  Please refer to Documentation/devicetree/bindings/graph.txt

> > Please read what that file says now.

> 

> Sorry, I did not understand above comment. Can you please elaborate a bit

> more?


I think what Rob meant to point out is that graph.txt now contains a
mention that the file has been moved to a more central location, which
is the dt-schema repository. So instead of referencing the graph.txt,
which then redirects to the graph.yaml in dt-schema, it'd be better to
directly reference graph.yaml from dt-schema.

That said, I'm not aware of a good or standard way to make such a
reference. Perhaps in this case, given that the rt5659 binding is not
very large, you can convert the file to json-schema first and then use
standard json-schema references for this.

Thierry
Sameer Pujar Feb. 10, 2021, 6:58 a.m. UTC | #4
On 2/10/2021 12:49 AM, Thierry Reding wrote:
> On Tue, Feb 09, 2021 at 06:51:58PM +0530, Sameer Pujar wrote:

>> Hi Rob,

>>

>> On 2/5/2021 8:59 PM, Rob Herring wrote:

>>> External email: Use caution opening links or attachments

>>>

>>>

>>> On Fri, Jan 29, 2021 at 11:57:38PM +0530, Sameer Pujar wrote:

>>>> Update following in rt5659.txt binding doc

>>>>     - Add JD source for Intel HDA header: Commit 041e74b71491

>>>>       ("ASoC: rt5659: Add the support of Intel HDA Header")

>>>>       added driver support. Add missing info here.

>>>>

>>>>     - sound-name-prefix: Used to prefix component widgets/kcontrols

>>>>       with given prefix.

>>>>

>>>>     - ports: Helps to use the Codec with audio graph card

>>>>

>>>> Signed-off-by: Sameer Pujar <spujar@nvidia.com>

>>>> Reported-by: Jon Hunter <jonathanh@nvidia.com>

>>>> Cc: Oder Chiou <oder_chiou@realtek.com>

>>>> Cc: Bard Liao <bardliao@realtek.com>

>>>> ---

>>>>    Documentation/devicetree/bindings/sound/rt5659.txt | 11 +++++++++++

>>>>    1 file changed, 11 insertions(+)

>>>>

>>>> diff --git a/Documentation/devicetree/bindings/sound/rt5659.txt b/Documentation/devicetree/bindings/sound/rt5659.txt

>>>> index 56788f5..c473df5 100644

>>>> --- a/Documentation/devicetree/bindings/sound/rt5659.txt

>>>> +++ b/Documentation/devicetree/bindings/sound/rt5659.txt

>>>> @@ -37,10 +37,21 @@ Optional properties:

>>>>    - realtek,jd-src

>>>>      0: No JD is used

>>>>      1: using JD3 as JD source

>>>> +  2: JD source for Intel HDA header

>>>>

>>>>    - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.

>>>>    - realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin.

>>>>

>>>> +- sound-name-prefix: Please refer to name-prefix.txt

>>>> +

>>>> +- ports: A Codec may have a single or multiple I2S interfaces. These

>>>> +  interfaces on Codec side can be described under 'ports' or 'port'.

>>>> +  When the SoC or host device is connected to multiple interfaces of

>>>> +  the Codec, the connectivity can be described using 'ports' property.

>>>> +  If a single interface is used, then 'port' can be used. The usage

>>>> +  depends on the platform or board design.

>>>> +  Please refer to Documentation/devicetree/bindings/graph.txt

>>> Please read what that file says now.

>> Sorry, I did not understand above comment. Can you please elaborate a bit

>> more?

> I think what Rob meant to point out is that graph.txt now contains a

> mention that the file has been moved to a more central location, which

> is the dt-schema repository. So instead of referencing the graph.txt,

> which then redirects to the graph.yaml in dt-schema, it'd be better to

> directly reference graph.yaml from dt-schema.

>

> That said, I'm not aware of a good or standard way to make such a

> reference. Perhaps in this case, given that the rt5659 binding is not

> very large, you can convert the file to json-schema first and then use

> standard json-schema references for this.


OK, in that case I will try convert this binding to json-schema in a 
separate patch. Thanks.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/rt5659.txt b/Documentation/devicetree/bindings/sound/rt5659.txt
index 56788f5..c473df5 100644
--- a/Documentation/devicetree/bindings/sound/rt5659.txt
+++ b/Documentation/devicetree/bindings/sound/rt5659.txt
@@ -37,10 +37,21 @@  Optional properties:
 - realtek,jd-src
   0: No JD is used
   1: using JD3 as JD source
+  2: JD source for Intel HDA header
 
 - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.
 - realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin.
 
+- sound-name-prefix: Please refer to name-prefix.txt
+
+- ports: A Codec may have a single or multiple I2S interfaces. These
+  interfaces on Codec side can be described under 'ports' or 'port'.
+  When the SoC or host device is connected to multiple interfaces of
+  the Codec, the connectivity can be described using 'ports' property.
+  If a single interface is used, then 'port' can be used. The usage
+  depends on the platform or board design.
+  Please refer to Documentation/devicetree/bindings/graph.txt
+
 Pins on the device (for linking into audio routes) for RT5659/RT5658:
 
   * DMIC L1