2 Module produce EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI.
3 UEFI PI Spec supersedes Intel's Framework Specs.
4 EFI_PEI_READ_ONLY_VARIABLE_PPI defined in Intel Framework Pkg is replaced by EFI_PEI_READ_ONLY_VARIABLE2_PPI
6 This module produces EFI_PEI_READ_ONLY_VARIABLE2_PPI on top of EFI_PEI_READ_ONLY_VARIABLE_PPI.
7 This module is used on platform when both of these two conditions are true:
8 1) Framework module produces EFI_PEI_READ_ONLY_VARIABLE_PPI is present.
9 2) The platform has PI modules that only consumes EFI_PEI_READ_ONLY_VARIABLE2_PPI.
11 This module can't be used together with ReadOnlyVariableToReadOnlyVariable2Thunk module.
14 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
15 This program and the accompanying materials
16 are licensed and made available under the terms and conditions of the BSD License
17 which accompanies this distribution. The full text of the license may be found at
18 http://opensource.org/licenses/bsd-license.php
20 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
21 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
27 #include <Ppi/ReadOnlyVariable2.h>
28 #include <Ppi/ReadOnlyVariable.h>
29 #include <Library/DebugLib.h>
30 #include <Library/PeiServicesTablePointerLib.h>
31 #include <Library/PeiServicesLib.h>
34 Provide the read variable functionality of the variable services.
36 @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.
37 @param VariableName A pointer to a null-terminated string that is the variable's name.
38 @param VariableGuid A pointer to an EFI_GUID that is the variable's GUID. The combination of
39 VariableGuid and VariableName must be unique.
40 @param Attributes If non-NULL, on return, points to the variable's attributes.
41 @param DataSize On entry, points to the size in bytes of the Data buffer.
42 On return, points to the size of the data returned in Data.
43 @param Data Points to the buffer which will hold the returned variable value.
45 @retval EFI_SUCCESS The interface could be successfully installed
46 @retval EFI_NOT_FOUND The variable could not be discovered
47 @retval EFI_BUFFER_TOO_SMALL The caller buffer is not large enough
53 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI
*This
,
54 IN CONST CHAR16
*VariableName
,
55 IN CONST EFI_GUID
*VariableGuid
,
56 OUT UINT32
*Attributes
,
57 IN OUT UINTN
*DataSize
,
62 EFI_PEI_READ_ONLY_VARIABLE_PPI
*ReadOnlyVariable
;
64 Status
= PeiServicesLocatePpi (
65 &gEfiPeiReadOnlyVariablePpiGuid
,
68 (VOID
**)&ReadOnlyVariable
70 ASSERT_EFI_ERROR (Status
);
72 return ReadOnlyVariable
->PeiGetVariable (
73 (EFI_PEI_SERVICES
**) GetPeiServicesTablePointer (),
74 (CHAR16
*)VariableName
,
75 (EFI_GUID
*)VariableGuid
,
83 Provide the get next variable functionality of the variable services.
85 @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.
87 @param VariableNameSize On entry, points to the size of the buffer pointed to by VariableName.
88 @param VariableName On entry, a pointer to a null-terminated string that is the variable's name.
89 On return, points to the next variable's null-terminated name string.
91 @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID.
92 On return, a pointer to the next variable's GUID.
94 @retval EFI_SUCCESS The interface could be successfully installed
95 @retval EFI_NOT_FOUND The variable could not be discovered
100 PeiGetNextVariableName (
101 IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI
*This
,
102 IN OUT UINTN
*VariableNameSize
,
103 IN OUT CHAR16
*VariableName
,
104 IN OUT EFI_GUID
*VariableGuid
108 EFI_PEI_READ_ONLY_VARIABLE_PPI
*ReadOnlyVariable
;
110 Status
= PeiServicesLocatePpi (
111 &gEfiPeiReadOnlyVariablePpiGuid
,
114 (VOID
**)&ReadOnlyVariable
116 ASSERT_EFI_ERROR (Status
);
118 return ReadOnlyVariable
->PeiGetNextVariableName (
119 (EFI_PEI_SERVICES
**) GetPeiServicesTablePointer (),
129 EFI_PEI_READ_ONLY_VARIABLE2_PPI mVariablePpi
= {
131 PeiGetNextVariableName
134 EFI_PEI_PPI_DESCRIPTOR mPpiListVariable
= {
135 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
136 &gEfiPeiReadOnlyVariable2PpiGuid
,
141 User entry for this PEIM driver.
143 @param FileHandle Handle of the file being invoked.
144 @param PeiServices Describes the list of possible PEI Services.
146 @retval EFI_SUCCESS ReadOnlyVariable2 PPI is successfully installed.
147 @return Others ReadOnlyVariable2 PPI is not successfully installed.
152 PeimInitializeReadOnlyVariable2 (
153 IN EFI_PEI_FILE_HANDLE FileHandle
,
154 IN CONST EFI_PEI_SERVICES
**PeiServices
158 // This thunk module can only be used together with a PI PEI core, as we
159 // assume PeiServices Pointer Table can be located in a standard way defined
162 ASSERT ((*PeiServices
)->Hdr
.Revision
>= 0x00010000);
165 // Developer should make sure ReadOnlyVariable2ToReadOnlyVariable module is not present. or else, the call chain will form a
166 // infinite loop: ReadOnlyVariable2 -> ReadOnlyVariable -> ReadOnlyVariable2 -> .....
169 // Publish the variable capability to other modules
171 return PeiServicesInstallPpi (&mPpiListVariable
);