]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/S3SaveState.h
Update the copyright notice format
[mirror_edk2.git] / MdePkg / Include / Protocol / S3SaveState.h
index 53442be2be8600da742ba98fba5422d8c0cf306a..1c8ba72e11e0dd9d61e26130697c2b980cfafa65 100644 (file)
@@ -5,8 +5,8 @@
   to be replayed during an S3 resume.\r
   This protocol is not required for all platforms.\r
   \r
-  Copyright (c) 2009, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  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
 #define EFI_S3_SAVE_STATE_PROTOCOL_GUID \\r
     { 0xe857caf6, 0xc046, 0x45dc, { 0xbe, 0x3f, 0xee, 0x7, 0x65, 0xfb, 0xa8, 0x87 }}\r
 \r
-//*******************************************\r
-// EFI Boot Script Opcode definitions\r
-//*******************************************\r
-#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE                 0x00\r
-#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE            0x01\r
-#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE                0x02\r
-#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE           0x03\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE         0x04\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE    0x05\r
-#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE            0x06\r
-#define EFI_BOOT_SCRIPT_STALL_OPCODE                    0x07\r
-#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE                 0x08\r
-#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE               0x09\r
-#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE              0x0A\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE        0x0B\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE   0x0C\r
-#define EFI_BOOT_SCRIPT_IO_POLL_OPCODE                  0x0D\r
-#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE                 0x0E\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE          0x0F\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE         0x10\r
-\r
-//*******************************************\r
-// EFI_BOOT_SCRIPT_WIDTH\r
-//*******************************************\r
-typedef enum {\r
-  EfiBootScriptWidthUint8,\r
-  EfiBootScriptWidthUint16,\r
-  EfiBootScriptWidthUint32,\r
-  EfiBootScriptWidthUint64,\r
-  EfiBootScriptWidthFifoUint8,\r
-  EfiBootScriptWidthFifoUint16,\r
-  EfiBootScriptWidthFifoUint32,\r
-  EfiBootScriptWidthFifoUint64,\r
-  EfiBootScriptWidthFillUint8,\r
-  EfiBootScriptWidthFillUint16,\r
-  EfiBootScriptWidthFillUint32,\r
-  EfiBootScriptWidthFillUint64,\r
-  EfiBootScriptWidthMaximum\r
-} EFI_BOOT_SCRIPT_WIDTH;\r
 \r
 typedef VOID *EFI_S3_BOOT_SCRIPT_POSITION;\r
 \r
@@ -90,8 +51,8 @@ typedef struct _EFI_S3_SAVE_STATE_PROTOCOL  EFI_S3_SAVE_STATE_PROTOCOL;
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_WRITE)(\r
-   IN CONST struct _EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
-   IN       UINT16                              OpCode,\r
+   IN CONST EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
+   IN       UINT16                      OpCode,\r
    ...\r
 );\r
 \r
@@ -134,10 +95,10 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_INSERT)(\r
-   IN       struct _EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
-   IN       BOOLEAN                             BeforeOrAfter,\r
-   IN OUT   EFI_S3_BOOT_SCRIPT_POSITION         *Position       OPTIONAL,\r
-   IN       UINT16                              OpCode,\r
+   IN CONST EFI_S3_SAVE_STATE_PROTOCOL  *This,\r
+   IN       BOOLEAN                     BeforeOrAfter,\r
+   IN OUT   EFI_S3_BOOT_SCRIPT_POSITION *Position       OPTIONAL,\r
+   IN       UINT16                      OpCode,\r
    ...\r
 );\r
 \r
@@ -171,11 +132,11 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_LABEL)(\r
-   IN     struct _EFI_S3_SAVE_STATE_PROTOCOL    *This,\r
-   IN     BOOLEAN                               BeforeOrAfter,\r
-   IN     BOOLEAN                               CreateIfNotFound,\r
-   IN OUT EFI_S3_BOOT_SCRIPT_POSITION           *Position OPTIONAL,\r
-   IN     CONST CHAR8                           *Label\r
+   IN CONST  EFI_S3_SAVE_STATE_PROTOCOL      *This,\r
+   IN        BOOLEAN                         BeforeOrAfter,\r
+   IN        BOOLEAN                         CreateIfNotFound,\r
+   IN OUT    EFI_S3_BOOT_SCRIPT_POSITION     *Position OPTIONAL,\r
+   IN CONST  CHAR8                           *Label\r
 );\r
 \r
 /**\r
@@ -196,10 +157,10 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_S3_SAVE_STATE_COMPARE)(\r
-   IN   struct _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
+   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
 struct _EFI_S3_SAVE_STATE_PROTOCOL {\r