From 297ce0faf35e99caac824858cf4a238fbc7f8c83 Mon Sep 17 00:00:00 2001 From: bxing Date: Wed, 4 Jul 2007 11:42:03 +0000 Subject: [PATCH] Renaming files/directories git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3050 6f19259b-4bc3-4df7-8a09-765794883524 --- .../{Common => Framework}/DataHubRecords.h | 0 .../{Common => Framework}/FrameworkDxeCis.h | 0 .../FrameworkFirmwareFileSystem.h | 0 .../FrameworkFirmwareVolumeHeader.h | 0 .../FrameworkFirmwareVolumeImageFormat.h | 0 .../{Common => Framework}/FrameworkHob.h | 0 .../{Common => Framework}/FrameworkLegacy16.h | 0 .../{Common => Framework}/FrameworkSmmCis.h | 0 .../FrameworkStatusCode.h | 0 .../FrameworkStatusCodeDataTypeId.h | 0 .../Include/Ppi/DeviceRecoveryModule.h | 131 ++++++++++++++++++ 11 files changed, 131 insertions(+) rename IntelFrameworkPkg/Include/{Common => Framework}/DataHubRecords.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkDxeCis.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkFirmwareFileSystem.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkFirmwareVolumeHeader.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkFirmwareVolumeImageFormat.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkHob.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkLegacy16.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkSmmCis.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkStatusCode.h (100%) rename IntelFrameworkPkg/Include/{Common => Framework}/FrameworkStatusCodeDataTypeId.h (100%) create mode 100644 IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h diff --git a/IntelFrameworkPkg/Include/Common/DataHubRecords.h b/IntelFrameworkPkg/Include/Framework/DataHubRecords.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/DataHubRecords.h rename to IntelFrameworkPkg/Include/Framework/DataHubRecords.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkDxeCis.h b/IntelFrameworkPkg/Include/Framework/FrameworkDxeCis.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkDxeCis.h rename to IntelFrameworkPkg/Include/Framework/FrameworkDxeCis.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkFirmwareFileSystem.h b/IntelFrameworkPkg/Include/Framework/FrameworkFirmwareFileSystem.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkFirmwareFileSystem.h rename to IntelFrameworkPkg/Include/Framework/FrameworkFirmwareFileSystem.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkFirmwareVolumeHeader.h b/IntelFrameworkPkg/Include/Framework/FrameworkFirmwareVolumeHeader.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkFirmwareVolumeHeader.h rename to IntelFrameworkPkg/Include/Framework/FrameworkFirmwareVolumeHeader.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkFirmwareVolumeImageFormat.h b/IntelFrameworkPkg/Include/Framework/FrameworkFirmwareVolumeImageFormat.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkFirmwareVolumeImageFormat.h rename to IntelFrameworkPkg/Include/Framework/FrameworkFirmwareVolumeImageFormat.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkHob.h b/IntelFrameworkPkg/Include/Framework/FrameworkHob.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkHob.h rename to IntelFrameworkPkg/Include/Framework/FrameworkHob.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkLegacy16.h b/IntelFrameworkPkg/Include/Framework/FrameworkLegacy16.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkLegacy16.h rename to IntelFrameworkPkg/Include/Framework/FrameworkLegacy16.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkSmmCis.h b/IntelFrameworkPkg/Include/Framework/FrameworkSmmCis.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkSmmCis.h rename to IntelFrameworkPkg/Include/Framework/FrameworkSmmCis.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkStatusCode.h b/IntelFrameworkPkg/Include/Framework/FrameworkStatusCode.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkStatusCode.h rename to IntelFrameworkPkg/Include/Framework/FrameworkStatusCode.h diff --git a/IntelFrameworkPkg/Include/Common/FrameworkStatusCodeDataTypeId.h b/IntelFrameworkPkg/Include/Framework/FrameworkStatusCodeDataTypeId.h similarity index 100% rename from IntelFrameworkPkg/Include/Common/FrameworkStatusCodeDataTypeId.h rename to IntelFrameworkPkg/Include/Framework/FrameworkStatusCodeDataTypeId.h diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h new file mode 100644 index 0000000000..7ed3217134 --- /dev/null +++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h @@ -0,0 +1,131 @@ +/** @file + This file declares Device Recovery Module PPI. + + Copyright (c) 2007, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + + Module Name: DeviceRecoveryModule.h + + @par Revision Reference: + This PPI is defined in Framework of EFI Recovery spec. + Version 0.9 + +**/ + +#ifndef _PEI_DEVICE_RECOVERY_MODULE_PPI_H_ +#define _PEI_DEVICE_RECOVERY_MODULE_PPI_H_ + +#include + +#define EFI_PEI_DEVICE_RECOVERY_MODULE_PPI_GUID \ + { \ + 0x0DE2CE25, 0x446A, 0x45a7, {0xBF, 0xC9, 0x37, 0xDA, 0x26, 0x34, 0x4B, 0x37 } \ + } + +typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODULE_PPI; + +/** + This function, by whatever mechanism, searches for DXE capsules from the + associated device and returns the number and maximum size in bytes of + the capsules discovered. Entry 1 is assumed to be the highest load priority + and entry N is assumed to be the lowest priority. + + @param PeiServices General-purpose services that are available to every PEIM + @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. + @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output, + *NumberRecoveryCapsules contains the number of recovery capsule + images available for retrieval from this PEIM instance. + + @retval EFI_SUCCESS One or more capsules were discovered. + @retval EFI_DEVICE_ERROR A device error occurred. + @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE) ( + IN EFI_PEI_SERVICES **PeiServices, + IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This, + OUT UINTN *NumberRecoveryCapsules + ); + +/** + This function gets the size and type of the requested recovery capsule. + + @param PeiServices General-purpose services that are available to every PEIM + @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. + @param CapsuleInstance Specifies for which capsule instance to retrieve the information. + @param Size A pointer to a caller-allocated UINTN in which the size of + the requested recovery module is returned. + @param CapsuleType A pointer to a caller-allocated EFI_GUID in + which the type of the requested recovery capsule is returned. + + @retval EFI_SUCCESS One or more capsules were discovered. + @retval EFI_DEVICE_ERROR A device error occurred. + @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO) ( + IN EFI_PEI_SERVICES **PeiServices, + IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This, + IN UINTN CapsuleInstance, + OUT UINTN *Size, + OUT EFI_GUID *CapsuleType + ); + +/** + This function, by whatever mechanism, retrieves a DXE capsule from some device + and loads it into memory. Note that the published interface is device neutral. + + @param PeiServices General-purpose services that are available to every PEIM + @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance. + @param CapsuleInstance Specifies which capsule instance to retrieve. + @param Buffer Specifies a caller-allocated buffer in which the requested + recovery capsule will be returned. + + @retval EFI_SUCCESS One or more capsules were discovered. + @retval EFI_DEVICE_ERROR A device error occurred. + @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE) ( + IN OUT EFI_PEI_SERVICES **PeiServices, + IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *This, + IN UINTN CapsuleInstance, + OUT VOID *Buffer + ); + +/** + @par Ppi Description: + Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI, + regardless of the underlying device(s). + + @param GetNumberRecoveryCapsules + Returns the number of DXE capsules that were found. + + @param GetRecoveryCapsuleInfo + Returns the capsule image type and the size of a given image. + + @param LoadRecoveryCapsule + Loads a DXE capsule into memory + +**/ +struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI { + EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE GetNumberRecoveryCapsules; + EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO GetRecoveryCapsuleInfo; + EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule; +}; + +extern EFI_GUID gEfiPeiDeviceRecoveryModulePpiGuid; + +#endif