IntelFrameworkPkg/Include/Protocol/BootScriptSave.h File Reference


Data Structures

struct  _EFI_BOOT_SCRIPT_SAVE_PROTOCOL

Defines

#define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_BOOT_SCRIPT_SAVE_PROTOCOL 
EFI_BOOT_SCRIPT_SAVE_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_BOOT_SCRIPT_WRITE )(IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This, IN UINT16 TableName, IN UINT16 OpCode,...)
typedef EFI_STATUS(EFIAPI * EFI_BOOT_SCRIPT_CLOSE_TABLE )(IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This, IN UINT16 TableName, OUT EFI_PHYSICAL_ADDRESS *Address)

Variables

EFI_GUID gEfiBootScriptSaveProtocolGuid

Detailed Description

This protocol is used to store or record various boot scripts into boot script tables.

Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This protocol defined in the Boot Script Specification, Version 0.91.

Define Documentation

#define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID

Value:

{ \
    0x470e1529, 0xb79e, 0x4e32, {0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 } \
  }
S3 Save Protocol GUID.


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_BOOT_SCRIPT_CLOSE_TABLE)(IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This, IN UINT16 TableName, OUT EFI_PHYSICAL_ADDRESS *Address)

Closes the specified script table.

Parameters:
This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
TableName The name of the script table.
Address A pointer to the physical address where the table begins.
Return values:
EFI_SUCCESS The table was successfully returned.
EFI_NOT_FOUND The specified table was not created previously.
EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.

typedef EFI_STATUS(EFIAPI * EFI_BOOT_SCRIPT_WRITE)(IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This, IN UINT16 TableName, IN UINT16 OpCode,...)

Adds a record into a specified Framework boot script table.

Parameters:
This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
TableName The name of the script table. Currently, the only meaningful value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.
OpCode The operation code (opcode) number.
... The argument list that is specific to each opcode.
Return values:
EFI_SUCCESS The operation succeeded. A record was added into the specified script table.
EFI_INVALID_PARAMETER The parameter is illegal, or the given boot script is not supported.
EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1