Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
p64_utils/docs/p64_utils_api_reference_manual/html/group__random.html
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
163 lines (158 sloc)
8.61 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!-- HTML header for doxygen 1.8.13--> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> | |
| <meta name="generator" content="Doxygen 1.8.13"/> | |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | |
| <title>PSoC64 Secure Boot Utilities Middleware Library 1.0: Random generation</title> | |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | |
| <script type="text/javascript" src="jquery.js"></script> | |
| <script type="text/javascript" src="dynsections.js"></script> | |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> | |
| <script type="text/javascript" src="resize.js"></script> | |
| <script type="text/javascript" src="navtreedata.js"></script> | |
| <script type="text/javascript" src="navtree.js"></script> | |
| <script type="text/javascript"> | |
| $(document).ready(initResizable); | |
| </script> | |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | |
| <script type="text/javascript" src="search/searchdata.js"></script> | |
| <script type="text/javascript" src="search/search.js"></script> | |
| <link href="doxygen_style.css" rel="stylesheet" type="text/css" /> | |
| </head> | |
| <body> | |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | |
| <div id="titlearea"> | |
| <table cellspacing="0" cellpadding="0"> | |
| <tbody> | |
| <tr style="height: 56px;"> | |
| <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td> | |
| <td id="projectalign" style="padding-left: 0.5em;"> | |
| <div id="projectname">PSoC64 Secure Boot Utilities Middleware Library 1.0</div> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| <!-- end header part --> | |
| <!-- Generated by Doxygen 1.8.13 --> | |
| <script type="text/javascript"> | |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); | |
| </script> | |
| <script type="text/javascript" src="menudata.js"></script> | |
| <script type="text/javascript" src="menu.js"></script> | |
| <script type="text/javascript"> | |
| $(function() { | |
| initMenu('',true,false,'search.php','Search'); | |
| $(document).ready(function() { init_search(); }); | |
| }); | |
| </script> | |
| <div id="main-nav"></div> | |
| </div><!-- top --> | |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> | |
| <div id="nav-tree"> | |
| <div id="nav-tree-contents"> | |
| <div id="nav-sync" class="sync"></div> | |
| </div> | |
| </div> | |
| <div id="splitbar" style="-moz-user-select:none;" | |
| class="ui-resizable-handle"> | |
| </div> | |
| </div> | |
| <script type="text/javascript"> | |
| $(document).ready(function(){initNavTree('group__random.html','');}); | |
| </script> | |
| <div id="doc-content"> | |
| <!-- window showing the filter options --> | |
| <div id="MSearchSelectWindow" | |
| onmouseover="return searchBox.OnSearchSelectShow()" | |
| onmouseout="return searchBox.OnSearchSelectHide()" | |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | |
| </div> | |
| <!-- iframe showing the search results (closed by default) --> | |
| <div id="MSearchResultsWindow"> | |
| <iframe src="javascript:void(0)" frameborder="0" | |
| name="MSearchResults" id="MSearchResults"> | |
| </iframe> | |
| </div> | |
| <div class="header"> | |
| <div class="summary"> | |
| <a href="#func-members">Functions</a> </div> | |
| <div class="headertitle"> | |
| <div class="title">Random generation<div class="ingroups"><a class="el" href="group__psacrypto.html">PSA crypto</a></div></div> </div> | |
| </div><!--header--> | |
| <div class="contents"> | |
| <a name="details" id="details"></a><h2 class="groupheader">General Description</h2> | |
| <table class="memberdecls"> | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> | |
| Functions</h2></td></tr> | |
| <tr class="memitem:ga7b5eb4e37667f453f912f51963bfbf49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__psacrypto__error.html#gae79cfe5e478f111f9f93e5d7e69d5e2a">cy_p64_psa_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__random.html#ga7b5eb4e37667f453f912f51963bfbf49">cy_p64_psa_generate_random</a> (uint8_t *output, size_t output_size)</td></tr> | |
| <tr class="memdesc:ga7b5eb4e37667f453f912f51963bfbf49"><td class="mdescLeft"> </td><td class="mdescRight">Generates random bytes. <a href="#ga7b5eb4e37667f453f912f51963bfbf49">More...</a><br /></td></tr> | |
| <tr class="separator:ga7b5eb4e37667f453f912f51963bfbf49"><td class="memSeparator" colspan="2"> </td></tr> | |
| </table> | |
| <h2 class="groupheader">Function Documentation</h2> | |
| <a id="ga7b5eb4e37667f453f912f51963bfbf49"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga7b5eb4e37667f453f912f51963bfbf49">◆ </a></span>cy_p64_psa_generate_random()</h2> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname"><a class="el" href="group__psacrypto__error.html#gae79cfe5e478f111f9f93e5d7e69d5e2a">cy_p64_psa_status_t</a> cy_p64_psa_generate_random </td> | |
| <td>(</td> | |
| <td class="paramtype">uint8_t * </td> | |
| <td class="paramname"><em>output</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">size_t </td> | |
| <td class="paramname"><em>output_size</em> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td> | |
| </tr> | |
| </table> | |
| </div><div class="memdoc"> | |
| <p>Generates random bytes. </p> | |
| <dl class="section warning"><dt>Warning</dt><dd>This function <b>can</b> fail! Callers MUST check the return status and MUST NOT use the content of the output buffer if the return status is not <a class="el" href="group__psacrypto__error.html#gabf57808e9787a7f482bdfc8a1b377685" title="The action was completed successfully. ">CY_P64_PSA_SUCCESS</a>.</dd></dl> | |
| <dl class="section note"><dt>Note</dt><dd>To generate a key, use <a class="el" href="group__import__export.html#ga93ee3c9c700505b08fc93c2136210fb7" title="Generates a key or key pair. ">cy_p64_psa_generate_key()</a> instead.</dd></dl> | |
| <dl class="params"><dt>Parameters</dt><dd> | |
| <table class="params"> | |
| <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>The output buffer for the generated data. </td></tr> | |
| <tr><td class="paramdir"></td><td class="paramname">output_size</td><td>The number of bytes to generate and output.</td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| <dl class="retval"><dt>Return values</dt><dd> | |
| <table class="retval"> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#gabf57808e9787a7f482bdfc8a1b377685" title="The action was completed successfully. ">CY_P64_PSA_SUCCESS</a></td><td></td></tr> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#ga0acb01b82422b2aef20c543f38622bf2" title="The requested operation or a parameter is not supported by this implementation. ">CY_P64_PSA_ERROR_NOT_SUPPORTED</a></td><td></td></tr> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#ga1cb05698d52a61c151eda07c94bc7111" title="There is not enough entropy to generate random data needed for the requested action. ">CY_P64_PSA_ERROR_INSUFFICIENT_ENTROPY</a></td><td></td></tr> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#gaa209f7289e4f7ccf07c693e99638e0c3" title="There is not enough runtime memory. ">CY_P64_PSA_ERROR_INSUFFICIENT_MEMORY</a></td><td></td></tr> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#ga90493ef15f5b8e005f8d9ec1cf5d28a2" title="There was a communication failure inside the implementation. ">CY_P64_PSA_ERROR_COMMUNICATION_FAILURE</a></td><td></td></tr> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#gaa48736089fd7ef40a370948e6e2160da" title="A hardware failure was detected. ">CY_P64_PSA_ERROR_HARDWARE_FAILURE</a></td><td></td></tr> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#gaee7005bec37e7c8b61cf07800c8252ff" title="A tampering attempt was detected. ">CY_P64_PSA_ERROR_CORRUPTION_DETECTED</a></td><td></td></tr> | |
| <tr><td class="paramname"><a class="el" href="group__psacrypto__error.html#gae5c7844defdf120d28efb745183538b9" title="The requested action cannot be performed in the current state. ">CY_P64_PSA_ERROR_BAD_STATE</a></td><td>It is implementation-dependent whether initialize results fails in this error code. </td></tr> | |
| </table> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| </div><!-- contents --> | |
| </div><!-- doc-content --> | |
| <!-- start footer part | |
| <div id="nav-path" class="navpath"> | |
| <ul> | |
| <li class="footer"> | |
| Generated for <b>PSoC64 Secure Boot Utilities Middleware Library 1.0</b> by <b>Cypress Semiconductor Corporation</b>. | |
| All rights reserved. | |
| </li> | |
| </ul> | |
| </div> | |
| --> | |
| </body> | |
| </html> |