Tspi_TPM_GetCapability(3)

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

NAME

8       Tspi_TPM_GetCapability - get information on the capabilities of the TPM
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_GetCapability(TSS_HTPM hTPM,              TSS_FLAG capArea,
20                                         UINT32   ulSubCapLength,    BYTE*    rgbSubCap,
21                                         UINT32*  pulRespDataLength, BYTE**   prgbRespData);
22
23
24

DESCRIPTION

26       Tspi_TPM_GetCapability  gets information on various capabilities of the
27       TPM. This command can be used to learn how many PCRs the TPM  supports,
28       etc.
29
30

PARAMETERS

32   hTPM
33       The hTPM parameter is used to specify the handle of the TPM object.
34
35   capArea
36       The  capArea  parameter  is the flag indicating the attribute to query.
37       Possible values are:
38
39   ulSubCapLength
40       The ulSubCapLength parameter is the length in bytes  of  the  rgbSubCap
41       parameter.
42
43   rgbSubCap
44       The  rgbSubCap parameter is the data indicating the attribute to query.
45       Possible values are:
46
47   pulRespDataLength
48       The pulRespDataLength parameter is the length in bytes of the prgbResp‐
49       Data parameter.
50
51   prgbRespData
52       The prgbRespData parameter receives a pointer to the actual data of the
53       specified attribute.
54
55

NOTES

57       The following Capability Areas and Sub-Capability Areas  are  supported
58       by 1.1 TSS's:
59
60
61       TSS_TPMCAP_ORD - query whether an ordinal is supported by the TPM.
62               subCaps: TPM_ORD_* (see tcpa_literals.h)
63
64       TSS_TPMCAP_FLAG  - query for the volatile and non-volatile flags inside
65       the TPM. (Must be owner authorized). In this case, the 2 UINT32  values
66       will be returned concatenated together in prgbRespData.
67               subCaps: ignored.
68
69       TSS_TPMCAP_ALG - query whether an algorithm is supported by the TPM.
70               subCaps: TSS_ALG_RSA
71                        TSS_ALG_DES
72                        TSS_ALG_3DES
73                        TSS_ALG_SHA
74                        TSS_ALG_HMAC
75                        TSS_ALG_AES
76
77       TSS_TPMCAP_PROPERTY - query a property of the TPM.
78               subCaps: TSS_TPMCAP_PROP_PCR
79                        TSS_TPMCAP_PROP_DIR
80                        TSS_TPMCAP_PROP_MANUFACTURER
81                        TSS_TPMCAP_PROP_SLOTS
82
83       TSS_TPMCAP_VERSION  -  get the TSS_VERSION structure tha identifies the
84       TPM.
85               subCaps: ignored.
86
87
88

RETURN CODES

90       Tspi_TPM_GetCapability returns TSS_SUCCESS on success, otherwise one of
91       the following values is returned:
92
93       TSS_E_INVALID_HANDLE
94              hTPM is not a valid handle.
95
96
97       TSS_E_INTERNAL_ERROR
98              An internal SW error has been detected.
99
100
101       TSS_E_BAD_PARAMETER
102              One or more parameters is bad.
103
104

CONFORMING TO

106       Tspi_TPM_GetCapability conforms to the Trusted Computing Group Software
107       Specification version 1.1 Golden
108
109