Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[linux-2.6] / drivers / acpi / hardware / hwsleep.c
1
2 /******************************************************************************
3  *
4  * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
5  *
6  *****************************************************************************/
7
8 /*
9  * Copyright (C) 2000 - 2007, R. Byron Moore
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 <acpi/actables.h>
47
48 #define _COMPONENT          ACPI_HARDWARE
49 ACPI_MODULE_NAME("hwsleep")
50
51 /*******************************************************************************
52  *
53  * FUNCTION:    acpi_set_firmware_waking_vector
54  *
55  * PARAMETERS:  physical_address    - Physical address of ACPI real mode
56  *                                    entry point.
57  *
58  * RETURN:      Status
59  *
60  * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
61  *
62  ******************************************************************************/
63 acpi_status
64 acpi_set_firmware_waking_vector(acpi_physical_address physical_address)
65 {
66         struct acpi_table_facs *facs;
67         acpi_status status;
68
69         ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
70
71         /* Get the FACS */
72
73         status =
74             acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS,
75                                     (struct acpi_table_header **)&facs);
76         if (ACPI_FAILURE(status)) {
77                 return_ACPI_STATUS(status);
78         }
79
80         /* Set the vector */
81
82         if ((facs->length < 32) || (!(facs->xfirmware_waking_vector))) {
83                 /*
84                  * ACPI 1.0 FACS or short table or optional X_ field is zero
85                  */
86                 facs->firmware_waking_vector = (u32) physical_address;
87         } else {
88                 /*
89                  * ACPI 2.0 FACS with valid X_ field
90                  */
91                 facs->xfirmware_waking_vector = physical_address;
92         }
93
94         return_ACPI_STATUS(AE_OK);
95 }
96
97 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
98
99 /*******************************************************************************
100  *
101  * FUNCTION:    acpi_get_firmware_waking_vector
102  *
103  * PARAMETERS:  *physical_address   - Where the contents of
104  *                                    the firmware_waking_vector field of
105  *                                    the FACS will be returned.
106  *
107  * RETURN:      Status, vector
108  *
109  * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
110  *
111  ******************************************************************************/
112 #ifdef ACPI_FUTURE_USAGE
113 acpi_status
114 acpi_get_firmware_waking_vector(acpi_physical_address * physical_address)
115 {
116         struct acpi_table_facs *facs;
117         acpi_status status;
118
119         ACPI_FUNCTION_TRACE(acpi_get_firmware_waking_vector);
120
121         if (!physical_address) {
122                 return_ACPI_STATUS(AE_BAD_PARAMETER);
123         }
124
125         /* Get the FACS */
126
127         status =
128             acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS,
129                                     (struct acpi_table_header **)&facs);
130         if (ACPI_FAILURE(status)) {
131                 return_ACPI_STATUS(status);
132         }
133
134         /* Get the vector */
135
136         if ((facs->length < 32) || (!(facs->xfirmware_waking_vector))) {
137                 /*
138                  * ACPI 1.0 FACS or short table or optional X_ field is zero
139                  */
140                 *physical_address =
141                     (acpi_physical_address) facs->firmware_waking_vector;
142         } else {
143                 /*
144                  * ACPI 2.0 FACS with valid X_ field
145                  */
146                 *physical_address =
147                     (acpi_physical_address) facs->xfirmware_waking_vector;
148         }
149
150         return_ACPI_STATUS(AE_OK);
151 }
152
153 ACPI_EXPORT_SYMBOL(acpi_get_firmware_waking_vector)
154 #endif
155
156 /*******************************************************************************
157  *
158  * FUNCTION:    acpi_enter_sleep_state_prep
159  *
160  * PARAMETERS:  sleep_state         - Which sleep state to enter
161  *
162  * RETURN:      Status
163  *
164  * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
165  *              This function must execute with interrupts enabled.
166  *              We break sleeping into 2 stages so that OSPM can handle
167  *              various OS-specific tasks between the two steps.
168  *
169  ******************************************************************************/
170 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
171 {
172         acpi_status status;
173         struct acpi_object_list arg_list;
174         union acpi_object arg;
175
176         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
177
178         /*
179          * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
180          */
181         status = acpi_get_sleep_type_data(sleep_state,
182                                           &acpi_gbl_sleep_type_a,
183                                           &acpi_gbl_sleep_type_b);
184         if (ACPI_FAILURE(status)) {
185                 return_ACPI_STATUS(status);
186         }
187
188         /* Setup parameter object */
189
190         arg_list.count = 1;
191         arg_list.pointer = &arg;
192
193         arg.type = ACPI_TYPE_INTEGER;
194         arg.integer.value = sleep_state;
195
196         /* Run the _PTS and _GTS methods */
197
198         status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
199         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
200                 return_ACPI_STATUS(status);
201         }
202
203         status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
204         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
205                 return_ACPI_STATUS(status);
206         }
207
208         /* Setup the argument to _SST */
209
210         switch (sleep_state) {
211         case ACPI_STATE_S0:
212                 arg.integer.value = ACPI_SST_WORKING;
213                 break;
214
215         case ACPI_STATE_S1:
216         case ACPI_STATE_S2:
217         case ACPI_STATE_S3:
218                 arg.integer.value = ACPI_SST_SLEEPING;
219                 break;
220
221         case ACPI_STATE_S4:
222                 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
223                 break;
224
225         default:
226                 arg.integer.value = ACPI_SST_INDICATOR_OFF;     /* Default is off */
227                 break;
228         }
229
230         /* Set the system indicators to show the desired sleep state. */
231
232         status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
233         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
234                 ACPI_EXCEPTION((AE_INFO, status,
235                                 "While executing method _SST"));
236         }
237
238         return_ACPI_STATUS(AE_OK);
239 }
240
241 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
242
243 /*******************************************************************************
244  *
245  * FUNCTION:    acpi_enter_sleep_state
246  *
247  * PARAMETERS:  sleep_state         - Which sleep state to enter
248  *
249  * RETURN:      Status
250  *
251  * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
252  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
253  *
254  ******************************************************************************/
255 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
256 {
257         u32 PM1Acontrol;
258         u32 PM1Bcontrol;
259         struct acpi_bit_register_info *sleep_type_reg_info;
260         struct acpi_bit_register_info *sleep_enable_reg_info;
261         u32 in_value;
262         acpi_status status;
263
264         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
265
266         if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
267             (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
268                 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=%X B=%X",
269                             acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
270                 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
271         }
272
273         sleep_type_reg_info =
274             acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
275         sleep_enable_reg_info =
276             acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
277
278         /* Clear wake status */
279
280         status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
281         if (ACPI_FAILURE(status)) {
282                 return_ACPI_STATUS(status);
283         }
284
285         /* Clear all fixed and general purpose status bits */
286
287         status = acpi_hw_clear_acpi_status();
288         if (ACPI_FAILURE(status)) {
289                 return_ACPI_STATUS(status);
290         }
291
292         /*
293          * 1) Disable/Clear all GPEs
294          * 2) Enable all wakeup GPEs
295          */
296         status = acpi_hw_disable_all_gpes();
297         if (ACPI_FAILURE(status)) {
298                 return_ACPI_STATUS(status);
299         }
300         acpi_gbl_system_awake_and_running = FALSE;
301
302         status = acpi_hw_enable_all_wakeup_gpes();
303         if (ACPI_FAILURE(status)) {
304                 return_ACPI_STATUS(status);
305         }
306
307         /* Get current value of PM1A control */
308
309         status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
310                                        ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
311         if (ACPI_FAILURE(status)) {
312                 return_ACPI_STATUS(status);
313         }
314         ACPI_DEBUG_PRINT((ACPI_DB_INIT,
315                           "Entering sleep state [S%d]\n", sleep_state));
316
317         /* Clear SLP_EN and SLP_TYP fields */
318
319         PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
320                          sleep_enable_reg_info->access_bit_mask);
321         PM1Bcontrol = PM1Acontrol;
322
323         /* Insert SLP_TYP bits */
324
325         PM1Acontrol |=
326             (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
327         PM1Bcontrol |=
328             (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
329
330         /*
331          * We split the writes of SLP_TYP and SLP_EN to workaround
332          * poorly implemented hardware.
333          */
334
335         /* Write #1: fill in SLP_TYP data */
336
337         status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
338                                         ACPI_REGISTER_PM1A_CONTROL,
339                                         PM1Acontrol);
340         if (ACPI_FAILURE(status)) {
341                 return_ACPI_STATUS(status);
342         }
343
344         status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
345                                         ACPI_REGISTER_PM1B_CONTROL,
346                                         PM1Bcontrol);
347         if (ACPI_FAILURE(status)) {
348                 return_ACPI_STATUS(status);
349         }
350
351         /* Insert SLP_ENABLE bit */
352
353         PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
354         PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
355
356         /* Write #2: SLP_TYP + SLP_EN */
357
358         ACPI_FLUSH_CPU_CACHE();
359
360         status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
361                                         ACPI_REGISTER_PM1A_CONTROL,
362                                         PM1Acontrol);
363         if (ACPI_FAILURE(status)) {
364                 return_ACPI_STATUS(status);
365         }
366
367         status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
368                                         ACPI_REGISTER_PM1B_CONTROL,
369                                         PM1Bcontrol);
370         if (ACPI_FAILURE(status)) {
371                 return_ACPI_STATUS(status);
372         }
373
374         if (sleep_state > ACPI_STATE_S3) {
375                 /*
376                  * We wanted to sleep > S3, but it didn't happen (by virtue of the
377                  * fact that we are still executing!)
378                  *
379                  * Wait ten seconds, then try again. This is to get S4/S5 to work on
380                  * all machines.
381                  *
382                  * We wait so long to allow chipsets that poll this reg very slowly to
383                  * still read the right value. Ideally, this block would go
384                  * away entirely.
385                  */
386                 acpi_os_stall(10000000);
387
388                 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
389                                                 ACPI_REGISTER_PM1_CONTROL,
390                                                 sleep_enable_reg_info->
391                                                 access_bit_mask);
392                 if (ACPI_FAILURE(status)) {
393                         return_ACPI_STATUS(status);
394                 }
395         }
396
397         /* Wait until we enter sleep state */
398
399         do {
400                 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value);
401                 if (ACPI_FAILURE(status)) {
402                         return_ACPI_STATUS(status);
403                 }
404
405                 /* Spin until we wake */
406
407         } while (!in_value);
408
409         return_ACPI_STATUS(AE_OK);
410 }
411
412 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
413
414 /*******************************************************************************
415  *
416  * FUNCTION:    acpi_enter_sleep_state_s4bios
417  *
418  * PARAMETERS:  None
419  *
420  * RETURN:      Status
421  *
422  * DESCRIPTION: Perform a S4 bios request.
423  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
424  *
425  ******************************************************************************/
426 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
427 {
428         u32 in_value;
429         acpi_status status;
430
431         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
432
433         status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
434         if (ACPI_FAILURE(status)) {
435                 return_ACPI_STATUS(status);
436         }
437
438         status = acpi_hw_clear_acpi_status();
439         if (ACPI_FAILURE(status)) {
440                 return_ACPI_STATUS(status);
441         }
442
443         /*
444          * 1) Disable/Clear all GPEs
445          * 2) Enable all wakeup GPEs
446          */
447         status = acpi_hw_disable_all_gpes();
448         if (ACPI_FAILURE(status)) {
449                 return_ACPI_STATUS(status);
450         }
451         acpi_gbl_system_awake_and_running = FALSE;
452
453         status = acpi_hw_enable_all_wakeup_gpes();
454         if (ACPI_FAILURE(status)) {
455                 return_ACPI_STATUS(status);
456         }
457
458         ACPI_FLUSH_CPU_CACHE();
459
460         status = acpi_os_write_port(acpi_gbl_FADT.smi_command,
461                                     (u32) acpi_gbl_FADT.S4bios_request, 8);
462
463         do {
464                 acpi_os_stall(1000);
465                 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value);
466                 if (ACPI_FAILURE(status)) {
467                         return_ACPI_STATUS(status);
468                 }
469         } while (!in_value);
470
471         return_ACPI_STATUS(AE_OK);
472 }
473
474 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
475
476 /*******************************************************************************
477  *
478  * FUNCTION:    acpi_leave_sleep_state
479  *
480  * PARAMETERS:  sleep_state         - Which sleep state we just exited
481  *
482  * RETURN:      Status
483  *
484  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
485  *              Called with interrupts ENABLED.
486  *
487  ******************************************************************************/
488 acpi_status acpi_leave_sleep_state(u8 sleep_state)
489 {
490         struct acpi_object_list arg_list;
491         union acpi_object arg;
492         acpi_status status;
493         struct acpi_bit_register_info *sleep_type_reg_info;
494         struct acpi_bit_register_info *sleep_enable_reg_info;
495         u32 PM1Acontrol;
496         u32 PM1Bcontrol;
497
498         ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
499
500         /*
501          * Set SLP_TYPE and SLP_EN to state S0.
502          * This is unclear from the ACPI Spec, but it is required
503          * by some machines.
504          */
505         status = acpi_get_sleep_type_data(ACPI_STATE_S0,
506                                           &acpi_gbl_sleep_type_a,
507                                           &acpi_gbl_sleep_type_b);
508         if (ACPI_SUCCESS(status)) {
509                 sleep_type_reg_info =
510                     acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
511                 sleep_enable_reg_info =
512                     acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
513
514                 /* Get current value of PM1A control */
515
516                 status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
517                                                ACPI_REGISTER_PM1_CONTROL,
518                                                &PM1Acontrol);
519                 if (ACPI_SUCCESS(status)) {
520
521                         /* Clear SLP_EN and SLP_TYP fields */
522
523                         PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
524                                          sleep_enable_reg_info->
525                                          access_bit_mask);
526                         PM1Bcontrol = PM1Acontrol;
527
528                         /* Insert SLP_TYP bits */
529
530                         PM1Acontrol |=
531                             (acpi_gbl_sleep_type_a << sleep_type_reg_info->
532                              bit_position);
533                         PM1Bcontrol |=
534                             (acpi_gbl_sleep_type_b << sleep_type_reg_info->
535                              bit_position);
536
537                         /* Just ignore any errors */
538
539                         (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
540                                                      ACPI_REGISTER_PM1A_CONTROL,
541                                                      PM1Acontrol);
542                         (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
543                                                      ACPI_REGISTER_PM1B_CONTROL,
544                                                      PM1Bcontrol);
545                 }
546         }
547
548         /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
549
550         acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
551
552         /* Setup parameter object */
553
554         arg_list.count = 1;
555         arg_list.pointer = &arg;
556         arg.type = ACPI_TYPE_INTEGER;
557
558         /* Ignore any errors from these methods */
559
560         arg.integer.value = ACPI_SST_WAKING;
561         status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
562         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
563                 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
564         }
565
566         arg.integer.value = sleep_state;
567         status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
568         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
569                 ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
570         }
571
572         status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
573         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
574                 ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
575         }
576         /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
577
578         /*
579          * Restore the GPEs:
580          * 1) Disable/Clear all GPEs
581          * 2) Enable all runtime GPEs
582          */
583         status = acpi_hw_disable_all_gpes();
584         if (ACPI_FAILURE(status)) {
585                 return_ACPI_STATUS(status);
586         }
587         acpi_gbl_system_awake_and_running = TRUE;
588
589         status = acpi_hw_enable_all_runtime_gpes();
590         if (ACPI_FAILURE(status)) {
591                 return_ACPI_STATUS(status);
592         }
593
594         /* Enable power button */
595
596         (void)
597             acpi_set_register(acpi_gbl_fixed_event_info
598                               [ACPI_EVENT_POWER_BUTTON].enable_register_id, 1);
599
600         (void)
601             acpi_set_register(acpi_gbl_fixed_event_info
602                               [ACPI_EVENT_POWER_BUTTON].status_register_id, 1);
603
604         arg.integer.value = ACPI_SST_WORKING;
605         status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
606         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
607                 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
608         }
609
610         return_ACPI_STATUS(status);
611 }
612
613 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)