Add comments on the definition of SPIN_LOCK_RELEASED & SPIN_LOCK_ACQUIRED

[mirror_edk2.git] / MdePkg / Include / Protocol / BootScriptSave.h

diff --git a/MdePkg/Include/Protocol/BootScriptSave.h b/MdePkg/Include/Protocol/BootScriptSave.h
index 496f79f0127feb0a49e48d1237ce8623737ea5c2..ae4d862cc4362e3a5d0f38539cda52fbc370fe56 100644 (file)
--- a/MdePkg/Include/Protocol/BootScriptSave.h
+++ b/MdePkg/Include/Protocol/BootScriptSave.h
@@ -36,20 +36,15 @@ typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;
 /**\r
   Adds a record into a specified Framework boot script table.\r
 \r
-  @param  This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
-  \r
-  @param  TableName Name of the script table.Currently, the only meaningful \r
-  value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.\r
-  \r
-  @param  OpCode The operation code (opcode) number.\r
-  \r
-  @param  ... Argument list that is specific to each opcode.\r
-\r
-  @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.\r
-  \r
+  @param  This                  A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
+  @param  TableName             Name of the script table.Currently, the only meaningful\r
+                                value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.\r
+  @param  OpCode                The operation code (opcode) number.\r
+  @param  ...                   Argument list that is specific to each opcode.\r
+\r
+  @retval EFI_SUCCESS           The operation succeeded. A record was added into the specified script table.\r
   @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r
+  @retval EFI_OUT_OF_RESOURCES  There is insufficient memory to store the boot script.\r
 \r
 **/\r
 typedef\r
@@ -64,17 +59,13 @@ EFI_STATUS
 /**\r
   Closes the specified script table.\r
 \r
-  @param  This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
-  \r
-  @param  TableName Name of the script table.\r
-  \r
-  @param  Address A pointer to the physical address where the table begins.\r
+  @param  This                  A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
+  @param  TableName             Name of the script table.\r
+  @param  Address               A pointer to the physical address where the table begins.\r
 \r
-  @retval EFI_SUCCESS The table was successfully returned.\r
-  \r
-  @retval EFI_NOT_FOUND The specified table was not created previously.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.\r
+  @retval EFI_SUCCESS           The table was successfully returned.\r
+  @retval EFI_NOT_FOUND         The specified table was not created previously.\r
+  @retval EFI_OUT_OF_RESOURCES  Memory is insufficient to hold the reorganized boot script table.\r
 \r
 **/\r
 typedef\r
@@ -105,6 +96,6 @@ struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {
   EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;\r
 };\r
 \r
-extern EFI_GUID gEfiBootScriptSaveGuid;\r
+extern EFI_GUID gEfiBootScriptSaveProtocolGuid;\r
 \r
 #endif\r