t-base API Documentation

1 Introduction
2 API Version History
3 tlApi
	3.1 Header File
	3.2 Generic Constants
		3.2.1 Error Codes
		3.2.2 Macros
		3.2.3 Other Constants
	3.3 Generic Types
		3.3.1 Enumerations and types
			3.3.1.1 mcSoContext_t
			3.3.1.2 mcSoLifeTime_t
			3.3.1.3 mcSoType_t
			3.3.1.4 mcSpid_t
		3.3.2 mcUuid_t - Universally Unique Identifier.
		3.3.3 mcSoHeader_t
		3.3.4 mcSuid_t
		3.3.5 suidData_t
		3.3.6 tlApiRsaKey_t
		3.3.7 tlApiDsaKey_t
		3.3.8 tlApiEcdsaKey_t
		3.3.9 tlApiKey_t
		3.3.10 tlApiSymKey_t
		3.3.11  tlApiKeyPair_t
		3.3.12 tlApiLongInt_t
		3.3.13 tlApiPlatformInfo_t
		3.3.14 tlApiSpTrustletId_t
		3.3.15 tlApiSymKey_t
	3.4 Inter-world communication
		3.4.1 tlApiNotify()
		3.4.2 tlApiWaitNotification
	3.5 Cryptography
		3.5.1 Constants
		3.5.2 Types
			3.5.2.1 tlApiCrSession_t
		3.5.3 Enumerations
			3.5.3.1 tlApiCipherAlg_t
			3.5.3.2 tlApiCipherMode_t
			3.5.3.3 tlApiKeyPairType_t
			3.5.3.4 tlApiMdAlg_t
			3.5.3.5 tlApiRngAlg_t
			3.5.3.6 tlApiSigAlg_t
			3.5.3.7 tlApiSigMode_t
		3.5.4 Functions
			3.5.4.1 tlApiCipherDoFinal
			3.5.4.2 tlApiCipherInit
			3.5.4.3 tlApiCipherInitWithData
			3.5.4.4 tlApiCipherUpdate
			3.5.4.5 tlApiCrAbort
			3.5.4.6 tlApiGenerateKeyPair
			3.5.4.7 tlApiMessageDigestDoFinal
			3.5.4.8 tlApiMessageDigestInit
			3.5.4.9 tlApiMessageDigestInitWithData
			3.5.4.10 tlApiMessageDigestUpdate
			3.5.4.11 tlApiRandomGenerateData
			3.5.4.12 tlApiSignatureInit
			3.5.4.13 tlApiSignatureInitWithData
			3.5.4.14 tlApiSignatureSign
			3.5.4.15 tlApiSignatureUpdate
			3.5.4.16 tlApiSignatureVerify
			3.5.4.17 tlApiDeriveKey
			3.5.4.18 tlApiEndorse
	3.6 Secure Objects
		3.6.1 Types
			3.6.1.1 tsSource_t
		3.6.2 Functions
			3.6.2.1 tlApiUnwrapObjectExt
			3.6.2.2 tlApiWrapObjectExt
	3.7 System Functions
		3.7.1 Functions
			3.7.1.1 tlApiExit
			3.7.1.2 tlApiGetPlatformInformation
			3.7.1.3 tlApiGetMobicoreVersion
			3.7.1.4 tlApiGetSuid
			3.7.1.5 tlApiGetVirtMemType
			3.7.1.6 tlApiIsNwdBufferValid
			3.7.1.7 tlApiGetVersion
			3.7.1.8 tlApiLogvPrintf
	3.8 Trusted User Interface
		3.8.1 Header File
		3.8.2 Error Codes
		3.8.3 Types
			3.8.3.1 tlApiTuiScreenInfo_t
			3.8.3.2 tlApiTuiTouchEventType_t
			3.8.3.3 tlApiTuiImage_t
			3.8.3.4 tlApiTuiCoordinates_t
			3.8.3.5 tlApiTuiTouchEvent_t
		3.8.4 Functions
			3.8.4.1 tlApiTuiGetScreenInfo
			3.8.4.2 tlApiTuiOpenSession
			3.8.4.3 tlApiTuiCloseSession
			3.8.4.4 tlApiTuiSetImage
			3.8.4.5 tlApiTuiGetTouchEvent
	3.9 DRM API
		3.9.1 Structures
			3.9.1.1 tlApiDrmOffsetSizePair
			3.9.1.2 tlApiDrmAlg
			3.9.1.3 tlApiDrmLink
			3.9.1.4 tlApiDrmInputSegmentDescriptor
			3.9.1.5 tlApiDrmDecryptContext
		3.9.2 Constants
		3.9.3 Errors
		3.9.4 Functions
			3.9.4.1 tlApiDrmOpenSession
			3.9.4.2 tlApiDrmProcessContent
			3.9.4.3 tlApiDrmCloseSession
			3.9.4.4 tlApiDrmCheckLink
	3.10 Memory Management
		3.10.1 Header File
		3.10.2 Heap reservation
		3.10.3 Functions
			3.10.3.1 tlApiMalloc
			3.10.3.2 tlApiRealloc
			3.10.3.3 tlApiFree
4 mcClient API
	4.1 Header File
	4.2 Data Structures
		4.2.1 mcBulkMap_t Structure Reference
		4.2.2 mcSessionHandle_t Structure Reference
	4.1 Error Codes
	4.2 Functions
		4.2.1 mcOpenDevice
		4.2.2 mcCloseDevice
		4.2.3 mcOpenTrustlet
		4.2.4 mcOpenSession – DEPRECATED
		4.2.5 mcCloseSession
		4.2.6 mcNotify
		4.2.7 mcWaitNotification
		4.2.8 mcMallocWsm – DEPRECATED
		4.2.9 mcFreeWsm – DEPRECATED
		4.2.10 mcMap
		4.2.11 mcUnmap
		4.2.12 mcGetSessionErrorCode
		4.2.13 mcGetMobiCoreVersion
5 GlobalPlatform TEE Client API
	5.1 Header File
	5.2 Implementation Notes
		5.2.1 TEEC_InitializeContext
		5.2.2 TEEC_FinalizeContext
		5.2.3 TEEC_RegisterSharedMemory
		5.2.4 TEEC_AllocateSharedMemory
		5.2.5 TEEC_ReleaseSharedMemory
		5.2.6 TEEC_OpenSession
		5.2.7 TEEC_CloseSession
		5.2.8 TEEC_InvokeCommand
		5.2.9 TEEC_RequestCancellation
6 GlobalPlatform TEE Internal API
	6.1 Header File
	6.2 Implementation Notes
		6.2.1 Properties
		6.2.2 Memory Management
			6.2.2.1 TEE_Malloc
			6.2.2.2 TEE_MemMove
			6.2.2.3 TEE_MemCompare
			6.2.2.4 TEE_MemFill
		6.2.3 Transient Objects
			6.2.3.1 TEE_AllocateTransientObject
		6.2.4 Persistent Objects
			6.2.4.1  TEE_OpenPersistentObject
			6.2.4.2 TEE_CreatePersistentObject
			6.2.4.3 TEE_CloseAndDeletePersistentObject
		6.2.5 Data Stream Access
			6.2.5.1 TEE_ReadObjectData, TEE_WriteObjectData, TEE_TruncateObjectData
		6.2.6 Generic Operation Functions
			6.2.6.1 TEE_AllocateOperation
	6.3 Extended API
		6.3.1 Logging
			6.3.1.1 TEE_LogPrintf
			6.3.1.2 TEE_LogvPrintf
			6.3.1.3 TEE_DbgPrintf
			6.3.1.4 TEE_DbgvPrintf
		6.3.2 TEE_TBase_UnwrapObject
		6.3.3 TEE_TBase_DeriveKey
		6.3.4 Trusted User Interface API
		6.3.5 DRM API