drivers/acpi/acpica/hwesleep.c

   1 /******************************************************************************
   2  *
   3  * Name: hwesleep.c - ACPI Hardware Sleep/Wake Support functions for the
   4  *                    extended FADT-V5 sleep registers.
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2012, Intel Corp.
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions, and the following disclaimer,
  17  *    without modification.
  18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  19  *    substantially similar to the "NO WARRANTY" disclaimer below
  20  *    ("Disclaimer") and any redistribution must be conditioned upon
  21  *    including a substantially similar Disclaimer requirement for further
  22  *    binary redistribution.
  23  * 3. Neither the names of the above-listed copyright holders nor the names
  24  *    of any contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * Alternatively, this software may be distributed under the terms of the
  28  * GNU General Public License ("GPL") version 2 as published by the Free
  29  * Software Foundation.
  30  *
  31  * NO WARRANTY
  32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42  * POSSIBILITY OF SUCH DAMAGES.
  43  */
  44
  45 #include <acpi/acpi.h>
  46 #include "accommon.h"
  47
  48 #define _COMPONENT          ACPI_HARDWARE
  49 ACPI_MODULE_NAME("hwesleep")
  50
  51 /*******************************************************************************
  52  *
  53  * FUNCTION:    acpi_hw_execute_sleep_method
  54  *
  55  * PARAMETERS:  method_pathname     - Pathname of method to execute
  56  *              integer_argument    - Argument to pass to the method
  57  *
  58  * RETURN:      None
  59  *
  60  * DESCRIPTION: Execute a sleep/wake related method with one integer argument
  61  *              and no return value.
  62  *
  63  ******************************************************************************/
  64 void acpi_hw_execute_sleep_method(char *method_pathname, u32 integer_argument)
  65 {
  66         struct acpi_object_list arg_list;
  67         union acpi_object arg;
  68         acpi_status status;
  69
  70         ACPI_FUNCTION_TRACE(hw_execute_sleep_method);
  71
  72         /* One argument, integer_argument; No return value expected */
  73
  74         arg_list.count = 1;
  75         arg_list.pointer = &arg;
  76         arg.type = ACPI_TYPE_INTEGER;
  77         arg.integer.value = (u64)integer_argument;
  78
  79         status = acpi_evaluate_object(NULL, method_pathname, &arg_list, NULL);
  80         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
  81                 ACPI_EXCEPTION((AE_INFO, status, "While executing method %s",
  82                                 method_pathname));
  83         }
  84
  85         return_VOID;
  86 }
  87
  88 /*******************************************************************************
  89  *
  90  * FUNCTION:    acpi_hw_extended_sleep
  91  *
  92  * PARAMETERS:  sleep_state         - Which sleep state to enter
  93  *              flags               - ACPI_EXECUTE_GTS to run optional method
  94  *
  95  * RETURN:      Status
  96  *
  97  * DESCRIPTION: Enter a system sleep state via the extended FADT sleep
  98  *              registers (V5 FADT).
  99  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
 100  *
 101  ******************************************************************************/
 102
 103 acpi_status acpi_hw_extended_sleep(u8 sleep_state, u8 flags)
 104 {
 105         acpi_status status;
 106         u8 sleep_type_value;
 107         u64 sleep_status;
 108
 109         ACPI_FUNCTION_TRACE(hw_extended_sleep);
 110
 111         /* Extended sleep registers must be valid */
 112
 113         if (!acpi_gbl_FADT.sleep_control.address ||
 114             !acpi_gbl_FADT.sleep_status.address) {
 115                 return_ACPI_STATUS(AE_NOT_EXIST);
 116         }
 117
 118         /* Clear wake status (WAK_STS) */
 119
 120         status =
 121             acpi_write((u64)ACPI_X_WAKE_STATUS, &acpi_gbl_FADT.sleep_status);
 122         if (ACPI_FAILURE(status)) {
 123                 return_ACPI_STATUS(status);
 124         }
 125
 126         acpi_gbl_system_awake_and_running = FALSE;
 127
 128         /* Optionally execute _GTS (Going To Sleep) */
 129
 130         if (flags & ACPI_EXECUTE_GTS) {
 131                 acpi_hw_execute_sleep_method(METHOD_PATHNAME__GTS, sleep_state);
 132         }
 133
 134         /* Flush caches, as per ACPI specification */
 135
 136         ACPI_FLUSH_CPU_CACHE();
 137
 138         /*
 139          * Set the SLP_TYP and SLP_EN bits.
 140          *
 141          * Note: We only use the first value returned by the \_Sx method
 142          * (acpi_gbl_sleep_type_a) - As per ACPI specification.
 143          */
 144         ACPI_DEBUG_PRINT((ACPI_DB_INIT,
 145                           "Entering sleep state [S%u]\n", sleep_state));
 146
 147         sleep_type_value =
 148             ((acpi_gbl_sleep_type_a << ACPI_X_SLEEP_TYPE_POSITION) &
 149              ACPI_X_SLEEP_TYPE_MASK);
 150
 151         status = acpi_write((u64)(sleep_type_value | ACPI_X_SLEEP_ENABLE),
 152                             &acpi_gbl_FADT.sleep_control);
 153         if (ACPI_FAILURE(status)) {
 154                 return_ACPI_STATUS(status);
 155         }
 156
 157         /* Wait for transition back to Working State */
 158
 159         do {
 160                 status = acpi_read(&sleep_status, &acpi_gbl_FADT.sleep_status);
 161                 if (ACPI_FAILURE(status)) {
 162                         return_ACPI_STATUS(status);
 163                 }
 164
 165         } while (!(((u8)sleep_status) & ACPI_X_WAKE_STATUS));
 166
 167         return_ACPI_STATUS(AE_OK);
 168 }
 169
 170 /*******************************************************************************
 171  *
 172  * FUNCTION:    acpi_hw_extended_wake_prep
 173  *
 174  * PARAMETERS:  sleep_state         - Which sleep state we just exited
 175  *              flags               - ACPI_EXECUTE_BFS to run optional method
 176  *
 177  * RETURN:      Status
 178  *
 179  * DESCRIPTION: Perform first part of OS-independent ACPI cleanup after
 180  *              a sleep. Called with interrupts ENABLED.
 181  *
 182  ******************************************************************************/
 183
 184 acpi_status acpi_hw_extended_wake_prep(u8 sleep_state, u8 flags)
 185 {
 186         acpi_status status;
 187         u8 sleep_type_value;
 188
 189         ACPI_FUNCTION_TRACE(hw_extended_wake_prep);
 190
 191         status = acpi_get_sleep_type_data(ACPI_STATE_S0,
 192                                           &acpi_gbl_sleep_type_a,
 193                                           &acpi_gbl_sleep_type_b);
 194         if (ACPI_SUCCESS(status)) {
 195                 sleep_type_value =
 196                     ((acpi_gbl_sleep_type_a << ACPI_X_SLEEP_TYPE_POSITION) &
 197                      ACPI_X_SLEEP_TYPE_MASK);
 198
 199                 (void)acpi_write((u64)(sleep_type_value | ACPI_X_SLEEP_ENABLE),
 200                                  &acpi_gbl_FADT.sleep_control);
 201         }
 202
 203         /* Optionally execute _BFS (Back From Sleep) */
 204
 205         if (flags & ACPI_EXECUTE_BFS) {
 206                 acpi_hw_execute_sleep_method(METHOD_PATHNAME__BFS, sleep_state);
 207         }
 208         return_ACPI_STATUS(AE_OK);
 209 }
 210
 211 /*******************************************************************************
 212  *
 213  * FUNCTION:    acpi_hw_extended_wake
 214  *
 215  * PARAMETERS:  sleep_state         - Which sleep state we just exited
 216  *              flags               - Reserved, set to zero
 217  *
 218  * RETURN:      Status
 219  *
 220  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
 221  *              Called with interrupts ENABLED.
 222  *
 223  ******************************************************************************/
 224
 225 acpi_status acpi_hw_extended_wake(u8 sleep_state, u8 flags)
 226 {
 227         ACPI_FUNCTION_TRACE(hw_extended_wake);
 228
 229         /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
 230
 231         acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
 232
 233         /* Execute the wake methods */
 234
 235         acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WAKING);
 236         acpi_hw_execute_sleep_method(METHOD_PATHNAME__WAK, sleep_state);
 237
 238         /*
 239          * Some BIOS code assumes that WAK_STS will be cleared on resume
 240          * and use it to determine whether the system is rebooting or
 241          * resuming. Clear WAK_STS for compatibility.
 242          */
 243         (void)acpi_write((u64)ACPI_X_WAKE_STATUS, &acpi_gbl_FADT.sleep_status);
 244         acpi_gbl_system_awake_and_running = TRUE;
 245
 246         acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WORKING);
 247         return_ACPI_STATUS(AE_OK);
 248 }