NAME

       Esys_PCR_Read - The ESAPI function for the TPM2_PCR_Read command.

SYNOPSIS

   Functions
       TSS2_RC Esys_PCR_Read_Async (ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR
           shandle3, const TPML_PCR_SELECTION *pcrSelectionIn)
       TSS2_RC Esys_PCR_Read (ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
           const TPML_PCR_SELECTION *pcrSelectionIn, UINT32 *pcrUpdateCounter, TPML_PCR_SELECTION
           **pcrSelectionOut, TPML_DIGEST **pcrValues)
       TSS2_RC Esys_PCR_Read_Finish (ESYS_CONTEXT *esysContext, UINT32 *pcrUpdateCounter, TPML_PCR_SELECTION
           **pcrSelectionOut, TPML_DIGEST **pcrValues)

Detailed Description

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

Function Documentation

   TSS2_RC Esys_PCR_Read (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
       const TPML_PCR_SELECTION * pcrSelectionIn, UINT32 * pcrUpdateCounter, TPML_PCR_SELECTION **
       pcrSelectionOut, TPML_DIGEST ** pcrValues)
       One-Call function for TPM2_PCR_Read

       This function invokes the TPM2_PCR_Read 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.
           shandle1 First session handle.
           shandle2 Second session handle.
           shandle3 Third session handle.
           pcrSelectionIn The selection of PCR to read.
           pcrUpdateCounter The current value of the PCR update counter.
           pcrSelectionOut The PCR in the returned list. (callee-allocated)
           pcrValues The contents of the PCR indicated in pcrSelectOut-> pcrSelection[] as tagged digests.
           (callee-allocated)

       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_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the 'decrypt' attribute bit set.
           TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the 'encrypt' attribute bit set.
           TSS2_ESYS_RC_NO_DECRYPT_PARAM if one of the sessions has the 'decrypt' attribute set and the command
           does not support encryption of the first command parameter.
           TSS2_ESYS_RC_NO_ENCRYPT_PARAM if one of the sessions has the 'encrypt' attribute set and the command
           does not support encryption of the first response parameter.
           TSS2_RCs produced by lower layers of the software stack may be returned to the caller unaltered
           unless handled internally.

   TSS2_RC Esys_PCR_Read_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR
       shandle3, const TPML_PCR_SELECTION * pcrSelectionIn)
       Asynchronous function for TPM2_PCR_Read

       This function invokes the TPM2_PCR_Read 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_PCR_Read_Finish.

       Parameters
           esysContext The ESYS_CONTEXT.
           shandle1 First session handle.
           shandle2 Second session handle.
           shandle3 Third session handle.
           pcrSelectionIn The selection of PCR to read.

       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_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the 'decrypt' attribute bit set.
           TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the 'encrypt' attribute bit set.
           TSS2_ESYS_RC_NO_DECRYPT_PARAM if one of the sessions has the 'decrypt' attribute set and the command
           does not support encryption of the first command parameter.
           TSS2_ESYS_RC_NO_ENCRYPT_PARAM if one of the sessions has the 'encrypt' attribute set and the command
           does not support encryption of the first response parameter.

   TSS2_RC Esys_PCR_Read_Finish (ESYS_CONTEXT * esysContext, UINT32 * pcrUpdateCounter, TPML_PCR_SELECTION **
       pcrSelectionOut, TPML_DIGEST ** pcrValues)
       Asynchronous finish function for TPM2_PCR_Read

       This function returns the results of a TPM2_PCR_Read command invoked via Esys_PCR_Read_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.
           pcrUpdateCounter The current value of the PCR update counter.
           pcrSelectionOut The PCR in the returned list. (callee-allocated)
           pcrValues The contents of the PCR indicated in pcrSelectOut-> pcrSelection[] as tagged digests.
           (callee-allocated)

       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.

tpm2-tss                                          Version 4.1.3                                 Esys_PCR_Read(3)