VariablePolicyHelperLib.h File Reference

Functions
EFI_STATUS EFIAPI	CreateBasicVariablePolicy (IN CONST EFI_GUID *Namespace, IN CONST CHAR16 *Name, IN UINT32 MinSize, IN UINT32 MaxSize, IN UINT32 AttributesMustHave, IN UINT32 AttributesCantHave, IN UINT8 LockPolicyType, OUT VARIABLE_POLICY_ENTRY **NewEntry)
EFI_STATUS EFIAPI	CreateVarStateVariablePolicy (IN CONST EFI_GUID *Namespace, IN CONST CHAR16 *Name, IN UINT32 MinSize, IN UINT32 MaxSize, IN UINT32 AttributesMustHave, IN UINT32 AttributesCantHave, IN CONST EFI_GUID *VarStateNamespace, IN UINT8 VarStateValue, IN CONST CHAR16 *VarStateName, OUT VARIABLE_POLICY_ENTRY **NewEntry)
EFI_STATUS EFIAPI	RegisterBasicVariablePolicy (IN EDKII_VARIABLE_POLICY_PROTOCOL *VariablePolicy, IN CONST EFI_GUID *Namespace, IN CONST CHAR16 *Name, IN UINT32 MinSize, IN UINT32 MaxSize, IN UINT32 AttributesMustHave, IN UINT32 AttributesCantHave, IN UINT8 LockPolicyType)
EFI_STATUS EFIAPI	RegisterVarStateVariablePolicy (IN EDKII_VARIABLE_POLICY_PROTOCOL *VariablePolicy, IN CONST EFI_GUID *Namespace, IN CONST CHAR16 *Name, IN UINT32 MinSize, IN UINT32 MaxSize, IN UINT32 AttributesMustHave, IN UINT32 AttributesCantHave, IN CONST EFI_GUID *VarStateNamespace, IN CONST CHAR16 *VarStateName, IN UINT8 VarStateValue)

Function Documentation

EFI_STATUS EFIAPI CreateBasicVariablePolicy	(	IN CONST EFI_GUID *	Namespace,
		IN CONST CHAR16 *	Name,
		IN UINT32	MinSize,
		IN UINT32	MaxSize,
		IN UINT32	AttributesMustHave,
		IN UINT32	AttributesCantHave,
		IN UINT8	LockPolicyType,
		OUT VARIABLE_POLICY_ENTRY **	NewEntry
	)

This helper function will allocate and populate a new VariablePolicy structure for a policy that does not contain any sub-structures (such as VARIABLE_LOCK_ON_VAR_STATE_POLICY).

NOTE: Caller will need to free structure once finished.

Parameters

[in]	Namespace	Pointer to an EFI_GUID for the target variable namespace that this policy will protect.
[in]	Name	[Optional] If provided, a pointer to the CHAR16 array for the target variable name. Otherwise, will create a policy that targets an entire namespace.
[in]	MinSize	MinSize for the VariablePolicy.
[in]	MaxSize	MaxSize for the VariablePolicy.
[in]	AttributesMustHave	AttributesMustHave for the VariablePolicy.
[in]	AttributesCantHave	AttributesCantHave for the VariablePolicy.
[in]	LockPolicyType	LockPolicyType for the VariablePolicy.
[out]	NewEntry	If successful, will be set to a pointer to the allocated buffer containing the new policy.

Return values

EFI_SUCCESS	Operation completed successfully and structure is populated.
EFI_INVALID_PARAMETER	Namespace is NULL.
EFI_INVALID_PARAMETER	LockPolicyType is invalid for a basic structure.
EFI_BUFFER_TOO_SMALL	Finished structure would not fit in UINT16 size.
EFI_OUT_OF_RESOURCES	Could not allocate sufficient space for structure.

EFI_STATUS EFIAPI CreateVarStateVariablePolicy	(	IN CONST EFI_GUID *	Namespace,
		IN CONST CHAR16 *	Name,
		IN UINT32	MinSize,
		IN UINT32	MaxSize,
		IN UINT32	AttributesMustHave,
		IN UINT32	AttributesCantHave,
		IN CONST EFI_GUID *	VarStateNamespace,
		IN UINT8	VarStateValue,
		IN CONST CHAR16 *	VarStateName,
		OUT VARIABLE_POLICY_ENTRY **	NewEntry
	)

This helper function will allocate and populate a new VariablePolicy structure for a policy with a lock type of VARIABLE_POLICY_TYPE_LOCK_ON_VAR_STATE.

NOTE: Caller will need to free structure once finished.

Parameters

[in]	Namespace	Pointer to an EFI_GUID for the target variable namespace that this policy will protect.
[in]	Name	[Optional] If provided, a pointer to the CHAR16 array for the target variable name. Otherwise, will create a policy that targets an entire namespace.
[in]	MinSize	MinSize for the VariablePolicy.
[in]	MaxSize	MaxSize for the VariablePolicy.
[in]	AttributesMustHave	AttributesMustHave for the VariablePolicy.
[in]	AttributesCantHave	AttributesCantHave for the VariablePolicy.
[in]	VarStateNamespace	Pointer to the EFI_GUID for the VARIABLE_LOCK_ON_VAR_STATE_POLICY.Namespace.
[in]	VarStateValue	Value for the VARIABLE_LOCK_ON_VAR_STATE_POLICY.Value.
[in]	VarStateName	Pointer to the CHAR16 array for the VARIABLE_LOCK_ON_VAR_STATE_POLICY.Name.
[out]	NewEntry	If successful, will be set to a pointer to the allocated buffer containing the new policy.

Return values

EFI_SUCCESS	Operation completed successfully and structure is populated.
EFI_INVALID_PARAMETER	Namespace, VarStateNamespace, VarStateName is NULL.
EFI_BUFFER_TOO_SMALL	Finished structure would not fit in UINT16 size.
EFI_OUT_OF_RESOURCES	Could not allocate sufficient space for structure.

EFI_STATUS EFIAPI RegisterBasicVariablePolicy	(	IN EDKII_VARIABLE_POLICY_PROTOCOL *	VariablePolicy,
		IN CONST EFI_GUID *	Namespace,
		IN CONST CHAR16 *	Name,
		IN UINT32	MinSize,
		IN UINT32	MaxSize,
		IN UINT32	AttributesMustHave,
		IN UINT32	AttributesCantHave,
		IN UINT8	LockPolicyType
	)

This helper function does everything that CreateBasicVariablePolicy() does, but also uses the passed in protocol to register the policy with the infrastructure. Does not return a buffer, does not require the caller to free anything.

Parameters

[in]	VariablePolicy	Pointer to a valid instance of the VariablePolicy protocol.
[in]	Namespace	Pointer to an EFI_GUID for the target variable namespace that this policy will protect.
[in]	Name	[Optional] If provided, a pointer to the CHAR16 array for the target variable name. Otherwise, will create a policy that targets an entire namespace.
[in]	MinSize	MinSize for the VariablePolicy.
[in]	MaxSize	MaxSize for the VariablePolicy.
[in]	AttributesMustHave	AttributesMustHave for the VariablePolicy.
[in]	AttributesCantHave	AttributesCantHave for the VariablePolicy.
[in]	LockPolicyType	LockPolicyType for the VariablePolicy.

Return values

EFI_INVALID_PARAMETER	VariablePolicy pointer is NULL.
EFI_STATUS	Status returned by CreateBasicVariablePolicy() or RegisterVariablePolicy().

EFI_STATUS EFIAPI RegisterVarStateVariablePolicy	(	IN EDKII_VARIABLE_POLICY_PROTOCOL *	VariablePolicy,
		IN CONST EFI_GUID *	Namespace,
		IN CONST CHAR16 *	Name,
		IN UINT32	MinSize,
		IN UINT32	MaxSize,
		IN UINT32	AttributesMustHave,
		IN UINT32	AttributesCantHave,
		IN CONST EFI_GUID *	VarStateNamespace,
		IN CONST CHAR16 *	VarStateName,
		IN UINT8	VarStateValue
	)

This helper function does everything that CreateBasicVariablePolicy() does, but also uses the passed in protocol to register the policy with the infrastructure. Does not return a buffer, does not require the caller to free anything.

Parameters

[in]	VariablePolicy	Pointer to a valid instance of the VariablePolicy protocol.
[in]	Namespace	Pointer to an EFI_GUID for the target variable namespace that this policy will protect.
[in]	Name	[Optional] If provided, a pointer to the CHAR16 array for the target variable name. Otherwise, will create a policy that targets an entire namespace.
[in]	MinSize	MinSize for the VariablePolicy.
[in]	MaxSize	MaxSize for the VariablePolicy.
[in]	AttributesMustHave	AttributesMustHave for the VariablePolicy.
[in]	AttributesCantHave	AttributesCantHave for the VariablePolicy.
[in]	VarStateNamespace	Pointer to the EFI_GUID for the VARIABLE_LOCK_ON_VAR_STATE_POLICY.Namespace.
[in]	VarStateName	Pointer to the CHAR16 array for the VARIABLE_LOCK_ON_VAR_STATE_POLICY.Name.
[in]	VarStateValue	Value for the VARIABLE_LOCK_ON_VAR_STATE_POLICY.Value.

Return values

EFI_INVALID_PARAMETER	VariablePolicy pointer is NULL.
EFI_STATUS	Status returned by CreateBasicVariablePolicy() or RegisterVariablePolicy().