Reviewed the description in the FatBinPkg .dec file.

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

/** @file\r
  Include file that supportes Framework extension to the UEFI 2.0 spec.\r
\r
  This include file must only contain things defined in the Framework\r
  specifications. If a code construct is defined in the Framework specification\r
  it must be included by this include file.\r
\r
  Copyright (c) 2007, 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
  Module Name:    FrameworkDxeCis.h\r
\r
  @par Revision Reference:\r
  This Protocol is defined in Framework for EFI Driver Execution Environment \r
  Core Interface Specification. \r
  Version 0.9.\r
\r
**/\r
\r
#ifndef _FRAMEWORK_DXE_CIS_H_\r
#define _FRAMEWORK_DXE_CIS_H_\r
\r
#include <PiDxe.h>\r
#include <Framework/StatusCode.h>\r
#include <Protocol/StatusCode.h>\r
\r
//\r
// Function prototype for invoking a function on an Application Processor\r
// Used by both the SMM infrastructure and the MP Services Protocol\r
//\r
typedef\r
VOID\r
(EFIAPI *EFI_AP_PROCEDURE)(\r
  IN  VOID                          *Buffer\r
  );\r
\r
typedef struct {\r
  EFI_TABLE_HEADER                  Hdr;\r
  //\r
  // Time services\r
  //\r
  EFI_GET_TIME                      GetTime;\r
  EFI_SET_TIME                      SetTime;\r
  EFI_GET_WAKEUP_TIME               GetWakeupTime;\r
  EFI_SET_WAKEUP_TIME               SetWakeupTime;\r
  //\r
  // Virtual memory services\r
  //\r
  EFI_SET_VIRTUAL_ADDRESS_MAP       SetVirtualAddressMap;\r
  EFI_CONVERT_POINTER               ConvertPointer;\r
  //\r
  // Variable services\r
  //\r
  EFI_GET_VARIABLE                  GetVariable;\r
  EFI_GET_NEXT_VARIABLE_NAME        GetNextVariableName;\r
  EFI_SET_VARIABLE                  SetVariable;\r
  //\r
  // Misc\r
  //\r
  EFI_GET_NEXT_HIGH_MONO_COUNT      GetNextHighMonotonicCount;\r
  EFI_RESET_SYSTEM                  ResetSystem;\r
  //\r
  // Framework extension to UEFI 2.0 runtime table\r
  // It was moved to a protocol to not conflict with UEFI 2.0\r
  //\r
  EFI_REPORT_STATUS_CODE            ReportStatusCode;\r
} FRAMEWORK_EFI_RUNTIME_SERVICES;\r
\r
#define EFI_EVENT_RUNTIME_CONTEXT       0x20000000\r
#define EFI_EVENT_NOTIFY_SIGNAL_ALL     0x00000400\r
#define EFI_EVENT_SIGNAL_READY_TO_BOOT  0x00000203\r
#define EFI_EVENT_SIGNAL_LEGACY_BOOT    0x00000204\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL          Header;\r
  EFI_GUID                          TianoSpecificDevicePath;\r
  UINT32                            Type;\r
} TIANO_DEVICE_PATH;\r
\r
#define TIANO_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE    0x01\r
typedef struct {\r
  TIANO_DEVICE_PATH                 Tiano;\r
  EFI_GUID                          NameGuid;\r
} FRAMEWORK_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;\r
\r
#endif\r