MdeModulePkg: Process Sys Prep load options in BdsDxe driver.

[mirror_edk2.git] / MdeModulePkg / Include / Library / ResetSystemLib.h

diff --git a/MdeModulePkg/Include/Library/ResetSystemLib.h b/MdeModulePkg/Include/Library/ResetSystemLib.h
index fd92135d7a17f46ec99031cefc867f70933bfd0f..f95293470b7a2eb121163ec5feddbd25d1c99cb1 100644 (file)
--- a/MdeModulePkg/Include/Library/ResetSystemLib.h
+++ b/MdeModulePkg/Include/Library/ResetSystemLib.h
@@ -1,15 +1,15 @@
 /** @file\r
   System reset Library Services.  This library class defines a set of\r
 /** @file\r
   System reset Library Services.  This library class defines a set of\r

-  methods to reset whole system.\r
+  methods that reset the whole system.\r

 \r
 \r

-  Copyright (c) 2005 - 2007, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-  \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                            \r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -17,13 +17,12 @@
 #define __RESET_SYSTEM_LIB_H__\r
 \r
 /**\r
 #define __RESET_SYSTEM_LIB_H__\r
 \r
 /**\r

-  Calling this function causes a system-wide reset. This sets\r
-  all circuitry within the system to its initial state. This type of reset \r
+  This function causes a system-wide reset (cold reset), in which\r
+  all circuitry within the system returns to its initial state. This type of reset \r

   is asynchronous to system operation and operates without regard to \r
   cycle boundaries.\r
 \r
   is asynchronous to system operation and operates without regard to \r
   cycle boundaries.\r
 \r

-  System reset should not return, if it returns, it means the system does \r
-  not support cold reset.\r
+  If this function returns, it means that the system does not support cold reset. \r

 **/\r
 VOID\r
 EFIAPI\r
 **/\r
 VOID\r
 EFIAPI\r


@@ -32,11 +31,10 @@ ResetCold (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Calling this function causes a system-wide initialization. The processors \r
-  are set to their initial state, and pending cycles are not corrupted.\r
+  This function causes a system-wide initialization (warm reset), in which all processors \r
+  are set to their initial state. Pending cycles are not corrupted.\r

 \r
 \r

-  System reset should not return, if it returns, it means the system does \r
-  not support warm reset.\r
+  If this function returns, it means that the system does not support warm reset.\r

 **/\r
 VOID\r
 EFIAPI\r
 **/\r
 VOID\r
 EFIAPI\r


@@ -45,11 +43,10 @@ ResetWarm (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Calling this function causes the system to enter a power state equivalent \r
+  This function causes the system to enter a power state equivalent \r

   to the ACPI G2/S5 or G3 states.\r
   \r
   to the ACPI G2/S5 or G3 states.\r
   \r

-  System shutdown should not return, if it returns, it means the system does \r
-  not support shut down reset.\r
+  If this function returns, it means that the system does not support shutdown reset.\r

 **/\r
 VOID\r
 EFIAPI\r
 **/\r
 VOID\r
 EFIAPI\r


@@ -58,15 +55,14 @@ ResetShutdown (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Calling this function causes the system to enter S3 and then\r
-  wake up immediately.\r
+  This function causes the system to enter S3 and then wake up immediately.\r

   \r
   \r

-  Reset update should not return, if it returns, it means the\r
-  library does not the feature.\r
+  If this function returns, it means that the system does not support S3 feature.\r

 **/\r
 VOID\r
 EFIAPI\r
 EnterS3WithImmediateWake (\r
   VOID\r
   );\r
 **/\r
 VOID\r
 EFIAPI\r
 EnterS3WithImmediateWake (\r
   VOID\r
   );\r

+  \r

 #endif\r
 #endif\r