101c09554b8052b0e0dbaf8606094f8163234fb9
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / soc / qcom / qcom,pmic-glink.yaml
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
7 title: Qualcomm PMIC GLINK firmware interface for battery management, USB
8   Type-C and other things.
9
10 maintainers:
11   - Bjorn Andersson <andersson@kernel.org>
12
13 description:
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
21 properties:
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           - const: qcom,sm8550-pmic-glink
37           - const: qcom,pmic-glink
38
39   '#address-cells':
40     const: 1
41
42   '#size-cells':
43     const: 0
44
45   orientation-gpios:
46     description: Array of input gpios for the Type-C connector orientation indication.
47       The GPIO indication is used to detect the orientation of the Type-C connector.
48       The array should contain a gpio entry for each PMIC Glink connector, in reg order.
49       It is defined that GPIO active level means "CC2" or Reversed/Flipped orientation.
50
51 patternProperties:
52   '^connector@\d$':
53     $ref: /schemas/connector/usb-connector.yaml#
54     required:
55       - reg
56
57 required:
58   - compatible
59
60 allOf:
61   - if:
62       not:
63         properties:
64           compatible:
65             contains:
66               enum:
67                 - qcom,sm8450-pmic-glink
68                 - qcom,sm8550-pmic-glink
69     then:
70       properties:
71         orientation-gpios: false
72
73 additionalProperties: false
74
75 examples:
76   - |+
77     pmic-glink {
78         compatible = "qcom,sc8280xp-pmic-glink", "qcom,pmic-glink";
79
80         #address-cells = <1>;
81         #size-cells = <0>;
82
83         connector@0 {
84             compatible = "usb-c-connector";
85             reg = <0>;
86             power-role = "dual";
87             data-role = "dual";
88
89             ports {
90                 #address-cells = <1>;
91                 #size-cells = <0>;
92
93                 port@0 {
94                     reg = <0>;
95                     endpoint {
96                         remote-endpoint = <&usb_role>;
97                     };
98                 };
99
100                 port@1 {
101                     reg = <1>;
102                     endpoint {
103                         remote-endpoint = <&ss_phy_out>;
104                     };
105                 };
106
107                 port@2 {
108                     reg = <2>;
109                     endpoint {
110                         remote-endpoint = <&sbu_mux>;
111                     };
112                 };
113             };
114         };
115     };
116 ...
117