xref: /freebsd/sys/contrib/device-tree/Bindings/soc/renesas/renesas-soc.yaml (revision 01950c46b8155250f64374fb72fc11faa44bf099)
1*01950c46SEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2*01950c46SEmmanuel Vadot%YAML 1.2
3*01950c46SEmmanuel Vadot---
4*01950c46SEmmanuel Vadot$id: http://devicetree.org/schemas/soc/renesas/renesas-soc.yaml#
5*01950c46SEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6*01950c46SEmmanuel Vadot
7*01950c46SEmmanuel Vadottitle: Renesas SoC compatibles naming convention
8*01950c46SEmmanuel Vadot
9*01950c46SEmmanuel Vadotmaintainers:
10*01950c46SEmmanuel Vadot  - Geert Uytterhoeven <geert+renesas@glider.be>
11*01950c46SEmmanuel Vadot  - Niklas Söderlund <niklas.soderlund@ragnatech.se>
12*01950c46SEmmanuel Vadot
13*01950c46SEmmanuel Vadotdescription: |
14*01950c46SEmmanuel Vadot  Guidelines for new compatibles for SoC blocks/components.
15*01950c46SEmmanuel Vadot  When adding new compatibles in new bindings, use the format::
16*01950c46SEmmanuel Vadot    renesas,SoC-IP
17*01950c46SEmmanuel Vadot
18*01950c46SEmmanuel Vadot  For example::
19*01950c46SEmmanuel Vadot   renesas,r8a77965-csi2
20*01950c46SEmmanuel Vadot
21*01950c46SEmmanuel Vadot  When adding new compatibles to existing bindings, use the format in the
22*01950c46SEmmanuel Vadot  existing binding, even if it contradicts the above.
23*01950c46SEmmanuel Vadot
24*01950c46SEmmanuel Vadotselect:
25*01950c46SEmmanuel Vadot  properties:
26*01950c46SEmmanuel Vadot    compatible:
27*01950c46SEmmanuel Vadot      contains:
28*01950c46SEmmanuel Vadot        pattern: "^renesas,.+-.+$"
29*01950c46SEmmanuel Vadot  required:
30*01950c46SEmmanuel Vadot    - compatible
31*01950c46SEmmanuel Vadot
32*01950c46SEmmanuel Vadotproperties:
33*01950c46SEmmanuel Vadot  compatible:
34*01950c46SEmmanuel Vadot    minItems: 1
35*01950c46SEmmanuel Vadot    maxItems: 4
36*01950c46SEmmanuel Vadot    items:
37*01950c46SEmmanuel Vadot      anyOf:
38*01950c46SEmmanuel Vadot        # Preferred naming style for compatibles of SoC components
39*01950c46SEmmanuel Vadot        - 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-]+$"
40*01950c46SEmmanuel Vadot        - pattern: "^renesas,(condor|falcon|gr-peach|gray-hawk|salvator|sk-rz|smar(c(2)?)?|spider|white-hawk)(.*)?$"
41*01950c46SEmmanuel Vadot
42*01950c46SEmmanuel Vadot        # Legacy compatibles
43*01950c46SEmmanuel Vadot        #
44*01950c46SEmmanuel Vadot        # New compatibles are not allowed.
45*01950c46SEmmanuel Vadot        - 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-]+$"
46*01950c46SEmmanuel Vadot        - pattern: "^renesas,(d|s)?bsc(3)?-(r8a73a4|r8a7740|sh73a0)$"
47*01950c46SEmmanuel Vadot        - pattern: "^renesas,em-(gio|sti|uart)$"
48*01950c46SEmmanuel Vadot        - pattern: "^renesas,fsi2-(r8a7740|sh73a0)$"
49*01950c46SEmmanuel Vadot        - pattern: "^renesas,hspi-r8a777[89]$"
50*01950c46SEmmanuel Vadot        - pattern: "^renesas,sysc-(r8a73a4|r8a7740|rmobile|sh73a0)$"
51*01950c46SEmmanuel Vadot        - enum:
52*01950c46SEmmanuel Vadot            - renesas,imr-lx4
53*01950c46SEmmanuel Vadot            - renesas,mtu2-r7s72100
54*01950c46SEmmanuel Vadot
55*01950c46SEmmanuel Vadot        # None SoC component compatibles
56*01950c46SEmmanuel Vadot        #
57*01950c46SEmmanuel Vadot        # Compatibles with the Renesas vendor prefix that do not relate to any SoC
58*01950c46SEmmanuel Vadot        # component are OK. New compatibles are allowed.
59*01950c46SEmmanuel Vadot        - enum:
60*01950c46SEmmanuel Vadot            - renesas,smp-sram
61*01950c46SEmmanuel Vadot
62*01950c46SEmmanuel Vadot        # Do not fail compatibles not matching the select pattern
63*01950c46SEmmanuel Vadot        #
64*01950c46SEmmanuel Vadot        # Some SoC components in addition to a Renesas compatible list
65*01950c46SEmmanuel Vadot        # compatibles not related to Renesas. The select pattern for this
66*01950c46SEmmanuel Vadot        # schema hits all compatibles that have at lest one Renesas compatible
67*01950c46SEmmanuel Vadot        # and try to validate all values in that compatible array, allow all
68*01950c46SEmmanuel Vadot        # that don't match the schema select pattern. For example,
69*01950c46SEmmanuel Vadot        #
70*01950c46SEmmanuel Vadot        #   compatible = "renesas,r9a07g044-mali", "arm,mali-bifrost";
71*01950c46SEmmanuel Vadot        - pattern: "^(?!renesas,.+-.+).+$"
72*01950c46SEmmanuel Vadot
73*01950c46SEmmanuel VadotadditionalProperties: true
74