xref: /freebsd/sys/contrib/device-tree/Bindings/clock/qcom,rpmcc.txt (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1Qualcomm RPM Clock Controller Binding
2------------------------------------------------
3The RPM is a dedicated hardware engine for managing the shared
4SoC resources in order to keep the lowest power profile. It
5communicates with other hardware subsystems via shared memory
6and accepts clock requests, aggregates the requests and turns
7the clocks on/off or scales them on demand.
8
9Required properties :
10- compatible : shall contain only one of the following. The generic
11               compatible "qcom,rpmcc" should be also included.
12
13			"qcom,rpmcc-msm8660", "qcom,rpmcc"
14			"qcom,rpmcc-apq8060", "qcom,rpmcc"
15			"qcom,rpmcc-msm8916", "qcom,rpmcc"
16			"qcom,rpmcc-msm8936", "qcom,rpmcc"
17			"qcom,rpmcc-msm8974", "qcom,rpmcc"
18			"qcom,rpmcc-msm8976", "qcom,rpmcc"
19			"qcom,rpmcc-apq8064", "qcom,rpmcc"
20			"qcom,rpmcc-ipq806x", "qcom,rpmcc"
21			"qcom,rpmcc-msm8992",·"qcom,rpmcc"
22			"qcom,rpmcc-msm8994",·"qcom,rpmcc"
23			"qcom,rpmcc-msm8996", "qcom,rpmcc"
24			"qcom,rpmcc-msm8998", "qcom,rpmcc"
25			"qcom,rpmcc-qcs404", "qcom,rpmcc"
26			"qcom,rpmcc-sdm660", "qcom,rpmcc"
27
28- #clock-cells : shall contain 1
29
30The clock enumerators are defined in <dt-bindings/clock/qcom,rpmcc.h>
31and come in pairs: FOO_CLK followed by FOO_A_CLK. The latter clock
32is an "active" clock, which means that the consumer only care that the
33clock is available when the apps CPU subsystem is active, i.e. not
34suspended or in deep idle. If it is important that the clock keeps running
35during system suspend, you need to specify the non-active clock, the one
36not containing *_A_* in the enumerator name.
37
38Example:
39	smd {
40		compatible = "qcom,smd";
41
42		rpm {
43			interrupts = <0 168 1>;
44			qcom,ipc = <&apcs 8 0>;
45			qcom,smd-edge = <15>;
46
47			rpm_requests {
48				compatible = "qcom,rpm-msm8916";
49				qcom,smd-channels = "rpm_requests";
50
51				rpmcc: clock-controller {
52					compatible = "qcom,rpmcc-msm8916", "qcom,rpmcc";
53					#clock-cells = <1>;
54				};
55			};
56		};
57	};
58