Linaro Git Browser
Code Review Sign In
review.linaro.org / lng / odp-dpdk / refs/heads/gh-pages / . / platform-api-guide / spec_2crypto_8h.html
blob: 7d5dcc239b3e36759229c90a8e19479ac007068e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>API Reference Manual for linux-dpdk: crypto.h File Reference</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>
<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.css" rel="stylesheet" type="text/css" />
<link href="odpdoxygen.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"><img alt="Logo" src="ODP-Logo-HQ.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">API Reference Manual for linux-dpdk
&#160;<span id="projectnumber">1.47.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('spec_2crypto_8h.html',''); initResizable(); });
/* @license-end */
</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">spec/crypto.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>ODP crypto.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;odp/visibility_begin.h&gt;</code><br />
<code>#include &lt;<a class="el" href="crypto__types_8h_source.html">odp/api/crypto_types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="packet__types_8h_source.html">odp/api/packet_types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="std__types_8h_source.html">odp/api/std_types.h</a>&gt;</code><br />
<code>#include &lt;odp/visibility_end.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for spec/crypto.h:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="spec_2crypto_8h__incl.svg" width="2560" height="1559"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="spec_2crypto_8h__dep__incl.svg" width="86" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
<p><a href="spec_2crypto_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga53075378e866aaa5799a742ca7e7ace8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga53075378e866aaa5799a742ca7e7ace8">odp_crypto_capability</a> (<a class="el" href="structodp__crypto__capability__t.html">odp_crypto_capability_t</a> *capa)</td></tr>
<tr class="memdesc:ga53075378e866aaa5799a742ca7e7ace8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query crypto capabilities. <a href="group__odp__crypto.html#ga53075378e866aaa5799a742ca7e7ace8">More...</a><br /></td></tr>
<tr class="separator:ga53075378e866aaa5799a742ca7e7ace8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e4c5cadb81c5e4a0665b8ecd0758b47"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga1e4c5cadb81c5e4a0665b8ecd0758b47">odp_crypto_cipher_capability</a> (<a class="el" href="group__odp__crypto.html#ga3c943d596daa203f2c71263ad4386ff0">odp_cipher_alg_t</a> cipher, <a class="el" href="structodp__crypto__cipher__capability__t.html">odp_crypto_cipher_capability_t</a> capa[], int num)</td></tr>
<tr class="memdesc:ga1e4c5cadb81c5e4a0665b8ecd0758b47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query supported cipher algorithm capabilities. <a href="group__odp__crypto.html#ga1e4c5cadb81c5e4a0665b8ecd0758b47">More...</a><br /></td></tr>
<tr class="separator:ga1e4c5cadb81c5e4a0665b8ecd0758b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaecb3a84f187e0bf136eb786cdf36a1d5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#gaecb3a84f187e0bf136eb786cdf36a1d5">odp_crypto_auth_capability</a> (<a class="el" href="group__odp__crypto.html#ga97ed3811136cd7888625a4973c416982">odp_auth_alg_t</a> auth, <a class="el" href="structodp__crypto__auth__capability__t.html">odp_crypto_auth_capability_t</a> capa[], int num)</td></tr>
<tr class="memdesc:gaecb3a84f187e0bf136eb786cdf36a1d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query supported authentication algorithm capabilities. <a href="group__odp__crypto.html#gaecb3a84f187e0bf136eb786cdf36a1d5">More...</a><br /></td></tr>
<tr class="separator:gaecb3a84f187e0bf136eb786cdf36a1d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70afc4b718ae91adc1e7f63da67af227"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga70afc4b718ae91adc1e7f63da67af227">odp_crypto_session_create</a> (const <a class="el" href="structodp__crypto__session__param__t.html">odp_crypto_session_param_t</a> *param, <a class="el" href="group__odp__crypto.html#ga63d32133107ee9c7cfe42b81ecc829d3">odp_crypto_session_t</a> *session, <a class="el" href="group__odp__crypto.html#gaa0dbfc50971a860e9b936fb931ebfbdf">odp_crypto_ses_create_err_t</a> *status)</td></tr>
<tr class="memdesc:ga70afc4b718ae91adc1e7f63da67af227"><td class="mdescLeft">&#160;</td><td class="mdescRight">Crypto session creation. <a href="group__odp__crypto.html#ga70afc4b718ae91adc1e7f63da67af227">More...</a><br /></td></tr>
<tr class="separator:ga70afc4b718ae91adc1e7f63da67af227"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b16b06aba57de266c937442ce1897e3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga8b16b06aba57de266c937442ce1897e3">odp_crypto_session_destroy</a> (<a class="el" href="group__odp__crypto.html#ga63d32133107ee9c7cfe42b81ecc829d3">odp_crypto_session_t</a> session)</td></tr>
<tr class="memdesc:ga8b16b06aba57de266c937442ce1897e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Crypto session destroy. <a href="group__odp__crypto.html#ga8b16b06aba57de266c937442ce1897e3">More...</a><br /></td></tr>
<tr class="separator:ga8b16b06aba57de266c937442ce1897e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae2c587b49a9b2e8b2764b29925f6f04c"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#gae2c587b49a9b2e8b2764b29925f6f04c">odp_crypto_session_to_u64</a> (<a class="el" href="group__odp__crypto.html#ga63d32133107ee9c7cfe42b81ecc829d3">odp_crypto_session_t</a> hdl)</td></tr>
<tr class="memdesc:gae2c587b49a9b2e8b2764b29925f6f04c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get printable value for an odp_crypto_session_t. <a href="group__odp__crypto.html#gae2c587b49a9b2e8b2764b29925f6f04c">More...</a><br /></td></tr>
<tr class="separator:gae2c587b49a9b2e8b2764b29925f6f04c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ed42013367bf22f400a5a0966dcf7ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga5ed42013367bf22f400a5a0966dcf7ee">odp_crypto_session_param_init</a> (<a class="el" href="structodp__crypto__session__param__t.html">odp_crypto_session_param_t</a> *param)</td></tr>
<tr class="memdesc:ga5ed42013367bf22f400a5a0966dcf7ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize crypto session parameters. <a href="group__odp__crypto.html#ga5ed42013367bf22f400a5a0966dcf7ee">More...</a><br /></td></tr>
<tr class="separator:ga5ed42013367bf22f400a5a0966dcf7ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabd3f8c7dfb77994be2f0dd06be934d5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__odp__packet.html#gae0641dfc3b74aabd61154e24419e35a6">odp_packet_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#gabd3f8c7dfb77994be2f0dd06be934d5a">odp_crypto_packet_from_event</a> (<a class="el" href="group__odp__event.html#ga51942509e0d072db63a565cbc1e7204d">odp_event_t</a> ev)</td></tr>
<tr class="memdesc:gabd3f8c7dfb77994be2f0dd06be934d5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return crypto processed packet that is associated with event. <a href="group__odp__crypto.html#gabd3f8c7dfb77994be2f0dd06be934d5a">More...</a><br /></td></tr>
<tr class="separator:gabd3f8c7dfb77994be2f0dd06be934d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga752f3b93bbabf8f5d1574b09c9ddbd7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__odp__event.html#ga51942509e0d072db63a565cbc1e7204d">odp_event_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga752f3b93bbabf8f5d1574b09c9ddbd7b">odp_crypto_packet_to_event</a> (<a class="el" href="group__odp__packet.html#gae0641dfc3b74aabd61154e24419e35a6">odp_packet_t</a> pkt)</td></tr>
<tr class="memdesc:ga752f3b93bbabf8f5d1574b09c9ddbd7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert crypto packet handle to event. <a href="group__odp__crypto.html#ga752f3b93bbabf8f5d1574b09c9ddbd7b">More...</a><br /></td></tr>
<tr class="separator:ga752f3b93bbabf8f5d1574b09c9ddbd7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7c10b3aeaa5429d1c7480249489b9392"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga7c10b3aeaa5429d1c7480249489b9392">odp_crypto_result</a> (<a class="el" href="structodp__crypto__packet__result__t.html">odp_crypto_packet_result_t</a> *result, <a class="el" href="group__odp__packet.html#gae0641dfc3b74aabd61154e24419e35a6">odp_packet_t</a> packet)</td></tr>
<tr class="memdesc:ga7c10b3aeaa5429d1c7480249489b9392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get crypto operation results from a crypto processed packet. <a href="group__odp__crypto.html#ga7c10b3aeaa5429d1c7480249489b9392">More...</a><br /></td></tr>
<tr class="separator:ga7c10b3aeaa5429d1c7480249489b9392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ff48da2115213ff59a478c0f989c3a7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#ga8ff48da2115213ff59a478c0f989c3a7">odp_crypto_op</a> (const <a class="el" href="group__odp__packet.html#gae0641dfc3b74aabd61154e24419e35a6">odp_packet_t</a> pkt_in[], <a class="el" href="group__odp__packet.html#gae0641dfc3b74aabd61154e24419e35a6">odp_packet_t</a> pkt_out[], const <a class="el" href="structodp__crypto__packet__op__param__t.html">odp_crypto_packet_op_param_t</a> param[], int num_pkt)</td></tr>
<tr class="memdesc:ga8ff48da2115213ff59a478c0f989c3a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Crypto packet operation. <a href="group__odp__crypto.html#ga8ff48da2115213ff59a478c0f989c3a7">More...</a><br /></td></tr>
<tr class="separator:ga8ff48da2115213ff59a478c0f989c3a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad7382b0187f8d3704c814b40e3e0adac"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__odp__crypto.html#gad7382b0187f8d3704c814b40e3e0adac">odp_crypto_op_enq</a> (const <a class="el" href="group__odp__packet.html#gae0641dfc3b74aabd61154e24419e35a6">odp_packet_t</a> pkt_in[], const <a class="el" href="group__odp__packet.html#gae0641dfc3b74aabd61154e24419e35a6">odp_packet_t</a> pkt_out[], const <a class="el" href="structodp__crypto__packet__op__param__t.html">odp_crypto_packet_op_param_t</a> param[], int num_pkt)</td></tr>
<tr class="memdesc:gad7382b0187f8d3704c814b40e3e0adac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Crypto packet operation. <a href="group__odp__crypto.html#gad7382b0187f8d3704c814b40e3e0adac">More...</a><br /></td></tr>
<tr class="separator:gad7382b0187f8d3704c814b40e3e0adac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>ODP crypto. </p>
<p class="definition">Definition in file <a class="el" href="spec_2crypto_8h_source.html">spec/crypto.h</a>.</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_a97ec78d987d17ef5986981beb9a2005.html">odp</a></li><li class="navelem"><a class="el" href="dir_be9f6d876b8eda462084eff1b3ea4553.html">api</a></li><li class="navelem"><a class="el" href="dir_6c22a75485a92e225a6a44114cdc818e.html">spec</a></li><li class="navelem"><a class="el" href="spec_2crypto_8h.html">crypto.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>