Home | History | Annotate | Download | only in Framework
      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 - 2010, Intel Corporation. All rights reserved.<BR>
      6 This program and the accompanying materials are licensed and made available under
      7 the terms and conditions of the BSD License that accompanies this distribution.
      8 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 **/
     15 
     16 #ifndef _BOOT_SCRIPT_H_
     17 #define _BOOT_SCRIPT_H_
     18 
     19 #include <PiDxe.h>
     20 ///
     21 /// The framework implementation defines follow opcode that are different from the PI specification:
     22 /// Add FRAMEWORK_ prefix to avoid naming conflict.
     23 ///
     24 /// S3 Boot Script Table identifier.
     25 ///
     26 #define FRAMEWORK_EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00
     27 ///
     28 /// The opcode is used to add a record for memory reads of the memory location and continues when the
     29 /// exit criteria is satisfied, or after a defined duration.
     30 ///
     31 #define FRAMEWORK_EFI_BOOT_SCRIPT_MEM_POLL_OPCODE               0x09
     32 ///
     33 /// The opcode is used to add a record for dispatching specified arbitrary code into a specified
     34 /// boot script table.
     35 ///
     36 #define FRAMEWORK_EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE             0x0D
     37 ///
     38 /// The opcode indicates the start of the boot script table.
     39 ///
     40 #define FRAMEWORK_EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA
     41 ///
     42 /// The opcode indicates the end of the boot script table.
     43 ///
     44 #define FRAMEWORK_EFI_BOOT_SCRIPT_TERMINATE_OPCODE              0xFF
     45 
     46 
     47 #endif
     48