1 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/hwsleep.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
120 #define _COMPONENT ACPI_HARDWARE
121 ACPI_MODULE_NAME ("hwsleep")
124 /******************************************************************************
126 * FUNCTION: AcpiSetFirmwareWakingVector
128 * PARAMETERS: PhysicalAddress - Physical address of ACPI real mode
133 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS
135 ******************************************************************************/
138 AcpiSetFirmwareWakingVector (
139 ACPI_PHYSICAL_ADDRESS PhysicalAddress)
142 ACPI_FUNCTION_TRACE ("AcpiSetFirmwareWakingVector");
147 if (AcpiGbl_CommonFACS.VectorWidth == 32)
149 *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector))
150 = (UINT32) PhysicalAddress;
154 *AcpiGbl_CommonFACS.FirmwareWakingVector
158 return_ACPI_STATUS (AE_OK);
162 /******************************************************************************
164 * FUNCTION: AcpiGetFirmwareWakingVector
166 * PARAMETERS: *PhysicalAddress - Output buffer where contents of
167 * the FirmwareWakingVector field of
168 * the FACS will be stored.
172 * DESCRIPTION: Access function for FirmwareWakingVector field in FACS
174 ******************************************************************************/
177 AcpiGetFirmwareWakingVector (
178 ACPI_PHYSICAL_ADDRESS *PhysicalAddress)
181 ACPI_FUNCTION_TRACE ("AcpiGetFirmwareWakingVector");
184 if (!PhysicalAddress)
186 return_ACPI_STATUS (AE_BAD_PARAMETER);
191 if (AcpiGbl_CommonFACS.VectorWidth == 32)
193 *PhysicalAddress = (ACPI_PHYSICAL_ADDRESS)
194 *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector));
199 *AcpiGbl_CommonFACS.FirmwareWakingVector;
202 return_ACPI_STATUS (AE_OK);
206 /******************************************************************************
208 * FUNCTION: AcpiEnterSleepStatePrep
210 * PARAMETERS: SleepState - Which sleep state to enter
214 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
215 * This function must execute with interrupts enabled.
216 * We break sleeping into 2 stages so that OSPM can handle
217 * various OS-specific tasks between the two steps.
219 ******************************************************************************/
222 AcpiEnterSleepStatePrep (
226 ACPI_OBJECT_LIST ArgList;
230 ACPI_FUNCTION_TRACE ("AcpiEnterSleepStatePrep");
234 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
236 Status = AcpiGetSleepTypeData (SleepState,
237 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
238 if (ACPI_FAILURE (Status))
240 return_ACPI_STATUS (Status);
243 /* Setup parameter object */
246 ArgList.Pointer = &Arg;
248 Arg.Type = ACPI_TYPE_INTEGER;
249 Arg.Integer.Value = SleepState;
251 /* Run the _PTS and _GTS methods */
253 Status = AcpiEvaluateObject (NULL, "\\_PTS", &ArgList, NULL);
254 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
256 return_ACPI_STATUS (Status);
259 Status = AcpiEvaluateObject (NULL, "\\_GTS", &ArgList, NULL);
260 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
262 return_ACPI_STATUS (Status);
265 return_ACPI_STATUS (AE_OK);
269 /******************************************************************************
271 * FUNCTION: AcpiEnterSleepState
273 * PARAMETERS: SleepState - Which sleep state to enter
277 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
278 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
280 ******************************************************************************/
283 AcpiEnterSleepState (
288 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
289 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
295 ACPI_FUNCTION_TRACE ("AcpiEnterSleepState");
298 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
299 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
301 ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n",
302 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
303 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
307 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A);
308 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
310 /* Clear wake status */
312 Status = AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_LOCK);
313 if (ACPI_FAILURE (Status))
315 return_ACPI_STATUS (Status);
318 Status = AcpiHwClearAcpiStatus();
319 if (ACPI_FAILURE (Status))
321 return_ACPI_STATUS (Status);
324 /* Disable BM arbitration */
326 Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 1, ACPI_MTX_LOCK);
327 if (ACPI_FAILURE (Status))
329 return_ACPI_STATUS (Status);
332 Status = AcpiHwDisableNonWakeupGpes();
333 if (ACPI_FAILURE (Status))
335 return_ACPI_STATUS (Status);
338 /* Get current value of PM1A control */
340 Status = AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL, &PM1AControl);
341 if (ACPI_FAILURE (Status))
343 return_ACPI_STATUS (Status);
345 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Entering sleep state [S%d]\n", SleepState));
347 /* Clear SLP_EN and SLP_TYP fields */
349 PM1AControl &= ~(SleepTypeRegInfo->AccessBitMask | SleepEnableRegInfo->AccessBitMask);
350 PM1BControl = PM1AControl;
352 /* Insert SLP_TYP bits */
354 PM1AControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
355 PM1BControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
357 /* Write #1: fill in SLP_TYP data */
359 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
360 if (ACPI_FAILURE (Status))
362 return_ACPI_STATUS (Status);
365 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
366 if (ACPI_FAILURE (Status))
368 return_ACPI_STATUS (Status);
371 /* Insert SLP_ENABLE bit */
373 PM1AControl |= SleepEnableRegInfo->AccessBitMask;
374 PM1BControl |= SleepEnableRegInfo->AccessBitMask;
376 /* Write #2: SLP_TYP + SLP_EN */
378 ACPI_FLUSH_CPU_CACHE ();
380 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl);
381 if (ACPI_FAILURE (Status))
383 return_ACPI_STATUS (Status);
386 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl);
387 if (ACPI_FAILURE (Status))
389 return_ACPI_STATUS (Status);
393 * Wait a second, then try again. This is to get S4/5 to work on all machines.
395 if (SleepState > ACPI_STATE_S3)
398 * We wait so long to allow chipsets that poll this reg very slowly to
399 * still read the right value. Ideally, this entire block would go
402 AcpiOsStall (10000000);
404 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL,
405 SleepEnableRegInfo->AccessBitMask);
406 if (ACPI_FAILURE (Status))
408 return_ACPI_STATUS (Status);
412 /* Wait until we enter sleep state */
417 Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK);
418 if (ACPI_FAILURE (Status))
420 return_ACPI_STATUS (Status);
424 * Some BIOSes don't set WAK_STS at all,
425 * give up waiting for wakeup if we time out.
429 break; /* giving up */
432 /* Spin until we wake */
436 Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 0, ACPI_MTX_DO_NOT_LOCK);
437 if (ACPI_FAILURE (Status))
439 return_ACPI_STATUS (Status);
442 return_ACPI_STATUS (AE_OK);
446 /******************************************************************************
448 * FUNCTION: AcpiEnterSleepStateS4bios
454 * DESCRIPTION: Perform a S4 bios request.
455 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
457 ******************************************************************************/
460 AcpiEnterSleepStateS4bios (
467 ACPI_FUNCTION_TRACE ("AcpiEnterSleepStateS4bios");
469 AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
470 AcpiHwClearAcpiStatus();
472 AcpiHwDisableNonWakeupGpes();
474 ACPI_FLUSH_CPU_CACHE();
476 Status = AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, (ACPI_INTEGER) AcpiGbl_FADT->S4BiosReq, 8);
480 Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK);
481 if (ACPI_FAILURE (Status))
483 return_ACPI_STATUS (Status);
487 return_ACPI_STATUS (AE_OK);
491 /******************************************************************************
493 * FUNCTION: AcpiLeaveSleepState
495 * PARAMETERS: SleepState - Which sleep state we just exited
499 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
501 ******************************************************************************/
504 AcpiLeaveSleepState (
507 ACPI_OBJECT_LIST ArgList;
512 ACPI_FUNCTION_TRACE ("AcpiLeaveSleepState");
515 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
517 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
519 /* Setup parameter object */
522 ArgList.Pointer = &Arg;
524 Arg.Type = ACPI_TYPE_INTEGER;
525 Arg.Integer.Value = SleepState;
527 /* Ignore any errors from these methods */
529 Status = AcpiEvaluateObject (NULL, "\\_BFS", &ArgList, NULL);
530 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
532 ACPI_REPORT_ERROR (("Method _BFS failed, %s\n", AcpiFormatException (Status)));
535 Status = AcpiEvaluateObject (NULL, "\\_WAK", &ArgList, NULL);
536 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
538 ACPI_REPORT_ERROR (("Method _WAK failed, %s\n", AcpiFormatException (Status)));
541 /* _WAK returns stuff - do we want to look at it? */
543 Status = AcpiHwEnableNonWakeupGpes();
544 if (ACPI_FAILURE (Status))
546 return_ACPI_STATUS (Status);
549 /* Disable BM arbitration */
550 Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 0, ACPI_MTX_LOCK);
552 return_ACPI_STATUS (Status);