TSS 2.0 System Level API (SAPI) Specification
Family "2.0" TCG PUBLISHED Page 5
Version 1.1, Revision 36 Copyright © TCG 2021 1 October 2021
Table of Contents
Table of Contents .......................................................................................................................................... 5
1 General Information on the TCG TSS 2.0 Specification Library ........................................................... 9
1.1 Scope of this Specification .............................................................................................................. 9
1.2 Acronyms ........................................................................................................................................ 9
1.3 TCG Software Stack 2.0 (TSS 2.0) Specification Library Structure ............................................... 9
1.4 References .................................................................................................................................... 10
2 TSS 2.0 SAPI Introduction .................................................................................................................. 11
2.1 Architecture ................................................................................................................................... 11
2.2 SAPI High Level Design Requirements: ....................................................................................... 11
2.2.1 Threading Model .................................................................................................................. 11
3 SAPI .................................................................................................................................................... 13
3.1 Overall functionality ...................................................................................................................... 13
3.2 Design requirements ..................................................................................................................... 13
3.3 Design rules .................................................................................................................................. 14
3.4 Architecture ................................................................................................................................... 15
3.5 SAPI data structures ..................................................................................................................... 17
3.6 Application Binary Interface (ABI) Negotiation ............................................................................. 17
3.7 Command Parameters .................................................................................................................. 18
3.7.1 System API Parameter Rules .............................................................................................. 18
3.8 SAPI Function APIs (by Category) ............................................................................................... 18
3.8.1 Command Context Allocation Functions .............................................................................. 19
3.8.2 Command Preparation Functions ........................................................................................ 21
3.8.3 Command Execution Functions ........................................................................................... 25
3.8.4 Command Completion .......................................................................................................... 29
4 SYS Header File .................................................................................................................................. 34
4.1 tss2_sys.h Prelude ....................................................................................................................... 34
4.2 tss2_sys.h sysContext Structure .................................................................................................. 34
4.3 tss2_sys.h Command and Response Session Structures ........................................................... 34
4.4 tss2_sys.h Command Context Management Functions ............................................................... 35
4.5 tss2_sys.h Command Preparation Functions ............................................................................... 35
4.6 tss2_sys.h Command Execution Functions .................................................................................. 36
4.7 tss2_sys.h Command Completion Functions ............................................................................... 36
4.8 tss2_sys.h Functions for Invoking TPM Commands .................................................................... 37
4.8.1 TPM Tss2_Sys_Startup Commands .................................................................................... 37
4.8.2 TPM Tss2_Sys_Shutdown Commands ............................................................................... 38
4.8.3 TPM Tss2_Sys_SelfTest Commands .................................................................................. 38
4.8.4 TPM Tss2_Sys_IncrementalSelfTest Commands ............................................................... 39
4.8.5 TPM Tss2_Sys_GetTestResult Commands ........................................................................ 39
4.8.6 TPM Tss2_Sys_StartAuthSession Commands.................................................................... 40
4.8.7 TPM Tss2_Sys_PolicyRestart Commands .......................................................................... 40
4.8.8 TPM Tss2_Sys_Create Commands ..................................................................................... 41
