diff options
Diffstat (limited to 'man/man3/Tspi_TPM_SetStatus.3')
-rw-r--r-- | man/man3/Tspi_TPM_SetStatus.3 | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/man/man3/Tspi_TPM_SetStatus.3 b/man/man3/Tspi_TPM_SetStatus.3 new file mode 100644 index 0000000..22ca6b7 --- /dev/null +++ b/man/man3/Tspi_TPM_SetStatus.3 @@ -0,0 +1,90 @@ +.\" Copyright (C) 2004 International Business Machines Corporation +.\" Written by Megan Schneider based on the Trusted Computing Group Software Stack Specification Version 1.1 Golden +.\" +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "Tspi_TPM_SetStatus" 3 "2004-05-25" "TSS 1.1" +.ce 1 +TCG Software Stack Developer's Reference +.SH NAME +Tspi_TPM_SetStatus \- modify the TPM's status +.SH "SYNOPSIS" +.ad l +.hy 0 +.nf +.B #include <tss/platform.h> +.B #include <tss/tcpa_defines.h> +.B #include <tss/tcpa_typedef.h> +.B #include <tss/tcpa_struct.h> +.B #include <tss/tss_typedef.h> +.B #include <tss/tss_structs.h> +.B #include <tss/tspi.h> +.sp +.BI "TSS_RESULT Tspi_TPM_SetStatus(TSS_HTPM " hTPM ", TSS_FLAG " statusFlag "," +.BI " TSS_BOOL " fTpmState ");" +.fi +.sp +.ad +.hy + +.SH "DESCRIPTION" +.PP +\fBTspi_TPM_SetStatus\fR alters the status of the +TPM. Depending on the chosen \fIstatusFlag\fR, \fIfTpmState\fR may +or may not be ignored. This command requires that the TPM be on and +the handle to the TPM available. \fBThis command is not currently +implemented\fR. + +.SH "PARAMETERS" +.PP +.SS hTPM +The \fIhTPM\fR parameter is used to specify the handle of the TPM object. +.SS statusFlag +The \fIstatusFlag\fR parameter is what the TPM status should be set to. +.SS fTpmState +The \fIfTpmState\fR parameter is the status value to set. For some states, +this flag is ignored. + +.SH "RETURN CODES" +.PP +\fBTspi_TPM_SetStatus\fR returns TSS_SUCCESS on success, otherwise +one of the following values is returned: +.TP +.SM TSS_E_INVALID_HANDLE +\fIhTPM\fR is not a valid handle. + +.TP +.SM TSS_E_INTERNAL_ERROR +An internal SW error has been detected. + +.TP +.SM TSS_E_BAD_PARAMETER +One or more parameters is bad. + +.SH "CONFORMING TO" + +.PP +\fBTspi_TPM_SetStatus\fR conforms to the Trusted Computing Group +Software Specification version 1.1 Golden + +.SH "SEE ALSO" + +.PP +\fBTspi_TPM_GetStatus\fR(3), \fBTspi_TPM_GetCapability\fR(3). + |