xref: /linux/Documentation/devicetree/bindings/soc/qcom/qcom,pmic-glink.yaml (revision d53b8e36925256097a08d7cb749198d85cbf9b2b) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/soc/qcom/qcom,pmic-glink.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Qualcomm PMIC GLINK firmware interface for battery management, USB
8  Type-C and other things.
9
10maintainers:
11  - Bjorn Andersson <andersson@kernel.org>
12
13description:
14  The PMIC GLINK service, running on a coprocessor on some modern Qualcomm
15  platforms and implement USB Type-C handling and battery management. This
16  binding describes the component in the OS used to communicate with the
17  firmware and connect it's resources to those described in the Devicetree,
18  particularly the USB Type-C controllers relationship with USB and DisplayPort
19  components.
20
21properties:
22  compatible:
23    oneOf:
24      - items:
25          - enum:
26              - qcom,qcm6490-pmic-glink
27              - qcom,sc8180x-pmic-glink
28              - qcom,sc8280xp-pmic-glink
29              - qcom,sm8350-pmic-glink
30              - qcom,sm8450-pmic-glink
31              - qcom,sm8550-pmic-glink
32          - const: qcom,pmic-glink
33      - items:
34          - enum:
35              - qcom,sm8650-pmic-glink
36              - qcom,x1e80100-pmic-glink
37          - const: qcom,sm8550-pmic-glink
38          - const: qcom,pmic-glink
39
40  '#address-cells':
41    const: 1
42
43  '#size-cells':
44    const: 0
45
46  orientation-gpios:
47    description: Array of input gpios for the Type-C connector orientation indication.
48      The GPIO indication is used to detect the orientation of the Type-C connector.
49      The array should contain a gpio entry for each PMIC Glink connector, in reg order.
50      It is defined that GPIO active level means "CC2" or Reversed/Flipped orientation.
51
52patternProperties:
53  '^connector@\d$':
54    $ref: /schemas/connector/usb-connector.yaml#
55    required:
56      - reg
57
58required:
59  - compatible
60
61additionalProperties: false
62
63examples:
64  - |+
65    pmic-glink {
66        compatible = "qcom,sc8280xp-pmic-glink", "qcom,pmic-glink";
67
68        #address-cells = <1>;
69        #size-cells = <0>;
70
71        connector@0 {
72            compatible = "usb-c-connector";
73            reg = <0>;
74            power-role = "dual";
75            data-role = "dual";
76
77            ports {
78                #address-cells = <1>;
79                #size-cells = <0>;
80
81                port@0 {
82                    reg = <0>;
83                    endpoint {
84                        remote-endpoint = <&usb_role>;
85                    };
86                };
87
88                port@1 {
89                    reg = <1>;
90                    endpoint {
91                        remote-endpoint = <&ss_phy_out>;
92                    };
93                };
94
95                port@2 {
96                    reg = <2>;
97                    endpoint {
98                        remote-endpoint = <&sbu_mux>;
99                    };
100                };
101            };
102        };
103    };
104...
105
106