src/include/reset.h

/* SPDX-License-Identifier: GPL-2.0-only */

#ifndef RESET_H
#define RESET_H

/*
 * Generic board reset function. Call from common code that
 * wants to trigger a reset.
 */
__noreturn void board_reset(void);
/*
 * SoC or board specific implementation of the board reset.
 *
 * Implementations shall meet the following criteria:
 *
 *   o For vboot support, the TPM MUST be reset.
 *
 *   o All SoC/chipset blocks SHOULD be reset except for those
 *     that are intentionally meant to survive reset (e.g. tomb-
 *     stone registers and that sort of stuff).
 *
 *   o All external SoC pins SHOULD return to power-on reset values.
 *
 *   o The CPU MUST resume execution from power-on reset vector
 *     (same as cold boot).
 *
 *   o Other board components (e.g. PCI, SDIO and stuff) SHOULD
 *     be reset.
 *
 *   o USB SHOULD be power-cycled.
 *
 *   o Board components that are intended to be fully independent
 *     from SoC (e.g. EC and EC-attached devices, the Cr50 on
 *     Chromebooks) SHOULD NOT be reset.
 *
 * General recommendations:
 *
 *   o DRAM SHOULD NOT lose power if possible.
 *
 *   o Reset time SHOULD be minimized
 */
void do_board_reset(void);

/*
 * Performs platform-specific actions for early power off.
 *
 * This function handles the necessary steps to initiate an early power off
 * sequence. This might involve configuring specific hardware registers,
 * sending commands to power management controllers, or performing other
 * platform-specific operations. It is crucial that this
 * function is implemented correctly to ensure a clean and controlled shutdown.
 *
 * Note: Issuing power off early before memory initialization is not supported use case on
 *       Intel chipset, therefore, it might need a special platform specific handing
 *       to power-off the platform early.
 */
void platform_do_early_poweroff(void);

#endif