]>
Commit | Line | Data |
---|---|---|
31b183bc SZ |
1 | /** @file\r |
2 | Provides variable check services and database management.\r | |
3 | \r | |
4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials are licensed and made available under\r | |
6 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
7 | The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php.\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _VARIABLE_CHECK_LIB_H_\r | |
16 | #define _VARIABLE_CHECK_LIB_H_\r | |
17 | \r | |
18 | #include <Protocol/VarCheck.h>\r | |
19 | \r | |
20 | typedef enum {\r | |
21 | VarCheckRequestReserved0 = 0,\r | |
22 | VarCheckRequestReserved1 = 1,\r | |
23 | VarCheckFromTrusted = 2,\r | |
24 | VarCheckFromUntrusted = 3,\r | |
25 | } VAR_CHECK_REQUEST_SOURCE;\r | |
26 | \r | |
27 | typedef\r | |
28 | VOID\r | |
29 | (EFIAPI *VAR_CHECK_END_OF_DXE_CALLBACK) (\r | |
30 | VOID\r | |
31 | );\r | |
32 | \r | |
33 | /**\r | |
34 | Register END_OF_DXE callback.\r | |
35 | The callback will be invoked by VarCheckLibInitializeAtEndOfDxe().\r | |
36 | \r | |
37 | @param[in] Callback END_OF_DXE callback.\r | |
38 | \r | |
39 | @retval EFI_SUCCESS The callback was registered successfully.\r | |
40 | @retval EFI_INVALID_PARAMETER Callback is NULL.\r | |
41 | @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r | |
42 | already been signaled.\r | |
43 | @retval EFI_OUT_OF_RESOURCES There is not enough resource for the callback register request.\r | |
44 | \r | |
45 | **/\r | |
46 | EFI_STATUS\r | |
47 | EFIAPI\r | |
48 | VarCheckLibRegisterEndOfDxeCallback (\r | |
49 | IN VAR_CHECK_END_OF_DXE_CALLBACK Callback\r | |
50 | );\r | |
51 | \r | |
52 | /**\r | |
53 | Var check initialize at END_OF_DXE.\r | |
54 | \r | |
55 | This function needs to be called at END_OF_DXE.\r | |
56 | Address pointers may be returned,\r | |
57 | and caller needs to ConvertPointer() for the pointers.\r | |
58 | \r | |
59 | @param[in, out] AddressPointerCount Output pointer to address pointer count.\r | |
60 | \r | |
61 | @return Address pointer buffer, NULL if input AddressPointerCount is NULL.\r | |
62 | \r | |
63 | **/\r | |
64 | VOID ***\r | |
65 | EFIAPI\r | |
66 | VarCheckLibInitializeAtEndOfDxe (\r | |
67 | IN OUT UINTN *AddressPointerCount OPTIONAL\r | |
68 | );\r | |
69 | \r | |
70 | /**\r | |
71 | Register address pointer.\r | |
72 | The AddressPointer may be returned by VarCheckLibInitializeAtEndOfDxe().\r | |
73 | \r | |
74 | @param[in] AddressPointer Address pointer.\r | |
75 | \r | |
76 | @retval EFI_SUCCESS The address pointer was registered successfully.\r | |
77 | @retval EFI_INVALID_PARAMETER AddressPointer is NULL.\r | |
78 | @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r | |
79 | already been signaled.\r | |
80 | @retval EFI_OUT_OF_RESOURCES There is not enough resource for the address pointer register request.\r | |
81 | \r | |
82 | **/\r | |
83 | EFI_STATUS\r | |
84 | EFIAPI\r | |
85 | VarCheckLibRegisterAddressPointer (\r | |
86 | IN VOID **AddressPointer\r | |
87 | );\r | |
88 | \r | |
89 | /**\r | |
90 | Register SetVariable check handler.\r | |
91 | \r | |
92 | @param[in] Handler Pointer to check handler.\r | |
93 | \r | |
94 | @retval EFI_SUCCESS The SetVariable check handler was registered successfully.\r | |
95 | @retval EFI_INVALID_PARAMETER Handler is NULL.\r | |
96 | @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r | |
97 | already been signaled.\r | |
98 | @retval EFI_OUT_OF_RESOURCES There is not enough resource for the SetVariable check handler register request.\r | |
99 | @retval EFI_UNSUPPORTED This interface is not implemented.\r | |
100 | For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.\r | |
101 | \r | |
102 | **/\r | |
103 | EFI_STATUS\r | |
104 | EFIAPI\r | |
105 | VarCheckLibRegisterSetVariableCheckHandler (\r | |
106 | IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER Handler\r | |
107 | );\r | |
108 | \r | |
109 | /**\r | |
110 | Variable property set.\r | |
111 | \r | |
112 | @param[in] Name Pointer to the variable name.\r | |
113 | @param[in] Guid Pointer to the vendor GUID.\r | |
114 | @param[in] VariableProperty Pointer to the input variable property.\r | |
115 | \r | |
116 | @retval EFI_SUCCESS The property of variable specified by the Name and Guid was set successfully.\r | |
117 | @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,\r | |
118 | or the fields of VariableProperty are not valid.\r | |
119 | @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r | |
120 | already been signaled.\r | |
121 | @retval EFI_OUT_OF_RESOURCES There is not enough resource for the variable property set request.\r | |
122 | \r | |
123 | **/\r | |
124 | EFI_STATUS\r | |
125 | EFIAPI\r | |
126 | VarCheckLibVariablePropertySet (\r | |
127 | IN CHAR16 *Name,\r | |
128 | IN EFI_GUID *Guid,\r | |
129 | IN VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r | |
130 | );\r | |
131 | \r | |
132 | /**\r | |
133 | Variable property get.\r | |
134 | \r | |
135 | @param[in] Name Pointer to the variable name.\r | |
136 | @param[in] Guid Pointer to the vendor GUID.\r | |
137 | @param[out] VariableProperty Pointer to the output variable property.\r | |
138 | \r | |
139 | @retval EFI_SUCCESS The property of variable specified by the Name and Guid was got successfully.\r | |
140 | @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.\r | |
141 | @retval EFI_NOT_FOUND The property of variable specified by the Name and Guid was not found.\r | |
142 | \r | |
143 | **/\r | |
144 | EFI_STATUS\r | |
145 | EFIAPI\r | |
146 | VarCheckLibVariablePropertyGet (\r | |
147 | IN CHAR16 *Name,\r | |
148 | IN EFI_GUID *Guid,\r | |
149 | OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r | |
150 | );\r | |
151 | \r | |
152 | /**\r | |
153 | SetVariable check.\r | |
154 | \r | |
155 | @param[in] VariableName Name of Variable to set.\r | |
156 | @param[in] VendorGuid Variable vendor GUID.\r | |
157 | @param[in] Attributes Attribute value of the variable.\r | |
158 | @param[in] DataSize Size of Data to set.\r | |
159 | @param[in] Data Data pointer.\r | |
160 | @param[in] RequestSource Request source.\r | |
161 | \r | |
162 | @retval EFI_SUCCESS The SetVariable check result was success.\r | |
163 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, GUID,\r | |
164 | DataSize and Data value was supplied.\r | |
165 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
166 | @retval Others The other return status from check handler.\r | |
167 | \r | |
168 | **/\r | |
169 | EFI_STATUS\r | |
170 | EFIAPI\r | |
171 | VarCheckLibSetVariableCheck (\r | |
172 | IN CHAR16 *VariableName,\r | |
173 | IN EFI_GUID *VendorGuid,\r | |
174 | IN UINT32 Attributes,\r | |
175 | IN UINTN DataSize,\r | |
176 | IN VOID *Data,\r | |
177 | IN VAR_CHECK_REQUEST_SOURCE RequestSource\r | |
178 | );\r | |
179 | \r | |
180 | #endif\r |