]> err.no Git - linux-2.6/blob - drivers/acpi/hardware/hwsleep.c
ACPICA: hw: remove use_lock flag from acpi_hw_register_{read, write}
[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  * FUNCTION:    acpi_enter_sleep_state_prep
158  *
159  * PARAMETERS:  sleep_state         - Which sleep state to enter
160  *
161  * RETURN:      Status
162  *
163  * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
164  *              This function must execute with interrupts enabled.
165  *              We break sleeping into 2 stages so that OSPM can handle
166  *              various OS-specific tasks between the two steps.
167  *
168  ******************************************************************************/
169 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
170 {
171         acpi_status status;
172         struct acpi_object_list arg_list;
173         union acpi_object arg;
174
175         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
176
177         /*
178          * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
179          */
180         status = acpi_get_sleep_type_data(sleep_state,
181                                           &acpi_gbl_sleep_type_a,
182                                           &acpi_gbl_sleep_type_b);
183         if (ACPI_FAILURE(status)) {
184                 return_ACPI_STATUS(status);
185         }
186
187         /* Setup parameter object */
188
189         arg_list.count = 1;
190         arg_list.pointer = &arg;
191
192         arg.type = ACPI_TYPE_INTEGER;
193         arg.integer.value = sleep_state;
194
195         /* Run the _PTS and _GTS methods */
196
197         status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
198         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
199                 return_ACPI_STATUS(status);
200         }
201
202         status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
203         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
204                 return_ACPI_STATUS(status);
205         }
206
207         /* Setup the argument to _SST */
208
209         switch (sleep_state) {
210         case ACPI_STATE_S0:
211                 arg.integer.value = ACPI_SST_WORKING;
212                 break;
213
214         case ACPI_STATE_S1:
215         case ACPI_STATE_S2:
216         case ACPI_STATE_S3:
217                 arg.integer.value = ACPI_SST_SLEEPING;
218                 break;
219
220         case ACPI_STATE_S4:
221                 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
222                 break;
223
224         default:
225                 arg.integer.value = ACPI_SST_INDICATOR_OFF;     /* Default is off */
226                 break;
227         }
228
229         /* Set the system indicators to show the desired sleep state. */
230
231         status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
232         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
233                 ACPI_EXCEPTION((AE_INFO, status,
234                                 "While executing method _SST"));
235         }
236
237         /*
238          * 1) Disable/Clear all GPEs
239          */
240         status = acpi_hw_disable_all_gpes();
241         if (ACPI_FAILURE(status)) {
242                 return_ACPI_STATUS(status);
243         }
244
245         return_ACPI_STATUS(AE_OK);
246 }
247
248 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
249
250 /*******************************************************************************
251  *
252  * FUNCTION:    acpi_enter_sleep_state
253  *
254  * PARAMETERS:  sleep_state         - Which sleep state to enter
255  *
256  * RETURN:      Status
257  *
258  * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
259  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
260  *
261  ******************************************************************************/
262 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
263 {
264         u32 PM1Acontrol;
265         u32 PM1Bcontrol;
266         struct acpi_bit_register_info *sleep_type_reg_info;
267         struct acpi_bit_register_info *sleep_enable_reg_info;
268         u32 in_value;
269         acpi_status status;
270
271         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
272
273         if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
274             (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
275                 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=%X B=%X",
276                             acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
277                 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
278         }
279
280         sleep_type_reg_info =
281             acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
282         sleep_enable_reg_info =
283             acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
284
285         /* Clear wake status */
286
287         status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
288         if (ACPI_FAILURE(status)) {
289                 return_ACPI_STATUS(status);
290         }
291
292         /* Clear all fixed and general purpose status bits */
293
294         status = acpi_hw_clear_acpi_status();
295         if (ACPI_FAILURE(status)) {
296                 return_ACPI_STATUS(status);
297         }
298
299         /*
300          * 2) Enable all wakeup GPEs
301          */
302         status = acpi_hw_disable_all_gpes();
303         if (ACPI_FAILURE(status)) {
304                 return_ACPI_STATUS(status);
305         }
306
307         acpi_gbl_system_awake_and_running = FALSE;
308
309         status = acpi_hw_enable_all_wakeup_gpes();
310         if (ACPI_FAILURE(status)) {
311                 return_ACPI_STATUS(status);
312         }
313
314         /* Get current value of PM1A control */
315
316         status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
317         if (ACPI_FAILURE(status)) {
318                 return_ACPI_STATUS(status);
319         }
320         ACPI_DEBUG_PRINT((ACPI_DB_INIT,
321                           "Entering sleep state [S%d]\n", sleep_state));
322
323         /* Clear SLP_EN and SLP_TYP fields */
324
325         PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
326                          sleep_enable_reg_info->access_bit_mask);
327         PM1Bcontrol = PM1Acontrol;
328
329         /* Insert SLP_TYP bits */
330
331         PM1Acontrol |=
332             (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
333         PM1Bcontrol |=
334             (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
335
336         /*
337          * We split the writes of SLP_TYP and SLP_EN to workaround
338          * poorly implemented hardware.
339          */
340
341         /* Write #1: fill in SLP_TYP data */
342
343         status = acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL,
344                                         PM1Acontrol);
345         if (ACPI_FAILURE(status)) {
346                 return_ACPI_STATUS(status);
347         }
348
349         status = acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL,
350                                         PM1Bcontrol);
351         if (ACPI_FAILURE(status)) {
352                 return_ACPI_STATUS(status);
353         }
354
355         /* Insert SLP_ENABLE bit */
356
357         PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
358         PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
359
360         /* Write #2: SLP_TYP + SLP_EN */
361
362         ACPI_FLUSH_CPU_CACHE();
363
364         status = acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL,
365                                         PM1Acontrol);
366         if (ACPI_FAILURE(status)) {
367                 return_ACPI_STATUS(status);
368         }
369
370         status = acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL,
371                                         PM1Bcontrol);
372         if (ACPI_FAILURE(status)) {
373                 return_ACPI_STATUS(status);
374         }
375
376         if (sleep_state > ACPI_STATE_S3) {
377                 /*
378                  * We wanted to sleep > S3, but it didn't happen (by virtue of the
379                  * fact that we are still executing!)
380                  *
381                  * Wait ten seconds, then try again. This is to get S4/S5 to work on
382                  * all machines.
383                  *
384                  * We wait so long to allow chipsets that poll this reg very slowly to
385                  * still read the right value. Ideally, this block would go
386                  * away entirely.
387                  */
388                 acpi_os_stall(10000000);
389
390                 status = acpi_hw_register_write(ACPI_REGISTER_PM1_CONTROL,
391                                                 sleep_enable_reg_info->
392                                                 access_bit_mask);
393                 if (ACPI_FAILURE(status)) {
394                         return_ACPI_STATUS(status);
395                 }
396         }
397
398         /* Wait until we enter sleep state */
399
400         do {
401                 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value);
402                 if (ACPI_FAILURE(status)) {
403                         return_ACPI_STATUS(status);
404                 }
405
406                 /* Spin until we wake */
407
408         } while (!in_value);
409
410         return_ACPI_STATUS(AE_OK);
411 }
412
413 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
414
415 /*******************************************************************************
416  *
417  * FUNCTION:    acpi_enter_sleep_state_s4bios
418  *
419  * PARAMETERS:  None
420  *
421  * RETURN:      Status
422  *
423  * DESCRIPTION: Perform a S4 bios request.
424  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
425  *
426  ******************************************************************************/
427 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
428 {
429         u32 in_value;
430         acpi_status status;
431
432         ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
433
434         status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
435         if (ACPI_FAILURE(status)) {
436                 return_ACPI_STATUS(status);
437         }
438
439         status = acpi_hw_clear_acpi_status();
440         if (ACPI_FAILURE(status)) {
441                 return_ACPI_STATUS(status);
442         }
443
444         /*
445          * 1) Disable/Clear all GPEs
446          * 2) Enable all wakeup GPEs
447          */
448         status = acpi_hw_disable_all_gpes();
449         if (ACPI_FAILURE(status)) {
450                 return_ACPI_STATUS(status);
451         }
452         acpi_gbl_system_awake_and_running = FALSE;
453
454         status = acpi_hw_enable_all_wakeup_gpes();
455         if (ACPI_FAILURE(status)) {
456                 return_ACPI_STATUS(status);
457         }
458
459         ACPI_FLUSH_CPU_CACHE();
460
461         status = acpi_os_write_port(acpi_gbl_FADT.smi_command,
462                                     (u32) acpi_gbl_FADT.S4bios_request, 8);
463
464         do {
465                 acpi_os_stall(1000);
466                 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value);
467                 if (ACPI_FAILURE(status)) {
468                         return_ACPI_STATUS(status);
469                 }
470         } while (!in_value);
471
472         return_ACPI_STATUS(AE_OK);
473 }
474
475 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
476
477 /*******************************************************************************
478  *
479  * FUNCTION:    acpi_leave_sleep_state
480  *
481  * PARAMETERS:  sleep_state         - Which sleep state we just exited
482  *
483  * RETURN:      Status
484  *
485  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
486  *              Called with interrupts ENABLED.
487  *
488  ******************************************************************************/
489 acpi_status acpi_leave_sleep_state(u8 sleep_state)
490 {
491         struct acpi_object_list arg_list;
492         union acpi_object arg;
493         acpi_status status;
494         struct acpi_bit_register_info *sleep_type_reg_info;
495         struct acpi_bit_register_info *sleep_enable_reg_info;
496         u32 PM1Acontrol;
497         u32 PM1Bcontrol;
498
499         ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
500
501         /*
502          * Set SLP_TYPE and SLP_EN to state S0.
503          * This is unclear from the ACPI Spec, but it is required
504          * by some machines.
505          */
506         status = acpi_get_sleep_type_data(ACPI_STATE_S0,
507                                           &acpi_gbl_sleep_type_a,
508                                           &acpi_gbl_sleep_type_b);
509         if (ACPI_SUCCESS(status)) {
510                 sleep_type_reg_info =
511                     acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
512                 sleep_enable_reg_info =
513                     acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
514
515                 /* Get current value of PM1A control */
516
517                 status = acpi_hw_register_read(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_REGISTER_PM1A_CONTROL,
540                                                      PM1Acontrol);
541                         (void)acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL,
542                                                      PM1Bcontrol);
543                 }
544         }
545
546         /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
547
548         acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
549
550         /* Setup parameter object */
551
552         arg_list.count = 1;
553         arg_list.pointer = &arg;
554         arg.type = ACPI_TYPE_INTEGER;
555
556         /* Ignore any errors from these methods */
557
558         arg.integer.value = ACPI_SST_WAKING;
559         status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
560         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
561                 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
562         }
563
564         arg.integer.value = sleep_state;
565         status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
566         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
567                 ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
568         }
569
570         /*
571          * GPEs must be enabled before _WAK is called as GPEs
572          * might get fired there
573          *
574          * Restore the GPEs:
575          * 1) Disable/Clear all GPEs
576          * 2) Enable all runtime GPEs
577          */
578         status = acpi_hw_disable_all_gpes();
579         if (ACPI_FAILURE(status)) {
580                 return_ACPI_STATUS(status);
581         }
582         status = acpi_hw_enable_all_runtime_gpes();
583         if (ACPI_FAILURE(status)) {
584                 return_ACPI_STATUS(status);
585         }
586
587         status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
588         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
589                 ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
590         }
591         /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
592
593         acpi_gbl_system_awake_and_running = TRUE;
594
595         /* Enable power button */
596
597         (void)
598             acpi_set_register(acpi_gbl_fixed_event_info
599                               [ACPI_EVENT_POWER_BUTTON].enable_register_id, 1);
600
601         (void)
602             acpi_set_register(acpi_gbl_fixed_event_info
603                               [ACPI_EVENT_POWER_BUTTON].status_register_id, 1);
604
605         arg.integer.value = ACPI_SST_WORKING;
606         status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
607         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
608                 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
609         }
610
611         return_ACPI_STATUS(status);
612 }
613
614 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)