projects / mirror_edk2.git / blame
| 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 | |
| 5 | This program and the accompanying materials\r | |
| 6 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 7 | which accompanies this distribution. 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 _PLATFORM_VARIABLE_CLEANUP_LIB_\r | |
| 16 | #define _PLATFORM_VARIABLE_CLEANUP_LIB_\r | |
| 17 | \r | |
| 18 | #include <Guid/VarErrorFlag.h>\r | |
| 19 | \r | |
| 20 | typedef enum {\r | |
| 21 | VarCleanupAll,\r | |
| 22 | VarCleanupManually,\r | |
| 23 | VarCleanupMax,\r | |
| 24 | } VAR_CLEANUP_TYPE;\r | |
| 25 | \r | |
| 26 | /**\r | |
| 27 | Get last boot variable error flag.\r | |
| 28 | \r | |
| 29 | @return Last boot variable error flag.\r | |
| 30 | \r | |
| 31 | **/\r | |
| 32 | VAR_ERROR_FLAG\r | |
| 33 | EFIAPI\r | |
| 34 | GetLastBootVarErrorFlag (\r | |
| f826516d | 35 | VOID\r |
| c95d9ab8 SZ |
36 | );\r |
| 37 | \r | |
| 38 | /**\r | |
| 39 | Platform variable cleanup.\r | |
| 40 | \r | |
| 41 | @param[in] Flag Variable error flag.\r | |
| 42 | @param[in] Type Variable cleanup type.\r | |
| 43 | If it is VarCleanupManually, the interface must be called after console connected.\r | |
| 44 | \r | |
| 45 | @retval EFI_SUCCESS No error or error processed.\r | |
| 46 | @retval EFI_UNSUPPORTED The specified Flag or Type is not supported.\r | |
| 47 | For example, system error may be not supported to process and Platform should have mechanism to reset system to manufacture mode.\r | |
| 48 | Another, if system and user variables are wanted to be distinguished to process, the interface must be called after EndOfDxe.\r | |
| 49 | @retval EFI_OUT_OF_RESOURCES Not enough resource to process the error.\r | |
| 50 | @retval EFI_INVALID_PARAMETER The specified Flag or Type is an invalid value.\r | |
| 51 | @retval Others Other failure occurs.\r | |
| 52 | \r | |
| 53 | **/\r | |
| 54 | EFI_STATUS\r | |
| 55 | EFIAPI\r | |
| 56 | PlatformVarCleanup (\r | |
| 57 | IN VAR_ERROR_FLAG Flag,\r | |
| 58 | IN VAR_CLEANUP_TYPE Type\r | |
| 59 | );\r | |
| 60 | \r | |
| 61 | #endif\r | |
| 62 | \r |