Allesandro, Alexandre, would you be able to find some time to review
this patch?
Marek
On Tue, 19 Sep 2023 12:38:12 +0200
Marek Behún <kabel@xxxxxxxxxx> wrote:
> Add support for true board poweroff (MCU can disable all unnecessary
> voltage regulators) and wakeup at a specified time, implemented via a
> RTC driver so that the rtcwake utility can be used to configure it.
>
> Signed-off-by: Marek Behún <kabel@xxxxxxxxxx>
> ---
> .../sysfs-bus-i2c-devices-turris-omnia-mcu | 16 ++
> drivers/platform/cznic/Kconfig | 4 +
> drivers/platform/cznic/Makefile | 1 +
> .../platform/cznic/turris-omnia-mcu-base.c | 4 +
> .../platform/cznic/turris-omnia-mcu-gpio.c | 2 -
> .../cznic/turris-omnia-mcu-sys-off-wakeup.c | 245 ++++++++++++++++++
> drivers/platform/cznic/turris-omnia-mcu.h | 19 ++
> 7 files changed, 289 insertions(+), 2 deletions(-)
> create mode 100644 drivers/platform/cznic/turris-omnia-mcu-sys-off-wakeup.c
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu b/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
> index c0efdf1b3803..d668b8e999e6 100644
> --- a/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
> +++ b/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu
> @@ -14,6 +14,22 @@ Description: (RW) The front button on the Turris Omnia router can be
>
> Format: %s.
>
> +What: /sys/bus/i2c/devices/<mcu_device>/front_button_poweron
> +Date: August 2023
> +KernelVersion: 6.6
> +Contact: Marek Behún <kabel@xxxxxxxxxx>
> +Description: (RW) Newer versions of the microcontroller firmware of the
> + Turris Omnia router support powering off the router into true
> + low power mode. The router can be powered on by pressing the
> + front button.
> +
> + This file configures whether front button power on is enabled.
> +
> + This file is present only if the power off feature is supported
> + by the firmware.
> +
> + Format: %i.
> +
> What: /sys/bus/i2c/devices/<mcu_device>/fw_features
> Date: August 2023
> KernelVersion: 6.6
> diff --git a/drivers/platform/cznic/Kconfig b/drivers/platform/cznic/Kconfig
> index 3a8c3edcd7e6..0a752aa654fa 100644
> --- a/drivers/platform/cznic/Kconfig
> +++ b/drivers/platform/cznic/Kconfig
> @@ -19,10 +19,14 @@ config TURRIS_OMNIA_MCU
> depends on I2C
> select GPIOLIB
> select GPIOLIB_IRQCHIP
> + select RTC_CLASS
> help
> Say Y here to add support for the features implemented by the
> microcontroller on the CZ.NIC's Turris Omnia SOHO router.
> The features include:
> + - board poweroff into true low power mode (with voltage regulators
> + disabled) and the ability to configure wake up from this mode (via
> + rtcwake)
> - GPIO pins
> - to get front button press events (the front button can be
> configured either to generate press events to the CPU or to change
> diff --git a/drivers/platform/cznic/Makefile b/drivers/platform/cznic/Makefile
> index a6177f5b4fff..6f1470d1f673 100644
> --- a/drivers/platform/cznic/Makefile
> +++ b/drivers/platform/cznic/Makefile
> @@ -3,3 +3,4 @@
> obj-$(CONFIG_TURRIS_OMNIA_MCU) += turris-omnia-mcu.o
> turris-omnia-mcu-objs := turris-omnia-mcu-base.o
> turris-omnia-mcu-objs += turris-omnia-mcu-gpio.o
> +turris-omnia-mcu-objs += turris-omnia-mcu-sys-off-wakeup.o
> diff --git a/drivers/platform/cznic/turris-omnia-mcu-base.c b/drivers/platform/cznic/turris-omnia-mcu-base.c
> index 2954151468e5..b507f81ebe0a 100644
> --- a/drivers/platform/cznic/turris-omnia-mcu-base.c
> +++ b/drivers/platform/cznic/turris-omnia-mcu-base.c
> @@ -226,6 +226,10 @@ static int omnia_mcu_probe(struct i2c_client *client)
> if (ret)
> return ret;
>
> + ret = omnia_mcu_register_sys_off_and_wakeup(mcu);
> + if (ret)
> + return ret;
> +
> return 0;
> }
>
> diff --git a/drivers/platform/cznic/turris-omnia-mcu-gpio.c b/drivers/platform/cznic/turris-omnia-mcu-gpio.c
> index e8d5eeb4eb31..3d34a32bc7b0 100644
> --- a/drivers/platform/cznic/turris-omnia-mcu-gpio.c
> +++ b/drivers/platform/cznic/turris-omnia-mcu-gpio.c
> @@ -5,8 +5,6 @@
> * 2023 by Marek Behún <kabel@xxxxxxxxxx>
> */
>
> -#include <asm/unaligned.h>
> -
> #include "turris-omnia-mcu.h"
>
> static const char * const omnia_mcu_gpio_names[64] = {
> diff --git a/drivers/platform/cznic/turris-omnia-mcu-sys-off-wakeup.c b/drivers/platform/cznic/turris-omnia-mcu-sys-off-wakeup.c
> new file mode 100644
> index 000000000000..07ae92d819e3
> --- /dev/null
> +++ b/drivers/platform/cznic/turris-omnia-mcu-sys-off-wakeup.c
> @@ -0,0 +1,245 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * CZ.NIC's Turris Omnia MCU system off and RTC wakeup driver
> + *
> + * This is not a true RTC driver (in the sense that it does not provide a
> + * real-time clock), rather the MCU implements a wakeup from powered off state
> + * at a specified time relative to MCU boot, and we expose this feature via RTC
> + * alarm, so that it can be used via the rtcwake command, which is the standard
> + * Linux command for this.
> + *
> + * 2023 by Marek Behún <kabel@xxxxxxxxxx>
> + */
> +
> +#include <linux/crc32.h>
> +#include <linux/delay.h>
> +#include <linux/reboot.h>
> +
> +#include "turris-omnia-mcu.h"
> +
> +static int omnia_get_uptime_wakeup(const struct i2c_client *client, u32 *uptime,
> + u32 *wakeup)
> +{
> + u32 reply[2];
> + int err;
> +
> + err = omnia_cmd_read(client, CMD_GET_UPTIME_AND_WAKEUP, reply,
> + sizeof(reply));
> + if (err)
> + return err;
> +
> + if (uptime)
> + *uptime = le32_to_cpu(reply[0]);
> +
> + if (wakeup)
> + *wakeup = le32_to_cpu(reply[1]);
> +
> + return 0;
> +}
> +
> +static int omnia_read_time(struct device *dev, struct rtc_time *tm)
> +{
> + u32 uptime;
> + int err;
> +
> + err = omnia_get_uptime_wakeup(to_i2c_client(dev), &uptime, NULL);
> + if (err)
> + return err;
> +
> + rtc_time64_to_tm(uptime, tm);
> +
> + return 0;
> +}
> +
> +static int omnia_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
> +{
> + struct i2c_client *client = to_i2c_client(dev);
> + struct omnia_mcu *mcu = i2c_get_clientdata(client);
> + u32 wakeup;
> + int err;
> +
> + err = omnia_get_uptime_wakeup(client, NULL, &wakeup);
> + if (err)
> + return err;
> +
> + alrm->enabled = !!wakeup;
> + rtc_time64_to_tm(wakeup ?: mcu->rtc_alarm, &alrm->time);
> +
> + return 0;
> +}
> +
> +static int omnia_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
> +{
> + struct i2c_client *client = to_i2c_client(dev);
> + struct omnia_mcu *mcu = i2c_get_clientdata(client);
> +
> + mcu->rtc_alarm = rtc_tm_to_time64(&alrm->time);
> +
> + if (alrm->enabled)
> + return omnia_cmd_write_u32(client, CMD_SET_WAKEUP,
> + mcu->rtc_alarm);
> + else
> + return 0;
> +}
> +
> +static int omnia_alarm_irq_enable(struct device *dev, unsigned int enabled)
> +{
> + struct i2c_client *client = to_i2c_client(dev);
> + struct omnia_mcu *mcu = i2c_get_clientdata(client);
> +
> + return omnia_cmd_write_u32(client, CMD_SET_WAKEUP,
> + enabled ? mcu->rtc_alarm : 0);
> +}
> +
> +static const struct rtc_class_ops omnia_rtc_ops = {
> + .read_time = omnia_read_time,
> + .read_alarm = omnia_read_alarm,
> + .set_alarm = omnia_set_alarm,
> + .alarm_irq_enable = omnia_alarm_irq_enable,
> +};
> +
> +static int omnia_power_off(struct sys_off_data *data)
> +{
> + struct omnia_mcu *mcu = data->cb_data;
> + u8 cmd[9];
> + u32 tmp;
> + u16 arg;
> + int err;
> +
> + if (mcu->front_button_poweron)
> + arg = CMD_POWER_OFF_POWERON_BUTTON;
> + else
> + arg = 0;
> +
> + cmd[0] = CMD_POWER_OFF;
> + put_unaligned_le16(CMD_POWER_OFF_MAGIC, &cmd[1]);
> + put_unaligned_le16(arg, &cmd[3]);
> +
> + tmp = cpu_to_be32(get_unaligned_le32(&cmd[1]));
> + put_unaligned_le32(crc32_be(0xffffffff, (void *)&tmp, sizeof(tmp)),
> + &cmd[5]);
> +
> + err = omnia_cmd_write(mcu->client, cmd, sizeof(cmd));
> + if (err)
> + dev_err(&mcu->client->dev,
> + "Unable to send the poweroff command: %d\n", err);
> +
> + return NOTIFY_DONE;
> +}
> +
> +static int omnia_restart(struct sys_off_data *data)
> +{
> + struct omnia_mcu *mcu = data->cb_data;
> + u8 cmd[3];
> + int err;
> +
> + cmd[0] = CMD_GENERAL_CONTROL;
> +
> + if (reboot_mode == REBOOT_HARD)
> + cmd[1] = cmd[2] = CTL_HARD_RST;
> + else
> + cmd[1] = cmd[2] = CTL_LIGHT_RST;
> +
> + err = omnia_cmd_write(mcu->client, cmd, sizeof(cmd));
> + if (err)
> + dev_err(&mcu->client->dev,
> + "Unable to send the restart command: %d\n", err);
> +
> + /*
> + * MCU needs a little bit to process the I2C command, otherwise it will
> + * do a light reset based on SOC SYSRES_OUT pin.
> + */
> + mdelay(1);
> +
> + return NOTIFY_DONE;
> +}
> +
> +static ssize_t front_button_poweron_show(struct device *dev,
> + struct device_attribute *a, char *buf)
> +{
> + struct omnia_mcu *mcu = i2c_get_clientdata(to_i2c_client(dev));
> +
> + return sysfs_emit(buf, "%d\n", mcu->front_button_poweron);
> +}
> +
> +static ssize_t front_button_poweron_store(struct device *dev,
> + struct device_attribute *a,
> + const char *buf, size_t count)
> +{
> + struct omnia_mcu *mcu = i2c_get_clientdata(to_i2c_client(dev));
> + bool val;
> +
> + if (kstrtobool(buf, &val) < 0)
> + return -EINVAL;
> +
> + mcu->front_button_poweron = val;
> +
> + return count;
> +}
> +static DEVICE_ATTR_RW(front_button_poweron);
> +
> +static struct attribute *omnia_mcu_poweroff_attrs[] = {
> + &dev_attr_front_button_poweron.attr,
> + NULL,
> +};
> +
> +static const struct attribute_group omnia_mcu_poweroff_group = {
> + .attrs = omnia_mcu_poweroff_attrs,
> +};
> +
> +int omnia_mcu_register_sys_off_and_wakeup(struct omnia_mcu *mcu)
> +{
> + struct device *dev = &mcu->client->dev;
> + int err;
> +
> + /* MCU restart is always available */
> + err = devm_register_sys_off_handler(dev, SYS_OFF_MODE_RESTART,
> + SYS_OFF_PRIO_FIRMWARE,
> + omnia_restart, mcu);
> + if (err) {
> + dev_err(dev, "Cannot register system restart handler: %d\n",
> + err);
> + return err;
> + }
> +
> + /*
> + * poweroff and wakeup are available only if POWEROFF_WAKEUP feature is
> + * present
> + */
> + if (!(mcu->features & FEAT_POWEROFF_WAKEUP))
> + return 0;
> +
> + err = devm_register_sys_off_handler(dev, SYS_OFF_MODE_POWER_OFF,
> + SYS_OFF_PRIO_FIRMWARE,
> + omnia_power_off, mcu);
> + if (err) {
> + dev_err(dev, "Cannot register system power off handler: %d\n",
> + err);
> + return err;
> + }
> +
> + mcu->rtcdev = devm_rtc_allocate_device(dev);
> + if (IS_ERR(mcu->rtcdev)) {
> + err = PTR_ERR(mcu->rtcdev);
> + dev_err(dev, "Cannot allocate RTC device: %d\n", err);
> + return err;
> + }
> +
> + mcu->rtcdev->ops = &omnia_rtc_ops;
> + mcu->rtcdev->range_max = U32_MAX;
> +
> + err = devm_rtc_register_device(mcu->rtcdev);
> + if (err) {
> + dev_err(dev, "Cannot register RTC device: %d\n", err);
> + return err;
> + }
> +
> + mcu->front_button_poweron = true;
> +
> + err = devm_device_add_group(dev, &omnia_mcu_poweroff_group);
> + if (err)
> + dev_err(dev, "Cannot add poweroff sysfs attribute group: %d\n",
> + err);
> +
> + return err;
> +}
> diff --git a/drivers/platform/cznic/turris-omnia-mcu.h b/drivers/platform/cznic/turris-omnia-mcu.h
> index b5802240aa8d..c40ac07be5f5 100644
> --- a/drivers/platform/cznic/turris-omnia-mcu.h
> +++ b/drivers/platform/cznic/turris-omnia-mcu.h
> @@ -9,10 +9,12 @@
> #define __DRIVERS_PLATFORM_CZNIC_TURRIS_OMNIA_MCU_H
>
> #include <asm/byteorder.h>
> +#include <asm/unaligned.h>
> #include <linux/gpio/driver.h>
> #include <linux/i2c.h>
> #include <linux/log2.h>
> #include <linux/mutex.h>
> +#include <linux/rtc.h>
> #include <linux/turris-omnia-mcu-interface.h>
> #include <linux/workqueue.h>
>
> @@ -29,6 +31,11 @@ struct omnia_mcu {
> u16 last_status;
> struct delayed_work button_release_emul_work;
> bool button_pressed_emul;
> +
> + /* RTC device for configuring wake-up */
> + struct rtc_device *rtcdev;
> + u32 rtc_alarm;
> + bool front_button_poweron;
> };
>
> static inline int omnia_cmd_write(const struct i2c_client *client, void *cmd,
> @@ -39,6 +46,17 @@ static inline int omnia_cmd_write(const struct i2c_client *client, void *cmd,
> return ret < 0 ? ret : 0;
> }
>
> +static inline int omnia_cmd_write_u32(const struct i2c_client *client, u8 cmd,
> + u32 val)
> +{
> + u8 buf[5];
> +
> + buf[0] = cmd;
> + put_unaligned_le32(val, &buf[1]);
> +
> + return omnia_cmd_write(client, buf, sizeof(buf));
> +}
> +
> static inline int omnia_cmd_read(const struct i2c_client *client, u8 cmd, void *reply,
> unsigned int len)
> {
> @@ -117,5 +135,6 @@ static inline int omnia_cmd_read_u8(const struct i2c_client *client, u8 cmd)
>
> int omnia_mcu_register_gpiochip(struct omnia_mcu *mcu);
> void omnia_mcu_unregister_gpiochip(struct omnia_mcu *mcu);
> +int omnia_mcu_register_sys_off_and_wakeup(struct omnia_mcu *mcu);
>
> #endif /* __DRIVERS_PLATFORM_CZNIC_TURRIS_OMNIA_MCU_H */
