1 /******************************************************************************
2 *
3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2015, 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 <contrib/dev/acpica/include/acpi.h>
47 #include <contrib/dev/acpica/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
56 AcpiHwSetFirmwareWakingVector (
57 ACPI_TABLE_FACS *Facs,
58 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
59 ACPI_PHYSICAL_ADDRESS PhysicalAddress64);
60 #endif
61
62 static ACPI_STATUS
63 AcpiHwSleepDispatch (
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
77 static ACPI_SLEEP_FUNCTIONS AcpiSleepDispatch[] =
78 {
79 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep), AcpiHwExtendedSleep},
80 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep), AcpiHwExtendedWakePrep},
81 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake), AcpiHwExtendedWake}
82 };
83
84
85 /*
86 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
87 * AcpiSetFirmwareWakingVector
88 * AcpiEnterSleepStateS4bios
89 */
90
91 #if (!ACPI_REDUCED_HARDWARE)
92 /*******************************************************************************
93 *
94 * FUNCTION: AcpiHwSetFirmwareWakingVector
95 *
96 * PARAMETERS: Facs - Pointer to FACS table
97 * PhysicalAddress - 32-bit physical address of ACPI real mode
98 * entry point
99 * PhysicalAddress64 - 64-bit physical address of ACPI protected
100 * entry point
101 *
102 * RETURN: Status
103 *
104 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
105 *
106 ******************************************************************************/
107
108 static ACPI_STATUS
AcpiHwSetFirmwareWakingVector(ACPI_TABLE_FACS * Facs,ACPI_PHYSICAL_ADDRESS PhysicalAddress,ACPI_PHYSICAL_ADDRESS PhysicalAddress64)109 AcpiHwSetFirmwareWakingVector (
110 ACPI_TABLE_FACS *Facs,
111 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
112 ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
113 {
114 ACPI_FUNCTION_TRACE (AcpiHwSetFirmwareWakingVector);
115
116
117 /*
118 * According to the ACPI specification 2.0c and later, the 64-bit
119 * waking vector should be cleared and the 32-bit waking vector should
120 * be used, unless we want the wake-up code to be called by the BIOS in
121 * Protected Mode. Some systems (for example HP dv5-1004nr) are known
122 * to fail to resume if the 64-bit vector is used.
123 */
124
125 /* Set the 32-bit vector */
126
127 Facs->FirmwareWakingVector = (UINT32) PhysicalAddress;
128
129 if (Facs->Length > 32)
130 {
131 if (Facs->Version >= 1)
132 {
133 /* Set the 64-bit vector */
134
135 Facs->XFirmwareWakingVector = PhysicalAddress64;
136 }
137 else
138 {
139 /* Clear the 64-bit vector if it exists */
140
141 Facs->XFirmwareWakingVector = 0;
142 }
143 }
144
145 return_ACPI_STATUS (AE_OK);
146 }
147
148
149 /*******************************************************************************
150 *
151 * FUNCTION: AcpiSetFirmwareWakingVector
152 *
153 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode
154 * entry point
155 * PhysicalAddress64 - 64-bit physical address of ACPI protected
156 * entry point
157 *
158 * RETURN: Status
159 *
160 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
161 *
162 ******************************************************************************/
163
164 ACPI_STATUS
AcpiSetFirmwareWakingVector(ACPI_PHYSICAL_ADDRESS PhysicalAddress,ACPI_PHYSICAL_ADDRESS PhysicalAddress64)165 AcpiSetFirmwareWakingVector (
166 ACPI_PHYSICAL_ADDRESS PhysicalAddress,
167 ACPI_PHYSICAL_ADDRESS PhysicalAddress64)
168 {
169
170 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
171
172 if (AcpiGbl_FACS)
173 {
174 (void) AcpiHwSetFirmwareWakingVector (AcpiGbl_FACS,
175 PhysicalAddress, PhysicalAddress64);
176 }
177
178 return_ACPI_STATUS (AE_OK);
179 }
180
ACPI_EXPORT_SYMBOL(AcpiSetFirmwareWakingVector)181 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector)
182
183
184 /*******************************************************************************
185 *
186 * FUNCTION: AcpiEnterSleepStateS4bios
187 *
188 * PARAMETERS: None
189 *
190 * RETURN: Status
191 *
192 * DESCRIPTION: Perform a S4 bios request.
193 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
194 *
195 ******************************************************************************/
196
197 ACPI_STATUS
198 AcpiEnterSleepStateS4bios (
199 void)
200 {
201 UINT32 InValue;
202 ACPI_STATUS Status;
203
204
205 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios);
206
207
208 /* Clear the wake status bit (PM1) */
209
210 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
211 if (ACPI_FAILURE (Status))
212 {
213 return_ACPI_STATUS (Status);
214 }
215
216 Status = AcpiHwClearAcpiStatus ();
217 if (ACPI_FAILURE (Status))
218 {
219 return_ACPI_STATUS (Status);
220 }
221
222 /*
223 * 1) Disable/Clear all GPEs
224 * 2) Enable all wakeup GPEs
225 */
226 Status = AcpiHwDisableAllGpes ();
227 if (ACPI_FAILURE (Status))
228 {
229 return_ACPI_STATUS (Status);
230 }
231 AcpiGbl_SystemAwakeAndRunning = FALSE;
232
233 Status = AcpiHwEnableAllWakeupGpes ();
234 if (ACPI_FAILURE (Status))
235 {
236 return_ACPI_STATUS (Status);
237 }
238
239 ACPI_FLUSH_CPU_CACHE ();
240
241 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
242 (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
243
244 do {
245 AcpiOsStall (ACPI_USEC_PER_MSEC);
246 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
247 if (ACPI_FAILURE (Status))
248 {
249 return_ACPI_STATUS (Status);
250 }
251 } while (!InValue);
252
253 return_ACPI_STATUS (AE_OK);
254 }
255
ACPI_EXPORT_SYMBOL(AcpiEnterSleepStateS4bios)256 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios)
257
258 #endif /* !ACPI_REDUCED_HARDWARE */
259
260
261 /*******************************************************************************
262 *
263 * FUNCTION: AcpiHwSleepDispatch
264 *
265 * PARAMETERS: SleepState - Which sleep state to enter/exit
266 * FunctionId - Sleep, WakePrep, or Wake
267 *
268 * RETURN: Status from the invoked sleep handling function.
269 *
270 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
271 * function.
272 *
273 ******************************************************************************/
274
275 static ACPI_STATUS
276 AcpiHwSleepDispatch (
277 UINT8 SleepState,
278 UINT32 FunctionId)
279 {
280 ACPI_STATUS Status;
281 ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId];
282
283
284 #if (!ACPI_REDUCED_HARDWARE)
285 /*
286 * If the Hardware Reduced flag is set (from the FADT), we must
287 * use the extended sleep registers (FADT). Note: As per the ACPI
288 * specification, these extended registers are to be used for HW-reduced
289 * platforms only. They are not general-purpose replacements for the
290 * legacy PM register sleep support.
291 */
292 if (AcpiGbl_ReducedHardware)
293 {
294 Status = SleepFunctions->ExtendedFunction (SleepState);
295 }
296 else
297 {
298 /* Legacy sleep */
299
300 Status = SleepFunctions->LegacyFunction (SleepState);
301 }
302
303 return (Status);
304
305 #else
306 /*
307 * For the case where reduced-hardware-only code is being generated,
308 * we know that only the extended sleep registers are available
309 */
310 Status = SleepFunctions->ExtendedFunction (SleepState);
311 return (Status);
312
313 #endif /* !ACPI_REDUCED_HARDWARE */
314 }
315
316
317 /*******************************************************************************
318 *
319 * FUNCTION: AcpiEnterSleepStatePrep
320 *
321 * PARAMETERS: SleepState - Which sleep state to enter
322 *
323 * RETURN: Status
324 *
325 * DESCRIPTION: Prepare to enter a system sleep state.
326 * This function must execute with interrupts enabled.
327 * We break sleeping into 2 stages so that OSPM can handle
328 * various OS-specific tasks between the two steps.
329 *
330 ******************************************************************************/
331
332 ACPI_STATUS
AcpiEnterSleepStatePrep(UINT8 SleepState)333 AcpiEnterSleepStatePrep (
334 UINT8 SleepState)
335 {
336 ACPI_STATUS Status;
337 ACPI_OBJECT_LIST ArgList;
338 ACPI_OBJECT Arg;
339 UINT32 SstValue;
340
341
342 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep);
343
344
345 Status = AcpiGetSleepTypeData (SleepState,
346 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
347 if (ACPI_FAILURE (Status))
348 {
349 return_ACPI_STATUS (Status);
350 }
351
352 /* Execute the _PTS method (Prepare To Sleep) */
353
354 ArgList.Count = 1;
355 ArgList.Pointer = &Arg;
356 Arg.Type = ACPI_TYPE_INTEGER;
357 Arg.Integer.Value = SleepState;
358
359 Status = AcpiEvaluateObject (NULL, METHOD_PATHNAME__PTS, &ArgList, NULL);
360 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
361 {
362 return_ACPI_STATUS (Status);
363 }
364
365 /* Setup the argument to the _SST method (System STatus) */
366
367 switch (SleepState)
368 {
369 case ACPI_STATE_S0:
370
371 SstValue = ACPI_SST_WORKING;
372 break;
373
374 case ACPI_STATE_S1:
375 case ACPI_STATE_S2:
376 case ACPI_STATE_S3:
377
378 SstValue = ACPI_SST_SLEEPING;
379 break;
380
381 case ACPI_STATE_S4:
382
383 SstValue = ACPI_SST_SLEEP_CONTEXT;
384 break;
385
386 default:
387
388 SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */
389 break;
390 }
391
392 /*
393 * Set the system indicators to show the desired sleep state.
394 * _SST is an optional method (return no error if not found)
395 */
396 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, SstValue);
397 return_ACPI_STATUS (AE_OK);
398 }
399
ACPI_EXPORT_SYMBOL(AcpiEnterSleepStatePrep)400 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep)
401
402
403 /*******************************************************************************
404 *
405 * FUNCTION: AcpiEnterSleepState
406 *
407 * PARAMETERS: SleepState - Which sleep state to enter
408 *
409 * RETURN: Status
410 *
411 * DESCRIPTION: Enter a system sleep state
412 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
413 *
414 ******************************************************************************/
415
416 ACPI_STATUS
417 AcpiEnterSleepState (
418 UINT8 SleepState)
419 {
420 ACPI_STATUS Status;
421
422
423 ACPI_FUNCTION_TRACE (AcpiEnterSleepState);
424
425
426 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
427 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
428 {
429 ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
430 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
431 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
432 }
433
434 Status = AcpiHwSleepDispatch (SleepState, ACPI_SLEEP_FUNCTION_ID);
435 return_ACPI_STATUS (Status);
436 }
437
ACPI_EXPORT_SYMBOL(AcpiEnterSleepState)438 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState)
439
440
441 /*******************************************************************************
442 *
443 * FUNCTION: AcpiLeaveSleepStatePrep
444 *
445 * PARAMETERS: SleepState - Which sleep state we are exiting
446 *
447 * RETURN: Status
448 *
449 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
450 * sleep. Called with interrupts DISABLED.
451 * We break wake/resume into 2 stages so that OSPM can handle
452 * various OS-specific tasks between the two steps.
453 *
454 ******************************************************************************/
455
456 ACPI_STATUS
457 AcpiLeaveSleepStatePrep (
458 UINT8 SleepState)
459 {
460 ACPI_STATUS Status;
461
462
463 ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep);
464
465
466 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_PREP_FUNCTION_ID);
467 return_ACPI_STATUS (Status);
468 }
469
ACPI_EXPORT_SYMBOL(AcpiLeaveSleepStatePrep)470 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep)
471
472
473 /*******************************************************************************
474 *
475 * FUNCTION: AcpiLeaveSleepState
476 *
477 * PARAMETERS: SleepState - Which sleep state we are exiting
478 *
479 * RETURN: Status
480 *
481 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
482 * Called with interrupts ENABLED.
483 *
484 ******************************************************************************/
485
486 ACPI_STATUS
487 AcpiLeaveSleepState (
488 UINT8 SleepState)
489 {
490 ACPI_STATUS Status;
491
492
493 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState);
494
495
496 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_FUNCTION_ID);
497 return_ACPI_STATUS (Status);
498 }
499
500 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)
501