Patchwork [1/2] dt-bindings: add hym8563 binding

login
register
mail settings
Submitter Heiko Stübner
Date Nov. 22, 2013, 9:55 p.m.
Message ID <201311222255.03642.heiko@sntech.de>
Download mbox | patch
Permalink /patch/293599/
State New
Headers show

Comments

Heiko Stübner - Nov. 22, 2013, 9:55 p.m.
Add binding documentation for the hym8563 rtc chip.

Signed-off-by: Heiko Stuebner <heiko@sntech.de>
---
 .../devicetree/bindings/rtc/haoyu,hym8563.txt      |   29 ++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt
Mark Rutland - Nov. 25, 2013, 11:50 a.m.
On Fri, Nov 22, 2013 at 09:55:03PM +0000, Heiko Stübner wrote:
> Add binding documentation for the hym8563 rtc chip.
> 
> Signed-off-by: Heiko Stuebner <heiko@sntech.de>
> ---
>  .../devicetree/bindings/rtc/haoyu,hym8563.txt      |   29 ++++++++++++++++++++
>  1 file changed, 29 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt
> 
> diff --git a/Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt b/Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt
> new file mode 100644
> index 0000000..2743416
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt
> @@ -0,0 +1,29 @@
> +Haoyu Microelectronics HYM8563 Real Time Clock
> +
> +The HYM8563 provides basic rtc and alarm functionality
> +as well as a clock output of up to 32kHz.
> +
> +Required properties:
> +- compatible: should be: "haoyu,hym8563"

The "haoyu" vendor prefix will need to be documented (I couldn't spot it
in mainline's vendor-refixes.txt).

> +- reg: i2c address
> +- gpios: interrupt gpio

What's this used for exactly?

Thanks,
Mark.

Patch

diff --git a/Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt b/Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt
new file mode 100644
index 0000000..2743416
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/haoyu,hym8563.txt
@@ -0,0 +1,29 @@ 
+Haoyu Microelectronics HYM8563 Real Time Clock
+
+The HYM8563 provides basic rtc and alarm functionality
+as well as a clock output of up to 32kHz.
+
+Required properties:
+- compatible: should be: "haoyu,hym8563"
+- reg: i2c address
+- gpios: interrupt gpio
+- interrupts: rtc alarm/event interrupt
+- #clock-cells: the value should be 0
+
+Example:
+
+hym8563: hym8563@51 {
+	compatible = "haoyu,hym8563";
+	reg = <0x51>;
+
+	gpios = <&gpio0 13 0>;
+	interrupts = <13 IRQ_TYPE_EDGE_FALLING>;
+
+	#clock-cells = <0>;
+};
+
+device {
+...
+	clocks = <&hym8563>;
+...
+};