Skip to content

Commit

Permalink
Documentation updates for release v3.7.6 (20240926)
Browse files Browse the repository at this point in the history
  • Loading branch information
Srinivas-E committed Sep 27, 2024
1 parent ff0f8ad commit b887dd4
Show file tree
Hide file tree
Showing 1,037 changed files with 29,443 additions and 105,414 deletions.
4 changes: 2 additions & 2 deletions a00005.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="microchip.png"/></td>
<td id="projectalign">
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.5</span>
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.6</span>
</div>
<div id="projectbrief">Microchip CryptoAuthentication Library</div>
</td>
Expand Down Expand Up @@ -107,7 +107,7 @@
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &quot;<a class="el" href="a00506.html">cryptoauthlib.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00521.html">cryptoauthlib.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00008.html">api_206a.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Expand Down
4 changes: 2 additions & 2 deletions a00008.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="microchip.png"/></td>
<td id="projectalign">
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.5</span>
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.6</span>
</div>
<div id="projectbrief">Microchip CryptoAuthentication Library</div>
</td>
Expand Down Expand Up @@ -107,7 +107,7 @@

<p>Provides api interfaces to use with ATSHA206A device.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="a00263.html">atca_status.h</a>&quot;</code><br />
<div class="textblock"><code>#include &quot;<a class="el" href="a00269.html">atca_status.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
Expand Down
6 changes: 3 additions & 3 deletions a00011.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="microchip.png"/></td>
<td id="projectalign">
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.5</span>
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.6</span>
</div>
<div id="projectbrief">Microchip CryptoAuthentication Library</div>
</td>
Expand Down Expand Up @@ -105,8 +105,8 @@

<p>Contains API for performing the symmetric Authentication between the Host and the device.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="a00506.html">cryptoauthlib.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00635.html">host/atca_host.h</a>&quot;</code><br />
<div class="textblock"><code>#include &quot;<a class="el" href="a00521.html">cryptoauthlib.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00650.html">host/atca_host.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00014.html">symmetric_authentication.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Expand Down
4 changes: 2 additions & 2 deletions a00014.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="microchip.png"/></td>
<td id="projectalign">
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.5</span>
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.6</span>
</div>
<div id="projectbrief">Microchip CryptoAuthentication Library</div>
</td>
Expand Down Expand Up @@ -105,7 +105,7 @@

<p>Contains API for performing the symmetric Authentication between the Host and the device.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="a00506.html">cryptoauthlib.h</a>&quot;</code><br />
<div class="textblock"><code>#include &quot;<a class="el" href="a00521.html">cryptoauthlib.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
Expand Down
26 changes: 13 additions & 13 deletions a00017.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="microchip.png"/></td>
<td id="projectalign">
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.5</span>
<div id="projectname">CryptoAuthLib<span id="projectnumber">&#160;v3.7.6</span>
</div>
<div id="projectbrief">Microchip CryptoAuthentication Library</div>
</td>
Expand Down Expand Up @@ -107,34 +107,34 @@
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;ctype.h&gt;</code><br />
<code>#include &quot;<a class="el" href="a00020.html">ascii_kit_host.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00614.html">hal/kit_protocol.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="a00629.html">hal/kit_protocol.h</a>&quot;</code><br />
<code>#include &quot;talib/talib_fce.h&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac79cbb36e6f0efe9196fa9131ccdb69b"><td class="memItemLeft" align="right" valign="top">ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#ac79cbb36e6f0efe9196fa9131ccdb69b">kit_host_init_phy</a> (<a class="el" href="a01652.html">atca_hal_kit_phy_t</a> *phy, <a class="el" href="a01584.html">ATCAIface</a> iface)</td></tr>
<tr class="memitem:ac79cbb36e6f0efe9196fa9131ccdb69b"><td class="memItemLeft" align="right" valign="top">ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#ac79cbb36e6f0efe9196fa9131ccdb69b">kit_host_init_phy</a> (<a class="el" href="a01671.html">atca_hal_kit_phy_t</a> *phy, <a class="el" href="a01607.html">ATCAIface</a> iface)</td></tr>
<tr class="memdesc:ac79cbb36e6f0efe9196fa9131ccdb69b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a phy structure with a cryptoauthlib hal adapter. <br /></td></tr>
<tr class="separator:ac79cbb36e6f0efe9196fa9131ccdb69b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dcff757a8d30cec3b1e209351b16358"><td class="memItemLeft" align="right" valign="top">ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#a9dcff757a8d30cec3b1e209351b16358">kit_host_init</a> (<a class="el" href="a01480.html">ascii_kit_host_context_t</a> *ctx, <a class="el" href="a01516.html">ATCAIfaceCfg</a> *iface[], const size_t iface_count, const <a class="el" href="a01652.html">atca_hal_kit_phy_t</a> *phy, const uint32_t flags)</td></tr>
<tr class="memitem:a9dcff757a8d30cec3b1e209351b16358"><td class="memItemLeft" align="right" valign="top">ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00017.html#a9dcff757a8d30cec3b1e209351b16358">kit_host_init</a> (<a class="el" href="a01507.html">ascii_kit_host_context_t</a> *ctx, <a class="el" href="a01539.html">ATCAIfaceCfg</a> *iface[], const size_t iface_count, const <a class="el" href="a01671.html">atca_hal_kit_phy_t</a> *phy, const uint32_t flags)</td></tr>
<tr class="memdesc:a9dcff757a8d30cec3b1e209351b16358"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the kit protocol parser context. <br /></td></tr>
<tr class="separator:a9dcff757a8d30cec3b1e209351b16358"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6f6e7798cc371e9667889cbbb4af330"><td class="memItemLeft" align="right" valign="top"><a id="ac6f6e7798cc371e9667889cbbb4af330" name="ac6f6e7798cc371e9667889cbbb4af330"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_format_response</b> (uint8_t *response, size_t rlen, ATCA_STATUS status, uint8_t *data, size_t dlen)</td></tr>
<tr class="memdesc:ac6f6e7798cc371e9667889cbbb4af330"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format the status and data into the kit protocol response format. <br /></td></tr>
<tr class="separator:ac6f6e7798cc371e9667889cbbb4af330"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac00c465f600b5dd1dcb85eddff61d93a"><td class="memItemLeft" align="right" valign="top"><a id="ac00c465f600b5dd1dcb85eddff61d93a" name="ac00c465f600b5dd1dcb85eddff61d93a"></a>
ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_process_cmd</b> (<a class="el" href="a01480.html">ascii_kit_host_context_t</a> *ctx, const <a class="el" href="a00020.html#abe18de5c585f639142a5bf7c253e5b7f">kit_host_map_entry_t</a> *cmd_list, int argc, char *argv[], uint8_t *response, size_t *rlen)</td></tr>
ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_process_cmd</b> (<a class="el" href="a01507.html">ascii_kit_host_context_t</a> *ctx, const <a class="el" href="a00020.html#abe18de5c585f639142a5bf7c253e5b7f">kit_host_map_entry_t</a> *cmd_list, int argc, char *argv[], uint8_t *response, size_t *rlen)</td></tr>
<tr class="memdesc:ac00c465f600b5dd1dcb85eddff61d93a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate through a command list to match the given command and then will execute it. <br /></td></tr>
<tr class="separator:ac00c465f600b5dd1dcb85eddff61d93a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a233f2637dd132eb43702aa80d7ed8bf6"><td class="memItemLeft" align="right" valign="top"><a id="a233f2637dd132eb43702aa80d7ed8bf6" name="a233f2637dd132eb43702aa80d7ed8bf6"></a>
ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_process_ta</b> (<a class="el" href="a01480.html">ascii_kit_host_context_t</a> *ctx, int argc, char *argv[], uint8_t *response, size_t *rlen)</td></tr>
ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_process_ta</b> (<a class="el" href="a01507.html">ascii_kit_host_context_t</a> *ctx, int argc, char *argv[], uint8_t *response, size_t *rlen)</td></tr>
<tr class="separator:a233f2637dd132eb43702aa80d7ed8bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2067eeb11f190a7fb64217f917c3ff76"><td class="memItemLeft" align="right" valign="top"><a id="a2067eeb11f190a7fb64217f917c3ff76" name="a2067eeb11f190a7fb64217f917c3ff76"></a>
ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_process_line</b> (<a class="el" href="a01480.html">ascii_kit_host_context_t</a> *ctx, uint8_t *input_line, size_t ilen, uint8_t *response, size_t *rlen)</td></tr>
ATCA_STATUS&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_process_line</b> (<a class="el" href="a01507.html">ascii_kit_host_context_t</a> *ctx, uint8_t *input_line, size_t ilen, uint8_t *response, size_t *rlen)</td></tr>
<tr class="memdesc:a2067eeb11f190a7fb64217f917c3ff76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse a line as a kit protocol command. The kit protocol is printable ascii and each line ends with a newline character. <br /></td></tr>
<tr class="separator:a2067eeb11f190a7fb64217f917c3ff76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2fa4cf8af951688c4be97cca0d23b71"><td class="memItemLeft" align="right" valign="top"><a id="ac2fa4cf8af951688c4be97cca0d23b71" name="ac2fa4cf8af951688c4be97cca0d23b71"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_task</b> (<a class="el" href="a01480.html">ascii_kit_host_context_t</a> *ctx)</td></tr>
void&#160;</td><td class="memItemRight" valign="bottom"><b>kit_host_task</b> (<a class="el" href="a01507.html">ascii_kit_host_context_t</a> *ctx)</td></tr>
<tr class="memdesc:ac2fa4cf8af951688c4be97cca0d23b71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Non returning kit protocol runner using the configured physical interface that was provided when the context was initialized. <br /></td></tr>
<tr class="separator:ac2fa4cf8af951688c4be97cca0d23b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
Expand All @@ -151,13 +151,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9dcff757a8d30cec3b1e2093
<tr>
<td class="memname">ATCA_STATUS kit_host_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01480.html">ascii_kit_host_context_t</a> *&#160;</td>
<td class="paramtype"><a class="el" href="a01507.html">ascii_kit_host_context_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01516.html">ATCAIfaceCfg</a> *&#160;</td>
<td class="paramtype"><a class="el" href="a01539.html">ATCAIfaceCfg</a> *&#160;</td>
<td class="paramname"><em>iface</em>[], </td>
</tr>
<tr>
Expand All @@ -169,7 +169,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9dcff757a8d30cec3b1e2093
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a01652.html">atca_hal_kit_phy_t</a> *&#160;</td>
<td class="paramtype">const <a class="el" href="a01671.html">atca_hal_kit_phy_t</a> *&#160;</td>
<td class="paramname"><em>phy</em>, </td>
</tr>
<tr>
Expand Down Expand Up @@ -210,13 +210,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac79cbb36e6f0efe9196fa913
<tr>
<td class="memname">ATCA_STATUS kit_host_init_phy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01652.html">atca_hal_kit_phy_t</a> *&#160;</td>
<td class="paramtype"><a class="el" href="a01671.html">atca_hal_kit_phy_t</a> *&#160;</td>
<td class="paramname"><em>phy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01584.html">ATCAIface</a>&#160;</td>
<td class="paramtype"><a class="el" href="a01607.html">ATCAIface</a>&#160;</td>
<td class="paramname"><em>iface</em>&#160;</td>
</tr>
<tr>
Expand Down
Loading

0 comments on commit b887dd4

Please sign in to comment.