ReactOS  0.4.15-dev-1203-g0e5a4d5
hwxfsleep.c
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2020, 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 #define EXPORT_ACPI_INTERFACES
45 
46 #include "acpi.h"
47 #include "accommon.h"
48 
49 #define _COMPONENT ACPI_HARDWARE
50  ACPI_MODULE_NAME ("hwxfsleep")
51 
52 /* Local prototypes */
53 
54 #if (!ACPI_REDUCED_HARDWARE)
55 static ACPI_STATUS
57  ACPI_TABLE_FACS *Facs,
58  ACPI_PHYSICAL_ADDRESS PhysicalAddress,
59  ACPI_PHYSICAL_ADDRESS PhysicalAddress64);
60 #endif
61 
62 static ACPI_STATUS
64  UINT8 SleepState,
65  UINT32 FunctionId);
66 
67 /*
68  * Dispatch table used to efficiently branch to the various sleep
69  * functions.
70  */
71 #define ACPI_SLEEP_FUNCTION_ID 0
72 #define ACPI_WAKE_PREP_FUNCTION_ID 1
73 #define ACPI_WAKE_FUNCTION_ID 2
74 
75 /* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
76 
78 {
79  {ACPI_STRUCT_INIT (LegacyFunction,
81  ACPI_STRUCT_INIT (ExtendedFunction,
83  {ACPI_STRUCT_INIT (LegacyFunction,
85  ACPI_STRUCT_INIT (ExtendedFunction,
87  {ACPI_STRUCT_INIT (LegacyFunction,
89  ACPI_STRUCT_INIT (ExtendedFunction,
91 };
92 
93 
94 /*
95  * These functions are removed for the ACPI_REDUCED_HARDWARE case:
96  * AcpiSetFirmwareWakingVector
97  * AcpiEnterSleepStateS4bios
98  */
99 
100 #if (!ACPI_REDUCED_HARDWARE)
101 /*******************************************************************************
102  *
103  * FUNCTION: AcpiHwSetFirmwareWakingVector
104  *
105  * PARAMETERS: Facs - Pointer to FACS table
106  * PhysicalAddress - 32-bit physical address of ACPI real mode
107  * entry point
108  * PhysicalAddress64 - 64-bit physical address of ACPI protected
109  * mode entry point
110  *
111  * RETURN: Status
112  *
113  * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
114  *
115  ******************************************************************************/
116 
117 static ACPI_STATUS
119  ACPI_TABLE_FACS *Facs,
120  ACPI_PHYSICAL_ADDRESS PhysicalAddress,
121  ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
122 {
124 
125 
126  /*
127  * According to the ACPI specification 2.0c and later, the 64-bit
128  * waking vector should be cleared and the 32-bit waking vector should
129  * be used, unless we want the wake-up code to be called by the BIOS in
130  * Protected Mode. Some systems (for example HP dv5-1004nr) are known
131  * to fail to resume if the 64-bit vector is used.
132  */
133 
134  /* Set the 32-bit vector */
135 
137 
138  if (Facs->Length > 32)
139  {
140  if (Facs->Version >= 1)
141  {
142  /* Set the 64-bit vector */
143 
144  Facs->XFirmwareWakingVector = PhysicalAddress64;
145  }
146  else
147  {
148  /* Clear the 64-bit vector if it exists */
149 
150  Facs->XFirmwareWakingVector = 0;
151  }
152  }
153 
155 }
156 
157 
158 /*******************************************************************************
159  *
160  * FUNCTION: AcpiSetFirmwareWakingVector
161  *
162  * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
163  * entry point
164  * PhysicalAddress64 - 64-bit physical address of ACPI protected
165  * mode entry point
166  *
167  * RETURN: Status
168  *
169  * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
170  *
171  ******************************************************************************/
172 
175  ACPI_PHYSICAL_ADDRESS PhysicalAddress,
176  ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
177 {
178 
180 
181  if (AcpiGbl_FACS)
182  {
183  (void) AcpiHwSetFirmwareWakingVector (AcpiGbl_FACS,
184  PhysicalAddress, PhysicalAddress64);
185  }
186 
188 }
189 
191 
192 
193 /*******************************************************************************
194  *
195  * FUNCTION: AcpiEnterSleepStateS4bios
196  *
197  * PARAMETERS: None
198  *
199  * RETURN: Status
200  *
201  * DESCRIPTION: Perform a S4 bios request.
202  * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
203  *
204  ******************************************************************************/
205 
208  void)
209 {
210  UINT32 InValue;
212 
213 
215 
216 
217  /* Clear the wake status bit (PM1) */
218 
220  if (ACPI_FAILURE (Status))
221  {
223  }
224 
226  if (ACPI_FAILURE (Status))
227  {
229  }
230 
231  /*
232  * 1) Disable all GPEs
233  * 2) Enable all wakeup GPEs
234  */
236  if (ACPI_FAILURE (Status))
237  {
239  }
240  AcpiGbl_SystemAwakeAndRunning = FALSE;
241 
243  if (ACPI_FAILURE (Status))
244  {
246  }
247 
249 
250  Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
251  (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
252  if (ACPI_FAILURE (Status))
253  {
255  }
256 
257  do {
260  if (ACPI_FAILURE (Status))
261  {
263  }
264 
265  } while (!InValue);
266 
268 }
269 
271 
272 #endif /* !ACPI_REDUCED_HARDWARE */
273 
274 
275 /*******************************************************************************
276  *
277  * FUNCTION: AcpiHwSleepDispatch
278  *
279  * PARAMETERS: SleepState - Which sleep state to enter/exit
280  * FunctionId - Sleep, WakePrep, or Wake
281  *
282  * RETURN: Status from the invoked sleep handling function.
283  *
284  * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
285  * function.
286  *
287  ******************************************************************************/
288 
289 static ACPI_STATUS
291  UINT8 SleepState,
292  UINT32 FunctionId)
293 {
295  ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId];
296 
297 
298 #if (!ACPI_REDUCED_HARDWARE)
299  /*
300  * If the Hardware Reduced flag is set (from the FADT), we must
301  * use the extended sleep registers (FADT). Note: As per the ACPI
302  * specification, these extended registers are to be used for HW-reduced
303  * platforms only. They are not general-purpose replacements for the
304  * legacy PM register sleep support.
305  */
306  if (AcpiGbl_ReducedHardware)
307  {
308  Status = SleepFunctions->ExtendedFunction (SleepState);
309  }
310  else
311  {
312  /* Legacy sleep */
313 
314  Status = SleepFunctions->LegacyFunction (SleepState);
315  }
316 
317  return (Status);
318 
319 #else
320  /*
321  * For the case where reduced-hardware-only code is being generated,
322  * we know that only the extended sleep registers are available
323  */
324  Status = SleepFunctions->ExtendedFunction (SleepState);
325  return (Status);
326 
327 #endif /* !ACPI_REDUCED_HARDWARE */
328 }
329 
330 
331 /*******************************************************************************
332  *
333  * FUNCTION: AcpiEnterSleepStatePrep
334  *
335  * PARAMETERS: SleepState - Which sleep state to enter
336  *
337  * RETURN: Status
338  *
339  * DESCRIPTION: Prepare to enter a system sleep state.
340  * This function must execute with interrupts enabled.
341  * We break sleeping into 2 stages so that OSPM can handle
342  * various OS-specific tasks between the two steps.
343  *
344  ******************************************************************************/
345 
348  UINT8 SleepState)
349 {
351  ACPI_OBJECT_LIST ArgList;
352  ACPI_OBJECT Arg;
353  UINT32 SstValue;
354 
355 
357 
358 
359  Status = AcpiGetSleepTypeData (SleepState,
360  &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
361  if (ACPI_FAILURE (Status))
362  {
364  }
365 
366  /* Execute the _PTS method (Prepare To Sleep) */
367 
368  ArgList.Count = 1;
369  ArgList.Pointer = &Arg;
370  Arg.Type = ACPI_TYPE_INTEGER;
371  Arg.Integer.Value = SleepState;
372 
375  {
377  }
378 
379  /* Setup the argument to the _SST method (System STatus) */
380 
381  switch (SleepState)
382  {
383  case ACPI_STATE_S0:
384 
385  SstValue = ACPI_SST_WORKING;
386  break;
387 
388  case ACPI_STATE_S1:
389  case ACPI_STATE_S2:
390  case ACPI_STATE_S3:
391 
392  SstValue = ACPI_SST_SLEEPING;
393  break;
394 
395  case ACPI_STATE_S4:
396 
397  SstValue = ACPI_SST_SLEEP_CONTEXT;
398  break;
399 
400  default:
401 
402  SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */
403  break;
404  }
405 
406  /*
407  * Set the system indicators to show the desired sleep state.
408  * _SST is an optional method (return no error if not found)
409  */
412 }
413 
415 
416 
417 /*******************************************************************************
418  *
419  * FUNCTION: AcpiEnterSleepState
420  *
421  * PARAMETERS: SleepState - Which sleep state to enter
422  *
423  * RETURN: Status
424  *
425  * DESCRIPTION: Enter a system sleep state
426  * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
427  *
428  ******************************************************************************/
429 
432  UINT8 SleepState)
433 {
435 
436 
438 
439 
440  if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
441  (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
442  {
443  ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
444  AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
446  }
447 
450 }
451 
453 
454 
455 /*******************************************************************************
456  *
457  * FUNCTION: AcpiLeaveSleepStatePrep
458  *
459  * PARAMETERS: SleepState - Which sleep state we are exiting
460  *
461  * RETURN: Status
462  *
463  * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
464  * sleep. Called with interrupts DISABLED.
465  * We break wake/resume into 2 stages so that OSPM can handle
466  * various OS-specific tasks between the two steps.
467  *
468  ******************************************************************************/
469 
472  UINT8 SleepState)
473 {
475 
476 
478 
479 
482 }
483 
485 
486 
487 /*******************************************************************************
488  *
489  * FUNCTION: AcpiLeaveSleepState
490  *
491  * PARAMETERS: SleepState - Which sleep state we are exiting
492  *
493  * RETURN: Status
494  *
495  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
496  * Called with interrupts ENABLED.
497  *
498  ******************************************************************************/
499 
502  UINT8 SleepState)
503 {
505 
506 
508 
509 
512 }
513 
ACPI_STATUS AcpiHwDisableAllGpes(void)
Definition: hwgpe.c:595
static ACPI_SLEEP_FUNCTIONS AcpiSleepDispatch[]
Definition: hwxfsleep.c:77
ACPI_STATUS AcpiHwClearAcpiStatus(void)
Definition: hwregs.c:452
#define ACPI_WAKE_FUNCTION_ID
Definition: hwxfsleep.c:73
struct png_info_def **typedef void(__cdecl typeof(png_destroy_read_struct))(struct png_struct_def **
Definition: typeof.h:49
ACPI_STATUS AcpiWriteBitRegister(UINT32 RegisterId, UINT32 Value)
Definition: hwxface.c:282
ACPI_STATUS AcpiHwLegacySleep(UINT8 SleepState)
Definition: hwsleep.c:67
#define ACPI_CLEAR_STATUS
Definition: actypes.h:930
void AcpiOsStall(UINT32 Microseconds)
Definition: osl.c:264
#define ACPI_TYPE_INTEGER
Definition: actypes.h:680
#define AE_AML_OPERAND_VALUE
Definition: acexcep.h:183
#define METHOD_PATHNAME__PTS
Definition: acnames.h:79
void AcpiHwExecuteSleepMethod(char *MethodPathname, UINT32 IntegerArgument)
Definition: hwesleep.c:67
ACPI_STATUS AcpiSetFirmwareWakingVector(ACPI_PHYSICAL_ADDRESS PhysicalAddress, ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
Definition: hwxfsleep.c:174
ACPI_STATUS AcpiHwLegacyWake(UINT8 SleepState)
Definition: hwsleep.c:300
UINT32 ACPI_STATUS
Definition: actypes.h:460
#define ACPI_SLEEP_TYPE_MAX
Definition: actypes.h:642
ACPI_STATUS AcpiGetSleepTypeData(UINT8 SleepState, UINT8 *SleepTypeA, UINT8 *SleepTypeB)
Definition: hwxface.c:411
#define ACPI_FAILURE(a)
Definition: acexcep.h:95
struct acpi_object::@602 Integer
#define FALSE
Definition: types.h:117
unsigned int UINT32
ACPI_STATUS AcpiHwLegacyWakePrep(UINT8 SleepState)
Definition: hwsleep.c:231
#define ACPI_MODULE_NAME(Name)
Definition: acoutput.h:216
#define ACPI_HW_OPTIONAL_FUNCTION(addr)
Definition: acmacros.h:483
ACPI_STATUS AcpiHwWritePort(ACPI_IO_ADDRESS Address, UINT32 Value, UINT32 Width)
Definition: hwvalid.c:312
#define ACPI_SST_WORKING
Definition: achware.h:51
#define ACPI_EXPORT_SYMBOL(Symbol)
Definition: actypes.h:343
#define AE_INFO
Definition: acoutput.h:230
smooth NULL
Definition: ftsmooth.c:416
#define ACPI_STATE_S4
Definition: actypes.h:620
UINT32 Length
Definition: actbl.h:221
#define ACPI_FLUSH_CPU_CACHE()
Definition: accygwin.h:53
#define ACPI_USEC_PER_MSEC
Definition: actypes.h:470
UINT8 Version
Definition: actbl.h:227
#define ACPI_SST_SLEEPING
Definition: achware.h:53
static ACPI_STATUS AcpiHwSetFirmwareWakingVector(ACPI_TABLE_FACS *Facs, ACPI_PHYSICAL_ADDRESS PhysicalAddress, ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
Definition: hwxfsleep.c:118
#define ACPI_SLEEP_FUNCTION_ID
Definition: hwxfsleep.c:71
ACPI_SLEEP_FUNCTION LegacyFunction
Definition: actypes.h:945
static ACPI_STATUS AcpiHwSleepDispatch(UINT8 SleepState, UINT32 FunctionId)
Definition: hwxfsleep.c:290
#define AE_NOT_FOUND
Definition: acexcep.h:113
#define ACPI_SST_SLEEP_CONTEXT
Definition: achware.h:54
ACPI_STATUS AcpiHwEnableAllWakeupGpes(void)
Definition: hwgpe.c:649
_Must_inspect_result_ typedef _In_ PHYSICAL_ADDRESS PhysicalAddress
Definition: iotypes.h:1081
#define ACPI_STATE_S0
Definition: actypes.h:616
Status
Definition: gdiplustypes.h:24
#define METHOD_PATHNAME__SST
Definition: acnames.h:80
ACPI_STATUS AcpiReadBitRegister(UINT32 RegisterId, UINT32 *ReturnValue)
Definition: hwxface.c:213
ACPI_SLEEP_FUNCTION ExtendedFunction
Definition: actypes.h:946
#define ACPI_BITREG_WAKE_STATUS
Definition: actypes.h:900
#define return_ACPI_STATUS(s)
Definition: acoutput.h:496
ACPI_STATUS AcpiEvaluateObject(ACPI_HANDLE Handle, ACPI_STRING Pathname, ACPI_OBJECT_LIST *ExternalParams, ACPI_BUFFER *ReturnBuffer)
Definition: nsxfeval.c:217
#define ACPI_FUNCTION_TRACE(a)
Definition: acoutput.h:480
#define ACPI_STRUCT_INIT(field, value)
Definition: acenv.h:314
ACPI_STATUS AcpiEnterSleepStateS4bios(void)
Definition: hwxfsleep.c:207
#define ACPI_STATE_S1
Definition: actypes.h:617
#define ACPI_STATE_S2
Definition: actypes.h:618
ACPI_STATUS AcpiHwExtendedWake(UINT8 SleepState)
Definition: hwesleep.c:243
ACPI_OBJECT * Pointer
Definition: actypes.h:1020
ACPI_STATUS AcpiHwExtendedWakePrep(UINT8 SleepState)
Definition: hwesleep.c:204
ACPI_STATUS AcpiHwExtendedSleep(UINT8 SleepState)
Definition: hwesleep.c:112
#define ACPI_ERROR(plist)
Definition: acoutput.h:240
UINT64 XFirmwareWakingVector
Definition: actbl.h:226
ACPI_OBJECT_TYPE Type
Definition: actypes.h:961
#define ACPI_STATE_S3
Definition: actypes.h:619
#define ACPI_SST_INDICATOR_OFF
Definition: achware.h:50
unsigned char UINT8
ACPI_STATUS AcpiLeaveSleepState(UINT8 SleepState)
Definition: hwxfsleep.c:501
#define AE_OK
Definition: acexcep.h:97
ACPI_STATUS AcpiLeaveSleepStatePrep(UINT8 SleepState)
Definition: hwxfsleep.c:471
ACPI_STATUS AcpiEnterSleepStatePrep(UINT8 SleepState)
Definition: hwxfsleep.c:347
ACPI_STATUS AcpiEnterSleepState(UINT8 SleepState)
Definition: hwxfsleep.c:431
#define ACPI_WAKE_PREP_FUNCTION_ID
Definition: hwxfsleep.c:72
UINT32 FirmwareWakingVector
Definition: actbl.h:223