Received-SPF: pass (google.com: domain of linux-kernel+bounces-170132-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Message-ID: <76519e53-a226-497b-9db1-4f11ea83151a@kwiboo.se>
Date: Mon, 6 May 2024 18:14:03 +0200
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH 2/4] dt-bindings: mfd: rk809: Add audio codec properties
To: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>, Krzysztof
 Kozlowski <krzysztof.kozlowski+dt@linaro.org>
Cc: devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
 linux-rockchip@lists.infradead.org, linux-kernel@vger.kernel.org, Heiko
 Stuebner <heiko@sntech.de>, Rob Herring <robh@kernel.org>, Conor Dooley
 <conor+dt@kernel.org>, Lee Jones <lee@kernel.org>, Chris Zhong
 <zyw@rock-chips.com>, Zhang Qing <zhangqing@rock-chips.com>
References: <20240505134120.2828885-1-jonas@kwiboo.se>
 <20240505134120.2828885-3-jonas@kwiboo.se>
 <5c4a6d57-82e0-430b-a12e-59c331a32eab@linaro.org>
Content-Language: en-US
From: Jonas Karlman <jonas@kwiboo.se>
In-Reply-To: <5c4a6d57-82e0-430b-a12e-59c331a32eab@linaro.org>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

Hi Krzysztof,

On 2024-05-06 12:47, Krzysztof Kozlowski wrote:
> On 05/05/2024 15:41, Jonas Karlman wrote:
>> Similar to RK817 the RK809 also integrates a complete audio system.
>>
>> Add audio codec properties to binding to reflect this.
>>
>> Signed-off-by: Jonas Karlman <jonas@kwiboo.se>
> 
> Except sending untested patches...

This patch was a 1:1 copy from rockchip,rk817.yaml so I expected
everything to already be correct, my bad.

Guess rockchip,rk817.yaml also needs same fixes/changes as listed below.

Will send a v2 with example fixed in a separate patch and try to fix
your remarks on this patch in v2.

> 
>> ---
>>  .../bindings/mfd/rockchip,rk809.yaml          | 34 ++++++++++++++++++-
>>  1 file changed, 33 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/mfd/rockchip,rk809.yaml b/Documentation/devicetree/bindings/mfd/rockchip,rk809.yaml
>> index c951056b8b4d..b78e1b090105 100644
>> --- a/Documentation/devicetree/bindings/mfd/rockchip,rk809.yaml
>> +++ b/Documentation/devicetree/bindings/mfd/rockchip,rk809.yaml
>> @@ -12,7 +12,7 @@ maintainers:
>>  
>>  description: |
>>    Rockchip RK809 series PMIC. This device consists of an i2c controlled MFD
>> -  that includes regulators, an RTC, and power button.
>> +  that includes regulators, an RTC, a power button and an audio codec.
>>  
>>  properties:
>>    compatible:
>> @@ -93,6 +93,34 @@ properties:
>>          unevaluatedProperties: false
>>      unevaluatedProperties: false
>>  
>> +  clocks:
>> +    description:
>> +      The input clock for the audio codec.
> 
> No, this allows anything. You must be here specific, see example-schema.
> maxItems: 1
> 
> Drop description, redundant.
> 
>> +
>> +  clock-names:
>> +    description:
>> +      The clock name for the codec clock.
> 
> Drop description, redundant.
> 
>> +    items:
>> +      - const: mclk
>> +
>> +  '#sound-dai-cells':
>> +    description:
>> +      Needed for the interpretation of sound dais.
> 
> Drop description, redundant. Do you see it anywhere for such properties?
> 
>> +    const: 0
> 
> 
> Missing ref to dai-common in your allOf (again: take a look how other
> bindings are doing it).
> 
> 
>> +
>> +  codec:
>> +    description: |
> 
> Do not need '|' unless you need to preserve formatting.
> 
>> +      The child node for the codec to hold additional properties. If no
>> +      additional properties are required for the codec, this node can be
>> +      omitted.
> 
> That's useless description. Describe hardware, not syntax. This must say
> what this node represents.
> 
> Anyway drop it. You do not have any resources there, so put properties
> in top level.

This just tries to follow the rockchip,rk817 binding, not fully sure
about the reasoning behind this node in the the rk817 binding.

RK809/RK817 are very similar and their schema files could possible be
merged.

> 
> 
>> +    type: object
>> +    additionalProperties: false
>> +    properties:
>> +      rockchip,mic-in-differential:
>> +        type: boolean
>> +        description:
>> +          Describes if the microphone uses differential mode.
> 
> Your description copies property name. Do not describe the syntax
> "Description describes", but say what is it.
> 
>> +
>>  allOf:
>>    - if:
>>        properties:
>> @@ -284,5 +312,9 @@ examples:
>>                      };
>>                  };
>>              };
>> +
>> +            rk809_codec: codec {
>> +                rockchip,mic-in-differential;
> 
> Missing all other properties. Make your example complete.

Noticed that the example used in this schema file is for RK808 and not
RK809 so will also add a patch that replaces/fixes the example in v2.

Regards,
Jonas

> 
> Best regards,
> Krzysztof
>