FmpDevicePkg/Include/LastAttemptStatus.h

   1 /** @file
   2   Defines last attempt status code ranges within the UEFI Specification
   3   defined unsuccessful vendor range.
   4
   5   Copyright (c) Microsoft Corporation.<BR>
   6
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef __LAST_ATTEMPT_STATUS_H__
  12 #define __LAST_ATTEMPT_STATUS_H__
  13
  14 ///
  15 /// Last Attempt Status Unsuccessful Vendor Range Map
  16 ///
  17 /// Update this map any time new ranges are added. Pre-existing range definitions cannot be modified
  18 /// to keep status code definitions consistent over time.
  19 ///
  20 /// START     | END       | Usage
  21 /// ------------------------------------------------------------------|
  22 /// 0x1000    | 0x17FF    | FmpDevicePkg                              |
  23 ///    0x1000 |    0x107F | FmpDxe driver                             |
  24 ///    0x1080 |    0x109F | FmpDependencyLib                          |
  25 ///    0x10A0 |    0x10BF | FmpDependencyCheckLib                     |
  26 ///    0x10C0 |    0x17FF | Unused. Available for future expansion.   |
  27 /// 0x1800    | 0x1FFF    | FmpDeviceLib instances implementation     |
  28 /// 0x2000    | 0x3FFF    | Unused. Available for future expansion.   |
  29 ///
  30
  31 ///
  32 /// The minimum value of the FMP reserved range.
  33 ///
  34 #define LAST_ATTEMPT_STATUS_FMP_RESERVED_MIN_ERROR_CODE_VALUE  0x1000
  35
  36 ///
  37 /// The maximum value of the FMP reserved range.
  38 ///
  39 #define LAST_ATTEMPT_STATUS_FMP_RESERVED_MAX_ERROR_CODE_VALUE  0x1FFF
  40
  41 ///
  42 /// The minimum value allowed for FmpDxe driver-specific errors.
  43 ///
  44 #define LAST_ATTEMPT_STATUS_DRIVER_MIN_ERROR_CODE_VALUE  0x1000
  45
  46 ///
  47 /// The maximum value allowed for FmpDxe driver-specific errors.
  48 ///
  49 #define LAST_ATTEMPT_STATUS_DRIVER_MAX_ERROR_CODE_VALUE  0x107F
  50
  51 ///
  52 /// The minimum value allowed for FmpDependencyLib related errors.
  53 ///
  54 #define LAST_ATTEMPT_STATUS_FMP_DEPENDENCY_LIB_MIN_ERROR_CODE_VALUE  0x1080
  55
  56 ///
  57 /// The maximum value allowed for FmpDependencyLib related errors.
  58 ///
  59 #define LAST_ATTEMPT_STATUS_FMP_DEPENDENCY_LIB_MAX_ERROR_CODE_VALUE  0x109F
  60
  61 ///
  62 /// The minimum value allowed for FmpDependencyCheckLib related errors.
  63 ///
  64 #define LAST_ATTEMPT_STATUS_FMP_DEPENDENCY_CHECK_LIB_MIN_ERROR_CODE_VALUE  0x10A0
  65
  66 ///
  67 /// The maximum value allowed for FmpDependencyCheckLib related errors.
  68 ///
  69 #define LAST_ATTEMPT_STATUS_FMP_DEPENDENCY_CHECK_LIB_MAX_ERROR_CODE_VALUE  0x10BF
  70
  71 ///
  72 /// The minimum value allowed for FMP device library errors.
  73 ///
  74 #define LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MIN_ERROR_CODE_VALUE  0x1800
  75
  76 ///
  77 /// The maximum value allowed for FMP device library errors.
  78 ///
  79 #define LAST_ATTEMPT_STATUS_DEVICE_LIBRARY_MAX_ERROR_CODE_VALUE  0x1FFF
  80
  81 #endif