Fapi_NvSetBits

Functions
TSS2_RC	Fapi_NvSetBits (FAPI_CONTEXT *context, char const *path, uint64_t bitmap)
TSS2_RC	Fapi_NvSetBits_Async (FAPI_CONTEXT *context, char const *path, uint64_t bitmap)
TSS2_RC	Fapi_NvSetBits_Finish (FAPI_CONTEXT *context)

Detailed Description

FAPI functions to invoke NvSetBits either as one-call or in an asynchronous manner.

Function Documentation

Fapi_NvSetBits()

Fapi_NvSetBits	(	FAPI_CONTEXT *	context,
		char const *	nvPath,
		uint64_t	bitmap
	)

One-Call function for Fapi_NvSetBits

Sets bits in an NV index that was created as a bit field. Any number of bits from 0 to 64 may be SET.

Parameters

[in,out]	context	The FAPI_CONTEXT
[in]	nvPath	The path to the NV index where bits are set
[in]	bitmap	The map of the bits to set

Return values

TSS2_RC_SUCCESS	if the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCE	if context or nvPath is NULL.
TSS2_FAPI_RC_BAD_CONTEXT	if context corruption is detected.
TSS2_FAPI_RC_BAD_PATH	if nvPath is not found.
TSS2_FAPI_RC_NV_WRONG_TYPE	if the NV index type is not TPM2_NT_COUNTER.
TSS2_FAPI_RC_NV_NOT_WRITEABLE	if the NV is not a writeable index.
TSS2_FAPI_RC_POLICY_UNKNOWN	if the policy is unknown.
TSS2_FAPI_RC_BAD_SEQUENCE	if the context has an asynchronous operation already pending.
TSS2_FAPI_RC_IO_ERROR	if the data cannot be saved.
TSS2_FAPI_RC_MEMORY	if the FAPI cannot allocate enough memory for internal operations or return parameters.
TSS2_FAPI_RC_NO_TPM	if FAPI was initialized in no-TPM-mode via its config file.
TSS2_FAPI_RC_PATH_NOT_FOUND	if a FAPI object path was not found during authorization.
TSS2_FAPI_RC_KEY_NOT_FOUND	if a key was not found.
TSS2_FAPI_RC_BAD_VALUE	if an invalid value was passed into the function.
TSS2_FAPI_RC_TRY_AGAIN	if an I/O operation is not finished yet and this function needs to be called again.
TSS2_FAPI_RC_GENERAL_FAILURE	if an internal error occurred.
TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN	if a required authorization callback is not set.
TSS2_FAPI_RC_AUTHORIZATION_FAILED	if the authorization attempt fails.
TSS2_ESYS_RC_*	possible error codes of ESAPI.
TSS2_FAPI_RC_NOT_PROVISIONED	FAPI was not provisioned.

Fapi_NvSetBits_Async()

Fapi_NvSetBits_Async	(	FAPI_CONTEXT *	context,
		char const *	nvPath,
		uint64_t	bitmap
	)

Asynchronous function for Fapi_NvSetBits

Sets bits in an NV index that was created as a bit field. Any number of bits from 0 to 64 may be SET.

Call Fapi_NvSetBits_Finish to finish the execution of this command.

Parameters

[in,out]	context	The FAPI_CONTEXT
[in]	nvPath	The path to the NV index where bits are set
[in]	bitmap	The map of the bits to set

Return values

TSS2_RC_SUCCESS	if the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCE	if context or nvPath is NULL.
TSS2_FAPI_RC_BAD_CONTEXT	if context corruption is detected.
TSS2_FAPI_RC_BAD_PATH	if nvPath is not found.
TSS2_FAPI_RC_NV_WRONG_TYPE	if the NV index type is not TPM2_NT_COUNTER.
TSS2_FAPI_RC_NV_NOT_WRITEABLE	if the NV is not a writeable index.
TSS2_FAPI_RC_POLICY_UNKNOWN	if the policy is unknown.
TSS2_FAPI_RC_BAD_SEQUENCE	if the context has an asynchronous operation already pending.
TSS2_FAPI_RC_IO_ERROR	if the data cannot be saved.
TSS2_FAPI_RC_MEMORY	if the FAPI cannot allocate enough memory for internal operations or return parameters.
TSS2_FAPI_RC_NO_TPM	if FAPI was initialized in no-TPM-mode via its config file.
TSS2_FAPI_RC_PATH_NOT_FOUND	if a FAPI object path was not found during authorization.
TSS2_FAPI_RC_KEY_NOT_FOUND	if a key was not found.
TSS2_FAPI_RC_BAD_VALUE	if an invalid value was passed into the function.
TSS2_FAPI_RC_NOT_PROVISIONED	FAPI was not provisioned.

Fapi_NvSetBits_Finish()

Fapi_NvSetBits_Finish

(

FAPI_CONTEXT *

context

)

Asynchronous finish function for Fapi_NnSetBits

This function should be called after a previous Fapi_NvSetBIts_Async.

Parameters

[in,out]

context

The FAPI_CONTEXT

Return values

TSS2_RC_SUCCESS	if the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCE	if context is NULL.
TSS2_FAPI_RC_BAD_CONTEXT	if context corruption is detected.
TSS2_FAPI_RC_BAD_SEQUENCE	if the context has an asynchronous operation already pending.
TSS2_FAPI_RC_IO_ERROR	if the data cannot be saved.
TSS2_FAPI_RC_MEMORY	if the FAPI cannot allocate enough memory for internal operations or return parameters.
TSS2_FAPI_RC_TRY_AGAIN	if the asynchronous operation is not yet complete. Call this function again later.
TSS2_FAPI_RC_BAD_PATH	if the path is used in inappropriate context or contains illegal characters.
TSS2_FAPI_RC_BAD_VALUE	if an invalid value was passed into the function.
TSS2_FAPI_RC_GENERAL_FAILURE	if an internal error occurred.
TSS2_FAPI_RC_PATH_NOT_FOUND	if a FAPI object path was not found during authorization.
TSS2_FAPI_RC_KEY_NOT_FOUND	if a key was not found.
TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN	if a required authorization callback is not set.
TSS2_FAPI_RC_AUTHORIZATION_FAILED	if the authorization attempt fails.
TSS2_FAPI_RC_POLICY_UNKNOWN	if policy search for a certain policy digest was not successful.
TSS2_ESYS_RC_*	possible error codes of ESAPI.
TSS2_FAPI_RC_NOT_PROVISIONED	FAPI was not provisioned.