web/docs/group__pico__sha256.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: pico_sha256</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('group__pico__sha256.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="summary">
 106 <a href="#nested-classes">Data Structures</a> &#124;
 107 <a href="#typedef-members">Typedefs</a> &#124;
 108 <a href="#func-members">Functions</a>  </div>
 109   <div class="headertitle"><div class="title">pico_sha256<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a></div></div></div>
 110 </div><!--header-->
 111 <div class="contents">
 112
 113 <p>SHA-256 Hardware Accelerated implementation.
 114 <a href="#details">More...</a></p>
 115 <table class="memberdecls">
 116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 117 Data Structures</h2></td></tr>
 118 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpico__sha256__state.html">pico_sha256_state</a></td></tr>
 119 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA-256 state used by the API.  <a href="structpico__sha256__state.html#details">More...</a><br /></td></tr>
 120 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 </table><table class="memberdecls">
 122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 123 Typedefs</h2></td></tr>
 124 <tr class="memitem:gadb68f9eb89ce1a5b795463cd083a30a0"><td class="memItemLeft" align="right" valign="top"><a id="gadb68f9eb89ce1a5b795463cd083a30a0" name="gadb68f9eb89ce1a5b795463cd083a30a0"></a>
 125 typedef struct <a class="el" href="structpico__sha256__state.html">pico_sha256_state</a>&#160;</td><td class="memItemRight" valign="bottom"><b>pico_sha256_state_t</b></td></tr>
 126 <tr class="memdesc:gadb68f9eb89ce1a5b795463cd083a30a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA-256 state used by the API. <br /></td></tr>
 127 <tr class="separator:gadb68f9eb89ce1a5b795463cd083a30a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 </table><table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 130 Functions</h2></td></tr>
 131 <tr class="memitem:ga56a125e51ec616f61082cc63c8599dcb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga56a125e51ec616f61082cc63c8599dcb">pico_sha256_try_start</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a> endianness, bool use_dma)</td></tr>
 132 <tr class="memdesc:ga56a125e51ec616f61082cc63c8599dcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a SHA-256 calculation returning immediately with an error if the SHA-256 hardware is not available.  <a href="group__pico__sha256.html#ga56a125e51ec616f61082cc63c8599dcb">More...</a><br /></td></tr>
 133 <tr class="separator:ga56a125e51ec616f61082cc63c8599dcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:ga6e6d3e0a3cb87e32a73757bcda88ebc1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga6e6d3e0a3cb87e32a73757bcda88ebc1">pico_sha256_start_blocking_until</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a> endianness, bool use_dma, <a class="el" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> until)</td></tr>
 135 <tr class="memdesc:ga6e6d3e0a3cb87e32a73757bcda88ebc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a SHA-256 calculation waiting for a defined period for the SHA-256 hardware to be available.  <a href="group__pico__sha256.html#ga6e6d3e0a3cb87e32a73757bcda88ebc1">More...</a><br /></td></tr>
 136 <tr class="separator:ga6e6d3e0a3cb87e32a73757bcda88ebc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:gaf8fdc6d7438ffed9fcbc124eb134ae6e"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#gaf8fdc6d7438ffed9fcbc124eb134ae6e">pico_sha256_start_blocking</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a> endianness, bool use_dma)</td></tr>
 138 <tr class="memdesc:gaf8fdc6d7438ffed9fcbc124eb134ae6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a SHA-256 calculation, blocking forever waiting until the SHA-256 hardware is available.  <a href="group__pico__sha256.html#gaf8fdc6d7438ffed9fcbc124eb134ae6e">More...</a><br /></td></tr>
 139 <tr class="separator:gaf8fdc6d7438ffed9fcbc124eb134ae6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:ga43c112e22aea468ce0551c5078e155cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga43c112e22aea468ce0551c5078e155cd">pico_sha256_update</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, const uint8_t *data, size_t data_size_bytes)</td></tr>
 141 <tr class="memdesc:ga43c112e22aea468ce0551c5078e155cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add byte data to be SHA-256 calculation.  <a href="group__pico__sha256.html#ga43c112e22aea468ce0551c5078e155cd">More...</a><br /></td></tr>
 142 <tr class="separator:ga43c112e22aea468ce0551c5078e155cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:ga9bf8472019386229c3ba3b6d169b9656"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga9bf8472019386229c3ba3b6d169b9656">pico_sha256_update_blocking</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, const uint8_t *data, size_t data_size_bytes)</td></tr>
 144 <tr class="memdesc:ga9bf8472019386229c3ba3b6d169b9656"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add byte data to be SHA-256 calculation.  <a href="group__pico__sha256.html#ga9bf8472019386229c3ba3b6d169b9656">More...</a><br /></td></tr>
 145 <tr class="separator:ga9bf8472019386229c3ba3b6d169b9656"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ga4eac54bf699dba0067a22ae3ef5ae121"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga4eac54bf699dba0067a22ae3ef5ae121">pico_sha256_finish</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, <a class="el" href="unionsha256__result__t.html">sha256_result_t</a> *out)</td></tr>
 147 <tr class="memdesc:ga4eac54bf699dba0067a22ae3ef5ae121"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish the SHA-256 calculation and return the result.  <a href="group__pico__sha256.html#ga4eac54bf699dba0067a22ae3ef5ae121">More...</a><br /></td></tr>
 148 <tr class="separator:ga4eac54bf699dba0067a22ae3ef5ae121"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 </table>
 150 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 151 <p >SHA-256 Hardware Accelerated implementation. </p>
 152 <p >RP2350 is equipped with a hardware accelerated implementation of the SHA-256 hash algorithm. This should be much quicker than performing a SHA-256 checksum in software.</p>
 153 <div class="fragment"><div class="line"><a class="code hl_struct" href="structpico__sha256__state.html">pico_sha256_state_t</a> state;</div>
 154 <div class="line"><span class="keywordflow">if</span> (<a class="code hl_function" href="group__pico__sha256.html#ga56a125e51ec616f61082cc63c8599dcb">pico_sha256_try_start</a>(&amp;state, <a class="code hl_enumvalue" href="group__hardware__sha256.html#ggaaf3089af3667088256de5d352973d5e6a9ed40fa208beaabfc2fc5b8edbd652c1">SHA256_BIG_ENDIAN</a>, <span class="keyword">true</span>) == <a class="code hl_enumvalue" href="group__pico__base.html#ggaddcb20bc9a61ceff479aa87369a862aaa9b50bcb755cf2e8295de9ffa52b252fd">PICO_OK</a>) {</div>
 155 <div class="line">    <a class="code hl_union" href="unionsha256__result__t.html">sha256_result_t</a> result;</div>
 156 <div class="line">    <a class="code hl_function" href="group__pico__sha256.html#ga43c112e22aea468ce0551c5078e155cd">pico_sha256_update</a>(&amp;state, some_data, <span class="keyword">sizeof</span>(some_data));</div>
 157 <div class="line">    <a class="code hl_function" href="group__pico__sha256.html#ga43c112e22aea468ce0551c5078e155cd">pico_sha256_update</a>(&amp;state, some_more_data, <span class="keyword">sizeof</span>(some_more_data));</div>
 158 <div class="line">    <a class="code hl_function" href="group__pico__sha256.html#ga4eac54bf699dba0067a22ae3ef5ae121">pico_sha256_finish</a>(&amp;state, &amp;result);</div>
 159 <div class="line">    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; <a class="code hl_define" href="group__hardware__sha256.html#ga08a18381a4c5a7c9f7d0d1b6550621a3">SHA256_RESULT_BYTES</a>; i++) {</div>
 160 <div class="line">        printf(<span class="stringliteral">&quot;%02x&quot;</span>, result.bytes[i]);</div>
 161 <div class="line">    }</div>
 162 <div class="line">}</div>
 163 <div class="ttc" id="agroup__hardware__sha256_html_ga08a18381a4c5a7c9f7d0d1b6550621a3"><div class="ttname"><a href="group__hardware__sha256.html#ga08a18381a4c5a7c9f7d0d1b6550621a3">SHA256_RESULT_BYTES</a></div><div class="ttdeci">#define SHA256_RESULT_BYTES</div><div class="ttdoc">Size of a sha256 result in bytes.</div><div class="ttdef"><b>Definition:</b> sha256.h:44</div></div>
 164 <div class="ttc" id="agroup__hardware__sha256_html_ggaaf3089af3667088256de5d352973d5e6a9ed40fa208beaabfc2fc5b8edbd652c1"><div class="ttname"><a href="group__hardware__sha256.html#ggaaf3089af3667088256de5d352973d5e6a9ed40fa208beaabfc2fc5b8edbd652c1">SHA256_BIG_ENDIAN</a></div><div class="ttdeci">@ SHA256_BIG_ENDIAN</div><div class="ttdoc">Big Endian.</div><div class="ttdef"><b>Definition:</b> sha256.h:51</div></div>
 165 <div class="ttc" id="agroup__pico__base_html_ggaddcb20bc9a61ceff479aa87369a862aaa9b50bcb755cf2e8295de9ffa52b252fd"><div class="ttname"><a href="group__pico__base.html#ggaddcb20bc9a61ceff479aa87369a862aaa9b50bcb755cf2e8295de9ffa52b252fd">PICO_OK</a></div><div class="ttdeci">@ PICO_OK</div><div class="ttdoc">No error; the operation succeeded.</div><div class="ttdef"><b>Definition:</b> error.h:23</div></div>
 166 <div class="ttc" id="agroup__pico__sha256_html_ga43c112e22aea468ce0551c5078e155cd"><div class="ttname"><a href="group__pico__sha256.html#ga43c112e22aea468ce0551c5078e155cd">pico_sha256_update</a></div><div class="ttdeci">void pico_sha256_update(pico_sha256_state_t *state, const uint8_t *data, size_t data_size_bytes)</div><div class="ttdoc">Add byte data to be SHA-256 calculation.</div><div class="ttdef"><b>Definition:</b> sha256.c:137</div></div>
 167 <div class="ttc" id="agroup__pico__sha256_html_ga4eac54bf699dba0067a22ae3ef5ae121"><div class="ttname"><a href="group__pico__sha256.html#ga4eac54bf699dba0067a22ae3ef5ae121">pico_sha256_finish</a></div><div class="ttdeci">void pico_sha256_finish(pico_sha256_state_t *state, sha256_result_t *out)</div><div class="ttdoc">Finish the SHA-256 calculation and return the result.</div><div class="ttdef"><b>Definition:</b> sha256.c:167</div></div>
 168 <div class="ttc" id="agroup__pico__sha256_html_ga56a125e51ec616f61082cc63c8599dcb"><div class="ttname"><a href="group__pico__sha256.html#ga56a125e51ec616f61082cc63c8599dcb">pico_sha256_try_start</a></div><div class="ttdeci">int pico_sha256_try_start(pico_sha256_state_t *state, enum sha256_endianness endianness, bool use_dma)</div><div class="ttdoc">Start a SHA-256 calculation returning immediately with an error if the SHA-256 hardware is not availa...</div><div class="ttdef"><b>Definition:</b> sha256.c:33</div></div>
 169 <div class="ttc" id="astructpico__sha256__state_html"><div class="ttname"><a href="structpico__sha256__state.html">pico_sha256_state</a></div><div class="ttdoc">SHA-256 state used by the API.</div><div class="ttdef"><b>Definition:</b> sha256.h:48</div></div>
 170 <div class="ttc" id="aunionsha256__result__t_html"><div class="ttname"><a href="unionsha256__result__t.html">sha256_result_t</a></div><div class="ttdoc">SHA-256 result generated by the API.</div><div class="ttdef"><b>Definition:</b> sha256.h:57</div></div>
 171 </div><!-- fragment --><h2><a class="anchor" id="sha256_example"></a>
 172 Example</h2>
 173 <div class="fragment"></div><!-- fragment --> <h2 class="groupheader">Function Documentation</h2>
 174 <a id="ga4eac54bf699dba0067a22ae3ef5ae121" name="ga4eac54bf699dba0067a22ae3ef5ae121"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#ga4eac54bf699dba0067a22ae3ef5ae121">&#9670;&nbsp;</a></span>pico_sha256_finish()</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">void pico_sha256_finish </td>
 182           <td>(</td>
 183           <td class="paramtype"><a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *&#160;</td>
 184           <td class="paramname"><em>state</em>, </td>
 185         </tr>
 186         <tr>
 187           <td class="paramkey"></td>
 188           <td></td>
 189           <td class="paramtype"><a class="el" href="unionsha256__result__t.html">sha256_result_t</a> *&#160;</td>
 190           <td class="paramname"><em>out</em>&#160;</td>
 191         </tr>
 192         <tr>
 193           <td></td>
 194           <td>)</td>
 195           <td></td><td></td>
 196         </tr>
 197       </table>
 198 </div><div class="memdoc">
 199
 200 <p>Finish the SHA-256 calculation and return the result. </p>
 201 <p >Ends the SHA-256 calculation freeing the hardware for use by another caller. You must have called pico_sha256_try_start already.</p>
 202 <dl class="params"><dt>Parameters</dt><dd>
 203   <table class="params">
 204     <tr><td class="paramname">state</td><td>A pointer to a pico_sha256_state_t instance </td></tr>
 205     <tr><td class="paramname">out</td><td>The SHA-256 checksum </td></tr>
 206   </table>
 207   </dd>
 208 </dl>
 209
 210 </div>
 211 </div>
 212 <a id="gaf8fdc6d7438ffed9fcbc124eb134ae6e" name="gaf8fdc6d7438ffed9fcbc124eb134ae6e"></a>
 213 <h2 class="memtitle"><span class="permalink"><a href="#gaf8fdc6d7438ffed9fcbc124eb134ae6e">&#9670;&nbsp;</a></span>pico_sha256_start_blocking()</h2>
 214
 215 <div class="memitem">
 216 <div class="memproto">
 217 <table class="mlabels">
 218   <tr>
 219   <td class="mlabels-left">
 220       <table class="memname">
 221         <tr>
 222           <td class="memname">static int pico_sha256_start_blocking </td>
 223           <td>(</td>
 224           <td class="paramtype"><a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *&#160;</td>
 225           <td class="paramname"><em>state</em>, </td>
 226         </tr>
 227         <tr>
 228           <td class="paramkey"></td>
 229           <td></td>
 230           <td class="paramtype">enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a>&#160;</td>
 231           <td class="paramname"><em>endianness</em>, </td>
 232         </tr>
 233         <tr>
 234           <td class="paramkey"></td>
 235           <td></td>
 236           <td class="paramtype">bool&#160;</td>
 237           <td class="paramname"><em>use_dma</em>&#160;</td>
 238         </tr>
 239         <tr>
 240           <td></td>
 241           <td>)</td>
 242           <td></td><td></td>
 243         </tr>
 244       </table>
 245   </td>
 246   <td class="mlabels-right">
 247 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 248   </tr>
 249 </table>
 250 </div><div class="memdoc">
 251
 252 <p>Start a SHA-256 calculation, blocking forever waiting until the SHA-256 hardware is available. </p>
 253 <p >Initialises the hardware and state ready to start a new SHA-256 calculation. Only one instance can be started at any time.</p>
 254 <dl class="params"><dt>Parameters</dt><dd>
 255   <table class="params">
 256     <tr><td class="paramname">state</td><td>A pointer to a pico_sha256_state_t instance </td></tr>
 257     <tr><td class="paramname">endianness</td><td>SHA256_BIG_ENDIAN or SHA256_LITTLE_ENDIAN for data in and data out </td></tr>
 258     <tr><td class="paramname">use_dma</td><td>Set to true to use DMA internally to copy data to hardware. This is quicker at the expense of hardware DMA resources. </td></tr>
 259   </table>
 260   </dd>
 261 </dl>
 262 <dl class="section return"><dt>Returns</dt><dd>Returns PICO_OK if the hardware was available for use and the sha256 calculation could be started, otherwise an error is returned </dd></dl>
 263
 264 </div>
 265 </div>
 266 <a id="ga6e6d3e0a3cb87e32a73757bcda88ebc1" name="ga6e6d3e0a3cb87e32a73757bcda88ebc1"></a>
 267 <h2 class="memtitle"><span class="permalink"><a href="#ga6e6d3e0a3cb87e32a73757bcda88ebc1">&#9670;&nbsp;</a></span>pico_sha256_start_blocking_until()</h2>
 268
 269 <div class="memitem">
 270 <div class="memproto">
 271       <table class="memname">
 272         <tr>
 273           <td class="memname">int pico_sha256_start_blocking_until </td>
 274           <td>(</td>
 275           <td class="paramtype"><a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *&#160;</td>
 276           <td class="paramname"><em>state</em>, </td>
 277         </tr>
 278         <tr>
 279           <td class="paramkey"></td>
 280           <td></td>
 281           <td class="paramtype">enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a>&#160;</td>
 282           <td class="paramname"><em>endianness</em>, </td>
 283         </tr>
 284         <tr>
 285           <td class="paramkey"></td>
 286           <td></td>
 287           <td class="paramtype">bool&#160;</td>
 288           <td class="paramname"><em>use_dma</em>, </td>
 289         </tr>
 290         <tr>
 291           <td class="paramkey"></td>
 292           <td></td>
 293           <td class="paramtype"><a class="el" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a>&#160;</td>
 294           <td class="paramname"><em>until</em>&#160;</td>
 295         </tr>
 296         <tr>
 297           <td></td>
 298           <td>)</td>
 299           <td></td><td></td>
 300         </tr>
 301       </table>
 302 </div><div class="memdoc">
 303
 304 <p>Start a SHA-256 calculation waiting for a defined period for the SHA-256 hardware to be available. </p>
 305 <p >Initialises the hardware and state ready to start a new SHA-256 calculation. Only one instance can be started at any time.</p>
 306 <dl class="params"><dt>Parameters</dt><dd>
 307   <table class="params">
 308     <tr><td class="paramname">state</td><td>A pointer to a pico_sha256_state_t instance </td></tr>
 309     <tr><td class="paramname">endianness</td><td>SHA256_BIG_ENDIAN or SHA256_LITTLE_ENDIAN for data in and data out </td></tr>
 310     <tr><td class="paramname">use_dma</td><td>Set to true to use DMA internally to copy data to hardware. This is quicker at the expense of hardware DMA resources. </td></tr>
 311     <tr><td class="paramname">until</td><td>How long to wait for the SHA hardware to be available </td></tr>
 312   </table>
 313   </dd>
 314 </dl>
 315 <dl class="section return"><dt>Returns</dt><dd>Returns PICO_OK if the hardware was available for use and the sha256 calculation could be started in time, otherwise an error is returned </dd></dl>
 316
 317 </div>
 318 </div>
 319 <a id="ga56a125e51ec616f61082cc63c8599dcb" name="ga56a125e51ec616f61082cc63c8599dcb"></a>
 320 <h2 class="memtitle"><span class="permalink"><a href="#ga56a125e51ec616f61082cc63c8599dcb">&#9670;&nbsp;</a></span>pico_sha256_try_start()</h2>
 321
 322 <div class="memitem">
 323 <div class="memproto">
 324       <table class="memname">
 325         <tr>
 326           <td class="memname">int pico_sha256_try_start </td>
 327           <td>(</td>
 328           <td class="paramtype"><a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *&#160;</td>
 329           <td class="paramname"><em>state</em>, </td>
 330         </tr>
 331         <tr>
 332           <td class="paramkey"></td>
 333           <td></td>
 334           <td class="paramtype">enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a>&#160;</td>
 335           <td class="paramname"><em>endianness</em>, </td>
 336         </tr>
 337         <tr>
 338           <td class="paramkey"></td>
 339           <td></td>
 340           <td class="paramtype">bool&#160;</td>
 341           <td class="paramname"><em>use_dma</em>&#160;</td>
 342         </tr>
 343         <tr>
 344           <td></td>
 345           <td>)</td>
 346           <td></td><td></td>
 347         </tr>
 348       </table>
 349 </div><div class="memdoc">
 350
 351 <p>Start a SHA-256 calculation returning immediately with an error if the SHA-256 hardware is not available. </p>
 352 <p >Initialises the hardware and state ready to start a new SHA-256 calculation. Only one instance can be started at any time.</p>
 353 <dl class="params"><dt>Parameters</dt><dd>
 354   <table class="params">
 355     <tr><td class="paramname">state</td><td>A pointer to a pico_sha256_state_t instance </td></tr>
 356     <tr><td class="paramname">endianness</td><td>SHA256_BIG_ENDIAN or SHA256_LITTLE_ENDIAN for data in and data out </td></tr>
 357     <tr><td class="paramname">use_dma</td><td>Set to true to use DMA internally to copy data to hardware. This is quicker at the expense of hardware DMA resources. </td></tr>
 358   </table>
 359   </dd>
 360 </dl>
 361 <dl class="section return"><dt>Returns</dt><dd>Returns PICO_OK if the hardware was available for use and the sha256 calculation could be started, otherwise an error is returned </dd></dl>
 362
 363 </div>
 364 </div>
 365 <a id="ga43c112e22aea468ce0551c5078e155cd" name="ga43c112e22aea468ce0551c5078e155cd"></a>
 366 <h2 class="memtitle"><span class="permalink"><a href="#ga43c112e22aea468ce0551c5078e155cd">&#9670;&nbsp;</a></span>pico_sha256_update()</h2>
 367
 368 <div class="memitem">
 369 <div class="memproto">
 370       <table class="memname">
 371         <tr>
 372           <td class="memname">void pico_sha256_update </td>
 373           <td>(</td>
 374           <td class="paramtype"><a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *&#160;</td>
 375           <td class="paramname"><em>state</em>, </td>
 376         </tr>
 377         <tr>
 378           <td class="paramkey"></td>
 379           <td></td>
 380           <td class="paramtype">const uint8_t *&#160;</td>
 381           <td class="paramname"><em>data</em>, </td>
 382         </tr>
 383         <tr>
 384           <td class="paramkey"></td>
 385           <td></td>
 386           <td class="paramtype">size_t&#160;</td>
 387           <td class="paramname"><em>data_size_bytes</em>&#160;</td>
 388         </tr>
 389         <tr>
 390           <td></td>
 391           <td>)</td>
 392           <td></td><td></td>
 393         </tr>
 394       </table>
 395 </div><div class="memdoc">
 396
 397 <p>Add byte data to be SHA-256 calculation. </p>
 398 <p >Add byte data to be SHA-256 calculation You may call this as many times as required to add all the data needed. You must have called pico_sha256_try_start (or equivalent) already.</p>
 399 <dl class="params"><dt>Parameters</dt><dd>
 400   <table class="params">
 401     <tr><td class="paramname">state</td><td>A pointer to a pico_sha256_state_t instance </td></tr>
 402     <tr><td class="paramname">data</td><td>Pointer to the data to be added to the calculation </td></tr>
 403     <tr><td class="paramname">data_size_bytes</td><td>Amount of data to add</td></tr>
 404   </table>
 405   </dd>
 406 </dl>
 407 <dl class="section note"><dt>Note</dt><dd>This function may return before the copy has completed in which case the data passed to the function must remain valid and unchanged until a further call to pico_sha256_update or pico_sha256_finish. If this is not done, corrupt data may be used for the SHA-256 calculation giving an unexpected result. </dd></dl>
 408
 409 </div>
 410 </div>
 411 <a id="ga9bf8472019386229c3ba3b6d169b9656" name="ga9bf8472019386229c3ba3b6d169b9656"></a>
 412 <h2 class="memtitle"><span class="permalink"><a href="#ga9bf8472019386229c3ba3b6d169b9656">&#9670;&nbsp;</a></span>pico_sha256_update_blocking()</h2>
 413
 414 <div class="memitem">
 415 <div class="memproto">
 416       <table class="memname">
 417         <tr>
 418           <td class="memname">void pico_sha256_update_blocking </td>
 419           <td>(</td>
 420           <td class="paramtype"><a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *&#160;</td>
 421           <td class="paramname"><em>state</em>, </td>
 422         </tr>
 423         <tr>
 424           <td class="paramkey"></td>
 425           <td></td>
 426           <td class="paramtype">const uint8_t *&#160;</td>
 427           <td class="paramname"><em>data</em>, </td>
 428         </tr>
 429         <tr>
 430           <td class="paramkey"></td>
 431           <td></td>
 432           <td class="paramtype">size_t&#160;</td>
 433           <td class="paramname"><em>data_size_bytes</em>&#160;</td>
 434         </tr>
 435         <tr>
 436           <td></td>
 437           <td>)</td>
 438           <td></td><td></td>
 439         </tr>
 440       </table>
 441 </div><div class="memdoc">
 442
 443 <p>Add byte data to be SHA-256 calculation. </p>
 444 <p >Add byte data to be SHA-256 calculation You may call this as many times as required to add all the data needed. You must have called pico_sha256_try_start already.</p>
 445 <dl class="params"><dt>Parameters</dt><dd>
 446   <table class="params">
 447     <tr><td class="paramname">state</td><td>A pointer to a pico_sha256_state_t instance </td></tr>
 448     <tr><td class="paramname">data</td><td>Pointer to the data to be added to the calculation </td></tr>
 449     <tr><td class="paramname">data_size_bytes</td><td>Amount of data to add</td></tr>
 450   </table>
 451   </dd>
 452 </dl>
 453 <dl class="section note"><dt>Note</dt><dd>This function will only return when the data passed in is no longer required, so it can be freed or changed on return. </dd></dl>
 454
 455 </div>
 456 </div>
 457 </div><!-- contents -->
 458 </div><!-- doc-content -->
 459
 460         <script src="main.js"></script>
 461 </body>
 462 </html>