[v2,4/4] ASoc: dt-bindings: PCM6240: Add initial DT binding

  PCM6240 driver implements a flexible and configurable setting for register
and filter coefficients, to one, two or even multiple PCM6240 Family Audio
chips.

Signed-off-by: Shenghao Ding <shenghao-ding@ti.com>

---
Change in v2:
 - Rewrite the subject to match something similar to other commits.
 - And something to be compatible with.
 - minItems, then maxItems.
 - Drop reset-gpios description
 - Remove the repeated reg descriptions and reg constraints.
 - Drop redundant spaces.
 - Add missing line breaks between blocks and additionalProperties.
 - All these chips have only a portion of the functionality of codec,
   such as ADC or DAC, and so on, but their audio performance is far
   superior to the codec's, and cost is lower than codec, and much easier
   to program than codec. Simply one or two register settings can enable
   them to work. Init for these chips are hardware reset or software reset.
   As to some audio filter params for internal filters, it is up to the
   special user cases, which can be saved into the bin file. The default
   value also can work well.
---
 .../devicetree/bindings/sound/ti,pcm6240.yaml | 276 ++++++++++++++++++
 1 file changed, 276 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/ti,pcm6240.yaml
  

On 26/01/2024 04:58, Shenghao Ding wrote:
> PCM6240 driver implements a flexible and configurable setting for register
> and filter coefficients, to one, two or even multiple PCM6240 Family Audio
> chips.
> 

Subject: you just ignored my comment...

Please use scripts/get_maintainers.pl to get a list of necessary people
and lists to CC (and consider --no-git-fallback argument). It might
happen, that command when run on an older kernel, gives you outdated
entries. Therefore please be sure you base your patches on recent Linux
kernel.

Tools like b4 or scripts_getmaintainer.pl provide you proper list of
people, so fix your workflow. Tools might also fail if you work on some
ancient tree (don't, use mainline), work on fork of kernel (don't, use
mainline) or you ignore some maintainers (really don't). Just use b4 and
all the problems go away.

..

> +      ti,pcmd3140: Four-channel PDM-input to TDM or I�S output converter.

This does not look like proper encoding.

> +
> +      ti,pcmd3180: Eight-channel pulse-density-modulation input to TDM or
> +      I�S output converter.
> +
> +      ti,taa5212: Low-power high-performance stereo audio ADC with 118-dB
> +      dynamic range.
> +
> +      ti,tad5212: Low-power stereo audio DAC with 120-dB dynamic range.
> +    oneOf:
> +      - items:
> +          - enum:
> +              - ti,adc3120
> +              - ti,adc5120
> +              - ti,pcm3120
> +              - ti,pcm5120
> +              - ti,pcm6120
> +          - const: ti,adc6120
> +      - items:
> +          - enum:
> +              - ti,pcm6260
> +              - ti,pcm6140
> +              - ti,pcm3140
> +              - ti,pcm5140
> +          - const: ti,pcm6240
> +      - items:
> +          - const: ti,dix4192
> +          - const: ti,pcm6240
> +          - const: ti,adc6120

It does not make sense. You said above adc6120 is not compatible with
pcm6240.

> +      - items:
> +          - const: ti,pcm1690
> +          - const: ti,pcm9211
> +          - const: ti,pcmd512x
> +      - items:
> +          - enum:
> +              - ti,pcmd3180
> +          - const: ti,pcmd3140
> +      - items:
> +          - enum:
> +              - taa5412
> +          - const: ti,taa5212
> +      - items:
> +          - enum:
> +              - tad5412
> +          - const: ti,tad5212
> +      - items:

No need for items.

> +          - enum:
> +              - ti,pcm6240
> +              - ti,pcmd3140
> +              - ti,taa5212
> +              - ti,tad5212
> +              - ti,pcmd3180

Where is adc6120 and others?

Missing blank line.

> +  reg:
> +    description:
> +      I2C address, in multiple pcmdevices case, all the i2c address
> +      aggregate as one Audio Device to support multiple audio slots.
> +    minItems: 1
> +    maxItems: 4
> +
> +  reset-gpios:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +    description:
> +      Invalid only for ti,pcm1690 because of no INT pin.
> +
> +  '#sound-dai-cells':
> +    const: 0
> +
> +required:
> +  - compatible
> +  - reg
> +
> +allOf:
> +  - $ref: dai-common.yaml#
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - ti,pcm1690
> +    then:
> +      properties:
> +        reg:
> +          items:
> +            minimum: 0x4c
> +            maximum: 0x4f

Nothing improved.

> +        interrupts: false
> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - ti,adc3120
> +              - ti,adc5120
> +              - ti,adc6120
> +              - ti,pcm3120
> +              - ti,pcm5120
> +              - ti,pcm6120
> +              - ti,pcmd3140
> +    then:
> +      properties:
> +        reg:
> +          maxItems: 1
> +          items:
> +            maximum: 0x4e
> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - ti,dix4192
> +    then:
> +      properties:
> +        reg:
> +          items:
> +            minimum: 0x70
> +            maximum: 0x73

Drop entire if

> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - ti,pcm6240
> +              - ti,pcm6260
> +    then:
> +      properties:
> +        reg:
> +          minItems: 1
> +          maxItems: 4
> +          items:
> +            minimum: 0x48
> +            maximum: 0x4b

Drop entire if

> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - ti,pcm9211
> +    then:
> +      properties:
> +        reg:
> +          items:
> +            minimum: 0x40
> +            maximum: 0x43

Drop entire if


> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - ti,taa5212
> +              - ti,taa5412
> +              - ti,tad5212
> +              - ti,tad5412
> +    then:
> +      properties:
> +        reg:
> +          items:
> +            minimum: 0x50
> +            maximum: 0x53

Drop entire if


> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +   #include <dt-bindings/gpio/gpio.h>
> +   i2c {
> +     /* example for two devices with interrupt support */
> +     #address-cells = <1>;
> +     #size-cells = <0>;
> +     pcm6240: audio-codec@48 {
> +       compatible = "ti,pcm6240";
> +       reg = <0x48>, /* primary-device */
> +            <0x4b>; /* secondary-device */

Looks misaligned.



Best regards,
Krzysztof
  

On Fri, Jan 26, 2024 at 09:27:47AM +0100, Krzysztof Kozlowski wrote:
> On 26/01/2024 04:58, Shenghao Ding wrote:

> > +  - if:
> > +      properties:
> > +        compatible:
> > +          contains:
> > +            enum:
> > +              - ti,pcm1690
> > +    then:
> > +      properties:
> > +        reg:
> > +          items:
> > +            minimum: 0x4c
> > +            maximum: 0x4f

> Nothing improved.

Shenghao explained what what this is doing - I'm not sure what the
actual problem is here?  It's an actual restriction on the values that
are valid.
  

> -----Original Message-----
> From: Mark Brown <broonie@kernel.org>
> Sent: Friday, January 26, 2024 9:50 PM
> To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Cc: Ding, Shenghao <shenghao-ding@ti.com>; conor+dt@kernel.org;
> robh+dt@kernel.org; andriy.shevchenko@linux.intel.com; Lu, Kevin <kevin-
> lu@ti.com>; Xu, Baojun <baojun.xu@ti.com>; devicetree@vger.kernel.org; P
> O, Vijeth <v-po@ti.com>; lgirdwood@gmail.com; perex@perex.cz; pierre-
> louis.bossart@linux.intel.com; 13916275206@139.com; Chawla, Mohit
> <mohit.chawla@ti.com>; linux-sound@vger.kernel.org; linux-
> kernel@vger.kernel.org; liam.r.girdwood@intel.com; soyer@irl.hu; Huang,
> Jonathan <jkhuang3@ti.com>; tiwai@suse.de; Djuandi, Peter
> <pdjuandi@ti.com>; McPherson, Jeff <j-mcpherson@ti.com>; Navada
> Kanyana, Mukund <navada@ti.com>
> Subject: [EXTERNAL] Re: [PATCH v2 4/4] ASoc: dt-bindings: PCM6240: Add
> initial DT binding
> 
> On Fri, Jan 26, 2024 at 09:27:47AM +0100, Krzysztof Kozlowski wrote:
> > On 26/01/2024 04:58, Shenghao Ding wrote:
> 
> > > +  - if:
> > > +      properties:
> > > +        compatible:
> > > +          contains:
> > > +            enum:
> > > +              - ti,pcm1690
> > > +    then:
> > > +      properties:
> > > +        reg:
> > > +          items:
> > > +            minimum: 0x4c
> > > +            maximum: 0x4f
> 
> > Nothing improved.
> 
> Shenghao explained what what this is doing - I'm not sure what the actual
> problem is here?  It's an actual restriction on the values that are valid.

Hi, Krzysztof. May I have the privilege to petition on behalf of my customers? They 
want to keep these if branches and the i2c address in yaml file. As you know, most 
of my customers used to make mistakes and confuse with the i2c address. Listing 
them here can help them to get the information easily.
  

On 29/01/2024 05:43, Ding, Shenghao wrote:
>>
>> On Fri, Jan 26, 2024 at 09:27:47AM +0100, Krzysztof Kozlowski wrote:
>>> On 26/01/2024 04:58, Shenghao Ding wrote:
>>
>>>> +  - if:
>>>> +      properties:
>>>> +        compatible:
>>>> +          contains:
>>>> +            enum:
>>>> +              - ti,pcm1690
>>>> +    then:
>>>> +      properties:
>>>> +        reg:
>>>> +          items:
>>>> +            minimum: 0x4c
>>>> +            maximum: 0x4f
>>
>>> Nothing improved.
>>
>> Shenghao explained what what this is doing - I'm not sure what the actual
>> problem is here?  It's an actual restriction on the values that are valid.
> 
> Hi, Krzysztof. May I have the privilege to petition on behalf of my customers? They 
> want to keep these if branches and the i2c address in yaml file. As you know, most 
> of my customers used to make mistakes and confuse with the i2c address. Listing 
> them here can help them to get the information easily.

To which cases this exception will apply? Your patches, all TI?

Bindings are not supposed to be so detailed to create DTS out if it,
because it makes them more difficult to maintain. Such amount of
if:then: makes it trickier, for no real gain.

Best regards,
Krzysztof
  

> -----Original Message-----
> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> Sent: Wednesday, January 31, 2024 12:18 AM
> To: Ding, Shenghao <shenghao-ding@ti.com>
> Cc: conor+dt@kernel.org; robh+dt@kernel.org;
> andriy.shevchenko@linux.intel.com; Lu, Kevin <kevin-lu@ti.com>; Xu, Baojun
> <baojun.xu@ti.com>; devicetree@vger.kernel.org; P O, Vijeth <v-
> po@ti.com>; lgirdwood@gmail.com; perex@perex.cz; pierre-
> louis.bossart@linux.intel.com; 13916275206@139.com; Chawla, Mohit
> <mohit.chawla@ti.com>; linux-sound@vger.kernel.org; linux-
> kernel@vger.kernel.org; liam.r.girdwood@intel.com; soyer@irl.hu; Huang,
> Jonathan <jkhuang3@ti.com>; tiwai@suse.de; Djuandi, Peter
> <pdjuandi@ti.com>; McPherson, Jeff <j-mcpherson@ti.com>; Navada
> Kanyana, Mukund <navada@ti.com>; Mark Brown <broonie@kernel.org>
> Subject: Re: [EXTERNAL] Re: [PATCH v2 4/4] ASoc: dt-bindings: PCM6240:
> Add initial DT binding
> 
> On 29/01/2024 05: 43, Ding, Shenghao wrote: >> >> On Fri, Jan 26, 2024 at
> 09: 27: 47AM +0100, Krzysztof Kozlowski wrote: >>> On 26/01/2024 04: 58,
> Shenghao Ding wrote: >> >>>> + - if: >>>> + properties:
> ZjQcmQRYFpfptBannerStart This message was sent from outside of Texas
> Instruments.
> Do not click links or open attachments unless you recognize the source of
> this email and know the content is safe.
> 
> ZjQcmQRYFpfptBannerEnd
> On 29/01/2024 05:43, Ding, Shenghao wrote:
> >>
> >> On Fri, Jan 26, 2024 at 09:27:47AM +0100, Krzysztof Kozlowski wrote:
> >>> On 26/01/2024 04:58, Shenghao Ding wrote:
> >>
> >>>> +  - if:
> >>>> +      properties:
> >>>> +        compatible:
> >>>> +          contains:
> >>>> +            enum:
> >>>> +              - ti,pcm1690
> >>>> +    then:
> >>>> +      properties:
> >>>> +        reg:
> >>>> +          items:
> >>>> +            minimum: 0x4c
> >>>> +            maximum: 0x4f
> >>
> >>> Nothing improved.
> >>
> >> Shenghao explained what what this is doing - I'm not sure what the
> >> actual problem is here?  It's an actual restriction on the values that are
> valid.
> >
> > Hi, Krzysztof. May I have the privilege to petition on behalf of my
> > customers? They want to keep these if branches and the i2c address in
> > yaml file. As you know, most of my customers used to make mistakes and
> > confuse with the i2c address. Listing them here can help them to get the
> information easily.
> 
> To which cases this exception will apply? Your patches, all TI?
> 
Some AI customers usually like to try some innovative projects, such as their multiple-slot TDM 
devices with serval different ADCs or DAC on different i2c buses. Traditional driver code really 
can't meet their requirements.
> Bindings are not supposed to be so detailed to create DTS out if it, because it
> makes them more difficult to maintain. Such amount of
> if:then: makes it trickier, for no real gain.
> 
Accept

 Best regards,
Shenghao Ding