m5/M5Unit-NFC
0
0
Fork 0
mirror of https://github.com/m5stack/M5Unit-NFC.git synced 2026-05-20 11:48:34 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
M5Unit-NFC/mifare_8cpp.html
T

323 lines
16 KiB
HTML
Raw Permalink 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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>M5Unit-NFC: src/nfc/a/mifare.cpp 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">M5Unit-NFC<span id="projectnumber">&#160;0.0.3 git rev:59f5362</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('mifare_8cpp.html',''); initResizable(true); });
/* @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">
<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 class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">mifare.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>MIFARE definitions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="mifare_8hpp_source.html">mifare.hpp</a>&quot;</code><br />
<code>#include &lt;cstring&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem5.html">m5</a></td></tr>
<tr class="memdesc:namespacem5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Top level namespace of M5stack. <br /></td></tr>
<tr class="separator:"><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:ae593ad8d9608d30bed275a3e33e8bcfa" id="r_ae593ad8d9608d30bed275a3e33e8bcfa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae593ad8d9608d30bed275a3e33e8bcfa">m5::nfc::a::mifare::classic::decode_value_block</a> (int32_t &amp;value, uint8_t &amp;addr, const uint8_t buf[16])</td></tr>
<tr class="memdesc:ae593ad8d9608d30bed275a3e33e8bcfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode the value of value block. <br /></td></tr>
<tr class="separator:ae593ad8d9608d30bed275a3e33e8bcfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0378982e28186360ac9eb38fa3128c3a" id="r_a0378982e28186360ac9eb38fa3128c3a"><td class="memItemLeft" align="right" valign="top">const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0378982e28186360ac9eb38fa3128c3a">m5::nfc::a::mifare::classic::encode_value_block</a> (uint8_t buf[16], const int32_t value, const uint8_t addr)</td></tr>
<tr class="memdesc:a0378982e28186360ac9eb38fa3128c3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode the value of value block. <br /></td></tr>
<tr class="separator:a0378982e28186360ac9eb38fa3128c3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf7a51fcc17ccc900b3fbdcf26b585d2" id="r_abf7a51fcc17ccc900b3fbdcf26b585d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abf7a51fcc17ccc900b3fbdcf26b585d2">m5::nfc::a::mifare::classic::encode_access_bits</a> (uint8_t abits[3], const uint8_t p0, const uint8_t p1, const uint8_t p2, const uint8_t p3)</td></tr>
<tr class="memdesc:abf7a51fcc17ccc900b3fbdcf26b585d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode access bits from permissions. <br /></td></tr>
<tr class="separator:abf7a51fcc17ccc900b3fbdcf26b585d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac16996d9234a9a5fc2467a4925d30142" id="r_ac16996d9234a9a5fc2467a4925d30142"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac16996d9234a9a5fc2467a4925d30142">m5::nfc::a::mifare::classic::decode_access_bits</a> (uint8_t permissions[4], const uint8_t ab0, const uint8_t ab1, const uint8_t ab2)</td></tr>
<tr class="memdesc:ac16996d9234a9a5fc2467a4925d30142"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode access bits to permissions. <br /></td></tr>
<tr class="separator:ac16996d9234a9a5fc2467a4925d30142"><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>MIFARE definitions. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ac16996d9234a9a5fc2467a4925d30142" name="ac16996d9234a9a5fc2467a4925d30142"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac16996d9234a9a5fc2467a4925d30142">&#9670;&#160;</a></span>decode_access_bits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool m5::nfc::a::mifare::classic::decode_access_bits </td>
<td>(</td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>permissions</em></span>[4], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>ab0</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>ab1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>ab2</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode access bits to permissions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">permissions[4]</td><td>Output buffer at least 4 bytes </td></tr>
<tr><td class="paramname">ab0</td><td>1st byte of the access bits </td></tr>
<tr><td class="paramname">ab1</td><td>2nd byte of the access bits </td></tr>
<tr><td class="paramname">ab2</td><td>3rd byte of the access bits </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful </dd></dl>
<dl class="section note"><dt>Note</dt><dd>permissions[0] block 0 </dd>
<dd>
permissions[1] block 1 </dd>
<dd>
permissions[2] block 2 </dd>
<dd>
permissions[3] sector trailer </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Return values should always be checked </dd></dl>
</div>
</div>
<a id="ae593ad8d9608d30bed275a3e33e8bcfa" name="ae593ad8d9608d30bed275a3e33e8bcfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae593ad8d9608d30bed275a3e33e8bcfa">&#9670;&#160;</a></span>decode_value_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool m5::nfc::a::mifare::classic::decode_value_block </td>
<td>(</td>
<td class="paramtype">int32_t &amp;</td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t &amp;</td> <td class="paramname"><span class="paramname"><em>addr</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>buf</em></span>[16]&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode the value of value block. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>Value </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">addr</td><td>Block address </td></tr>
<tr><td class="paramdir"></td><td class="paramname">buf</td><td>Data of block(16 bytes) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful </dd></dl>
</div>
</div>
<a id="abf7a51fcc17ccc900b3fbdcf26b585d2" name="abf7a51fcc17ccc900b3fbdcf26b585d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf7a51fcc17ccc900b3fbdcf26b585d2">&#9670;&#160;</a></span>encode_access_bits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool m5::nfc::a::mifare::classic::encode_access_bits </td>
<td>(</td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>abits</em></span>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>p0</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>p1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>p2</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>p3</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode access bits from permissions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">abits[3]</td><td>Output buffer at least 3 bytes </td></tr>
<tr><td class="paramname">p0</td><td>permissions for block 0 </td></tr>
<tr><td class="paramname">p1</td><td>permissions for block 1 </td></tr>
<tr><td class="paramname">p2</td><td>permissions for block 2 </td></tr>
<tr><td class="paramname">p3</td><td>permissions for sector tarailer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Return values should always be checked </dd>
<dd>
Writing incorrect access bits may make the sector inaccessible! </dd></dl>
</div>
</div>
<a id="a0378982e28186360ac9eb38fa3128c3a" name="a0378982e28186360ac9eb38fa3128c3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0378982e28186360ac9eb38fa3128c3a">&#9670;&#160;</a></span>encode_value_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t * m5::nfc::a::mifare::classic::encode_value_block </td>
<td>(</td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>buf</em></span>[16], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int32_t</td> <td class="paramname"><span class="paramname"><em>value</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t</td> <td class="paramname"><span class="paramname"><em>addr</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode the value of value block. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Output buffer at least 16 bytes </td></tr>
<tr><td class="paramdir"></td><td class="paramname">value</td><td>Value </td></tr>
<tr><td class="paramdir"></td><td class="paramname">addr</td><td>Block address </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Encoded buffer </dd></dl>
</div>
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_59410e1461a4f8107dcbc9b19538c327.html">nfc</a></li><li class="navelem"><a class="el" href="dir_f85cf2582a8a5aef89f310f924dcae95.html">a</a></li><li class="navelem"><a class="el" href="mifare_8cpp.html">mifare.cpp</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.11.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink