Re: [PATCH v3 02/23] dt-bindings: ata: ahci-platform: Detach common AHCI bindings

[Rob Herring <robh@kernel.org>]

On Fri, May 27, 2022 at 01:10:57PM +0300, Serge Semin wrote:
> On Tue, May 24, 2022 at 10:19:14AM -0500, Rob Herring wrote:
> > On Sun, May 22, 2022 at 06:02:47PM +0300, Serge Semin wrote:
> > > On Tue, May 17, 2022 at 02:10:55PM -0500, Rob Herring wrote:
> > > > On Thu, May 12, 2022 at 02:17:49AM +0300, Serge Semin wrote:
> > > > > In order to create a more sophisticated AHCI controller DT bindings let's
> > > > > divide the already available generic AHCI platform YAML schema into the
> > > > > platform part and a set of the common AHCI properties. The former part
> > > > > will be used to evaluate the AHCI DT nodes mainly compatible with the
> > > > > generic AHCI controller while the later schema will be used for more
> > > > > thorough AHCI DT nodes description. For instance such YAML schemas design
> > > > > will be useful for our DW AHCI SATA controller derivative with four clock
> > > > > sources, two reset lines, one system controller reference and specific
> > > > > max Rx/Tx DMA xfers size constraints.
> > > > > 
> > > > > Note the phys and target-supply property requirement is preserved in the
> > > > > generic AHCI platform bindings because some platforms can lack of the
> > > > > explicitly specified PHYs or target device power regulators.

[...]

> > > > > +patternProperties:
> > > > > +  "^sata-port@[0-9a-f]+$":
> > > > > +    type: object
> > > > > +    description:
> > > > > +      It is optionally possible to describe the ports as sub-nodes so
> > > > > +      to enable each port independently when dealing with multiple PHYs.
> > > > > +
> > > > > +    properties:
> > > > > +      reg:
> > > > > +        description: AHCI SATA port identifier
> > > > > +        maxItems: 1
> > > > > +
> > > > > +      phys:
> > > > > +        description: Individual AHCI SATA port PHY
> > > > > +        maxItems: 1
> > > > > +
> > > > > +      phy-names:
> > > > > +        description: AHCI SATA port PHY ID
> > > > > +        maxItems: 1
> > > > > +
> > > > > +      target-supply:
> > > > > +        description: Power regulator for SATA port target device
> > > > > +
> > > > > +    required:
> > > > > +      - reg
> > > > > +
> > > > > +    additionalProperties: true
> > > > 
> > > 
> > > > If device specific bindings can add their own properties (as this 
> > > > allows), then all the common sata-port properties needs to be its own 
> > > > schema document. That way the device binding can reference it, define 
> > > > extra properties and set 'unevaluatedProperties: false'.
> > > > 
> > > 
> > > Could you please be more specific the way it is supposed to look? We
> > > have already got the sata-port@.* object defined in the sata-common.yaml
> > > super-schema. Here I just redefine it with more specific properties.
> > 
> 
> > If you want an example, see spi-peripheral-props.yaml and the change 
> > that introduced it.
> > 
> > If properties are defined in multiple locations, we have to be able to 
> > combine all those schemas to a single (logical, not single file) schema 
> > to apply it. That's the only way all the disjoint properties can be 
> > evaluated.
> 
> Hm, why do you refer to the cdns,qspi-nor-peripheral-props.yaml and
> samsung,spi-peripheral-props.yaml schema from the common
> spi-peripheral-props.yaml schema? In that case you permit having the
> vendor-specific properties used in all controllers. It doesn't seem
> right. Isn't it would be more natural to create a generic-to-private
> hierarchy? Like this:

It's not 'used in all controllers' but used in all devices. But yes, it 
does mean a device node could have any of the properties. 

The schema for the device must have all possible properties in its 
schema either directly or via $ref's. There's not a way to say if the 
parent controller is X, then apply these controller child device 
properties.

> > spi-peripheral-props.yaml:
> + properties:
> +    ...
> 
> > cdns,qspi-nor-peripheral-props.yaml:
> + allOf:
> +   - $ref: spi-peripheral-props.yaml#
> + properties:
> +   ...
> 
> > samsung,spi-peripheral-props.yaml:

Who would apply/$ref this in your schema?

> + allOf:
> +   - $ref: spi-peripheral-props.yaml#
> + properties:
> +   ...
> 
> Especially seeing you left the generic peripheral-props schema opened for
> the additional properties (additionalProperties: true). Afterwards the Cdns
> and Samsung SPI DT-schemas would refer to these peripheral props schemas
> in the sub-nodes. Like this:
> > cdns,qspi-nor.yaml:
> + ...
> + patternProperties:
> +   "^.*@[0-9a-f]+$":
> +     type: object
> +     $ref: spi-peripheral-props.yaml
> +     ...

This is the pattern that simply doesn't work. "^.*@[0-9a-f]+$" is 
entirely independent of a device schema and there's not 1 schema that 
has all possible properties.

We could at least limit nodes to allow one set of controller specific 
properties (but not necessarily the correct one):

allOf:
  - $ref: spi-peripheral-props.yaml#
  - oneOf:
      - $ref: samsung,spi-peripheral-props.yaml#
      - $ref: cdns,qspi-nor-peripheral-props.yaml#

And then in each of the above schemas we need:

anyOf:
  - required: [ vendor,prop1 ]
  - required: [ vendor,prop2 ]
  - ... for all the controller specific properties

The last part keeps the vendor specific schema from being true if none 
of the properties are present.

> > > Is it ok if I moved the sata-port@.* properties in the "definitions"
> > > section of the sata-common.yaml and ahci-common.yaml schema and
> > > re-used them right in the common bindings and, if required, in the
> > > device-specific schema?
> > 
> 
> > Yes, I guess. There's not really any advantage to doing that. A separate 
> > schema file is only a small amount of boilerplate.
> 
> IMO having the common ports definitions in the same schema file as the
> corresponding DT-bindings is more readable. You don't have to
> open additional files, switch between tabs in order to get to the
> referred sub-schema. In addition splitting that much coherent parts
> isn't good from the maintainability point of view either.
> 
> > 
> > > Please confirm that the next schema hierarchy is what you were talking
> > > about and it will be ok in this case:
> > > 
> > > > Documentation/devicetree/bindings/ata/sata-common.yaml:
> > > ...
> > > + patternProperties:
> > > +   "^sata-port@[0-9a-e]$":
> > > +     $ref: '#/definitions/sata-port'
> > > + 
> > > + definitions:
> > 
> 
> > '$defs' is preferred over 'definitions'.
> 
> Ok.
> 
> > 
> > > +   sata-port:
> > > +     type: object
> > > +   
> > > +     properties:
> > > +       reg:
> > > +         minimum: 0
> > 
> 
> > That's the default.
> > 
> > > + 
> > > +     additionalProperties: true
> > 
> > Drop this.
> 
> Ok.
> 
> > 
> > > 
> > > > Documentation/devicetree/bindings/ata/ahci-common.yaml:
> > > ...
> > > + patternProperties:
> > > +   "^sata-port@[0-9a-e]$":
> > > +     $ref: '#/definitions/ahci-port'
> > > + 
> > > + definitions:
> > > +   ahci-port:
> > > +     $ref: /schemas/ata/sata-common.yaml#/definitions/sata-port
> > > +     properties:
> > > +       reg:
> > > +         minimum: 0
> > > +         maximum: 31
> > > ...
> > > + 
> > > +     additionalProperties: true
> > 
> > Drop this.
> > 
> > > 
> > > > Documentation/devicetree/bindings/ata/snps,dwc-ahci.yaml:
> > > ...
> > > + patternProperties:
> > > +   "^sata-port@[0-9a-e]$":
> > > +     $ref: /schemas/ata/ahci-common.yaml#/definitions/ahci-port
> > > +     properties:
> > > +       reg:
> > > +         minimum: 0
> > > +         maximum: 7
> > > + 
> > > +       snps,tx-ts-max:
> > > +         $ref: /schemas/types.yaml#/definitions/uint32
> > > + 
> > > +       snps,rx-ts-max:
> > > +         $ref: /schemas/types.yaml#/definitions/uint32
> > > +
> > > +     unevaluatedProperties: true
> > 
> 
> > This needs to be false. 
> 
> Right. Incorrectly copy-pasted it.
> 
> > And this should work as the $ref issue is only 
> > for the top-level schema.
> 
> Do you mean that this will work for the schemas referring the
> snps,dwc-ahci.yaml schema only? I suppose the vendor-specific schemas
> still can extend it by re-designing the snps,dwc-ahci.yaml DT-binding in
> the same way as the generic SATA/AHCI schemas.

I mean it doesn't have the bug in dtschema preventing 
unevaluatedProperties from fully working correctly.

Rob