IntelFrameworkPkg/Include/Protocol/BootScriptSave.h

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