~ubuntu-branches/ubuntu/gutsy/trousers/gutsy

« back to all changes in this revision

Viewing changes to man/man3/Tspi_TPM_CertifySelfTest.3

  • Committer: Bazaar Package Importer
  • Author(s): William Lima
  • Date: 2007-04-18 16:39:38 UTC
  • Revision ID: james.westby@ubuntu.com-20070418163938-opscl2mvvi76jiec
Tags: upstream-0.2.9.1
ImportĀ upstreamĀ versionĀ 0.2.9.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Copyright (C) 2004 International Business Machines Corporation
 
2
.\" Written by Kathy Robertson based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden
 
3
.\"
 
4
.de Sh \" Subsection
 
5
.br
 
6
.if t .Sp
 
7
.ne 5
 
8
.PP
 
9
\fB\\$1\fR
 
10
.PP
 
11
..
 
12
.de Sp \" Vertical space (when we can't use .PP)
 
13
.if t .sp .5v
 
14
.if n .sp
 
15
..
 
16
.de Ip \" List item
 
17
.br
 
18
.ie \\n(.$>=3 .ne \\$3
 
19
.el .ne 3
 
20
.IP "\\$1" \\$2
 
21
..
 
22
.TH "Tspi_TPM_CertifySelfTest" 3 "2004-05-26" "TSS 1.1" "TCG Software Stack Developer's Reference"
 
23
.SH NAME
 
24
Tspi_TPM_CertifySelfTest\- have the TPM sign its self test data
 
25
.SH "SYNOPSIS"
 
26
.ad l
 
27
.hy 0
 
28
.nf
 
29
.B #include <tss/platform.h>
 
30
.B #include <tss/tcpa_defines.h>
 
31
.B #include <tss/tcpa_typedef.h>
 
32
.B #include <tss/tcpa_struct.h>
 
33
.B #include <tss/tss_typedef.h>
 
34
.B #include <tss/tss_structs.h>
 
35
.B #include <tss/tspi.h>
 
36
.sp
 
37
.BI "TSS_RESULT Tspi_TPM_CertifySelfTest(TSS_HTPM        " hTPM ", TSS_HKEY " hKey ","
 
38
.BI "                                    TSS_VALIDATION* " pValidationData " );"
 
39
.fi
 
40
.sp
 
41
.ad
 
42
.hy
 
43
 
 
44
.SH "DESCRIPTION"
 
45
.PP
 
46
\fBTspi_TPM_CertifySelfTest\fR performs a self-test of each internal TPM function and returns an authenticated value (signature) if the test has passed.
 
47
.SH "PARAMETERS"
 
48
.PP
 
49
.SS hTPM
 
50
Handle of the TPM object
 
51
.PP 
 
52
.SS hKey
 
53
Handle of the signature key object
 
54
.PP
 
55
.SS
 
56
pValidationData
 
57
Validation data structure.
 
58
[IN] Provide externalData information required to compute the signature.
 
59
[OUT] On successful completion of the ocmmand, the structure provides a buffer containing the validation data and a buffer containing the data the validation data was computed from.
 
60
.SH "RETURN CODES"
 
61
.PP
 
62
\fBTspi_TPM_CertifySelfTest\fR returns TSS_SUCCESS on success, otherwise one of the following values are returned:
 
63
.TP
 
64
.SM TSS_E_INVALID_HANDLE
 
65
\fBhTPM\fR is not a valid handle to a TPM object.
 
66
.TP
 
67
.SM TSS_E_INTERNAL_ERROR
 
68
An error occurred internal to the TSS.
 
69
 
 
70
.SH "CONFORMING TO"
 
71
 
 
72
.PP
 
73
\fBTspi_TPM_CertifySelfTest\fR conforms to the Trusted Computing Group Software Specification version 1.1 Golden
 
74
.SH "SEE ALSO"
 
75
 
 
76
.PP
 
77
\fBTspi_TPM_SelfTestFull\fR(3).
 
78
 
 
79
 
 
80