From c3649a2def02c41d837ae1f79dda729ccb91e677 Mon Sep 17 00:00:00 2001 From: Igor Pashev Date: Sun, 25 Nov 2012 14:36:20 +0000 Subject: Imported Upstream version 0.3.9 --- man/man3/Tspi_TPM_PcrExtend.3 | 101 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 man/man3/Tspi_TPM_PcrExtend.3 (limited to 'man/man3/Tspi_TPM_PcrExtend.3') diff --git a/man/man3/Tspi_TPM_PcrExtend.3 b/man/man3/Tspi_TPM_PcrExtend.3 new file mode 100644 index 0000000..cd01713 --- /dev/null +++ b/man/man3/Tspi_TPM_PcrExtend.3 @@ -0,0 +1,101 @@ +.\" 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_PcrExtend" 3 "2004-05-25" "TSS 1.1" +.ce 1 +TCG Software Stack Developer's Reference +.SH NAME +Tspi_TPM_PcrExtend \- extend a PCR register and optionally write the PCR event log. +.SH "SYNOPSIS" +.ad l +.hy 0 +.nf +.B #include +.B #include +.B #include +.B #include +.B #include +.B #include +.B #include +.sp +.BI "TSS_RESULT Tspi_TPM_PcrExtend(TSS_HTPM " hTPM ", UINT32 " ulPcrIndex "," +.BI " UINT32 " ulPcrDataLength ", BYTE* " pbPcrData "," +.BI " TSS_PCR_EVENT* " pPcrEvent "," +.BI " UINT32* " pulPcrValueLength ", BYTE** " prgbPcrValue ");" +.fi +.sp +.ad +.hy + +.SH "DESCRIPTION" +.PP +\fBTspi_TPM_PcrExtend\fR extends a PCR register and writes the PCR event log if +one is supplied by the user. + +.SH "PARAMETERS" +.PP +.SS hTPM +The \fIhTPM\fR parameter is used to specify the handle of the TPM +object. The command to get the TPM to test itself will be sent here. +.SS ulPcrIndex +The \fIulPcrIndex\fR parameter is the index of the PCR to extend. +.SS ulPcrDataLength +The \fIulPcrDataLength\fR parameter is the length in bytes of the \fIpbPcrData\fR parameter. +.SS pbPcrData +The \fIpbPcrData\fR parameter is a pointer to data to be hashed by the TSS, which will +be used in the extend operation. +.SS pPcrEvent +The \fIpPcrEvent\fR parameter is the TSS_PCR_EVENT structure to be passed to the TCS +to record the extend event. If \fIpPcrEvent\fR is not NULL, the application should +fill out the members of the structure that it cares about. +.SS pulPcrValueLength +The \fIpulPcrValueLength\fR parameter receives the length in bytes of the \fIprgbPcrValue\fR parameter. +.SS prgbPcrValue +The \fIprgbPcrValue\fR receives a pointer to the memory block containing the PCR data after the +extend operation. + +.SH "RETURN CODES" +.PP +\fBTspi_TPM_PcrExtend\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_PcrExtend\fR conforms to the Trusted Computing Group Software +Specification version 1.1 Golden + +.SH "SEE ALSO" + +.PP +\fBTspi_TPM_PcrRead\fR(3). + -- cgit v1.2.3