diff options
| author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-01-21 09:47:43 +0000 |
|---|---|---|
| committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-01-21 09:47:43 +0000 |
| commit | 4c9c0f719df00f211790eadf04d21a93a0cdf76c (patch) | |
| tree | 90a4d5a29da41787f75ac11191f707e8f2215f5e /EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk | |
| parent | 96827f17562a5f055b7e14817f3388e881f33020 (diff) | |
Rename module name from ***To*** to ***On***. AAAOnBBB means this module produce AAA Protocol/PPI based on BBB. This change improves the readability.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7328 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk')
2 files changed, 273 insertions, 0 deletions
diff --git a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.c b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.c new file mode 100644 index 000000000..2de6c9278 --- /dev/null +++ b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.c @@ -0,0 +1,208 @@ +/** @file
+Module produce EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI.
+UEFI PI Spec supersedes Intel's Framework Specs.
+EFI_PEI_READ_ONLY_VARIABLE_PPI defined in Intel Framework Pkg is replaced by EFI_PEI_READ_ONLY_VARIABLE2_PPI
+in MdePkg.
+This module produces EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI.
+This module is used on platform when both of these two conditions are true:
+1) Framework module produces EFI_PEI_READ_ONLY_VARIABLE_PPI is present.
+2) The platform has PI modules that only consumes EFI_PEI_READ_ONLY_VARIABLE2_PPI.
+
+This module can't be used together with ReadOnlyVariableToReadOnlyVariable2Thunk module.
+
+
+Copyright (c) 2006 - 2008 Intel Corporation. <BR>
+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:
+
+**/
+
+#include <PiPei.h>
+#include <Ppi/ReadOnlyVariable2.h>
+#include <Ppi/ReadOnlyVariable.h>
+#include <Ppi/ReadOnlyVariableThunkPresent.h>
+#include <Library/DebugLib.h>
+#include <Library/PeiServicesTablePointerLib.h>
+#include <Library/PeiServicesLib.h>
+
+//
+// Function Prototypes
+//
+EFI_STATUS
+EFIAPI
+PeiGetVariable (
+ IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,
+ IN CONST CHAR16 *VariableName,
+ IN CONST EFI_GUID *VariableGuid,
+ OUT UINT32 *Attributes,
+ IN OUT UINTN *DataSize,
+ OUT VOID *Data
+ );
+
+EFI_STATUS
+EFIAPI
+PeiGetNextVariableName (
+ IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,
+ IN OUT UINTN *VariableNameSize,
+ IN OUT CHAR16 *VariableName,
+ IN OUT EFI_GUID *VariableGuid
+ );
+
+//
+// Module globals
+//
+EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi = {
+ PeiGetVariable,
+ PeiGetNextVariableName
+};
+
+EFI_PEI_PPI_DESCRIPTOR mPpiListVariable = {
+ (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
+ &gEfiPeiReadOnlyVariable2PpiGuid,
+ &mVariablePpi
+};
+
+
+EFI_PEI_PPI_DESCRIPTOR mReadOnlyVariableThunkPresent = {
+ (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
+ &gPeiReadonlyVariableThunkPresentPpiGuid,
+ NULL
+};
+
+/**
+ User entry for this PEIM driver.
+
+ @param FileHandle Handle of the file being invoked.
+ @param PeiServices Describes the list of possible PEI Services.
+
+ @retval EFI_SUCCESS ReadOnlyVariable2 PPI is successfully installed.
+ @return Others ReadOnlyVariable2 PPI is not successfully installed.
+
+**/
+EFI_STATUS
+EFIAPI
+PeimInitializeReadOnlyVariable2 (
+ IN EFI_PEI_FILE_HANDLE FfsHeader,
+ IN CONST EFI_PEI_SERVICES **PeiServices
+ )
+{
+ VOID *Interface;
+ EFI_STATUS Status;
+ //
+ // This thunk module can only be used together with a PI PEI core, as we
+ // assume PeiServices Pointer Table can be located in a standard way defined
+ // in PI spec.
+ //
+ ASSERT ((*PeiServices)->Hdr.Revision >= 0x00010000);
+
+ //
+ // Make sure ReadOnlyVariable2ToReadOnlyVariable module is not present. If so, the call chain will form a
+ // infinite loop: ReadOnlyVariable2 -> ReadOnlyVariable -> ReadOnlyVariable2 -> ....
+ //
+ Status = PeiServicesLocatePpi (&gPeiReadonlyVariableThunkPresentPpiGuid, 0, NULL, &Interface);
+ ASSERT (Status == EFI_NOT_FOUND);
+
+ Status = PeiServicesInstallPpi (&mReadOnlyVariableThunkPresent);
+ ASSERT_EFI_ERROR (Status);
+
+ //
+ // Publish the variable capability to other modules
+ //
+ return PeiServicesInstallPpi (&mPpiListVariable);
+}
+
+/**
+ Provide the read variable functionality of the variable services.
+
+ @param PeiServices General purpose services available to every PEIM.
+ @param VariableName The variable name
+ @param VendorGuid The vendor's GUID
+ @param Attributes Pointer to the attribute
+ @param DataSize Size of data
+ @param Data Pointer to data
+
+ @retval EFI_SUCCESS The interface could be successfully installed
+ @retval EFI_NOT_FOUND The variable could not be discovered
+ @retval EFI_BUFFER_TOO_SMALL The caller buffer is not large enough
+
+**/
+EFI_STATUS
+EFIAPI
+PeiGetVariable (
+ IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,
+ IN CONST CHAR16 *VariableName,
+ IN CONST EFI_GUID *VariableGuid,
+ OUT UINT32 *Attributes,
+ IN OUT UINTN *DataSize,
+ OUT VOID *Data
+ )
+{
+ EFI_STATUS Status;
+ EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;
+
+ Status = PeiServicesLocatePpi (
+ &gEfiPeiReadOnlyVariablePpiGuid,
+ 0,
+ NULL,
+ (VOID **)&ReadOnlyVariable
+ );
+ ASSERT_EFI_ERROR (Status);
+
+ return ReadOnlyVariable->PeiGetVariable (
+ (EFI_PEI_SERVICES **) GetPeiServicesTablePointer (),
+ (CHAR16 *)VariableName,
+ (EFI_GUID *)VariableGuid,
+ Attributes,
+ DataSize,
+ Data
+ );
+}
+
+/**
+ Provide the get next variable functionality of the variable services.
+
+ @param PeiServices General purpose services available to every PEIM.
+ @param VariabvleNameSize The variable name's size.
+ @param VariableName A pointer to the variable's name.
+ @param VariableGuid A pointer to the EFI_GUID structure.
+ @param VariableNameSize Size of the variable name
+ @param VariableName The variable name
+ @param VendorGuid The vendor's GUID
+
+ @retval EFI_SUCCESS The interface could be successfully installed
+ @retval EFI_NOT_FOUND The variable could not be discovered
+
+**/
+EFI_STATUS
+EFIAPI
+PeiGetNextVariableName (
+ IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This,
+ IN OUT UINTN *VariableNameSize,
+ IN OUT CHAR16 *VariableName,
+ IN OUT EFI_GUID *VariableGuid
+ )
+{
+ EFI_STATUS Status;
+ EFI_PEI_READ_ONLY_VARIABLE_PPI *ReadOnlyVariable;
+
+ Status = PeiServicesLocatePpi (
+ &gEfiPeiReadOnlyVariablePpiGuid,
+ 0,
+ NULL,
+ (VOID **)&ReadOnlyVariable
+ );
+ ASSERT_EFI_ERROR (Status);
+
+ return ReadOnlyVariable->PeiGetNextVariableName (
+ (EFI_PEI_SERVICES **) GetPeiServicesTablePointer (),
+ VariableNameSize,
+ VariableName,
+ VariableGuid
+ );
+}
diff --git a/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.inf b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.inf new file mode 100644 index 000000000..3d6f1f5df --- /dev/null +++ b/EdkCompatibilityPkg/Compatibility/ReadOnlyVariable2OnReadOnlyVariableThunk/ReadOnlyVariable2ToReadOnlyVariableThunk.inf @@ -0,0 +1,65 @@ +#/** @file
+# Module produce EFI_PEI_READ_ONLY_VARIABLE_PPI top of EFI_PEI_READ_ONLY_VARIABLE2_PPI .
+#
+# UEFI PI Spec supersedes Intel's Framework Specs.
+# EFI_PEI_READ_ONLY_VARIABLE_PPI defined in Intel Framework Pkg is replaced by EFI_PEI_READ_ONLY_VARIABLE2_PPI
+# in MdePkg.
+# This module produces EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI .
+# This module is used on platform when both of these two conditions are true:
+# 1) Framework module produces EFI_PEI_READ_ONLY_VARIABLE_PPI is present.
+# 2) The platform has PI modules that consumes EFI_PEI_READ_ONLY_VARIABLE2_PPI.
+#
+# This module can't be used together with ReadOnlyVariableToReadOnlyVariable2Thunk module.
+#
+#
+# PEIM to provide the Variable functionality.
+# Copyright (c) 2006 - 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.
+#
+#
+#**/
+
+[Defines]
+ INF_VERSION = 0x00010005
+ BASE_NAME = ReadOnlyVariable2ToReadOnlyVariableThunk
+ FILE_GUID = 950216A2-A621-479c-A13D-2990617BDFE7
+ MODULE_TYPE = PEIM
+ VERSION_STRING = 1.0
+ EDK_RELEASE_VERSION = 0x00020000
+ EFI_SPECIFICATION_VERSION = 0x00020000
+
+ ENTRY_POINT = PeimInitializeReadOnlyVariable2
+
+#
+# The following information is for reference only and not required by the build tools.
+#
+# VALID_ARCHITECTURES = IA32 X64 IPF EBC
+#
+
+[Sources.common]
+ ReadOnlyVariable2ToReadOnlyVariableThunk.c
+
+[Packages]
+ MdePkg/MdePkg.dec
+ EdkCompatibilityPkg/EdkCompatibilityPkg.dec
+ IntelFrameworkPkg/IntelFrameworkPkg.dec
+
+[LibraryClasses]
+ PeimEntryPoint
+ PeiServicesLib
+ PeiServicesTablePointerLib
+ DebugLib
+
+[Ppis]
+ gEfiPeiReadOnlyVariablePpiGuid # PPI ALWAYS_CONSUMED
+ gEfiPeiReadOnlyVariable2PpiGuid # PPI ALWAYS_PRODUCED
+ gPeiReadonlyVariableThunkPresentPpiGuid
+
+[Depex]
+ gEfiPeiReadOnlyVariablePpiGuid
|