| 1 | =head1 NAME
|
|---|
| 2 |
|
|---|
| 3 | TPM_IO_TpmEstablished_Get - get the value of the TPMEstablished flag
|
|---|
| 4 |
|
|---|
| 5 | TPM_IO_TpmEstablished_Reset - reset the TPMEstablished flag
|
|---|
| 6 |
|
|---|
| 7 | =head1 LIBRARY
|
|---|
| 8 |
|
|---|
| 9 | TPM library (libtpms, -ltpms)
|
|---|
| 10 |
|
|---|
| 11 | =head1 SYNOPSIS
|
|---|
| 12 |
|
|---|
| 13 | B<#include <libtpms/tpm_types.h>>
|
|---|
| 14 |
|
|---|
| 15 | B<#include <libtpms/tpm_tis.h>>
|
|---|
| 16 |
|
|---|
| 17 | B<#include <libtpms/tpm_error.h>>
|
|---|
| 18 |
|
|---|
| 19 | B<TPM_RESULT TPM_IO_TpmEstablished_Get(TPM_BOOL> *I<tpmEstablished>B<);>
|
|---|
| 20 |
|
|---|
| 21 | B<TPM_RESULT TPM_IO_TpmEstablished_Reset(void);>
|
|---|
| 22 |
|
|---|
| 23 | =head1 DESCRIPTION
|
|---|
| 24 |
|
|---|
| 25 | The B<TPM_IO_TpmEstablished_Get()> function returns the value of the
|
|---|
| 26 | TPMEstablished flag of the TPM's permanent data.
|
|---|
| 27 |
|
|---|
| 28 | The B<TPM_IO_TpmEstablished_Reset()> function resets the TPMEstablished
|
|---|
| 29 | flag.
|
|---|
| 30 |
|
|---|
| 31 | =head1 ERRORS
|
|---|
| 32 |
|
|---|
| 33 | =over 4
|
|---|
| 34 |
|
|---|
| 35 | =item B<TPM_SUCCESS>
|
|---|
| 36 |
|
|---|
| 37 | The function completed successfully.
|
|---|
| 38 |
|
|---|
| 39 | =item B<TPM_FAIL>
|
|---|
| 40 |
|
|---|
| 41 | General failure.
|
|---|
| 42 |
|
|---|
| 43 | =item B<TPM_BAD_LOCALITY>
|
|---|
| 44 |
|
|---|
| 45 | The locality used for resetting the flags is wrong.
|
|---|
| 46 |
|
|---|
| 47 | =back
|
|---|
| 48 |
|
|---|
| 49 | For a complete list of TPM error codes please consult the include file
|
|---|
| 50 | B<libtpms/tpm_error.h>
|
|---|
| 51 |
|
|---|
| 52 | =head1 SEE ALSO
|
|---|
| 53 |
|
|---|
| 54 | B<TPMLIB_MainInit>(3), B<TPMLIB_Terminate>(3), B<TPMLIB_RegisterCallbacks>(3),
|
|---|
| 55 | B<TPMLIB_Process>(3), B<TPM_IO_Hash_Start>(3), B<TPM_IO_Hash_End>(3),
|
|---|
| 56 | B<TPM_IO_Hash_Data>(3)
|
|---|
| 57 |
|
|---|
| 58 | =cut
|
|---|
