1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/** @file
This file contains the required header files for the CSE Variable Storage PEIM.
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
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.
**/
#ifndef _CSE_VARIABLE_STORAGE_PEI_H_
#define _CSE_VARIABLE_STORAGE_PEI_H_
#include <Ppi/VariableStoragePpi.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/CseVariableStorageLib.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/PcdLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/PeiServicesLib.h>
#include <Library/VariableNvmStorageLib.h>
#include <Guid/CseVariableStoragePpiInstanceGuid.h>
extern EFI_GUID gCseVariableFileInfoHobGuid;
/**
Provide the functionality of CSE NVM variable storage services.
@param[in] FileHandle Handle of the file being invoked.
Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().
@param[in] PeiServices General purpose services available to every PEIM.
@retval EFI_SUCCESS If the interface could be successfully installed.
@retval Others Returned from PeiServicesInstallPpi().
**/
EFI_STATUS
EFIAPI
PeimInitializeCseVariableStorageServices (
IN EFI_PEI_FILE_HANDLE FileHandle,
IN CONST EFI_PEI_SERVICES **PeiServices
);
/**
Retrieves a PPI instance-specific GUID.
Returns a unique GUID per VARIABLE_STORAGE_PPI instance.
@param[out] VariableGuid A pointer to an EFI_GUID that is this PPI instance's GUID.
@retval EFI_SUCCESS The data was returned successfully.
@retval EFI_INVALID_PARAMETER A required parameter is NULL.
**/
EFI_STATUS
EFIAPI
PeiCseVariableStorageGetId (
OUT EFI_GUID *InstanceGuid
);
/**
This service retrieves a variable's value using its name and GUID.
Read the specified variable from the CSE NVM variable store. If the Data
buffer is too small to hold the contents of the variable,
the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the
required buffer size to obtain the data.
@param[in] This A pointer to this instance of the VARIABLE_STORAGE_PPI.
@param[in] VariableName A pointer to a null-terminated string that is the variable's name.
@param[in] VariableGuid A pointer to an EFI_GUID that is the variable's GUID. The combination of
VariableGuid and VariableName must be unique.
@param[out] Attributes If non-NULL, on return, points to the variable's attributes.
@param[in, out] DataSize On entry, points to the size in bytes of the Data buffer.
On return, points to the size of the data returned in Data.
@param[out] Data Points to the buffer which will hold the returned variable value.
@retval EFI_SUCCESS The variable was read successfully.
@retval EFI_NOT_FOUND The variable could not be found.
@retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data.
DataSize is updated with the size required for
the specified variable.
@retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.
@retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.
**/
EFI_STATUS
EFIAPI
PeiCseVariableStorageGetVariable (
IN CONST VARIABLE_STORAGE_PPI *This,
IN CONST CHAR16 *VariableName,
IN CONST EFI_GUID *VariableGuid,
OUT UINT32 *Attributes,
IN OUT UINTN *DataSize,
OUT VOID *Data
);
/**
Return the next variable name and GUID.
This function is called multiple times to retrieve the VariableName
and VariableGuid of all variables currently available in the system.
On each call, the previous results are passed into the interface,
and, on return, the interface returns the data for the next
interface. When the entire variable list has been returned,
EFI_NOT_FOUND is returned.
@param[in] This A pointer to this instance of the VARIABLE_STORAGE_PPI.
@param[in, out] VariableNameSize On entry, points to the size of the buffer pointed to by
VariableName. On return, the size of the variable name buffer.
@param[in, out] VariableName On entry, a pointer to a null-terminated string that is the
variable's name. On return, points to the next variable's
null-terminated name string.
@param[in, out] VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID.
On return, a pointer to the next variable's GUID.
@param[out] VariableAttributes A pointer to the variable attributes.
@retval EFI_SUCCESS The variable was read successfully.
@retval EFI_NOT_FOUND The variable could not be found.
@retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the resulting
data. VariableNameSize is updated with the size
required for the specified variable.
@retval EFI_INVALID_PARAMETER VariableName, VariableGuid or
VariableNameSize is NULL.
@retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.
**/
EFI_STATUS
EFIAPI
PeiCseVariableStorageGetNextVariableName (
IN CONST VARIABLE_STORAGE_PPI *This,
IN OUT UINTN *VariableNameSize,
IN OUT CHAR16 *VariableName,
IN OUT EFI_GUID *VariableGuid,
OUT UINT32 *VariableAttributes
);
#endif
|
