On Tue, Feb 13, 2024 at 08:23:40PM +0100, Niklas Söderlund wrote: > Compatibles can come in two formats. Either "vendor,ip-soc" or > "vendor,soc-ip". Add a DT schema file documenting Renesas preferred > policy and enforcing it for all new compatibles, except few existing > patterns. > > Suggested-by: Krzysztof Kozlowski <krzysztof.kozlowski@xxxxxxxxxx> > Signed-off-by: Niklas Söderlund <niklas.soderlund+renesas@xxxxxxxxxxxx> > --- > * Changes since v2 > - Improve the select so it matches on any compatible containing a > component specific Renesas value. > - Make the regexps more compact. > - Define MaxItems to allow the increased selection to work. > - Add rmobile and shmobile prefixes. > - I did not take Rob's ack from v2 as the schema changed a lot after > Geerts review. > > * Changes since v1 > - Split the "SoC agnostic compatibles" section into two to make it's > intent clearer. > - Improved the documentation for each group of compatibles. > - Reduced the number of regexp to create a larger target area. As > suggested by Krzysztof the goal is not to validate each SoC name but > check for the correct order of SoC-IP. > > * Changes since RFC > - Moved to Documentation/devicetree/bindings/soc/renesas. > - Changed the pattern in the initial select to match on .*-.*. > - Added a lot of missing compatible values. > --- > .../bindings/soc/renesas/renesas-soc.yaml | 72 +++++++++++++++++++ > 1 file changed, 72 insertions(+) > create mode 100644 Documentation/devicetree/bindings/soc/renesas/renesas-soc.yaml > > diff --git a/Documentation/devicetree/bindings/soc/renesas/renesas-soc.yaml b/Documentation/devicetree/bindings/soc/renesas/renesas-soc.yaml > new file mode 100644 > index 000000000000..57c11022d793 > --- /dev/null > +++ b/Documentation/devicetree/bindings/soc/renesas/renesas-soc.yaml > @@ -0,0 +1,72 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/soc/renesas/renesas-soc.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Renesas SoC compatibles naming convention > + > +maintainers: > + - Geert Uytterhoeven <geert+renesas@xxxxxxxxx> > + - Niklas Söderlund <niklas.soderlund@xxxxxxxxxxxx> > + > +description: | > + Guidelines for new compatibles for SoC blocks/components. > + When adding new compatibles in new bindings, use the format:: > + renesas,SoC-IP > + > + For example:: > + renesas,r8a77965-csi2 > + > + When adding new compatibles to existing bindings, use the format in the > + existing binding, even if it contradicts the above. > + > +select: > + properties: > + compatible: > + contains: > + pattern: "^renesas,.+-.+$" > + required: > + - compatible > + > +properties: > + compatible: > + maxItems: 4 'minItems: 1' should fix the error reported. > + items: > + anyOf: > + # Preferred naming style for compatibles of SoC components > + - pattern: "^renesas,(emev2|r(7s|8a|9a)[a-z0-9]+|rcar|rmobile|rz[a-z0-9]*|sh(7[a-z0-9]+)?|mobile)-[a-z0-9-]+$" > + - pattern: "^renesas,(condor|falcon|gr-peach|salvator|sk-rz|smar(c(2)?)?|spider|white-hawk)(.*)?$" > + > + # Legacy compatibles > + # > + # New compatibles are not allowed. > + - pattern: "^renesas,(can|cpg|dmac|du|(g)?ether(avb)?|gpio|hscif|(r)?i[i2]c|imr|intc|ipmmu|irqc|jpu|mmcif|msiof|mtu2|pci(e)?|pfc|pwm|[rq]spi|rcar_sound|sata|scif[ab]*|sdhi|thermal|tmu|tpu|usb(2|hs)?|vin|xhci)-[a-z0-9-]+$" > + - pattern: "^renesas,(d|s)?bsc(3)?-(r8a73a4|r8a7740|sh73a0)$" > + - pattern: "^renesas,em-(gio|sti|uart)$" > + - pattern: "^renesas,fsi2-(r8a7740|sh73a0)$" > + - pattern: "^renesas,hspi-r8a777[89]$" > + - pattern: "^renesas,sysc-(r8a73a4|r8a7740|rmobile|sh73a0)$" > + - enum: > + - renesas,imr-lx4 > + - renesas,mtu2-r7s72100 > + > + # None SoC component compatibles > + # > + # Compatibles with the Renesas vendor prefix that do not relate to any SoC > + # component are OK. New compatibles are allowed. > + - enum: > + - renesas,smp-sram > + > + # Do not fail compatibles not matching the select pattern > + # > + # Some SoC components in addition to a Renesas compatible list > + # compatibles not related to Renesas. The select pattern for this > + # schema hits all compatibles that have at lest one Renesas compatible > + # and try to validate all values in that compatible array, allow all > + # that don't match the schema select pattern. For example, > + # > + # compatible = "renesas,r9a07g044-mali", "arm,mali-bifrost"; > + - pattern: "^(?!renesas,.+-.+).+$" > + > +additionalProperties: true > -- > 2.43.0 >
