libtpms/man/man3/TPM_IO_TpmEstablished_Get.pod
Stefan Berger 3cf528aaac Integrate the TPM 2 into the library; do not compile with TPM 2 yet
Introduce --with-tpm2 for ./configure to enable building with
TPM 2 functionality. Delay the building of TPM 2 code until more
patches are applied and the vTPM state that's created has a chance
of being backwards compatible.

Extend the libtpms API to allow user to choose version of TPM.

Missing functionality at this point:
- TPM 2 needs to be extended to serialize and deserialize its volatile state
- Handling of the establishment bit

Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
2018-06-15 18:07:47 -04:00

59 lines
1.1 KiB
Plaintext

=head1 NAME
TPM_IO_TpmEstablished_Get - get the value of the TPMEstablished flag
TPM_IO_TpmEstablished_Reset - reset the TPMEstablished flag
=head1 LIBRARY
TPM library (libtpms, -ltpms)
=head1 SYNOPSIS
B<#include <libtpms/tpm_types.h>>
B<#include <libtpms/tpm_tis.h>>
B<#include <libtpms/tpm_error.h>>
B<TPM_RESULT TPM_IO_TpmEstablished_Get(TPM_BOOL> *I<tpmEstablished>B<);>
B<TPM_RESULT TPM_IO_TpmEstablished_Reset(void);>
=head1 DESCRIPTION
The B<TPM_IO_TpmEstablished_Get()> function returns the value of the
TPMEstablished flag of the TPM's permanent data.
The B<TPM_IO_TpmEstablished_Reset()> function resets the TPMEstablished
flag.
=head1 ERRORS
=over 4
=item B<TPM_SUCCESS>
The function completed sucessfully.
=item B<TPM_FAIL>
General failure.
=item B<TPM_BAD_LOCALITY>
The locality used for resetting the flags is wrong.
=back
For a complete list of TPM error codes please consult the include file
B<libtpms/tpm_error.h>
=head1 SEE ALSO
B<TPMLIB_MainInit>(3), B<TPMLIB_Terminate>(3), B<TPMLIB_RegisterCallbacks>(3),
B<TPMLIB_Process>(3), B<TPM_IO_Hash_Start>(3), B<TPM_IO_Hash_End>(3),
B<TPM_IO_Hash_Data>(3)
=cut