Tspi_TPM_GetStatus(3)

💖 Tspi_TPM_GetStatus(3) 💖

okay bestie, gather round, we're reading the Library Functions Manual of the TCG Software Stack Developer's Reference and honestly? it's giving iconic. sit down, hydrate, let's go 🫶

✨ NAME ✨

Tspi_TPM_GetStatus — the girl whose entire job is querying the TPM's status 💅

🌸 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_GetStatus(TSS_HTPM hTPM, TSS_FLAG statusFlag, BOOL* pfTpmState);

like yes, that's a lot of includes, she's high maintenance but worth it 💖

🦋 DESCRIPTION 🦋

Tspi_TPM_GetStatus queries the status of the TPM, and returns a specific status based on whatever flags you specified. main character behaviour fr fr ✨

🚨 bestie, important: this command is not currently implemented. like, she's on the guest list but she is NOT showing up to the party. 😭 do not build your whole vibe around her.

🎀 PARAMETERS 🎀

• hTPM — the handle of the TPM object. that's her ID, that's her passport, that's how we know which TPM we're talking about 🫶
• statusFlag — the status you wanna retrieve. pick your flag, pick your destiny 🌈
• fTpmState — lowkey the docs list this heading as fTpmState, but the parameter itself is pfTpmState, and it's a pointer to the value of the status queried. so she points at the answer. no cap 👑

🔥 RETURN CODES 🔥

Tspi_TPM_GetStatus returns TSS_SUCCESS on success. otherwise, one of these lil gremlins comes back at you:

• TSS_E_INVALID_HANDLE — hTPM is not a valid handle. she doesn't know her. blocked 💀
• TSS_E_INTERNAL_ERROR — an internal SW error has been detected. something inside went wrong, not your fault babe 🙈
• TSS_E_BAD_PARAMETER — one or more parameters is bad. reread your args bestie 😭

👑 CONFORMING TO 👑

Tspi_TPM_GetStatus conforms to the Trusted Computing Group Software Specification version 1.1 Golden. yes, Golden. as it should be ✨

💜 SEE ALSO 💜

• Tspi_TPM_SetStatus(3)
• Tspi_TPM_GetCapability(3)

and that's the whole page bestie, no crumbs left 🍓

this lil masterpiece comes to you from TSS 1.1, dated 2004-05-25 — vintage, iconic, ate and left no crumbs. mwah 💅🎀