/** @file\r
Internal header file for SMM S3 Boot Script Saver state driver.\r
\r
- Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
Adds a record into S3 boot script table.\r
\r
This function is used to store a boot script record into a given boot\r
- script table. If the table specified by TableName is nonexistent in the \r
- system, a new table will automatically be created and then the script record \r
- will be added into the new table. This function is responsible for allocating \r
+ script table. If the table specified by TableName is nonexistent in the\r
+ system, a new table will automatically be created and then the script record\r
+ will be added into the new table. This function is responsible for allocating\r
necessary memory for the script.\r
\r
- This function has a variable parameter list. The exact parameter list depends on \r
- the OpCode that is passed into the function. If an unsupported OpCode or illegal \r
+ This function has a variable parameter list. The exact parameter list depends on\r
+ the OpCode that is passed into the function. If an unsupported OpCode or illegal\r
parameter list is passed in, this function returns EFI_INVALID_PARAMETER.\r
If there are not enough resources available for storing more scripts, this function returns\r
EFI_OUT_OF_RESOURCES.\r
\r
@param This A pointer to the EFI_S3_SAVE_STATE_PROTOCOL instance.\r
@param OpCode The operation code (opcode) number.\r
- @param ... Argument list that is specific to each opcode. \r
+ @param ... Argument list that is specific to each opcode.\r
\r
@retval EFI_SUCCESS The operation succeeded. A record was added into the\r
specified script table.\r
@retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
- If the opcode is unknow or not supported because of the PCD \r
+ If the opcode is unknow or not supported because of the PCD\r
Feature Flags.\r
@retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r
\r
inserted, either before or after, depending on BeforeOrAfter. On exit, specifies\r
the position of the inserted opcode in the boot script table.\r
@param OpCode The operation code (opcode) number.\r
- @param ... Argument list that is specific to each opcode. \r
+ @param ... Argument list that is specific to each opcode.\r
\r
@retval EFI_SUCCESS The operation succeeded. A record was added into the\r
specified script table.\r
\r
@retval EFI_SUCCESS The label already exists or was inserted.\r
@retval EFI_INVALID_PARAMETER The Opcode is an invalid opcode value or the Position is not a valid position in the boot script table..\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
/**\r
Compare two positions in the boot script table and return their relative position.\r
- \r
+\r
This function compares two positions in the boot script table and returns their relative positions. If\r
Position1 is before Position2, then -1 is returned. If Position1 is equal to Position2,\r
then 0 is returned. If Position1 is after Position2, then 1 is returned.\r
- \r
+\r
@param This A pointer to the EFI_S3_SAVE_STATE_PROTOCOL instance.\r
@param Position1 The positions in the boot script table to compare\r
@param Position2 The positions in the boot script table to compare\r
@param RelativePosition On return, points to the result of the comparison\r
\r
- @retval EFI_SUCCESS The operation succeeded. \r
+ @retval EFI_SUCCESS The operation succeeded.\r
@retval EFI_INVALID_PARAMETER The Position1 or Position2 is not a valid position in the boot script table.\r
\r
**/\r
EFI_STATUS\r
-EFIAPI \r
+EFIAPI\r
BootScriptCompare (\r
IN CONST EFI_S3_SAVE_STATE_PROTOCOL *This,\r
IN EFI_S3_BOOT_SCRIPT_POSITION Position1,\r
IN EFI_S3_BOOT_SCRIPT_POSITION Position2,\r
OUT UINTN *RelativePosition\r
);\r
- \r
+\r
#endif //_INTERNAL_SMM_S3_SAVE_STATE_H_\r