CapsuleUpdatePolicy.h File Reference

Go to the source code of this file.

Data Structures
struct	_EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL

Macros
#define	EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL_GUID

Typedefs
typedef struct _EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL	EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_POWER) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)
typedef EFI_STATUS(EFIAPI *	EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_THERMAL) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)
typedef EFI_STATUS(EFIAPI *	EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_ENVIRONMENT) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)
typedef BOOLEAN(EFIAPI *	EDKII_CAPSULE_UPDATE_POLICY_IS_LOWEST_SUPPORTED_VERSION_CHECK_REQUIRED) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This)
typedef BOOLEAN(EFIAPI *	EDKII_CAPSULE_UPDATE_POLICY_IS_FMP_DEVICE_AT_LOCK_EVENT_REQUIRED) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This)

Variables
EFI_GUID	gEdkiiCapsuleUpdatePolicyProtocolGuid

Detailed Description

Provides platform policy services used during a capsule update.

Copyright (c) 2019, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CapsuleUpdatePolicy.h.

Macro Definition Documentation

EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL_GUID

#define EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL_GUID

Value:

  { \
    0x487784c5, 0x6299, 0x4ba6, { 0xb0, 0x96, 0x5c, 0xc5, 0x27, 0x7c, 0xf7, 0x57 } \
  }

Definition at line 13 of file CapsuleUpdatePolicy.h.

Typedef Documentation

EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_ENVIRONMENT

typedef EFI_STATUS(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_ENVIRONMENT) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)

Determines if the system environment state supports a capsule update.

Parameters

[in]	This	A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
[out]	Good	Returns TRUE if system environment state supports a capsule update. Returns FALSE if system environment state does not support a capsule update. Return value is only valid if return status is EFI_SUCCESS.

Return values

EFI_SUCCESS	Good parameter has been updated with result.
EFI_INVALID_PARAMETER	Good is NULL.
EFI_DEVICE_ERROR	System environment state can not be determined.

Definition at line 77 of file CapsuleUpdatePolicy.h.

EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_POWER

typedef EFI_STATUS(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_POWER) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)

Determine if the system power state supports a capsule update.

Parameters

[in]	This	A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
[out]	Good	Returns TRUE if system power state supports a capsule update. Returns FALSE if system power state does not support a capsule update. Return value is only valid if return status is EFI_SUCCESS.

Return values

EFI_SUCCESS	Good parameter has been updated with result.
EFI_INVALID_PARAMETER	Good is NULL.
EFI_DEVICE_ERROR	System power state can not be determined.

Definition at line 35 of file CapsuleUpdatePolicy.h.

EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_THERMAL

typedef EFI_STATUS(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_THERMAL) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)

Determines if the system thermal state supports a capsule update.

Parameters

[in]	This	A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
[out]	Good	Returns TRUE if system thermal state supports a capsule update. Returns FALSE if system thermal state does not support a capsule update. Return value is only valid if return status is EFI_SUCCESS.

Return values

EFI_SUCCESS	Good parameter has been updated with result.
EFI_INVALID_PARAMETER	Good is NULL.
EFI_DEVICE_ERROR	System thermal state can not be determined.

Definition at line 56 of file CapsuleUpdatePolicy.h.

EDKII_CAPSULE_UPDATE_POLICY_IS_FMP_DEVICE_AT_LOCK_EVENT_REQUIRED

typedef BOOLEAN(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_IS_FMP_DEVICE_AT_LOCK_EVENT_REQUIRED) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This)

Determines if the FMP device should be locked when the event specified by PcdFmpDeviceLockEventGuid is signaled. The expected result from this function is TRUE so the FMP device is always locked. A platform can choose to return FALSE (e.g. during manufacturing) to allow FMP devices to remain unlocked.

Parameters

[in]

This

A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.

Return values

TRUE	The FMP device lock action is required at lock event guid.
FALSE	Do not perform FMP device lock at lock event guid.

Definition at line 114 of file CapsuleUpdatePolicy.h.

EDKII_CAPSULE_UPDATE_POLICY_IS_LOWEST_SUPPORTED_VERSION_CHECK_REQUIRED

typedef BOOLEAN(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_IS_LOWEST_SUPPORTED_VERSION_CHECK_REQUIRED) (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This)

Determines if the Lowest Supported Version checks should be performed. The expected result from this function is TRUE. A platform can choose to return FALSE (e.g. during manufacturing or servicing) to allow a capsule update to a version below the current Lowest Supported Version.

Parameters

[in]

This

A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.

Return values

TRUE	The lowest supported version check is required.
FALSE	Do not perform lowest support version check.

Definition at line 96 of file CapsuleUpdatePolicy.h.

EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL

typedef struct _EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL

Definition at line 18 of file CapsuleUpdatePolicy.h.