Re: [PATCH V2 3/4] dt-bindings: power: reset: qcom-pon: Convert qcom PON binding to yaml

From: Sebastian Reichel <sebastian.reichel@collabora.com>
To: skakit@codeaurora.org
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Rob Herring <robh+dt@kernel.org>, Andy Gross <agross@kernel.org>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	David Collins <collinsd@codeaurora.org>,
	kgunda@codeaurora.org, Vinod Koul <vkoul@kernel.org>,
	Courtney Cavin <courtney.cavin@sonymobile.com>,
	linux-input@vger.kernel.org, linux-kernel@vger.kernel.org,
	devicetree@vger.kernel.org, linux-arm-msm@vger.kernel.org,
	linux-pm@vger.kernel.org
Subject: Re: [PATCH V2 3/4] dt-bindings: power: reset: qcom-pon: Convert qcom PON binding to yaml
Date: Tue, 27 Apr 2021 10:37:21 +0200	[thread overview]
Message-ID: <20210427083721.heavcdadeb4ajkk2@earth.universe> (raw)
In-Reply-To: <322cbdbb022fec3f43c1cbe13c532dd3@codeaurora.org>

[-- Attachment #1: Type: text/plain, Size: 2678 bytes --]

Hi,

On Tue, Apr 27, 2021 at 11:45:44AM +0530, skakit@codeaurora.org wrote:
> Hi Sebastian,
> 
> On 2021-04-09 13:48, skakit@codeaurora.org wrote:
> > Hi Sebastian,
> > 
> > On 2021-04-08 18:30, Sebastian Reichel wrote:
> > > Hi,
> > > 
> > > On Thu, Apr 08, 2021 at 05:01:08PM +0530, satya priya wrote:
> > > > Convert qcom PON binding from .txt to .yaml format.
> > > > 
> > > > Signed-off-by: satya priya <skakit@codeaurora.org>
> > > > ---
> > > 
> > > Thanks for doing this.
> > > 
> > > > Changes in V2:
> > > >  - As per Rob's comments, converted the main PON binding and
> > > > added in V2.
> > > > 
> [...]
> > > > +  reg:
> > > > +    description: Specifies the physical address of the pon register
> > > 
> > > That description is obvious and pointless. Instead add
> > > 
> > > maxItems: 1
> > > 
> > 
> > Okay.
> > 
> > > > +  pwrkey:
> > > > +    type: object
> > > > +    $ref: "../../input/qcom,pm8941-pwrkey.yaml#"
> > > > +
> > > > +  resin:
> > > > +    type: object
> > > > +    $ref: "../../input/qcom,pm8941-pwrkey.yaml#"
> > > > +
> > > > +required:
> > > > +  - compatible
> > > > +  - reg
> > > > +
> > > > +additionalProperties: true
> > > 
> > > Instead of allowing arbitrary properties, only valid modes
> > > should be allowed. So drop additionalProperties and do this
> > > instead:
> > > 
> > > allOf:
> > >   - $ref: reboot-mode.yaml#
> > > 
> > > unevaluatedProperties: false
> > > 
> > 
> > Okay.
> 
> I am not able to use 'allOf' to refer reboot-mode.yaml as some of the
> properties do not match with reboot-mode.yaml properties. Can we use oneOf
> like below?
> 
> oneOf:
>   - $ref: "reboot-mode.yaml#"
>   - $ref: "../../input/qcom,pm8941-pwrkey.yaml#"

That does not make sense.

The reference to reboot-mode.yaml is needed because it adds valid
mode properties, so that you can set unevaluatedProperties to false.
You need it at the root of the PON binding. They are not added to
the required list, so it's fine if not all of them are used. Also
there can (and usually is) more than one mode, so using oneOf is not
ok.

Last but not least the pwrkey reference is needed to describe
specific nodes (resin, pwrkey) and should not appear at the root
of the PON binding.

> Also, If I drop additionalProperties I am getting below error.
> 
> kernel/Documentation/devicetree/bindings/power/reset/qcom,pon.yaml:
> 'additionalProperties' is a required property

You need to add 'unevaluatedProperties: false'. It is basically
the same as 'additionalProperties: false', but also accepts
properties from the referenced bindings.

Thanks,

-- Sebastian

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]