Esys_Startup(3)                    tpm2-tss                    Esys_Startup(3)

NAME
       Esys_Startup - The ESAPI function for the TPM2_Startup command.

SYNOPSIS
   Functions
       TSS2_RC Esys_Startup_Async (ESYS_CONTEXT *esysContext, TPM2_SU
           startupType)
       TSS2_RC Esys_Startup (ESYS_CONTEXT *esysContext, TPM2_SU startupType)
       TSS2_RC Esys_Startup_Finish (ESYS_CONTEXT *esysContext)

Detailed Description
       ESAPI function to invoke the TPM2_Startup command either as a one-call
       or in an asynchronous manner.

Function Documentation
   TSS2_RC Esys_Startup (ESYS_CONTEXT * esysContext, TPM2_SU startupType)
       One-Call function for TPM2_Startup

       This function invokes the TPM2_Startup command in a one-call variant.
       This means the function will block until the TPM response is available.
       All input parameters are const. The memory for non-simple output
       parameters is allocated by the function implementation.

       Parameters
           esysContext The ESYS_CONTEXT.
           startupType TPM2_SU_CLEAR or TPM2_SU_STATE.

       Return values
           TSS2_RC_SUCCESS if the function call was a success.
           TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
           pointers or required output handle references are NULL.
           TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
           TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for
           internal operations or return parameters.
           TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous
           operation already pending.
           TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not
           at least contain the tag, response length, and response code.
           TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
           TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did
           not verify.
           TSS2_RCs produced by lower layers of the software stack may be
           returned to the caller unaltered unless handled internally.

   TSS2_RC Esys_Startup_Async (ESYS_CONTEXT * esysContext, TPM2_SU
       startupType)
       Asynchronous function for TPM2_Startup

       This function invokes the TPM2_Startup command in a asynchronous
       variant. This means the function will return as soon as the command has
       been sent downwards the stack to the TPM. All input parameters are
       const. In order to retrieve the TPM's response call
       Esys_Startup_Finish.

       Parameters
           esysContext The ESYS_CONTEXT.
           startupType TPM2_SU_CLEAR or TPM2_SU_STATE.

       Return values
           ESYS_RC_SUCCESS if the function call was a success.
           TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
           pointers or required output handle references are NULL.
           TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
           TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for
           internal operations or return parameters.
           TSS2_RCs produced by lower layers of the software stack may be
           returned to the caller unaltered unless handled internally.

   TSS2_RC Esys_Startup_Finish (ESYS_CONTEXT * esysContext)
       Asynchronous finish function for TPM2_Startup

       This function returns the results of a TPM2_Startup command invoked via
       Esys_Startup_Finish. All non-simple output parameters are allocated by
       the function's implementation. NULL can be passed for every output
       parameter if the value is not required.

       Parameters
           esysContext The ESYS_CONTEXT.

       Return values
           TSS2_RC_SUCCESS on success
           ESYS_RC_SUCCESS if the function call was a success.
           TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
           pointers or required output handle references are NULL.
           TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
           TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for
           internal operations or return parameters.
           TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous
           operation already pending.
           TSS2_ESYS_RC_TRY_AGAIN if the timeout counter expires before the
           TPM response is received.
           TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not
           at least contain the tag, response length, and response code.
           TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did
           not verify.
           TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
           TSS2_RCs produced by lower layers of the software stack may be
           returned to the caller unaltered unless handled internally.

Author
       Generated automatically by Doxygen for tpm2-tss from the source code.

Version 4.0.1                   Sun May 7 2023                 Esys_Startup(3)