Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

Tspi_TPM_DirRead (3)

Name

Tspi_TPM_DirRead - Read a Data Integrity Register

Synopsis

#include <tss/platform.h>
#include <tss/tcpa_defines.h>
#include <tss/tcpa_typedef.h>
#include <tss/tcpa_struct.h>
#include <tss/tss_typedef.h>
#include <tss/tss_structs.h>
#include <tss/tspi.h>

TSS_RESULT Tspi_TPM_DirRead(TSS_HTPM hTPM,             UINT32 ulDirIndex,
UINT32*  pulDirDataLength, BYTE** prgbDirData);

Description

Tspi_TPM_DirRead(3)        Library Functions Manual        Tspi_TPM_DirRead(3)



                   TCG Software Stack Developer's Reference

NAME
       Tspi_TPM_DirRead - Read a Data Integrity Register

SYNOPSIS
       #include <tss/platform.h>
       #include <tss/tcpa_defines.h>
       #include <tss/tcpa_typedef.h>
       #include <tss/tcpa_struct.h>
       #include <tss/tss_typedef.h>
       #include <tss/tss_structs.h>
       #include <tss/tspi.h>

       TSS_RESULT Tspi_TPM_DirRead(TSS_HTPM hTPM,             UINT32 ulDirIndex,
                                   UINT32*  pulDirDataLength, BYTE** prgbDirData);



DESCRIPTION
       Tspi_TPM_DirRead reads a data integrity register. DIRs are non-volatile
       (persistent across reboots) memory areas maintained by the TPM.


PARAMETERS
   hTPM
       The hTPM parameter is used to specify the handle of the TPM object.

   ulDirIndex
       The ulDirIndex parameter is the index of the DIR to read. To query  the
       TPM  for the number of DIR registers it supports, use Tspi_TPM_GetCapa-
       bility(3).

   pulDirDataLength
       The pulDirDataLength parameter receives the  length  in  bytes  of  the
       prgbDirData parameter.

   prgbDirData
       The  prgbDirData  parameter receives a pointer to memory containing the
       DIR data.


RETURN CODES
       Tspi_TPM_DirRead returns TSS_SUCCESS on success, otherwise one  of  the
       following values is returned:

       TSS_E_INVALID_HANDLE
              hTPM is not a valid handle.


       TSS_E_INTERNAL_ERROR
              An internal SW error has been detected.


       TSS_E_BAD_PARAMETER
              One or more parameters is bad.


CONFORMING TO
       Tspi_TPM_DirRead conforms to the Trusted Computing Group Software Spec-
       ification version 1.1 Golden



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+---------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE       |
       +---------------+---------------------------+
       |Availability   | library/security/trousers |
       +---------------+---------------------------+
       |Stability      | Uncommitted               |
       +---------------+---------------------------+
SEE ALSO
       Tspi_TPM_GetCapability(3), Tspi_TPM_DirWrite(3).




NOTES
       This software was built from source available at https://github.com/or-
       acle/solaris-userland.   The  original  community source was downloaded
       from                                                    https://source-
       forge.net/projects/trousers/files/trousers/0.3.13/trousers-0.3.13.tar.gz

       Further information about this software can be found on the open source
       community website at http://trousers.sourceforge.net/.



TSS 1.1                           2004-05-25               Tspi_TPM_DirRead(3)