IntelFrameworkPkg/Include/Framework/BootScript.h

   1 /** @file
   2   This file contains the boot script defintions that are shared between the
   3   Boot Script Executor PPI and the Boot Script Save Protocol.
   4
   5 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _BOOT_SCRIPT_H_
  11 #define _BOOT_SCRIPT_H_
  12
  13 #include <PiDxe.h>
  14 ///
  15 /// The framework implementation defines follow opcode that are different from the PI specification:
  16 /// Add FRAMEWORK_ prefix to avoid naming conflict.
  17 ///
  18 /// S3 Boot Script Table identifier.
  19 ///
  20 #define FRAMEWORK_EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00
  21 ///
  22 /// The opcode is used to add a record for memory reads of the memory location and continues when the
  23 /// exit criteria is satisfied, or after a defined duration.
  24 ///
  25 #define FRAMEWORK_EFI_BOOT_SCRIPT_MEM_POLL_OPCODE               0x09
  26 ///
  27 /// The opcode is used to add a record for dispatching specified arbitrary code into a specified
  28 /// boot script table.
  29 ///
  30 #define FRAMEWORK_EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE             0x0D
  31 ///
  32 /// The opcode indicates the start of the boot script table.
  33 ///
  34 #define FRAMEWORK_EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA
  35 ///
  36 /// The opcode indicates the end of the boot script table.
  37 ///
  38 #define FRAMEWORK_EFI_BOOT_SCRIPT_TERMINATE_OPCODE              0xFF
  39
  40
  41 #endif