Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Mon, 7 Feb 2022 16:16:18 +0100
From:   Krzysztof Adamski <krzysztof.adamski@nokia.com>
To:     Catalin Marinas <catalin.marinas@arm.com>,
        Will Deacon <will@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        Peter Collingbourne <pcc@google.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Wolfram Sang <wsa+renesas@sang-engineering.com>,
        Ard Biesheuvel <ardb@kernel.org>
Cc:     Alexander Sverdlin <alexander.sverdlin@nokia.com>,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org,
        linux-efi@vger.kernel.org
Subject: [PATCH v3] arm64: move efi_reboot to restart handler
Message-ID: <YgE3wo3W8y1qcd3t@localhost.localdomain>
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?izEmHuRBb32Sgf9pcvGVztFFkcgY8y9NOgZ+Iq9B3/6N9Wt/3OZlLoO6QL4y?=
 =?us-ascii?Q?JZtnJuYt8V21RdltEI0wMdbpiKM8e3Gx1ok5VvatNhi/YbDuduz8+A33c1NX?=
 =?us-ascii?Q?l8QtG+F42JayCDFK3y2WCF2FXCeCm113kB8KJnqJEvnIo+jkVupBM4rwTuYy?=
 =?us-ascii?Q?+/a7UH54SuQt8N3fHOlQLRX3oBUClU3H3SQSiLXXyVyTWB2U5bLI1rxgUrqr?=
 =?us-ascii?Q?sqjKlVutVAhe8oNhtQtV0os+/Fux355ZYmSgOCS46rmcv5puJPg5fTz3ppN/?=
 =?us-ascii?Q?gsY02A1458vD0tlLR7BLCO/FNj5OkVl4yvdb6mD2sxZTVKlzC/fYFEodyk49?=
 =?us-ascii?Q?MfLEckISCpBFS2BN1b2AAiJjQPPOqOB8nKWYh823c+nvur5OzH+f7ik554UO?=
 =?us-ascii?Q?xH/AfupzK7VqWCiG0hVnfQLewGQSnvKNf8R4ies8nwMlEyi3DHLlyK/HYKgM?=
 =?us-ascii?Q?T7R4iHMGdRPyrhktRGb8NnZcy/CwewtBLykMHBjmuQAWb0KMfF21C29yZSON?=
 =?us-ascii?Q?0Hq254NKVGXKsGT22no2gXw6SingLZv5RT2tHstNq0yiRK6i2J529lBalPpu?=
 =?us-ascii?Q?BjZoYzCV83zi/QtrfRnFhs8K0WoFYDO9ipsG3vcHFuMcx165JrG3Ui4oV9sW?=
 =?us-ascii?Q?3UqXAmZa7fn/92/WjMnjbhpvupz4elUmSQy9GR3XW1MkahhatNZ8kRH8htiS?=
 =?us-ascii?Q?ew+ZCtZKIggnT3cl/2e2hwFMHCFcJ2zP2cCMmc1xSN5u3jpjBni5TKX428/x?=
 =?us-ascii?Q?SO32KUhUnsab3gjI0OkeIX66W+g0muPb0oNwNVSY56qr7tHe7+06bXBEHGaE?=
 =?us-ascii?Q?0zXAyBWQlS+WAXja9jOdpP8G6Vonjo14+p6y/6R1l237+6+VMn4StDIGqF3X?=
 =?us-ascii?Q?dyZanvtzpS5ulxeC2CuCWBz4LQdCONj/ap0mbvJsveWEfLCeFygaBTDtK45h?=
 =?us-ascii?Q?N1HVuqe8z6l9T6c0Z8KcgmX2pL5noYATtDdv+q7s5CA9ycAr+GIxAy+WGqRT?=
 =?us-ascii?Q?8BkLivJFGHn0oPlYQFRXvd8pFstxa02rTs763V1QeOh8vm93ImWQgTqW6pTT?=
 =?us-ascii?Q?tudyRoJ5KNtKAaKPSR/dU7zd/GX6jcZM3ppN+tyWuVQm+ENHRqyeIe8MxWi5?=
 =?us-ascii?Q?MAfmrMtk9oTy/uMgqWne5RTCkzoCa7/1yh/kvwx0EsW2NqJm8BUiXaToVCG+?=
 =?us-ascii?Q?tCSUzSDiOydmBKBzuHVcJp6eFvFNUrJcNm3JVHnzSP22Zq64YhHVc9pIF9FW?=
 =?us-ascii?Q?u8/2XtIiEUkJIERPd6mM8RBBxsJ+wFblPc7lxfcbwggz82KK3KKR0X0Rp8Kd?=
 =?us-ascii?Q?LaIu6xzNtM4SRUiFTXf6JTAMIh1ZpfB1IKivgXWfkUqqTiK0G64h1oBVmYCq?=
 =?us-ascii?Q?lycOwA3cqpvBvQVO8okOE00rRtJHvLRi7ltNUkFTRNOgl3E8ZWaJMHuemJn3?=
 =?us-ascii?Q?R8ToTxpKrrP5xMYqjFwMlk1PIPz5tx4rOCfWcL539sk4Hmqjnj48PnmrW0TP?=
 =?us-ascii?Q?d/JtKiZhkozVPz67BIa0wwm40zwDX7HCo+Vl6Ms4qM5Avg3NnIEvY3juFgMj?=
 =?us-ascii?Q?6nMWBKJWRzFmFvyk8MTZE37uftFYHOcHL0UzdABr6RBw4E6LK8sN3VBjXz4L?=
 =?us-ascii?Q?iWwbMoeHWzr7WUBualqxikG65cLffCHcPDScZBuCEsR32c2Nif8Q/1y9z9/O?=
 =?us-ascii?Q?YCAKLA=3D=3D?=
X-OriginatorOrg: nokia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 97f76af9-a26a-4a42-ca24-08d9ea4ccd43
X-MS-Exchange-CrossTenant-AuthSource: AS8PR07MB8104.eurprd07.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Feb 2022 15:16:23.4447
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 5d471751-9675-428d-917b-70f44f9630b0
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 6rQmAi3eRy5EuVx4tDrmHYYKvMFQOwcpJ81OxXMpjMbeMnAI+KZKEKQZMlUHqC8ki8OHv/OU/+vajxiVVVhL5v570hs5mQBoncupyICnWoM=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR07MB5227
X-Spam-Status: No, score=-0.9 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,FORGED_SPF_HELO,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE,T_SCC_BODY_TEXT_LINE
        autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On EFI enabled arm64 systems, efi_reboot was called before
do_kernel_restart, completely omitting the reset_handlers functionality.
By registering efi_reboot as part of the chain with elevated priority,
we make it run before the default handler but still allow plugging in
other handlers.

This is useful in two scenarios:
 - Abusing the restart handler as a notification mechanism similar to
   reboot notifiers, but working in wider spectrum of cases, (notably
   also at emergency_restart) and just before reset. This is useful for
   things like in-kernel pwrseq_emmc, or any other place where it is
   beneficial for an *external* component to know about the restart, but
   not performing the reset itself.
 - Providing higher priority reset handler, where resetting the SoC is
   not enough, and reset of the whole board should be orchestrated by
   some external component, that the firmware is not aware of (like an
   FPGA or some PMIC).

This change moves the conditional efi_reboot() call from arm64 specific
machine_restart() function to an arm efi initialization code where it is
registered as a restart handler with a very high (but not the highest)
priority, leaving a small window of opportunity for some code to be run
prior to the actual reset, like on other architectures.

The restart handlers mechanism is proven to work reliably as we depend
on it heavily on other platforms so there is almost no cost for this
change but it adds flexibility and unifies our infrastructure with other
ports (where one can depend on restart handlers working).

Signed-off-by: Krzysztof Adamski <krzysztof.adamski@nokia.com>
---

While previous attempts got mixed feedback, my explanations did not seen
counterarguments so I am trying another round:

Changes in v3:
  - Bump the priority much higher, to almost maximal value
  - Add a comment discouraging from registering higher prio handlers
  - Update the commit message to contain some more justifications

Changes in v2:
  - Register the handler in EFI code, instead of arm64 setup.c
  - Remove the contdition from the handler - it should be run in all
    cases when it is registered
  - Bump the priority to 130 to make it completly obious this should be
    run before PSCI (which has priority of 129)

 arch/arm64/kernel/process.c        |  7 -------
 drivers/firmware/efi/arm-runtime.c | 25 +++++++++++++++++++++++++
 2 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/arch/arm64/kernel/process.c b/arch/arm64/kernel/process.c
index 5369e649fa79..b86ef77bb0c8 100644
--- a/arch/arm64/kernel/process.c
+++ b/arch/arm64/kernel/process.c
@@ -130,13 +130,6 @@ void machine_restart(char *cmd)
 	local_irq_disable();
 	smp_send_stop();
 
-	/*
-	 * UpdateCapsule() depends on the system being reset via
-	 * ResetSystem().
-	 */
-	if (efi_enabled(EFI_RUNTIME_SERVICES))
-		efi_reboot(reboot_mode, NULL);
-
 	/* Now call the architecture specific reboot code. */
 	do_kernel_restart(cmd);
 
diff --git a/drivers/firmware/efi/arm-runtime.c b/drivers/firmware/efi/arm-runtime.c
index 3359ae2adf24..b29f47783bbc 100644
--- a/drivers/firmware/efi/arm-runtime.c
+++ b/drivers/firmware/efi/arm-runtime.c
@@ -80,6 +80,28 @@ static bool __init efi_virtmap_init(void)
 	return true;
 }
 
+static int efi_restart(struct notifier_block *nb, unsigned long action,
+		       void *data)
+{
+	/*
+	 * UpdateCapsule() depends on the system being reset via
+	 * ResetSystem().
+	 */
+	efi_reboot(reboot_mode, NULL);
+
+	return NOTIFY_DONE;
+}
+
+static struct notifier_block efi_restart_nb = {
+	.notifier_call = efi_restart,
+	/**
+	 * If you are running UEFI based system, you most certainly should let
+	 * efi_reboot() do a reset for you. If you think you know better, we
+	 * leave you a window of opportunity here by not using maximal priority.
+	 */
+	.priority = 251,
+};
+
 /*
  * Enable the UEFI Runtime Services if all prerequisites are in place, i.e.,
  * non-early mapping of the UEFI system table and virtual mappings for all
@@ -148,6 +170,9 @@ static int __init arm_enable_runtime_services(void)
 	efi_native_runtime_setup();
 	set_bit(EFI_RUNTIME_SERVICES, &efi.flags);
 
+	if (IS_ENABLED(CONFIG_ARM64))
+		register_restart_handler(&efi_restart_nb);
+
 	return 0;
 }
 early_initcall(arm_enable_runtime_services);
-- 
2.34.1