new file mode 100644
@@ -0,0 +1,135 @@
+# 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@glider.be>
+ - Niklas Söderlund <niklas.soderlund@ragnatech.se>
+
+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:
+ pattern: "^renesas,.*-.*$"
+ required:
+ - compatible
+
+properties:
+ compatible:
+ oneOf:
+ # Preferred naming style for compatibles of SoC components
+ - pattern: "^renesas,emev2-[a-z0-9-]+$"
+ - pattern: "^renesas,r(7s|8a|9a)[a-z0-9]+-[a-z0-9-]+$"
+ - pattern: "^renesas,rcar-[a-z0-9-]+$"
+ - pattern: "^renesas,rz[a-z0-9]*-[a-z0-9-]+$"
+ - pattern: "^renesas,sh-[a-z0-9-]+$"
+ - pattern: "^renesas,sh7[a-z0-9]+-[a-z0-9-]+$"
+
+ # Fallback compatibles
+ #
+ # Some SoC components in addition to a specific SoC compatible have a
+ # generic fallback compatible. For example the Interrupt Controller,
+ #
+ # compatible = "renesas,intc-irqpin-r8a7740", "renesas,intc-irqpin";
+ #
+ # This is OK and new fallback compatibles are allowed.
+ - enum:
+ - renesas,cpg-div6-clock
+ - renesas,cpg-mstp-clocks
+ - renesas,intc-irqpin
+
+ # Legacy compatibles
+ #
+ # New compatibles are not allowed but new variations of existing
+ # patterns/compatibles are.
+ - pattern: "^renesas,can-[a-z0-9]+$"
+ - pattern: "^renesas,dmac-[a-z0-9]+$"
+ - pattern: "^renesas,du-[a-z0-9]+$"
+ - pattern: "^renesas,ether-[a-z0-9]+$"
+ - pattern: "^renesas,etheravb-[a-z0-9]+$"
+ - pattern: "^renesas,etheravb-rcar-gen[0-9]$"
+ - pattern: "^renesas,gether-[a-z0-9]+$"
+ - pattern: "^renesas,gpio-[a-z0-9]+$"
+ - pattern: "^renesas,hscif-[a-z0-9]+$"
+ - pattern: "^renesas,i2c-[a-z0-9]+$"
+ - pattern: "^renesas,iic-[a-z0-9]+$"
+ - pattern: "^renesas,intc-ex-[a-z0-9]+$"
+ - pattern: "^renesas,intc-irqpin-[a-z0-9]+$"
+ - pattern: "^renesas,ipmmu-[a-z0-9]+$"
+ - pattern: "^renesas,irqc-[a-z0-9]+$"
+ - pattern: "^renesas,jpu-[a-z0-9]+$"
+ - pattern: "^renesas,mmcif-[a-z0-9]+$"
+ - pattern: "^renesas,msiof-[a-z0-9]+$"
+ - pattern: "^renesas,pci-[a-z0-9]+$"
+ - pattern: "^renesas,pci-rcar-gen[0-9]$"
+ - pattern: "^renesas,pcie-[a-z0-9]+$"
+ - pattern: "^renesas,pcie-rcar-gen[0-9]$"
+ - pattern: "^renesas,pfc-[a-z0-9]+$"
+ - pattern: "^renesas,pwm-[a-z0-9]+$"
+ - pattern: "^renesas,qspi-[a-z0-9]+$"
+ - pattern: "^renesas,rcar_sound-[a-z0-9]+$"
+ - pattern: "^renesas,riic-[a-z0-9]+$"
+ - pattern: "^renesas,rspi-[a-z0-9]+$"
+ - pattern: "^renesas,sata-[a-z0-9]+(-es1)?$"
+ - pattern: "^renesas,scif-[a-z0-9]+$"
+ - pattern: "^renesas,scifa-[a-z0-9]+$"
+ - pattern: "^renesas,scifb-[a-z0-9]+$"
+ - pattern: "^renesas,sdhi-[a-z0-9]+$"
+ - pattern: "^renesas,thermal-[a-z0-9]+$"
+ - pattern: "^renesas,tmu-[a-z0-9]+$"
+ - pattern: "^renesas,tpu-[a-z0-9]+$"
+ - pattern: "^renesas,usb-phy-[a-z0-9]+$"
+ - pattern: "^renesas,usb2-phy-[a-z0-9]+$"
+ - pattern: "^renesas,usbhs-[a-z0-9]+$"
+ - pattern: "^renesas,vin-[a-z0-9]+$"
+ - pattern: "^renesas,xhci-[a-z0-9]+$"
+
+ # Fixed legacy compatibles
+ #
+ # List cannot grow with new bindings.
+ - enum:
+ - renesas,bsc-r8a73a4
+ - renesas,bsc-sh73a0
+ - renesas,dbsc-r8a73a4
+ - renesas,dbsc3-r8a7740
+ - renesas,em-gio
+ - renesas,em-sti
+ - renesas,em-uart
+ - renesas,fsi2-r8a7740
+ - renesas,fsi2-sh73a0
+ - renesas,hspi-r8a7778
+ - renesas,hspi-r8a7779
+ - renesas,imr-lx4
+ - renesas,mtu2-r7s72100
+ - renesas,rmobile-iic
+ - renesas,sbsc-sh73a0
+ - renesas,sdhi-mmc-r8a77470
+ - renesas,shmobile-flctl-sh7372
+ - renesas,sysc-r8a73a4
+ - renesas,sysc-r8a7740
+ - renesas,sysc-rmobile
+ - renesas,sysc-sh73a0
+ - renesas,usb-dmac
+
+ # 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
+
+additionalProperties: true
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@linaro.org> Signed-off-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se> --- * 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 | 135 ++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 Documentation/devicetree/bindings/soc/renesas/renesas-soc.yaml