ReactOS  0.4.15-dev-5618-g8866b9d
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 - 2022, 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 MERCHANTABILITY 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 
248  Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
249  (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
250  if (ACPI_FAILURE (Status))
251  {
253  }
254 
255  do {
258  if (ACPI_FAILURE (Status))
259  {
261  }
262 
263  } while (!InValue);
264 
266 }
267 
269 
270 #endif /* !ACPI_REDUCED_HARDWARE */
271 
272 
273 /*******************************************************************************
274  *
275  * FUNCTION: AcpiHwSleepDispatch
276  *
277  * PARAMETERS: SleepState - Which sleep state to enter/exit
278  * FunctionId - Sleep, WakePrep, or Wake
279  *
280  * RETURN: Status from the invoked sleep handling function.
281  *
282  * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
283  * function.
284  *
285  ******************************************************************************/
286 
287 static ACPI_STATUS
289  UINT8 SleepState,
290  UINT32 FunctionId)
291 {
293  ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId];
294 
295 
296 #if (!ACPI_REDUCED_HARDWARE)
297  /*
298  * If the Hardware Reduced flag is set (from the FADT), we must
299  * use the extended sleep registers (FADT). Note: As per the ACPI
300  * specification, these extended registers are to be used for HW-reduced
301  * platforms only. They are not general-purpose replacements for the
302  * legacy PM register sleep support.
303  */
304  if (AcpiGbl_ReducedHardware)
305  {
306  Status = SleepFunctions->ExtendedFunction (SleepState);
307  }
308  else
309  {
310  /* Legacy sleep */
311 
312  Status = SleepFunctions->LegacyFunction (SleepState);
313  }
314 
315  return (Status);
316 
317 #else
318  /*
319  * For the case where reduced-hardware-only code is being generated,
320  * we know that only the extended sleep registers are available
321  */
322  Status = SleepFunctions->ExtendedFunction (SleepState);
323  return (Status);
324 
325 #endif /* !ACPI_REDUCED_HARDWARE */
326 }
327 
328 
329 /*******************************************************************************
330  *
331  * FUNCTION: AcpiEnterSleepStatePrep
332  *
333  * PARAMETERS: SleepState - Which sleep state to enter
334  *
335  * RETURN: Status
336  *
337  * DESCRIPTION: Prepare to enter a system sleep state.
338  * This function must execute with interrupts enabled.
339  * We break sleeping into 2 stages so that OSPM can handle
340  * various OS-specific tasks between the two steps.
341  *
342  ******************************************************************************/
343 
346  UINT8 SleepState)
347 {
349  ACPI_OBJECT_LIST ArgList;
350  ACPI_OBJECT Arg;
351  UINT32 SstValue;
352 
353 
355 
356 
357  Status = AcpiGetSleepTypeData (SleepState,
358  &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
359  if (ACPI_FAILURE (Status))
360  {
362  }
363 
365  &AcpiGbl_SleepTypeAS0, &AcpiGbl_SleepTypeBS0);
366  if (ACPI_FAILURE (Status)) {
367  AcpiGbl_SleepTypeAS0 = ACPI_SLEEP_TYPE_INVALID;
368  }
369 
370  /* Execute the _PTS method (Prepare To Sleep) */
371 
372  ArgList.Count = 1;
373  ArgList.Pointer = &Arg;
374  Arg.Type = ACPI_TYPE_INTEGER;
375  Arg.Integer.Value = SleepState;
376 
379  {
381  }
382 
383  /* Setup the argument to the _SST method (System STatus) */
384 
385  switch (SleepState)
386  {
387  case ACPI_STATE_S0:
388 
389  SstValue = ACPI_SST_WORKING;
390  break;
391 
392  case ACPI_STATE_S1:
393  case ACPI_STATE_S2:
394  case ACPI_STATE_S3:
395 
396  SstValue = ACPI_SST_SLEEPING;
397  break;
398 
399  case ACPI_STATE_S4:
400 
401  SstValue = ACPI_SST_SLEEP_CONTEXT;
402  break;
403 
404  default:
405 
406  SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */
407  break;
408  }
409 
410  /*
411  * Set the system indicators to show the desired sleep state.
412  * _SST is an optional method (return no error if not found)
413  */
416 }
417 
419 
420 
421 /*******************************************************************************
422  *
423  * FUNCTION: AcpiEnterSleepState
424  *
425  * PARAMETERS: SleepState - Which sleep state to enter
426  *
427  * RETURN: Status
428  *
429  * DESCRIPTION: Enter a system sleep state
430  * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
431  *
432  ******************************************************************************/
433 
436  UINT8 SleepState)
437 {
439 
440 
442 
443 
444  if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
445  (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
446  {
447  ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
448  AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
450  }
451 
454 }
455 
457 
458 
459 /*******************************************************************************
460  *
461  * FUNCTION: AcpiLeaveSleepStatePrep
462  *
463  * PARAMETERS: SleepState - Which sleep state we are exiting
464  *
465  * RETURN: Status
466  *
467  * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
468  * sleep. Called with interrupts DISABLED.
469  * We break wake/resume into 2 stages so that OSPM can handle
470  * various OS-specific tasks between the two steps.
471  *
472  ******************************************************************************/
473 
476  UINT8 SleepState)
477 {
479 
480 
482 
483 
486 }
487 
489 
490 
491 /*******************************************************************************
492  *
493  * FUNCTION: AcpiLeaveSleepState
494  *
495  * PARAMETERS: SleepState - Which sleep state we are exiting
496  *
497  * RETURN: Status
498  *
499  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
500  * Called with interrupts ENABLED.
501  *
502  ******************************************************************************/
503 
506  UINT8 SleepState)
507 {
509 
510 
512 
513 
516 }
517 
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:939
void AcpiOsStall(UINT32 Microseconds)
Definition: osl.c:264
#define ACPI_TYPE_INTEGER
Definition: actypes.h:688
#define AE_AML_OPERAND_VALUE
Definition: acexcep.h:183
#define METHOD_PATHNAME__PTS
Definition: acnames.h:80
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
struct acpi_object::@600 Integer
ACPI_STATUS AcpiHwLegacyWake(UINT8 SleepState)
Definition: hwsleep.c:301
UINT32 ACPI_STATUS
Definition: actypes.h:460
#define ACPI_SLEEP_TYPE_MAX
Definition: actypes.h:650
ACPI_STATUS AcpiGetSleepTypeData(UINT8 SleepState, UINT8 *SleepTypeA, UINT8 *SleepTypeB)
Definition: hwxface.c:411
#define ACPI_FAILURE(a)
Definition: acexcep.h:95
#define FALSE
Definition: types.h:117
unsigned int UINT32
ACPI_STATUS AcpiHwLegacyWakePrep(UINT8 SleepState)
Definition: hwsleep.c:234
#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
#define ACPI_STATE_S4
Definition: actypes.h:628
UINT32 Length
Definition: actbl.h:221
Status
Definition: gdiplustypes.h:24
#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:954
static ACPI_STATUS AcpiHwSleepDispatch(UINT8 SleepState, UINT32 FunctionId)
Definition: hwxfsleep.c:288
#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:1098
#define ACPI_STATE_S0
Definition: actypes.h:624
#define METHOD_PATHNAME__SST
Definition: acnames.h:81
ACPI_STATUS AcpiReadBitRegister(UINT32 RegisterId, UINT32 *ReturnValue)
Definition: hwxface.c:213
ACPI_SLEEP_FUNCTION ExtendedFunction
Definition: actypes.h:955
#define ACPI_BITREG_WAKE_STATUS
Definition: actypes.h:909
#define ACPI_SLEEP_TYPE_INVALID
Definition: actypes.h:651
#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
#define NULL
Definition: types.h:112
ACPI_STATUS AcpiEnterSleepStateS4bios(void)
Definition: hwxfsleep.c:207
#define ACPI_STATE_S1
Definition: actypes.h:625
#define ACPI_STATE_S2
Definition: actypes.h:626
ACPI_STATUS AcpiHwExtendedWake(UINT8 SleepState)
Definition: hwesleep.c:243
ACPI_OBJECT * Pointer
Definition: actypes.h:1029
ACPI_STATUS AcpiHwExtendedWakePrep(UINT8 SleepState)
Definition: hwesleep.c:207
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:970
#define ACPI_STATE_S3
Definition: actypes.h:627
#define ACPI_SST_INDICATOR_OFF
Definition: achware.h:50
unsigned char UINT8
ACPI_STATUS AcpiLeaveSleepState(UINT8 SleepState)
Definition: hwxfsleep.c:505
#define AE_OK
Definition: acexcep.h:97
ACPI_STATUS AcpiLeaveSleepStatePrep(UINT8 SleepState)
Definition: hwxfsleep.c:475
ACPI_STATUS AcpiEnterSleepStatePrep(UINT8 SleepState)
Definition: hwxfsleep.c:345
ACPI_STATUS AcpiEnterSleepState(UINT8 SleepState)
Definition: hwxfsleep.c:435
#define ACPI_WAKE_PREP_FUNCTION_ID
Definition: hwxfsleep.c:72
UINT32 FirmwareWakingVector
Definition: actbl.h:223