ESAPI: Coding style and documentation

Signed-off-by: Andreas Fuchs <andreas.fuchs@sit.fraunhofer.de>

1 files changed, 0 insertions, 114 deletions

diff --git a/src/tss2-esys/esys_int.h b/src/tss2-esys/esys_int.h
index 650d41ea..94ff48e5 100644
--- a/src/tss2-esys/esys_int.h
+++ b/src/tss2-esys/esys_int.h
@@ -47,26 +47,19 @@ typedef struct RSRC_NODE_T {
     struct RSRC_NODE_T * next;  /**< The next object in the linked list. */
 } RSRC_NODE_T;
 
-/*
- * Declares of structs for storing ESAPI input parameters
- */
-
 
 typedef struct {
     TPM2_SU startupType;
 } Startup_IN;
 
-
 typedef struct {
     TPM2_SU shutdownType;
 } Shutdown_IN;
 
-
 typedef struct {
     TPMI_YES_NO fullTest;
 } SelfTest_IN;
 
-
 typedef struct {
     TPML_ALG *toTest;
     TPML_ALG toTestData;
@@ -74,7 +67,6 @@ typedef struct {
 
 typedef TPMS_EMPTY  GetTestResult_IN;
 
-
 typedef struct {
     ESYS_TR tpmKey;
     ESYS_TR bind;
@@ -88,12 +80,10 @@ typedef struct {
     TPMT_SYM_DEF symmetricData;
 } StartAuthSession_IN;
 
-
 typedef struct {
     ESYS_TR sessionHandle;
 } PolicyRestart_IN;
 
-
 typedef struct {
     ESYS_TR parentHandle;
     TPM2B_SENSITIVE_CREATE *inSensitive;
@@ -106,7 +96,6 @@ typedef struct {
     TPML_PCR_SELECTION creationPCRData;
 } Create_IN;
 
-
 typedef struct {
     ESYS_TR parentHandle;
     TPM2B_PRIVATE *inPrivate;
@@ -115,7 +104,6 @@ typedef struct {
     TPM2B_PUBLIC inPublicData;
 } Load_IN;
 
-
 typedef struct {
     TPMI_RH_HIERARCHY hierarchy;
     TPM2B_SENSITIVE *inPrivate;
@@ -124,12 +112,10 @@ typedef struct {
     TPM2B_PUBLIC inPublicData;
 } LoadExternal_IN;
 
-
 typedef struct {
     ESYS_TR objectHandle;
 } ReadPublic_IN;
 
-
 typedef struct {
     ESYS_TR activateHandle;
     ESYS_TR keyHandle;
@@ -139,7 +125,6 @@ typedef struct {
     TPM2B_ENCRYPTED_SECRET secretData;
 } ActivateCredential_IN;
 
-
 typedef struct {
     ESYS_TR handle;
     TPM2B_DIGEST *credential;
@@ -148,12 +133,10 @@ typedef struct {
     TPM2B_NAME objectNameData;
 } MakeCredential_IN;
 
-
 typedef struct {
     ESYS_TR itemHandle;
 } Unseal_IN;
 
-
 typedef struct {
     ESYS_TR objectHandle;
     ESYS_TR parentHandle;
@@ -161,7 +144,6 @@ typedef struct {
     TPM2B_AUTH newAuthData;
 } ObjectChangeAuth_IN;
 
-
 typedef struct {
     ESYS_TR parentHandle;
     TPM2B_SENSITIVE_CREATE *inSensitive;
@@ -170,7 +152,6 @@ typedef struct {
     TPM2B_TEMPLATE inPublicData;
 } CreateLoaded_IN;
 
-
 typedef struct {
     ESYS_TR objectHandle;
     ESYS_TR newParentHandle;
@@ -180,7 +161,6 @@ typedef struct {
     TPMT_SYM_DEF_OBJECT symmetricAlgData;
 } Duplicate_IN;
 
-
 typedef struct {
     ESYS_TR oldParent;
     ESYS_TR newParent;
@@ -192,7 +172,6 @@ typedef struct {
     TPM2B_ENCRYPTED_SECRET inSymSeedData;
 } Rewrap_IN;
 
-
 typedef struct {
     ESYS_TR parentHandle;
     TPM2B_DATA *encryptionKey;
@@ -207,7 +186,6 @@ typedef struct {
     TPMT_SYM_DEF_OBJECT symmetricAlgData;
 } Import_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
     TPM2B_PUBLIC_KEY_RSA *message;
@@ -218,7 +196,6 @@ typedef struct {
     TPM2B_DATA labelData;
 } RSA_Encrypt_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
     TPM2B_PUBLIC_KEY_RSA *cipherText;
@@ -229,24 +206,20 @@ typedef struct {
     TPM2B_DATA labelData;
 } RSA_Decrypt_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
 } ECDH_KeyGen_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
     TPM2B_ECC_POINT *inPoint;
     TPM2B_ECC_POINT inPointData;
 } ECDH_ZGen_IN;
 
-
 typedef struct {
     TPMI_ECC_CURVE curveID;
 } ECC_Parameters_IN;
 
-
 typedef struct {
     ESYS_TR keyA;
     TPMI_ECC_KEY_EXCHANGE inScheme;
@@ -257,7 +230,6 @@ typedef struct {
     TPM2B_ECC_POINT inQeBData;
 } ZGen_2Phase_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
     TPMI_YES_NO decrypt;
@@ -268,7 +240,6 @@ typedef struct {
     TPM2B_MAX_BUFFER inDataData;
 } EncryptDecrypt_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
     TPMI_YES_NO decrypt;
@@ -279,7 +250,6 @@ typedef struct {
     TPM2B_IV ivInData;
 } EncryptDecrypt2_IN;
 
-
 typedef struct {
     TPMI_ALG_HASH hashAlg;
     TPMI_RH_HIERARCHY hierarchy;
@@ -287,7 +257,6 @@ typedef struct {
     TPM2B_MAX_BUFFER dataData;
 } Hash_IN;
 
-
 typedef struct {
     ESYS_TR handle;
     TPMI_ALG_HASH hashAlg;
@@ -295,18 +264,15 @@ typedef struct {
     TPM2B_MAX_BUFFER bufferData;
 } HMAC_IN;
 
-
 typedef struct {
     UINT16 bytesRequested;
 } GetRandom_IN;
 
-
 typedef struct {
     TPM2B_SENSITIVE_DATA *inData;
     TPM2B_SENSITIVE_DATA inDataData;
 } StirRandom_IN;
 
-
 typedef struct {
     ESYS_TR handle;
     TPMI_ALG_HASH hashAlg;
@@ -314,21 +280,18 @@ typedef struct {
     TPM2B_AUTH authData;
 } HMAC_Start_IN;
 
-
 typedef struct {
     TPMI_ALG_HASH hashAlg;
     TPM2B_AUTH *auth;
     TPM2B_AUTH authData;
 } HashSequenceStart_IN;
 
-
 typedef struct {
     ESYS_TR sequenceHandle;
     TPM2B_MAX_BUFFER *buffer;
     TPM2B_MAX_BUFFER bufferData;
 } SequenceUpdate_IN;
 
-
 typedef struct {
     ESYS_TR sequenceHandle;
     TPMI_RH_HIERARCHY hierarchy;
@@ -336,7 +299,6 @@ typedef struct {
     TPM2B_MAX_BUFFER bufferData;
 } SequenceComplete_IN;
 
-
 typedef struct {
     ESYS_TR pcrHandle;
     ESYS_TR sequenceHandle;
@@ -344,7 +306,6 @@ typedef struct {
     TPM2B_MAX_BUFFER bufferData;
 } EventSequenceComplete_IN;
 
-
 typedef struct {
     ESYS_TR objectHandle;
     ESYS_TR signHandle;
@@ -354,7 +315,6 @@ typedef struct {
     TPMT_SIG_SCHEME inSchemeData;
 } Certify_IN;
 
-
 typedef struct {
     ESYS_TR signHandle;
     ESYS_TR objectHandle;
@@ -368,7 +328,6 @@ typedef struct {
     TPMT_TK_CREATION creationTicketData;
 } CertifyCreation_IN;
 
-
 typedef struct {
     ESYS_TR signHandle;
     TPM2B_DATA *qualifyingData;
@@ -379,7 +338,6 @@ typedef struct {
     TPML_PCR_SELECTION PCRselectData;
 } Quote_IN;
 
-
 typedef struct {
     ESYS_TR privacyAdminHandle;
     ESYS_TR signHandle;
@@ -390,7 +348,6 @@ typedef struct {
     TPMT_SIG_SCHEME inSchemeData;
 } GetSessionAuditDigest_IN;
 
-
 typedef struct {
     ESYS_TR privacyHandle;
     ESYS_TR signHandle;
@@ -400,7 +357,6 @@ typedef struct {
     TPMT_SIG_SCHEME inSchemeData;
 } GetCommandAuditDigest_IN;
 
-
 typedef struct {
     ESYS_TR privacyAdminHandle;
     ESYS_TR signHandle;
@@ -410,7 +366,6 @@ typedef struct {
     TPMT_SIG_SCHEME inSchemeData;
 } GetTime_IN;
 
-
 typedef struct {
     ESYS_TR signHandle;
     TPM2B_ECC_POINT *P1;
@@ -421,12 +376,10 @@ typedef struct {
     TPM2B_ECC_PARAMETER y2Data;
 } Commit_IN;
 
-
 typedef struct {
     TPMI_ECC_CURVE curveID;
 } EC_Ephemeral_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
     TPM2B_DIGEST *digest;
@@ -435,7 +388,6 @@ typedef struct {
     TPMT_SIGNATURE signatureData;
 } VerifySignature_IN;
 
-
 typedef struct {
     ESYS_TR keyHandle;
     TPM2B_DIGEST *digest;
@@ -446,7 +398,6 @@ typedef struct {
     TPMT_TK_HASHCHECK validationData;
 } Sign_IN;
 
-
 typedef struct {
     ESYS_TR auth;
     TPMI_ALG_HASH auditAlg;
@@ -456,34 +407,29 @@ typedef struct {
     TPML_CC clearListData;
 } SetCommandCodeAuditStatus_IN;
 
-
 typedef struct {
     ESYS_TR pcrHandle;
     TPML_DIGEST_VALUES *digests;
     TPML_DIGEST_VALUES digestsData;
 } PCR_Extend_IN;
 
-
 typedef struct {
     ESYS_TR pcrHandle;
     TPM2B_EVENT *eventData;
     TPM2B_EVENT eventDataData;
 } PCR_Event_IN;
 
-
 typedef struct {
     TPML_PCR_SELECTION *pcrSelectionIn;
     TPML_PCR_SELECTION pcrSelectionInData;
 } PCR_Read_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     TPML_PCR_SELECTION *pcrAllocation;
     TPML_PCR_SELECTION pcrAllocationData;
 } PCR_Allocate_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     TPMI_ALG_HASH hashAlg;
@@ -492,19 +438,16 @@ typedef struct {
     TPM2B_DIGEST authPolicyData;
 } PCR_SetAuthPolicy_IN;
 
-
 typedef struct {
     ESYS_TR pcrHandle;
     TPM2B_DIGEST *auth;
     TPM2B_DIGEST authData;
 } PCR_SetAuthValue_IN;
 
-
 typedef struct {
     ESYS_TR pcrHandle;
 } PCR_Reset_IN;
 
-
 typedef struct {
     ESYS_TR authObject;
     ESYS_TR policySession;
@@ -519,7 +462,6 @@ typedef struct {
     TPMT_SIGNATURE authData;
 } PolicySigned_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR policySession;
@@ -532,7 +474,6 @@ typedef struct {
     TPM2B_NONCE policyRefData;
 } PolicySecret_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPM2B_TIMEOUT *timeout;
@@ -547,14 +488,12 @@ typedef struct {
     TPMT_TK_AUTH ticketData;
 } PolicyTicket_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPML_DIGEST *pHashList;
     TPML_DIGEST pHashListData;
 } PolicyOR_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPM2B_DIGEST *pcrDigest;
@@ -563,13 +502,11 @@ typedef struct {
     TPML_PCR_SELECTION pcrsData;
 } PolicyPCR_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPMA_LOCALITY locality;
 } PolicyLocality_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
@@ -580,7 +517,6 @@ typedef struct {
     TPM2B_OPERAND operandBData;
 } PolicyNV_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     UINT16 offset;
@@ -589,32 +525,27 @@ typedef struct {
     TPM2B_OPERAND operandBData;
 } PolicyCounterTimer_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPM2_CC code;
 } PolicyCommandCode_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
 } PolicyPhysicalPresence_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPM2B_DIGEST *cpHashA;
     TPM2B_DIGEST cpHashAData;
 } PolicyCpHash_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPM2B_DIGEST *nameHash;
     TPM2B_DIGEST nameHashData;
 } PolicyNameHash_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPMI_YES_NO includeObject;
@@ -624,7 +555,6 @@ typedef struct {
     TPM2B_NAME newParentNameData;
 } PolicyDuplicationSelect_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPM2B_DIGEST *approvedPolicy;
@@ -637,42 +567,35 @@ typedef struct {
     TPMT_TK_VERIFIED checkTicketData;
 } PolicyAuthorize_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
 } PolicyAuthValue_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
 } PolicyPassword_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
 } PolicyGetDigest_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPMI_YES_NO writtenSet;
 } PolicyNvWritten_IN;
 
-
 typedef struct {
     ESYS_TR policySession;
     TPM2B_DIGEST *templateHash;
     TPM2B_DIGEST templateHashData;
 } PolicyTemplate_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
     ESYS_TR policySession;
 } PolicyAuthorizeNV_IN;
 
-
 typedef struct {
     ESYS_TR primaryHandle;
     TPM2B_SENSITIVE_CREATE *inSensitive;
@@ -685,14 +608,12 @@ typedef struct {
     TPML_PCR_SELECTION creationPCRData;
 } CreatePrimary_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     TPMI_RH_ENABLES enable;
     TPMI_YES_NO state;
 } HierarchyControl_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     TPMI_ALG_HASH hashAlg;
@@ -700,40 +621,33 @@ typedef struct {
     TPM2B_DIGEST authPolicyData;
 } SetPrimaryPolicy_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
 } ChangePPS_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
 } ChangeEPS_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
 } Clear_IN;
 
-
 typedef struct {
     ESYS_TR auth;
     TPMI_YES_NO disable;
 } ClearControl_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     TPM2B_AUTH *newAuth;
     TPM2B_AUTH newAuthData;
 } HierarchyChangeAuth_IN;
 
-
 typedef struct {
     ESYS_TR lockHandle;
 } DictionaryAttackLockReset_IN;
 
-
 typedef struct {
     ESYS_TR lockHandle;
     UINT32 newMaxTries;
@@ -741,7 +655,6 @@ typedef struct {
     UINT32 lockoutRecovery;
 } DictionaryAttackParameters_IN;
 
-
 typedef struct {
     ESYS_TR auth;
     TPML_CC *setList;
@@ -750,13 +663,11 @@ typedef struct {
     TPML_CC clearListData;
 } PP_Commands_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     UINT32 algorithmSet;
 } SetAlgorithmSet_IN;
 
-
 typedef struct {
     ESYS_TR authorization;
     ESYS_TR keyHandle;
@@ -766,34 +677,28 @@ typedef struct {
     TPMT_SIGNATURE manifestSignatureData;
 } FieldUpgradeStart_IN;
 
-
 typedef struct {
     TPM2B_MAX_BUFFER *fuData;
     TPM2B_MAX_BUFFER fuDataData;
 } FieldUpgradeData_IN;
 
-
 typedef struct {
     UINT32 sequenceNumber;
 } FirmwareRead_IN;
 
-
 typedef struct {
     ESYS_TR saveHandle;
 } ContextSave_IN;
 
-
 typedef struct {
     TPMS_CONTEXT *context;
     TPMS_CONTEXT contextData;
 } ContextLoad_IN;
 
-
 typedef struct {
     ESYS_TR flushHandle;
 } FlushContext_IN;
 
-
 typedef struct {
     ESYS_TR auth;
     ESYS_TR objectHandle;
@@ -802,32 +707,27 @@ typedef struct {
 
 typedef TPMS_EMPTY  ReadClock_IN;
 
-
 typedef struct {
     ESYS_TR auth;
     UINT64 newTime;
 } ClockSet_IN;
 
-
 typedef struct {
     ESYS_TR auth;
     TPM2_CLOCK_ADJUST rateAdjust;
 } ClockRateAdjust_IN;
 
-
 typedef struct {
     TPM2_CAP capability;
     UINT32 property;
     UINT32 propertyCount;
 } GetCapability_IN;
 
-
 typedef struct {
     TPMT_PUBLIC_PARMS *parameters;
     TPMT_PUBLIC_PARMS parametersData;
 } TestParms_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     TPM2B_AUTH *auth;
@@ -836,24 +736,20 @@ typedef struct {
     TPM2B_NV_PUBLIC publicInfoData;
 } NV_DefineSpace_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
 } NV_UndefineSpace_IN;
 
-
 typedef struct {
     ESYS_TR nvIndex;
     ESYS_TR platform;
 } NV_UndefineSpaceSpecial_IN;
 
-
 typedef struct {
     ESYS_TR nvIndex;
 } NV_ReadPublic_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
@@ -862,13 +758,11 @@ typedef struct {
     TPM2B_MAX_NV_BUFFER dataData;
 } NV_Write_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
 } NV_Increment_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
@@ -876,25 +770,21 @@ typedef struct {
     TPM2B_MAX_NV_BUFFER dataData;
 } NV_Extend_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
     UINT64 bits;
 } NV_SetBits_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
 } NV_WriteLock_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
 } NV_GlobalWriteLock_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
@@ -902,20 +792,17 @@ typedef struct {
     UINT16 offset;
 } NV_Read_IN;
 
-
 typedef struct {
     ESYS_TR authHandle;
     ESYS_TR nvIndex;
 } NV_ReadLock_IN;
 
-
 typedef struct {
     ESYS_TR nvIndex;
     TPM2B_AUTH *newAuth;
     TPM2B_AUTH newAuthData;
 } NV_ChangeAuth_IN;
 
-
 typedef struct {
     ESYS_TR signHandle;
     ESYS_TR authHandle;
@@ -928,7 +815,6 @@ typedef struct {
     TPMT_SIG_SCHEME inSchemeData;
 } NV_Certify_IN;
 
-
 typedef struct {
     TPM2B_DATA *inputData;
     TPM2B_DATA inputDataData;