195857638SErik Schmauss // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
295b482a8SLen Brown /******************************************************************************
395b482a8SLen Brown *
470958576SBob Moore * Name: hwsleep.c - ACPI Hardware Sleep/Wake Support functions for the
570958576SBob Moore * original/legacy sleep/PM registers.
695b482a8SLen Brown *
7*487ea80aSBob Moore * Copyright (C) 2000 - 2023, Intel Corp.
895b482a8SLen Brown *
995857638SErik Schmauss *****************************************************************************/
1095b482a8SLen Brown
1195b482a8SLen Brown #include <acpi/acpi.h>
12e2f7a777SLen Brown #include "accommon.h"
1395b482a8SLen Brown
1495b482a8SLen Brown #define _COMPONENT ACPI_HARDWARE
1595b482a8SLen Brown ACPI_MODULE_NAME("hwsleep")
1695b482a8SLen Brown
1770958576SBob Moore #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
182feec47dSBob Moore /*******************************************************************************
192feec47dSBob Moore *
202feec47dSBob Moore * FUNCTION: acpi_hw_legacy_sleep
2195b482a8SLen Brown *
2295b482a8SLen Brown * PARAMETERS: sleep_state - Which sleep state to enter
2395b482a8SLen Brown *
2495b482a8SLen Brown * RETURN: Status
2595b482a8SLen Brown *
262feec47dSBob Moore * DESCRIPTION: Enter a system sleep state via the legacy FADT PM registers
2795b482a8SLen Brown * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
2895b482a8SLen Brown *
2995b482a8SLen Brown ******************************************************************************/
acpi_hw_legacy_sleep(u8 sleep_state)303f6f49c7SLen Brown acpi_status acpi_hw_legacy_sleep(u8 sleep_state)
3195b482a8SLen Brown {
3295b482a8SLen Brown struct acpi_bit_register_info *sleep_type_reg_info;
3395b482a8SLen Brown struct acpi_bit_register_info *sleep_enable_reg_info;
342feec47dSBob Moore u32 pm1a_control;
352feec47dSBob Moore u32 pm1b_control;
3695b482a8SLen Brown u32 in_value;
3795b482a8SLen Brown acpi_status status;
3895b482a8SLen Brown
392feec47dSBob Moore ACPI_FUNCTION_TRACE(hw_legacy_sleep);
4095b482a8SLen Brown
4195b482a8SLen Brown sleep_type_reg_info =
4282d79b86SBob Moore acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
4395b482a8SLen Brown sleep_enable_reg_info =
4495b482a8SLen Brown acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
4595b482a8SLen Brown
4695b482a8SLen Brown /* Clear wake status */
4795b482a8SLen Brown
481fad8738SBob Moore status = acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS,
491fad8738SBob Moore ACPI_CLEAR_STATUS);
5095b482a8SLen Brown if (ACPI_FAILURE(status)) {
5195b482a8SLen Brown return_ACPI_STATUS(status);
5295b482a8SLen Brown }
5395b482a8SLen Brown
54fa85015cSRafael J. Wysocki /* Disable all GPEs */
5595b482a8SLen Brown status = acpi_hw_disable_all_gpes();
5695b482a8SLen Brown if (ACPI_FAILURE(status)) {
5795b482a8SLen Brown return_ACPI_STATUS(status);
5895b482a8SLen Brown }
59fa85015cSRafael J. Wysocki status = acpi_hw_clear_acpi_status();
60fa85015cSRafael J. Wysocki if (ACPI_FAILURE(status)) {
61fa85015cSRafael J. Wysocki return_ACPI_STATUS(status);
62fa85015cSRafael J. Wysocki }
6395b482a8SLen Brown acpi_gbl_system_awake_and_running = FALSE;
6495b482a8SLen Brown
65fa85015cSRafael J. Wysocki /* Enable all wakeup GPEs */
6695b482a8SLen Brown status = acpi_hw_enable_all_wakeup_gpes();
6795b482a8SLen Brown if (ACPI_FAILURE(status)) {
6895b482a8SLen Brown return_ACPI_STATUS(status);
6995b482a8SLen Brown }
7095b482a8SLen Brown
7195b482a8SLen Brown /* Get current value of PM1A control */
7295b482a8SLen Brown
7332c9ef99SBob Moore status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
7432c9ef99SBob Moore &pm1a_control);
7595b482a8SLen Brown if (ACPI_FAILURE(status)) {
7695b482a8SLen Brown return_ACPI_STATUS(status);
7795b482a8SLen Brown }
7895b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_INIT,
79b27d6597SBob Moore "Entering sleep state [S%u]\n", sleep_state));
8095b482a8SLen Brown
8132c9ef99SBob Moore /* Clear the SLP_EN and SLP_TYP fields */
8295b482a8SLen Brown
8332c9ef99SBob Moore pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
8495b482a8SLen Brown sleep_enable_reg_info->access_bit_mask);
8532c9ef99SBob Moore pm1b_control = pm1a_control;
8695b482a8SLen Brown
8732c9ef99SBob Moore /* Insert the SLP_TYP bits */
8895b482a8SLen Brown
8932c9ef99SBob Moore pm1a_control |=
9095b482a8SLen Brown (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
9132c9ef99SBob Moore pm1b_control |=
9295b482a8SLen Brown (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
9395b482a8SLen Brown
9495b482a8SLen Brown /*
9595b482a8SLen Brown * We split the writes of SLP_TYP and SLP_EN to workaround
9695b482a8SLen Brown * poorly implemented hardware.
9795b482a8SLen Brown */
9895b482a8SLen Brown
9932c9ef99SBob Moore /* Write #1: write the SLP_TYP data to the PM1 Control registers */
10095b482a8SLen Brown
10132c9ef99SBob Moore status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
10295b482a8SLen Brown if (ACPI_FAILURE(status)) {
10395b482a8SLen Brown return_ACPI_STATUS(status);
10495b482a8SLen Brown }
10595b482a8SLen Brown
10632c9ef99SBob Moore /* Insert the sleep enable (SLP_EN) bit */
10795b482a8SLen Brown
10832c9ef99SBob Moore pm1a_control |= sleep_enable_reg_info->access_bit_mask;
10932c9ef99SBob Moore pm1b_control |= sleep_enable_reg_info->access_bit_mask;
11095b482a8SLen Brown
11132c9ef99SBob Moore /* Flush caches, as per ACPI specification */
11295b482a8SLen Brown
1131d4e0b3aSKirill A. Shutemov if (sleep_state < ACPI_STATE_S4) {
11495b482a8SLen Brown ACPI_FLUSH_CPU_CACHE();
1151d4e0b3aSKirill A. Shutemov }
11695b482a8SLen Brown
1170fc5e8f4SLv Zheng status = acpi_os_enter_sleep(sleep_state, pm1a_control, pm1b_control);
1180fc5e8f4SLv Zheng if (status == AE_CTRL_TERMINATE) {
11909f98a82STang Liang return_ACPI_STATUS(AE_OK);
1200fc5e8f4SLv Zheng }
1210fc5e8f4SLv Zheng if (ACPI_FAILURE(status)) {
12209f98a82STang Liang return_ACPI_STATUS(status);
1230fc5e8f4SLv Zheng }
1240fc5e8f4SLv Zheng
12532c9ef99SBob Moore /* Write #2: Write both SLP_TYP + SLP_EN */
12695b482a8SLen Brown
12732c9ef99SBob Moore status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
12895b482a8SLen Brown if (ACPI_FAILURE(status)) {
12995b482a8SLen Brown return_ACPI_STATUS(status);
13095b482a8SLen Brown }
13195b482a8SLen Brown
13295b482a8SLen Brown if (sleep_state > ACPI_STATE_S3) {
13395b482a8SLen Brown /*
13495b482a8SLen Brown * We wanted to sleep > S3, but it didn't happen (by virtue of the
13595b482a8SLen Brown * fact that we are still executing!)
13695b482a8SLen Brown *
13795b482a8SLen Brown * Wait ten seconds, then try again. This is to get S4/S5 to work on
13895b482a8SLen Brown * all machines.
13995b482a8SLen Brown *
140d4913dc6SBob Moore * We wait so long to allow chipsets that poll this reg very slowly
141d4913dc6SBob Moore * to still read the right value. Ideally, this block would go
14295b482a8SLen Brown * away entirely.
14395b482a8SLen Brown */
144c41679a4SBob Moore acpi_os_stall(10 * ACPI_USEC_PER_SEC);
14595b482a8SLen Brown
14695b482a8SLen Brown status = acpi_hw_register_write(ACPI_REGISTER_PM1_CONTROL,
14795b482a8SLen Brown sleep_enable_reg_info->
14895b482a8SLen Brown access_bit_mask);
14995b482a8SLen Brown if (ACPI_FAILURE(status)) {
15095b482a8SLen Brown return_ACPI_STATUS(status);
15195b482a8SLen Brown }
15295b482a8SLen Brown }
15395b482a8SLen Brown
1542feec47dSBob Moore /* Wait for transition back to Working State */
15595b482a8SLen Brown
15695b482a8SLen Brown do {
15750ffba1bSBob Moore status =
15850ffba1bSBob Moore acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
15995b482a8SLen Brown if (ACPI_FAILURE(status)) {
16095b482a8SLen Brown return_ACPI_STATUS(status);
16195b482a8SLen Brown }
1622feec47dSBob Moore
16395b482a8SLen Brown } while (!in_value);
16495b482a8SLen Brown
16595b482a8SLen Brown return_ACPI_STATUS(AE_OK);
16695b482a8SLen Brown }
16795b482a8SLen Brown
16895b482a8SLen Brown /*******************************************************************************
16995b482a8SLen Brown *
1702feec47dSBob Moore * FUNCTION: acpi_hw_legacy_wake_prep
17195b482a8SLen Brown *
1722feec47dSBob Moore * PARAMETERS: sleep_state - Which sleep state we just exited
17395b482a8SLen Brown *
17495b482a8SLen Brown * RETURN: Status
17595b482a8SLen Brown *
17695b482a8SLen Brown * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
17795b482a8SLen Brown * sleep.
1782feec47dSBob Moore * Called with interrupts ENABLED.
17995b482a8SLen Brown *
18095b482a8SLen Brown ******************************************************************************/
1812feec47dSBob Moore
acpi_hw_legacy_wake_prep(u8 sleep_state)1823f6f49c7SLen Brown acpi_status acpi_hw_legacy_wake_prep(u8 sleep_state)
18395b482a8SLen Brown {
184d3c4b6f6SRafael J. Wysocki acpi_status status = AE_OK;
18595b482a8SLen Brown struct acpi_bit_register_info *sleep_type_reg_info;
18695b482a8SLen Brown struct acpi_bit_register_info *sleep_enable_reg_info;
18732c9ef99SBob Moore u32 pm1a_control;
18832c9ef99SBob Moore u32 pm1b_control;
18995b482a8SLen Brown
1902feec47dSBob Moore ACPI_FUNCTION_TRACE(hw_legacy_wake_prep);
19195b482a8SLen Brown
19295b482a8SLen Brown /*
19395b482a8SLen Brown * Set SLP_TYPE and SLP_EN to state S0.
19495b482a8SLen Brown * This is unclear from the ACPI Spec, but it is required
19595b482a8SLen Brown * by some machines.
19695b482a8SLen Brown */
197d3c4b6f6SRafael J. Wysocki if (acpi_gbl_sleep_type_a_s0 != ACPI_SLEEP_TYPE_INVALID) {
19895b482a8SLen Brown sleep_type_reg_info =
19982d79b86SBob Moore acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
20095b482a8SLen Brown sleep_enable_reg_info =
20195b482a8SLen Brown acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
20295b482a8SLen Brown
20395b482a8SLen Brown /* Get current value of PM1A control */
20495b482a8SLen Brown
20595b482a8SLen Brown status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
20632c9ef99SBob Moore &pm1a_control);
20795b482a8SLen Brown if (ACPI_SUCCESS(status)) {
20895b482a8SLen Brown
20932c9ef99SBob Moore /* Clear the SLP_EN and SLP_TYP fields */
21095b482a8SLen Brown
21132c9ef99SBob Moore pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
21295b482a8SLen Brown sleep_enable_reg_info->
21395b482a8SLen Brown access_bit_mask);
21432c9ef99SBob Moore pm1b_control = pm1a_control;
21595b482a8SLen Brown
21632c9ef99SBob Moore /* Insert the SLP_TYP bits */
21795b482a8SLen Brown
218d3c4b6f6SRafael J. Wysocki pm1a_control |= (acpi_gbl_sleep_type_a_s0 <<
219d4913dc6SBob Moore sleep_type_reg_info->bit_position);
220d3c4b6f6SRafael J. Wysocki pm1b_control |= (acpi_gbl_sleep_type_b_s0 <<
221d4913dc6SBob Moore sleep_type_reg_info->bit_position);
22295b482a8SLen Brown
22332c9ef99SBob Moore /* Write the control registers and ignore any errors */
22495b482a8SLen Brown
22532c9ef99SBob Moore (void)acpi_hw_write_pm1_control(pm1a_control,
22632c9ef99SBob Moore pm1b_control);
22795b482a8SLen Brown }
22895b482a8SLen Brown }
22995b482a8SLen Brown
23095b482a8SLen Brown return_ACPI_STATUS(status);
23195b482a8SLen Brown }
23295b482a8SLen Brown
23395b482a8SLen Brown /*******************************************************************************
23495b482a8SLen Brown *
2352feec47dSBob Moore * FUNCTION: acpi_hw_legacy_wake
23695b482a8SLen Brown *
23795b482a8SLen Brown * PARAMETERS: sleep_state - Which sleep state we just exited
23895b482a8SLen Brown *
23995b482a8SLen Brown * RETURN: Status
24095b482a8SLen Brown *
24195b482a8SLen Brown * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
24295b482a8SLen Brown * Called with interrupts ENABLED.
24395b482a8SLen Brown *
24495b482a8SLen Brown ******************************************************************************/
2452feec47dSBob Moore
acpi_hw_legacy_wake(u8 sleep_state)2463f6f49c7SLen Brown acpi_status acpi_hw_legacy_wake(u8 sleep_state)
24795b482a8SLen Brown {
24895b482a8SLen Brown acpi_status status;
24995b482a8SLen Brown
2502feec47dSBob Moore ACPI_FUNCTION_TRACE(hw_legacy_wake);
25195b482a8SLen Brown
25295b482a8SLen Brown /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
25395b482a8SLen Brown
25495b482a8SLen Brown acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
2554efeeecdSBob Moore acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WAKING);
25695b482a8SLen Brown
25795b482a8SLen Brown /*
25895b482a8SLen Brown * GPEs must be enabled before _WAK is called as GPEs
25995b482a8SLen Brown * might get fired there
26095b482a8SLen Brown *
26195b482a8SLen Brown * Restore the GPEs:
26218996f2dSErik Schmauss * 1) Disable all GPEs
26395b482a8SLen Brown * 2) Enable all runtime GPEs
26495b482a8SLen Brown */
26595b482a8SLen Brown status = acpi_hw_disable_all_gpes();
26695b482a8SLen Brown if (ACPI_FAILURE(status)) {
26795b482a8SLen Brown return_ACPI_STATUS(status);
26895b482a8SLen Brown }
2692feec47dSBob Moore
27095b482a8SLen Brown status = acpi_hw_enable_all_runtime_gpes();
27195b482a8SLen Brown if (ACPI_FAILURE(status)) {
27295b482a8SLen Brown return_ACPI_STATUS(status);
27395b482a8SLen Brown }
27495b482a8SLen Brown
2752feec47dSBob Moore /*
2762feec47dSBob Moore * Now we can execute _WAK, etc. Some machines require that the GPEs
2772feec47dSBob Moore * are enabled before the wake methods are executed.
2782feec47dSBob Moore */
2794efeeecdSBob Moore acpi_hw_execute_sleep_method(METHOD_PATHNAME__WAK, sleep_state);
28095b482a8SLen Brown
28195b482a8SLen Brown /*
2822feec47dSBob Moore * Some BIOS code assumes that WAK_STS will be cleared on resume
2832feec47dSBob Moore * and use it to determine whether the system is rebooting or
2842feec47dSBob Moore * resuming. Clear WAK_STS for compatibility.
28595b482a8SLen Brown */
286739dcbb9SLv Zheng (void)acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS,
287739dcbb9SLv Zheng ACPI_CLEAR_STATUS);
28895b482a8SLen Brown acpi_gbl_system_awake_and_running = TRUE;
28995b482a8SLen Brown
29095b482a8SLen Brown /* Enable power button */
29195b482a8SLen Brown
29295b482a8SLen Brown (void)
29350ffba1bSBob Moore acpi_write_bit_register(acpi_gbl_fixed_event_info
294768aaaf1SBob Moore [ACPI_EVENT_POWER_BUTTON].
295768aaaf1SBob Moore enable_register_id, ACPI_ENABLE_EVENT);
29695b482a8SLen Brown
29795b482a8SLen Brown (void)
29850ffba1bSBob Moore acpi_write_bit_register(acpi_gbl_fixed_event_info
299768aaaf1SBob Moore [ACPI_EVENT_POWER_BUTTON].
300768aaaf1SBob Moore status_register_id, ACPI_CLEAR_STATUS);
30195b482a8SLen Brown
302a1dc35b8SAnchal Agarwal /* Enable sleep button */
303a1dc35b8SAnchal Agarwal
304a1dc35b8SAnchal Agarwal (void)
305a1dc35b8SAnchal Agarwal acpi_write_bit_register(acpi_gbl_fixed_event_info
306a1dc35b8SAnchal Agarwal [ACPI_EVENT_SLEEP_BUTTON].
307a1dc35b8SAnchal Agarwal enable_register_id, ACPI_ENABLE_EVENT);
308a1dc35b8SAnchal Agarwal
309a1dc35b8SAnchal Agarwal (void)
310a1dc35b8SAnchal Agarwal acpi_write_bit_register(acpi_gbl_fixed_event_info
311a1dc35b8SAnchal Agarwal [ACPI_EVENT_SLEEP_BUTTON].
312a1dc35b8SAnchal Agarwal status_register_id, ACPI_CLEAR_STATUS);
313a1dc35b8SAnchal Agarwal
3144efeeecdSBob Moore acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WORKING);
3152feec47dSBob Moore return_ACPI_STATUS(status);
3162feec47dSBob Moore }
3172feec47dSBob Moore
31833620c54SBob Moore #endif /* !ACPI_REDUCED_HARDWARE */
319