]> git.proxmox.com Git - mirror_edk2.git/blame - FmpDevicePkg/PrivateInclude/FmpLastAttemptStatus.h
FatPkg: Apply uncrustify changes
[mirror_edk2.git] / FmpDevicePkg / PrivateInclude / FmpLastAttemptStatus.h
CommitLineData
2c1e9f1d
MK
1/** @file\r
2 Defines private last attempt status codes used in FmpDevicePkg.\r
3\r
4 Copyright (c) Microsoft Corporation.<BR>\r
5\r
6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
7\r
8**/\r
9\r
10#ifndef __FMP_LAST_ATTEMPT_STATUS_H__\r
11#define __FMP_LAST_ATTEMPT_STATUS_H__\r
12\r
13///\r
14/// Last attempt status codes defined for additional granularity in FmpDevicePkg components.\r
15///\r
16/// These codes are defined within the last attempt status FMP reserved range which extends from\r
17/// LAST_ATTEMPT_STATUS_FMP_RESERVED_MIN_ERROR_CODE_VALUE to LAST_ATTEMPT_STATUS_FMP_RESERVED_MAX_ERROR_CODE_VALUE.\r
18///\r
19/// The following last attempt status code ranges are currently defined for the corresponding component:\r
20/// * LAST_ATTEMPT_STATUS_DRIVER - FMP driver\r
21/// * LAST_ATTEMPT_STATUS_DEPENDENCY - FMP dependency functionality\r
22///\r
23/// Future last attempt status code additions in FmpDevicePkg should be added as follows:\r
24/// * FmpDxe driver: Onto the end of the LAST_ATTEMPT_STATUS_DRIVER_ERROR range\r
25/// * FMP dependency functionality: Onto the end of the LAST_ATTEMPT_STATUS_DEPENDENCY_ERROR range\r
26/// * Other components: Add a new range onto the end of the last existing range in the enum within the limits of\r
27/// [LAST_ATTEMPT_STATUS_FMP_RESERVED_MIN_ERROR_CODE_VALUE,LAST_ATTEMPT_STATUS_FMP_RESERVED_MAX_ERROR_CODE_VALUE]\r
28///\r
29/// The value of pre-existing last attempt status codes should never be modified to ensure the values remain\r
30/// consistent over time.\r
31///\r
32enum LAST_ATTEMPT_STATUS_EXPANDED_ERROR_LIST\r
33{\r
34 ///\r
35 /// Last attempt status codes used in FmpDxe\r
36 ///\r
37 LAST_ATTEMPT_STATUS_DRIVER_ERROR_GET_FMP_HEADER = LAST_ATTEMPT_STATUS_DRIVER_MIN_ERROR_CODE_VALUE,\r
38 LAST_ATTEMPT_STATUS_DRIVER_ERROR_PROGRESS_CALLBACK_ERROR ,\r
39 LAST_ATTEMPT_STATUS_DRIVER_ERROR_CHECK_POWER_API ,\r
40 LAST_ATTEMPT_STATUS_DRIVER_ERROR_CHECK_SYS_THERMAL_API ,\r
41 LAST_ATTEMPT_STATUS_DRIVER_ERROR_THERMAL ,\r
42 LAST_ATTEMPT_STATUS_DRIVER_ERROR_CHECK_SYS_ENV_API ,\r
43 LAST_ATTEMPT_STATUS_DRIVER_ERROR_SYSTEM_ENV ,\r
44 LAST_ATTEMPT_STATUS_DRIVER_ERROR_GET_FMP_HEADER_SIZE ,\r
45 LAST_ATTEMPT_STATUS_DRIVER_ERROR_GET_ALL_HEADER_SIZE ,\r
46 LAST_ATTEMPT_STATUS_DRIVER_ERROR_GET_FMP_HEADER_VERSION ,\r
47 LAST_ATTEMPT_STATUS_DRIVER_ERROR_IMAGE_NOT_PROVIDED ,\r
48 LAST_ATTEMPT_STATUS_DRIVER_ERROR_IMAGE_NOT_UPDATABLE ,\r
49 LAST_ATTEMPT_STATUS_DRIVER_ERROR_INVALID_CERTIFICATE ,\r
50 LAST_ATTEMPT_STATUS_DRIVER_ERROR_INVALID_IMAGE_INDEX ,\r
51 LAST_ATTEMPT_STATUS_DRIVER_ERROR_INVALID_KEY_LENGTH ,\r
52 LAST_ATTEMPT_STATUS_DRIVER_ERROR_INVALID_KEY_LENGTH_VALUE ,\r
53 LAST_ATTEMPT_STATUS_DRIVER_ERROR_VERSION_TOO_LOW ,\r
54 LAST_ATTEMPT_STATUS_DRIVER_ERROR_DEVICE_LOCKED ,\r
55 LAST_ATTEMPT_STATUS_DRIVER_ERROR_IMAGE_AUTH_FAILURE ,\r
56 LAST_ATTEMPT_STATUS_DRIVER_ERROR_PROTOCOL_ARG_MISSING ,\r
57\r
58 ///\r
59 /// Last attempt status codes used in FmpDependencyLib\r
60 ///\r
61 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_GET_DEPEX_FAILURE = LAST_ATTEMPT_STATUS_FMP_DEPENDENCY_LIB_MIN_ERROR_CODE_VALUE,\r
62 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_NO_END_OPCODE ,\r
63 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_UNKNOWN_OPCODE ,\r
64 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_GUID_BEYOND_DEPEX ,\r
65 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_VERSION_BEYOND_DEPEX ,\r
66 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_VERSION_STR_BEYOND_DEPEX ,\r
67 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_FMP_NOT_FOUND ,\r
68 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_PUSH_FAILURE ,\r
69 LAST_ATTEMPT_STATUS_DEPENDENCY_LIB_ERROR_POP_FAILURE ,\r
70\r
71 ///\r
72 /// Last attempt status codes used in FmpDependencyCheckLib\r
73 ///\r
74 LAST_ATTEMPT_STATUS_DEPENDENCY_CHECK_LIB_ERROR_FMP_PROTOCOL_NOT_FOUND = LAST_ATTEMPT_STATUS_FMP_DEPENDENCY_CHECK_LIB_MIN_ERROR_CODE_VALUE,\r
75 LAST_ATTEMPT_STATUS_DEPENDENCY_CHECK_LIB_ERROR_MEM_ALLOC_FMP_INFO_BUFFER_FAILED ,\r
76 LAST_ATTEMPT_STATUS_DEPENDENCY_CHECK_LIB_ERROR_MEM_ALLOC_DESC_VER_BUFFER_FAILED ,\r
77 LAST_ATTEMPT_STATUS_DEPENDENCY_CHECK_LIB_ERROR_MEM_ALLOC_DESC_SIZE_BUFFER_FAILED ,\r
78 LAST_ATTEMPT_STATUS_DEPENDENCY_CHECK_LIB_ERROR_MEM_ALLOC_FMP_VER_BUFFER_FAILED\r
79};\r
80\r
81#endif\r