csu3_am335x/EVSE/GPL/tpm2-tss-3.2.0/doxygen-doc/man/Fapi_PcrRead.3

.TH "Fapi_PcrRead" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Fapi_PcrRead
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "TSS2_RC \fBFapi_PcrRead\fP (\fBFAPI_CONTEXT\fP *context, uint32_t pcrIndex, uint8_t **pcrValue, size_t *pcrValueSize, char **pcrLog)"
.br
.ti -1c
.RI "TSS2_RC \fBFapi_PcrRead_Async\fP (\fBFAPI_CONTEXT\fP *context, uint32_t pcrIndex)"
.br
.ti -1c
.RI "TSS2_RC \fBFapi_PcrRead_Finish\fP (\fBFAPI_CONTEXT\fP *context, uint8_t **pcrValue, size_t *pcrValueSize, char **pcrLog)"
.br
.in -1c
.SH "Detailed Description"
.PP 
FAPI functions to invoke PcrRead either as one-call or in an asynchronous manner\&. 
.SH "Function Documentation"
.PP 
.SS "Fapi_PcrRead (\fBFAPI_CONTEXT\fP * context, uint32_t pcrIndex, uint8_t ** pcrValue, size_t * pcrValueSize, char ** pcrLog)"
One-Call function for Fapi_PcrRead
.PP
Reads from a given PCR and returns the value and the event log\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIpcrIndex\fP The index of the PCR to read 
.br
\fIpcrValue\fP The value of the PCR\&. May be NULL 
.br
\fIpcrValueSize\fP The size of value in bytes\&. May be NULL 
.br
\fIpcrLog\fP The PCR log\&. May be NULL
.RE
.PP
\fBReturn values:\fP
.RS 4
\fITSS2_RC_SUCCESS\fP if the function call was a success\&. 
.br
\fITSS2_FAPI_RC_BAD_REFERENCE\fP if context, pcrValue or pcrValueSize is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if pcrIndex is invalid\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_IO_ERROR\fP if the data cannot be saved\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_NO_TPM\fP if FAPI was initialized in no-TPM-mode via its config file\&. 
.br
\fITSS2_FAPI_RC_TRY_AGAIN\fP if an I/O operation is not finished yet and this function needs to be called again\&. 
.br
\fITSS2_FAPI_RC_AUTHORIZATION_UNKNOWN\fP if a required authorization callback is not set\&. 
.br
\fITSS2_FAPI_RC_AUTHORIZATION_FAILED\fP if the authorization attempt fails\&. 
.br
\fITSS2_FAPI_RC_GENERAL_FAILURE\fP if an internal error occurred\&. 
.br
\fITSS2_FAPI_RC_POLICY_UNKNOWN\fP if policy search for a certain policy digest was not successful\&. 
.br
\fITSS2_FAPI_RC_NO_CERT\fP if an error did occur during certificate downloading\&. 
.br
\fITSS2_FAPI_RC_PATH_NOT_FOUND\fP if a FAPI object path was not found during authorization\&. 
.br
\fITSS2_FAPI_RC_KEY_NOT_FOUND\fP if a key was not found\&. 
.br
\fITSS2_ESYS_RC_*\fP possible error codes of ESAPI\&. 
.RE
.PP

.SS "Fapi_PcrRead_Async (\fBFAPI_CONTEXT\fP * context, uint32_t pcrIndex)"
Asynchronous function for Fapi_PcrRead
.PP
Reads from a given PCR and returns the value and the event log\&.
.PP
Call Fapi_PcrRead_Finish to finish the execution of this command\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIpcrIndex\fP The index of the PCR to read
.RE
.PP
\fBReturn values:\fP
.RS 4
\fITSS2_RC_SUCCESS\fP if the function call was a success\&. 
.br
\fITSS2_FAPI_RC_BAD_REFERENCE\fP if context is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if pcrIndex is invalid\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_IO_ERROR\fP if the data cannot be saved\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_NO_TPM\fP if FAPI was initialized in no-TPM-mode via its config file\&. 
.br
\fITSS2_ESYS_RC_*\fP possible error codes of ESAPI\&. 
.RE
.PP

.SS "Fapi_PcrRead_Finish (\fBFAPI_CONTEXT\fP * context, uint8_t ** pcrValue, size_t * pcrValueSize, char ** pcrLog)"
Asynchronous finish function for Fapi_PcrRead
.PP
This function should be called after a previous Fapi_PcrRead_Async\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIpcrValue\fP The value of the PCR\&. May be NULL 
.br
\fIpcrValueSize\fP The size of value in bytes\&. May be NULL 
.br
\fIpcrLog\fP The PCR log\&. May be NULL
.RE
.PP
\fBReturn values:\fP
.RS 4
\fITSS2_RC_SUCCESS\fP if the function call was a success\&. 
.br
\fITSS2_FAPI_RC_BAD_REFERENCE\fP if context, pcrValue or pcrValueSize is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_IO_ERROR\fP if the data cannot be saved\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_TRY_AGAIN\fP if the asynchronous operation is not yet complete\&. Call this function again later\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if an invalid value was passed into the function\&. 
.br
\fITSS2_ESYS_RC_*\fP possible error codes of ESAPI\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for tpm2-tss from the source code\&.