IntelFrameworkPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / BootScript.h

/** @file\r
  This file contains the boot script defintions that are shared between the\r
  Boot Script Executor PPI and the Boot Script Save Protocol.\r
\r
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _BOOT_SCRIPT_H_\r
#define _BOOT_SCRIPT_H_\r
\r
#include <PiDxe.h>\r
///\r
/// The framework implementation defines follow opcode that are different from the PI specification:\r
/// Add FRAMEWORK_ prefix to avoid naming conflict.\r
///\r
/// S3 Boot Script Table identifier.\r
///\r
#define FRAMEWORK_EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00\r
///\r
/// The opcode is used to add a record for memory reads of the memory location and continues when the\r
/// exit criteria is satisfied, or after a defined duration.\r
///\r
#define FRAMEWORK_EFI_BOOT_SCRIPT_MEM_POLL_OPCODE               0x09\r
///\r
/// The opcode is used to add a record for dispatching specified arbitrary code into a specified\r
/// boot script table.\r
///\r
#define FRAMEWORK_EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE             0x0D\r
///\r
/// The opcode indicates the start of the boot script table.\r
///\r
#define FRAMEWORK_EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA\r
///\r
/// The opcode indicates the end of the boot script table.\r
///\r
#define FRAMEWORK_EFI_BOOT_SCRIPT_TERMINATE_OPCODE              0xFF\r
\r
\r
#endif\r