Tspi_T...Result(3)

✨ Tspi_TPM_GetTestResult(3) ✨

okay bestie, so this one lives in the TCG Software Stack Developer's Reference β€” section 3 of the manual, iykyk β€” and it's literally called Tspi_TPM_GetTestResult. It's your lil backstage pass to the TPM's self-test tea. πŸ«–


πŸ’– NAME πŸ’–

Tspi_TPM_GetTestResult β€” get manufacturer specific information regarding the results of a self test.

Like, the TPM ran its little self check and now it's ready to spill. 🌸


πŸŽ€ 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_GetTestResult(TSS_HTPM hTPM, UINT32* pulTestResultLength, BYTE** prgbTestResult);

yes you need all seven of those includes, don't @ me, that's just how the TSS headers roll πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

Tspi_TPM_GetTestResult is provided by a manufacturer of a TPM to provide manufacturer specific self test results.

so basically: this function exists so the TPM's maker can hand you their own custom info about how the self test went. it's giving "brand-specific receipts" πŸ“œβœ¨ β€” not a generic universal format, but whatever the manufacturer decided to put in there.


🌈 PARAMETERS 🌈

hTPM

Handle of the TPM object πŸ‘‘

that's your TPM right there, bestie.

pulTestREsultLength

Receives the length (in bytes) of the prgbTestResult parameter πŸ“

(yes the name has that capital E in it, pulTestREsultLength, we do not make the rules, we just respect the header files 🫢)

prgbTestResult

Pointer to the memory block containing the TPM manufacturer specific information. 🧚

the actual goodies live behind this pointer, and pulTestREsultLength tells you how many bytes of goodies you're getting.


πŸ”₯ RETURN CODES πŸ”₯

Tspi_TPM_GetTestResult returns TSS_SUCCESS on success β€” slay πŸ’– β€” otherwise one of the following values are returned:

  • TSS_E_INVALID_HANDLE β€” hTPM is not a valid handle to the TPM object. not a real TPM handle, bestie, it's giving fake 😭
  • TSS_E_INTERNAL_ERROR β€” An error occurred internal to the TSS. πŸ’€ something inside the TSS broke, nothing to do with you, but also nothing you can fix from here.
⚠️ heads up: on success you get TSS_SUCCESS, but literally any of the above can come back instead, so check your return value, don't just assume the vibe is immaculate.

πŸ‘‘ CONFORMING TO πŸ‘‘

Tspi_TPM_GetTestResult conforms to the Trusted Computing Group Software Specification version 1.1 Golden ⭐

certified, standardized, iconic. periodt.


πŸ“ SEE ALSO πŸ“


and that's the whole page!! so good, so thorough, no notes πŸ’œ

kisses, this was TSS 1.1, dated 2004-05-26 β€” yeah she's vintage, she's a classic, and she still ate πŸŽ€βœ¨πŸ’