IntelFrameworkPkg/Include/Protocol/BootScriptSave.h

   1 /** @file
   2   Definition of the Boot Script Save protocol.
   3
   4   Copyright (c) 2007, 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 #include <PiDxe.h>
  24
  25 //
  26 // S3 Save Protocol GUID
  27 //
  28 #define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID \
  29   { \
  30     0x470e1529, 0xb79e, 0x4e32, {0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 } \
  31   }
  32
  33 typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;
  34
  35 //
  36 // Protocol Member_Function
  37 //
  38 /**
  39   Adds a record into a specified Framework boot script table.
  40
  41   @param  This                  A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
  42   @param  TableName             Name of the script table.Currently, the only meaningful
  43                                 value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.
  44   @param  OpCode                The operation code (opcode) number.
  45   @param  ...                   Argument list that is specific to each opcode.
  46
  47   @retval EFI_SUCCESS           The operation succeeded. A record was added into the specified script table.
  48   @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.
  49   @retval EFI_OUT_OF_RESOURCES  There is insufficient memory to store the boot script.
  50
  51 **/
  52 typedef
  53 EFI_STATUS
  54 (EFIAPI *EFI_BOOT_SCRIPT_WRITE) (
  55   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            *This,
  56   IN UINT16                                   TableName,
  57   IN UINT16                                   OpCode,
  58   ...
  59   );
  60
  61 /**
  62   Closes the specified script table.
  63
  64   @param  This                  A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
  65   @param  TableName             Name of the script table.
  66   @param  Address               A pointer to the physical address where the table begins.
  67
  68   @retval EFI_SUCCESS           The table was successfully returned.
  69   @retval EFI_NOT_FOUND         The specified table was not created previously.
  70   @retval EFI_OUT_OF_RESOURCES  Memory is insufficient to hold the reorganized boot script table.
  71
  72 **/
  73 typedef
  74 EFI_STATUS
  75 (EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (
  76   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            *This,
  77   IN UINT16                                   TableName,
  78   OUT EFI_PHYSICAL_ADDRESS                    *Address
  79   );
  80
  81 //
  82 // S3 Save Protocol data structure
  83 //
  84 /**
  85   @par Protocol Description:
  86   The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions
  87   to store or record various boot scripts into boot script tables.
  88
  89   @param Write
  90   Writes various boot scripts to a boot script table.
  91
  92   @param CloseTable
  93   Retrieves and closes a script table.
  94
  95 **/
  96 struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {
  97   EFI_BOOT_SCRIPT_WRITE       Write;
  98   EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;
  99 };
 100
 101 extern EFI_GUID gEfiBootScriptSaveProtocolGuid;
 102
 103 #endif
 104