X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FLibrary%2FResetSystemLib.h;h=f95293470b7a2eb121163ec5feddbd25d1c99cb1;hb=1634214dbb06057e331b85727947683d3b3bf2f4;hp=fd92135d7a17f46ec99031cefc867f70933bfd0f;hpb=30143b15817ae2bd3701cbc15bb435ababf34d2d;p=mirror_edk2.git diff --git a/MdeModulePkg/Include/Library/ResetSystemLib.h b/MdeModulePkg/Include/Library/ResetSystemLib.h index fd92135d7a..f95293470b 100644 --- a/MdeModulePkg/Include/Library/ResetSystemLib.h +++ b/MdeModulePkg/Include/Library/ResetSystemLib.h @@ -1,15 +1,15 @@ /** @file System reset Library Services. This library class defines a set of - methods to reset whole system. + methods that reset the whole system. - Copyright (c) 2005 - 2007, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. +The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -17,13 +17,12 @@ #define __RESET_SYSTEM_LIB_H__ /** - Calling this function causes a system-wide reset. This sets - all circuitry within the system to its initial state. This type of reset + This function causes a system-wide reset (cold reset), in which + all circuitry within the system returns to its initial state. This type of reset is asynchronous to system operation and operates without regard to cycle boundaries. - System reset should not return, if it returns, it means the system does - not support cold reset. + If this function returns, it means that the system does not support cold reset. **/ VOID EFIAPI @@ -32,11 +31,10 @@ ResetCold ( ); /** - Calling this function causes a system-wide initialization. The processors - are set to their initial state, and pending cycles are not corrupted. + This function causes a system-wide initialization (warm reset), in which all processors + are set to their initial state. Pending cycles are not corrupted. - System reset should not return, if it returns, it means the system does - not support warm reset. + If this function returns, it means that the system does not support warm reset. **/ VOID EFIAPI @@ -45,11 +43,10 @@ ResetWarm ( ); /** - Calling this function causes the system to enter a power state equivalent + This function causes the system to enter a power state equivalent to the ACPI G2/S5 or G3 states. - System shutdown should not return, if it returns, it means the system does - not support shut down reset. + If this function returns, it means that the system does not support shutdown reset. **/ VOID EFIAPI @@ -58,15 +55,14 @@ ResetShutdown ( ); /** - Calling this function causes the system to enter S3 and then - wake up immediately. + This function causes the system to enter S3 and then wake up immediately. - Reset update should not return, if it returns, it means the - library does not the feature. + If this function returns, it means that the system does not support S3 feature. **/ VOID EFIAPI EnterS3WithImmediateWake ( VOID ); + #endif