Skip to contentSkip to conversation

rtc/cmos: add OF bindings

PATCH Superseded Sebastian Andrzej Siewior 4 participants 5 messages Dec 1, 2010 – Dec 2, 2010 2 messages not in the archive

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 rtc/cmos: add OF bindings

This allows to load the OF driver based informations from the device tree. Systems without BIOS may need to perform some initialization. PowerPC creates a PNP device from the OF information and performs this kind of initialization in their private PCI quirk. This looks more generic.

---
v1 - v2:
- changed ctrl_reg & freq_reg to changed ctrl-reg & freq-reg as recommended by Benh
- added missing get_rtc_time()
- set the default day to 1
- added binding info

 Documentation/powerpc/dts-bindings/rtc-cmos.txt |   28 ++++++
 drivers/rtc/rtc-cmos.c                          |  108 +++++++++++++++++++++++
 2 files changed, 136 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/powerpc/dts-bindings/rtc-cmos.txt
Documentation/powerpc/dts-bindings/rtc-cmos.txt new file +28 -0
new file mode 100644
index 0000000..7382989
@@ -0,0 +1,28 @@
+ Motorola mc146818 compatible RTC
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Required properties:
+  - compatible : "motorola,mc146818"
+  - reg : should contain registers location and length.
+
+Optional properties:
+  - interrupts : should contain interrupt.
+  - interrupt-parent : interrupt source phandle.
+  - ctrl-reg : Contains the initial value of the control register also
+    called "Register B".
+  - freq-reg : Contains the initial value of the frequency register also
+    called "Regsiter A".
+
+"Register A" and "B" are usually initialized by the firmware (BIOS for
+instance). If this is not done, it can be performed by the driver.
+
+ISA Example:
+
+	rtc@70 {
+	         compatible = "motorola,mc146818";
+	         interrupts = <8 3>;
+	         interrupt-parent = <&ioapic1>;
+	         ctrl-reg = <2>;
+	         freq-reg = <0x26>;
+	         reg = <1 0x70 2>;
+	 };
drivers/rtc/rtc-cmos.c +108 -0

138 lines not on this page · raw message

Signature · 1 line
1.7.3.2

A message that is not in the archive (sent off-list or not yet received): [email protected]

#2 lore raw
Quoted 5 lines · Sebastian Andrzej Siewior

This allows to load the OF driver based informations from the device tree. Systems without BIOS may need to perform some initialization. PowerPC creates a PNP device from the OF information and performs this kind of initialization in their private PCI quirk. This looks more generic.

Nice. We should also get this up on Grant's new wiki for device tree bindings at:
http://www.devicetree.org/
Longer term, that will be a better place to collect bindings than inside the kernel documentation.

Signature · 4 lines
David Gibson			| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you.  NOT _the_ _other_
				| _way_ _around_!
http://www.ozlabs.org/~dgibson
#3 lore raw
In reply to a message not in the archive
Quoted 10 lines · Sebastian Andrzej Siewior

This allows to load the OF driver based informations from the device tree. Systems without BIOS may need to perform some initialization. PowerPC creates a PNP device from the OF information and performs this kind of initialization in their private PCI quirk. This looks more generic.

---

Hi Sebastian.

Quoted 1 line

+static struct of_platform_driver cmos_of_driver_probe = {

of_platform_drivers are deprecated and being removed. Regular platform_drivers can be assigned an of_match_table and the platform_bus_type will use it to match drivers to devices. Instead of doing it this way, you can look for a device tree node in the existing platform_drivers probe hook and if it exists then fetch the additional data there.

g.

A message that is not in the archive (sent off-list or not yet received): AANLkTinF8GVv-HwKWCRx2jJoCZVWwNzBou3shi8OJj3S-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#5 lore raw

PATCH v3 1/1 rtc/cmos: add OF bindings

This allows to load the OF driver based informations from the device tree. Systems without BIOS may need to perform some initialization. PowerPC creates a PNP device from the OF information and performs this kind of initialization in their private PCI quirk. This looks more generic.

---
 Documentation/powerpc/dts-bindings/rtc-cmos.txt |   28 ++++++++++++++++
 drivers/rtc/rtc-cmos.c                          |   39 +++++++++++++++++++++++
 2 files changed, 67 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/powerpc/dts-bindings/rtc-cmos.txt
Documentation/powerpc/dts-bindings/rtc-cmos.txt new file +28 -0
new file mode 100644
index 0000000..7382989
@@ -0,0 +1,28 @@
+ Motorola mc146818 compatible RTC
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Required properties:
+  - compatible : "motorola,mc146818"
+  - reg : should contain registers location and length.
+
+Optional properties:
+  - interrupts : should contain interrupt.
+  - interrupt-parent : interrupt source phandle.
+  - ctrl-reg : Contains the initial value of the control register also
+    called "Register B".
+  - freq-reg : Contains the initial value of the frequency register also
+    called "Regsiter A".
+
+"Register A" and "B" are usually initialized by the firmware (BIOS for
+instance). If this is not done, it can be performed by the driver.
+
+ISA Example:
+
+	rtc@70 {
+	         compatible = "motorola,mc146818";
+	         interrupts = <8 3>;
+	         interrupt-parent = <&ioapic1>;
+	         ctrl-reg = <2>;
+	         freq-reg = <0x26>;
+	         reg = <1 0x70 2>;
+	 };
drivers/rtc/rtc-cmos.c +39 -0
index 5856167..dbb95b3 100644
@@ -36,6 +36,8 @@
 #include <linux/platform_device.h>
 #include <linux/mod_devicetable.h>
 #include <linux/log2.h>
+#include <linux/of.h>
+#include <linux/of_platform.h>
 
 /* this is for "generic access to PC-style RTC" using CMOS_READ/CMOS_WRITE */
 #include <asm-generic/rtc.h>
@@ -1121,6 +1123,15 @@ static struct pnp_driver cmos_pnp_driver = {
 
 #endif	/* CONFIG_PNP */
 
+#ifdef CONFIG_OF
+static const struct of_device_id of_cmos_match[] = {
+	{
+		.compatible = "motorola,mc146818",
+	},
+	{ },
+};
+MODULE_DEVICE_TABLE(of, of_cmos_match);
+#endif
 /*----------------------------------------------------------------*/
 
 /* Platform setup should have set up an RTC device, when PNP is
@@ -1129,6 +1140,31 @@ static struct pnp_driver cmos_pnp_driver = {
 
 static int __init cmos_platform_probe(struct platform_device *pdev)
 {
+	if (pdev->dev.of_node) {
+		struct device_node *node = pdev->dev.of_node;
+		struct rtc_time time;
+		int ret;
+		const __be32 *val;
+
+		val = of_get_property(node, "ctrl-reg", NULL);
+		if (val)
+			CMOS_WRITE(be32_to_cpup(val), RTC_CONTROL);
+
+		val = of_get_property(node, "freq-reg", NULL);
+		if (val)
+			CMOS_WRITE(be32_to_cpup(val), RTC_FREQ_SELECT);
+
+		get_rtc_time(&time);
+		ret = rtc_valid_tm(&time);
+		if (ret) {
+			struct rtc_time def_time = {
+				.tm_year = 1,
+				.tm_mday = 1,
+			};
+			set_rtc_time(&def_time);
+		}
+	}
+
 	cmos_wake_setup(&pdev->dev);
 	return cmos_do_probe(&pdev->dev,
 			platform_get_resource(pdev, IORESOURCE_IO, 0),
@@ -1157,6 +1193,9 @@ static struct platform_driver cmos_platform_driver = {
 	.shutdown	= cmos_platform_shutdown,
 	.driver = {
 		.name		= (char *) driver_name,
+#if defined(CONFIG_OF)
+		.of_match_table = of_cmos_match,
+#endif
 		.suspend	= cmos_suspend,
 		.resume		= cmos_resume,
 	}
Signature · 1 line
1.7.3.2
#6 lore raw

PATCH 1/1 x86/rtc: don't register rtc if we have an OF node for it

In reply to Grant Likely

or the rtc driver will probe for two devices: the static platform device the OF device.

---
 arch/x86/kernel/rtc.c |   23 +++++++++++++++++++++++
 1 files changed, 23 insertions(+), 0 deletions(-)
arch/x86/kernel/rtc.c +23 -0
index 1cfbbfc..382c6cb 100644
@@ -6,6 +6,7 @@
 #include <linux/acpi.h>
 #include <linux/bcd.h>
 #include <linux/pnp.h>
+#include <linux/of.h>
 
 #include <asm/vsyscall.h>
 #include <asm/x86_init.h>
@@ -218,6 +219,25 @@ static struct platform_device rtc_device = {
 	.num_resources	= ARRAY_SIZE(rtc_resources),
 };
 
+#ifdef CONFIG_OF
+static __init int have_rtc_of_node(void)
+{
+	struct device_node *n;
+
+	n = of_find_compatible_node(NULL, NULL, "motorola,mc146818");
+	if (n) {
+		of_node_put(n);
+		return 1;
+	}
+	return 0;
+}
+#else
+static inline int have_rtc_of_node(void)
+{
+	return 0;
+}
+#endif
+
 static __init int add_rtc_cmos(void)
 {
 #ifdef CONFIG_PNP
@@ -237,6 +257,9 @@ static __init int add_rtc_cmos(void)
 	}
 #endif
 
+	if (have_rtc_of_node())
+		return 0;
+
 	platform_device_register(&rtc_device);
 	dev_info(&rtc_device.dev,
 		 "registered platform RTC device (no PNP device found)\n");
Signature · 1 line
1.7.3.2