summaryrefslogtreecommitdiffstats
path: root/man/man3/TPMLIB_MainInit.pod
blob: 663b2a148c8319c3d052abb43b73e262c4cf8cc1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
=head1 NAME

TPMLIB_MainInit    - Initialize the TPM
 
TPMLIB_Terminate   - Terminate the TPM

=head1 LIBRARY

TPM library (libtpms, -ltpms)

=head1 SYNOPSIS

B<#include <libtpms/tpm_types.h>>

B<#include <libtpms/tpm_library.h>>

B<#include <libtpms/tpm_error.h>>

B<TPM_RESULT TPMLIB_MainInit(void);>

B<TPM_RESULT TPMLIB_Terminate(void);>

=head1 DESCRIPTION

The B<TPMLIB_MainInit()> and B<TPMLIB_Terminate()> functions are used
to initialize and terminate the TPM respectively. The B<TPMLIB_MainInit()>
function must be called before the TPM processes any TPM command.
The B<TPMLIB_Terminate()> function is called to free all the internal 
resources (memory allocations) the TPM has used and must be called after
the last TPM command was processed by the TPM. The B<TPMLIB_MainInit()>
function can then be called again.

Use B<TPMLIB_RegisterCallbacks()> to set callback functions for
initialization and writing and restoring the internal state in a
portable format.

=head1 ERRORS

=over 4

=item B<TPM_SUCCESS>

The function completed successfully.

=item B<TPM_FAIL>

General failure.

=back

For a complete list of TPM error codes please consult the include file
B<libtpms/tpm_error.h>

=head1 EXAMPLE

 #include <stdio.h>

 #include <libtpms/tpm_types.h>
 #include <libtpms/tpm_library.h>
 #include <libtpms/tpm_error.h>

 int main(void) {
     TPM_RESULT res;
     unsigned char *respbuffer = NULL;
     uint32_t resp_size = 0;
     uint32_t respbufsize = 0;
     unsigned char *command;
     uint32_t command_size;

     [...]

     if (TPMLIB_MainInit() != TPM_SUCCESS) {
         fprintf(stderr, "Could not start the TPM.\n");
         return 1;
     }

     [...]
     /* build TPM command */
     [...]

     res = TPMLIB_Process(&respbuffer, &resp_size,
                          &respbufsize,
                          command, command_size);
     [...]

     TPMLIB_Terminate();

     return 0;
 }

=head1 SEE ALSO

B<TPMLIB_Process>(3), B<TPMLIB_RegisterCallbacks>(3), B<TPMLIB_GetVersion>(3)
B<TPMLIB_GetTPMProperty>(3), B<TPMLIB_DecodeBlob>(3)

=cut