IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h

   1 /** @file
   2   This file declares the Boot Script Executer PPI.
   3
   4   This PPI is published by a PEIM upon dispatch and provides an execution engine for the
   5   Framework boot script. This PEIM should be platform neutral and have no specific knowledge of
   6   platform instructions or other information. The ability to interpret the boot script depends on the
   7   abundance of other PPIs that are available. For example, if the script requests an SMBus command
   8   execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it
   9   by issuing the native IA-32 instruction.
  10
  11 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
  12 SPDX-License-Identifier: BSD-2-Clause-Patent
  13
  14   @par Revision Reference:
  15   This PPI is defined in Framework of EFI BootScript spec.
  16   Version 0.91.
  17
  18 **/
  19
  20 #ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_
  21 #define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_
  22
  23 #define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \
  24   { \
  25     0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \
  26   }
  27
  28 typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;
  29
  30 /**
  31   Executes the Framework boot script table.
  32
  33   @param  PeiServices    A pointer to the system PEI Services Table.
  34   @param  This           A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
  35   @param  Address        The physical memory address where the table is stored.
  36                          It must be zero if the table to be executed is stored in
  37                          a firmware volume file.
  38   @param  FvFile         The firmware volume file name that contains the table to
  39                          be executed. It must be NULL if the table to be executed
  40                          is stored in physical memory.
  41
  42   @retval EFI_SUCCESS           The boot script table was executed successfully.
  43   @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.
  44   @retval EFI_NOT_FOUND         The file name specified in FvFile cannot be found.
  45   @retval EFI_UNSUPPORTED       The format of the boot script table is invalid.
  46                                 Or, an unsupported opcode occurred in the table.
  47                                 Or there were opcode execution errors, such as an
  48                                 insufficient dependency.
  49
  50 **/
  51 typedef
  52 EFI_STATUS
  53 (EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(
  54   IN     EFI_PEI_SERVICES                        **PeiServices,
  55   IN     EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI        *This,
  56   IN     EFI_PHYSICAL_ADDRESS                    Address,
  57   IN     EFI_GUID                                *FvFile OPTIONAL
  58   );
  59
  60 ///
  61 /// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and
  62 /// executes the Framework boot script table.
  63 ///
  64 struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {
  65   ///
  66   /// Executes a boot script table.
  67   ///
  68   EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;
  69 };
  70
  71 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;
  72
  73 #endif