X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;ds=sidebyside;f=MdePkg%2FInclude%2FProtocol%2FS3SaveState.h;h=5a72dd860d65c48de015a03deaaa939750606c15;hb=fed5f4475948fd09cb71ba4c9f3918af1c3a7ba6;hp=a535764292153ea3d2e1d85e2c4ea3b5f219630d;hpb=938e182117505d0e42759ba85b15599bd7844ec7;p=mirror_edk2.git diff --git a/MdePkg/Include/Protocol/S3SaveState.h b/MdePkg/Include/Protocol/S3SaveState.h index a535764292..5a72dd860d 100644 --- a/MdePkg/Include/Protocol/S3SaveState.h +++ b/MdePkg/Include/Protocol/S3SaveState.h @@ -5,8 +5,8 @@ to be replayed during an S3 resume. This protocol is not required for all platforms. - Copyright (c) 2009, Intel Corporation - All rights reserved. This program and the accompanying materials + Copyright (c) 2009 - 2011, 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 @@ -14,6 +14,10 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + @par Revision Reference: + This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 5: + Standards + **/ #ifndef __S3_SAVE_STATE_H__ @@ -22,45 +26,6 @@ #define EFI_S3_SAVE_STATE_PROTOCOL_GUID \ { 0xe857caf6, 0xc046, 0x45dc, { 0xbe, 0x3f, 0xee, 0x7, 0x65, 0xfb, 0xa8, 0x87 }} -//******************************************* -// EFI Boot Script Opcode definitions -//******************************************* -#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE 0x00 -#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE 0x01 -#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE 0x02 -#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE 0x03 -#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE 0x04 -#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE 0x05 -#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE 0x06 -#define EFI_BOOT_SCRIPT_STALL_OPCODE 0x07 -#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE 0x08 -#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x09 -#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE 0x0A -#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE 0x0B -#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C -#define EFI_BOOT_SCRIPT_IO_POLL_OPCODE 0x0D -#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x0E -#define EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE 0x0F -#define EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE 0x10 - -//******************************************* -// EFI_BOOT_SCRIPT_WIDTH -//******************************************* -typedef enum { - EfiBootScriptWidthUint8, - EfiBootScriptWidthUint16, - EfiBootScriptWidthUint32, - EfiBootScriptWidthUint64, - EfiBootScriptWidthFifoUint8, - EfiBootScriptWidthFifoUint16, - EfiBootScriptWidthFifoUint32, - EfiBootScriptWidthFifoUint64, - EfiBootScriptWidthFillUint8, - EfiBootScriptWidthFillUint16, - EfiBootScriptWidthFillUint32, - EfiBootScriptWidthFillUint64, - EfiBootScriptWidthMaximum -} EFI_BOOT_SCRIPT_WIDTH; typedef VOID *EFI_S3_BOOT_SCRIPT_POSITION; @@ -86,8 +51,8 @@ typedef struct _EFI_S3_SAVE_STATE_PROTOCOL EFI_S3_SAVE_STATE_PROTOCOL; typedef EFI_STATUS (EFIAPI *EFI_S3_SAVE_STATE_WRITE)( - IN CONST struct _EFI_S3_SAVE_STATE_PROTOCOL *This, - IN UINT16 OpCode, + IN CONST EFI_S3_SAVE_STATE_PROTOCOL *This, + IN UINT16 OpCode, ... ); @@ -130,10 +95,10 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_S3_SAVE_STATE_INSERT)( - IN struct _EFI_S3_SAVE_STATE_PROTOCOL *This, - IN BOOLEAN BeforeOrAfter, - IN OUT EFI_S3_BOOT_SCRIPT_POSITION *Position OPTIONAL, - IN UINT16 OpCode, + IN CONST EFI_S3_SAVE_STATE_PROTOCOL *This, + IN BOOLEAN BeforeOrAfter, + IN OUT EFI_S3_BOOT_SCRIPT_POSITION *Position OPTIONAL, + IN UINT16 OpCode, ... ); @@ -160,18 +125,18 @@ EFI_STATUS @retval EFI_SUCCESS The label already exists or was inserted. @retval EFI_NOT_FOUND The label did not already exist and CreateifNotFound was FALSE. - @retval EFI_INVALID_PARAMETER The Opcode is an invalid opcode value. + @retval EFI_INVALID_PARAMETER The Label is NULL or points to an empty string. @retval EFI_INVALID_PARAMETER The Position is not a valid position in the boot script table. @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script. **/ typedef EFI_STATUS (EFIAPI *EFI_S3_SAVE_STATE_LABEL)( - IN struct _EFI_S3_SAVE_STATE_PROTOCOL *This, - IN BOOLEAN BeforeOrAfter, - IN BOOLEAN CreateIfNotFound, - IN OUT EFI_S3_BOOT_SCRIPT_POSITION *Position OPTIONAL, - IN CONST CHAR8 *Label + IN CONST EFI_S3_SAVE_STATE_PROTOCOL *This, + IN BOOLEAN BeforeOrAfter, + IN BOOLEAN CreateIfNotFound, + IN OUT EFI_S3_BOOT_SCRIPT_POSITION *Position OPTIONAL, + IN CONST CHAR8 *Label ); /** @@ -186,16 +151,17 @@ EFI_STATUS @param[in] Position2 The positions in the boot script table to compare. @param[out] RelativePosition On return, points to the result of the comparison. - @retval EFI_SUCCESS The label already exists or was inserted. + @retval EFI_SUCCESS The operation succeeded. @retval EFI_INVALID_PARAMETER The Position1 or Position2 is not a valid position in the boot script table. + @retval EFI_INVALID_PARAMETER The RelativePosition is NULL. **/ typedef EFI_STATUS (EFIAPI *EFI_S3_SAVE_STATE_COMPARE)( - IN struct _EFI_S3_SAVE_STATE_PROTOCOL *This, - IN EFI_S3_BOOT_SCRIPT_POSITION Position1, - IN EFI_S3_BOOT_SCRIPT_POSITION Position2, - OUT UINTN *RelativePosition + IN CONST EFI_S3_SAVE_STATE_PROTOCOL *This, + IN EFI_S3_BOOT_SCRIPT_POSITION Position1, + IN EFI_S3_BOOT_SCRIPT_POSITION Position2, + OUT UINTN *RelativePosition ); struct _EFI_S3_SAVE_STATE_PROTOCOL {