Fapi_NvExtend − Fapi_NvExtend
Functions
TSS2_RC Fapi_NvExtend
(FAPI_CONTEXT *context, char const *path, uint8_t
const *data, size_t size, char const *logData)
TSS2_RC Fapi_NvExtend_Async (FAPI_CONTEXT
*context, char const *path, uint8_t const *data, size_t
size, char const *logData)
TSS2_RC Fapi_NvExtend_Finish (FAPI_CONTEXT
*context)
FAPI functions to invoke NvExtend either as one-call or in an asynchronous manner.
TSS2_RC
Fapi_NvExtend (FAPI_CONTEXT * context, char const * nvPath,
uint8_t const * data, size_t dataSize, char const *
logData)
One-Call function for Fapi_NvExtend
Performs an extend operation on an NV index with the type extend.
Parameters
context the FAPI context
nvPath The path to the NV index that is extended
data The data to extend on the NV index
dataSize The size of the data to extend. Must be smaller
than 1024
logData A JSON representation of the data that is
written to the event log. May be NULL
Return values
TSS2_RC_SUCCESS if the
function call was a success.
TSS2_FAPI_RC_BAD_REFERENCE if context, nvPath, or data
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 is not an
extendable 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_BAD_VALUE if an invalid value was passed
into the function.
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_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.
TSS2_RC
Fapi_NvExtend_Async (FAPI_CONTEXT * context, char const *
nvPath, uint8_t const * data, size_t dataSize, char const *
logData)
Asynchronous function for Fapi_NvExtend
Performs an extend operation on an NV index with the type extend.
Call Fapi_NvExtend_Finish to finish the execution of this command.
Parameters
context the FAPI context
nvPath The path to the NV index that is extended
data The data to extend on the NV index
dataSize The size of the data to extend. Must be smaller
than 1024
logData A JSON representation of the data that is
written to the event log. May be NULL
Return values
TSS2_RC_SUCCESS if the
function call was a success.
TSS2_FAPI_RC_BAD_REFERENCE if context, nvPath, or data
is NULL.
TSS2_FAPI_RC_BAD_CONTEXT if context corruption is
detected.
TSS2_FAPI_RC_BAD_VALUE if dataSize is larger than 1024
TSS2_FAPI_RC_BAD_PATH if nvPath is not found.
TSS2_FAPI_RC_NV_WRONG_TYPE if the NV is not an
extendable 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_NOT_PROVISIONED FAPI was not
provisioned.
TSS2_RC
Fapi_NvExtend_Finish (FAPI_CONTEXT * context)
Asynchronous finish function for Fapi_NvExtend
This function should be called after a previous Fapi_NvExtend.
Parameters
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 a 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.
Generated automatically by Doxygen for tpm2-tss from the source code.