[PATCH v4 1/5] dt-bindings: Convert ahci-platform DT bindings to yaml

[Rob Herring]

On Thu, Mar 3, 2022 at 1:04 AM Frank Wunderlich <frank-w at public-files.de> wrote:
>
> Hi Rob,
>
> thanks for review,
>
> have prepared the changes based on yours and krzysztof comments
>
> https://github.com/frank-w/BPI-R2-4.14/commits/5.17-next-20220225
>
> (just ignore the top 2 commits) i thought i had a size-cells-error, but did not get them again after reverting this part, seems they are fixed by inclusion of the sata-common binding
>
> > Gesendet: Mittwoch, 02. März 2022 um 19:14 Uhr
> > Von: "Rob Herring" <robh at kernel.org>
> > An: "Frank Wunderlich" <linux at fw-web.de>
>
> > On Tue, Mar 01, 2022 at 04:24:17PM +0100, Frank Wunderlich wrote:
> > > From: Frank Wunderlich <frank-w at public-files.de>
>
> > > diff --git a/Documentation/devicetree/bindings/ata/ahci-platform.yaml b/Documentation/devicetree/bindings/ata/ahci-platform.yaml
> > > new file mode 100644
> > > index 000000000000..cf67ddfc6afb
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/ata/ahci-platform.yaml
> > > @@ -0,0 +1,162 @@
> > > +# SPDX-License-Identifier: GPL-2.0
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/ata/ahci-platform.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: AHCI SATA Controller
> >
> > blank line.
>
> done
>
> > > +description:
> > > +  SATA nodes are defined to describe on-chip Serial ATA controllers.
> > > +  Each SATA controller should have its own node.
> > > +
> > > +  It is possible, but not required, to represent each port as a sub-node.
> > > +  It allows to enable each port independently when dealing with multiple
> > > +  PHYs.
> >
> > You need a '|' after 'description' if you want to maintain the
> > paragraphs.
>
> ok added | to all multiline descriptions
>
> > > +
> > > +maintainers:
> > > +  - Hans de Goede <hdegoede at redhat.com>
> > > +  - Jens Axboe <axboe at kernel.dk>
> > > +
> > > +allOf:
> > > +- $ref: "sata-common.yaml#"
> > > +
> > > +properties:
> > > +  compatible:
> > > +    oneOf:
> > > +      - items:
> > > +        - enum:
> > > +          - brcm,iproc-ahci
> > > +          - marvell,armada-8k-ahci
> > > +          - marvell,berlin2q-ahci
> > > +        - const: generic-ahci
> > > +      - enum:
> > > +        - brcm,iproc-ahci
> > > +        - cavium,octeon-7130-ahci
> > > +        - hisilicon,hisi-ahci
> > > +        - ibm,476gtr-ahci
> > > +        - marvell,armada-3700-ahci
> > > +        - marvell,armada-380-ahci
> > > +        - snps,dwc-ahci
> > > +        - snps,spear-ahci
> >
> > Install yamllint and run 'make dt_binding_check'. It's going to
> > complain about the indentation.
>
> you're right, i had no yamllint installed, so i have not seen these indention errors
>
> > > +  ahci-supply:
> > > +    description:
> > > +      regulator for AHCI controller
> > > +
> > > +  clock-names:
> >
> > Group with 'clocks'
>
> ok, already done in my tree because of krzysztofs comment
>
> > > +  ports-implemented:
> > > +    $ref: '/schemas/types.yaml#/definitions/uint32'
> > > +    description:
> > > +      Mask that indicates which ports that the HBA supports
> > > +      are available for software to use. Useful if PORTS_IMPL
> > > +      is not programmed by the BIOS, which is true with
> > > +      some embedded SoCs.
> > > +    maxItems: 1
> >
> > A uint32 is only ever 1 item. Drop.
> >
> > IIRC, isn't the max here 0xff? Add constraints.
>
> i've found it only set to 0x1 so i have currently set the maximum to 0x1, is this ok?
> If some higher value is needed binding needs to be touched...

There's a spec for it, so no need to look at what's used. Calxeda AHCI
had 5 ports IIRC.


> > > +  reg-names:
> > > +    maxItems: 1
> >
> > Group with 'reg'.
>
> ok
>
> > > +patternProperties:
> > > +  "^sata-port@[0-9a-f]+$":
> > > +    type: object
> >
> >        additionalProperties: false
>
> ok added to my tree
>
> and needed to add phy-names because some marvell boards using this
>
> arch/arm64/boot/dts/marvell/armada-8040-mcbin-singleshot.dt.yaml: sata at 540000: sata-port at 1: 'phy-names' does not match any of the regexes: 'pinctrl-[0-9]+'
>
> now i have only the marvell-errors about incomplete sata-port subnode (without phy/target-supply) like i mention in the patch...how to proceed with this?

So the child nodes are incomplete? They should be disabled then
(status = "disabled") and that turns off required properties checks.

Rob