Files
test/doc/Doxygen/html/sdrv__crypto__mailbox__ske__xts_8h.html
2025-11-07 20:19:23 +08:00

273 lines
13 KiB
HTML

<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SemiDrive SSDK Appication Program Interface: Z:/01-Code/06-SSDK-DEV-Firewall/ssdk/drivers/include/crypto/mailbox/sdrv_crypto_mailbox_ske_xts.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="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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">SemiDrive SSDK Appication Program Interface<span id="projectnumber">&#160;PTG3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_ee023d43c33bfccc31aa50a48a76892b.html">include</a></li><li class="navelem"><a class="el" href="dir_e08589e132e001d864753e5516cdc279.html">crypto</a></li><li class="navelem"><a class="el" href="dir_f7beecef409612ffb7ee2f98c8e6b0b6.html">mailbox</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sdrv_crypto_mailbox_ske_xts.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="sdrv__crypto__mailbox__common_8h_source.html">sdrv_crypto_mailbox_common.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="sdrv__crypto__mailbox__ske__basic_8h_source.html">sdrv_crypto_mailbox_ske_basic.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="sdrv__crypto__mailbox__trng_8h_source.html">sdrv_crypto_mailbox_trng.h</a>&quot;</code><br />
</div>
<p><a href="sdrv__crypto__mailbox__ske__xts_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 id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa244248c85df4712a7b13e388c51c830"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__crypto__mailbox__ske__xts_8h.html#aa244248c85df4712a7b13e388c51c830">cmd_ske_xts_enc</a> (uint8_t mode, uint8_t *plain, uint32_t bytelen, <a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a> key_type, uint8_t *key, uint16_t key_id, uint8_t *iv, uint8_t *cipher, uint8_t *mac_buf)</td></tr>
<tr class="separator:aa244248c85df4712a7b13e388c51c830"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9a189f39842f3d305db314008ac1ee9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__crypto__mailbox__ske__xts_8h.html#af9a189f39842f3d305db314008ac1ee9">cmd_ske_xts_dec</a> (uint8_t mode, uint8_t *replain, <a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a> key_type, uint8_t *key, uint16_t key_id, uint8_t *iv, uint8_t *cipher, uint32_t cipherbytelen, uint8_t *mac_buf)</td></tr>
<tr class="separator:af9a189f39842f3d305db314008ac1ee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2021 Semidrive Semiconductor. All rights reserved. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="af9a189f39842f3d305db314008ac1ee9" name="af9a189f39842f3d305db314008ac1ee9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9a189f39842f3d305db314008ac1ee9">&#9670;&nbsp;</a></span>cmd_ske_xts_dec()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a> cmd_ske_xts_dec </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>replain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a>&#160;</td>
<td class="paramname"><em>key_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>key_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>iv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>cipher</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>cipherbytelen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>mac_buf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get device info </p>
<p >This function get ehsm device info.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>ske mode </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">replain</td><td>replain buff </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_type</td><td>enc key type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>enc key buff </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_id</td><td>enc key id </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">iv</td><td>iv buff </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cipher</td><td>out buff </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cipherbytelen</td><td>cipher bytelen </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mac_buf</td><td>mac buff </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CMD_RETURN_SUCCESS or error code. </dd></dl>
</div>
</div>
<a id="aa244248c85df4712a7b13e388c51c830" name="aa244248c85df4712a7b13e388c51c830"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa244248c85df4712a7b13e388c51c830">&#9670;&nbsp;</a></span>cmd_ske_xts_enc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__crypto__utility_8h.html#aa5bd0c76afac3bcab03732f2e64ab19a">sdrv_crypto_error_status_e</a> cmd_ske_xts_enc </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>plain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>bytelen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__crypto__mailbox__common_8h.html#aa9a594b8daf0a5c6b1c6ca6c81083419">cmd_key_type_e</a>&#160;</td>
<td class="paramname"><em>key_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>key_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>iv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>cipher</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>mac_buf</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>ske xts enc </p>
<p >This function ske xts enc</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>ske mode </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">plain</td><td>plain buff </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bytelen</td><td>plain bytelen </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_type</td><td>enc key type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>enc key buff </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key_id</td><td>enc key id </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">iv</td><td>iv buff </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cipher</td><td>out buff </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mac_buf</td><td>mac buff </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CMD_RETURN_SUCCESS or error code. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>