CapsuleUpdatePolicy.h 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. /** @file
  2. Provides platform policy services used during a capsule update.
  3. Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef __CAPSULE_UPDATE_POLICY_H__
  7. #define __CAPSULE_UPDATE_POLICY_H__
  8. #define EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL_GUID \
  9. { \
  10. 0x487784c5, 0x6299, 0x4ba6, { 0xb0, 0x96, 0x5c, 0xc5, 0x27, 0x7c, 0xf7, 0x57 } \
  11. }
  12. typedef struct _EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL;
  13. /**
  14. Determine if the system power state supports a capsule update.
  15. @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
  16. @param[out] Good Returns TRUE if system power state supports a capsule
  17. update. Returns FALSE if system power state does not
  18. support a capsule update. Return value is only valid if
  19. return status is EFI_SUCCESS.
  20. @retval EFI_SUCCESS Good parameter has been updated with result.
  21. @retval EFI_INVALID_PARAMETER Good is NULL.
  22. @retval EFI_DEVICE_ERROR System power state can not be determined.
  23. **/
  24. typedef
  25. EFI_STATUS
  26. (EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_POWER) (
  27. IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,
  28. OUT BOOLEAN *Good
  29. );
  30. /**
  31. Determines if the system thermal state supports a capsule update.
  32. @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
  33. @param[out] Good Returns TRUE if system thermal state supports a capsule
  34. update. Returns FALSE if system thermal state does not
  35. support a capsule update. Return value is only valid if
  36. return status is EFI_SUCCESS.
  37. @retval EFI_SUCCESS Good parameter has been updated with result.
  38. @retval EFI_INVALID_PARAMETER Good is NULL.
  39. @retval EFI_DEVICE_ERROR System thermal state can not be determined.
  40. **/
  41. typedef
  42. EFI_STATUS
  43. (EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_THERMAL) (
  44. IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,
  45. OUT BOOLEAN *Good
  46. );
  47. /**
  48. Determines if the system environment state supports a capsule update.
  49. @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
  50. @param[out] Good Returns TRUE if system environment state supports a capsule
  51. update. Returns FALSE if system environment state does not
  52. support a capsule update. Return value is only valid if
  53. return status is EFI_SUCCESS.
  54. @retval EFI_SUCCESS Good parameter has been updated with result.
  55. @retval EFI_INVALID_PARAMETER Good is NULL.
  56. @retval EFI_DEVICE_ERROR System environment state can not be determined.
  57. **/
  58. typedef
  59. EFI_STATUS
  60. (EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_ENVIRONMENT) (
  61. IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,
  62. OUT BOOLEAN *Good
  63. );
  64. /**
  65. Determines if the Lowest Supported Version checks should be performed. The
  66. expected result from this function is TRUE. A platform can choose to return
  67. FALSE (e.g. during manufacturing or servicing) to allow a capsule update to a
  68. version below the current Lowest Supported Version.
  69. @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
  70. @retval TRUE The lowest supported version check is required.
  71. @retval FALSE Do not perform lowest support version check.
  72. **/
  73. typedef
  74. BOOLEAN
  75. (EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_IS_LOWEST_SUPPORTED_VERSION_CHECK_REQUIRED) (
  76. IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This
  77. );
  78. /**
  79. Determines if the FMP device should be locked when the event specified by
  80. PcdFmpDeviceLockEventGuid is signaled. The expected result from this function
  81. is TRUE so the FMP device is always locked. A platform can choose to return
  82. FALSE (e.g. during manufacturing) to allow FMP devices to remain unlocked.
  83. @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
  84. @retval TRUE The FMP device lock action is required at lock event guid.
  85. @retval FALSE Do not perform FMP device lock at lock event guid.
  86. **/
  87. typedef
  88. BOOLEAN
  89. (EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_IS_FMP_DEVICE_AT_LOCK_EVENT_REQUIRED) (
  90. IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This
  91. );
  92. ///
  93. /// This protocol provides platform policy services used during a capsule update.
  94. ///
  95. struct _EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL {
  96. EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_POWER CheckSystemPower;
  97. EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_THERMAL CheckSystemThermal;
  98. EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_ENVIRONMENT CheckSystemEnvironment;
  99. EDKII_CAPSULE_UPDATE_POLICY_IS_LOWEST_SUPPORTED_VERSION_CHECK_REQUIRED IsLowestSupportedVersionCheckRequired;
  100. EDKII_CAPSULE_UPDATE_POLICY_IS_FMP_DEVICE_AT_LOCK_EVENT_REQUIRED IsLockFmpDeviceAtLockEventGuidRequired;
  101. };
  102. extern EFI_GUID gEdkiiCapsuleUpdatePolicyProtocolGuid;
  103. #endif