Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...

[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, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\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 which is different from PI specification: \r
/// To 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 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 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 indicate the start of the boot script table.\r
///\r
#define FRAMEWORK_EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA\r
///\r
/// The opcode indicate the end of the boot script table.\r
///\r
#define FRAMEWORK_EFI_BOOT_SCRIPT_TERMINATE_OPCODE              0xFF\r
\r
\r
#endif\r