IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h File Reference


Data Structures

struct  _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI

Defines

#define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID

Typedefs

typedef struct
_EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI 
EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI
typedef EFI_STATUS(EFIAPI * EFI_PEI_BOOT_SCRIPT_EXECUTE )(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This, IN EFI_PHYSICAL_ADDRESS Address, IN EFI_GUID *FvFile)

Variables

EFI_GUID gEfiPeiBootScriptExecuterPpiGuid

Detailed Description

This file declares the Boot Script Executer PPI.

This PPI is published by a PEIM upon dispatch and provides an execution engine for the Framework boot script. This PEIM should be platform neutral and have no specific knowledge of platform instructions or other information. The ability to interpret the boot script depends on the abundance of other PPIs that are available. For example, if the script requests an SMBus command execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it by issuing the native IA-32 instruction.

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 PPI is defined in Framework of EFI BootScript spec. Version 0.91.

Define Documentation

#define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID

Value:

{ \
    0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_PEI_BOOT_SCRIPT_EXECUTE)(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This, IN EFI_PHYSICAL_ADDRESS Address, IN EFI_GUID *FvFile)

Executes the Framework boot script table.

Parameters:
PeiServices A pointer to the system PEI Services Table.
This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
Address The physical memory address where the table is stored. It must be zero if the table to be executed is stored in a firmware volume file.
FvFile The firmware volume file name that contains the table to be executed. It must be NULL if the table to be executed is stored in physical memory.
Return values:
EFI_SUCCESS The boot script table was executed successfully.
EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.
EFI_NOT_FOUND The file name specified in FvFile cannot be found.
EFI_UNSUPPORTED The format of the boot script table is invalid. Or, an unsupported opcode occurred in the table. Or there were opcode execution errors, such as an insufficient dependency.


Variable Documentation


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