EdkCompatibilityPkg/Foundation/Framework/Protocol/BootScriptSave/BootScriptSave.h

   1 /*++
   2
   3 Copyright (c) 1999 - 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   BootScriptSave.h
  15
  16 Abstract:
  17
  18   S3 Save Protocol
  19
  20 --*/
  21
  22 #ifndef _BOOT_SCRIPT_SAVE_PROTOCOL_H
  23 #define _BOOT_SCRIPT_SAVE_PROTOCOL_H
  24
  25 //
  26 // Includes
  27 //
  28 #include "Tiano.h"
  29
  30 //
  31 // Forward reference for pure ANSI compatability
  32 //
  33 EFI_FORWARD_DECLARATION (EFI_BOOT_SCRIPT_SAVE_PROTOCOL);
  34
  35 //
  36 // S3 Save Protocol GUID
  37 //
  38 #define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID \
  39   { \
  40     0x470e1529, 0xb79e, 0x4e32, 0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 \
  41   }
  42
  43 //
  44 // Protocol Data Structures
  45 //
  46 typedef
  47 EFI_STATUS
  48 EFI_BOOTSERVICE
  49 (EFIAPI *EFI_BOOT_SCRIPT_WRITE) (
  50   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            * This,
  51   IN UINT16                                   TableName,
  52   IN UINT16                                   OpCode,
  53   ...
  54   );
  55
  56 typedef
  57 EFI_STATUS
  58 EFI_BOOTSERVICE
  59 (EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (
  60   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            * This,
  61   IN UINT16                                   TableName,
  62   OUT EFI_PHYSICAL_ADDRESS                    * Address
  63   );
  64
  65 //
  66 // S3 Save Protocol data structure
  67 //
  68 typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {
  69   EFI_BOOT_SCRIPT_WRITE       Write;
  70   EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;
  71 } EFI_BOOT_SCRIPT_SAVE_PROTOCOL;
  72
  73 extern EFI_GUID gEfiBootScriptSaveGuid;
  74
  75 #endif