mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 12:32:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
bf00061749
libnx/crc_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

286 lines
14 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/crypto/crc.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">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_2874fbf892ad5b8020be2442f929b820.html">crypto</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">crc.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Hardware accelerated CRC32 implementation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;arm_acle.h&gt;</code><br />
<code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
</div>
<p><a href="crc_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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a33ee8ec046c08401fef0348232ff285e" id="r_a33ee8ec046c08401fef0348232ff285e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="crc_8h.html#a33ee8ec046c08401fef0348232ff285e">_CRC_ALIGN</a>(sz, insn)</td></tr>
<tr class="separator:a33ee8ec046c08401fef0348232ff285e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48199fc7d132c14bd429cf5d446b57e1" id="r_a48199fc7d132c14bd429cf5d446b57e1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="crc_8h.html#a48199fc7d132c14bd429cf5d446b57e1">_CRC_REMAINDER</a>(sz, insn)</td></tr>
<tr class="separator:a48199fc7d132c14bd429cf5d446b57e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aa47ab1950a51ac32d46db792a70d388a" id="r_aa47ab1950a51ac32d46db792a70d388a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="crc_8h.html#aa47ab1950a51ac32d46db792a70d388a">crc32CalculateWithSeed</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> seed, const void *src, size_t size)</td></tr>
<tr class="memdesc:aa47ab1950a51ac32d46db792a70d388a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a CRC32 over data using a seed. <br /></td></tr>
<tr class="separator:aa47ab1950a51ac32d46db792a70d388a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39711a596fc1d60810083e0372627213" id="r_a39711a596fc1d60810083e0372627213"><td class="memItemLeft" align="right" valign="top"><a id="a39711a596fc1d60810083e0372627213" name="a39711a596fc1d60810083e0372627213"></a>
static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><b>crc32Calculate</b> (const void *src, size_t size)</td></tr>
<tr class="memdesc:a39711a596fc1d60810083e0372627213"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a CRC32 over data. <br /></td></tr>
<tr class="separator:a39711a596fc1d60810083e0372627213"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32bf313f736b1157443aecb75d8a83fa" id="r_a32bf313f736b1157443aecb75d8a83fa"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="crc_8h.html#a32bf313f736b1157443aecb75d8a83fa">crc32cCalculateWithSeed</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> seed, const void *src, size_t size)</td></tr>
<tr class="memdesc:a32bf313f736b1157443aecb75d8a83fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a CRC32C over data using a seed. <br /></td></tr>
<tr class="separator:a32bf313f736b1157443aecb75d8a83fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90effd9b7421ac72c4a7f00740969be7" id="r_a90effd9b7421ac72c4a7f00740969be7"><td class="memItemLeft" align="right" valign="top"><a id="a90effd9b7421ac72c4a7f00740969be7" name="a90effd9b7421ac72c4a7f00740969be7"></a>
static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><b>crc32cCalculate</b> (const void *src, size_t size)</td></tr>
<tr class="memdesc:a90effd9b7421ac72c4a7f00740969be7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate a CRC32C over data. <br /></td></tr>
<tr class="separator:a90effd9b7421ac72c4a7f00740969be7"><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>Hardware accelerated CRC32 implementation. </p>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a33ee8ec046c08401fef0348232ff285e" name="a33ee8ec046c08401fef0348232ff285e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33ee8ec046c08401fef0348232ff285e">&#9670;&#160;</a></span>_CRC_ALIGN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _CRC_ALIGN</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">sz, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">insn&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div>
<div class="line"> if (((uintptr_t)src_u8 &amp; <span class="keyword">sizeof</span>(sz)) &amp;&amp; (<a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>)len &gt;= <span class="keyword">sizeof</span>(sz)) { \</div>
<div class="line"> crc = __crc32##insn(crc, *((<span class="keyword">const</span> sz *)src_u8)); \</div>
<div class="line"> src_u8 += <span class="keyword">sizeof</span>(sz); \</div>
<div class="line"> len -= <span class="keyword">sizeof</span>(sz); \</div>
<div class="line"> } \</div>
<div class="line">} <span class="keywordflow">while</span> (0)</div>
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a48199fc7d132c14bd429cf5d446b57e1" name="a48199fc7d132c14bd429cf5d446b57e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48199fc7d132c14bd429cf5d446b57e1">&#9670;&#160;</a></span>_CRC_REMAINDER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define _CRC_REMAINDER</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">sz, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">insn&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div>
<div class="line"> if (len &amp; <span class="keyword">sizeof</span>(sz)) { \</div>
<div class="line"> crc = __crc32##insn(crc, *((<span class="keyword">const</span> sz *)src_u8)); \</div>
<div class="line"> src_u8 += <span class="keyword">sizeof</span>(sz); \</div>
<div class="line"> } \</div>
<div class="line">} <span class="keywordflow">while</span> (0)</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa47ab1950a51ac32d46db792a70d388a" name="aa47ab1950a51ac32d46db792a70d388a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa47ab1950a51ac32d46db792a70d388a">&#9670;&#160;</a></span>crc32CalculateWithSeed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> crc32CalculateWithSeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>seed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate a CRC32 over data using a seed. </p>
<p>Can be used to calculate a CRC32 in chunks using an initial seed of zero for the first chunk. </p>
</div>
</div>
<a id="a32bf313f736b1157443aecb75d8a83fa" name="a32bf313f736b1157443aecb75d8a83fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32bf313f736b1157443aecb75d8a83fa">&#9670;&#160;</a></span>crc32cCalculateWithSeed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> crc32cCalculateWithSeed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>seed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate a CRC32C over data using a seed. </p>
<p>Can be used to calculate a CRC32C in chunks using an initial seed of zero for the first chunk. </p>
</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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink