]>
Commit | Line | Data |
---|---|---|
c95d9ab8 SZ |
1 | /** @file\r |
2 | The library class provides platform variable cleanup services.\r | |
3 | \r | |
4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
c95d9ab8 SZ |
6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef _PLATFORM_VARIABLE_CLEANUP_LIB_\r | |
10 | #define _PLATFORM_VARIABLE_CLEANUP_LIB_\r | |
11 | \r | |
12 | #include <Guid/VarErrorFlag.h>\r | |
13 | \r | |
14 | typedef enum {\r | |
15 | VarCleanupAll,\r | |
16 | VarCleanupManually,\r | |
17 | VarCleanupMax,\r | |
18 | } VAR_CLEANUP_TYPE;\r | |
19 | \r | |
20 | /**\r | |
21 | Get last boot variable error flag.\r | |
22 | \r | |
23 | @return Last boot variable error flag.\r | |
24 | \r | |
25 | **/\r | |
26 | VAR_ERROR_FLAG\r | |
27 | EFIAPI\r | |
28 | GetLastBootVarErrorFlag (\r | |
f826516d | 29 | VOID\r |
c95d9ab8 SZ |
30 | );\r |
31 | \r | |
32 | /**\r | |
33 | Platform variable cleanup.\r | |
34 | \r | |
35 | @param[in] Flag Variable error flag.\r | |
36 | @param[in] Type Variable cleanup type.\r | |
37 | If it is VarCleanupManually, the interface must be called after console connected.\r | |
38 | \r | |
39 | @retval EFI_SUCCESS No error or error processed.\r | |
40 | @retval EFI_UNSUPPORTED The specified Flag or Type is not supported.\r | |
41 | For example, system error may be not supported to process and Platform should have mechanism to reset system to manufacture mode.\r | |
42 | Another, if system and user variables are wanted to be distinguished to process, the interface must be called after EndOfDxe.\r | |
43 | @retval EFI_OUT_OF_RESOURCES Not enough resource to process the error.\r | |
44 | @retval EFI_INVALID_PARAMETER The specified Flag or Type is an invalid value.\r | |
45 | @retval Others Other failure occurs.\r | |
46 | \r | |
47 | **/\r | |
48 | EFI_STATUS\r | |
49 | EFIAPI\r | |
50 | PlatformVarCleanup (\r | |
51 | IN VAR_ERROR_FLAG Flag,\r | |
52 | IN VAR_CLEANUP_TYPE Type\r | |
53 | );\r | |
54 | \r | |
55 | #endif\r | |
56 | \r |