1Tspi_TPM_DirRead(3)        Library Functions Manual        Tspi_TPM_DirRead(3)
2
3
4
5                   TCG Software Stack Developer's Reference
6

NAME

8       Tspi_TPM_DirRead - Read a Data Integrity Register
9

SYNOPSIS

11       #include <tss/platform.h>
12       #include <tss/tcpa_defines.h>
13       #include <tss/tcpa_typedef.h>
14       #include <tss/tcpa_struct.h>
15       #include <tss/tss_typedef.h>
16       #include <tss/tss_structs.h>
17       #include <tss/tspi.h>
18
19       TSS_RESULT Tspi_TPM_DirRead(TSS_HTPM hTPM,             UINT32 ulDirIndex,
20                                   UINT32*  pulDirDataLength, BYTE** prgbDirData);
21
22
23

DESCRIPTION

25       Tspi_TPM_DirRead reads a data integrity register. DIRs are non-volatile
26       (persistent across reboots) memory areas maintained by the TPM.
27
28

PARAMETERS

30   hTPM
31       The hTPM parameter is used to specify the handle of the TPM object.
32
33   ulDirIndex
34       The ulDirIndex parameter is the index of the DIR to read. To query  the
35       TPM  for the number of DIR registers it supports, use Tspi_TPM_GetCapa‐
36       bility(3).
37
38   pulDirDataLength
39       The pulDirDataLength parameter receives the  length  in  bytes  of  the
40       prgbDirData parameter.
41
42   prgbDirData
43       The  prgbDirData  parameter receives a pointer to memory containing the
44       DIR data.
45
46

RETURN CODES

48       Tspi_TPM_DirRead returns TSS_SUCCESS on success, otherwise one  of  the
49       following values is returned:
50
51       TSS_E_INVALID_HANDLE
52              hTPM is not a valid handle.
53
54
55       TSS_E_INTERNAL_ERROR
56              An internal SW error has been detected.
57
58
59       TSS_E_BAD_PARAMETER
60              One or more parameters is bad.
61
62

CONFORMING TO

64       Tspi_TPM_DirRead conforms to the Trusted Computing Group Software Spec‐
65       ification version 1.1 Golden
66
67

SEE ALSO

69       Tspi_TPM_GetCapability(3), Tspi_TPM_DirWrite(3).
70
71
72
73
74TSS 1.1                           2004-05-25               Tspi_TPM_DirRead(3)
Impressum