Merge branch 'next-seccomp' of git://git.kernel.org/pub/scm/linux/kernel/git/jmorris...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / clock / qcom,rpmcc.txt
1 Qualcomm RPM Clock Controller Binding
2 ------------------------------------------------
3 The RPM is a dedicated hardware engine for managing the shared
4 SoC resources in order to keep the lowest power profile. It
5 communicates with other hardware subsystems via shared memory
6 and accepts clock requests, aggregates the requests and turns
7 the clocks on/off or scales them on demand.
8
9 Required 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-msm8974", "qcom,rpmcc"
17                         "qcom,rpmcc-apq8064", "qcom,rpmcc"
18                         "qcom,rpmcc-msm8996", "qcom,rpmcc"
19                         "qcom,rpmcc-qcs404", "qcom,rpmcc"
20
21 - #clock-cells : shall contain 1
22
23 The clock enumerators are defined in <dt-bindings/clock/qcom,rpmcc.h>
24 and come in pairs: FOO_CLK followed by FOO_A_CLK. The latter clock
25 is an "active" clock, which means that the consumer only care that the
26 clock is available when the apps CPU subsystem is active, i.e. not
27 suspended or in deep idle. If it is important that the clock keeps running
28 during system suspend, you need to specify the non-active clock, the one
29 not containing *_A_* in the enumerator name.
30
31 Example:
32         smd {
33                 compatible = "qcom,smd";
34
35                 rpm {
36                         interrupts = <0 168 1>;
37                         qcom,ipc = <&apcs 8 0>;
38                         qcom,smd-edge = <15>;
39
40                         rpm_requests {
41                                 compatible = "qcom,rpm-msm8916";
42                                 qcom,smd-channels = "rpm_requests";
43
44                                 rpmcc: clock-controller {
45                                         compatible = "qcom,rpmcc-msm8916", "qcom,rpmcc";
46                                         #clock-cells = <1>;
47                                 };
48                         };
49                 };
50         };