xref: /freebsd-src/sys/contrib/device-tree/Bindings/arm/qcom-soc.yaml (revision 8d13bc63c0e1d50bc9e47ac1f26329c999bfecf0)
18bab661aSEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
28bab661aSEmmanuel Vadot%YAML 1.2
38bab661aSEmmanuel Vadot---
48bab661aSEmmanuel Vadot$id: http://devicetree.org/schemas/arm/qcom-soc.yaml#
58bab661aSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
68bab661aSEmmanuel Vadot
78bab661aSEmmanuel Vadottitle: Qualcomm SoC compatibles naming convention
88bab661aSEmmanuel Vadot
98bab661aSEmmanuel Vadotmaintainers:
108bab661aSEmmanuel Vadot  - Bjorn Andersson <andersson@kernel.org>
118bab661aSEmmanuel Vadot
128bab661aSEmmanuel Vadotdescription: |
138bab661aSEmmanuel Vadot  Guidelines for new compatibles for SoC blocks/components.
148bab661aSEmmanuel Vadot  When adding new compatibles in new bindings, use the format::
158bab661aSEmmanuel Vadot    qcom,SoC-IP
168bab661aSEmmanuel Vadot
178bab661aSEmmanuel Vadot  For example::
188bab661aSEmmanuel Vadot   qcom,sdm845-llcc-bwmon
198bab661aSEmmanuel Vadot
208bab661aSEmmanuel Vadot  When adding new compatibles to existing bindings, use the format in the
218bab661aSEmmanuel Vadot  existing binding, even if it contradicts the above.
228bab661aSEmmanuel Vadot
238bab661aSEmmanuel Vadotselect:
248bab661aSEmmanuel Vadot  properties:
258bab661aSEmmanuel Vadot    compatible:
26*8d13bc63SEmmanuel Vadot      pattern: "^qcom,.*(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm|x1e)[0-9]+.*$"
278bab661aSEmmanuel Vadot  required:
288bab661aSEmmanuel Vadot    - compatible
298bab661aSEmmanuel Vadot
308bab661aSEmmanuel Vadotproperties:
318bab661aSEmmanuel Vadot  compatible:
328bab661aSEmmanuel Vadot    oneOf:
338bab661aSEmmanuel Vadot      # Preferred naming style for compatibles of SoC components:
34*8d13bc63SEmmanuel Vadot      - pattern: "^qcom,(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm|x1e)[0-9]+(pro)?-.*$"
358bab661aSEmmanuel Vadot      - pattern: "^qcom,(sa|sc)8[0-9]+[a-z][a-z]?-.*$"
368bab661aSEmmanuel Vadot
378bab661aSEmmanuel Vadot      # Legacy namings - variations of existing patterns/compatibles are OK,
388bab661aSEmmanuel Vadot      # but do not add completely new entries to these:
39*8d13bc63SEmmanuel Vadot      - pattern: "^qcom,[ak]pss-wdt-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
40*8d13bc63SEmmanuel Vadot      - pattern: "^qcom,gcc-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
41*8d13bc63SEmmanuel Vadot      - pattern: "^qcom,mmcc-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
42*8d13bc63SEmmanuel Vadot      - pattern: "^qcom,pcie-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm|x1e)[0-9]+.*$"
43*8d13bc63SEmmanuel Vadot      - pattern: "^qcom,rpm-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm)[0-9]+.*$"
44*8d13bc63SEmmanuel Vadot      - pattern: "^qcom,scm-(apq|ipq|mdm|msm|qcm|qcs|q[dr]u|sa|sc|sd[amx]|sm|x1e)[0-9]+.*$"
458bab661aSEmmanuel Vadot      - enum:
468bab661aSEmmanuel Vadot          - qcom,dsi-ctrl-6g-qcm2290
478bab661aSEmmanuel Vadot          - qcom,gpucc-sdm630
488bab661aSEmmanuel Vadot          - qcom,gpucc-sdm660
498bab661aSEmmanuel Vadot          - qcom,lcc-apq8064
508bab661aSEmmanuel Vadot          - qcom,lcc-ipq8064
518bab661aSEmmanuel Vadot          - qcom,lcc-mdm9615
528bab661aSEmmanuel Vadot          - qcom,lcc-msm8960
538bab661aSEmmanuel Vadot          - qcom,lpass-cpu-apq8016
548bab661aSEmmanuel Vadot          - qcom,usb-ss-ipq4019-phy
558bab661aSEmmanuel Vadot          - qcom,usb-hs-ipq4019-phy
568bab661aSEmmanuel Vadot          - qcom,vqmmc-ipq4019-regulator
578bab661aSEmmanuel Vadot
588bab661aSEmmanuel Vadot      # Legacy compatibles with wild-cards - list cannot grow with new bindings:
598bab661aSEmmanuel Vadot      - enum:
608bab661aSEmmanuel Vadot          - qcom,ipq806x-gmac
618bab661aSEmmanuel Vadot          - qcom,ipq806x-nand
628bab661aSEmmanuel Vadot          - qcom,ipq806x-sata-phy
638bab661aSEmmanuel Vadot          - qcom,ipq806x-usb-phy-ss
648bab661aSEmmanuel Vadot          - qcom,ipq806x-usb-phy-hs
658bab661aSEmmanuel Vadot
668bab661aSEmmanuel VadotadditionalProperties: true
67