mfd: devicetree: bindings: Add pm8xxx RTC description

The PM8xxx family of PMICs contain an RTC.  This RTC is described as a
subnode of the PM8xxx.  Document these bindings, and replace the pwrkey
node in the example with the RTC, which is now described in this
document.

While we're here, add a short description to the device tree bindings
describing what the the PM8xxx devices are and how they are expected to
be used.

Signed-off-by: Josh Cartwright <joshc@codeaurora.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
This commit is contained in:
Josh Cartwright 2014-03-12 12:17:24 -05:00 committed by Lee Jones
parent 204747c970
commit 5de5b2d5b8

View file

@ -1,6 +1,9 @@
Qualcomm PM8xxx PMIC multi-function devices
PROPERTIES
The PM8xxx family of Power Management ICs are used to provide regulated
voltages and other various functionality to Qualcomm SoCs.
= PROPERTIES
- compatible:
Usage: required
@ -45,7 +48,37 @@ PROPERTIES
Value type: <empty>
Definition: identifies this node as an interrupt controller
EXAMPLE
= SUBCOMPONENTS
The PMIC contains multiple independent functions, each described in a subnode.
The below bindings specify the set of valid subnodes.
== Real-Time Clock
- compatible:
Usage: required
Value type: <string>
Definition: must be one of:
"qcom,pm8058-rtc"
"qcom,pm8921-rtc"
- reg:
Usage: required
Value type: <prop-encoded-array>
Definition: single entry specifying the base address of the RTC registers
- interrupts:
Usage: required
Value type: <prop-encoded-array>
Definition: single entry specifying the RTC's alarm interrupt
- allow-set-time:
Usage: optional
Value type: <empty>
Definition: indicates that the setting of RTC time is allowed by
the host CPU
= EXAMPLE
pmicintc: pmic@0 {
compatible = "qcom,pm8921";
@ -55,9 +88,9 @@ EXAMPLE
#address-cells = <1>;
#size-cells = <0>;
pwrkey {
compatible = "qcom,pm8921-pwrkey";
interrupt-parent = <&pmicintc>;
interrupts = <50 1>, <51 1>;
rtc@11d {
compatible = "qcom,pm8921-rtc";
reg = <0x11d>;
interrupts = <0x27 0>;
};
};