drivers/acpi/sleep/main.c

   1 /*
   2  * sleep.c - ACPI sleep support.
   3  *
   4  * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
   5  * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com>
   6  * Copyright (c) 2000-2003 Patrick Mochel
   7  * Copyright (c) 2003 Open Source Development Lab
   8  *
   9  * This file is released under the GPLv2.
  10  *
  11  */
  12
  13 #include <linux/delay.h>
  14 #include <linux/irq.h>
  15 #include <linux/dmi.h>
  16 #include <linux/device.h>
  17 #include <linux/suspend.h>
  18
  19 #include <asm/io.h>
  20
  21 #include <acpi/acpi_bus.h>
  22 #include <acpi/acpi_drivers.h>
  23 #include "sleep.h"
  24
  25 u8 sleep_states[ACPI_S_STATE_COUNT];
  26
  27 #ifdef CONFIG_PM_SLEEP
  28 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
  29 #endif
  30
  31 int acpi_sleep_prepare(u32 acpi_state)
  32 {
  33 #ifdef CONFIG_ACPI_SLEEP
  34         /* do we have a wakeup address for S2 and S3? */
  35         if (acpi_state == ACPI_STATE_S3) {
  36                 if (!acpi_wakeup_address) {
  37                         return -EFAULT;
  38                 }
  39                 acpi_set_firmware_waking_vector((acpi_physical_address)
  40                                                 virt_to_phys((void *)
  41                                                              acpi_wakeup_address));
  42
  43         }
  44         ACPI_FLUSH_CPU_CACHE();
  45         acpi_enable_wakeup_device_prep(acpi_state);
  46 #endif
  47         acpi_enter_sleep_state_prep(acpi_state);
  48         return 0;
  49 }
  50
  51 #ifdef CONFIG_SUSPEND
  52 static struct platform_suspend_ops acpi_pm_ops;
  53
  54 extern void do_suspend_lowlevel(void);
  55
  56 static u32 acpi_suspend_states[] = {
  57         [PM_SUSPEND_ON] = ACPI_STATE_S0,
  58         [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
  59         [PM_SUSPEND_MEM] = ACPI_STATE_S3,
  60         [PM_SUSPEND_MAX] = ACPI_STATE_S5
  61 };
  62
  63 static int init_8259A_after_S1;
  64
  65 /**
  66  *      acpi_pm_set_target - Set the target system sleep state to the state
  67  *              associated with given @pm_state, if supported.
  68  */
  69
  70 static int acpi_pm_set_target(suspend_state_t pm_state)
  71 {
  72         u32 acpi_state = acpi_suspend_states[pm_state];
  73         int error = 0;
  74
  75         if (sleep_states[acpi_state]) {
  76                 acpi_target_sleep_state = acpi_state;
  77         } else {
  78                 printk(KERN_ERR "ACPI does not support this state: %d\n",
  79                         pm_state);
  80                 error = -ENOSYS;
  81         }
  82         return error;
  83 }
  84
  85 /**
  86  *      acpi_pm_prepare - Do preliminary suspend work.
  87  *
  88  *      If necessary, set the firmware waking vector and do arch-specific
  89  *      nastiness to get the wakeup code to the waking vector.
  90  */
  91
  92 static int acpi_pm_prepare(void)
  93 {
  94         int error = acpi_sleep_prepare(acpi_target_sleep_state);
  95
  96         if (error)
  97                 acpi_target_sleep_state = ACPI_STATE_S0;
  98
  99         return error;
 100 }
 101
 102 /**
 103  *      acpi_pm_enter - Actually enter a sleep state.
 104  *      @pm_state: ignored
 105  *
 106  *      Flush caches and go to sleep. For STR we have to call arch-specific
 107  *      assembly, which in turn call acpi_enter_sleep_state().
 108  *      It's unfortunate, but it works. Please fix if you're feeling frisky.
 109  */
 110
 111 static int acpi_pm_enter(suspend_state_t pm_state)
 112 {
 113         acpi_status status = AE_OK;
 114         unsigned long flags = 0;
 115         u32 acpi_state = acpi_target_sleep_state;
 116
 117         ACPI_FLUSH_CPU_CACHE();
 118
 119         /* Do arch specific saving of state. */
 120         if (acpi_state == ACPI_STATE_S3) {
 121                 int error = acpi_save_state_mem();
 122
 123                 if (error) {
 124                         acpi_target_sleep_state = ACPI_STATE_S0;
 125                         return error;
 126                 }
 127         }
 128
 129         local_irq_save(flags);
 130         acpi_enable_wakeup_device(acpi_state);
 131         switch (acpi_state) {
 132         case ACPI_STATE_S1:
 133                 barrier();
 134                 status = acpi_enter_sleep_state(acpi_state);
 135                 break;
 136
 137         case ACPI_STATE_S3:
 138                 do_suspend_lowlevel();
 139                 break;
 140         }
 141
 142         /* ACPI 3.0 specs (P62) says that it's the responsabilty
 143          * of the OSPM to clear the status bit [ implying that the
 144          * POWER_BUTTON event should not reach userspace ]
 145          */
 146         if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
 147                 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
 148
 149         /*
 150          * Disable and clear GPE status before interrupt is enabled. Some GPEs
 151          * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
 152          * acpi_leave_sleep_state will reenable specific GPEs later
 153          */
 154         acpi_hw_disable_all_gpes();
 155
 156         local_irq_restore(flags);
 157         printk(KERN_DEBUG "Back to C!\n");
 158
 159         /* restore processor state */
 160         if (acpi_state == ACPI_STATE_S3)
 161                 acpi_restore_state_mem();
 162
 163         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 164 }
 165
 166 /**
 167  *      acpi_pm_finish - Finish up suspend sequence.
 168  *
 169  *      This is called after we wake back up (or if entering the sleep state
 170  *      failed).
 171  */
 172
 173 static void acpi_pm_finish(void)
 174 {
 175         u32 acpi_state = acpi_target_sleep_state;
 176
 177         acpi_disable_wakeup_device(acpi_state);
 178         acpi_leave_sleep_state(acpi_state);
 179
 180         /* reset firmware waking vector */
 181         acpi_set_firmware_waking_vector((acpi_physical_address) 0);
 182
 183         acpi_target_sleep_state = ACPI_STATE_S0;
 184
 185 #ifdef CONFIG_X86
 186         if (init_8259A_after_S1) {
 187                 printk("Broken toshiba laptop -> kicking interrupts\n");
 188                 init_8259A(0);
 189         }
 190 #endif
 191 }
 192
 193 static int acpi_pm_state_valid(suspend_state_t pm_state)
 194 {
 195         u32 acpi_state;
 196
 197         switch (pm_state) {
 198         case PM_SUSPEND_ON:
 199         case PM_SUSPEND_STANDBY:
 200         case PM_SUSPEND_MEM:
 201                 acpi_state = acpi_suspend_states[pm_state];
 202
 203                 return sleep_states[acpi_state];
 204         default:
 205                 return 0;
 206         }
 207 }
 208
 209 static struct platform_suspend_ops acpi_pm_ops = {
 210         .valid = acpi_pm_state_valid,
 211         .set_target = acpi_pm_set_target,
 212         .prepare = acpi_pm_prepare,
 213         .enter = acpi_pm_enter,
 214         .finish = acpi_pm_finish,
 215 };
 216
 217 /*
 218  * Toshiba fails to preserve interrupts over S1, reinitialization
 219  * of 8259 is needed after S1 resume.
 220  */
 221 static int __init init_ints_after_s1(const struct dmi_system_id *d)
 222 {
 223         printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
 224         init_8259A_after_S1 = 1;
 225         return 0;
 226 }
 227
 228 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
 229         {
 230          .callback = init_ints_after_s1,
 231          .ident = "Toshiba Satellite 4030cdt",
 232          .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
 233          },
 234         {},
 235 };
 236 #endif /* CONFIG_SUSPEND */
 237
 238 #ifdef CONFIG_HIBERNATION
 239 static int acpi_hibernation_start(void)
 240 {
 241         acpi_target_sleep_state = ACPI_STATE_S4;
 242         return 0;
 243 }
 244
 245 static int acpi_hibernation_prepare(void)
 246 {
 247         return acpi_sleep_prepare(ACPI_STATE_S4);
 248 }
 249
 250 static int acpi_hibernation_enter(void)
 251 {
 252         acpi_status status = AE_OK;
 253         unsigned long flags = 0;
 254
 255         ACPI_FLUSH_CPU_CACHE();
 256
 257         local_irq_save(flags);
 258         acpi_enable_wakeup_device(ACPI_STATE_S4);
 259         /* This shouldn't return.  If it returns, we have a problem */
 260         status = acpi_enter_sleep_state(ACPI_STATE_S4);
 261         local_irq_restore(flags);
 262
 263         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 264 }
 265
 266 static void acpi_hibernation_leave(void)
 267 {
 268         /*
 269          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
 270          * enable it here.
 271          */
 272         acpi_enable();
 273 }
 274
 275 static void acpi_hibernation_finish(void)
 276 {
 277         acpi_disable_wakeup_device(ACPI_STATE_S4);
 278         acpi_leave_sleep_state(ACPI_STATE_S4);
 279
 280         /* reset firmware waking vector */
 281         acpi_set_firmware_waking_vector((acpi_physical_address) 0);
 282
 283         acpi_target_sleep_state = ACPI_STATE_S0;
 284 }
 285
 286 static int acpi_hibernation_pre_restore(void)
 287 {
 288         acpi_status status;
 289
 290         status = acpi_hw_disable_all_gpes();
 291
 292         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 293 }
 294
 295 static void acpi_hibernation_restore_cleanup(void)
 296 {
 297         acpi_hw_enable_all_runtime_gpes();
 298 }
 299
 300 static struct platform_hibernation_ops acpi_hibernation_ops = {
 301         .start = acpi_hibernation_start,
 302         .pre_snapshot = acpi_hibernation_prepare,
 303         .finish = acpi_hibernation_finish,
 304         .prepare = acpi_hibernation_prepare,
 305         .enter = acpi_hibernation_enter,
 306         .leave = acpi_hibernation_leave,
 307         .pre_restore = acpi_hibernation_pre_restore,
 308         .restore_cleanup = acpi_hibernation_restore_cleanup,
 309 };
 310 #endif                          /* CONFIG_HIBERNATION */
 311
 312 int acpi_suspend(u32 acpi_state)
 313 {
 314         suspend_state_t states[] = {
 315                 [1] = PM_SUSPEND_STANDBY,
 316                 [3] = PM_SUSPEND_MEM,
 317                 [5] = PM_SUSPEND_MAX
 318         };
 319
 320         if (acpi_state < 6 && states[acpi_state])
 321                 return pm_suspend(states[acpi_state]);
 322         if (acpi_state == 4)
 323                 return hibernate();
 324         return -EINVAL;
 325 }
 326
 327 #ifdef CONFIG_PM_SLEEP
 328 /**
 329  *      acpi_pm_device_sleep_state - return preferred power state of ACPI device
 330  *              in the system sleep state given by %acpi_target_sleep_state
 331  *      @dev: device to examine
 332  *      @wake: if set, the device should be able to wake up the system
 333  *      @d_min_p: used to store the upper limit of allowed states range
 334  *      Return value: preferred power state of the device on success, -ENODEV on
 335  *              failure (ie. if there's no 'struct acpi_device' for @dev)
 336  *
 337  *      Find the lowest power (highest number) ACPI device power state that
 338  *      device @dev can be in while the system is in the sleep state represented
 339  *      by %acpi_target_sleep_state.  If @wake is nonzero, the device should be
 340  *      able to wake up the system from this sleep state.  If @d_min_p is set,
 341  *      the highest power (lowest number) device power state of @dev allowed
 342  *      in this system sleep state is stored at the location pointed to by it.
 343  *
 344  *      The caller must ensure that @dev is valid before using this function.
 345  *      The caller is also responsible for figuring out if the device is
 346  *      supposed to be able to wake up the system and passing this information
 347  *      via @wake.
 348  */
 349
 350 int acpi_pm_device_sleep_state(struct device *dev, int wake, int *d_min_p)
 351 {
 352         acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
 353         struct acpi_device *adev;
 354         char acpi_method[] = "_SxD";
 355         unsigned long d_min, d_max;
 356
 357         if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
 358                 printk(KERN_DEBUG "ACPI handle has no context!\n");
 359                 return -ENODEV;
 360         }
 361
 362         acpi_method[2] = '0' + acpi_target_sleep_state;
 363         /*
 364          * If the sleep state is S0, we will return D3, but if the device has
 365          * _S0W, we will use the value from _S0W
 366          */
 367         d_min = ACPI_STATE_D0;
 368         d_max = ACPI_STATE_D3;
 369
 370         /*
 371          * If present, _SxD methods return the minimum D-state (highest power
 372          * state) we can use for the corresponding S-states.  Otherwise, the
 373          * minimum D-state is D0 (ACPI 3.x).
 374          *
 375          * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
 376          * provided -- that's our fault recovery, we ignore retval.
 377          */
 378         if (acpi_target_sleep_state > ACPI_STATE_S0)
 379                 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
 380
 381         /*
 382          * If _PRW says we can wake up the system from the target sleep state,
 383          * the D-state returned by _SxD is sufficient for that (we assume a
 384          * wakeup-aware driver if wake is set).  Still, if _SxW exists
 385          * (ACPI 3.x), it should return the maximum (lowest power) D-state that
 386          * can wake the system.  _S0W may be valid, too.
 387          */
 388         if (acpi_target_sleep_state == ACPI_STATE_S0 ||
 389             (wake && adev->wakeup.state.enabled &&
 390              adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
 391                 acpi_method[3] = 'W';
 392                 acpi_evaluate_integer(handle, acpi_method, NULL, &d_max);
 393                 /* Sanity check */
 394                 if (d_max < d_min)
 395                         d_min = d_max;
 396         }
 397
 398         if (d_min_p)
 399                 *d_min_p = d_min;
 400         return d_max;
 401 }
 402 #endif
 403
 404 static void acpi_power_off_prepare(void)
 405 {
 406         /* Prepare to power off the system */
 407         acpi_sleep_prepare(ACPI_STATE_S5);
 408 }
 409
 410 static void acpi_power_off(void)
 411 {
 412         /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
 413         printk("%s called\n", __FUNCTION__);
 414         local_irq_disable();
 415         acpi_enable_wakeup_device(ACPI_STATE_S5);
 416         acpi_enter_sleep_state(ACPI_STATE_S5);
 417 }
 418
 419 int __init acpi_sleep_init(void)
 420 {
 421         acpi_status status;
 422         u8 type_a, type_b;
 423 #ifdef CONFIG_SUSPEND
 424         int i = 0;
 425
 426         dmi_check_system(acpisleep_dmi_table);
 427 #endif
 428
 429         if (acpi_disabled)
 430                 return 0;
 431
 432         sleep_states[ACPI_STATE_S0] = 1;
 433         printk(KERN_INFO PREFIX "(supports S0");
 434
 435 #ifdef CONFIG_SUSPEND
 436         for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
 437                 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
 438                 if (ACPI_SUCCESS(status)) {
 439                         sleep_states[i] = 1;
 440                         printk(" S%d", i);
 441                 }
 442         }
 443
 444         suspend_set_ops(&acpi_pm_ops);
 445 #endif
 446
 447 #ifdef CONFIG_HIBERNATION
 448         status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
 449         if (ACPI_SUCCESS(status)) {
 450                 hibernation_set_ops(&acpi_hibernation_ops);
 451                 sleep_states[ACPI_STATE_S4] = 1;
 452                 printk(" S4");
 453         }
 454 #endif
 455         status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
 456         if (ACPI_SUCCESS(status)) {
 457                 sleep_states[ACPI_STATE_S5] = 1;
 458                 printk(" S5");
 459                 pm_power_off_prepare = acpi_power_off_prepare;
 460                 pm_power_off = acpi_power_off;
 461         }
 462         printk(")\n");
 463         return 0;
 464 }