* [PATCH v6 0/7] Introduction of PSCR Framework and Related Components
@ 2025-03-14 11:35 Oleksij Rempel
2025-03-14 11:35 ` [PATCH v6 1/7] power: Extend power_on_reason.h for upcoming PSCRR framework Oleksij Rempel
` (6 more replies)
0 siblings, 7 replies; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:35 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
changes v6:
- add sysfs documentation
- rebase against latest hw_protection_reboot changes:
https://web.git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git/commit/?h=mm-nonmm-unstable&id=212dd3f6e57f6af8ed3caa23b93adc29334f9652
- push core part of the reset reason the kernel/reboot.c
changes v5:
- fix compile with NVMEM=n and potential issues with NVMEM=m
changes v4:
- fix compile with CONFIG_PSCRR=n
changes v3
- rework to remove devicetree dependencies
- extend NVMEM to search devices and cells by names.
changes v2:
- rename the framework from PSCR to PSCRR (last R is for Recorder)
- extend power on reason header and use it to show detected reason on
system start and in sysfs.
- remove "unknow" reason
- rebase on top of v6.8-rc1
- yaml fixes
- zero reason state on boot
Hello all,
This patch series introduces the Power State Change Reasons Recording
(PSCRR) framework and its related components into the kernel. The PSCR
framework is designed for systems where traditional methods of storing
power state change reasons, like PMICs or watchdogs, are inadequate. It
provides a structured way to store reasons for system shutdowns and
reboots, such as under-voltage or software-triggered events, in
non-volatile hardware storage.
These changes are critical for systems requiring detailed postmortem
analysis and where immediate power-down scenarios limit traditional
storage options. The framework also assists bootloaders and early-stage
system components in making informed recovery decisions.
Oleksij Rempel (7):
power: Extend power_on_reason.h for upcoming PSCRR framework
reboot: hw_protection_trigger: use standardized numeric
shutdown/reboot reasons instead of strings
power: reset: Introduce PSCR Recording Framework for Non-Volatile
Storage
nvmem: provide consumer access to cell size metrics
nvmem: add support for device and sysfs-based cell lookups
power: reset: add PSCR NVMEM Driver for Recording Power State Change
Reasons
Documentation: Add sysfs documentation for PSCRR reboot reason
tracking
.../ABI/testing/sysfs-kernel-reboot-pscrr | 46 ++
drivers/nvmem/core.c | 134 ++++++
drivers/platform/chrome/cros_ec_lpc.c | 2 +-
drivers/power/reset/Kconfig | 43 ++
drivers/power/reset/Makefile | 2 +
drivers/power/reset/pscrr-nvmem.c | 254 +++++++++++
drivers/power/reset/pscrr.c | 417 ++++++++++++++++++
drivers/regulator/core.c | 7 +-
drivers/regulator/irq_helpers.c | 22 +-
drivers/thermal/thermal_core.c | 3 +-
include/linux/nvmem-consumer.h | 25 ++
include/linux/power/power_on_reason.h | 4 +
include/linux/pscrr.h | 49 ++
include/linux/reboot.h | 77 +++-
kernel/reboot.c | 89 +++-
15 files changed, 1156 insertions(+), 18 deletions(-)
create mode 100644 Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
create mode 100644 drivers/power/reset/pscrr-nvmem.c
create mode 100644 drivers/power/reset/pscrr.c
create mode 100644 include/linux/pscrr.h
--
2.39.5
^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH v6 1/7] power: Extend power_on_reason.h for upcoming PSCRR framework
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
@ 2025-03-14 11:35 ` Oleksij Rempel
2025-03-14 11:35 ` [PATCH v6 2/7] reboot: hw_protection_trigger: use standardized numeric shutdown/reboot reasons instead of strings Oleksij Rempel
` (5 subsequent siblings)
6 siblings, 0 replies; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:35 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
Prepare for the introduction of the Power State Change Reason Recorder
(PSCRR) framework by expanding the power_on_reason.h header. This
extension includes new power-on reasons:
- POWER_ON_REASON_OVER_CURRENT for over-current conditions.
- POWER_ON_REASON_REGULATOR_FAILURE for regulator failures.
- POWER_ON_REASON_OVER_TEMPERATURE for over temperature situations.
- POWER_ON_REASON_EC_PANIC for EC panics
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
changes v6:
- add POWER_ON_REASON_EC_PANIC
- s/POWER_ON_REASON_OVERTEMPERATURE/POWER_ON_REASON_OVER_TEMPERATURE
---
include/linux/power/power_on_reason.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/linux/power/power_on_reason.h b/include/linux/power/power_on_reason.h
index 95a1ec0c403c..bf9501792696 100644
--- a/include/linux/power/power_on_reason.h
+++ b/include/linux/power/power_on_reason.h
@@ -15,5 +15,9 @@
#define POWER_ON_REASON_XTAL_FAIL "crystal oscillator failure"
#define POWER_ON_REASON_BROWN_OUT "brown-out reset"
#define POWER_ON_REASON_UNKNOWN "unknown reason"
+#define POWER_ON_REASON_OVER_CURRENT "over current"
+#define POWER_ON_REASON_REGULATOR_FAILURE "regulator failure"
+#define POWER_ON_REASON_OVER_TEMPERATURE "over temperature"
+#define POWER_ON_REASON_EC_PANIC "EC panic"
#endif /* POWER_ON_REASON_H */
--
2.39.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 2/7] reboot: hw_protection_trigger: use standardized numeric shutdown/reboot reasons instead of strings
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
2025-03-14 11:35 ` [PATCH v6 1/7] power: Extend power_on_reason.h for upcoming PSCRR framework Oleksij Rempel
@ 2025-03-14 11:35 ` Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage Oleksij Rempel
` (4 subsequent siblings)
6 siblings, 0 replies; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:35 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
Prepares the kernel for the Power State Change Reason (PSCR) recorder,
which will store shutdown and reboot reasons in persistent storage.
Instead of using string-based reason descriptions, which are often too
large to fit within limited storage spaces (e.g., RTC clocks with only 8
bits of battery-backed storage), we introduce `enum psc_reason`. This
enumerates predefined reasons for power state changes, making it
efficient to store and retrieve shutdown causes.
Key changes:
- Introduced `enum psc_reason`, defining structured reasons for power state
changes.
- Replaced string-based shutdown reasons with `psc_reason` identifiers.
- Implemented `get_psc_reason()` and `set_psc_reason()` for tracking the
last shutdown cause.
- Added `psc_reason_to_str()` to map enum values to human-readable strings.
- Updated `hw_protection_trigger()` to use `psc_reason` instead of string
parameters.
- Updated all consumers of `hw_protection_trigger()` to pass an appropriate
`psc_reason` value instead
of a string.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
changes v6:
- added in this version
---
drivers/platform/chrome/cros_ec_lpc.c | 2 +-
drivers/regulator/core.c | 7 ++-
drivers/regulator/irq_helpers.c | 22 ++++---
drivers/thermal/thermal_core.c | 3 +-
include/linux/reboot.h | 77 ++++++++++++++++++++++-
kernel/reboot.c | 89 +++++++++++++++++++++++++--
6 files changed, 182 insertions(+), 18 deletions(-)
diff --git a/drivers/platform/chrome/cros_ec_lpc.c b/drivers/platform/chrome/cros_ec_lpc.c
index 0b723c1e435c..235b259aeb30 100644
--- a/drivers/platform/chrome/cros_ec_lpc.c
+++ b/drivers/platform/chrome/cros_ec_lpc.c
@@ -454,7 +454,7 @@ static void cros_ec_lpc_acpi_notify(acpi_handle device, u32 value, void *data)
blocking_notifier_call_chain(&ec_dev->panic_notifier, 0, ec_dev);
kobject_uevent_env(&ec_dev->dev->kobj, KOBJ_CHANGE, (char **)env);
/* Begin orderly shutdown. EC will force reset after a short period. */
- __hw_protection_trigger("CrOS EC Panic", -1, HWPROT_ACT_SHUTDOWN);
+ __hw_protection_trigger(PSCR_EC_PANIC, -1, HWPROT_ACT_SHUTDOWN);
/* Do not query for other events after a panic is reported */
return;
}
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index 280559509dcf..de90e9ac9712 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -5243,6 +5243,7 @@ EXPORT_SYMBOL_GPL(regulator_bulk_free);
static void regulator_handle_critical(struct regulator_dev *rdev,
unsigned long event)
{
+ enum psc_reason pscr;
const char *reason = NULL;
if (!rdev->constraints->system_critical)
@@ -5251,18 +5252,22 @@ static void regulator_handle_critical(struct regulator_dev *rdev,
switch (event) {
case REGULATOR_EVENT_UNDER_VOLTAGE:
reason = "System critical regulator: voltage drop detected";
+ pscr = PSCR_UNDER_VOLTAGE;
break;
case REGULATOR_EVENT_OVER_CURRENT:
reason = "System critical regulator: over-current detected";
+ pscr = PSCR_OVER_CURRENT;
break;
case REGULATOR_EVENT_FAIL:
reason = "System critical regulator: unknown error";
+ pscr = PSCR_REGULATOR_FAILURE;
}
if (!reason)
return;
- hw_protection_trigger(reason,
+ rdev_crit(rdev, "%s\n", reason);
+ hw_protection_trigger(pscr,
rdev->constraints->uv_less_critical_window_ms);
}
diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
index 5742faee8071..31395a912341 100644
--- a/drivers/regulator/irq_helpers.c
+++ b/drivers/regulator/irq_helpers.c
@@ -63,17 +63,22 @@ static void regulator_notifier_isr_work(struct work_struct *work)
reread:
if (d->fatal_cnt && h->retry_cnt > d->fatal_cnt) {
- if (!d->die)
- return hw_protection_trigger("Regulator HW failure? - no IC recovery",
+ if (!d->die) {
+ pr_crit("Regulator HW failure? - no IC recovery\n");
+ return hw_protection_trigger(PSCR_REGULATOR_FAILURE,
REGULATOR_FORCED_SAFETY_SHUTDOWN_WAIT_MS);
+ }
+
ret = d->die(rid);
/*
* If the 'last resort' IC recovery failed we will have
* nothing else left to do...
*/
- if (ret)
- return hw_protection_trigger("Regulator HW failure. IC recovery failed",
+ if (ret) {
+ pr_crit("Regulator HW failure. IC recovery failed\n");
+ return hw_protection_trigger(PSCR_REGULATOR_FAILURE,
REGULATOR_FORCED_SAFETY_SHUTDOWN_WAIT_MS);
+ }
/*
* If h->die() was implemented we assume recovery has been
@@ -263,14 +268,17 @@ static irqreturn_t regulator_notifier_isr(int irq, void *data)
if (d->fatal_cnt && h->retry_cnt > d->fatal_cnt) {
/* If we have no recovery, just try shut down straight away */
if (!d->die) {
- hw_protection_trigger("Regulator failure. Retry count exceeded",
+ pr_crit("Regulator failure. Retry count exceeded\n");
+ hw_protection_trigger(PSCR_REGULATOR_FAILURE,
REGULATOR_FORCED_SAFETY_SHUTDOWN_WAIT_MS);
} else {
ret = d->die(rid);
/* If die() failed shut down as a last attempt to save the HW */
- if (ret)
- hw_protection_trigger("Regulator failure. Recovery failed",
+ if (ret) {
+ pr_crit("Regulator failure. Recovery failed\n");
+ hw_protection_trigger(PSCR_REGULATOR_FAILURE,
REGULATOR_FORCED_SAFETY_SHUTDOWN_WAIT_MS);
+ }
}
}
diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
index 5847729419f2..37cb58fd633e 100644
--- a/drivers/thermal/thermal_core.c
+++ b/drivers/thermal/thermal_core.c
@@ -377,11 +377,10 @@ static void thermal_zone_device_halt(struct thermal_zone_device *tz,
* Its a must for forced_emergency_poweroff_work to be scheduled.
*/
int poweroff_delay_ms = CONFIG_THERMAL_EMERGENCY_POWEROFF_DELAY_MS;
- const char *msg = "Temperature too high";
dev_emerg(&tz->device, "%s: critical temperature reached\n", tz->type);
- __hw_protection_trigger(msg, poweroff_delay_ms, action);
+ __hw_protection_trigger(PSCR_OVER_TEMPERATURE, poweroff_delay_ms, action);
}
void thermal_zone_device_critical(struct thermal_zone_device *tz)
diff --git a/include/linux/reboot.h b/include/linux/reboot.h
index aa08c3bbbf59..6477910c6a9e 100644
--- a/include/linux/reboot.h
+++ b/include/linux/reboot.h
@@ -178,6 +178,73 @@ void ctrl_alt_del(void);
extern void orderly_poweroff(bool force);
extern void orderly_reboot(void);
+
+/**
+ * enum psc_reason - Enumerates reasons for power state changes.
+ *
+ * This enum defines various reasons why a system might transition into a
+ * shutdown, reboot, or kexec state. While originally intended for hardware
+ * protection events, `psc_reason` can be extended to track other system
+ * transitions, such as controlled reboots triggered by software or
+ * maintenance operations.
+ *
+ * The values in this enumeration provide structured and standardized
+ * identifiers that replace free-form string descriptions. They are designed
+ * to be stored efficiently, making them suitable for use in environments
+ * with limited storage, such as battery-backed RTC registers, non-volatile
+ * memory, or bootloader communication mechanisms.
+ *
+ * Importantly, the order of these values **must remain stable**, as
+ * bootloaders, user-space tools, or post-mortem investigation utilities
+ * may rely on their numerical representation for consistent behavior.
+ *
+ * @PSCR_UNKNOWN: Unknown or unspecified reason for the power state change.
+ * This value serves as a default when no explicit cause is recorded.
+ *
+ * @PSCR_UNDER_VOLTAGE: Shutdown or reboot triggered due to supply voltage
+ * dropping below a safe threshold. This helps prevent instability or
+ * corruption caused by insufficient power.
+ *
+ * @PSCR_OVER_CURRENT: System shutdown or reboot due to excessive current draw,
+ * which may indicate a short circuit, an overloaded power rail, or other
+ * hardware faults requiring immediate action.
+ *
+ * @PSCR_REGULATOR_FAILURE: A critical failure in a voltage regulator, causing
+ * improper power delivery. This may be due to internal component failure,
+ * transient conditions, or external load issues requiring mitigation.
+ *
+ * @PSCR_OVER_TEMPERATURE: System shutdown or reboot due to excessive thermal
+ * conditions. This attempts to prevent hardware damage when temperature
+ * sensors detect unsafe levels, often impacting CPUs, GPUs, or power
+ * components.
+ *
+ * @PSCR_EC_PANIC: Shutdown or reboot triggered by an Embedded Controller (EC)
+ * panic. The EC is a microcontroller responsible for low-level system
+ * management, including power sequencing, thermal control, and battery
+ * management. An EC panic may indicate critical firmware issues, power
+ * management errors, or an unrecoverable hardware fault requiring
+ * immediate response.
+ *
+ * @PSCR_REASON_COUNT: Number of defined power state change reasons. This
+ * value is useful for range checking and potential future extensions
+ * while maintaining compatibility.
+ */
+enum psc_reason {
+ PSCR_UNKNOWN,
+ PSCR_UNDER_VOLTAGE,
+ PSCR_OVER_CURRENT,
+ PSCR_REGULATOR_FAILURE,
+ PSCR_OVER_TEMPERATURE,
+ PSCR_EC_PANIC,
+
+ /* Number of reasons */
+ PSCR_REASON_COUNT,
+};
+
+#define PSCR_MAX_REASON (PSCR_REASON_COUNT - 1)
+
+const char *psc_reason_to_str(enum psc_reason reason);
+
/**
* enum hw_protection_action - Hardware protection action
*
@@ -191,13 +258,13 @@ extern void orderly_reboot(void);
*/
enum hw_protection_action { HWPROT_ACT_DEFAULT, HWPROT_ACT_SHUTDOWN, HWPROT_ACT_REBOOT };
-void __hw_protection_trigger(const char *reason, int ms_until_forced,
+void __hw_protection_trigger(enum psc_reason reason, int ms_until_forced,
enum hw_protection_action action);
/**
* hw_protection_trigger - Trigger default emergency system hardware protection action
*
- * @reason: Reason of emergency shutdown or reboot to be printed.
+ * @reason: Reason of emergency shutdown or reboot.
* @ms_until_forced: Time to wait for orderly shutdown or reboot before
* triggering it. Negative value disables the forced
* shutdown or reboot.
@@ -206,11 +273,15 @@ void __hw_protection_trigger(const char *reason, int ms_until_forced,
* hardware from further damage. The exact action taken is controllable at
* runtime and defaults to shutdown.
*/
-static inline void hw_protection_trigger(const char *reason, int ms_until_forced)
+static inline void hw_protection_trigger(enum psc_reason reason,
+ int ms_until_forced)
{
__hw_protection_trigger(reason, ms_until_forced, HWPROT_ACT_DEFAULT);
}
+enum psc_reason get_psc_reason(void);
+void set_psc_reason(enum psc_reason reason);
+
/*
* Emergency restart, callable from an interrupt handler.
*/
diff --git a/kernel/reboot.c b/kernel/reboot.c
index 5299790a2832..138c5562bb6a 100644
--- a/kernel/reboot.c
+++ b/kernel/reboot.c
@@ -13,6 +13,7 @@
#include <linux/kexec.h>
#include <linux/kmod.h>
#include <linux/kmsg_dump.h>
+#include <linux/power/power_on_reason.h>
#include <linux/reboot.h>
#include <linux/suspend.h>
#include <linux/syscalls.h>
@@ -49,6 +50,7 @@ int reboot_default = 1;
int reboot_cpu;
enum reboot_type reboot_type = BOOT_ACPI;
int reboot_force;
+enum psc_reason psc_last_reason = PSCR_UNKNOWN;
struct sys_off_handler {
struct notifier_block nb;
@@ -1009,10 +1011,86 @@ static void hw_failure_emergency_schedule(enum hw_protection_action action,
msecs_to_jiffies(action_delay_ms));
}
+/**
+ * get_psc_reason - Retrieve the last recorded power state change reason.
+ *
+ * This function returns the most recent power state change reason stored
+ * in `psc_last_reason`. The value is set using `set_psc_reason()` when a
+ * shutdown, reboot, or kexec event occurs.
+ *
+ * The reason can be used for system diagnostics, post-mortem analysis, or
+ * debugging unexpected power state changes. Bootloaders or user-space tools
+ * may retrieve this value to determine why the system last transitioned to
+ * a new power state.
+ *
+ * Return: A value from `enum psc_reason`, indicating the last known power
+ * state change reason.
+ */
+enum psc_reason get_psc_reason(void)
+{
+ return READ_ONCE(psc_last_reason);
+}
+EXPORT_SYMBOL_GPL(get_psc_reason);
+
+/**
+ * set_psc_reason - Set the reason for the last power state change.
+ *
+ * @reason: A value from `enum psc_reason` indicating the cause of the power
+ * state change.
+ *
+ * This function records the reason for a shutdown, reboot, or kexec event
+ * by storing it in `psc_last_reason`. It ensures that the value remains
+ * consistent within the running system, allowing retrieval via
+ * `get_psc_reason()` for diagnostics, logging, or post-mortem analysis.
+ *
+ * Persistence Consideration:
+ * - This function **does not persist** the recorded reason across power cycles.
+ * - After a system reset or complete power loss, the recorded reason is lost.
+ * - To store power state change reasons persistently, additional tools such as
+ * the Power State Change Reason Recorder (PSCRR) framework should be used.
+ */
+void set_psc_reason(enum psc_reason reason)
+{
+ WRITE_ONCE(psc_last_reason, reason);
+}
+EXPORT_SYMBOL_GPL(set_psc_reason);
+
+/**
+ * psc_reason_to_str - Converts a power state change reason enum to a string.
+ * @reason: The `psc_reason` enum value to be converted.
+ *
+ * This function provides a human-readable string representation of the power
+ * state change reason, making it easier to interpret logs and debug messages.
+ *
+ * Return:
+ * - A string corresponding to the given `psc_reason` value.
+ * - `"Invalid"` if the value is not recognized.
+ */
+const char *psc_reason_to_str(enum psc_reason reason)
+{
+ switch (reason) {
+ case PSCR_UNKNOWN:
+ return POWER_ON_REASON_UNKNOWN;
+ case PSCR_UNDER_VOLTAGE:
+ return POWER_ON_REASON_BROWN_OUT;
+ case PSCR_OVER_CURRENT:
+ return POWER_ON_REASON_OVER_CURRENT;
+ case PSCR_REGULATOR_FAILURE:
+ return POWER_ON_REASON_REGULATOR_FAILURE;
+ case PSCR_OVER_TEMPERATURE:
+ return POWER_ON_REASON_OVER_TEMPERATURE;
+ case PSCR_EC_PANIC:
+ return POWER_ON_REASON_EC_PANIC;
+ default:
+ return "Invalid";
+ }
+}
+EXPORT_SYMBOL_GPL(psc_reason_to_str);
+
/**
* __hw_protection_trigger - Trigger an emergency system shutdown or reboot
*
- * @reason: Reason of emergency shutdown or reboot to be printed.
+ * @reason: Reason of emergency shutdown or reboot.
* @ms_until_forced: Time to wait for orderly shutdown or reboot before
* triggering it. Negative value disables the forced
* shutdown or reboot.
@@ -1024,7 +1102,7 @@ static void hw_failure_emergency_schedule(enum hw_protection_action action,
* pending even if the previous request has given a large timeout for forced
* shutdown/reboot.
*/
-void __hw_protection_trigger(const char *reason, int ms_until_forced,
+void __hw_protection_trigger(enum psc_reason reason, int ms_until_forced,
enum hw_protection_action action)
{
static atomic_t allow_proceed = ATOMIC_INIT(1);
@@ -1032,8 +1110,11 @@ void __hw_protection_trigger(const char *reason, int ms_until_forced,
if (action == HWPROT_ACT_DEFAULT)
action = hw_protection_action;
- pr_emerg("HARDWARE PROTECTION %s (%s)\n",
- hw_protection_action_str(action), reason);
+ set_psc_reason(reason);
+
+ pr_emerg("HARDWARE PROTECTION %s: %i (%s)\n",
+ hw_protection_action_str(action), reason,
+ psc_reason_to_str(reason));
/* Shutdown should be initiated only once. */
if (!atomic_dec_and_test(&allow_proceed))
--
2.39.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
2025-03-14 11:35 ` [PATCH v6 1/7] power: Extend power_on_reason.h for upcoming PSCRR framework Oleksij Rempel
2025-03-14 11:35 ` [PATCH v6 2/7] reboot: hw_protection_trigger: use standardized numeric shutdown/reboot reasons instead of strings Oleksij Rempel
@ 2025-03-14 11:36 ` Oleksij Rempel
2025-03-14 12:22 ` Matti Vaittinen
2025-03-14 11:36 ` [PATCH v6 4/7] nvmem: provide consumer access to cell size metrics Oleksij Rempel
` (3 subsequent siblings)
6 siblings, 1 reply; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:36 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
This commit introduces the Power State Change Reasons Recording (PSCRR)
framework into the kernel. The framework is vital for systems where
PMICs or watchdogs cannot provide information on power state changes. It
stores reasons for system shutdowns and reboots, like under-voltage or
software-triggered events, in non-volatile hardware storage. This
approach is essential for postmortem analysis in scenarios where
traditional storage methods (block devices, RAM) are not feasible. The
framework aids bootloaders and early-stage system components in recovery
decision-making, although it does not cover resets caused by hardware
issues like system freezes or watchdog timeouts.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
changes v6:
- move enum pscr_reason to kernel reboot core
- move reason storage to reboot core
- add locking
---
drivers/power/reset/Kconfig | 21 ++
drivers/power/reset/Makefile | 1 +
drivers/power/reset/pscrr.c | 417 +++++++++++++++++++++++++++++++++++
include/linux/pscrr.h | 49 ++++
4 files changed, 488 insertions(+)
create mode 100644 drivers/power/reset/pscrr.c
create mode 100644 include/linux/pscrr.h
diff --git a/drivers/power/reset/Kconfig b/drivers/power/reset/Kconfig
index 60bf0ca64cf3..b874a04698df 100644
--- a/drivers/power/reset/Kconfig
+++ b/drivers/power/reset/Kconfig
@@ -316,3 +316,24 @@ config POWER_MLXBF
This driver supports reset or low power mode handling for Mellanox BlueField.
endif
+
+menuconfig PSCRR
+ bool "Power State Change Reasons Recording (PSCRR) Framework"
+ help
+ Enables the Power State Change Reasons Recording (PSCRR) framework.
+
+ This framework is designed to store reasons for system shutdowns or
+ reboots, like under voltage or software-triggered events, in
+ non-volatile hardware storage. It is particularly useful for
+ postmortem analysis, where traditional storage methods (like block
+ devices or RAM) are not feasible due to immediate power-down
+ requirements or insufficient power to retain data.
+
+ This is useful for bootloaders or other early-stage system components
+ to make recovery decisions based on the last known system state. Note
+ that this framework does not track hardware-induced resets, such as
+ system freezes, watchdog timeouts, or sudden power losses without
+ controlled shutdown. It is primarily intended for controlled power
+ state transitions.
+
+ If unsure, say N.
diff --git a/drivers/power/reset/Makefile b/drivers/power/reset/Makefile
index 10782d32e1da..dbd6ae6b26a4 100644
--- a/drivers/power/reset/Makefile
+++ b/drivers/power/reset/Makefile
@@ -32,6 +32,7 @@ obj-$(CONFIG_POWER_RESET_KEYSTONE) += keystone-reset.o
obj-$(CONFIG_POWER_RESET_SYSCON) += syscon-reboot.o
obj-$(CONFIG_POWER_RESET_SYSCON_POWEROFF) += syscon-poweroff.o
obj-$(CONFIG_POWER_RESET_RMOBILE) += rmobile-reset.o
+obj-$(CONFIG_PSCRR) += pscrr.o
obj-$(CONFIG_REBOOT_MODE) += reboot-mode.o
obj-$(CONFIG_SYSCON_REBOOT_MODE) += syscon-reboot-mode.o
obj-$(CONFIG_POWER_RESET_SC27XX) += sc27xx-poweroff.o
diff --git a/drivers/power/reset/pscrr.c b/drivers/power/reset/pscrr.c
new file mode 100644
index 000000000000..818a5935d007
--- /dev/null
+++ b/drivers/power/reset/pscrr.c
@@ -0,0 +1,417 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * pscrr_core.c - Core Power State Change Reason Recording
+ *
+ * This framework provides a method for recording the cause of the last system
+ * reboot, particularly in scenarios where **hardware protection events** (e.g.,
+ * undervoltage, overcurrent, thermal shutdown) force an immediate reset. Unlike
+ * traditional logging mechanisms that rely on block storage (e.g., NAND, eMMC),
+ * PSCRR ensures shutdown reasons are preserved in a way that survives power
+ * loss for later analysis.
+ *
+ * Purpose:
+ * --------
+ * The primary goal of PSCRR is to help developers and system operators analyze
+ * real-world failures by identifying what conditions embedded devices
+ * experience in the field. By persisting power state change reasons across
+ * reboots, engineers can gain insight into why and how systems fail, enabling
+ * better debugging and long-term system improvements.
+ *
+ * At the time of developing this framework, no specific recovery strategies
+ * were designed. Instead, the focus is on reliable event recording to support
+ * future diagnostic and recovery efforts.
+ *
+ * Sysfs Interface:
+ * ----------------
+ * /sys/kernel/pscrr/reason - Read/write current power state change
+ * reason
+ * /sys/kernel/pscrr/reason_boot - Read-only last recorded reason from
+ * previous boot
+ *
+ * Why is this needed?
+ * --------------------
+ * Many embedded systems experience power-related faults where **safe shutdown
+ * of block storage (e.g., NAND, eMMC) is not possible**:
+ * - Undervoltage protection triggers a hard shutdown before data can be
+ * written.
+ * - eMMC/NAND cannot be safely updated during power failure.
+ *
+ * To ensure post-mortem analysis is possible, alternate non-volatile storage
+ * should be used, such as:
+ * - Battery-backed RTC scratchpad
+ * - EEPROM or small NVMEM regions
+ * - FRAM or other fast, low-power persistent memory
+ *
+ * How PSCRR Works:
+ * ----------------
+ * - A driver detects a problem (e.g., overtemperature) and calls:
+ * hw_protection_trigger(PSCR_OVERTEMPERATURE, ...);
+ * - Or, userspace sets the reboot or shutdown reason:
+ * echo 3 > /sys/kernel/pscrr/reason
+ * - The reboot subsystem records the reason as variable.
+ * - Before reboot, PSCRR writes the reason to hardware storage
+ * via the backend's `.write_reason()` callback.
+ * - On the next boot, the stored reason is retrieved from persistent storage
+ * and exposed via `/sys/kernel/pscrr/reason_boot` for analysis.
+ * - Userspace can dynamically set `/sys/kernel/pscrr/reason` to
+ * update the shutdown reason before a reboot.
+ */
+
+#include <linux/kernel.h>
+#include <linux/kobject.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/notifier.h>
+#include <linux/power/power_on_reason.h>
+#include <linux/pscrr.h>
+#include <linux/reboot.h>
+#include <linux/slab.h>
+#include <linux/sysfs.h>
+
+struct pscrr_data {
+ struct notifier_block reboot_nb;
+ const struct pscrr_backend_ops *ops;
+
+ enum psc_reason last_boot_reason;
+
+ /* Kobject for sysfs */
+ struct kobject *kobj;
+};
+
+static struct pscrr_data *g_pscrr;
+static DEFINE_MUTEX(pscrr_lock);
+
+/**
+ * pscrr_reboot_notifier - Stores the last power state change reason before
+ * reboot.
+ * @nb: Notifier block structure (unused in this function).
+ * @action: The type of reboot action (unused in this function).
+ * @unused: Unused parameter.
+ *
+ * This function is called when the system is about to reboot or shut down. It
+ * writes the last recorded power state change reason to persistent storage
+ * using the registered backend’s write_reason() function.
+ *
+ * If writing fails, an error message is logged, but the reboot sequence is
+ * not blocked. The function always returns `NOTIFY_OK` to ensure that the
+ * system can reboot safely even if the reason cannot be stored.
+ *
+ * Return:
+ * - `NOTIFY_OK` on success or failure, allowing reboot to proceed.
+ * - `NOTIFY_DONE` if the PSCRR subsystem is not initialized.
+ */
+static int pscrr_reboot_notifier(struct notifier_block *nb,
+ unsigned long action, void *unused)
+{
+ int ret;
+
+ mutex_lock(&pscrr_lock);
+
+ if (!g_pscrr || !g_pscrr->ops || !g_pscrr->ops->write_reason) {
+ mutex_unlock(&pscrr_lock);
+ return NOTIFY_DONE;
+ }
+
+ ret = g_pscrr->ops->write_reason(get_psc_reason());
+ if (ret) {
+ pr_err("PSCRR: Failed to store reason %d (%s) at reboot, err=%pe\n",
+ get_psc_reason(), psc_reason_to_str(get_psc_reason()),
+ ERR_PTR(ret));
+ } else {
+ pr_info("PSCRR: Stored reason %d (%s) at reboot.\n",
+ get_psc_reason(), psc_reason_to_str(get_psc_reason()));
+ }
+
+ mutex_unlock(&pscrr_lock);
+
+ /*
+ * Return NOTIFY_OK to allow reboot to proceed despite failure, in
+ * case there is any.
+ */
+ return NOTIFY_OK;
+}
+
+/*----------------------------------------------------------------------*/
+/* Sysfs Interface */
+/*----------------------------------------------------------------------*/
+
+/**
+ * reason_show - Retrieves the current power state change reason via sysfs.
+ * @kobj: Kernel object associated with this attribute (unused).
+ * @attr: The sysfs attribute being accessed (unused).
+ * @buf: Buffer to store the output string.
+ *
+ * This function is used to read the current power state change reason from
+ * the `/sys/kernel/pscrr/reason` sysfs entry.
+ *
+ * If the PSCRR subsystem is not initialized, the function returns a message
+ * indicating that no backend is registered.
+ *
+ * The returned value is formatted as an integer (`enum psc_reason`) followed
+ * by a newline (`\n`) for compatibility with standard sysfs behavior.
+ *
+ * Return:
+ * - Number of bytes written to `buf` (formatted integer string).
+ * - `"No backend registered\n"` if the PSCRR subsystem is uninitialized.
+ */
+static ssize_t reason_show(struct kobject *kobj, struct kobj_attribute *attr,
+ char *buf)
+{
+ enum psc_reason r;
+
+ mutex_lock(&pscrr_lock);
+
+ if (!g_pscrr || !g_pscrr->ops) {
+ mutex_unlock(&pscrr_lock);
+ return scnprintf(buf, PAGE_SIZE, "No backend registered\n");
+ }
+
+ /* If the backend can read from hardware, do so. Otherwise, use our cached value. */
+ if (g_pscrr->ops->read_reason) {
+ if (g_pscrr->ops->read_reason(&r) == 0) {
+ /* Also update our cached value for consistency */
+ set_psc_reason(r);
+ } else {
+ /* If read fails, fallback to cached. */
+ r = get_psc_reason();
+ }
+ } else {
+ r = get_psc_reason();
+ }
+
+ mutex_unlock(&pscrr_lock);
+
+ return scnprintf(buf, PAGE_SIZE, "%d\n", r);
+}
+
+/**
+ * reason_store - Updates the current power state change reason via sysfs.
+ * @kobj: Kernel object associated with this attribute (unused).
+ * @attr: The sysfs attribute being modified (unused).
+ * @buf: User-provided input buffer containing the reason value.
+ * @count: Number of bytes written to the attribute.
+ *
+ * This function allows users to set the power state change reason through
+ * the `/sys/kernel/pscrr/reason` sysfs entry.
+ *
+ * If the reason is out of range, a warning is logged but the write is still
+ * attempted. If the backend write fails, an error is logged, and the function
+ * returns the error code.
+ *
+ * Return:
+ * - `count` on success (indicating the number of bytes processed).
+ * - `-ENODEV` if the PSCRR subsystem is not initialized.
+ * - Any other error code returned by the backend’s `write_reason()`.
+ */
+static ssize_t reason_store(struct kobject *kobj, struct kobj_attribute *attr,
+ const char *buf, size_t count)
+{
+ long val;
+ int ret;
+
+ mutex_lock(&pscrr_lock);
+
+ if (!g_pscrr || !g_pscrr->ops || !g_pscrr->ops->write_reason) {
+ ret = -ENODEV;
+ goto err_unlock;
+ }
+
+ ret = kstrtol(buf, 10, &val);
+ if (ret)
+ goto err_unlock;
+
+ if (val > U32_MAX) {
+ ret = -ERANGE;
+ goto err_unlock;
+ }
+
+ if (val < PSCR_UNKNOWN || val > PSCR_MAX_REASON)
+ /*
+ * Log a warning, but still attempt to write the value. In
+ * case the backend can handle it, we don't want to block it.
+ */
+ pr_warn("PSCRR: writing unknown reason %ld (out of range)\n",
+ val);
+
+ ret = g_pscrr->ops->write_reason((enum psc_reason)val);
+ if (ret) {
+ pr_err("PSCRR: write_reason(%ld) failed, err=%d\n", val, ret);
+ goto err_unlock;
+ }
+
+ set_psc_reason((enum psc_reason)val);
+
+ mutex_unlock(&pscrr_lock);
+
+ return count; /* number of bytes consumed */
+
+err_unlock:
+ mutex_unlock(&pscrr_lock);
+ return ret;
+}
+
+static struct kobj_attribute reason_attr = __ATTR(reason, 0644, reason_show,
+ reason_store);
+
+/**
+ * reason_boot_show - Retrieves the last recorded power state change reason.
+ * @kobj: Kernel object associated with this attribute (unused).
+ * @attr: The sysfs attribute being accessed (unused).
+ * @buf: Buffer to store the output string.
+ *
+ * This function provides access to the `/sys/kernel/pscrr/reason_boot` sysfs
+ * entry, which contains the last recorded power state change reason from the
+ * **previous boot**. The value is retrieved from `priv->last_boot_reason`,
+ * which is initialized at module load time by reading from persistent storage.
+ *
+ * If the PSCRR NVMEM backend (`priv`) is not initialized, the function returns
+ * `-ENODEV` to indicate that the value is unavailable.
+ *
+ * The returned value is formatted as an integer (`enum psc_reason`) followed
+ * by a newline (`\n`) for sysfs compatibility.
+ *
+ * Return:
+ * - Number of bytes written to `buf` (formatted integer string).
+ * - `-ENODEV` if the PSCRR backend is not initialized.
+ */
+static ssize_t reason_boot_show(struct kobject *kobj,
+ struct kobj_attribute *attr, char *buf)
+{
+ enum psc_reason last_boot_reason;
+
+ mutex_lock(&pscrr_lock);
+
+ if (!g_pscrr) {
+ mutex_unlock(&pscrr_lock);
+ return -ENODEV;
+ }
+
+ last_boot_reason = g_pscrr->last_boot_reason;
+
+ mutex_unlock(&pscrr_lock);
+
+ return scnprintf(buf, PAGE_SIZE, "%d\n", last_boot_reason);
+}
+
+static struct kobj_attribute reason_boot_attr =
+ __ATTR(reason_boot, 0444, reason_boot_show, NULL); /* Read-only */
+
+static struct attribute *pscrr_attrs[] = {
+ &reason_attr.attr,
+ &reason_boot_attr.attr,
+ NULL,
+};
+
+static struct attribute_group pscrr_attr_group = {
+ .attrs = pscrr_attrs,
+};
+
+int pscrr_core_init(const struct pscrr_backend_ops *ops)
+{
+ enum psc_reason stored_val = PSCR_UNKNOWN;
+ int ret;
+
+ mutex_lock(&pscrr_lock);
+
+ if (g_pscrr) {
+ pr_err("PSCRR: Core is already initialized!\n");
+ ret = -EBUSY;
+ goto err_unlock;
+ }
+
+ if (!ops->read_reason || !ops->write_reason) {
+ pr_err("PSCRR: Backend must provide read and write callbacks\n");
+ ret = -EINVAL;
+ goto err_unlock;
+ }
+
+ g_pscrr = kzalloc(sizeof(*g_pscrr), GFP_KERNEL);
+ if (!g_pscrr) {
+ ret = -ENOMEM;
+ goto err_unlock;
+ }
+
+ g_pscrr->ops = ops;
+ g_pscrr->last_boot_reason = PSCR_UNKNOWN;
+
+ ret = ops->read_reason(&stored_val);
+ if (!ret) {
+ g_pscrr->last_boot_reason = stored_val;
+ pr_info("PSCRR: Initial read_reason: %d (%s)\n",
+ stored_val, psc_reason_to_str(stored_val));
+ } else {
+ pr_warn("PSCRR: read_reason failed, err=%pe\n",
+ ERR_PTR(ret));
+ }
+
+ /* Setup the reboot notifier */
+ g_pscrr->reboot_nb.notifier_call = pscrr_reboot_notifier;
+ ret = register_reboot_notifier(&g_pscrr->reboot_nb);
+ if (ret) {
+ pr_err("PSCRR: Failed to register reboot notifier, err=%pe\n",
+ ERR_PTR(ret));
+ goto err_free;
+ }
+
+ /* Create a kobject and sysfs group under /sys/kernel/pscrr */
+ g_pscrr->kobj = kobject_create_and_add("pscrr", kernel_kobj);
+ if (!g_pscrr->kobj) {
+ pr_err("PSCRR: Failed to create /sys/kernel/pscrr\n");
+ ret = -ENOMEM;
+ goto err_unreg_reboot;
+ }
+
+ ret = sysfs_create_group(g_pscrr->kobj, &pscrr_attr_group);
+ if (ret) {
+ pr_err("PSCRR: Failed to create sysfs group, err=%pe\n",
+ ERR_PTR(ret));
+ goto err_kobj_put;
+ }
+
+ mutex_unlock(&pscrr_lock);
+
+ pr_info("PSCRR: initialized successfully.\n");
+
+ return 0;
+
+err_kobj_put:
+ kobject_put(g_pscrr->kobj);
+err_unreg_reboot:
+ unregister_reboot_notifier(&g_pscrr->reboot_nb);
+err_free:
+ kfree(g_pscrr);
+ g_pscrr = NULL;
+err_unlock:
+ mutex_unlock(&pscrr_lock);
+ return ret;
+}
+EXPORT_SYMBOL_GPL(pscrr_core_init);
+
+void pscrr_core_exit(void)
+{
+ mutex_lock(&pscrr_lock);
+
+ if (!g_pscrr) {
+ mutex_unlock(&pscrr_lock);
+ return;
+ }
+
+ if (g_pscrr->kobj) {
+ sysfs_remove_group(g_pscrr->kobj, &pscrr_attr_group);
+ kobject_put(g_pscrr->kobj);
+ }
+
+ unregister_reboot_notifier(&g_pscrr->reboot_nb);
+
+ kfree(g_pscrr);
+ g_pscrr = NULL;
+
+ mutex_unlock(&pscrr_lock);
+
+ pr_info("PSCRR: exited.\n");
+}
+EXPORT_SYMBOL_GPL(pscrr_core_exit);
+
+MODULE_AUTHOR("Oleksij Rempel <o.rempel@pengutronix.de>");
+MODULE_DESCRIPTION("Power State Change Reason Recording (PSCRR) core");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/pscrr.h b/include/linux/pscrr.h
new file mode 100644
index 000000000000..f49c49144239
--- /dev/null
+++ b/include/linux/pscrr.h
@@ -0,0 +1,49 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * pscrr.h - Public header for Power State Change Reason Recording (PSCRR).
+ */
+
+#ifndef __PSCRR_H__
+#define __PSCRR_H__
+
+#include <linux/reboot.h>
+
+/**
+ * struct pscrr_backend_ops - Backend operations for storing power state change
+ * reasons.
+ *
+ * This structure defines the interface for backend implementations that handle
+ * the persistent storage of power state change reasons. Different backends
+ * (e.g., NVMEM, EEPROM, battery-backed RAM) can implement these operations to
+ * store and retrieve shutdown reasons across reboots.
+ *
+ * @write_reason: Function pointer to store the specified `psc_reason` in
+ * persistent storage. This function is called before a reboot
+ * to record the last power state change reason.
+ * @read_reason: Function pointer to retrieve the last stored `psc_reason`
+ * from persistent storage. This function is called at boot to
+ * restore the shutdown reason.
+ */
+struct pscrr_backend_ops {
+ int (*write_reason)(enum psc_reason reason);
+ int (*read_reason)(enum psc_reason *reason);
+};
+
+/**
+ * pscrr_core_init - Initialize the PSCRR core with a given backend
+ * @ops: Backend operations that the core will call
+ *
+ * Return: 0 on success, negative error code on failure.
+ * The core sets up sysfs, registers reboot notifier, etc.
+ */
+int pscrr_core_init(const struct pscrr_backend_ops *ops);
+
+/**
+ * pscrr_core_exit - De-initialize the PSCRR core
+ *
+ * Unregisters the reboot notifier, removes the sysfs entries, etc.
+ * Should be called by the backend driver at removal/shutdown.
+ */
+void pscrr_core_exit(void);
+
+#endif /* __PSCRR_H__ */
--
2.39.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 4/7] nvmem: provide consumer access to cell size metrics
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
` (2 preceding siblings ...)
2025-03-14 11:36 ` [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage Oleksij Rempel
@ 2025-03-14 11:36 ` Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 5/7] nvmem: add support for device and sysfs-based cell lookups Oleksij Rempel
` (2 subsequent siblings)
6 siblings, 0 replies; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:36 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
Add nvmem_cell_get_size() function to provide access to cell size
metrics. In some cases we may get cell size less as consumer would
expect it. So, nvmem_cell_write() would fail with incorrect buffer size.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
changes v6:
- update function comment for nvmem_cell_get_size()
---
drivers/nvmem/core.c | 29 +++++++++++++++++++++++++++++
include/linux/nvmem-consumer.h | 7 +++++++
2 files changed, 36 insertions(+)
diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c
index fff85bbf0ecd..754a9448c39d 100644
--- a/drivers/nvmem/core.c
+++ b/drivers/nvmem/core.c
@@ -1828,6 +1828,35 @@ int nvmem_cell_write(struct nvmem_cell *cell, void *buf, size_t len)
EXPORT_SYMBOL_GPL(nvmem_cell_write);
+/**
+ * nvmem_cell_get_size() - Retrieve the storage size of an NVMEM cell.
+ * @cell: Pointer to the NVMEM cell structure.
+ * @bytes: Optional pointer to store the cell size in bytes (can be NULL).
+ * @bits: Optional pointer to store the cell size in bits (can be NULL).
+ *
+ * This function allows consumers to retrieve the size of a specific NVMEM
+ * cell before performing read/write operations. It is useful for validating
+ * buffer sizes to prevent mismatched writes.
+ *
+ * Return: 0 on success or negative on failure.
+ */
+int nvmem_cell_get_size(struct nvmem_cell *cell, size_t *bytes, size_t *bits)
+{
+ struct nvmem_cell_entry *entry = cell->entry;
+
+ if (!entry->nvmem)
+ return -EINVAL;
+
+ if (bytes)
+ *bytes = entry->bytes;
+
+ if (bits)
+ *bits = entry->nbits;
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(nvmem_cell_get_size);
+
static int nvmem_cell_read_common(struct device *dev, const char *cell_id,
void *val, size_t count)
{
diff --git a/include/linux/nvmem-consumer.h b/include/linux/nvmem-consumer.h
index 34c0e58dfa26..bcb0e17e415d 100644
--- a/include/linux/nvmem-consumer.h
+++ b/include/linux/nvmem-consumer.h
@@ -56,6 +56,7 @@ void nvmem_cell_put(struct nvmem_cell *cell);
void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell);
void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len);
int nvmem_cell_write(struct nvmem_cell *cell, void *buf, size_t len);
+int nvmem_cell_get_size(struct nvmem_cell *cell, size_t *bytes, size_t *bits);
int nvmem_cell_read_u8(struct device *dev, const char *cell_id, u8 *val);
int nvmem_cell_read_u16(struct device *dev, const char *cell_id, u16 *val);
int nvmem_cell_read_u32(struct device *dev, const char *cell_id, u32 *val);
@@ -128,6 +129,12 @@ static inline int nvmem_cell_write(struct nvmem_cell *cell,
return -EOPNOTSUPP;
}
+static inline int nvmem_cell_get_size(struct nvmem_cell *cell, size_t *bytes,
+ size_t *bits)
+{
+ return -EOPNOTSUPP;
+}
+
static inline int nvmem_cell_read_u8(struct device *dev,
const char *cell_id, u8 *val)
{
--
2.39.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 5/7] nvmem: add support for device and sysfs-based cell lookups
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
` (3 preceding siblings ...)
2025-03-14 11:36 ` [PATCH v6 4/7] nvmem: provide consumer access to cell size metrics Oleksij Rempel
@ 2025-03-14 11:36 ` Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 6/7] power: reset: add PSCR NVMEM Driver for Recording Power State Change Reasons Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking Oleksij Rempel
6 siblings, 0 replies; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:36 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
Introduce new API functions to allow looking up NVMEM devices and cells
by name, enhancing flexibility in cases where devicetree-based lookup
is not available.
Key changes:
- Added `nvmem_device_get_by_name()`: Enables retrieving an NVMEM device by
its name for systems where direct device reference is needed.
- Added `nvmem_cell_get_by_sysfs_name()`: Allows retrieving an NVMEM cell
based on its sysfs-style name (e.g., "cell@offset,bits"), making it
possible to identify cells dynamically.
- Introduced `nvmem_find_cell_entry_by_sysfs_name()`: A helper function
that constructs sysfs-like names and searches for matching cell entries.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
changes v5:
- fix build we NVMEM=n
---
drivers/nvmem/core.c | 105 +++++++++++++++++++++++++++++++++
include/linux/nvmem-consumer.h | 18 ++++++
2 files changed, 123 insertions(+)
diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c
index 754a9448c39d..676b2308f62f 100644
--- a/drivers/nvmem/core.c
+++ b/drivers/nvmem/core.c
@@ -1203,6 +1203,23 @@ struct nvmem_device *of_nvmem_device_get(struct device_node *np, const char *id)
EXPORT_SYMBOL_GPL(of_nvmem_device_get);
#endif
+/**
+ * nvmem_device_get_by_name - Look up an NVMEM device by its device name
+ * @name: String matching device name in the provider
+ *
+ * Return: A valid pointer to struct nvmem_device on success,
+ * or ERR_PTR(...) on failure. The caller must later call nvmem_device_put() to
+ * release the reference.
+ */
+struct nvmem_device *nvmem_device_get_by_name(const char *name)
+{
+ if (!name)
+ return ERR_PTR(-EINVAL);
+
+ return __nvmem_device_get((void *)name, device_match_name);
+}
+EXPORT_SYMBOL_GPL(nvmem_device_get_by_name);
+
/**
* nvmem_device_get() - Get nvmem device from a given id
*
@@ -1516,6 +1533,94 @@ struct nvmem_cell *of_nvmem_cell_get(struct device_node *np, const char *id)
EXPORT_SYMBOL_GPL(of_nvmem_cell_get);
#endif
+/**
+ * nvmem_find_cell_entry_by_sysfs_name - Find an NVMEM cell entry by its sysfs
+ * name.
+ * @nvmem: The nvmem_device pointer where the cell is located.
+ * @sysfs_name: The full sysfs cell name, e.g. "mycell@0x100,8".
+ *
+ * This function constructs the sysfs-like name for each cell and compares it
+ * to @sysfs_name. If a match is found, the matching nvmem_cell_entry pointer
+ * is returned. This is analogous to nvmem_find_cell_entry_by_name(), except
+ * it matches on the sysfs naming convention used in the device's attributes.
+ *
+ * Return: Pointer to the matching nvmem_cell_entry on success, or NULL if no
+ * match is found.
+ */
+static struct nvmem_cell_entry *
+nvmem_find_cell_entry_by_sysfs_name(struct nvmem_device *nvmem,
+ const char *sysfs_name)
+{
+ struct nvmem_cell_entry *entry;
+ char tmp[NVMEM_CELL_NAME_MAX];
+
+ mutex_lock(&nvmem_mutex);
+ list_for_each_entry(entry, &nvmem->cells, node) {
+ int len = snprintf(tmp, NVMEM_CELL_NAME_MAX, "%s@%x,%u",
+ entry->name, entry->offset,
+ entry->bit_offset);
+
+ if (len >= NVMEM_CELL_NAME_MAX) {
+ pr_warn("nvmem: cell name too long (max %zu bytes): %s\n",
+ NVMEM_CELL_NAME_MAX, sysfs_name);
+ continue;
+ }
+
+ if (len < 0) {
+ pr_warn("nvmem: error formatting cell name\n");
+ continue;
+ }
+
+ if (!strcmp(tmp, sysfs_name)) {
+ mutex_unlock(&nvmem_mutex);
+ return entry;
+ }
+ }
+
+ mutex_unlock(&nvmem_mutex);
+ return NULL;
+}
+
+/**
+ * nvmem_cell_get_by_sysfs_name - Retrieve an NVMEM cell using a sysfs-style
+ * name.
+ * @nvmem: Pointer to the `struct nvmem_device` containing the cell.
+ * @sysfs_name: The sysfs-style cell name, formatted as
+ * "<cell_name>@<offset>,<bits>".
+ *
+ * This function enables dynamic lookup of NVMEM cells via sysfs-style
+ * identifiers. It is useful when devicetree-based lookup is unavailable or when
+ * cells are managed dynamically.
+ *
+ * Example Usage:
+ * nvmem_cell_get_by_sysfs_name(nvmem, "mycell@0x100,8");
+ *
+ * Return: Pointer to `struct nvmem_cell` on success. On error, an ERR_PTR() is
+ * returned with the appropriate error code.
+ */
+struct nvmem_cell *nvmem_cell_get_by_sysfs_name(struct nvmem_device *nvmem,
+ const char *sysfs_name)
+{
+ struct nvmem_cell_entry *entry;
+ struct nvmem_cell *cell;
+
+ entry = nvmem_find_cell_entry_by_sysfs_name(nvmem, sysfs_name);
+ if (!entry)
+ return ERR_PTR(-ENOENT);
+
+ if (!try_module_get(nvmem->owner))
+ return ERR_PTR(-EINVAL);
+
+ kref_get(&nvmem->refcnt);
+
+ cell = nvmem_create_cell(entry, entry->name, 0);
+ if (IS_ERR(cell))
+ __nvmem_device_put(nvmem);
+
+ return cell;
+}
+EXPORT_SYMBOL_GPL(nvmem_cell_get_by_sysfs_name);
+
/**
* nvmem_cell_get() - Get nvmem cell of device form a given cell name
*
diff --git a/include/linux/nvmem-consumer.h b/include/linux/nvmem-consumer.h
index bcb0e17e415d..2b5e06f457b0 100644
--- a/include/linux/nvmem-consumer.h
+++ b/include/linux/nvmem-consumer.h
@@ -20,6 +20,10 @@ struct nvmem_cell;
struct nvmem_device;
struct nvmem_cell_info;
+#define NVMEM_CELL_NAME_MAX \
+ (sizeof("very_long_cell_name_with_some_extra_chars_12345678@0x12345678,128"))
+
+
/**
* struct nvmem_cell_lookup - cell lookup entry
*
@@ -52,6 +56,8 @@ enum {
/* Cell based interface */
struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *id);
struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *id);
+struct nvmem_cell *nvmem_cell_get_by_sysfs_name(struct nvmem_device *nvmem,
+ const char *cell_name);
void nvmem_cell_put(struct nvmem_cell *cell);
void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell);
void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len);
@@ -70,6 +76,7 @@ int nvmem_cell_read_variable_le_u64(struct device *dev, const char *cell_id,
struct nvmem_device *nvmem_device_get(struct device *dev, const char *name);
struct nvmem_device *devm_nvmem_device_get(struct device *dev,
const char *name);
+struct nvmem_device *nvmem_device_get_by_name(const char *name);
void nvmem_device_put(struct nvmem_device *nvmem);
void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem);
int nvmem_device_read(struct nvmem_device *nvmem, unsigned int offset,
@@ -109,6 +116,12 @@ static inline struct nvmem_cell *devm_nvmem_cell_get(struct device *dev,
return ERR_PTR(-EOPNOTSUPP);
}
+static inline struct nvmem_cell *
+nvmem_cell_get_by_sysfs_name(struct nvmem_device *nvmem, const char *cell_name)
+{
+ return ERR_PTR(-EOPNOTSUPP);
+}
+
static inline void devm_nvmem_cell_put(struct device *dev,
struct nvmem_cell *cell)
{
@@ -185,6 +198,11 @@ static inline struct nvmem_device *devm_nvmem_device_get(struct device *dev,
return ERR_PTR(-EOPNOTSUPP);
}
+static inline struct nvmem_device *nvmem_device_get_by_name(const char *name)
+{
+ return ERR_PTR(-EOPNOTSUPP);
+}
+
static inline void nvmem_device_put(struct nvmem_device *nvmem)
{
}
--
2.39.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 6/7] power: reset: add PSCR NVMEM Driver for Recording Power State Change Reasons
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
` (4 preceding siblings ...)
2025-03-14 11:36 ` [PATCH v6 5/7] nvmem: add support for device and sysfs-based cell lookups Oleksij Rempel
@ 2025-03-14 11:36 ` Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking Oleksij Rempel
6 siblings, 0 replies; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:36 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
This driver utilizes the Power State Change Reasons Recording (PSCRR)
framework to store specific power state change information, such as
shutdown or reboot reasons, into a designated non-volatile memory
(NVMEM) cell.
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
changes v6:
- rename pscr_reason to psc_reason
changes v5:
- avoid a build against NVMEM=m
changes v4:
- remove devicetree dependencies
---
drivers/power/reset/Kconfig | 22 +++
drivers/power/reset/Makefile | 1 +
drivers/power/reset/pscrr-nvmem.c | 254 ++++++++++++++++++++++++++++++
3 files changed, 277 insertions(+)
create mode 100644 drivers/power/reset/pscrr-nvmem.c
diff --git a/drivers/power/reset/Kconfig b/drivers/power/reset/Kconfig
index b874a04698df..e2267a6345d0 100644
--- a/drivers/power/reset/Kconfig
+++ b/drivers/power/reset/Kconfig
@@ -337,3 +337,25 @@ menuconfig PSCRR
state transitions.
If unsure, say N.
+
+if PSCRR
+
+config PSCRR_NVMEM
+ tristate "Generic NVMEM-based Power State Change Reason Recorder"
+ depends on NVMEM || !NVMEM
+ help
+ This option enables support for storing power state change reasons
+ (such as shutdown, reboot, or power failure events) into a designated
+ NVMEM (Non-Volatile Memory) cell.
+
+ This feature allows embedded systems to retain power transition
+ history even after a full system restart or power loss. It is useful
+ for post-mortem debugging, automated recovery strategies, and
+ improving system reliability.
+
+ The NVMEM cell used for storing these reasons can be dynamically
+ configured via module parameters.
+
+ If unsure, say N.
+
+endif
diff --git a/drivers/power/reset/Makefile b/drivers/power/reset/Makefile
index dbd6ae6b26a4..532698552d40 100644
--- a/drivers/power/reset/Makefile
+++ b/drivers/power/reset/Makefile
@@ -33,6 +33,7 @@ obj-$(CONFIG_POWER_RESET_SYSCON) += syscon-reboot.o
obj-$(CONFIG_POWER_RESET_SYSCON_POWEROFF) += syscon-poweroff.o
obj-$(CONFIG_POWER_RESET_RMOBILE) += rmobile-reset.o
obj-$(CONFIG_PSCRR) += pscrr.o
+obj-$(CONFIG_PSCRR_NVMEM) += pscrr-nvmem.o
obj-$(CONFIG_REBOOT_MODE) += reboot-mode.o
obj-$(CONFIG_SYSCON_REBOOT_MODE) += syscon-reboot-mode.o
obj-$(CONFIG_POWER_RESET_SC27XX) += sc27xx-poweroff.o
diff --git a/drivers/power/reset/pscrr-nvmem.c b/drivers/power/reset/pscrr-nvmem.c
new file mode 100644
index 000000000000..7d02d989893f
--- /dev/null
+++ b/drivers/power/reset/pscrr-nvmem.c
@@ -0,0 +1,254 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * pscrr_nvmem.c - PSCRR backend for storing shutdown reasons in small NVMEM
+ * cells
+ *
+ * This backend provides a way to persist power state change reasons in a
+ * non-volatile memory (NVMEM) cell, ensuring that reboot causes can be
+ * analyzed post-mortem. Unlike traditional logging to eMMC or NAND, which
+ * may be unreliable during power failures, this approach allows storing
+ * reboot reasons in small, fast-access storage like RTC scratchpads, EEPROM,
+ * or FRAM.
+ *
+ * The module allows dynamic configuration of the NVMEM device and cell
+ * via module parameters:
+ *
+ * Example usage:
+ * modprobe pscrr-nvmem nvmem_name=pcf85063_nvram0 cell_name=pscr@0,0
+ */
+
+#include <linux/err.h>
+#include <linux/init.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/nvmem-consumer.h>
+#include <linux/pscrr.h>
+#include <linux/slab.h>
+
+/*
+ * Module parameters:
+ * nvmem_name: Name of the NVMEM device (e.g. "pcf85063_nvram0").
+ * cell_name : Sysfs name of the cell on that device (e.g. "pscr@0,0").
+ */
+static char *nvmem_name;
+module_param(nvmem_name, charp, 0444);
+MODULE_PARM_DESC(nvmem_name, "Name of the NVMEM device (e.g. pcf85063_nvram0)");
+
+static char *cell_name;
+module_param(cell_name, charp, 0444);
+MODULE_PARM_DESC(cell_name, "Sysfs name of the NVMEM cell (e.g. pscr@0,0)");
+
+struct pscrr_nvmem_priv {
+ struct nvmem_device *nvmem;
+ struct nvmem_cell *cell;
+
+ size_t total_bits;
+ size_t max_val;
+};
+
+static struct pscrr_nvmem_priv *priv;
+
+static int pscrr_nvmem_write_reason(enum psc_reason reason)
+{
+ size_t required_bytes;
+ u32 val;
+ int ret;
+
+ if (!priv || !priv->cell)
+ return -ENODEV;
+
+ /* Ensure reason fits in the available storage */
+ if (reason > priv->max_val) {
+ pr_err("PSCRR-nvmem: Reason %d exceeds max storable value %zu for %zu-bit cell\n",
+ reason, priv->max_val, priv->total_bits);
+ return -ERANGE;
+ }
+
+ val = reason;
+
+ /* Determine required bytes for storing total_bits */
+ required_bytes = (priv->total_bits + 7) / 8;
+
+ /* Write the reason to the NVMEM cell */
+ ret = nvmem_cell_write(priv->cell, &val, required_bytes);
+ if (ret < 0) {
+ pr_err("PSCRR-nvmem: Failed to write reason %d, err=%d (%pe)\n",
+ reason, ret, ERR_PTR(ret));
+ return ret;
+ }
+
+ pr_debug("PSCRR-nvmem: Successfully wrote reason %d\n", reason);
+
+ return 0;
+}
+
+static int pscrr_nvmem_read_reason(enum psc_reason *reason)
+{
+ size_t required_bytes, len;
+ unsigned int val;
+ int ret = 0;
+ void *buf;
+
+ if (!priv || !priv->cell)
+ return -ENODEV;
+
+ buf = nvmem_cell_read(priv->cell, &len);
+ if (IS_ERR(buf)) {
+ ret = PTR_ERR(buf);
+ pr_err("PSCRR-nvmem: Failed to read cell, err=%d (%pe)\n", ret,
+ ERR_PTR(ret));
+ return ret;
+ }
+
+ /* Calculate the required number of bytes */
+ required_bytes = (priv->total_bits + 7) / 8;
+
+ /* Validate that the returned length is large enough */
+ if (len < required_bytes) {
+ pr_err("PSCRR-nvmem: Read length %zu is too small (need at least %zu bytes)\n",
+ len, required_bytes);
+ kfree(buf);
+ return -EIO;
+ }
+
+ /* Extract value safely with proper memory alignment handling */
+ val = 0;
+ memcpy(&val, buf, required_bytes);
+
+ /* Mask only the necessary bits to avoid garbage data */
+ val &= (1U << priv->total_bits) - 1;
+
+ kfree(buf);
+
+ *reason = (enum psc_reason)val;
+
+ pr_debug("PSCRR-nvmem: Read reason => %d (from %zu bytes, %zu bits used)\n",
+ *reason, len, priv->total_bits);
+
+ return 0;
+}
+
+static const struct pscrr_backend_ops pscrr_nvmem_ops = {
+ .write_reason = pscrr_nvmem_write_reason,
+ .read_reason = pscrr_nvmem_read_reason,
+};
+
+static int __init pscrr_nvmem_init(void)
+{
+ size_t bytes, bits;
+ int ret;
+
+ if (!nvmem_name || !cell_name) {
+ pr_err("PSCRR-nvmem: Must specify both nvmem_name and cell_name.\n");
+ return -EINVAL;
+ }
+
+ priv = kzalloc(sizeof(*priv), GFP_KERNEL);
+ if (!priv)
+ return -ENOMEM;
+
+ priv->nvmem = nvmem_device_get_by_name(nvmem_name);
+ if (IS_ERR(priv->nvmem)) {
+ ret = PTR_ERR(priv->nvmem);
+ pr_err("PSCRR-nvmem: nvmem_device_get_by_name(%s) failed: %d\n",
+ nvmem_name, ret);
+ priv->nvmem = NULL;
+ goto err_free;
+ }
+
+ priv->cell = nvmem_cell_get_by_sysfs_name(priv->nvmem, cell_name);
+ if (IS_ERR(priv->cell)) {
+ ret = PTR_ERR(priv->cell);
+ pr_err("PSCRR-nvmem: nvmem_cell_get_by_sysfs_name(%s) failed, err=%pe\n",
+ cell_name, ERR_PTR(ret));
+ priv->cell = NULL;
+ goto err_dev_put;
+ }
+
+ ret = nvmem_cell_get_size(priv->cell, &bytes, &bits);
+ if (ret < 0) {
+ pr_err("PSCRR-nvmem: Failed to get cell size, err=%pe\n",
+ ERR_PTR(ret));
+ goto err_cell_put;
+ }
+
+ if (bits)
+ priv->total_bits = bits;
+ else
+ priv->total_bits = bytes * 8;
+
+ if (priv->total_bits > 31) {
+ pr_err("PSCRR-nvmem: total_bits=%zu is too large (max 31 allowed)\n",
+ priv->total_bits);
+ return -EOVERFLOW;
+ }
+
+ priv->max_val = (1 << priv->total_bits) - 1;
+ pr_debug("PSCRR-nvmem: Cell size: %zu bytes + %zu bits => total_bits=%zu\n",
+ bytes, bits, priv->total_bits);
+
+ /*
+ * If we store reasons 0..PSCR_MAX_REASON, the largest needed is
+ * 'PSCR_MAX_REASON'. That must fit within total_bits.
+ * So the max storable integer is (1 << total_bits) - 1.
+ */
+ if (priv->max_val < PSCR_MAX_REASON) {
+ pr_err("PSCRR-nvmem: Not enough bits (%zu) to store up to reason=%d\n",
+ priv->total_bits, PSCR_MAX_REASON);
+ ret = -ENOSPC;
+ goto err_cell_put;
+ }
+
+ /* 4. Register with pscrr_core. */
+ ret = pscrr_core_init(&pscrr_nvmem_ops);
+ if (ret) {
+ pr_err("PSCRR-nvmem: pscrr_core_init() failed: %d\n", ret);
+ goto err_cell_put;
+ }
+
+ pr_info("PSCRR-nvmem: Loaded (nvmem=%s, cell=%s), can store 0..%zu\n",
+ nvmem_name, cell_name, priv->max_val);
+ return 0;
+
+err_cell_put:
+ if (priv->cell) {
+ nvmem_cell_put(priv->cell);
+ priv->cell = NULL;
+ }
+err_dev_put:
+ if (priv->nvmem) {
+ nvmem_device_put(priv->nvmem);
+ priv->nvmem = NULL;
+ }
+err_free:
+ kfree(priv);
+ priv = NULL;
+ return ret;
+}
+
+static void __exit pscrr_nvmem_exit(void)
+{
+ pscrr_core_exit();
+
+ if (priv) {
+ if (priv->cell) {
+ nvmem_cell_put(priv->cell);
+ priv->cell = NULL;
+ }
+ if (priv->nvmem) {
+ nvmem_device_put(priv->nvmem);
+ priv->nvmem = NULL;
+ }
+ kfree(priv);
+ priv = NULL;
+ }
+
+ pr_info("pscrr-nvmem: Unloaded\n");
+}
+
+module_init(pscrr_nvmem_init);
+module_exit(pscrr_nvmem_exit);
+
+MODULE_AUTHOR("Oleksij Rempel <o.rempel@pengutronix.de>");
+MODULE_DESCRIPTION("PSCRR backend for storing reason code in NVMEM");
+MODULE_LICENSE("GPL");
--
2.39.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
` (5 preceding siblings ...)
2025-03-14 11:36 ` [PATCH v6 6/7] power: reset: add PSCR NVMEM Driver for Recording Power State Change Reasons Oleksij Rempel
@ 2025-03-14 11:36 ` Oleksij Rempel
2025-03-14 13:38 ` Matti Vaittinen
6 siblings, 1 reply; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 11:36 UTC (permalink / raw)
To: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano
Cc: Oleksij Rempel, kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Matti Vaittinen, Ahmad Fatoum,
Andrew Morton, chrome-platform
Add documentation for the Power State Change Reason Recorder (PSCRR)
sysfs interface, which allows tracking of system shutdown and reboot
reasons. The documentation provides details on available sysfs entries
under `/sys/kernel/pscrr/`, explaining their functionality, example usage,
and how they interact with different backend storage options (e.g., NVMEM).
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
.../ABI/testing/sysfs-kernel-reboot-pscrr | 46 +++++++++++++++++++
1 file changed, 46 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
diff --git a/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
new file mode 100644
index 000000000000..7cc643f89675
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
@@ -0,0 +1,46 @@
+What: /sys/kernel/pscrr/reason
+Date: April 2025
+KernelVersion: 6.15
+Contact: Oleksij Rempel <o.rempel@pengutronix.de>
+Description:
+ This file provides access to the last recorded power state
+ change reason. The storage backend is configurable and, if
+ supported, the reason may be stored persistently in an
+ NVMEM cell or another backend.
+
+ Reading this file returns an integer representing the last
+ recorded shutdown or reboot cause.
+
+ Writing an integer value to this file sets the reason to be
+ stored and recorded for system analysis.
+
+ Example usage (values are for illustration and may not reflect
+ actual reasons used in a given system):
+ Read:
+ $ cat /sys/kernel/pscrr/reason
+ 3 # (Example: Power loss event, may differ per system)
+
+ Write:
+ $ echo 5 > /sys/kernel/pscrr/reason
+ # Sets the reason to 5 (Example: User-triggered reboot,
+ # this may not be a real value in your system)
+
+ Values are defined in:
+ - `include/linux/reboot.h` (enum psc_reason)
+
+What: /sys/kernel/pscrr/reason_boot
+Date: April 2025
+KernelVersion: 6.15
+Contact: Oleksij Rempel <o.rempel@pengutronix.de>
+Description:
+ This file provides the last recorded power state change reason
+ from before the current system boot. If a supported backend
+ (e.g., NVMEM) is configured, this value is retained across
+ reboots.
+
+ Example usage (values are for illustration and may not reflect
+ actual reasons used in a given system):
+ Read:
+ $ cat /sys/kernel/pscrr/reason_boot
+ 2 # (Example: Over-temperature shutdown, may differ per system)
+
--
2.39.5
^ permalink raw reply related [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage
2025-03-14 11:36 ` [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage Oleksij Rempel
@ 2025-03-14 12:22 ` Matti Vaittinen
2025-03-14 13:58 ` Oleksij Rempel
0 siblings, 1 reply; 15+ messages in thread
From: Matti Vaittinen @ 2025-03-14 12:22 UTC (permalink / raw)
To: Oleksij Rempel, Sebastian Reichel, Srinivas Kandagatla,
Benson Leung, Tzung-Bi Shih, Daniel Lezcano
Cc: kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Ahmad Fatoum, Andrew Morton,
chrome-platform
Hi deee Ho Oleksij,
On 14/03/2025 13:36, Oleksij Rempel wrote:
> This commit introduces the Power State Change Reasons Recording (PSCRR)
> framework into the kernel. The framework is vital for systems where
> PMICs or watchdogs cannot provide information on power state changes. It
> stores reasons for system shutdowns and reboots, like under-voltage or
> software-triggered events, in non-volatile hardware storage. This
> approach is essential for postmortem analysis in scenarios where
> traditional storage methods (block devices, RAM) are not feasible. The
> framework aids bootloaders and early-stage system components in recovery
> decision-making, although it does not cover resets caused by hardware
> issues like system freezes or watchdog timeouts.
>
> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
I see you're already at v6, so I am probably slightly late... I think I
hadn't noticed this before. Thus, feel free to treat my comments as mere
suggestions.
All in all, I do like this series. Looks mostly very good to me :) Just
wondering if we could utilize this same for standardizing reading the
reset reason registers which are included in many PMICs?
> ---
...
> +int pscrr_core_init(const struct pscrr_backend_ops *ops)
> +{
> + enum psc_reason stored_val = PSCR_UNKNOWN;
> + int ret;
> +
> + mutex_lock(&pscrr_lock);
> +
> + if (g_pscrr) {
> + pr_err("PSCRR: Core is already initialized!\n");
> + ret = -EBUSY;
> + goto err_unlock;
> + }
> +
> + if (!ops->read_reason || !ops->write_reason) {
> + pr_err("PSCRR: Backend must provide read and write callbacks\n");
Why both are required?
I can easily envision integrating the some PMIC's 'boot reason' register
reading to the PSCRR. Benefit would be that user-space could use this
same interface when reading the reset reason on a system where reason is
stored using mechanisms provided by this series - and when reset reason
is automatically stored by the HW (for example to a PMIC).
In a PMIC case the write_reason might not be needed, right?
> + ret = -EINVAL;
> + goto err_unlock;
> + }
> +
> + g_pscrr = kzalloc(sizeof(*g_pscrr), GFP_KERNEL);
> + if (!g_pscrr) {
> + ret = -ENOMEM;
> + goto err_unlock;
> + }
> +
> + g_pscrr->ops = ops;
> + g_pscrr->last_boot_reason = PSCR_UNKNOWN;
> +
> + ret = ops->read_reason(&stored_val);
> + if (!ret) {
> + g_pscrr->last_boot_reason = stored_val;
> + pr_info("PSCRR: Initial read_reason: %d (%s)\n",
> + stored_val, psc_reason_to_str(stored_val));
> + } else {
> + pr_warn("PSCRR: read_reason failed, err=%pe\n",
> + ERR_PTR(ret));
> + }
...
> +/**
> + * struct pscrr_backend_ops - Backend operations for storing power state change
> + * reasons.
> + *
> + * This structure defines the interface for backend implementations that handle
> + * the persistent storage of power state change reasons. Different backends
> + * (e.g., NVMEM, EEPROM, battery-backed RAM) can implement these operations to
> + * store and retrieve shutdown reasons across reboots.
Maybe we should support / mention also a case where the PMIC driver
could just register the read-callback and provide the reset reason
stored by the PMIC to users. In this case the write_reason might not be
needed.
> + *
> + * @write_reason: Function pointer to store the specified `psc_reason` in
> + * persistent storage. This function is called before a reboot
> + * to record the last power state change reason.
> + * @read_reason: Function pointer to retrieve the last stored `psc_reason`
> + * from persistent storage. This function is called at boot to
> + * restore the shutdown reason.
> + */
> +struct pscrr_backend_ops {
> + int (*write_reason)(enum psc_reason reason);
> + int (*read_reason)(enum psc_reason *reason);
> +};
Yours,
-- Matti
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking
2025-03-14 11:36 ` [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking Oleksij Rempel
@ 2025-03-14 13:38 ` Matti Vaittinen
2025-03-14 14:10 ` Oleksij Rempel
0 siblings, 1 reply; 15+ messages in thread
From: Matti Vaittinen @ 2025-03-14 13:38 UTC (permalink / raw)
To: Oleksij Rempel, Sebastian Reichel, Srinivas Kandagatla,
Benson Leung, Tzung-Bi Shih, Daniel Lezcano
Cc: kernel, linux-kernel, Liam Girdwood, Mark Brown,
Rafael J. Wysocki, Zhang Rui, Lukasz Luba, linux-pm,
Søren Andersen, Guenter Roeck, Ahmad Fatoum, Andrew Morton,
chrome-platform
On 14/03/2025 13:36, Oleksij Rempel wrote:
> Add documentation for the Power State Change Reason Recorder (PSCRR)
> sysfs interface, which allows tracking of system shutdown and reboot
> reasons. The documentation provides details on available sysfs entries
> under `/sys/kernel/pscrr/`, explaining their functionality, example usage,
> and how they interact with different backend storage options (e.g., NVMEM).
>
> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> ---
> .../ABI/testing/sysfs-kernel-reboot-pscrr | 46 +++++++++++++++++++
> 1 file changed, 46 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
>
> diff --git a/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> new file mode 100644
> index 000000000000..7cc643f89675
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> @@ -0,0 +1,46 @@
> +What: /sys/kernel/pscrr/reason
> +Date: April 2025
> +KernelVersion: 6.15
> +Contact: Oleksij Rempel <o.rempel@pengutronix.de>
> +Description:
> + This file provides access to the last recorded power state
> + change reason. The storage backend is configurable and, if
> + supported, the reason may be stored persistently in an
> + NVMEM cell or another backend.
> +
> + Reading this file returns an integer representing the last
> + recorded shutdown or reboot cause.
> +
> + Writing an integer value to this file sets the reason to be
> + stored and recorded for system analysis.
> +
> + Example usage (values are for illustration and may not reflect
> + actual reasons used in a given system):
> + Read:
> + $ cat /sys/kernel/pscrr/reason
> + 3 # (Example: Power loss event, may differ per system)
> +
> + Write:
> + $ echo 5 > /sys/kernel/pscrr/reason
> + # Sets the reason to 5 (Example: User-triggered reboot,
> + # this may not be a real value in your system)
> +
> + Values are defined in:
> + - `include/linux/reboot.h` (enum psc_reason)
Is it possible to provide the reason (also) as string?
I believe we should fix the meaning of the numbers so the ABI is not
changing for the users. Hence we could as well document the meaning of
the values(?) If I read the suggestion right, we will in any case have
predefined set of reasons in the kernel side.
Or, am I missing something?
> +
> +What: /sys/kernel/pscrr/reason_boot
> +Date: April 2025
> +KernelVersion: 6.15
> +Contact: Oleksij Rempel <o.rempel@pengutronix.de>
> +Description:
> + This file provides the last recorded power state change reason
> + from before the current system boot. If a supported backend
> + (e.g., NVMEM) is configured, this value is retained across
> + reboots.
> +
> + Example usage (values are for illustration and may not reflect
> + actual reasons used in a given system):
> + Read:
> + $ cat /sys/kernel/pscrr/reason_boot
> + 2 # (Example: Over-temperature shutdown, may differ per system)
> +
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage
2025-03-14 12:22 ` Matti Vaittinen
@ 2025-03-14 13:58 ` Oleksij Rempel
2025-03-17 7:55 ` Matti Vaittinen
0 siblings, 1 reply; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 13:58 UTC (permalink / raw)
To: Matti Vaittinen
Cc: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano, kernel, linux-kernel,
Liam Girdwood, Mark Brown, Rafael J. Wysocki, Zhang Rui,
Lukasz Luba, linux-pm, Søren Andersen, Guenter Roeck,
Ahmad Fatoum, Andrew Morton, chrome-platform
Hi Matti,
Thanks for your feedback and for taking the time to review this patch series!
On Fri, Mar 14, 2025 at 02:22:40PM +0200, Matti Vaittinen wrote:
> Hi deee Ho Oleksij,
>
> On 14/03/2025 13:36, Oleksij Rempel wrote:
> > This commit introduces the Power State Change Reasons Recording (PSCRR)
> > framework into the kernel. The framework is vital for systems where
> > PMICs or watchdogs cannot provide information on power state changes. It
> > stores reasons for system shutdowns and reboots, like under-voltage or
> > software-triggered events, in non-volatile hardware storage. This
> > approach is essential for postmortem analysis in scenarios where
> > traditional storage methods (block devices, RAM) are not feasible. The
> > framework aids bootloaders and early-stage system components in recovery
> > decision-making, although it does not cover resets caused by hardware
> > issues like system freezes or watchdog timeouts.
> >
> > Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
>
> I see you're already at v6, so I am probably slightly late... I think I
> hadn't noticed this before. Thus, feel free to treat my comments as mere
> suggestions.
>
> All in all, I do like this series. Looks mostly very good to me :) Just
> wondering if we could utilize this same for standardizing reading the reset
> reason registers which are included in many PMICs?
>
> > ---
>
> ...
>
> > +int pscrr_core_init(const struct pscrr_backend_ops *ops)
> > +{
> > + enum psc_reason stored_val = PSCR_UNKNOWN;
> > + int ret;
> > +
> > + mutex_lock(&pscrr_lock);
> > +
> > + if (g_pscrr) {
> > + pr_err("PSCRR: Core is already initialized!\n");
> > + ret = -EBUSY;
> > + goto err_unlock;
> > + }
> > +
> > + if (!ops->read_reason || !ops->write_reason) {
> > + pr_err("PSCRR: Backend must provide read and write callbacks\n");
>
> Why both are required?
>
> I can easily envision integrating the some PMIC's 'boot reason' register
> reading to the PSCRR. Benefit would be that user-space could use this same
> interface when reading the reset reason on a system where reason is stored
> using mechanisms provided by this series - and when reset reason is
> automatically stored by the HW (for example to a PMIC).
>
> In a PMIC case the write_reason might not be needed, right?
I agree that PMICs could be valuable sources of reset reasons, and integrating
them into PSCRR makes sense. However, this introduces new challenges when
multiple providers exist on the same system, each reporting different power
state change reasons.
Handling Multiple Read-Only Providers (PMIC, Firmware, etc.):
- If we have multiple sources (e.g., PMIC, firmware logs, NVMEM-based storage),
we need to define how to handle conflicting or differing reset reasons.
- Using priorities may work in simple cases but is unlikely to scale well
across different platforms.
- A more flexible solution would be to expose all read-only providers
separately, rather than forcing one to override others.
Potential UAPI and Sysfs Structure
- The current sysfs API exposes:
- `/sys/kernel/pscrr/reason` → Default recorder
- `/sys/kernel/pscrr/reason_boot` → Last stored reason on default recorder
from before boot
- If we introduce read-only providers (like PMICs), we may need a dedicated
subdirectory to keep them separate.
- A possible structure:
```
/sys/kernel/pscrr/
├── reason # Default recorder
├── reason_boot # Default recorder (before boot)
├── providers/
│ ├── pmic0 # Read-only reset reason from PMIC
│ ├── firmware # Reset reason from firmware logs
│ ├── another_provider
```
- This would allow user-space tools to query all available sources while keeping
the default recorder behavior intact.
Next Steps
- I propose keeping this patch series focused on the default PSCRR recorder.
- Support for multiple read-only providers should be designed as a future
extension, possibly with an expanded sysfs API.
Would you agree that this approach keeps things maintainable while allowing
for future extensibility? Also, do you have a preference for naming the
subdirectory (`providers/`, `sources/`, etc.)?
Thanks again for your feedback!
Best regards,
Oleksij
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking
2025-03-14 13:38 ` Matti Vaittinen
@ 2025-03-14 14:10 ` Oleksij Rempel
2025-03-17 8:46 ` Matti Vaittinen
0 siblings, 1 reply; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-14 14:10 UTC (permalink / raw)
To: Matti Vaittinen
Cc: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano, kernel, linux-kernel,
Liam Girdwood, Mark Brown, Rafael J. Wysocki, Zhang Rui,
Lukasz Luba, linux-pm, Søren Andersen, Guenter Roeck,
Ahmad Fatoum, Andrew Morton, chrome-platform
On Fri, Mar 14, 2025 at 03:38:55PM +0200, Matti Vaittinen wrote:
> On 14/03/2025 13:36, Oleksij Rempel wrote:
> > Add documentation for the Power State Change Reason Recorder (PSCRR)
> > sysfs interface, which allows tracking of system shutdown and reboot
> > reasons. The documentation provides details on available sysfs entries
> > under `/sys/kernel/pscrr/`, explaining their functionality, example usage,
> > and how they interact with different backend storage options (e.g., NVMEM).
> >
> > Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> > ---
> > .../ABI/testing/sysfs-kernel-reboot-pscrr | 46 +++++++++++++++++++
> > 1 file changed, 46 insertions(+)
> > create mode 100644 Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> >
> > diff --git a/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> > new file mode 100644
> > index 000000000000..7cc643f89675
> > --- /dev/null
> > +++ b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> > @@ -0,0 +1,46 @@
> > +What: /sys/kernel/pscrr/reason
> > +Date: April 2025
> > +KernelVersion: 6.15
> > +Contact: Oleksij Rempel <o.rempel@pengutronix.de>
> > +Description:
> > + This file provides access to the last recorded power state
> > + change reason. The storage backend is configurable and, if
> > + supported, the reason may be stored persistently in an
> > + NVMEM cell or another backend.
> > +
> > + Reading this file returns an integer representing the last
> > + recorded shutdown or reboot cause.
> > +
> > + Writing an integer value to this file sets the reason to be
> > + stored and recorded for system analysis.
> > +
> > + Example usage (values are for illustration and may not reflect
> > + actual reasons used in a given system):
> > + Read:
> > + $ cat /sys/kernel/pscrr/reason
> > + 3 # (Example: Power loss event, may differ per system)
> > +
> > + Write:
> > + $ echo 5 > /sys/kernel/pscrr/reason
> > + # Sets the reason to 5 (Example: User-triggered reboot,
> > + # this may not be a real value in your system)
> > +
> > + Values are defined in:
> > + - `include/linux/reboot.h` (enum psc_reason)
>
> Is it possible to provide the reason (also) as string?
>
> I believe we should fix the meaning of the numbers so the ABI is not
> changing for the users. Hence we could as well document the meaning of the
> values(?) If I read the suggestion right, we will in any case have
> predefined set of reasons in the kernel side.
>
> Or, am I missing something?
Yes, it is correct, the values should be fixed for user space. Should
they be documented in this documentation too?
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage
2025-03-14 13:58 ` Oleksij Rempel
@ 2025-03-17 7:55 ` Matti Vaittinen
0 siblings, 0 replies; 15+ messages in thread
From: Matti Vaittinen @ 2025-03-17 7:55 UTC (permalink / raw)
To: Oleksij Rempel
Cc: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano, kernel, linux-kernel,
Liam Girdwood, Mark Brown, Rafael J. Wysocki, Zhang Rui,
Lukasz Luba, linux-pm, Søren Andersen, Guenter Roeck,
Ahmad Fatoum, Andrew Morton, chrome-platform
On 14/03/2025 15:58, Oleksij Rempel wrote:
> Hi Matti,
>
> Thanks for your feedback and for taking the time to review this patch series!
>
> On Fri, Mar 14, 2025 at 02:22:40PM +0200, Matti Vaittinen wrote:
>> Hi deee Ho Oleksij,
>>
>> On 14/03/2025 13:36, Oleksij Rempel wrote:
>>> This commit introduces the Power State Change Reasons Recording (PSCRR)
>>> framework into the kernel. The framework is vital for systems where
>>> PMICs or watchdogs cannot provide information on power state changes. It
>>> stores reasons for system shutdowns and reboots, like under-voltage or
>>> software-triggered events, in non-volatile hardware storage. This
>>> approach is essential for postmortem analysis in scenarios where
>>> traditional storage methods (block devices, RAM) are not feasible. The
>>> framework aids bootloaders and early-stage system components in recovery
>>> decision-making, although it does not cover resets caused by hardware
>>> issues like system freezes or watchdog timeouts.
>>>
>>> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
>>
>> I see you're already at v6, so I am probably slightly late... I think I
>> hadn't noticed this before. Thus, feel free to treat my comments as mere
>> suggestions.
>>
>> All in all, I do like this series. Looks mostly very good to me :) Just
>> wondering if we could utilize this same for standardizing reading the reset
>> reason registers which are included in many PMICs?
>>
>>> ---
>>
>> ...
>>
>>> +int pscrr_core_init(const struct pscrr_backend_ops *ops)
>>> +{
>>> + enum psc_reason stored_val = PSCR_UNKNOWN;
>>> + int ret;
>>> +
>>> + mutex_lock(&pscrr_lock);
>>> +
>>> + if (g_pscrr) {
>>> + pr_err("PSCRR: Core is already initialized!\n");
>>> + ret = -EBUSY;
>>> + goto err_unlock;
>>> + }
>>> +
>>> + if (!ops->read_reason || !ops->write_reason) {
>>> + pr_err("PSCRR: Backend must provide read and write callbacks\n");
>>
>> Why both are required?
>>
>> I can easily envision integrating the some PMIC's 'boot reason' register
>> reading to the PSCRR. Benefit would be that user-space could use this same
>> interface when reading the reset reason on a system where reason is stored
>> using mechanisms provided by this series - and when reset reason is
>> automatically stored by the HW (for example to a PMIC).
>>
>> In a PMIC case the write_reason might not be needed, right?
>
> I agree that PMICs could be valuable sources of reset reasons, and integrating
> them into PSCRR makes sense. However, this introduces new challenges when
> multiple providers exist on the same system, each reporting different power
> state change reasons.
I see that now. I didn't think of having multiple sources of this
information at the same time, but I agree it is a valid setup. For
example an under voltage warning triggering software reset could leave a
reason in PSCRR non volatile memory, while it wouldn't leave a trace in
a PMIC. More severe under voltage on same system might trigger the
hardware shutdown by the PMIC, which would leave the reason in PMIC but
not necessarily to the non volatile memory (depending on the amount
backup-energy). So yes, we might need multiple sources to get a good
picture. Thanks for pointing this out to me.
> Handling Multiple Read-Only Providers (PMIC, Firmware, etc.):
> - If we have multiple sources (e.g., PMIC, firmware logs, NVMEM-based storage),
> we need to define how to handle conflicting or differing reset reasons.
> - Using priorities may work in simple cases but is unlikely to scale well
> across different platforms.
> - A more flexible solution would be to expose all read-only providers
> separately, rather than forcing one to override others.
>
> Potential UAPI and Sysfs Structure
> - The current sysfs API exposes:
> - `/sys/kernel/pscrr/reason` → Default recorder
> - `/sys/kernel/pscrr/reason_boot` → Last stored reason on default recorder
> from before boot
> - If we introduce read-only providers (like PMICs), we may need a dedicated
> subdirectory to keep them separate.
> - A possible structure:
> ```
> /sys/kernel/pscrr/
> ├── reason # Default recorder
> ├── reason_boot # Default recorder (before boot)
> ├── providers/
> │ ├── pmic0 # Read-only reset reason from PMIC
> │ ├── firmware # Reset reason from firmware logs
> │ ├── another_provider
> ```
> - This would allow user-space tools to query all available sources while keeping
> the default recorder behavior intact.
>
> Next Steps
> - I propose keeping this patch series focused on the default PSCRR recorder.
> - Support for multiple read-only providers should be designed as a future
> extension, possibly with an expanded sysfs API.
Makes sense. Better to get something ready than keep everything on the
table. :) Still wonder if we should allow registering read-only
providers, even if we supported only a single source? But, I am not
insisting this, just doing a suggestion. Don't want to make "the
perfect" to be the enemy of good. (Actually, when I think of it, in many
cases I wouldn't want to even make the "good" to be enemy of "much
better than nothing").
> Would you agree that this approach keeps things maintainable while allowing
> for future extensibility?
Sure.
> Also, do you have a preference for naming the
> subdirectory (`providers/`, `sources/`, etc.)?
I am bad with naming but both of those would work for me :)
Yours,
-- Matti
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking
2025-03-14 14:10 ` Oleksij Rempel
@ 2025-03-17 8:46 ` Matti Vaittinen
2025-03-18 9:22 ` Oleksij Rempel
0 siblings, 1 reply; 15+ messages in thread
From: Matti Vaittinen @ 2025-03-17 8:46 UTC (permalink / raw)
To: Oleksij Rempel
Cc: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano, kernel, linux-kernel,
Liam Girdwood, Mark Brown, Rafael J. Wysocki, Zhang Rui,
Lukasz Luba, linux-pm, Søren Andersen, Guenter Roeck,
Ahmad Fatoum, Andrew Morton, chrome-platform
On 14/03/2025 16:10, Oleksij Rempel wrote:
> On Fri, Mar 14, 2025 at 03:38:55PM +0200, Matti Vaittinen wrote:
>> On 14/03/2025 13:36, Oleksij Rempel wrote:
>>> Add documentation for the Power State Change Reason Recorder (PSCRR)
>>> sysfs interface, which allows tracking of system shutdown and reboot
>>> reasons. The documentation provides details on available sysfs entries
>>> under `/sys/kernel/pscrr/`, explaining their functionality, example usage,
>>> and how they interact with different backend storage options (e.g., NVMEM).
>>>
>>> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
>>> ---
>>> .../ABI/testing/sysfs-kernel-reboot-pscrr | 46 +++++++++++++++++++
>>> 1 file changed, 46 insertions(+)
>>> create mode 100644 Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
>>>
>>> diff --git a/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
>>> new file mode 100644
>>> index 000000000000..7cc643f89675
>>> --- /dev/null
>>> +++ b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
>>> @@ -0,0 +1,46 @@
>>> +What: /sys/kernel/pscrr/reason
>>> +Date: April 2025
>>> +KernelVersion: 6.15
>>> +Contact: Oleksij Rempel <o.rempel@pengutronix.de>
>>> +Description:
>>> + This file provides access to the last recorded power state
>>> + change reason. The storage backend is configurable and, if
>>> + supported, the reason may be stored persistently in an
>>> + NVMEM cell or another backend.
>>> +
>>> + Reading this file returns an integer representing the last
>>> + recorded shutdown or reboot cause.
>>> +
>>> + Writing an integer value to this file sets the reason to be
>>> + stored and recorded for system analysis.
>>> +
>>> + Example usage (values are for illustration and may not reflect
>>> + actual reasons used in a given system):
>>> + Read:
>>> + $ cat /sys/kernel/pscrr/reason
>>> + 3 # (Example: Power loss event, may differ per system)
>>> +
>>> + Write:
>>> + $ echo 5 > /sys/kernel/pscrr/reason
>>> + # Sets the reason to 5 (Example: User-triggered reboot,
>>> + # this may not be a real value in your system)
>>> +
>>> + Values are defined in:
>>> + - `include/linux/reboot.h` (enum psc_reason)
>>
>> Is it possible to provide the reason (also) as string?
>>
>> I believe we should fix the meaning of the numbers so the ABI is not
>> changing for the users. Hence we could as well document the meaning of the
>> values(?) If I read the suggestion right, we will in any case have
>> predefined set of reasons in the kernel side.
>>
>> Or, am I missing something?
>
> Yes, it is correct, the values should be fixed for user space. Should
> they be documented in this documentation too?
I believe it could be helpful for both the user-space users and
potential pscrr provider driver writers. It could also set things to stone.
But, I don't have much experience on the documentation like this so
please treat this as a suggestion - but do as you see fits best.
Yours,
-- Matti
^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking
2025-03-17 8:46 ` Matti Vaittinen
@ 2025-03-18 9:22 ` Oleksij Rempel
0 siblings, 0 replies; 15+ messages in thread
From: Oleksij Rempel @ 2025-03-18 9:22 UTC (permalink / raw)
To: Matti Vaittinen
Cc: Sebastian Reichel, Srinivas Kandagatla, Benson Leung,
Tzung-Bi Shih, Daniel Lezcano, kernel, linux-kernel,
Liam Girdwood, Mark Brown, Rafael J. Wysocki, Zhang Rui,
Lukasz Luba, linux-pm, Søren Andersen, Guenter Roeck,
Ahmad Fatoum, Andrew Morton, chrome-platform
On Mon, Mar 17, 2025 at 10:46:01AM +0200, Matti Vaittinen wrote:
> On 14/03/2025 16:10, Oleksij Rempel wrote:
> > On Fri, Mar 14, 2025 at 03:38:55PM +0200, Matti Vaittinen wrote:
> > > On 14/03/2025 13:36, Oleksij Rempel wrote:
> > > > Add documentation for the Power State Change Reason Recorder (PSCRR)
> > > > sysfs interface, which allows tracking of system shutdown and reboot
> > > > reasons. The documentation provides details on available sysfs entries
> > > > under `/sys/kernel/pscrr/`, explaining their functionality, example usage,
> > > > and how they interact with different backend storage options (e.g., NVMEM).
> > > >
> > > > Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> > > > ---
> > > > .../ABI/testing/sysfs-kernel-reboot-pscrr | 46 +++++++++++++++++++
> > > > 1 file changed, 46 insertions(+)
> > > > create mode 100644 Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> > > >
> > > > diff --git a/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> > > > new file mode 100644
> > > > index 000000000000..7cc643f89675
> > > > --- /dev/null
> > > > +++ b/Documentation/ABI/testing/sysfs-kernel-reboot-pscrr
> > > > @@ -0,0 +1,46 @@
> > > > +What: /sys/kernel/pscrr/reason
> > > > +Date: April 2025
> > > > +KernelVersion: 6.15
> > > > +Contact: Oleksij Rempel <o.rempel@pengutronix.de>
> > > > +Description:
> > > > + This file provides access to the last recorded power state
> > > > + change reason. The storage backend is configurable and, if
> > > > + supported, the reason may be stored persistently in an
> > > > + NVMEM cell or another backend.
> > > > +
> > > > + Reading this file returns an integer representing the last
> > > > + recorded shutdown or reboot cause.
> > > > +
> > > > + Writing an integer value to this file sets the reason to be
> > > > + stored and recorded for system analysis.
> > > > +
> > > > + Example usage (values are for illustration and may not reflect
> > > > + actual reasons used in a given system):
> > > > + Read:
> > > > + $ cat /sys/kernel/pscrr/reason
> > > > + 3 # (Example: Power loss event, may differ per system)
> > > > +
> > > > + Write:
> > > > + $ echo 5 > /sys/kernel/pscrr/reason
> > > > + # Sets the reason to 5 (Example: User-triggered reboot,
> > > > + # this may not be a real value in your system)
> > > > +
> > > > + Values are defined in:
> > > > + - `include/linux/reboot.h` (enum psc_reason)
> > >
> > > Is it possible to provide the reason (also) as string?
> > >
> > > I believe we should fix the meaning of the numbers so the ABI is not
> > > changing for the users. Hence we could as well document the meaning of the
> > > values(?) If I read the suggestion right, we will in any case have
> > > predefined set of reasons in the kernel side.
> > >
> > > Or, am I missing something?
> >
> > Yes, it is correct, the values should be fixed for user space. Should
> > they be documented in this documentation too?
>
> I believe it could be helpful for both the user-space users and potential
> pscrr provider driver writers. It could also set things to stone.
Ok, i'll send updated patch set. I'll be happy to have your Reviewed-by
:)
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
^ permalink raw reply [flat|nested] 15+ messages in thread
end of thread, other threads:[~2025-03-18 9:23 UTC | newest]
Thread overview: 15+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-03-14 11:35 [PATCH v6 0/7] Introduction of PSCR Framework and Related Components Oleksij Rempel
2025-03-14 11:35 ` [PATCH v6 1/7] power: Extend power_on_reason.h for upcoming PSCRR framework Oleksij Rempel
2025-03-14 11:35 ` [PATCH v6 2/7] reboot: hw_protection_trigger: use standardized numeric shutdown/reboot reasons instead of strings Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage Oleksij Rempel
2025-03-14 12:22 ` Matti Vaittinen
2025-03-14 13:58 ` Oleksij Rempel
2025-03-17 7:55 ` Matti Vaittinen
2025-03-14 11:36 ` [PATCH v6 4/7] nvmem: provide consumer access to cell size metrics Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 5/7] nvmem: add support for device and sysfs-based cell lookups Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 6/7] power: reset: add PSCR NVMEM Driver for Recording Power State Change Reasons Oleksij Rempel
2025-03-14 11:36 ` [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking Oleksij Rempel
2025-03-14 13:38 ` Matti Vaittinen
2025-03-14 14:10 ` Oleksij Rempel
2025-03-17 8:46 ` Matti Vaittinen
2025-03-18 9:22 ` Oleksij Rempel
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox