From patchwork Fri Mar 14 11:35:58 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 14016679 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1A3411FE468 for ; Fri, 14 Mar 2025 11:36:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952188; cv=none; b=UIMS6m1p2htYS+Co82pLakv1w92piut4+YWmjNoS7CAOZTCvfQaLlnoMvbPt/SzOTja9iYnd1k8FrSqMgwTpOBbJI3k2npsQwicZoA3Fgb59LyP555MHDvKpQoXDIzWfaVPn4BAYg/OStj1v/Jt7Zc81TLjjSciD5VJiDXb6Vjg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952188; c=relaxed/simple; bh=lTbHJ1/ZlZxy/0X5aGRTsmnSe0G1gRDQaLVCb3W0FPk=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=BCOMhFc8BXQ/dsEYWWqHpGomcB5qIlRJaYfW0Lt+9Wday9IjpGLozVa9yaWNxDlaS2x/UhhXKml5p8xVFUzz9z88QR/+MHFxobVBBsQxlLIas5nBARq9sX8aqCCjm+sereIZ8K/mgLAjcBQbX0XR1ML0JY/3cuE8WX0eP2hVBaU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tt3Kg-0007NZ-QE; Fri, 14 Mar 2025 12:36:06 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tt3Kf-005h5q-1t; Fri, 14 Mar 2025 12:36:05 +0100 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tt3Kf-007S64-1c; Fri, 14 Mar 2025 12:36:05 +0100 From: Oleksij Rempel To: Sebastian Reichel , Srinivas Kandagatla , Benson Leung , Tzung-Bi Shih , Daniel Lezcano Cc: Oleksij Rempel , kernel@pengutronix.de, linux-kernel@vger.kernel.org, Liam Girdwood , Mark Brown , "Rafael J. Wysocki" , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org, =?utf-8?q?S=C3=B8ren_Andersen?= , Guenter Roeck , Matti Vaittinen , Ahmad Fatoum , Andrew Morton , chrome-platform@lists.linux.dev Subject: [PATCH v6 1/7] power: Extend power_on_reason.h for upcoming PSCRR framework Date: Fri, 14 Mar 2025 12:35:58 +0100 Message-Id: <20250314113604.1776201-2-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250314113604.1776201-1-o.rempel@pengutronix.de> References: <20250314113604.1776201-1-o.rempel@pengutronix.de> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: chrome-platform@lists.linux.dev 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 --- 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 */ From patchwork Fri Mar 14 11:35:59 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 14016685 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CCD2E1FF1AB for ; Fri, 14 Mar 2025 11:36:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952211; cv=none; b=oIaX9nzi0i+7yqRPXVCFi0nXlyKJ1EVV5dLb54S0b5w4ytTUfIONxvtxCNuFpWiTqU50rRl4zsvIGtU740CU7y8dgXu1KqWVvktRBHISj6Sa3Z1iHCpMho09/2fEgxSUNpx/PA/VC+ci9lLSQo2LDDEVTdU4Ye4qwD0ulqnNldA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952211; c=relaxed/simple; bh=KzQDmvkgld6TQyzYhmK3aY8GTZDDrDkFej9Cz/eFIGI=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=bC+o7UcIj6vfare4jwMEIWxl98DqXdM2t+Pf3WqWT4Vhu35g0NODW+pBIt1xoRipMGsTQWjrUuExORTbKKMWubl6WKbzXdJWyeViLGu3vpD/yo/XOLuc0QhtZjots7SbxSRBU/63JeHnJDVAlLQfFX0gTDal3UoKJrW8A2deu/8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tt3Kg-0007Nb-QD; Fri, 14 Mar 2025 12:36:06 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tt3Kf-005h5r-1z; Fri, 14 Mar 2025 12:36:05 +0100 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tt3Kf-007S6E-1h; Fri, 14 Mar 2025 12:36:05 +0100 From: Oleksij Rempel To: Sebastian Reichel , Srinivas Kandagatla , Benson Leung , Tzung-Bi Shih , Daniel Lezcano Cc: Oleksij Rempel , kernel@pengutronix.de, linux-kernel@vger.kernel.org, Liam Girdwood , Mark Brown , "Rafael J. Wysocki" , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org, =?utf-8?q?S=C3=B8ren_Andersen?= , Guenter Roeck , Matti Vaittinen , Ahmad Fatoum , Andrew Morton , chrome-platform@lists.linux.dev Subject: [PATCH v6 2/7] reboot: hw_protection_trigger: use standardized numeric shutdown/reboot reasons instead of strings Date: Fri, 14 Mar 2025 12:35:59 +0100 Message-Id: <20250314113604.1776201-3-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250314113604.1776201-1-o.rempel@pengutronix.de> References: <20250314113604.1776201-1-o.rempel@pengutronix.de> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: chrome-platform@lists.linux.dev 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 --- 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 #include #include +#include #include #include #include @@ -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)) From patchwork Fri Mar 14 11:36:00 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 14016682 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A1B1F1FE47E for ; Fri, 14 Mar 2025 11:36:30 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952193; cv=none; b=ogG/VPj4orho1Z+xK/MX/pFxzQjS9pZMBYoB/WpUeUoBQoZbVq2CZK5OgxKs9ML65O/6Rr+n9K5CgEm1u8zhynNhnSdtOxmHNvG2/vSVEoaIat4mZxbruL1YZf/T5Pf21lJRxAtFM1y9TdMfgeHUH+crAlBWdZKvS/xU+lAG6nQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952193; c=relaxed/simple; bh=bt9eeUG2BJh1cfC7p8x6xVrInMtRH4cNohZj2klFHNo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version:Content-Type; b=OLu+6sMiBLz8yHXibP3VSAFKu2MLgb+WvZZGSGxcNVGHDyfh2SSQA7Zwg+y9N6jood9I55UuXDDyonFYfNWk+lHceazPNo6YqNSfJ97gvM+arFsO8WPrX74tW17b7nn/I8kjFyNo3kOUqRM25xBQsxq48kUvclWZxYmr+3duw5c= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tt3Kg-0007Na-QD; Fri, 14 Mar 2025 12:36:06 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tt3Kf-005h5s-21; Fri, 14 Mar 2025 12:36:05 +0100 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tt3Kf-007S6O-1k; Fri, 14 Mar 2025 12:36:05 +0100 From: Oleksij Rempel To: Sebastian Reichel , Srinivas Kandagatla , Benson Leung , Tzung-Bi Shih , Daniel Lezcano Cc: Oleksij Rempel , kernel@pengutronix.de, linux-kernel@vger.kernel.org, Liam Girdwood , Mark Brown , "Rafael J. Wysocki" , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org, =?utf-8?q?S=C3=B8ren_Andersen?= , Guenter Roeck , Matti Vaittinen , Ahmad Fatoum , Andrew Morton , chrome-platform@lists.linux.dev Subject: [PATCH v6 3/7] power: reset: Introduce PSCR Recording Framework for Non-Volatile Storage Date: Fri, 14 Mar 2025 12:36:00 +0100 Message-Id: <20250314113604.1776201-4-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250314113604.1776201-1-o.rempel@pengutronix.de> References: <20250314113604.1776201-1-o.rempel@pengutronix.de> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: chrome-platform@lists.linux.dev 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 --- 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 +#include +#include +#include +#include +#include +#include +#include +#include +#include + +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 "); +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 + +/** + * 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__ */ From patchwork Fri Mar 14 11:36:01 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 14016681 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 501A31FECD7 for ; Fri, 14 Mar 2025 11:36:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952193; cv=none; b=BIpvwozckoGrKJnGl8ByPbpHovrgiWhlsWxo/qqi6RGlAgwASm2IG4zJTYgK522HjsKgfNnwG5k5QwT7mxOZkJQqp0DrJgnpwD+RVOIG5CUc7LkELAwGXtSkc+NDtR/t427IByK7hCwwtreiDYas/tlFgEkiIDySJQoXrrpHsC4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952193; c=relaxed/simple; bh=uUmYJxs95mrM4B2aqNw/3s0vKcVGkdJCqAA4sx9f114=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=sYfvE4F8VsteByGk1oAW6MRicYgBRVZZtwDFkkn8I1UblzxLSXWNGpUCipUgRWLhCdq58enREup4/C1R+y3aKwnUowuUV6cvRNc83VOIbbLkhhLrSLZnhwz0ykI5QfaNgSpNep9MGCyP5K5/rC5AJC0Vkkr89lsHsDCWN+216sw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tt3Kg-0007Nc-QD; Fri, 14 Mar 2025 12:36:06 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tt3Kf-005h5t-25; Fri, 14 Mar 2025 12:36:05 +0100 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tt3Kf-007S6Y-1o; Fri, 14 Mar 2025 12:36:05 +0100 From: Oleksij Rempel To: Sebastian Reichel , Srinivas Kandagatla , Benson Leung , Tzung-Bi Shih , Daniel Lezcano Cc: Oleksij Rempel , kernel@pengutronix.de, linux-kernel@vger.kernel.org, Liam Girdwood , Mark Brown , "Rafael J. Wysocki" , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org, =?utf-8?q?S=C3=B8ren_Andersen?= , Guenter Roeck , Matti Vaittinen , Ahmad Fatoum , Andrew Morton , chrome-platform@lists.linux.dev Subject: [PATCH v6 4/7] nvmem: provide consumer access to cell size metrics Date: Fri, 14 Mar 2025 12:36:01 +0100 Message-Id: <20250314113604.1776201-5-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250314113604.1776201-1-o.rempel@pengutronix.de> References: <20250314113604.1776201-1-o.rempel@pengutronix.de> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: chrome-platform@lists.linux.dev 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 --- 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) { From patchwork Fri Mar 14 11:36:02 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 14016680 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id BCAEA1FE47E for ; Fri, 14 Mar 2025 11:36:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952190; cv=none; b=aGy6c5QIK6wTyvmaZ+kq+CuxPKT/g4ZfyS0GscMgNYHKy06uW1WPDy2Slsnx7Slk/KDvrk9izcN41yToMpKvjRxgm7/S06ST/bGjFt8QJvmOcUR4/gEq+h+sTDaPiaKKalVLqLZNLcD1tBoi5z1A8ct5Vhm4dYZyRToHr+pMzLw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952190; c=relaxed/simple; bh=syywMVMqohA1NGmYJCurCu30p3AL85R5OC4/8mHT9eA=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=lIJz7Fke1XFtdLPpMzjs8udLmXh0aZ0rpPfesA6Ouo61+cFXxfA4SnTzVtMlBFs2zJvmyOKr0D0z68kyAQaoaPPXsnml2sBe/hXAoCJNBiP4dhrXYxiRdD7TNVjNTogk9M9KrI9074H8RiCWkLxZ6oGZEky2j9BZvkP5ANvfPIk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tt3Kg-0007Nd-QE; Fri, 14 Mar 2025 12:36:06 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tt3Kf-005h5v-2C; Fri, 14 Mar 2025 12:36:05 +0100 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tt3Kf-007S6i-1r; Fri, 14 Mar 2025 12:36:05 +0100 From: Oleksij Rempel To: Sebastian Reichel , Srinivas Kandagatla , Benson Leung , Tzung-Bi Shih , Daniel Lezcano Cc: Oleksij Rempel , kernel@pengutronix.de, linux-kernel@vger.kernel.org, Liam Girdwood , Mark Brown , "Rafael J. Wysocki" , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org, =?utf-8?q?S=C3=B8ren_Andersen?= , Guenter Roeck , Matti Vaittinen , Ahmad Fatoum , Andrew Morton , chrome-platform@lists.linux.dev Subject: [PATCH v6 5/7] nvmem: add support for device and sysfs-based cell lookups Date: Fri, 14 Mar 2025 12:36:02 +0100 Message-Id: <20250314113604.1776201-6-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250314113604.1776201-1-o.rempel@pengutronix.de> References: <20250314113604.1776201-1-o.rempel@pengutronix.de> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: chrome-platform@lists.linux.dev 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 --- 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 + * "@,". + * + * 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) { } From patchwork Fri Mar 14 11:36:03 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 14016683 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5F21C1FE463 for ; Fri, 14 Mar 2025 11:36:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952195; cv=none; b=e5MhgO9VW8eqHvuimLO1cQ9cF++k6GRfsMZFz3OL926rWbA+VsTRdnHWKbYRsjZnenbNXh1WAvqOO1JkxowRcapE7WC4g47OHvhKiCW31ScT3DvVc5FK4ZBrcP8j9ok6/6+q+jtoR1DoP4q54Otjj2tjh1++/dDxl/zA4SEFIHM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952195; c=relaxed/simple; bh=cWqrnz0iPUlouLQkAHvJFln5YMRL17uZKEqs7OguoTE=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=kXA1tx8FnA7zanqJ+1gLolEtLd6s3VfhZvT2s1GNr9l/UbS2bh/adPiCfVt03/qZPbFDzwSEAjLv1InUxSumLPJeSeJOHNFPdMYzAZSwvjTNPBhnC47QM0GbUml/PVCULjhLFWCpjk/CJ0hjmB1fwCBOydOmXQNK+MPWsXH68LY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tt3Kg-0007Ne-QD; Fri, 14 Mar 2025 12:36:06 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tt3Kf-005h5x-2H; Fri, 14 Mar 2025 12:36:05 +0100 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tt3Kf-007S6s-1v; Fri, 14 Mar 2025 12:36:05 +0100 From: Oleksij Rempel To: Sebastian Reichel , Srinivas Kandagatla , Benson Leung , Tzung-Bi Shih , Daniel Lezcano Cc: Oleksij Rempel , kernel@pengutronix.de, linux-kernel@vger.kernel.org, Liam Girdwood , Mark Brown , "Rafael J. Wysocki" , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org, =?utf-8?q?S=C3=B8ren_Andersen?= , Guenter Roeck , Matti Vaittinen , Ahmad Fatoum , Andrew Morton , chrome-platform@lists.linux.dev Subject: [PATCH v6 6/7] power: reset: add PSCR NVMEM Driver for Recording Power State Change Reasons Date: Fri, 14 Mar 2025 12:36:03 +0100 Message-Id: <20250314113604.1776201-7-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250314113604.1776201-1-o.rempel@pengutronix.de> References: <20250314113604.1776201-1-o.rempel@pengutronix.de> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: chrome-platform@lists.linux.dev 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 --- 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 +#include +#include +#include +#include +#include +#include + +/* + * 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 "); +MODULE_DESCRIPTION("PSCRR backend for storing reason code in NVMEM"); +MODULE_LICENSE("GPL"); From patchwork Fri Mar 14 11:36:04 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksij Rempel X-Patchwork-Id: 14016684 Received: from metis.whiteo.stw.pengutronix.de (metis.whiteo.stw.pengutronix.de [185.203.201.7]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 77EFB1FDE24 for ; Fri, 14 Mar 2025 11:36:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.203.201.7 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952199; cv=none; b=mriMwtnpWhf4974OAfpJy7OVAswkeYz0pwJIsNRLTOEelL7MbDIBoiG4IsW7c9naRABBtCizl7SxWc1N6OLdYokYUR5JSAmSxJFvNkhbLSjPtlqM8LGyy+N1zAuJ/cCyYOwLJza01Ca7ntWXRMYop+7jDI1s+r+i7oHqIXWA/LQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741952199; c=relaxed/simple; bh=BM2P1+sWqXKKZwR/jHqONVfULGU+/JuCKI63iVNdZTM=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=WlMhTNMU1cK54PaOpi/GLeLz0jTMO/FDRMcxh15OjmKeYe8Qope5wGCHutE5SpzIQdSJ3TgI5gWXtvR/Y9eLmweQMZDOTdvnAk6pe3qDZukgyt7WpWAstwBE5muucX+20tDUIfI33v0WSOoE/r4HnNXLxd9VPcl9PC4OZBpqtgg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de; spf=pass smtp.mailfrom=pengutronix.de; arc=none smtp.client-ip=185.203.201.7 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pengutronix.de Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tt3Kg-0007Nf-QE; Fri, 14 Mar 2025 12:36:06 +0100 Received: from dude04.red.stw.pengutronix.de ([2a0a:edc0:0:1101:1d::ac]) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1tt3Kf-005h5z-2K; Fri, 14 Mar 2025 12:36:05 +0100 Received: from ore by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1tt3Kf-007S73-1z; Fri, 14 Mar 2025 12:36:05 +0100 From: Oleksij Rempel To: Sebastian Reichel , Srinivas Kandagatla , Benson Leung , Tzung-Bi Shih , Daniel Lezcano Cc: Oleksij Rempel , kernel@pengutronix.de, linux-kernel@vger.kernel.org, Liam Girdwood , Mark Brown , "Rafael J. Wysocki" , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org, =?utf-8?q?S=C3=B8ren_Andersen?= , Guenter Roeck , Matti Vaittinen , Ahmad Fatoum , Andrew Morton , chrome-platform@lists.linux.dev Subject: [PATCH v6 7/7] Documentation: Add sysfs documentation for PSCRR reboot reason tracking Date: Fri, 14 Mar 2025 12:36:04 +0100 Message-Id: <20250314113604.1776201-8-o.rempel@pengutronix.de> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250314113604.1776201-1-o.rempel@pengutronix.de> References: <20250314113604.1776201-1-o.rempel@pengutronix.de> Precedence: bulk X-Mailing-List: chrome-platform@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2a0a:edc0:0:c01:1d::a2 X-SA-Exim-Mail-From: ore@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: chrome-platform@lists.linux.dev 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 --- .../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 +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 +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) +