830 lines
55 KiB
HTML
830 lines
55 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=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/services/nfc.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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libctru
|
|
 <span id="projectnumber">v2.4.1</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&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&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>
|
|
<!-- 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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">nfc.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>NFC service.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="nfc_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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNFC__TagInfo.html">NFC_TagInfo</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNFC__AmiiboSettings.html">NFC_AmiiboSettings</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">AmiiboSettings structure, see also here: <a href="https://3dbrew.org/wiki/NFC:GetAmiiboSettings">https://3dbrew.org/wiki/NFC:GetAmiiboSettings</a>. <a href="structNFC__AmiiboSettings.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNFC__AmiiboConfig.html">NFC_AmiiboConfig</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">AmiiboConfig structure, see also here: <a href="https://3dbrew.org/wiki/NFC:GetAmiiboConfig">https://3dbrew.org/wiki/NFC:GetAmiiboConfig</a>. <a href="structNFC__AmiiboConfig.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNFC__AppDataInitStruct.html">NFC_AppDataInitStruct</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Used by <a class="el" href="nfc_8h.html#adba9904e5419fd1116639802ee4f3976" title="This initializes the appdata using the specified input, when the appdata previously wasn't initialize...">nfcInitializeWriteAppData()</a> internally, see also here: <a href="https://3dbrew.org/wiki/NFC:GetAppDataInitStruct">https://3dbrew.org/wiki/NFC:GetAppDataInitStruct</a>. <a href="structNFC__AppDataInitStruct.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNFC__AppDataWriteStruct.html">NFC_AppDataWriteStruct</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Used by <a class="el" href="nfc_8h.html#ae123ea01db425b1a36f3d423a058f3a3" title="Writes the appdata, after nfcOpenAppData() was used successfully.">nfcWriteAppData()</a> internally, see also: <a href="https://3dbrew.org/wiki/NFC:WriteAppData">https://3dbrew.org/wiki/NFC:WriteAppData</a>. <a href="structNFC__AppDataWriteStruct.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ad13ff10463dc54dafdb68fe33f97fa72"><td class="memItemLeft" align="right" valign="top"><a id="ad13ff10463dc54dafdb68fe33f97fa72"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#ad13ff10463dc54dafdb68fe33f97fa72">NFC_ERR_INVALID_STATE</a>   0xC8A17600</td></tr>
|
|
<tr class="memdesc:ad13ff10463dc54dafdb68fe33f97fa72"><td class="mdescLeft"> </td><td class="mdescRight">This is returned when the current state is invalid for this command. <br /></td></tr>
|
|
<tr class="separator:ad13ff10463dc54dafdb68fe33f97fa72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a874ef45433da4582948a692fab7225ba"><td class="memItemLeft" align="right" valign="top"><a id="a874ef45433da4582948a692fab7225ba"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a874ef45433da4582948a692fab7225ba">NFC_ERR_APPDATA_UNINITIALIZED</a>   0xC8A17620</td></tr>
|
|
<tr class="memdesc:a874ef45433da4582948a692fab7225ba"><td class="mdescLeft"> </td><td class="mdescRight">This is returned by <a class="el" href="nfc_8h.html#a9a0588d2d7bf6174b21fdb1d18d325b7" title="Opens the appdata, when the amiibo appdata was previously initialized.">nfcOpenAppData()</a> when the appdata is uninitialized since <a class="el" href="nfc_8h.html#adba9904e5419fd1116639802ee4f3976" title="This initializes the appdata using the specified input, when the appdata previously wasn't initialize...">nfcInitializeWriteAppData()</a> wasn't used previously. <br /></td></tr>
|
|
<tr class="separator:a874ef45433da4582948a692fab7225ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1933b382f5960700e016b8f5a20c420b"><td class="memItemLeft" align="right" valign="top"><a id="a1933b382f5960700e016b8f5a20c420b"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a1933b382f5960700e016b8f5a20c420b">NFC_ERR_AMIIBO_NOTSETUP</a>   0xC8A17628</td></tr>
|
|
<tr class="memdesc:a1933b382f5960700e016b8f5a20c420b"><td class="mdescLeft"> </td><td class="mdescRight">This is returned by <a class="el" href="nfc_8h.html#ab3072a287fd53717e05c8aca7265ad1c" title="Returns the current AmiiboSettings.">nfcGetAmiiboSettings()</a> when the amiibo wasn't setup by the amiibo Settings applet. <br /></td></tr>
|
|
<tr class="separator:a1933b382f5960700e016b8f5a20c420b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af62d4461851c683739a4154a95bcbe64"><td class="memItemLeft" align="right" valign="top"><a id="af62d4461851c683739a4154a95bcbe64"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#af62d4461851c683739a4154a95bcbe64">NFC_ERR_APPID_MISMATCH</a>   0xC8A17638</td></tr>
|
|
<tr class="memdesc:af62d4461851c683739a4154a95bcbe64"><td class="mdescLeft"> </td><td class="mdescRight">This is returned by <a class="el" href="nfc_8h.html#a9a0588d2d7bf6174b21fdb1d18d325b7" title="Opens the appdata, when the amiibo appdata was previously initialized.">nfcOpenAppData()</a> when the input AppID doesn't match the actual amiibo AppID. <br /></td></tr>
|
|
<tr class="separator:af62d4461851c683739a4154a95bcbe64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71f20a0149822130f47496369e8ac446"><td class="memItemLeft" align="right" valign="top"><a id="a71f20a0149822130f47496369e8ac446"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a71f20a0149822130f47496369e8ac446">NFC_ERR_DATACORRUPTION0</a>   0xC8C1760C</td></tr>
|
|
<tr class="memdesc:a71f20a0149822130f47496369e8ac446"><td class="mdescLeft"> </td><td class="mdescRight">"Returned for HMAC-hash mismatch(data corruption), with HMAC-calculation input_buffer_size=0x34." <br /></td></tr>
|
|
<tr class="separator:a71f20a0149822130f47496369e8ac446"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07acea106acdf958061b9b8e74fa05d0"><td class="memItemLeft" align="right" valign="top"><a id="a07acea106acdf958061b9b8e74fa05d0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a07acea106acdf958061b9b8e74fa05d0">NFC_ERR_DATACORRUPTION1</a>   0xC8A17618</td></tr>
|
|
<tr class="memdesc:a07acea106acdf958061b9b8e74fa05d0"><td class="mdescLeft"> </td><td class="mdescRight">HMAC-hash mismatch with input_buffer_size=0x1DF, see here: <a href="https://www.3dbrew.org/wiki/Amiibo">https://www.3dbrew.org/wiki/Amiibo</a>. <br /></td></tr>
|
|
<tr class="separator:a07acea106acdf958061b9b8e74fa05d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74193ef260c5a8942d77835636e4f36c"><td class="memItemLeft" align="right" valign="top"><a id="a74193ef260c5a8942d77835636e4f36c"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a74193ef260c5a8942d77835636e4f36c">NFC_STARTSCAN_DEFAULTINPUT</a>   0</td></tr>
|
|
<tr class="memdesc:a74193ef260c5a8942d77835636e4f36c"><td class="mdescLeft"> </td><td class="mdescRight">This can be used for <a class="el" href="nfc_8h.html#ac3ef0b90950c2111d60dce85bcebbc25" title="Starts scanning for NFC tags.">nfcStartScanning()</a>. <br /></td></tr>
|
|
<tr class="separator:a74193ef260c5a8942d77835636e4f36c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a9eece04c91681b888fb1fa0744944cd7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a9eece04c91681b888fb1fa0744944cd7">NFC_OpType</a> { <br />
|
|
  <b>NFC_OpType_1</b> = 1
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a9eece04c91681b888fb1fa0744944cd7a0cd7ce431e3b1f84d93ae5f1c60fa8b7">NFC_OpType_NFCTag</a> = 2
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a9eece04c91681b888fb1fa0744944cd7a4dfe8836eb56105d0b7a3f84c615ffb3">NFC_OpType_RawNFC</a> = 3
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a9eece04c91681b888fb1fa0744944cd7"><td class="mdescLeft"> </td><td class="mdescRight">NFC operation type. <a href="nfc_8h.html#a9eece04c91681b888fb1fa0744944cd7">More...</a><br /></td></tr>
|
|
<tr class="separator:a9eece04c91681b888fb1fa0744944cd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69a16164e08b77836ef1bc9482f16d48"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48">NFC_TagState</a> { <br />
|
|
  <b>NFC_TagState_Uninitialized</b> = 0
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48ab8076e3eb5dae8b8a6039bd5216bc00b">NFC_TagState_ScanningStopped</a> = 1
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48aafac0dbd5b19fe620065ee0e0594e182">NFC_TagState_Scanning</a> = 2
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48af5614df893e8dff6bed2e253e869073a">NFC_TagState_InRange</a> = 3
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48a3724306f91d953f27676392d586144ed">NFC_TagState_OutOfRange</a> = 4
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48a05ee15a8c4822b2cfe6d5c609ef02069">NFC_TagState_DataReady</a> = 5
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a69a16164e08b77836ef1bc9482f16d48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9334a5b9057f32da96db9b5c6a045d67"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />
|
|
  <b>NFC_amiiboFlag_Setup</b> = BIT(4)
|
|
, <br />
|
|
  <a class="el" href="nfc_8h.html#a9334a5b9057f32da96db9b5c6a045d67a16ce51e6a1dce2256d7a988d1dd9add4">NFC_amiiboFlag_AppDataSetup</a> = BIT(5)
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a9334a5b9057f32da96db9b5c6a045d67"><td class="mdescLeft"> </td><td class="mdescRight">Bit4-7 are always clear with <a class="el" href="nfc_8h.html#ab3072a287fd53717e05c8aca7265ad1c" title="Returns the current AmiiboSettings.">nfcGetAmiiboSettings()</a> due to "& 0xF". <a href="nfc_8h.html#a9334a5b9057f32da96db9b5c6a045d67">More...</a><br /></td></tr>
|
|
<tr class="separator:a9334a5b9057f32da96db9b5c6a045d67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a7596b3f973da03255dc6528bf1000092"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a7596b3f973da03255dc6528bf1000092">nfcInit</a> (<a class="el" href="nfc_8h.html#a9eece04c91681b888fb1fa0744944cd7">NFC_OpType</a> type)</td></tr>
|
|
<tr class="memdesc:a7596b3f973da03255dc6528bf1000092"><td class="mdescLeft"> </td><td class="mdescRight">Initializes NFC. <a href="nfc_8h.html#a7596b3f973da03255dc6528bf1000092">More...</a><br /></td></tr>
|
|
<tr class="separator:a7596b3f973da03255dc6528bf1000092"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28d582228da24339528ddb84ab6224f8"><td class="memItemLeft" align="right" valign="top"><a id="a28d582228da24339528ddb84ab6224f8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a28d582228da24339528ddb84ab6224f8">nfcExit</a> (void)</td></tr>
|
|
<tr class="memdesc:a28d582228da24339528ddb84ab6224f8"><td class="mdescLeft"> </td><td class="mdescRight">Shuts down NFC. <br /></td></tr>
|
|
<tr class="separator:a28d582228da24339528ddb84ab6224f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd3f71363e602913e0a5f3b980fa09e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#acd3f71363e602913e0a5f3b980fa09e3">nfcGetSessionHandle</a> (void)</td></tr>
|
|
<tr class="memdesc:acd3f71363e602913e0a5f3b980fa09e3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the NFC service handle. <a href="nfc_8h.html#acd3f71363e602913e0a5f3b980fa09e3">More...</a><br /></td></tr>
|
|
<tr class="separator:acd3f71363e602913e0a5f3b980fa09e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3ef0b90950c2111d60dce85bcebbc25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#ac3ef0b90950c2111d60dce85bcebbc25">nfcStartScanning</a> (<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> inval)</td></tr>
|
|
<tr class="memdesc:ac3ef0b90950c2111d60dce85bcebbc25"><td class="mdescLeft"> </td><td class="mdescRight">Starts scanning for NFC tags. <a href="nfc_8h.html#ac3ef0b90950c2111d60dce85bcebbc25">More...</a><br /></td></tr>
|
|
<tr class="separator:ac3ef0b90950c2111d60dce85bcebbc25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed548d946f176cb58d27f02eb3f8788b"><td class="memItemLeft" align="right" valign="top"><a id="aed548d946f176cb58d27f02eb3f8788b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#aed548d946f176cb58d27f02eb3f8788b">nfcStopScanning</a> (void)</td></tr>
|
|
<tr class="memdesc:aed548d946f176cb58d27f02eb3f8788b"><td class="mdescLeft"> </td><td class="mdescRight">Stops scanning for NFC tags. <br /></td></tr>
|
|
<tr class="separator:aed548d946f176cb58d27f02eb3f8788b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56c7173fe91f49f79098da6db466df1b"><td class="memItemLeft" align="right" valign="top"><a id="a56c7173fe91f49f79098da6db466df1b"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a56c7173fe91f49f79098da6db466df1b">nfcLoadAmiiboData</a> (void)</td></tr>
|
|
<tr class="memdesc:a56c7173fe91f49f79098da6db466df1b"><td class="mdescLeft"> </td><td class="mdescRight">Read amiibo NFC data and load in memory. <br /></td></tr>
|
|
<tr class="separator:a56c7173fe91f49f79098da6db466df1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d3c5604801770e2e8b9ae1298c4834d"><td class="memItemLeft" align="right" valign="top"><a id="a9d3c5604801770e2e8b9ae1298c4834d"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a9d3c5604801770e2e8b9ae1298c4834d">nfcResetTagScanState</a> (void)</td></tr>
|
|
<tr class="memdesc:a9d3c5604801770e2e8b9ae1298c4834d"><td class="mdescLeft"> </td><td class="mdescRight">If the tagstate is valid(NFC_TagState_DataReady or 6), it then sets the current tagstate to NFC_TagState_InRange. <br /></td></tr>
|
|
<tr class="separator:a9d3c5604801770e2e8b9ae1298c4834d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25d99d1157eba6cd04662e73bfad21d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a25d99d1157eba6cd04662e73bfad21d7">nfcUpdateStoredAmiiboData</a> (void)</td></tr>
|
|
<tr class="memdesc:a25d99d1157eba6cd04662e73bfad21d7"><td class="mdescLeft"> </td><td class="mdescRight">This writes the amiibo data stored in memory to the actual amiibo data storage(which is normally the NFC data pages). <a href="nfc_8h.html#a25d99d1157eba6cd04662e73bfad21d7">More...</a><br /></td></tr>
|
|
<tr class="separator:a25d99d1157eba6cd04662e73bfad21d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e0e09ac27a6ceefea37fa33c0330b7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a7e0e09ac27a6ceefea37fa33c0330b7b">nfcGetTagState</a> (<a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48">NFC_TagState</a> *state)</td></tr>
|
|
<tr class="memdesc:a7e0e09ac27a6ceefea37fa33c0330b7b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current NFC tag state. <a href="nfc_8h.html#a7e0e09ac27a6ceefea37fa33c0330b7b">More...</a><br /></td></tr>
|
|
<tr class="separator:a7e0e09ac27a6ceefea37fa33c0330b7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10329321c3f31c5b4c5f273c54497b1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a10329321c3f31c5b4c5f273c54497b1f">nfcGetTagInfo</a> (<a class="el" href="structNFC__TagInfo.html">NFC_TagInfo</a> *out)</td></tr>
|
|
<tr class="memdesc:a10329321c3f31c5b4c5f273c54497b1f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current TagInfo. <a href="nfc_8h.html#a10329321c3f31c5b4c5f273c54497b1f">More...</a><br /></td></tr>
|
|
<tr class="separator:a10329321c3f31c5b4c5f273c54497b1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a0588d2d7bf6174b21fdb1d18d325b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a9a0588d2d7bf6174b21fdb1d18d325b7">nfcOpenAppData</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> amiibo_appid)</td></tr>
|
|
<tr class="memdesc:a9a0588d2d7bf6174b21fdb1d18d325b7"><td class="mdescLeft"> </td><td class="mdescRight">Opens the appdata, when the amiibo appdata was previously initialized. <a href="nfc_8h.html#a9a0588d2d7bf6174b21fdb1d18d325b7">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a0588d2d7bf6174b21fdb1d18d325b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adba9904e5419fd1116639802ee4f3976"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#adba9904e5419fd1116639802ee4f3976">nfcInitializeWriteAppData</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> amiibo_appid, const void *buf, size_t size)</td></tr>
|
|
<tr class="memdesc:adba9904e5419fd1116639802ee4f3976"><td class="mdescLeft"> </td><td class="mdescRight">This initializes the appdata using the specified input, when the appdata previously wasn't initialized. <a href="nfc_8h.html#adba9904e5419fd1116639802ee4f3976">More...</a><br /></td></tr>
|
|
<tr class="separator:adba9904e5419fd1116639802ee4f3976"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96eaa70e51883928d1289391ac6d0e99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a96eaa70e51883928d1289391ac6d0e99">nfcReadAppData</a> (void *buf, size_t size)</td></tr>
|
|
<tr class="memdesc:a96eaa70e51883928d1289391ac6d0e99"><td class="mdescLeft"> </td><td class="mdescRight">Reads the appdata. <a href="nfc_8h.html#a96eaa70e51883928d1289391ac6d0e99">More...</a><br /></td></tr>
|
|
<tr class="separator:a96eaa70e51883928d1289391ac6d0e99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae123ea01db425b1a36f3d423a058f3a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#ae123ea01db425b1a36f3d423a058f3a3">nfcWriteAppData</a> (const void *buf, size_t size, <a class="el" href="structNFC__TagInfo.html">NFC_TagInfo</a> *taginfo)</td></tr>
|
|
<tr class="memdesc:ae123ea01db425b1a36f3d423a058f3a3"><td class="mdescLeft"> </td><td class="mdescRight">Writes the appdata, after <a class="el" href="nfc_8h.html#a9a0588d2d7bf6174b21fdb1d18d325b7" title="Opens the appdata, when the amiibo appdata was previously initialized.">nfcOpenAppData()</a> was used successfully. <a href="nfc_8h.html#ae123ea01db425b1a36f3d423a058f3a3">More...</a><br /></td></tr>
|
|
<tr class="separator:ae123ea01db425b1a36f3d423a058f3a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3072a287fd53717e05c8aca7265ad1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#ab3072a287fd53717e05c8aca7265ad1c">nfcGetAmiiboSettings</a> (<a class="el" href="structNFC__AmiiboSettings.html">NFC_AmiiboSettings</a> *out)</td></tr>
|
|
<tr class="memdesc:ab3072a287fd53717e05c8aca7265ad1c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current AmiiboSettings. <a href="nfc_8h.html#ab3072a287fd53717e05c8aca7265ad1c">More...</a><br /></td></tr>
|
|
<tr class="separator:ab3072a287fd53717e05c8aca7265ad1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26dccce0f9fa807abf31ffa5cf5c28e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a26dccce0f9fa807abf31ffa5cf5c28e7">nfcGetAmiiboConfig</a> (<a class="el" href="structNFC__AmiiboConfig.html">NFC_AmiiboConfig</a> *out)</td></tr>
|
|
<tr class="memdesc:a26dccce0f9fa807abf31ffa5cf5c28e7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current AmiiboConfig. <a href="nfc_8h.html#a26dccce0f9fa807abf31ffa5cf5c28e7">More...</a><br /></td></tr>
|
|
<tr class="separator:a26dccce0f9fa807abf31ffa5cf5c28e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc0100533e84183043289003958ea15a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#abc0100533e84183043289003958ea15a">nfcStartOtherTagScanning</a> (<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> unk0, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> unk1)</td></tr>
|
|
<tr class="memdesc:abc0100533e84183043289003958ea15a"><td class="mdescLeft"> </td><td class="mdescRight">Starts scanning for NFC tags when initialized with NFC_OpType_RawNFC. <a href="nfc_8h.html#abc0100533e84183043289003958ea15a">More...</a><br /></td></tr>
|
|
<tr class="separator:abc0100533e84183043289003958ea15a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a927cd24bd9c4018521ff205b8603c1cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a927cd24bd9c4018521ff205b8603c1cb">nfcSendTagCommand</a> (const void *inbuf, size_t insize, void *outbuf, size_t outsize, size_t *actual_transfer_size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> microseconds)</td></tr>
|
|
<tr class="memdesc:a927cd24bd9c4018521ff205b8603c1cb"><td class="mdescLeft"> </td><td class="mdescRight">This sends a raw NFC command to the tag. <a href="nfc_8h.html#a927cd24bd9c4018521ff205b8603c1cb">More...</a><br /></td></tr>
|
|
<tr class="separator:a927cd24bd9c4018521ff205b8603c1cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24c86d1a32ec011bad1c2bdae1eb8e26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a24c86d1a32ec011bad1c2bdae1eb8e26">nfcCmd21</a> (void)</td></tr>
|
|
<tr class="memdesc:a24c86d1a32ec011bad1c2bdae1eb8e26"><td class="mdescLeft"> </td><td class="mdescRight">Unknown. <a href="nfc_8h.html#a24c86d1a32ec011bad1c2bdae1eb8e26">More...</a><br /></td></tr>
|
|
<tr class="separator:a24c86d1a32ec011bad1c2bdae1eb8e26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c46ce5e0bb848fc966821278a76646c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="nfc_8h.html#a0c46ce5e0bb848fc966821278a76646c">nfcCmd22</a> (void)</td></tr>
|
|
<tr class="memdesc:a0c46ce5e0bb848fc966821278a76646c"><td class="mdescLeft"> </td><td class="mdescRight">Unknown. <a href="nfc_8h.html#a0c46ce5e0bb848fc966821278a76646c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c46ce5e0bb848fc966821278a76646c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>NFC service. </p>
|
|
<p>This can only be used with system-version >=9.3.0-X. </p>
|
|
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a9334a5b9057f32da96db9b5c6a045d67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9334a5b9057f32da96db9b5c6a045d67">◆ </a></span>anonymous enum</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bit4-7 are always clear with <a class="el" href="nfc_8h.html#ab3072a287fd53717e05c8aca7265ad1c" title="Returns the current AmiiboSettings.">nfcGetAmiiboSettings()</a> due to "& 0xF". </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9334a5b9057f32da96db9b5c6a045d67a16ce51e6a1dce2256d7a988d1dd9add4"></a>NFC_amiiboFlag_AppDataSetup </td><td class="fielddoc"><p>This indicates that the amiibo was setup with amiibo Settings. <a class="el" href="nfc_8h.html#ab3072a287fd53717e05c8aca7265ad1c" title="Returns the current AmiiboSettings.">nfcGetAmiiboSettings()</a> will return an all-zero struct when this is not set. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9eece04c91681b888fb1fa0744944cd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9eece04c91681b888fb1fa0744944cd7">◆ </a></span>NFC_OpType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="nfc_8h.html#a9eece04c91681b888fb1fa0744944cd7">NFC_OpType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>NFC operation type. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9eece04c91681b888fb1fa0744944cd7a0cd7ce431e3b1f84d93ae5f1c60fa8b7"></a>NFC_OpType_NFCTag </td><td class="fielddoc"><p>Unknown. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a9eece04c91681b888fb1fa0744944cd7a4dfe8836eb56105d0b7a3f84c615ffb3"></a>NFC_OpType_RawNFC </td><td class="fielddoc"><p>This is the default. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a69a16164e08b77836ef1bc9482f16d48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69a16164e08b77836ef1bc9482f16d48">◆ </a></span>NFC_TagState</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48">NFC_TagState</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a69a16164e08b77836ef1bc9482f16d48ab8076e3eb5dae8b8a6039bd5216bc00b"></a>NFC_TagState_ScanningStopped </td><td class="fielddoc"><p><a class="el" href="nfc_8h.html#a7596b3f973da03255dc6528bf1000092" title="Initializes NFC.">nfcInit()</a> was not used yet. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a69a16164e08b77836ef1bc9482f16d48aafac0dbd5b19fe620065ee0e0594e182"></a>NFC_TagState_Scanning </td><td class="fielddoc"><p>Not currently scanning for NFC tags. Set by <a class="el" href="nfc_8h.html#aed548d946f176cb58d27f02eb3f8788b" title="Stops scanning for NFC tags.">nfcStopScanning()</a> and <a class="el" href="nfc_8h.html#a7596b3f973da03255dc6528bf1000092" title="Initializes NFC.">nfcInit()</a>, when successful. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a69a16164e08b77836ef1bc9482f16d48af5614df893e8dff6bed2e253e869073a"></a>NFC_TagState_InRange </td><td class="fielddoc"><p>Currently scanning for NFC tags. Set by <a class="el" href="nfc_8h.html#ac3ef0b90950c2111d60dce85bcebbc25" title="Starts scanning for NFC tags.">nfcStartScanning()</a> when successful. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a69a16164e08b77836ef1bc9482f16d48a3724306f91d953f27676392d586144ed"></a>NFC_TagState_OutOfRange </td><td class="fielddoc"><p>NFC tag is in range. The state automatically changes to this when the state was previously value 2, without using any NFC service commands. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a69a16164e08b77836ef1bc9482f16d48a05ee15a8c4822b2cfe6d5c609ef02069"></a>NFC_TagState_DataReady </td><td class="fielddoc"><p>NFC tag is now out of range, where the NFC tag was previously in range. This occurs automatically without using any NFC service commands. Once this state is entered, it won't automatically change to anything else when the tag is moved in range again. Hence, if you want to keep doing tag scanning after this, you must stop+start scanning. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a24c86d1a32ec011bad1c2bdae1eb8e26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24c86d1a32ec011bad1c2bdae1eb8e26">◆ </a></span>nfcCmd21()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcCmd21 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unknown. </p>
|
|
<p>This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c46ce5e0bb848fc966821278a76646c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c46ce5e0bb848fc966821278a76646c">◆ </a></span>nfcCmd22()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcCmd22 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unknown. </p>
|
|
<p>This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a26dccce0f9fa807abf31ffa5cf5c28e7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a26dccce0f9fa807abf31ffa5cf5c28e7">◆ </a></span>nfcGetAmiiboConfig()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcGetAmiiboConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNFC__AmiiboConfig.html">NFC_AmiiboConfig</a> * </td>
|
|
<td class="paramname"><em>out</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the current AmiiboConfig. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">out</td><td>Pointer to write the output AmiiboConfig. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a22">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab3072a287fd53717e05c8aca7265ad1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3072a287fd53717e05c8aca7265ad1c">◆ </a></span>nfcGetAmiiboSettings()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcGetAmiiboSettings </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNFC__AmiiboSettings.html">NFC_AmiiboSettings</a> * </td>
|
|
<td class="paramname"><em>out</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the current AmiiboSettings. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">out</td><td>Pointer to write the output AmiiboSettings. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a20">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acd3f71363e602913e0a5f3b980fa09e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd3f71363e602913e0a5f3b980fa09e3">◆ </a></span>nfcGetSessionHandle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> nfcGetSessionHandle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the NFC service handle. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The NFC service handle. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a10329321c3f31c5b4c5f273c54497b1f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10329321c3f31c5b4c5f273c54497b1f">◆ </a></span>nfcGetTagInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcGetTagInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNFC__TagInfo.html">NFC_TagInfo</a> * </td>
|
|
<td class="paramname"><em>out</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the current TagInfo. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">out</td><td>Pointer to write the output TagInfo. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a16">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e0e09ac27a6ceefea37fa33c0330b7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e0e09ac27a6ceefea37fa33c0330b7b">◆ </a></span>nfcGetTagState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcGetTagState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="nfc_8h.html#a69a16164e08b77836ef1bc9482f16d48">NFC_TagState</a> * </td>
|
|
<td class="paramname"><em>state</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the current NFC tag state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>Pointer to write NFC tag state. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a6">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7596b3f973da03255dc6528bf1000092"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7596b3f973da03255dc6528bf1000092">◆ </a></span>nfcInit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="nfc_8h.html#a9eece04c91681b888fb1fa0744944cd7">NFC_OpType</a> </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes NFC. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>See the NFC_OpType enum. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a39">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adba9904e5419fd1116639802ee4f3976"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adba9904e5419fd1116639802ee4f3976">◆ </a></span>nfcInitializeWriteAppData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcInitializeWriteAppData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>amiibo_appid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This initializes the appdata using the specified input, when the appdata previously wasn't initialized. </p>
|
|
<p>If the appdata is already initialized, you must first use the amiibo Settings applet menu option labeled "Delete amiibo Game Data". This automatically writes the amiibo data into the actual data storage(normally NFC data pages). See also <a class="el" href="nfc_8h.html#ae123ea01db425b1a36f3d423a058f3a3" title="Writes the appdata, after nfcOpenAppData() was used successfully.">nfcWriteAppData()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">amiibo_appid</td><td>amiibo AppID. See also <a class="el" href="nfc_8h.html#a9a0588d2d7bf6174b21fdb1d18d325b7" title="Opens the appdata, when the amiibo appdata was previously initialized.">nfcOpenAppData()</a>. </td></tr>
|
|
<tr><td class="paramname">buf</td><td>Input buffer. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Buffer size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a35">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9a0588d2d7bf6174b21fdb1d18d325b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a0588d2d7bf6174b21fdb1d18d325b7">◆ </a></span>nfcOpenAppData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcOpenAppData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>amiibo_appid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens the appdata, when the amiibo appdata was previously initialized. </p>
|
|
<p>This must be used before reading/writing the appdata. See also: <a href="https://3dbrew.org/wiki/NFC:OpenAppData">https://3dbrew.org/wiki/NFC:OpenAppData</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">amiibo_appid</td><td>Amiibo AppID. See here: <a href="https://www.3dbrew.org/wiki/Amiibo">https://www.3dbrew.org/wiki/Amiibo</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a27">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96eaa70e51883928d1289391ac6d0e99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96eaa70e51883928d1289391ac6d0e99">◆ </a></span>nfcReadAppData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcReadAppData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the appdata. </p>
|
|
<p>The size must be >=0xD8-bytes, but the actual used size is hard-coded to 0xD8. Note that areas of appdata which were never written to by applications are uninitialized in this output buffer. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buf</td><td>Output buffer. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Buffer size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a30">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a927cd24bd9c4018521ff205b8603c1cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a927cd24bd9c4018521ff205b8603c1cb">◆ </a></span>nfcSendTagCommand()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcSendTagCommand </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>inbuf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>insize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>outbuf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>outsize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>actual_transfer_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>microseconds</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This sends a raw NFC command to the tag. </p>
|
|
<p>This can only be used when initialized with NFC_OpType_RawNFC, and when the TagState is NFC_TagState_InRange. See also: <a href="https://www.3dbrew.org/wiki/NFC:SendTagCommand">https://www.3dbrew.org/wiki/NFC:SendTagCommand</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inbuf</td><td>Input buffer. </td></tr>
|
|
<tr><td class="paramname">insize</td><td>Size of the input buffer. </td></tr>
|
|
<tr><td class="paramname">outbuf</td><td>Output buffer. </td></tr>
|
|
<tr><td class="paramname">outsize</td><td>Size of the output buffer. </td></tr>
|
|
<tr><td class="paramname">actual_transfer_size</td><td>Optional output ptr to write the actual output-size to, can be NULL. </td></tr>
|
|
<tr><td class="paramname">microseconds</td><td>Timing-related field in microseconds. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc0100533e84183043289003958ea15a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc0100533e84183043289003958ea15a">◆ </a></span>nfcStartOtherTagScanning()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcStartOtherTagScanning </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td>
|
|
<td class="paramname"><em>unk0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>unk1</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Starts scanning for NFC tags when initialized with NFC_OpType_RawNFC. </p>
|
|
<p>See also: <a href="https://www.3dbrew.org/wiki/NFC:StartOtherTagScanning">https://www.3dbrew.org/wiki/NFC:StartOtherTagScanning</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">unk0</td><td>Same as <a class="el" href="nfc_8h.html#ac3ef0b90950c2111d60dce85bcebbc25" title="Starts scanning for NFC tags.">nfcStartScanning()</a> input. </td></tr>
|
|
<tr><td class="paramname">unk1</td><td>Unknown. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac3ef0b90950c2111d60dce85bcebbc25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac3ef0b90950c2111d60dce85bcebbc25">◆ </a></span>nfcStartScanning()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcStartScanning </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td>
|
|
<td class="paramname"><em>inval</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Starts scanning for NFC tags. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inval</td><td>Unknown. See NFC_STARTSCAN_DEFAULTINPUT. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a3">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25d99d1157eba6cd04662e73bfad21d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25d99d1157eba6cd04662e73bfad21d7">◆ </a></span>nfcUpdateStoredAmiiboData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcUpdateStoredAmiiboData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This writes the amiibo data stored in memory to the actual amiibo data storage(which is normally the NFC data pages). </p>
|
|
<p>This can only be used if NFC_LoadAmiiboData() was used previously. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a34">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae123ea01db425b1a36f3d423a058f3a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae123ea01db425b1a36f3d423a058f3a3">◆ </a></span>nfcWriteAppData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> nfcWriteAppData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structNFC__TagInfo.html">NFC_TagInfo</a> * </td>
|
|
<td class="paramname"><em>taginfo</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Writes the appdata, after <a class="el" href="nfc_8h.html#a9a0588d2d7bf6174b21fdb1d18d325b7" title="Opens the appdata, when the amiibo appdata was previously initialized.">nfcOpenAppData()</a> was used successfully. </p>
|
|
<p>The size should be <=0xD8-bytes. See also: <a href="https://3dbrew.org/wiki/NFC:WriteAppData">https://3dbrew.org/wiki/NFC:WriteAppData</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buf</td><td>Input buffer. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Buffer size. </td></tr>
|
|
<tr><td class="paramname">taginfo</td><td>TagInfo from <a class="el" href="nfc_8h.html#a10329321c3f31c5b4c5f273c54497b1f" title="Returns the current TagInfo.">nfcGetTagInfo()</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="nfc_2source_2main_8c-example.html#a33">nfc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
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
|
|
</small></address>
|
|
</body>
|
|
</html>
|