Skip to contentSkip to conversation

ACPI: TAD: introduce acpi_has_rtc()

PATCH Superseded Hamza Mahfooz 4 participants 6 messages Oct 26 – Oct 27

Subsystems (2)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/2 ACPI: TAD: introduce acpi_has_rtc()

The same RTC may also be accessible by other means, like the EFI GetTime() and SetTime() runtime services used by rtc-efi, which are best avoided if there is a native ACPI interface to the RTC.

To allow other RTC drivers to stand down in that case, add an exported helper, acpi_has_rtc(), that returns true if there is a TAD the driver will register an RTC class device for.

The helper looks for a platform device matching the driver's ID table whose _GCP indicates real time support, like acpi_tad_probe() checks, instead of checking whether the driver has bound to such a device, so that callers need not depend on the order in which drivers are probed.

---
v1: https://lore.kernel.org/r/[email protected]/
v2:
- Rename acpi_tad_rtc_available() to acpi_has_rtc(), move it to within acpi-tad (which allows us to simplify it quite a bit) and declare it
in linux/acpi.h. (Ard)
- Add acpi_disabled check. (Ard)

---
 drivers/acpi/acpi_tad.c | 38 ++++++++++++++++++++++++++++++++++++++
 include/linux/acpi.h    |  6 ++++++
 2 files changed, 44 insertions(+)
drivers/acpi/acpi_tad.c +38 -0
index 45459a4ca..eea4d2123 100644
@@ -899,6 +899,44 @@ static const struct acpi_device_id acpi_tad_ids[] = {
 	{}
 };
 
+static int acpi_tad_rtc_match(struct device *dev, const void *data)
+{
+	unsigned long long caps;
+	acpi_status status;
+
+	if (!acpi_match_device(acpi_tad_ids, dev))
+		return 0;
+
+	status = acpi_evaluate_integer(ACPI_HANDLE(dev), "_GCP", NULL, &caps);
+
+	return ACPI_SUCCESS(status) && (caps & ACPI_TAD_RT);
+}
+
+/**
+ * acpi_has_rtc - Check if the RTC should be driven via the ACPI TAD
+ *
+ * Check if there is a TAD implementing the real time methods that this driver
+ * will register an RTC class device for.
+ *
+ * Return: %true if the RTC should be driven via the ACPI TAD, %false otherwise.
+ */
+bool acpi_has_rtc(void)
+{
+	struct device *dev;
+
+	if (acpi_disabled || !IS_ENABLED(CONFIG_RTC_CLASS))
+		return false;
+
+	dev = bus_find_device(&platform_bus_type, NULL, NULL,
+			      acpi_tad_rtc_match);
+	if (!dev)
+		return false;
+
+	put_device(dev);
+	return true;
+}
+EXPORT_SYMBOL_GPL(acpi_has_rtc);
+
 static struct platform_driver acpi_tad_driver = {
 	.driver = {
 		.name = "acpi-tad",
include/linux/acpi.h +6 -0
index ddacac812..71524a821 100644
@@ -1553,6 +1553,12 @@ extern bool acpi_has_watchdog(void);
 static inline bool acpi_has_watchdog(void) { return false; }
 #endif
 
+#if IS_REACHABLE(CONFIG_ACPI_TAD)
+bool acpi_has_rtc(void);
+#else
+static inline bool acpi_has_rtc(void) { return false; }
+#endif
+
 #ifdef CONFIG_ACPI_SPCR_TABLE
 extern bool qdf2400_e44_present;
 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
Signature · 1 line
2.56.0
#1 lore raw

PATCH v3 2/2 rtc: efi: defer to the ACPI TAD if it can drive the RTC

EFI runtime services are best avoided where possible, and ACPI defines a standard interface to the RTC in the form of the Time and Alarm Device (TAD), which the acpi-tad driver has been exposing as an RTC class device since commit 8a1e7f4b1764 ("ACPI: TAD: Add RTC class device interface").

So, make rtc-efi decline to probe, before calling GetTime(), if acpi_has_rtc() says that the RTC can be driven via the TAD.

Also, to ensure that acpi_has_rtc() is always reachable from rtc-efi when ACPI_TAD is enabled, make RTC_DRV_EFI depend on ACPI_TAD || !ACPI_TAD.

---
v1: https://lore.kernel.org/all/[email protected]/
v2:
- Make rtc-efi decline to probe instead of not registering the device in efisubsys_init(). (Ard)
- Make RTC_DRV_EFI depend on !ACPI || ACPI_TAD. (Ard)
v3: Make RTC_DRV_EFI depend on ACPI_TAD || !ACPI_TAD. (Sashiko)

---
 drivers/rtc/Kconfig   | 5 +++++
 drivers/rtc/rtc-efi.c | 4 ++++
 2 files changed, 9 insertions(+)
drivers/rtc/Kconfig +5 -0
index 1e863f1d3..5b7e9d2a8 100644
@@ -1262,10 +1262,15 @@ config RTC_DRV_DA9063
 config RTC_DRV_EFI
 	tristate "EFI RTC"
 	depends on EFI && !X86
+	depends on ACPI_TAD || !ACPI_TAD
 	help
 	  If you say yes here you will get support for the EFI
 	  Real Time Clock.
 
+	  On ACPI systems, the ACPI Time and Alarm Device (TAD) driver
+	  is used instead of this one if the TAD can drive the RTC (assuming
+	  it's enabled).
+
 	  This driver can also be built as a module. If so, the module
 	  will be called rtc-efi.
 
drivers/rtc/rtc-efi.c +4 -0
index b4f44999e..545b21b17 100644
@@ -10,6 +10,7 @@
 
 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 
+#include <linux/acpi.h>
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/stringify.h>
@@ -192,6 +193,9 @@ static int __init efi_rtc_probe(struct platform_device *dev)
 	efi_time_t eft;
 	efi_time_cap_t cap;
 
+	if (acpi_has_rtc())
+		return -ENODEV;
+
 	/* First check if the RTC is usable */
 	if (efi.get_time(&eft, &cap) != EFI_SUCCESS)
 		return -ENODEV;
Signature · 1 line
2.56.0
#2 lore raw

Re: [PATCH v3 2/2] rtc: efi: defer to the ACPI TAD if it can drive the RTC

Sashiko has reviewed this patch and found no issues.
Quoted 9 lines

EFI runtime services are best avoided where possible, and ACPI defines a standard interface to the RTC in the form of the Time and Alarm Device (TAD), which the acpi-tad driver has been exposing as an RTC class device since commit 8a1e7f4b1764 ("ACPI: TAD: Add RTC class device interface").

So, make rtc-efi decline to probe, before calling GetTime(), if acpi_has_rtc() says that the RTC can be driven via the TAD.

Quoted 6 lines

Also, to ensure that acpi_has_rtc() is always reachable from rtc-efi when ACPI_TAD is enabled, make RTC_DRV_EFI depend on ACPI_TAD || !ACPI_TAD.

Sashiko has reviewed this patch and found no issues.

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2
#3 lore raw
In reply to Hamza Mahfooz
Sashiko has reviewed this patch and found no issues.
Quoted 8 lines

The same RTC may also be accessible by other means, like the EFI GetTime() and SetTime() runtime services used by rtc-efi, which are best avoided if there is a native ACPI interface to the RTC.

To allow other RTC drivers to stand down in that case, add an exported helper, acpi_has_rtc(), that returns true if there is a TAD the driver will register an RTC class device for.

Quoted 7 lines

The helper looks for a platform device matching the driver's ID table whose _GCP indicates real time support, like acpi_tad_probe() checks, instead of checking whether the driver has bound to such a device, so that callers need not depend on the order in which drivers are probed.

Sashiko has reviewed this patch and found no issues.

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Reviewed-by on v3 1/2
#4 lore raw
In reply to Hamza Mahfooz

Hello Hamza,

Quoted 15 lines · Hamza Mahfooz

The same RTC may also be accessible by other means, like the EFI GetTime() and SetTime() runtime services used by rtc-efi, which are best avoided if there is a native ACPI interface to the RTC.

To allow other RTC drivers to stand down in that case, add an exported helper, acpi_has_rtc(), that returns true if there is a TAD the driver will register an RTC class device for.

The helper looks for a platform device matching the driver's ID table whose _GCP indicates real time support, like acpi_tad_probe() checks, instead of checking whether the driver has bound to such a device, so that callers need not depend on the order in which drivers are probed.

Quoted 8 lines

---
v1:
https://lore.kernel.org/r/[email protected]/
v2:
- Rename acpi_tad_rtc_available() to acpi_has_rtc(), move it to within acpi-tad (which allows us to simplify it quite a bit) and declare it in linux/acpi.h. (Ard)
- Add acpi_disabled check. (Ard)

Next time, please use a cover latter when sending a series, so that you can capture these changelogs in one place.

The series looks good to me:

I'll let Rafael and Alexandre decide how to queue this, once they are happy with the patches as well.

#5 lore raw
In reply to Hamza Mahfooz
Quoted 53 lines · Hamza Mahfooz

The same RTC may also be accessible by other means, like the EFI GetTime() and SetTime() runtime services used by rtc-efi, which are best avoided if there is a native ACPI interface to the RTC.

To allow other RTC drivers to stand down in that case, add an exported helper, acpi_has_rtc(), that returns true if there is a TAD the driver will register an RTC class device for.

The helper looks for a platform device matching the driver's ID table whose _GCP indicates real time support, like acpi_tad_probe() checks, instead of checking whether the driver has bound to such a device, so that callers need not depend on the order in which drivers are probed.

---
v1: https://lore.kernel.org/r/[email protected]/
v2:
- Rename acpi_tad_rtc_available() to acpi_has_rtc(), move it to within acpi-tad (which allows us to simplify it quite a bit) and declare it
in linux/acpi.h. (Ard)
- Add acpi_disabled check. (Ard)

---
 drivers/acpi/acpi_tad.c | 38 ++++++++++++++++++++++++++++++++++++++
 include/linux/acpi.h    |  6 ++++++
 2 files changed, 44 insertions(+)
drivers/acpi/acpi_tad.c +17 -0
index 45459a4ca..eea4d2123 100644
@@ -899,6 +899,44 @@ static const struct acpi_device_id acpi_tad_ids[] = {
        {}
 };
 
+static int acpi_tad_rtc_match(struct device *dev, const void *data)
+{
+       unsigned long long caps;
+       acpi_status status;
+
+       if (!acpi_match_device(acpi_tad_ids, dev))
+               return 0;
+
+       status = acpi_evaluate_integer(ACPI_HANDLE(dev), "_GCP", NULL, &caps);
+
+       return ACPI_SUCCESS(status) && (caps & ACPI_TAD_RT);
+}
+
+/**
+ * acpi_has_rtc - Check if the RTC should be driven via the ACPI TAD
+ *
+ * Check if there is a TAD implementing the real time methods that this driver

drivers/acpi/acpi_tad.c static const struct acpi_device_id acpi_tad_ids[] = { · line 928

Quoted 10 lines
drivers/acpi/acpi_tad.c +10 -0
+ * will register an RTC class device for.
+ *
+ * Return: %true if the RTC should be driven via the ACPI TAD, %false otherwise.
+ */
+bool acpi_has_rtc(void)
+{
+       struct device *dev;
+
+       if (acpi_disabled || !IS_ENABLED(CONFIG_RTC_CLASS))
+               return false;

You may as well put these new functions under the existing CONFIG_RTC_CLASS #ifdef so they don't get compiled unnecessarily, and add an empty stub for acpi_has_rtc() in the !CONFIG_RTC_CLASS case.

The IS_ENABLED(CONFIG_RTC_CLASS) check above will not be necessary any more then.

Apart from the above, the patch looks fine to me.

Quoted 34 lines
drivers/acpi/acpi_tad.c +11 -0
+
+       dev = bus_find_device(&platform_bus_type, NULL, NULL,
+                             acpi_tad_rtc_match);
+       if (!dev)
+               return false;
+
+       put_device(dev);
+       return true;
+}
+EXPORT_SYMBOL_GPL(acpi_has_rtc);
+
 static struct platform_driver acpi_tad_driver = {
        .driver = {
                .name = "acpi-tad",
include/linux/acpi.h +6 -1
index ddacac812..71524a821 100644
@@ -1553,6 +1553,12 @@ extern bool acpi_has_watchdog(void);
 static inline bool acpi_has_watchdog(void) { return false; }
 #endif
 
+#if IS_REACHABLE(CONFIG_ACPI_TAD)
+bool acpi_has_rtc(void);
+#else
+static inline bool acpi_has_rtc(void) { return false; }
+#endif
+
 #ifdef CONFIG_ACPI_SPCR_TABLE
 extern bool qdf2400_e44_present;
 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
--

2.56.0