drivers/acpi/acpica/hwxfsleep.c

   1 /******************************************************************************
   2  *
   3  * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2012, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include "accommon.h"
  46 #include <linux/module.h>
  47
  48 #define _COMPONENT          ACPI_HARDWARE
  49 ACPI_MODULE_NAME("hwxfsleep")
  50
  51 /* Local prototypes */
  52 static acpi_status
  53 acpi_hw_sleep_dispatch(u8 sleep_state, u8 flags, u32 function_id);
  54
  55 /*
  56  * Dispatch table used to efficiently branch to the various sleep
  57  * functions.
  58  */
  59 #define ACPI_SLEEP_FUNCTION_ID         0
  60 #define ACPI_WAKE_PREP_FUNCTION_ID     1
  61 #define ACPI_WAKE_FUNCTION_ID          2
  62
  63 /* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
  64
  65 static struct acpi_sleep_functions acpi_sleep_dispatch[] = {
  66         {ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_sleep),
  67          acpi_hw_extended_sleep},
  68         {ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake_prep),
  69          acpi_hw_extended_wake_prep},
  70         {ACPI_HW_OPTIONAL_FUNCTION(acpi_hw_legacy_wake), acpi_hw_extended_wake}
  71 };
  72
  73 /*
  74  * These functions are removed for the ACPI_REDUCED_HARDWARE case:
  75  *      acpi_set_firmware_waking_vector
  76  *      acpi_set_firmware_waking_vector64
  77  *      acpi_enter_sleep_state_s4bios
  78  */
  79
  80 #if (!ACPI_REDUCED_HARDWARE)
  81 /*******************************************************************************
  82  *
  83  * FUNCTION:    acpi_set_firmware_waking_vector
  84  *
  85  * PARAMETERS:  physical_address    - 32-bit physical address of ACPI real mode
  86  *                                    entry point.
  87  *
  88  * RETURN:      Status
  89  *
  90  * DESCRIPTION: Sets the 32-bit firmware_waking_vector field of the FACS
  91  *
  92  ******************************************************************************/
  93
  94 acpi_status acpi_set_firmware_waking_vector(u32 physical_address)
  95 {
  96         ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
  97
  98
  99         /*
 100          * According to the ACPI specification 2.0c and later, the 64-bit
 101          * waking vector should be cleared and the 32-bit waking vector should
 102          * be used, unless we want the wake-up code to be called by the BIOS in
 103          * Protected Mode.  Some systems (for example HP dv5-1004nr) are known
 104          * to fail to resume if the 64-bit vector is used.
 105          */
 106
 107         /* Set the 32-bit vector */
 108
 109         acpi_gbl_FACS->firmware_waking_vector = physical_address;
 110
 111         /* Clear the 64-bit vector if it exists */
 112
 113         if ((acpi_gbl_FACS->length > 32) && (acpi_gbl_FACS->version >= 1)) {
 114                 acpi_gbl_FACS->xfirmware_waking_vector = 0;
 115         }
 116
 117         return_ACPI_STATUS(AE_OK);
 118 }
 119
 120 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
 121
 122 #if ACPI_MACHINE_WIDTH == 64
 123 /*******************************************************************************
 124  *
 125  * FUNCTION:    acpi_set_firmware_waking_vector64
 126  *
 127  * PARAMETERS:  physical_address    - 64-bit physical address of ACPI protected
 128  *                                    mode entry point.
 129  *
 130  * RETURN:      Status
 131  *
 132  * DESCRIPTION: Sets the 64-bit X_firmware_waking_vector field of the FACS, if
 133  *              it exists in the table. This function is intended for use with
 134  *              64-bit host operating systems.
 135  *
 136  ******************************************************************************/
 137 acpi_status acpi_set_firmware_waking_vector64(u64 physical_address)
 138 {
 139         ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector64);
 140
 141
 142         /* Determine if the 64-bit vector actually exists */
 143
 144         if ((acpi_gbl_FACS->length <= 32) || (acpi_gbl_FACS->version < 1)) {
 145                 return_ACPI_STATUS(AE_NOT_EXIST);
 146         }
 147
 148         /* Clear 32-bit vector, set the 64-bit X_ vector */
 149
 150         acpi_gbl_FACS->firmware_waking_vector = 0;
 151         acpi_gbl_FACS->xfirmware_waking_vector = physical_address;
 152         return_ACPI_STATUS(AE_OK);
 153 }
 154
 155 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector64)
 156 #endif
 157
 158 /*******************************************************************************
 159  *
 160  * FUNCTION:    acpi_enter_sleep_state_s4bios
 161  *
 162  * PARAMETERS:  None
 163  *
 164  * RETURN:      Status
 165  *
 166  * DESCRIPTION: Perform a S4 bios request.
 167  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
 168  *
 169  ******************************************************************************/
 170 #ifndef CONFIG_XEN
 171 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
 172 {
 173         u32 in_value;
 174         acpi_status status;
 175
 176         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
 177
 178         /* Clear the wake status bit (PM1) */
 179
 180         status =
 181             acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
 182         if (ACPI_FAILURE(status)) {
 183                 return_ACPI_STATUS(status);
 184         }
 185
 186         status = acpi_hw_clear_acpi_status();
 187         if (ACPI_FAILURE(status)) {
 188                 return_ACPI_STATUS(status);
 189         }
 190
 191         /*
 192          * 1) Disable/Clear all GPEs
 193          * 2) Enable all wakeup GPEs
 194          */
 195         status = acpi_hw_disable_all_gpes();
 196         if (ACPI_FAILURE(status)) {
 197                 return_ACPI_STATUS(status);
 198         }
 199         acpi_gbl_system_awake_and_running = FALSE;
 200
 201         status = acpi_hw_enable_all_wakeup_gpes();
 202         if (ACPI_FAILURE(status)) {
 203                 return_ACPI_STATUS(status);
 204         }
 205
 206         ACPI_FLUSH_CPU_CACHE();
 207
 208         status = acpi_hw_write_port(acpi_gbl_FADT.smi_command,
 209                                     (u32)acpi_gbl_FADT.S4bios_request, 8);
 210
 211         do {
 212                 acpi_os_stall(1000);
 213                 status =
 214                     acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
 215                 if (ACPI_FAILURE(status)) {
 216                         return_ACPI_STATUS(status);
 217                 }
 218         } while (!in_value);
 219
 220         return_ACPI_STATUS(AE_OK);
 221 }
 222
 223 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
 224 #endif
 225 #endif                          /* !ACPI_REDUCED_HARDWARE */
 226 /*******************************************************************************
 227  *
 228  * FUNCTION:    acpi_hw_sleep_dispatch
 229  *
 230  * PARAMETERS:  sleep_state         - Which sleep state to enter/exit
 231  *              function_id         - Sleep, wake_prep, or Wake
 232  *
 233  * RETURN:      Status from the invoked sleep handling function.
 234  *
 235  * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
 236  *              function.
 237  *
 238  ******************************************************************************/
 239 static acpi_status
 240 acpi_hw_sleep_dispatch(u8 sleep_state, u8 flags, u32 function_id)
 241 {
 242         acpi_status status;
 243         struct acpi_sleep_functions *sleep_functions =
 244             &acpi_sleep_dispatch[function_id];
 245
 246 #if (!ACPI_REDUCED_HARDWARE)
 247
 248         /*
 249          * If the Hardware Reduced flag is set (from the FADT), we must
 250          * use the extended sleep registers
 251          */
 252         if (acpi_gbl_reduced_hardware || acpi_gbl_FADT.sleep_control.address) {
 253                 status = sleep_functions->extended_function(sleep_state, flags);
 254         } else {
 255                 /* Legacy sleep */
 256
 257                 status = sleep_functions->legacy_function(sleep_state, flags);
 258         }
 259
 260         return (status);
 261
 262 #else
 263         /*
 264          * For the case where reduced-hardware-only code is being generated,
 265          * we know that only the extended sleep registers are available
 266          */
 267         status = sleep_functions->extended_function(sleep_state, flags);
 268         return (status);
 269
 270 #endif                          /* !ACPI_REDUCED_HARDWARE */
 271 }
 272
 273 /*******************************************************************************
 274  *
 275  * FUNCTION:    acpi_enter_sleep_state_prep
 276  *
 277  * PARAMETERS:  sleep_state         - Which sleep state to enter
 278  *
 279  * RETURN:      Status
 280  *
 281  * DESCRIPTION: Prepare to enter a system sleep state.
 282  *              This function must execute with interrupts enabled.
 283  *              We break sleeping into 2 stages so that OSPM can handle
 284  *              various OS-specific tasks between the two steps.
 285  *
 286  ******************************************************************************/
 287
 288 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
 289 {
 290         acpi_status status;
 291         struct acpi_object_list arg_list;
 292         union acpi_object arg;
 293         u32 sst_value;
 294
 295         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
 296
 297         status = acpi_get_sleep_type_data(sleep_state,
 298                                           &acpi_gbl_sleep_type_a,
 299                                           &acpi_gbl_sleep_type_b);
 300         if (ACPI_FAILURE(status)) {
 301                 return_ACPI_STATUS(status);
 302         }
 303
 304         /* Execute the _PTS method (Prepare To Sleep) */
 305
 306         arg_list.count = 1;
 307         arg_list.pointer = &arg;
 308         arg.type = ACPI_TYPE_INTEGER;
 309         arg.integer.value = sleep_state;
 310
 311         status =
 312             acpi_evaluate_object(NULL, METHOD_PATHNAME__PTS, &arg_list, NULL);
 313         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
 314                 return_ACPI_STATUS(status);
 315         }
 316
 317         /* Setup the argument to the _SST method (System STatus) */
 318
 319         switch (sleep_state) {
 320         case ACPI_STATE_S0:
 321                 sst_value = ACPI_SST_WORKING;
 322                 break;
 323
 324         case ACPI_STATE_S1:
 325         case ACPI_STATE_S2:
 326         case ACPI_STATE_S3:
 327                 sst_value = ACPI_SST_SLEEPING;
 328                 break;
 329
 330         case ACPI_STATE_S4:
 331                 sst_value = ACPI_SST_SLEEP_CONTEXT;
 332                 break;
 333
 334         default:
 335                 sst_value = ACPI_SST_INDICATOR_OFF;     /* Default is off */
 336                 break;
 337         }
 338
 339         /*
 340          * Set the system indicators to show the desired sleep state.
 341          * _SST is an optional method (return no error if not found)
 342          */
 343         acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, sst_value);
 344         return_ACPI_STATUS(AE_OK);
 345 }
 346
 347 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
 348
 349 /*******************************************************************************
 350  *
 351  * FUNCTION:    acpi_enter_sleep_state
 352  *
 353  * PARAMETERS:  sleep_state         - Which sleep state to enter
 354  *              Flags               - ACPI_EXECUTE_GTS to run optional method
 355  *
 356  * RETURN:      Status
 357  *
 358  * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
 359  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
 360  *
 361  ******************************************************************************/
 362 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state, u8 flags)
 363 {
 364         acpi_status status;
 365
 366         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
 367
 368         if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
 369             (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
 370                 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
 371                             acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
 372                 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
 373         }
 374
 375         status =
 376             acpi_hw_sleep_dispatch(sleep_state, flags, ACPI_SLEEP_FUNCTION_ID);
 377         return_ACPI_STATUS(status);
 378 }
 379
 380 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
 381
 382 /*******************************************************************************
 383  *
 384  * FUNCTION:    acpi_leave_sleep_state_prep
 385  *
 386  * PARAMETERS:  sleep_state         - Which sleep state we are exiting
 387  *              Flags               - ACPI_EXECUTE_BFS to run optional method
 388  *
 389  * RETURN:      Status
 390  *
 391  * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
 392  *              sleep.
 393  *              Called with interrupts DISABLED.
 394  *
 395  ******************************************************************************/
 396 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state, u8 flags)
 397 {
 398         acpi_status status;
 399
 400         ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
 401
 402         status =
 403             acpi_hw_sleep_dispatch(sleep_state, flags,
 404                                    ACPI_WAKE_PREP_FUNCTION_ID);
 405         return_ACPI_STATUS(status);
 406 }
 407
 408 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state_prep)
 409
 410 /*******************************************************************************
 411  *
 412  * FUNCTION:    acpi_leave_sleep_state
 413  *
 414  * PARAMETERS:  sleep_state         - Which sleep state we are exiting
 415  *
 416  * RETURN:      Status
 417  *
 418  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
 419  *              Called with interrupts ENABLED.
 420  *
 421  ******************************************************************************/
 422 acpi_status acpi_leave_sleep_state(u8 sleep_state)
 423 {
 424         acpi_status status;
 425
 426         ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
 427
 428
 429         status = acpi_hw_sleep_dispatch(sleep_state, 0, ACPI_WAKE_FUNCTION_ID);
 430         return_ACPI_STATUS(status);
 431 }
 432
 433 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)