crypto/external/cpl/trousers/dist/man/man3/Tspi_TPM_DirWrite.3
author christos <christos@NetBSD.org>
Sat, 28 Jan 2012 01:35:04 +0000
branchtrunk
changeset 208533 fb64bd2b788b
permissions -rw-r--r--
import trousers 0.3.8 from sourceforge. TrouSerS is the open-source TCG Software Stack

.\" 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_DirWrite" 3 "2004-05-25" "TSS 1.1"
.ce 1
TCG Software Stack Developer's Reference
.SH NAME
Tspi_TPM_DirWrite \- write to a Data Integrity Register
.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_DirWrite(TSS_HTPM " hTPM ",            UINT32 " ulDirIndex ","
.BI "                             UINT32   " ulDirDataLength ", BYTE*  " rgbDirData ");"
.fi
.sp
.ad
.hy

.SH "DESCRIPTION"
.PP
\fBTspi_TPM_DirWrite\fR writes a data integrity
register. You need to know the DIR index and data you wish to write
to the DIR prior to using this command.

.SH "PARAMETERS"
.PP
.SS hTPM
The \fIhTPM\fR parameter is used to specify the handle of the TPM
object.
.SS ulDirIndex
The \fIulDirIndex\fR parameter is the index of the DIR to write. To query the TPM for the
number of DIR registers it supports, use \fBTspi_TPM_GetCapability\fR(3).
.SS ulDirDataLength
The \fIulDirDataLength\fR parameter is the length in bytes of the \fIrgbDirData\fR parameter.
.SS rgbDirData
The \fIrgbDirData\fR parameter is a pointer to memory containing the
data to be written to the DIR.

.SH "RETURN CODES"
.PP
\fBTspi_TPM_DirWrite\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_DirWrite\fR conforms to the Trusted Computing Group Software
Specification version 1.1 Golden

.SH "SEE ALSO"
.PP
\fBTspi_TPM_GetCapability\fR(3), \fBTspi_TPM_DirRead\fR(3).