MdePkg/Include/Protocol/BootScriptSave.h

   1 /** @file
   2   Definition of the Boot Script Save protocol.
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  BootScriptSave.h
  14
  15   @par Revision Reference:
  16   This protocol defined in the Boot Script Specification, Version 0.91.
  17
  18 **/
  19
  20 #ifndef _BOOT_SCRIPT_SAVE_PROTOCOL_H
  21 #define _BOOT_SCRIPT_SAVE_PROTOCOL_H
  22
  23 //
  24 // S3 Save Protocol GUID
  25 //
  26 #define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID \
  27   { \
  28     0x470e1529, 0xb79e, 0x4e32, {0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 } \
  29   }
  30
  31 typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;
  32
  33 //
  34 // Protocol Member_Function
  35 //
  36 /**
  37   Adds a record into a specified Framework boot script table.
  38
  39   @param  This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
  40
  41   @param  TableName Name of the script table.Currently, the only meaningful
  42   value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.
  43
  44   @param  OpCode The operation code (opcode) number.
  45
  46   @param  ... Argument list that is specific to each opcode.
  47
  48   @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.
  49
  50   @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.
  51
  52   @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
  53
  54 **/
  55 typedef
  56 EFI_STATUS
  57 (EFIAPI *EFI_BOOT_SCRIPT_WRITE) (
  58   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            *This,
  59   IN UINT16                                   TableName,
  60   IN UINT16                                   OpCode,
  61   ...
  62   );
  63
  64 /**
  65   Closes the specified script table.
  66
  67   @param  This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
  68
  69   @param  TableName Name of the script table.
  70
  71   @param  Address A pointer to the physical address where the table begins.
  72
  73   @retval EFI_SUCCESS The table was successfully returned.
  74
  75   @retval EFI_NOT_FOUND The specified table was not created previously.
  76
  77   @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.
  78
  79 **/
  80 typedef
  81 EFI_STATUS
  82 (EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (
  83   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            *This,
  84   IN UINT16                                   TableName,
  85   OUT EFI_PHYSICAL_ADDRESS                    *Address
  86   );
  87
  88 //
  89 // S3 Save Protocol data structure
  90 //
  91 /**
  92   @par Protocol Description:
  93   The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions
  94   to store or record various boot scripts into boot script tables.
  95
  96   @param Write
  97   Writes various boot scripts to a boot script table.
  98
  99   @param CloseTable
 100   Retrieves and closes a script table.
 101
 102 **/
 103 struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {
 104   EFI_BOOT_SCRIPT_WRITE       Write;
 105   EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;
 106 };
 107
 108 extern EFI_GUID gEfiBootScriptSaveProtocolGuid;
 109
 110 #endif