Tspi_TPM_DirRead(3)

💖 Tspi_TPM_DirRead 💖

okay bestie, welcome to the manual page for Tspi_TPM_DirRead(3) — straight out of the TCG Software Stack Developer's Reference ✨ this is your girl's guide to reading a Data Integrity Register, and yes, it's as iconic as it sounds 🎀

🌸 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);

like, look at that signature. it's giving function. 😌

🦋 DESCRIPTION 🦋

So Tspi_TPM_DirRead reads a data integrity register, periodt. And what even is a DIR, you ask? DIRs are non-volatile memory areas — meaning they persist across reboots, no cap, they stay put 🫶 — and they're maintained by the TPM itself. little memory vaults. obsessed.

🎀 PARAMETERS 🎀

hTPM

The hTPM parameter is how you specify the handle of the TPM object. that's your TPM's little name tag 💖

ulDirIndex

The ulDirIndex parameter is the index of the DIR you wanna read. and if you're sitting there like "bestie how many DIR registers does this TPM even have??" — you query the TPM for the number of DIR registers it supports using Tspi_TPM_GetCapability(3). iykyk. 🔥

pulDirDataLength

The pulDirDataLength parameter receives the length in bytes of the prgbDirData parameter. it's the size tag, she's reporting back 📏

prgbDirData

The prgbDirData parameter receives a pointer to memory containing the DIR data. boom, that's the goods 💅

💀 RETURN CODES 💀

Tspi_TPM_DirRead returns TSS_SUCCESS on success, and otherwise one of these values comes back at you:

• TSS_E_INVALID_HANDLE — hTPM is not a valid handle. bestie that's not a real handle 😭
• TSS_E_INTERNAL_ERROR — an internal SW error has been detected. not her fault, something internal is going through it 💀
• TSS_E_BAD_PARAMETER — one or more parameters is bad. check your args babe 🙈

👑 CONFORMING TO 👑

Tspi_TPM_DirRead conforms to the Trusted Computing Group Software Specification version 1.1 Golden. standards! she has them! ⭐

🌈 SEE ALSO 🌈

• Tspi_TPM_GetCapability(3)
• Tspi_TPM_DirWrite(3)

read one, write one — balance 🧚

fr fr that's the whole page — TSS 1.1, dated 2004-05-25, and that footer lives down at the bottom like the little signature it is. mwah, go read some registers bestie 💜✨