libctru/cfgnor_8h_source.html
2024-11-03 20:36:34 +00:00

144 lines
16 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/cfgnor.h Source File</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
&#160;<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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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="headertitle">
<div class="title">cfgnor.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cfgnor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * @file cfgnor.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * @brief CFGNOR service.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * @brief Initializes CFGNOR.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * @param value Unknown, usually 1.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#a7a45bb4d5a1c4698b8a81a78b3ecfb37"> 11</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="cfgnor_8h.html#a7a45bb4d5a1c4698b8a81a78b3ecfb37">cfgnorInit</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> value);</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">/// Exits CFGNOR</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#a6af5a1ec948c981dfbf61b786bb8ae64"> 14</a></span>&#160;<span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="cfgnor_8h.html#a6af5a1ec948c981dfbf61b786bb8ae64">cfgnorExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * @brief Dumps the NOR flash.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * @param buf Buffer to dump to.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * @param size Size of the buffer.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#a676ea33bb8e4d4cd4c548991057e2448"> 21</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="cfgnor_8h.html#a676ea33bb8e4d4cd4c548991057e2448">cfgnorDumpFlash</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *buf, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * @brief Writes the NOR flash.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * @param buf Buffer to write from.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * @param size Size of the buffer.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#a935562a582305bc87d35278850002995"> 28</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="cfgnor_8h.html#a935562a582305bc87d35278850002995">cfgnorWriteFlash</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *buf, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> * @brief Initializes the CFGNOR session.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> * @param value Unknown, usually 1.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#afe5e3cb23c2e604192fb5accbb2d8574"> 34</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="cfgnor_8h.html#afe5e3cb23c2e604192fb5accbb2d8574">CFGNOR_Initialize</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> value);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">/// Shuts down the CFGNOR session.</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#a7cf5f43f09426a0c7a35ec0a753eeb8b"> 37</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="cfgnor_8h.html#a7cf5f43f09426a0c7a35ec0a753eeb8b">CFGNOR_Shutdown</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> * @brief Reads data from NOR.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> * @param offset Offset to read from.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> * @param buf Buffer to read data to.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"> * @param size Size of the buffer.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#abbe38a4ffcc42bb0089239c10b147399"> 45</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="cfgnor_8h.html#abbe38a4ffcc42bb0089239c10b147399">CFGNOR_ReadData</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> offset, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *buf, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> * @brief Writes data to NOR.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> * @param offset Offset to write to.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> * @param buf Buffer to write data from.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> * @param size Size of the buffer.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="cfgnor_8h.html#ab81da0b552ab30b4a3e50881e9917a16"> 53</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="cfgnor_8h.html#ab81da0b552ab30b4a3e50881e9917a16">CFGNOR_WriteData</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> offset, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *buf, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
<div class="ttc" id="acfgnor_8h_html_a676ea33bb8e4d4cd4c548991057e2448"><div class="ttname"><a href="cfgnor_8h.html#a676ea33bb8e4d4cd4c548991057e2448">cfgnorDumpFlash</a></div><div class="ttdeci">Result cfgnorDumpFlash(u32 *buf, u32 size)</div><div class="ttdoc">Dumps the NOR flash.</div></div>
<div class="ttc" id="acfgnor_8h_html_a6af5a1ec948c981dfbf61b786bb8ae64"><div class="ttname"><a href="cfgnor_8h.html#a6af5a1ec948c981dfbf61b786bb8ae64">cfgnorExit</a></div><div class="ttdeci">void cfgnorExit(void)</div><div class="ttdoc">Exits CFGNOR.</div></div>
<div class="ttc" id="acfgnor_8h_html_a7a45bb4d5a1c4698b8a81a78b3ecfb37"><div class="ttname"><a href="cfgnor_8h.html#a7a45bb4d5a1c4698b8a81a78b3ecfb37">cfgnorInit</a></div><div class="ttdeci">Result cfgnorInit(u8 value)</div><div class="ttdoc">Initializes CFGNOR.</div></div>
<div class="ttc" id="acfgnor_8h_html_a7cf5f43f09426a0c7a35ec0a753eeb8b"><div class="ttname"><a href="cfgnor_8h.html#a7cf5f43f09426a0c7a35ec0a753eeb8b">CFGNOR_Shutdown</a></div><div class="ttdeci">Result CFGNOR_Shutdown(void)</div><div class="ttdoc">Shuts down the CFGNOR session.</div></div>
<div class="ttc" id="acfgnor_8h_html_a935562a582305bc87d35278850002995"><div class="ttname"><a href="cfgnor_8h.html#a935562a582305bc87d35278850002995">cfgnorWriteFlash</a></div><div class="ttdeci">Result cfgnorWriteFlash(u32 *buf, u32 size)</div><div class="ttdoc">Writes the NOR flash.</div></div>
<div class="ttc" id="acfgnor_8h_html_ab81da0b552ab30b4a3e50881e9917a16"><div class="ttname"><a href="cfgnor_8h.html#ab81da0b552ab30b4a3e50881e9917a16">CFGNOR_WriteData</a></div><div class="ttdeci">Result CFGNOR_WriteData(u32 offset, u32 *buf, u32 size)</div><div class="ttdoc">Writes data to NOR.</div></div>
<div class="ttc" id="acfgnor_8h_html_abbe38a4ffcc42bb0089239c10b147399"><div class="ttname"><a href="cfgnor_8h.html#abbe38a4ffcc42bb0089239c10b147399">CFGNOR_ReadData</a></div><div class="ttdeci">Result CFGNOR_ReadData(u32 offset, u32 *buf, u32 size)</div><div class="ttdoc">Reads data from NOR.</div></div>
<div class="ttc" id="acfgnor_8h_html_afe5e3cb23c2e604192fb5accbb2d8574"><div class="ttname"><a href="cfgnor_8h.html#afe5e3cb23c2e604192fb5accbb2d8574">CFGNOR_Initialize</a></div><div class="ttdeci">Result CFGNOR_Initialize(u8 value)</div><div class="ttdoc">Initializes the CFGNOR session.</div></div>
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
</div><!-- fragment --></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.1
</small></address>
</body>
</html>