xref: /linux/Documentation/devicetree/bindings/arm/qcom-soc.yaml (revision 68a052239fc4b351e961f698b824f7654a346091) 
1# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/arm/qcom-soc.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Qualcomm SoC compatibles naming convention
8
9maintainers:
10  - Bjorn Andersson <andersson@kernel.org>
11
12description: |
13  Guidelines for new compatibles for SoC blocks/components.
14  When adding new compatibles in new bindings, use the format::
15    qcom,SoC-IP
16
17  For example::
18   qcom,sdm845-llcc-bwmon
19
20  When adding new compatibles to existing bindings, use the format in the
21  existing binding, even if it contradicts the above.
22
23select:
24  properties:
25    compatible:
26      oneOf:
27        - pattern: "^qcom,.*(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sar|sc|sd[amx]|sm|x1[ep])[0-9]+.*$"
28        - pattern: "^qcom,.*(glymur|milos).*$"
29  required:
30    - compatible
31
32properties:
33  compatible:
34    oneOf:
35      # Preferred naming style for compatibles of SoC components:
36      - pattern: "^qcom,(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm|x1[ep])[0-9]+(pro)?-.*$"
37      - pattern: "^qcom,sar[0-9]+[a-z]?-.*$"
38      - pattern: "^qcom,(sa|sc)8[0-9]+[a-z][a-z]?-.*$"
39      - pattern: "^qcom,(glymur|milos)-.*$"
40
41      # Legacy namings - variations of existing patterns/compatibles are OK,
42      # but do not add completely new entries to these:
43      - pattern: "^qcom,[ak]pss-wdt-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
44      - pattern: "^qcom,gcc-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
45      - pattern: "^qcom,mmcc-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
46      - pattern: "^qcom,pcie-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm|x1[ep])[0-9]+.*$"
47      - pattern: "^qcom,rpm-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
48      - pattern: "^qcom,scm-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm|x1[ep])[0-9]+.*$"
49      - enum:
50          - qcom,dsi-ctrl-6g-qcm2290
51          - qcom,gpucc-sdm630
52          - qcom,gpucc-sdm660
53          - qcom,lcc-apq8064
54          - qcom,lcc-ipq8064
55          - qcom,lcc-mdm9615
56          - qcom,lcc-msm8960
57          - qcom,lpass-cpu-apq8016
58          - qcom,usb-ss-ipq4019-phy
59          - qcom,usb-hs-ipq4019-phy
60          - qcom,vqmmc-ipq4019-regulator
61
62      # Legacy compatibles with wild-cards - list cannot grow with new bindings:
63      - enum:
64          - qcom,ipq806x-gmac
65          - qcom,ipq806x-nand
66          - qcom,ipq806x-sata-phy
67          - qcom,ipq806x-usb-phy-ss
68          - qcom,ipq806x-usb-phy-hs
69
70additionalProperties: true
71