FmpLastAttemptStatus.h 3.9 KB

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