From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr2-f12.google.com (mail-wr2-f12.google.com [74.125.225.76]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A4B6845D91F for ; Wed, 30 Sep 2026 07:46:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.225.76 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1790754377; cv=none; b=sI/uljdycZ1cEN9tLrbJRJIGCOQcJophkTZkiRi7rEHtticxn1AonIEmB3Gc0Gi5fldl81flFnTuv/vBw50wVYqaphuktBY4X9/JE2GqNrBw0BiDQfMMvHAF24b7KloL7/6cKKi+lKuBrLL4LoCG4MUVwWumJnYowmKSmsyl8ZQ= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1790754377; c=relaxed/simple; bh=eI1N+vgTtX0UV8uuSGGKHvNWw5/CcAU0WVZl3XWcRIU=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Sa41Q7rRohclgzHVl5C9mzmNYX13OUAj2FC3qOvgZcqhnz7AbnjoxzvOC6qcoayske5fE7KnYkxCWdfiA+DnuVdsFIxWUWd3v3QXOpGkOrLBI78V4B/psRyp+BGNWwukl3ij81EWz/7Ap7K3HknZ76cLAEvgmkqzAIoCQGpdjXo= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=M4BORDs4; arc=none smtp.client-ip=74.125.225.76 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="M4BORDs4" Received: by mail-wr2-f12.google.com with SMTP id ffacd0b85a97d-48434392b02so4346668f8f.3 for ; Wed, 30 Sep 2026 00:46:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1790754373; x=1791359173; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to:content-type; bh=oHBzvkyAz6qIuzrHXiXDcUpv5YLjttHF1IIwKiFQRgs=; b=M4BORDs4X/NvN9LLUkCQ/fYVCMjoMV2aHvgpigUq7tK9G8h4nUyCEIwzauzlZ/1OY0 /LiP6h1pmSqeO0Y67a79gQVlewizD0P59TK7pc/c8gZowRnHERQQBppUCf3L19Hml75S He0xdzgBygr53OfJ7h0BELwC4WLl2iksy4/NJmHm3AQEVOjftLKFUWqCSGkOGWUf4iFw mK3TaG1foL396NErTWHqPZ4kR+3U5e1BT/3+scJS2ZRRhJLa6jYoxjAWEtwInNfeSWXd h0DoNjejGWopVn9mbAq+o79nYkRYp0wbVBz/k2m8x0h71Y+ZLviI5oJMRyuMII5TFpXq qnDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1790754373; x=1791359173; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to:content-type; bh=oHBzvkyAz6qIuzrHXiXDcUpv5YLjttHF1IIwKiFQRgs=; b=jeKL2U2A+1BghPoEsgKAzyd7c6e4iIjeqyZc3An6Jb2d/A+SchAVgxW9t+K+j8il0b PT7IYDs5rdsqTnEG+eIZl6EKCN/tac4kaa8jIS2byWjGpXU7C8mTD+xPAHg4bmXRfF2i fNnOpzFacDT9O/oUE53mpZWL/7PlGqhAVWtbvV8HeSJZikcStAwBCzfJ26o2NlQzrK+W VoHWHLI2EE3cPsvHX2eG5fLHoyk1TdKEqt3k5E053mv3lpfob7JRZjN+sm9ysZynrnuz sHG+Y91SMy9bJAz2ly70UCAvIvu0Z1QXKHzUfdi/KxM8V3302MplKK01c8oF1/HcVmB7 xM7A== X-Forwarded-Encrypted: i=1; AKwUvBwso1XxrivSIQpb7rRXtGYRA3/ML9wevagrCtsFTreL9mYBKjoYDE/UincEgBLch0tt5f76htpbX5k=@vger.kernel.org X-Gm-Message-State: AFq9FYK4IkcQT27J7xMP7whDQgPY5gm4t+FlUrslave4q+tME9WPw3Fl kHYOTy+LbCo6Zjpht3ogX+H+6MXYIJsCOx/DTgfwI22bNb1Bass99N0S X-Gm-Gg: AYBFou16R3k+3qhBn1I8fwb1P/WD9gsrcU4vHpFbyYdBySBl2UPQNkn/j7Nj7/S9+NJ JRMXMiUDq4G/bSn0b3sXEUTmLYITtFO/IJN44wzL6ICnAgjyv4rapvS21NucJWD/ir3Ttyc404T 5BFUYehfkFHVnVVuCRjRWGDeXJRD9XkoCrUxKH942YDBCqdFvrVGkYnsccl1HC3lcxgqG3N1Rvd IiKCbD84iiFQitBsGCkyrPKhfCU3kwZQbc22oehOgJHzkvuf+rDuCLo/52iqiL6b24edEGM+HG4 Ik6Ov0f2eqk1Igu8ltn+XdWykoLHA8AOZYqrMc+/tNIjIkgJw+6hVkILUCapgODeyLBPMvoosfs ELWGOSGAKzZIOEQLgA/0EXFWKU8YUCnYnOcwt0+0SDMgKes9nAHel8Wn/LUk1QsMrs+QVmSJ/4q l2FnRavjlKldweu9wO3Wpdpe8SaDPNNn2wXGsDzvKVgO0lfTNycQy5aWUIrtqqAkCoi+oJc9wwb WlmYwKbW8M5avc85xjQNmP/UfdVckw4O3aG2kBchPxeLQ== X-Received: by 2002:a5d:5e84:0:b0:487:27f9:843 with SMTP id ffacd0b85a97d-48b0258264cmr1060720f8f.56.1790754372559; Wed, 30 Sep 2026 00:46:12 -0700 (PDT) Received: from zeus.localdomain (212.71.14.70.adsl.dyn.edpnet.net. [212.71.14.70]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-48b02a0185asm1487480f8f.32.2026.09.30.00.46.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 30 Sep 2026 00:46:11 -0700 (PDT) From: Sander Speetjens To: Alexandre Belloni Cc: Rob Herring , Krzysztof Kozlowski , Conor Dooley , Florian Fainelli , Jonathan Bell , Stefan Wahren , linux-rtc@vger.kernel.org, devicetree@vger.kernel.org, linux-rpi-kernel@lists.infradead.org, linux-arm-kernel@lists.infradead.org, sander.speetjens@gmail.com, Dom Cobley Subject: [PATCH v6 2/2] rtc: Add Raspberry Pi 5 RTC driver Date: Wed, 30 Sep 2026 09:46:08 +0200 Message-ID: <20260930074608.479089-3-sander.speetjens@gmail.com> X-Mailer: git-send-email 2.55.0 In-Reply-To: <20260930074608.479089-1-sander.speetjens@gmail.com> References: <20260930074608.479089-1-sander.speetjens@gmail.com> Precedence: bulk X-Mailing-List: linux-rtc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Upstreaming the downstream Raspberry Pi 5 RTC driver. This driver supports the custom DA9091, which is accessed through the firmware mailbox. Signed-off-by: Jonathan Bell Signed-off-by: Dom Cobley Signed-off-by: Sander Speetjens --- V5 -> V6: - Add MODULE_ALIAS, as mentioned by sashiko-bot - Encapsulate the mailbox data in le32_to_cpu or cpu_to_le32, as mentioned by sashiko-bot. For good practice V4 -> V5: No changes V3 -> V4: - Fix Kconfig depends that disallows having Raspberrypi firmware built as a module while the rtc driver is built in - Remove sysfs - Add limits from firmware properties and check in rpi_rtc_set_charge_voltage V2 -> V3: - Move platform check to firmware and abort before registering a platform device if on another platform - Add a dependency on the Raspberry Pi firmware to Kconfig - Check return value of devm_device_init_wakeup - Fix property name V1 -> V2: Instead of the original driver, which was directly bound to the device tree. This driver is bound to the Raspberry Pi firmware device by creating a child device in the firmware driver probe function. The child device is then bound to this driver, which uses the firmware mailbox to access the RTC. A couple of minor changes have been made to the driver since it was originally written, including: - Checking if the model is a Raspberry Pi 5, as the RTC is only present on that model. - Using the new devm_rpi_firmware_get() and devm_init_wakeup() helper to get the firmware device and avoid leaking memory. - Using millivolts instead of microvolts for the trickle charge voltage, to match the RTC standard. - Instead of setting the trickle charge voltage to 0 to disable trickle charging, the property is now optional. If the property is not present, trickle charging is disabled, per the RTC standard. - Renaming the driver dt match compatible to "raspberrypi,firmware-rtc" to match the other firmware bindings. - Renaming the driver name to "raspberrypi-rtc" to match the other firmware drivers. drivers/firmware/raspberrypi.c | 25 ++++ drivers/rtc/Kconfig | 12 ++ drivers/rtc/Makefile | 1 + drivers/rtc/rtc-raspberrypi.c | 251 +++++++++++++++++++++++++++++++++ 4 files changed, 289 insertions(+) create mode 100644 drivers/rtc/rtc-raspberrypi.c diff --git a/drivers/firmware/raspberrypi.c b/drivers/firmware/raspberrypi.c index 0aa322e9a2e7..a35f00c6fb2c 100644 --- a/drivers/firmware/raspberrypi.c +++ b/drivers/firmware/raspberrypi.c @@ -24,6 +24,7 @@ static struct platform_device *rpi_hwmon; static struct platform_device *rpi_clk; +static struct platform_device *rpi_rtc; struct rpi_firmware { struct mbox_client cl; @@ -231,6 +232,27 @@ static void rpi_register_clk_driver(struct device *dev) -1, NULL, 0); } +static void rpi_register_rtc_driver(struct device *dev) +{ + struct device_node *firmware; + + // Check if our model is a Raspberry Pi 5, as the RTC is only present on that model. + const char *model = of_get_property(of_root, "model", NULL); + + if (!model || strncmp(model, "Raspberry Pi 5", 14) != 0) + return; + + firmware = of_get_compatible_child(dev->of_node, + "raspberrypi,firmware-rtc"); + if (firmware) { + of_node_put(firmware); + return; + } + + rpi_rtc = platform_device_register_data(dev, "raspberrypi-rtc", + -1, NULL, 0); +} + unsigned int rpi_firmware_clk_get_max_rate(struct rpi_firmware *fw, unsigned int id) { struct rpi_firmware_clk_rate_request msg = @@ -305,6 +327,7 @@ static int rpi_firmware_probe(struct platform_device *pdev) rpi_firmware_print_firmware_revision(fw); rpi_register_hwmon_driver(dev, fw); rpi_register_clk_driver(dev); + rpi_register_rtc_driver(dev); return 0; } @@ -327,6 +350,8 @@ static void rpi_firmware_remove(struct platform_device *pdev) rpi_hwmon = NULL; platform_device_unregister(rpi_clk); rpi_clk = NULL; + platform_device_unregister(rpi_rtc); + rpi_rtc = NULL; rpi_firmware_put(fw); } diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig index 05b9233b9418..4dbe20bcace8 100644 --- a/drivers/rtc/Kconfig +++ b/drivers/rtc/Kconfig @@ -1999,6 +1999,18 @@ config RTC_DRV_R7301 This driver can also be built as a module. If so, the module will be called rtc-r7301. +config RTC_DRV_RPI + tristate "Raspberry Pi RTC" + depends on RASPBERRYPI_FIRMWARE || (COMPILE_TEST && !RASPBERRYPI_FIRMWARE) + depends on ARCH_BRCMSTB || COMPILE_TEST + default ARCH_BRCMSTB + help + If you say yes here you get support for the RTC found on + Raspberry Pi devices. + + This driver can also be built as a module. If so, the module + will be called rtc-raspberrypi. + config RTC_DRV_STM32 tristate "STM32 RTC" select REGMAP_MMIO diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile index 0347645b021f..46f1a0fc2416 100644 --- a/drivers/rtc/Makefile +++ b/drivers/rtc/Makefile @@ -144,6 +144,7 @@ obj-$(CONFIG_RTC_DRV_PS3) += rtc-ps3.o obj-$(CONFIG_RTC_DRV_PXA) += rtc-pxa.o obj-$(CONFIG_RTC_DRV_R7301) += rtc-r7301.o obj-$(CONFIG_RTC_DRV_R9701) += rtc-r9701.o +obj-$(CONFIG_RTC_DRV_RPI) += rtc-raspberrypi.o obj-$(CONFIG_RTC_DRV_RC5T583) += rtc-rc5t583.o obj-$(CONFIG_RTC_DRV_RC5T619) += rtc-rc5t619.o obj-$(CONFIG_RTC_DRV_RK808) += rtc-rk808.o diff --git a/drivers/rtc/rtc-raspberrypi.c b/drivers/rtc/rtc-raspberrypi.c new file mode 100644 index 000000000000..53178d1eaf48 --- /dev/null +++ b/drivers/rtc/rtc-raspberrypi.c @@ -0,0 +1,251 @@ +// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause +/** + * rtc-raspberrypi.c + * + * RTC driver using firmware mailbox + * Supports battery backed RTC and wake alarms + * + * Based on rtc-meson-vrtc by Neil Armstrong + * + * Copyright (c) 2023, Raspberry Pi Ltd. + */ + +#include +#include +#include +#include +#include + +#define RPI_FIRMWARE_GET_RTC_REG 0x00030087 +#define RPI_FIRMWARE_SET_RTC_REG 0x00038087 + +enum { + RTC_TIME, + RTC_ALARM, + RTC_ALARM_PENDING, + RTC_ALARM_ENABLE, + RTC_BBAT_CHG_VOLTS, + RTC_BBAT_CHG_VOLTS_MIN, + RTC_BBAT_CHG_VOLTS_MAX, + RTC_BBAT_VOLTS +}; + +struct rpi_rtc_data { + struct rtc_device *rtc; + struct rpi_firmware *fw; + u32 bbat_vchg_millivolts; + u32 bbat_vchg_min_millivolts; + u32 bbat_vchg_max_millivolts; +}; + +static int rpi_rtc_read_time(struct device *dev, struct rtc_time *tm) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_TIME }; + int err; + + err = rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_GET_RTC_REG, + &data, sizeof(data)); + rtc_time64_to_tm(le32_to_cpu(data[1]), tm); + return err; +} + +static int rpi_rtc_set_time(struct device *dev, struct rtc_time *tm) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_TIME, cpu_to_le32(rtc_tm_to_time64(tm)) }; + + return rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_SET_RTC_REG, + &data, sizeof(data)); +} + +static int rpi_rtc_alarm_irq_is_enabled(struct device *dev, unsigned char *enabled) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_ALARM_ENABLE }; + s32 err = 0; + + err = rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_GET_RTC_REG, + &data, sizeof(data)); + *enabled = data[1] & 0x1; + return err; +} + +static int rpi_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_ALARM_ENABLE, enabled }; + + return rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_SET_RTC_REG, + &data, sizeof(data)); +} + +static int rpi_rtc_alarm_clear_pending(struct device *dev) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_ALARM_PENDING, 1 }; + + return rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_SET_RTC_REG, + &data, sizeof(data)); +} + +static int rpi_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alarm) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_ALARM }; + s32 err = 0; + + err = rpi_rtc_alarm_irq_is_enabled(dev, &alarm->enabled); + if (!err) + err = rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_GET_RTC_REG, + &data, sizeof(data)); + rtc_time64_to_tm(data[1], &alarm->time); + + return err; +} + +static int rpi_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alarm) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_ALARM, rtc_tm_to_time64(&alarm->time) }; + int err; + + err = rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_SET_RTC_REG, + &data, sizeof(data)); + + if (err == 0) + err = rpi_rtc_alarm_irq_enable(dev, alarm->enabled); + + return err; +} + +static const struct rtc_class_ops rpi_rtc_ops = { + .read_time = rpi_rtc_read_time, + .set_time = rpi_rtc_set_time, + .read_alarm = rpi_rtc_read_alarm, + .set_alarm = rpi_rtc_set_alarm, + .alarm_irq_enable = rpi_rtc_alarm_irq_enable, +}; + +static void rpi_rtc_set_limits(struct device *dev) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_BBAT_CHG_VOLTS_MIN }; + + int err = rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_GET_RTC_REG, + &data, sizeof(data)); + if (err == 0) + vrtc->bbat_vchg_min_millivolts = data[1] / 1000U; + + data[0] = RTC_BBAT_CHG_VOLTS_MAX; + data[1] = 0; + err = rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_GET_RTC_REG, + &data, sizeof(data)); + if (err == 0) + vrtc->bbat_vchg_max_millivolts = data[1] / 1000U; +} + +static int rpi_rtc_set_charge_voltage(struct device *dev) +{ + struct rpi_rtc_data *vrtc = dev_get_drvdata(dev); + u32 data[2] = { RTC_BBAT_CHG_VOLTS, vrtc->bbat_vchg_millivolts * 1000U }; + int err; + + if (vrtc->bbat_vchg_millivolts != 0 && + (vrtc->bbat_vchg_millivolts < vrtc->bbat_vchg_min_millivolts || + vrtc->bbat_vchg_millivolts > vrtc->bbat_vchg_max_millivolts)) { + dev_warn(dev, "trickle charge voltage %umV is outside of the supported range (%umV - %umV)\n", + vrtc->bbat_vchg_millivolts, + vrtc->bbat_vchg_min_millivolts, + vrtc->bbat_vchg_max_millivolts); + return -EINVAL; + } + + err = rpi_firmware_property(vrtc->fw, RPI_FIRMWARE_SET_RTC_REG, + &data, sizeof(data)); + + if (err) + dev_err(dev, "failed to set trickle charge voltage to %umV: %d\n", + vrtc->bbat_vchg_millivolts, err); + else if (vrtc->bbat_vchg_millivolts) + dev_info(dev, "trickle charging enabled at %umV\n", + vrtc->bbat_vchg_millivolts); + + return err; +} + +static int rpi_rtc_probe(struct platform_device *pdev) +{ + struct rpi_rtc_data *vrtc; + struct device *dev = &pdev->dev; + struct rpi_firmware *firmware; + int ret; + + // Get the firmware device from the parent device + firmware = devm_rpi_firmware_get(dev, dev->parent->of_node); + + if (!firmware) + return -EPROBE_DEFER; + + vrtc = devm_kzalloc(dev, sizeof(*vrtc), GFP_KERNEL); + if (!vrtc) + return -ENOMEM; + + vrtc->fw = firmware; + + ret = devm_device_init_wakeup(dev); + if (ret) + return ret; + + platform_set_drvdata(pdev, vrtc); + + vrtc->rtc = devm_rtc_allocate_device(dev); + if (IS_ERR(vrtc->rtc)) + return PTR_ERR(vrtc->rtc); + + vrtc->rtc->range_max = U32_MAX; /* 2106-02-07 */ + + set_bit(RTC_FEATURE_ALARM_WAKEUP_ONLY, vrtc->rtc->features); + clear_bit(RTC_FEATURE_UPDATE_INTERRUPT, vrtc->rtc->features); + + vrtc->rtc->ops = &rpi_rtc_ops; + + rpi_rtc_alarm_clear_pending(dev); + + /* + * The trickle-voltage property lives on the parent firmware node + * because we deliberately do not create a DT child node just to + * instantiate this driver (see DT maintainer guidance). + * The firmware driver registers us as a platform device at runtime. + */ + vrtc->bbat_vchg_millivolts = 0; + of_property_read_u32(dev->parent->of_node, "trickle-voltage-millivolt", + &vrtc->bbat_vchg_millivolts); + + rpi_rtc_set_limits(dev); + rpi_rtc_set_charge_voltage(dev); + + return devm_rtc_register_device(vrtc->rtc); +} + +static const struct of_device_id rpi_rtc_dt_match[] = { + { .compatible = "raspberrypi,firmware-rtc" }, + { } +}; +MODULE_DEVICE_TABLE(of, rpi_rtc_dt_match); + +static struct platform_driver rpi_rtc_driver = { + .driver = { + .name = "raspberrypi-rtc", + .of_match_table = of_match_ptr(rpi_rtc_dt_match), + }, + .probe = rpi_rtc_probe +}; + +module_platform_driver(rpi_rtc_driver); + +MODULE_AUTHOR("Jonathan Bell "); +MODULE_AUTHOR("Sander Speetjens "); +MODULE_DESCRIPTION("Raspberry Pi RTC driver"); +MODULE_LICENSE("GPL"); +MODULE_ALIAS("platform:raspberrypi-rtc"); -- 2.55.0