Re: [PATCH 1/4] rtc: armada38x: Add the device tree binding documentation

On Wed, Jan 14, 2015 at 12:02:27AM +0100, Arnaud Ebalard wrote:

Hi Gregory,

Gregory CLEMENT [off-list ref] writes:

quoted

The Armada 38x SoCs come with a new RTC which differs from the one
used in the other mvebu SoCs until now. This patch describes the
binding of this RTC.

Signed-off-by: Gregory CLEMENT <gregory.clement-wi1+55ScJUtKEb57/3fJTNBPR1lH4CV8@public.gmane.org>
---
 .../devicetree/bindings/rtc/armada-380-rtc.txt          | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/armada-380-rtc.txt

diff --git a/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt b/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt
new file mode 100644
index 000000000000..2c56bef9dd7e
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/armada-380-rtc.txt

@@ -0,0 +1,17 @@
+* Real Time Clock of te Armada 38x SoCs
+
+RTC controller for the Armada 38x SoCs
+
+Required properties:
+- compatible : Should be "marvell,armada-380-rtc"
+- reg: physical base address of the controller and length of memory mapped
+  region. The second entires is for the IP configuration part.

                        ^^^^^^^
                        entry

I had to read probe function to understand precisely the purpose of each
region, i.e. IMHO the description could be made a bit clearer.

Maybe using reg-names would make it easier to understand, both in the
documentation and the DT itself (as well as not needing to enforce a
particular ordering of the two areas in the documentation)

Maxime

-- 
Maxime Ripard, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com