Skip to content

Commit

Permalink
Doxygen for 2ad3f80
Browse files Browse the repository at this point in the history
  • Loading branch information
chinglee-iot committed May 13, 2024
1 parent d5e6b44 commit 9e0f3a2
Show file tree
Hide file tree
Showing 13 changed files with 64 additions and 53 deletions.
2 changes: 1 addition & 1 deletion main/pkcs11_mbedtls_function_c_digestfinal.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_a8d9dbaaa88129137a4c68ba0456a18b1"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#a8d9dbaaa88129137a4c68ba0456a18b1">LogError</a></div><div class="ttdeci">#define LogError(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Error&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:317</div></div>
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_af60e8ffc327d136e5d0d8441ed98c98d"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#af60e8ffc327d136e5d0d8441ed98c98d">LogDebug</a></div><div class="ttdeci">#define LogDebug(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Debug&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:377</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a1936e3a07702240561149805e8f0bfbb"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a1936e3a07702240561149805e8f0bfbb">mbedtlsLowLevelCodeOrDefault</a></div><div class="ttdeci">#define mbedtlsLowLevelCodeOrDefault(mbedTlsCode)</div><div class="ttdoc">Utility for converting the level-level code in an mbedTLS error to string, if the code-contains a lev...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:108</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a1f3dc3758726bb4737db956e4cd71e91"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a1f3dc3758726bb4737db956e4cd71e91">C_DigestFinal</a></div><div class="ttdeci">CK_RV C_DigestFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pDigest, CK_ULONG_PTR pulDigestLen)</div><div class="ttdoc">Finishes a multiple-part digesting operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3856</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a1f3dc3758726bb4737db956e4cd71e91"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a1f3dc3758726bb4737db956e4cd71e91">C_DigestFinal</a></div><div class="ttdeci">CK_RV C_DigestFinal(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pDigest, CK_ULONG_PTR pulDigestLen)</div><div class="ttdoc">Finishes a multiple-part digesting operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3867</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7b281bde3593fa0973cac1a3c3745a8c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7b281bde3593fa0973cac1a3c3745a8c">prvSessionPointerFromHandle</a></div><div class="ttdeci">static P11Session_t * prvSessionPointerFromHandle(CK_SESSION_HANDLE xSession)</div><div class="ttdoc">Maps an opaque caller session handle into its internal state structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:394</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a92427274c3174ef89fbf82a0ad25a252"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a92427274c3174ef89fbf82a0ad25a252">mbedtlsHighLevelCodeOrDefault</a></div><div class="ttdeci">#define mbedtlsHighLevelCodeOrDefault(mbedTlsCode)</div><div class="ttdoc">Utility for converting the high-level code in an mbedTLS error to string, if the code-contains a high...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:100</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ab93c9263b9b89774e57eee9e8ac708a8"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ab93c9263b9b89774e57eee9e8ac708a8">prvCheckValidSessionAndModule</a></div><div class="ttdeci">static CK_RV prvCheckValidSessionAndModule(const P11Session_t *pxSession)</div><div class="ttdoc">Helper to check if the current session is initialized and valid.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:348</div></div>
Expand Down
2 changes: 1 addition & 1 deletion main/pkcs11_mbedtls_function_c_digestinit.html
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_a8d9dbaaa88129137a4c68ba0456a18b1"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#a8d9dbaaa88129137a4c68ba0456a18b1">LogError</a></div><div class="ttdeci">#define LogError(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Error&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:317</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a1936e3a07702240561149805e8f0bfbb"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a1936e3a07702240561149805e8f0bfbb">mbedtlsLowLevelCodeOrDefault</a></div><div class="ttdeci">#define mbedtlsLowLevelCodeOrDefault(mbedTlsCode)</div><div class="ttdoc">Utility for converting the level-level code in an mbedTLS error to string, if the code-contains a lev...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:108</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a2ec465960e108e808263b43e589fbd58"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a2ec465960e108e808263b43e589fbd58">prvOperationActive</a></div><div class="ttdeci">static CK_BBOOL prvOperationActive(const P11Session_t *pxSession)</div><div class="ttdoc">Determines if an operation is in progress.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:414</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a3f6bcb9f9be8a7822d9d8f7c44c33403"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a3f6bcb9f9be8a7822d9d8f7c44c33403">C_DigestInit</a></div><div class="ttdeci">CK_RV C_DigestInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism)</div><div class="ttdoc">Initializes a message-digesting operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3688</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a3f6bcb9f9be8a7822d9d8f7c44c33403"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a3f6bcb9f9be8a7822d9d8f7c44c33403">C_DigestInit</a></div><div class="ttdeci">CK_RV C_DigestInit(CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism)</div><div class="ttdoc">Initializes a message-digesting operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3699</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7b281bde3593fa0973cac1a3c3745a8c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7b281bde3593fa0973cac1a3c3745a8c">prvSessionPointerFromHandle</a></div><div class="ttdeci">static P11Session_t * prvSessionPointerFromHandle(CK_SESSION_HANDLE xSession)</div><div class="ttdoc">Maps an opaque caller session handle into its internal state structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:394</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a92427274c3174ef89fbf82a0ad25a252"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a92427274c3174ef89fbf82a0ad25a252">mbedtlsHighLevelCodeOrDefault</a></div><div class="ttdeci">#define mbedtlsHighLevelCodeOrDefault(mbedTlsCode)</div><div class="ttdoc">Utility for converting the high-level code in an mbedTLS error to string, if the code-contains a high...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:100</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ab93c9263b9b89774e57eee9e8ac708a8"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ab93c9263b9b89774e57eee9e8ac708a8">prvCheckValidSessionAndModule</a></div><div class="ttdeci">static CK_RV prvCheckValidSessionAndModule(const P11Session_t *pxSession)</div><div class="ttdoc">Helper to check if the current session is initialized and valid.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:348</div></div>
Expand Down
2 changes: 1 addition & 1 deletion main/pkcs11_mbedtls_function_c_digestupdate.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_a8d9dbaaa88129137a4c68ba0456a18b1"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#a8d9dbaaa88129137a4c68ba0456a18b1">LogError</a></div><div class="ttdeci">#define LogError(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Error&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:317</div></div>
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_af60e8ffc327d136e5d0d8441ed98c98d"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#af60e8ffc327d136e5d0d8441ed98c98d">LogDebug</a></div><div class="ttdeci">#define LogDebug(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Debug&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:377</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a1936e3a07702240561149805e8f0bfbb"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a1936e3a07702240561149805e8f0bfbb">mbedtlsLowLevelCodeOrDefault</a></div><div class="ttdeci">#define mbedtlsLowLevelCodeOrDefault(mbedTlsCode)</div><div class="ttdoc">Utility for converting the level-level code in an mbedTLS error to string, if the code-contains a lev...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:108</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7a8189a6963fbcfdfe2bebe20a8bf3b6"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7a8189a6963fbcfdfe2bebe20a8bf3b6">C_DigestUpdate</a></div><div class="ttdeci">CK_RV C_DigestUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, CK_ULONG ulPartLen)</div><div class="ttdoc">Continues a multiple-part digesting operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3773</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7a8189a6963fbcfdfe2bebe20a8bf3b6"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7a8189a6963fbcfdfe2bebe20a8bf3b6">C_DigestUpdate</a></div><div class="ttdeci">CK_RV C_DigestUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart, CK_ULONG ulPartLen)</div><div class="ttdoc">Continues a multiple-part digesting operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3784</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7b281bde3593fa0973cac1a3c3745a8c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7b281bde3593fa0973cac1a3c3745a8c">prvSessionPointerFromHandle</a></div><div class="ttdeci">static P11Session_t * prvSessionPointerFromHandle(CK_SESSION_HANDLE xSession)</div><div class="ttdoc">Maps an opaque caller session handle into its internal state structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:394</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a92427274c3174ef89fbf82a0ad25a252"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a92427274c3174ef89fbf82a0ad25a252">mbedtlsHighLevelCodeOrDefault</a></div><div class="ttdeci">#define mbedtlsHighLevelCodeOrDefault(mbedTlsCode)</div><div class="ttdoc">Utility for converting the high-level code in an mbedTLS error to string, if the code-contains a high...</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:100</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ab93c9263b9b89774e57eee9e8ac708a8"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ab93c9263b9b89774e57eee9e8ac708a8">prvCheckValidSessionAndModule</a></div><div class="ttdeci">static CK_RV prvCheckValidSessionAndModule(const P11Session_t *pxSession)</div><div class="ttdoc">Helper to check if the current session is initialized and valid.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:348</div></div>
Expand Down
2 changes: 1 addition & 1 deletion main/pkcs11_mbedtls_function_c_findobjects.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@
<div class="ttc" id="acore__pkcs11_8h_html_a30315d302108bcfb354196f37b16a492"><div class="ttname"><a href="core__pkcs11_8h.html#a30315d302108bcfb354196f37b16a492">CK_DECLARE_FUNCTION</a></div><div class="ttdeci">#define CK_DECLARE_FUNCTION(returnType, name)</div><div class="ttdoc">Macro for defining a PKCS #11 functions.</div><div class="ttdef"><b>Definition:</b> core_pkcs11.h:77</div></div>
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_a8d9dbaaa88129137a4c68ba0456a18b1"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#a8d9dbaaa88129137a4c68ba0456a18b1">LogError</a></div><div class="ttdeci">#define LogError(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Error&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:317</div></div>
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_af60e8ffc327d136e5d0d8441ed98c98d"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#af60e8ffc327d136e5d0d8441ed98c98d">LogDebug</a></div><div class="ttdeci">#define LogDebug(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Debug&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:377</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a42635cbaa2ba78482ae053bea477246a"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a42635cbaa2ba78482ae053bea477246a">C_FindObjects</a></div><div class="ttdeci">CK_RV C_FindObjects(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE_PTR phObject, CK_ULONG ulMaxObjectCount, CK_ULONG_PTR pulObjectCount)</div><div class="ttdoc">Initializes an object search operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3539</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a42635cbaa2ba78482ae053bea477246a"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a42635cbaa2ba78482ae053bea477246a">C_FindObjects</a></div><div class="ttdeci">CK_RV C_FindObjects(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE_PTR phObject, CK_ULONG ulMaxObjectCount, CK_ULONG_PTR pulObjectCount)</div><div class="ttdoc">Initializes an object search operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3550</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7b281bde3593fa0973cac1a3c3745a8c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7b281bde3593fa0973cac1a3c3745a8c">prvSessionPointerFromHandle</a></div><div class="ttdeci">static P11Session_t * prvSessionPointerFromHandle(CK_SESSION_HANDLE xSession)</div><div class="ttdoc">Maps an opaque caller session handle into its internal state structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:394</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ab93c9263b9b89774e57eee9e8ac708a8"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ab93c9263b9b89774e57eee9e8ac708a8">prvCheckValidSessionAndModule</a></div><div class="ttdeci">static CK_RV prvCheckValidSessionAndModule(const P11Session_t *pxSession)</div><div class="ttdoc">Helper to check if the current session is initialized and valid.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:348</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ac07ee599e28a77e94ef82db1346157d3"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ac07ee599e28a77e94ef82db1346157d3">prvAddObjectToList</a></div><div class="ttdeci">static CK_RV prvAddObjectToList(CK_OBJECT_HANDLE xPalHandle, CK_OBJECT_HANDLE_PTR pxAppHandle, const CK_BYTE *pcLabel, CK_ULONG xLabelLength)</div><div class="ttdoc">Add an object that exists in NVM to the application object array.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:1215</div></div>
Expand Down
2 changes: 1 addition & 1 deletion main/pkcs11_mbedtls_function_c_findobjectsfinal.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
<div class="line">}</div>
<div class="ttc" id="acore__pkcs11_8h_html_a30315d302108bcfb354196f37b16a492"><div class="ttname"><a href="core__pkcs11_8h.html#a30315d302108bcfb354196f37b16a492">CK_DECLARE_FUNCTION</a></div><div class="ttdeci">#define CK_DECLARE_FUNCTION(returnType, name)</div><div class="ttdoc">Macro for defining a PKCS #11 functions.</div><div class="ttdef"><b>Definition:</b> core_pkcs11.h:77</div></div>
<div class="ttc" id="acore__pkcs11__config__defaults_8h_html_a8d9dbaaa88129137a4c68ba0456a18b1"><div class="ttname"><a href="core__pkcs11__config__defaults_8h.html#a8d9dbaaa88129137a4c68ba0456a18b1">LogError</a></div><div class="ttdeci">#define LogError(message)</div><div class="ttdoc">Macro that is called in the corePKCS11 library for logging &quot;Error&quot; level messages.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_config_defaults.h:317</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a46347f830269bfbcbece15951f0c0fa4"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a46347f830269bfbcbece15951f0c0fa4">C_FindObjectsFinal</a></div><div class="ttdeci">CK_RV C_FindObjectsFinal(CK_SESSION_HANDLE hSession)</div><div class="ttdoc">Finishes an object search operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3639</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a46347f830269bfbcbece15951f0c0fa4"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a46347f830269bfbcbece15951f0c0fa4">C_FindObjectsFinal</a></div><div class="ttdeci">CK_RV C_FindObjectsFinal(CK_SESSION_HANDLE hSession)</div><div class="ttdoc">Finishes an object search operation.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:3650</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_a7b281bde3593fa0973cac1a3c3745a8c"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#a7b281bde3593fa0973cac1a3c3745a8c">prvSessionPointerFromHandle</a></div><div class="ttdeci">static P11Session_t * prvSessionPointerFromHandle(CK_SESSION_HANDLE xSession)</div><div class="ttdoc">Maps an opaque caller session handle into its internal state structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:394</div></div>
<div class="ttc" id="acore__pkcs11__mbedtls_8c_html_ab93c9263b9b89774e57eee9e8ac708a8"><div class="ttname"><a href="core__pkcs11__mbedtls_8c.html#ab93c9263b9b89774e57eee9e8ac708a8">prvCheckValidSessionAndModule</a></div><div class="ttdeci">static CK_RV prvCheckValidSessionAndModule(const P11Session_t *pxSession)</div><div class="ttdoc">Helper to check if the current session is initialized and valid.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:348</div></div>
<div class="ttc" id="astruct_p11_session__t_html"><div class="ttname"><a href="struct_p11_session__t.html">P11Session_t</a></div><div class="ttdoc">Session structure.</div><div class="ttdef"><b>Definition:</b> core_pkcs11_mbedtls.c:311</div></div>
Expand Down
Loading

0 comments on commit 9e0f3a2

Please sign in to comment.