projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 30143b15 | 1 | /** @file\r |
| 2 | System reset Library Services. This library class defines a set of\r | |
| e9b67286 | 3 | methods that reset the whole system.\r |
| 30143b15 | 4 | \r |
| d1102dba LG |
5 | Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| 6 | This program and the accompanying materials are licensed and made available under\r | |
| 7 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
| 64a80549 | 8 | The full text of the license may be found at\r |
| d1102dba | 9 | http://opensource.org/licenses/bsd-license.php.\r |
| 64a80549 | 10 | \r |
| d1102dba | 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
| 64a80549 | 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| 30143b15 | 13 | \r |
| 14 | **/\r | |
| 15 | \r | |
| 16 | #ifndef __RESET_SYSTEM_LIB_H__\r | |
| 17 | #define __RESET_SYSTEM_LIB_H__\r | |
| 18 | \r | |
| 19 | /**\r | |
| e9b67286 | 20 | This function causes a system-wide reset (cold reset), in which\r |
| d1102dba LG |
21 | all circuitry within the system returns to its initial state. This type of reset\r |
| 22 | is asynchronous to system operation and operates without regard to\r | |
| 30143b15 | 23 | cycle boundaries.\r |
| 24 | \r | |
| d1102dba | 25 | If this function returns, it means that the system does not support cold reset.\r |
| 30143b15 | 26 | **/\r |
| 27 | VOID\r | |
| 28 | EFIAPI\r | |
| 29 | ResetCold (\r | |
| 30 | VOID\r | |
| 31 | );\r | |
| 32 | \r | |
| 33 | /**\r | |
| d1102dba | 34 | This function causes a system-wide initialization (warm reset), in which all processors\r |
| e9b67286 | 35 | are set to their initial state. Pending cycles are not corrupted.\r |
| 30143b15 | 36 | \r |
| e9b67286 | 37 | If this function returns, it means that the system does not support warm reset.\r |
| 30143b15 | 38 | **/\r |
| 39 | VOID\r | |
| 40 | EFIAPI\r | |
| 41 | ResetWarm (\r | |
| 42 | VOID\r | |
| 43 | );\r | |
| 44 | \r | |
| 45 | /**\r | |
| d1102dba | 46 | This function causes the system to enter a power state equivalent\r |
| 30143b15 | 47 | to the ACPI G2/S5 or G3 states.\r |
| d1102dba | 48 | \r |
| 64a80549 | 49 | If this function returns, it means that the system does not support shutdown reset.\r |
| 30143b15 | 50 | **/\r |
| 51 | VOID\r | |
| 52 | EFIAPI\r | |
| 53 | ResetShutdown (\r | |
| 54 | VOID\r | |
| 55 | );\r | |
| 56 | \r | |
| 57 | /**\r | |
| e40b7d5d | 58 | This function causes the system to enter S3 and then wake up immediately.\r |
| d1102dba | 59 | \r |
| e40b7d5d | 60 | If this function returns, it means that the system does not support S3 feature.\r |
| 30143b15 | 61 | **/\r |
| 62 | VOID\r | |
| 63 | EFIAPI\r | |
| 64 | EnterS3WithImmediateWake (\r | |
| 65 | VOID\r | |
| 66 | );\r | |
| d4283a78 RN |
67 | \r |
| 68 | /**\r | |
| 69 | This function causes a systemwide reset. The exact type of the reset is\r | |
| 70 | defined by the EFI_GUID that follows the Null-terminated Unicode string passed\r | |
| 71 | into ResetData. If the platform does not recognize the EFI_GUID in ResetData\r | |
| 72 | the platform must pick a supported reset type to perform.The platform may\r | |
| 73 | optionally log the parameters from any non-normal reset that occurs.\r | |
| 74 | \r | |
| 75 | @param[in] DataSize The size, in bytes, of ResetData.\r | |
| 76 | @param[in] ResetData The data buffer starts with a Null-terminated string,\r | |
| 77 | followed by the EFI_GUID.\r | |
| 78 | **/\r | |
| 79 | VOID\r | |
| 80 | EFIAPI\r | |
| 81 | ResetPlatformSpecific (\r | |
| 82 | IN UINTN DataSize,\r | |
| 83 | IN VOID *ResetData\r | |
| 84 | );\r | |
| 85 | \r | |
| 30143b15 | 86 | #endif\r |