959 lines
70 KiB
HTML
959 lines
70 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/os.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> </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="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">os.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>OS related stuff.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="svc_8h_source.html">svc.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="os_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="structosKernelConfig__s.html">osKernelConfig_s</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Kernel configuration page (read-only). <a href="structosKernelConfig__s.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="structosTimeRef__s.html">osTimeRef_s</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Time reference information struct (filled in by PTM). <a href="structosTimeRef__s.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="structosSharedConfig__s.html">osSharedConfig_s</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Shared system configuration page structure (read-only or read-write depending on exheader). <a href="structosSharedConfig__s.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="structTickCounter.html">TickCounter</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Tick counter. <a href="structTickCounter.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="structOS__VersionBin.html">OS_VersionBin</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structOS__VersionBin.html" title="OS_VersionBin. Format of the system version: "<major>.<minor>.<build>-<nupver><region>".">OS_VersionBin</a>. Format of the system version: "<major>.<minor>.<build>-<nupver><region>". <a href="structOS__VersionBin.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:a54dfa9664a5032211d512fb04fcd7cac"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a54dfa9664a5032211d512fb04fcd7cac">SYSCLOCK_SOC</a>   (16756991u)</td></tr>
|
|
<tr class="memdesc:a54dfa9664a5032211d512fb04fcd7cac"><td class="mdescLeft"> </td><td class="mdescRight">< The external clock rate for the SoC. <a href="os_8h.html#a54dfa9664a5032211d512fb04fcd7cac">More...</a><br /></td></tr>
|
|
<tr class="separator:a54dfa9664a5032211d512fb04fcd7cac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcef538e8f16a2abba193c704e87cf96"><td class="memItemLeft" align="right" valign="top"><a id="adcef538e8f16a2abba193c704e87cf96"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#adcef538e8f16a2abba193c704e87cf96">SYSCLOCK_SYS</a>   (<a class="el" href="os_8h.html#a54dfa9664a5032211d512fb04fcd7cac">SYSCLOCK_SOC</a> * 2)</td></tr>
|
|
<tr class="memdesc:adcef538e8f16a2abba193c704e87cf96"><td class="mdescLeft"> </td><td class="mdescRight">The base clock rate for the SDMMC controller (and some other peripherals). <br /></td></tr>
|
|
<tr class="separator:adcef538e8f16a2abba193c704e87cf96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af2fd339c05f8d8e8e6b96f0b0989d8fa"><td class="memItemLeft" align="right" valign="top"><a id="af2fd339c05f8d8e8e6b96f0b0989d8fa"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#af2fd339c05f8d8e8e6b96f0b0989d8fa">SYSCLOCK_SDMMC</a>   (<a class="el" href="os_8h.html#adcef538e8f16a2abba193c704e87cf96">SYSCLOCK_SYS</a> * 2)</td></tr>
|
|
<tr class="memdesc:af2fd339c05f8d8e8e6b96f0b0989d8fa"><td class="mdescLeft"> </td><td class="mdescRight">The clock rate for the Arm9. <br /></td></tr>
|
|
<tr class="separator:af2fd339c05f8d8e8e6b96f0b0989d8fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f3b7dd4e5c4f31727c18559e99233b0"><td class="memItemLeft" align="right" valign="top"><a id="a1f3b7dd4e5c4f31727c18559e99233b0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a1f3b7dd4e5c4f31727c18559e99233b0">SYSCLOCK_ARM9</a>   (<a class="el" href="os_8h.html#adcef538e8f16a2abba193c704e87cf96">SYSCLOCK_SYS</a> * 4)</td></tr>
|
|
<tr class="memdesc:a1f3b7dd4e5c4f31727c18559e99233b0"><td class="mdescLeft"> </td><td class="mdescRight">The clock rate for the Arm11 in CTR mode and in <a class="el" href="svc_8h.html#a3a31bff3a0f1d8ff768911e38f70c5d7">svcGetSystemTick</a>. <br /></td></tr>
|
|
<tr class="separator:a1f3b7dd4e5c4f31727c18559e99233b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f6e9f05fa950bd4fdf60f5bd8586af7"><td class="memItemLeft" align="right" valign="top"><a id="a5f6e9f05fa950bd4fdf60f5bd8586af7"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a5f6e9f05fa950bd4fdf60f5bd8586af7">SYSCLOCK_ARM11</a>   (<a class="el" href="os_8h.html#a1f3b7dd4e5c4f31727c18559e99233b0">SYSCLOCK_ARM9</a> * 2)</td></tr>
|
|
<tr class="memdesc:a5f6e9f05fa950bd4fdf60f5bd8586af7"><td class="mdescLeft"> </td><td class="mdescRight">The clock rate for the Arm11 in LGR1 mode. <br /></td></tr>
|
|
<tr class="separator:a5f6e9f05fa950bd4fdf60f5bd8586af7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3600c385921844a2f11cc3e37bd63c6"><td class="memItemLeft" align="right" valign="top"><a id="ae3600c385921844a2f11cc3e37bd63c6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#ae3600c385921844a2f11cc3e37bd63c6">SYSCLOCK_ARM11_LGR1</a>   (<a class="el" href="os_8h.html#a5f6e9f05fa950bd4fdf60f5bd8586af7">SYSCLOCK_ARM11</a> * 2)</td></tr>
|
|
<tr class="memdesc:ae3600c385921844a2f11cc3e37bd63c6"><td class="mdescLeft"> </td><td class="mdescRight">The clock rate for the Arm11 in LGR2 mode. <br /></td></tr>
|
|
<tr class="separator:ae3600c385921844a2f11cc3e37bd63c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35f086625fd7891e330f89bc1ee260f6"><td class="memItemLeft" align="right" valign="top"><a id="a35f086625fd7891e330f89bc1ee260f6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a35f086625fd7891e330f89bc1ee260f6">SYSCLOCK_ARM11_LGR2</a>   (<a class="el" href="os_8h.html#a5f6e9f05fa950bd4fdf60f5bd8586af7">SYSCLOCK_ARM11</a> * 3)</td></tr>
|
|
<tr class="memdesc:a35f086625fd7891e330f89bc1ee260f6"><td class="mdescLeft"> </td><td class="mdescRight">The highest possible clock rate for the Arm11 on known New 3DS units. <br /></td></tr>
|
|
<tr class="separator:a35f086625fd7891e330f89bc1ee260f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f2440590cf63482efcca27e7f430a6a"><td class="memItemLeft" align="right" valign="top"><a id="a2f2440590cf63482efcca27e7f430a6a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>SYSCLOCK_ARM11_NEW</b>   <a class="el" href="os_8h.html#a35f086625fd7891e330f89bc1ee260f6">SYSCLOCK_ARM11_LGR2</a></td></tr>
|
|
<tr class="separator:a2f2440590cf63482efcca27e7f430a6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85dd4c0ef5d305fa1dc2d238d5649c7e"><td class="memItemLeft" align="right" valign="top"><a id="a85dd4c0ef5d305fa1dc2d238d5649c7e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CPU_TICKS_PER_MSEC</b>   (<a class="el" href="os_8h.html#a5f6e9f05fa950bd4fdf60f5bd8586af7">SYSCLOCK_ARM11</a> / 1000.0)</td></tr>
|
|
<tr class="separator:a85dd4c0ef5d305fa1dc2d238d5649c7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a833eea4c477845aee2c7ed1aaed78d78"><td class="memItemLeft" align="right" valign="top"><a id="a833eea4c477845aee2c7ed1aaed78d78"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CPU_TICKS_PER_USEC</b>   (<a class="el" href="os_8h.html#a5f6e9f05fa950bd4fdf60f5bd8586af7">SYSCLOCK_ARM11</a> / 1000000.0)</td></tr>
|
|
<tr class="separator:a833eea4c477845aee2c7ed1aaed78d78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceac399d08eb60be9497b16a9bc7c287"><td class="memItemLeft" align="right" valign="top"><a id="aceac399d08eb60be9497b16a9bc7c287"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#aceac399d08eb60be9497b16a9bc7c287">SYSTEM_VERSION</a>(major, minor, revision)    (((major)<<24)|((minor)<<16)|((revision)<<8))</td></tr>
|
|
<tr class="memdesc:aceac399d08eb60be9497b16a9bc7c287"><td class="mdescLeft"> </td><td class="mdescRight">Packs a system version from its components. <br /></td></tr>
|
|
<tr class="separator:aceac399d08eb60be9497b16a9bc7c287"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bd5e5709b15356ed59ca500ddfa1522"><td class="memItemLeft" align="right" valign="top"><a id="a0bd5e5709b15356ed59ca500ddfa1522"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a0bd5e5709b15356ed59ca500ddfa1522">GET_VERSION_MAJOR</a>(version)   ((version) >>24)</td></tr>
|
|
<tr class="memdesc:a0bd5e5709b15356ed59ca500ddfa1522"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the major version from a packed system version. <br /></td></tr>
|
|
<tr class="separator:a0bd5e5709b15356ed59ca500ddfa1522"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6cfa84144d8bb77e77a734012549090f"><td class="memItemLeft" align="right" valign="top"><a id="a6cfa84144d8bb77e77a734012549090f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a6cfa84144d8bb77e77a734012549090f">GET_VERSION_MINOR</a>(version)   (((version)>>16)&0xFF)</td></tr>
|
|
<tr class="memdesc:a6cfa84144d8bb77e77a734012549090f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the minor version from a packed system version. <br /></td></tr>
|
|
<tr class="separator:a6cfa84144d8bb77e77a734012549090f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7e2448695a0c735dee58ad61f73f172"><td class="memItemLeft" align="right" valign="top"><a id="ac7e2448695a0c735dee58ad61f73f172"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#ac7e2448695a0c735dee58ad61f73f172">GET_VERSION_REVISION</a>(version)   (((version)>> 8)&0xFF)</td></tr>
|
|
<tr class="memdesc:ac7e2448695a0c735dee58ad61f73f172"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the revision version from a packed system version. <br /></td></tr>
|
|
<tr class="separator:ac7e2448695a0c735dee58ad61f73f172"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76d0d25e825d506e2a54f29090cd7e47"><td class="memItemLeft" align="right" valign="top"><a id="a76d0d25e825d506e2a54f29090cd7e47"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a76d0d25e825d506e2a54f29090cd7e47">OS_HEAP_AREA_BEGIN</a>   0x08000000</td></tr>
|
|
<tr class="memdesc:a76d0d25e825d506e2a54f29090cd7e47"><td class="mdescLeft"> </td><td class="mdescRight">Start of the heap area in the virtual address space. <br /></td></tr>
|
|
<tr class="separator:a76d0d25e825d506e2a54f29090cd7e47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63faf0db6e346d556e5be95a2acb28ad"><td class="memItemLeft" align="right" valign="top"><a id="a63faf0db6e346d556e5be95a2acb28ad"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a63faf0db6e346d556e5be95a2acb28ad">OS_HEAP_AREA_END</a>   0x0E000000</td></tr>
|
|
<tr class="memdesc:a63faf0db6e346d556e5be95a2acb28ad"><td class="mdescLeft"> </td><td class="mdescRight">End of the heap area in the virtual address space. <br /></td></tr>
|
|
<tr class="separator:a63faf0db6e346d556e5be95a2acb28ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1d62cafe4afecb5d46186ebe5c8352f"><td class="memItemLeft" align="right" valign="top"><a id="ae1d62cafe4afecb5d46186ebe5c8352f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#ae1d62cafe4afecb5d46186ebe5c8352f">OS_MAP_AREA_BEGIN</a>   0x10000000</td></tr>
|
|
<tr class="memdesc:ae1d62cafe4afecb5d46186ebe5c8352f"><td class="mdescLeft"> </td><td class="mdescRight">Start of the mappable area in the virtual address space. <br /></td></tr>
|
|
<tr class="separator:ae1d62cafe4afecb5d46186ebe5c8352f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47c4df507cf8cbe2e4a2d64c1df9db5a"><td class="memItemLeft" align="right" valign="top"><a id="a47c4df507cf8cbe2e4a2d64c1df9db5a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a47c4df507cf8cbe2e4a2d64c1df9db5a">OS_MAP_AREA_END</a>   0x14000000</td></tr>
|
|
<tr class="memdesc:a47c4df507cf8cbe2e4a2d64c1df9db5a"><td class="mdescLeft"> </td><td class="mdescRight">End of the mappable area in the virtual address space. <br /></td></tr>
|
|
<tr class="separator:a47c4df507cf8cbe2e4a2d64c1df9db5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a204a5a08cb0308b3622358d22e41e3ad"><td class="memItemLeft" align="right" valign="top"><a id="a204a5a08cb0308b3622358d22e41e3ad"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a204a5a08cb0308b3622358d22e41e3ad">OS_OLD_FCRAM_VADDR</a>   0x14000000</td></tr>
|
|
<tr class="memdesc:a204a5a08cb0308b3622358d22e41e3ad"><td class="mdescLeft"> </td><td class="mdescRight">Old pre-8.x linear FCRAM mapping virtual address. <br /></td></tr>
|
|
<tr class="separator:a204a5a08cb0308b3622358d22e41e3ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b5f879f4639acc7d44b8de752d7cd69"><td class="memItemLeft" align="right" valign="top"><a id="a5b5f879f4639acc7d44b8de752d7cd69"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a5b5f879f4639acc7d44b8de752d7cd69">OS_OLD_FCRAM_PADDR</a>   0x20000000</td></tr>
|
|
<tr class="memdesc:a5b5f879f4639acc7d44b8de752d7cd69"><td class="mdescLeft"> </td><td class="mdescRight">Old pre-8.x linear FCRAM mapping physical address. <br /></td></tr>
|
|
<tr class="separator:a5b5f879f4639acc7d44b8de752d7cd69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a44bd1e73ee9aec7f5c51956625cda11e"><td class="memItemLeft" align="right" valign="top"><a id="a44bd1e73ee9aec7f5c51956625cda11e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a44bd1e73ee9aec7f5c51956625cda11e">OS_OLD_FCRAM_SIZE</a>   0x8000000</td></tr>
|
|
<tr class="memdesc:a44bd1e73ee9aec7f5c51956625cda11e"><td class="mdescLeft"> </td><td class="mdescRight">Old pre-8.x linear FCRAM mapping size (128 MiB) <br /></td></tr>
|
|
<tr class="separator:a44bd1e73ee9aec7f5c51956625cda11e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a185da471d9d52138c3eaf34605f853a8"><td class="memItemLeft" align="right" valign="top"><a id="a185da471d9d52138c3eaf34605f853a8"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a185da471d9d52138c3eaf34605f853a8">OS_QTMRAM_VADDR</a>   0x1E800000</td></tr>
|
|
<tr class="memdesc:a185da471d9d52138c3eaf34605f853a8"><td class="mdescLeft"> </td><td class="mdescRight">New3DS QTM memory virtual address. <br /></td></tr>
|
|
<tr class="separator:a185da471d9d52138c3eaf34605f853a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1db38351caf7b5db6e21718bc329ba01"><td class="memItemLeft" align="right" valign="top"><a id="a1db38351caf7b5db6e21718bc329ba01"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a1db38351caf7b5db6e21718bc329ba01">OS_QTMRAM_PADDR</a>   0x1F000000</td></tr>
|
|
<tr class="memdesc:a1db38351caf7b5db6e21718bc329ba01"><td class="mdescLeft"> </td><td class="mdescRight">New3DS QTM memory physical address. <br /></td></tr>
|
|
<tr class="separator:a1db38351caf7b5db6e21718bc329ba01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25d3987a690b022660a4ba5aee8cefc0"><td class="memItemLeft" align="right" valign="top"><a id="a25d3987a690b022660a4ba5aee8cefc0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a25d3987a690b022660a4ba5aee8cefc0">OS_QTMRAM_SIZE</a>   0x400000</td></tr>
|
|
<tr class="memdesc:a25d3987a690b022660a4ba5aee8cefc0"><td class="mdescLeft"> </td><td class="mdescRight">New3DS QTM memory size (4 MiB; last 128 KiB reserved by kernel) <br /></td></tr>
|
|
<tr class="separator:a25d3987a690b022660a4ba5aee8cefc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea9394a7835afe057607234caf811b00"><td class="memItemLeft" align="right" valign="top"><a id="aea9394a7835afe057607234caf811b00"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#aea9394a7835afe057607234caf811b00">OS_MMIO_VADDR</a>   0x1EC00000</td></tr>
|
|
<tr class="memdesc:aea9394a7835afe057607234caf811b00"><td class="mdescLeft"> </td><td class="mdescRight">Memory mapped IO range virtual address. <br /></td></tr>
|
|
<tr class="separator:aea9394a7835afe057607234caf811b00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcff263c48e6933220897117cd8c54c4"><td class="memItemLeft" align="right" valign="top"><a id="adcff263c48e6933220897117cd8c54c4"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#adcff263c48e6933220897117cd8c54c4">OS_MMIO_PADDR</a>   0x10100000</td></tr>
|
|
<tr class="memdesc:adcff263c48e6933220897117cd8c54c4"><td class="mdescLeft"> </td><td class="mdescRight">Memory mapped IO range physical address. <br /></td></tr>
|
|
<tr class="separator:adcff263c48e6933220897117cd8c54c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4dcd0e08ea665120251c0a61830bc537"><td class="memItemLeft" align="right" valign="top"><a id="a4dcd0e08ea665120251c0a61830bc537"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a4dcd0e08ea665120251c0a61830bc537">OS_MMIO_SIZE</a>   0x400000</td></tr>
|
|
<tr class="memdesc:a4dcd0e08ea665120251c0a61830bc537"><td class="mdescLeft"> </td><td class="mdescRight">Memory mapped IO range size (4 MiB) <br /></td></tr>
|
|
<tr class="separator:a4dcd0e08ea665120251c0a61830bc537"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a257f319d3665a6973ff7f6bfab034c1c"><td class="memItemLeft" align="right" valign="top"><a id="a257f319d3665a6973ff7f6bfab034c1c"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a257f319d3665a6973ff7f6bfab034c1c">OS_VRAM_VADDR</a>   0x1F000000</td></tr>
|
|
<tr class="memdesc:a257f319d3665a6973ff7f6bfab034c1c"><td class="mdescLeft"> </td><td class="mdescRight">VRAM virtual address. <br /></td></tr>
|
|
<tr class="separator:a257f319d3665a6973ff7f6bfab034c1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa54cb94190acf66752380c99db1b235"><td class="memItemLeft" align="right" valign="top"><a id="aaa54cb94190acf66752380c99db1b235"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#aaa54cb94190acf66752380c99db1b235">OS_VRAM_PADDR</a>   0x18000000</td></tr>
|
|
<tr class="memdesc:aaa54cb94190acf66752380c99db1b235"><td class="mdescLeft"> </td><td class="mdescRight">VRAM physical address. <br /></td></tr>
|
|
<tr class="separator:aaa54cb94190acf66752380c99db1b235"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d114961536f1bb0385d25c433c657e5"><td class="memItemLeft" align="right" valign="top"><a id="a9d114961536f1bb0385d25c433c657e5"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a9d114961536f1bb0385d25c433c657e5">OS_VRAM_SIZE</a>   0x600000</td></tr>
|
|
<tr class="memdesc:a9d114961536f1bb0385d25c433c657e5"><td class="mdescLeft"> </td><td class="mdescRight">VRAM size (6 MiB) <br /></td></tr>
|
|
<tr class="separator:a9d114961536f1bb0385d25c433c657e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85b86b666c6400935e24ccbe4d5630cd"><td class="memItemLeft" align="right" valign="top"><a id="a85b86b666c6400935e24ccbe4d5630cd"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a85b86b666c6400935e24ccbe4d5630cd">OS_DSPRAM_VADDR</a>   0x1FF00000</td></tr>
|
|
<tr class="memdesc:a85b86b666c6400935e24ccbe4d5630cd"><td class="mdescLeft"> </td><td class="mdescRight">DSP memory virtual address. <br /></td></tr>
|
|
<tr class="separator:a85b86b666c6400935e24ccbe4d5630cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84c0fa82e1298c9ef6fee39e54b10b9b"><td class="memItemLeft" align="right" valign="top"><a id="a84c0fa82e1298c9ef6fee39e54b10b9b"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a84c0fa82e1298c9ef6fee39e54b10b9b">OS_DSPRAM_PADDR</a>   0x1FF00000</td></tr>
|
|
<tr class="memdesc:a84c0fa82e1298c9ef6fee39e54b10b9b"><td class="mdescLeft"> </td><td class="mdescRight">DSP memory physical address. <br /></td></tr>
|
|
<tr class="separator:a84c0fa82e1298c9ef6fee39e54b10b9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af635d5643a14dd1742f1e416e3a5cacd"><td class="memItemLeft" align="right" valign="top"><a id="af635d5643a14dd1742f1e416e3a5cacd"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#af635d5643a14dd1742f1e416e3a5cacd">OS_DSPRAM_SIZE</a>   0x80000</td></tr>
|
|
<tr class="memdesc:af635d5643a14dd1742f1e416e3a5cacd"><td class="mdescLeft"> </td><td class="mdescRight">DSP memory size (512 KiB) <br /></td></tr>
|
|
<tr class="separator:af635d5643a14dd1742f1e416e3a5cacd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a79af6c4935190ea9f1e97825fdaba5"><td class="memItemLeft" align="right" valign="top"><a id="a9a79af6c4935190ea9f1e97825fdaba5"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a9a79af6c4935190ea9f1e97825fdaba5">OS_KERNELCFG_VADDR</a>   0x1FF80000</td></tr>
|
|
<tr class="memdesc:a9a79af6c4935190ea9f1e97825fdaba5"><td class="mdescLeft"> </td><td class="mdescRight">Kernel configuration page virtual address. <br /></td></tr>
|
|
<tr class="separator:a9a79af6c4935190ea9f1e97825fdaba5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88de8f3029eebb77d9247b51bba3246a"><td class="memItemLeft" align="right" valign="top"><a id="a88de8f3029eebb77d9247b51bba3246a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a88de8f3029eebb77d9247b51bba3246a">OS_SHAREDCFG_VADDR</a>   0x1FF81000</td></tr>
|
|
<tr class="memdesc:a88de8f3029eebb77d9247b51bba3246a"><td class="mdescLeft"> </td><td class="mdescRight">Shared system configuration page virtual address. <br /></td></tr>
|
|
<tr class="separator:a88de8f3029eebb77d9247b51bba3246a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c42fad973b18285c89eb14ec0d687d4"><td class="memItemLeft" align="right" valign="top"><a id="a3c42fad973b18285c89eb14ec0d687d4"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a3c42fad973b18285c89eb14ec0d687d4">OS_FCRAM_VADDR</a>   0x30000000</td></tr>
|
|
<tr class="memdesc:a3c42fad973b18285c89eb14ec0d687d4"><td class="mdescLeft"> </td><td class="mdescRight">Linear FCRAM mapping virtual address. <br /></td></tr>
|
|
<tr class="separator:a3c42fad973b18285c89eb14ec0d687d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae730e758255a129b372ae7417fe235d5"><td class="memItemLeft" align="right" valign="top"><a id="ae730e758255a129b372ae7417fe235d5"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#ae730e758255a129b372ae7417fe235d5">OS_FCRAM_PADDR</a>   0x20000000</td></tr>
|
|
<tr class="memdesc:ae730e758255a129b372ae7417fe235d5"><td class="mdescLeft"> </td><td class="mdescRight">Linear FCRAM mapping physical address. <br /></td></tr>
|
|
<tr class="separator:ae730e758255a129b372ae7417fe235d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaef63c2ac4cc3aa389bdcc26911131b0"><td class="memItemLeft" align="right" valign="top"><a id="aaef63c2ac4cc3aa389bdcc26911131b0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#aaef63c2ac4cc3aa389bdcc26911131b0">OS_FCRAM_SIZE</a>   0x10000000</td></tr>
|
|
<tr class="memdesc:aaef63c2ac4cc3aa389bdcc26911131b0"><td class="mdescLeft"> </td><td class="mdescRight">Linear FCRAM mapping size (256 MiB) <br /></td></tr>
|
|
<tr class="separator:aaef63c2ac4cc3aa389bdcc26911131b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a110240637e208519619c37d675e0f7b0"><td class="memItemLeft" align="right" valign="top"><a id="a110240637e208519619c37d675e0f7b0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a110240637e208519619c37d675e0f7b0">OS_KernelConfig</a>   ((<a class="el" href="structosKernelConfig__s.html">osKernelConfig_s</a> const*)<a class="el" href="os_8h.html#a9a79af6c4935190ea9f1e97825fdaba5">OS_KERNELCFG_VADDR</a>)</td></tr>
|
|
<tr class="memdesc:a110240637e208519619c37d675e0f7b0"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the kernel configuration page (see <a class="el" href="structosKernelConfig__s.html">osKernelConfig_s</a>) <br /></td></tr>
|
|
<tr class="separator:a110240637e208519619c37d675e0f7b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8f51101cc5a2564100ed3686645151f"><td class="memItemLeft" align="right" valign="top"><a id="ac8f51101cc5a2564100ed3686645151f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#ac8f51101cc5a2564100ed3686645151f">OS_SharedConfig</a>   ((<a class="el" href="structosSharedConfig__s.html">osSharedConfig_s</a>*)<a class="el" href="os_8h.html#a88de8f3029eebb77d9247b51bba3246a">OS_SHAREDCFG_VADDR</a>)</td></tr>
|
|
<tr class="memdesc:ac8f51101cc5a2564100ed3686645151f"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the shared system configuration page (see <a class="el" href="structosSharedConfig__s.html">osSharedConfig_s</a>) <br /></td></tr>
|
|
<tr class="separator:ac8f51101cc5a2564100ed3686645151f"><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:ad5be83050dcdaf4ba7824a2afd420866"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#ad5be83050dcdaf4ba7824a2afd420866">osConvertVirtToPhys</a> (const void *vaddr)</td></tr>
|
|
<tr class="memdesc:ad5be83050dcdaf4ba7824a2afd420866"><td class="mdescLeft"> </td><td class="mdescRight">Converts an address from virtual (process) memory to physical memory. <a href="os_8h.html#ad5be83050dcdaf4ba7824a2afd420866">More...</a><br /></td></tr>
|
|
<tr class="separator:ad5be83050dcdaf4ba7824a2afd420866"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41ed4b6791dc260649c69b1c065f232e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a41ed4b6791dc260649c69b1c065f232e">osConvertOldLINEARMemToNew</a> (const void *vaddr)</td></tr>
|
|
<tr class="memdesc:a41ed4b6791dc260649c69b1c065f232e"><td class="mdescLeft"> </td><td class="mdescRight">Converts 0x14* vmem to 0x30*. <a href="os_8h.html#a41ed4b6791dc260649c69b1c065f232e">More...</a><br /></td></tr>
|
|
<tr class="separator:a41ed4b6791dc260649c69b1c065f232e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a061ac8524aac2414f830fa821da7df03"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a061ac8524aac2414f830fa821da7df03">osStrError</a> (<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> error)</td></tr>
|
|
<tr class="memdesc:a061ac8524aac2414f830fa821da7df03"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves basic information about a service error. <a href="os_8h.html#a061ac8524aac2414f830fa821da7df03">More...</a><br /></td></tr>
|
|
<tr class="separator:a061ac8524aac2414f830fa821da7df03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a383e9cab6b8d56a0e419fc830fe4c4e2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a383e9cab6b8d56a0e419fc830fe4c4e2">osGetFirmVersion</a> (void)</td></tr>
|
|
<tr class="memdesc:a383e9cab6b8d56a0e419fc830fe4c4e2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the system's FIRM version. <a href="os_8h.html#a383e9cab6b8d56a0e419fc830fe4c4e2">More...</a><br /></td></tr>
|
|
<tr class="separator:a383e9cab6b8d56a0e419fc830fe4c4e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19f063780d025bae2b9c169440eb7598"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a19f063780d025bae2b9c169440eb7598">osGetKernelVersion</a> (void)</td></tr>
|
|
<tr class="memdesc:a19f063780d025bae2b9c169440eb7598"><td class="mdescLeft"> </td><td class="mdescRight">Gets the system's kernel version. <a href="os_8h.html#a19f063780d025bae2b9c169440eb7598">More...</a><br /></td></tr>
|
|
<tr class="separator:a19f063780d025bae2b9c169440eb7598"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b38d0ea945c9816d1f7173334227a0e"><td class="memItemLeft" align="right" valign="top"><a id="a8b38d0ea945c9816d1f7173334227a0e"></a>
|
|
static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a8b38d0ea945c9816d1f7173334227a0e">osGetSystemCoreVersion</a> (void)</td></tr>
|
|
<tr class="memdesc:a8b38d0ea945c9816d1f7173334227a0e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the system's "core version" (2 on NATIVE_FIRM, 3 on SAFE_FIRM, etc.) <br /></td></tr>
|
|
<tr class="separator:a8b38d0ea945c9816d1f7173334227a0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f8d5fa6b6dcdd275499eea50219bfb3"><td class="memItemLeft" align="right" valign="top"><a id="a2f8d5fa6b6dcdd275499eea50219bfb3"></a>
|
|
static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a2f8d5fa6b6dcdd275499eea50219bfb3">osGetApplicationMemType</a> (void)</td></tr>
|
|
<tr class="memdesc:a2f8d5fa6b6dcdd275499eea50219bfb3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the system's memory layout ID (0-5 on Old 3DS, 6-8 on New 3DS) <br /></td></tr>
|
|
<tr class="separator:a2f8d5fa6b6dcdd275499eea50219bfb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84c11685ada809c00648ff3fa9d9c8d8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a84c11685ada809c00648ff3fa9d9c8d8">osGetMemRegionSize</a> (<a class="el" href="svc_8h.html#ac4f63d4e584005af063b41bc55bb92eb">MemRegion</a> region)</td></tr>
|
|
<tr class="memdesc:a84c11685ada809c00648ff3fa9d9c8d8"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the specified memory region. <a href="os_8h.html#a84c11685ada809c00648ff3fa9d9c8d8">More...</a><br /></td></tr>
|
|
<tr class="separator:a84c11685ada809c00648ff3fa9d9c8d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c7da76485fb0c673bc5b913cb8c7083"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a9c7da76485fb0c673bc5b913cb8c7083">osGetMemRegionUsed</a> (<a class="el" href="svc_8h.html#ac4f63d4e584005af063b41bc55bb92eb">MemRegion</a> region)</td></tr>
|
|
<tr class="memdesc:a9c7da76485fb0c673bc5b913cb8c7083"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of used bytes within the specified memory region. <a href="os_8h.html#a9c7da76485fb0c673bc5b913cb8c7083">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c7da76485fb0c673bc5b913cb8c7083"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21dbc581346733ec3fca0a3986dbd046"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a21dbc581346733ec3fca0a3986dbd046">osGetMemRegionFree</a> (<a class="el" href="svc_8h.html#ac4f63d4e584005af063b41bc55bb92eb">MemRegion</a> region)</td></tr>
|
|
<tr class="memdesc:a21dbc581346733ec3fca0a3986dbd046"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of free bytes within the specified memory region. <a href="os_8h.html#a21dbc581346733ec3fca0a3986dbd046">More...</a><br /></td></tr>
|
|
<tr class="separator:a21dbc581346733ec3fca0a3986dbd046"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a558cbe8dfd6cb624ca4350a3036cdcf5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structosTimeRef__s.html">osTimeRef_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a558cbe8dfd6cb624ca4350a3036cdcf5">osGetTimeRef</a> (void)</td></tr>
|
|
<tr class="memdesc:a558cbe8dfd6cb624ca4350a3036cdcf5"><td class="mdescLeft"> </td><td class="mdescRight">Reads the latest reference timepoint published by PTM. <a href="os_8h.html#a558cbe8dfd6cb624ca4350a3036cdcf5">More...</a><br /></td></tr>
|
|
<tr class="separator:a558cbe8dfd6cb624ca4350a3036cdcf5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a05661250c79188dc1c54cd2776d9fb21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a05661250c79188dc1c54cd2776d9fb21">osGetTime</a> (void)</td></tr>
|
|
<tr class="memdesc:a05661250c79188dc1c54cd2776d9fb21"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current time. <a href="os_8h.html#a05661250c79188dc1c54cd2776d9fb21">More...</a><br /></td></tr>
|
|
<tr class="separator:a05661250c79188dc1c54cd2776d9fb21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae51bb4cd74ac9cda5f40cb23b8e5b146"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#ae51bb4cd74ac9cda5f40cb23b8e5b146">osTickCounterStart</a> (<a class="el" href="structTickCounter.html">TickCounter</a> *cnt)</td></tr>
|
|
<tr class="memdesc:ae51bb4cd74ac9cda5f40cb23b8e5b146"><td class="mdescLeft"> </td><td class="mdescRight">Starts a tick counter. <a href="os_8h.html#ae51bb4cd74ac9cda5f40cb23b8e5b146">More...</a><br /></td></tr>
|
|
<tr class="separator:ae51bb4cd74ac9cda5f40cb23b8e5b146"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b5624b8fab29f0d4f2d9e996d0a7d21"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a2b5624b8fab29f0d4f2d9e996d0a7d21">osTickCounterUpdate</a> (<a class="el" href="structTickCounter.html">TickCounter</a> *cnt)</td></tr>
|
|
<tr class="memdesc:a2b5624b8fab29f0d4f2d9e996d0a7d21"><td class="mdescLeft"> </td><td class="mdescRight">Updates the elapsed time in a tick counter. <a href="os_8h.html#a2b5624b8fab29f0d4f2d9e996d0a7d21">More...</a><br /></td></tr>
|
|
<tr class="separator:a2b5624b8fab29f0d4f2d9e996d0a7d21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a64822647ef4d119deea35ed971683c35"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a64822647ef4d119deea35ed971683c35">osTickCounterRead</a> (const <a class="el" href="structTickCounter.html">TickCounter</a> *cnt)</td></tr>
|
|
<tr class="memdesc:a64822647ef4d119deea35ed971683c35"><td class="mdescLeft"> </td><td class="mdescRight">Reads the elapsed time in a tick counter. <a href="os_8h.html#a64822647ef4d119deea35ed971683c35">More...</a><br /></td></tr>
|
|
<tr class="separator:a64822647ef4d119deea35ed971683c35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa38acca606f2880ac3ee9f6c531a6eaa"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#aa38acca606f2880ac3ee9f6c531a6eaa">osGetWifiStrength</a> (void)</td></tr>
|
|
<tr class="memdesc:aa38acca606f2880ac3ee9f6c531a6eaa"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current Wifi signal strength. <a href="os_8h.html#aa38acca606f2880ac3ee9f6c531a6eaa">More...</a><br /></td></tr>
|
|
<tr class="separator:aa38acca606f2880ac3ee9f6c531a6eaa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b62a51a9c8f111843c1fd3ef0756026"><td class="memItemLeft" align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a3b62a51a9c8f111843c1fd3ef0756026">osGet3DSliderState</a> (void)</td></tr>
|
|
<tr class="memdesc:a3b62a51a9c8f111843c1fd3ef0756026"><td class="mdescLeft"> </td><td class="mdescRight">Gets the state of the 3D slider. <a href="os_8h.html#a3b62a51a9c8f111843c1fd3ef0756026">More...</a><br /></td></tr>
|
|
<tr class="separator:a3b62a51a9c8f111843c1fd3ef0756026"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e0cfa91ba702211f3a235a36b7901a5"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a8e0cfa91ba702211f3a235a36b7901a5">osIsHeadsetConnected</a> (void)</td></tr>
|
|
<tr class="memdesc:a8e0cfa91ba702211f3a235a36b7901a5"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a headset is connected. <a href="os_8h.html#a8e0cfa91ba702211f3a235a36b7901a5">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e0cfa91ba702211f3a235a36b7901a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7484b739da8ae26a3df6d363eeb13d98"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="os_8h.html#a7484b739da8ae26a3df6d363eeb13d98">osSetSpeedupEnable</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a7484b739da8ae26a3df6d363eeb13d98"><td class="mdescLeft"> </td><td class="mdescRight">Configures the New 3DS speedup. <a href="os_8h.html#a7484b739da8ae26a3df6d363eeb13d98">More...</a><br /></td></tr>
|
|
<tr class="separator:a7484b739da8ae26a3df6d363eeb13d98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3bc6073f0b8a41926ad0de5a2a4d4cb"><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="os_8h.html#ac3bc6073f0b8a41926ad0de5a2a4d4cb">osGetSystemVersionData</a> (<a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> *nver_versionbin, <a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> *cver_versionbin)</td></tr>
|
|
<tr class="memdesc:ac3bc6073f0b8a41926ad0de5a2a4d4cb"><td class="mdescLeft"> </td><td class="mdescRight">Gets the NAND system-version stored in NVer/CVer. <a href="os_8h.html#ac3bc6073f0b8a41926ad0de5a2a4d4cb">More...</a><br /></td></tr>
|
|
<tr class="separator:ac3bc6073f0b8a41926ad0de5a2a4d4cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abeb74bb5b93330aff04bf10d317aa9d3"><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="os_8h.html#abeb74bb5b93330aff04bf10d317aa9d3">osGetSystemVersionDataString</a> (<a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> *nver_versionbin, <a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> *cver_versionbin, char *sysverstr, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> sysverstr_maxsize)</td></tr>
|
|
<tr class="memdesc:abeb74bb5b93330aff04bf10d317aa9d3"><td class="mdescLeft"> </td><td class="mdescRight">This is a wrapper for osGetSystemVersionData. <a href="os_8h.html#abeb74bb5b93330aff04bf10d317aa9d3">More...</a><br /></td></tr>
|
|
<tr class="separator:abeb74bb5b93330aff04bf10d317aa9d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>OS related stuff. </p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a54dfa9664a5032211d512fb04fcd7cac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54dfa9664a5032211d512fb04fcd7cac">◆ </a></span>SYSCLOCK_SOC</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SYSCLOCK_SOC   (16756991u)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>< The external clock rate for the SoC. </p>
|
|
<p>The base system clock rate (for I2C, NDMA, etc.). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a41ed4b6791dc260649c69b1c065f232e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41ed4b6791dc260649c69b1c065f232e">◆ </a></span>osConvertOldLINEARMemToNew()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* osConvertOldLINEARMemToNew </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>vaddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts 0x14* vmem to 0x30*. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vaddr</td><td>Input virtual address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The corresponding address in the 0x30* range, the input address if it's already within the new vmem, or 0 if it's outside of both ranges. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5be83050dcdaf4ba7824a2afd420866"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5be83050dcdaf4ba7824a2afd420866">◆ </a></span>osConvertVirtToPhys()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> osConvertVirtToPhys </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>vaddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts an address from virtual (process) memory to physical memory. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vaddr</td><td>Input virtual address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The corresponding physical address. It is sometimes required by services or when using the GPU command buffer. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="mvd_2source_2main_8c-example.html#a24">mvd/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3b62a51a9c8f111843c1fd3ef0756026"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3b62a51a9c8f111843c1fd3ef0756026">◆ </a></span>osGet3DSliderState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static float osGet3DSliderState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></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>Gets the state of the 3D slider. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The state of the 3D slider (0.0~1.0) </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="graphics_2gpu_2fragment_light_2source_2main_8c-example.html#a31">graphics/gpu/fragment_light/source/main.c</a>, <a class="el" href="graphics_2gpu_2lenny_2source_2main_8c-example.html#a34">graphics/gpu/lenny/source/main.c</a>, <a class="el" href="graphics_2gpu_2particles_2source_2main_8c-example.html#a47">graphics/gpu/particles/source/main.c</a>, and <a class="el" href="graphics_2gpu_2toon_shading_2source_2main_8c-example.html#a38">graphics/gpu/toon_shading/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a383e9cab6b8d56a0e419fc830fe4c4e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a383e9cab6b8d56a0e419fc830fe4c4e2">◆ </a></span>osGetFirmVersion()</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> osGetFirmVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></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>Gets the system's FIRM version. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The system's FIRM version.</dd></dl>
|
|
<p>This can be used to compare system versions easily with <a class="el" href="os_8h.html#aceac399d08eb60be9497b16a9bc7c287">SYSTEM_VERSION</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a19f063780d025bae2b9c169440eb7598"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19f063780d025bae2b9c169440eb7598">◆ </a></span>osGetKernelVersion()</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> osGetKernelVersion </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></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>Gets the system's kernel version. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The system's kernel version.</dd></dl>
|
|
<p>This can be used to compare system versions easily with <a class="el" href="os_8h.html#aceac399d08eb60be9497b16a9bc7c287">SYSTEM_VERSION</a>.</p>
|
|
<div class="fragment"><div class="line"><span class="keywordflow">if</span>(<a class="code" href="os_8h.html#a19f063780d025bae2b9c169440eb7598">osGetKernelVersion</a>() > <a class="code" href="os_8h.html#aceac399d08eb60be9497b16a9bc7c287">SYSTEM_VERSION</a>(2,46,0)) printf(<span class="stringliteral">"You are running 9.0 or higher\n"</span>);</div>
|
|
<div class="ttc" id="aos_8h_html_a19f063780d025bae2b9c169440eb7598"><div class="ttname"><a href="os_8h.html#a19f063780d025bae2b9c169440eb7598">osGetKernelVersion</a></div><div class="ttdeci">static u32 osGetKernelVersion(void)</div><div class="ttdoc">Gets the system's kernel version.</div><div class="ttdef"><b>Definition:</b> os.h:197</div></div>
|
|
<div class="ttc" id="aos_8h_html_aceac399d08eb60be9497b16a9bc7c287"><div class="ttname"><a href="os_8h.html#aceac399d08eb60be9497b16a9bc7c287">SYSTEM_VERSION</a></div><div class="ttdeci">#define SYSTEM_VERSION(major, minor, revision)</div><div class="ttdoc">Packs a system version from its components.</div><div class="ttdef"><b>Definition:</b> os.h:29</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a21dbc581346733ec3fca0a3986dbd046"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21dbc581346733ec3fca0a3986dbd046">◆ </a></span>osGetMemRegionFree()</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> osGetMemRegionFree </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="svc_8h.html#ac4f63d4e584005af063b41bc55bb92eb">MemRegion</a> </td>
|
|
<td class="paramname"><em>region</em></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>Gets the number of free bytes within the specified memory region. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">region</td><td>Memory region to check. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of free bytes of memory. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84c11685ada809c00648ff3fa9d9c8d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84c11685ada809c00648ff3fa9d9c8d8">◆ </a></span>osGetMemRegionSize()</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> osGetMemRegionSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="svc_8h.html#ac4f63d4e584005af063b41bc55bb92eb">MemRegion</a> </td>
|
|
<td class="paramname"><em>region</em></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>Gets the size of the specified memory region. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">region</td><td>Memory region to check. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The size of the memory region, in bytes. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c7da76485fb0c673bc5b913cb8c7083"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c7da76485fb0c673bc5b913cb8c7083">◆ </a></span>osGetMemRegionUsed()</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> osGetMemRegionUsed </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="svc_8h.html#ac4f63d4e584005af063b41bc55bb92eb">MemRegion</a> </td>
|
|
<td class="paramname"><em>region</em></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>Gets the number of used bytes within the specified memory region. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">region</td><td>Memory region to check. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of used bytes of memory. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac3bc6073f0b8a41926ad0de5a2a4d4cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac3bc6073f0b8a41926ad0de5a2a4d4cb">◆ </a></span>osGetSystemVersionData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> osGetSystemVersionData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> * </td>
|
|
<td class="paramname"><em>nver_versionbin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> * </td>
|
|
<td class="paramname"><em>cver_versionbin</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the NAND system-version stored in NVer/CVer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nver_versionbin</td><td>Output <a class="el" href="structOS__VersionBin.html" title="OS_VersionBin. Format of the system version: "<major>.<minor>.<build>-<nupver><region>".">OS_VersionBin</a> structure for the data read from NVer. </td></tr>
|
|
<tr><td class="paramname">cver_versionbin</td><td>Output <a class="el" href="structOS__VersionBin.html" title="OS_VersionBin. Format of the system version: "<major>.<minor>.<build>-<nupver><region>".">OS_VersionBin</a> structure for the data read from CVer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The result-code. This value can be positive if opening "romfs:/version.bin" fails with stdio, since errno would be returned in that case. In some cases the error can be special negative values as well. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abeb74bb5b93330aff04bf10d317aa9d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abeb74bb5b93330aff04bf10d317aa9d3">◆ </a></span>osGetSystemVersionDataString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> osGetSystemVersionDataString </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> * </td>
|
|
<td class="paramname"><em>nver_versionbin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structOS__VersionBin.html">OS_VersionBin</a> * </td>
|
|
<td class="paramname"><em>cver_versionbin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>sysverstr</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>sysverstr_maxsize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This is a wrapper for osGetSystemVersionData. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nver_versionbin</td><td>Optional output <a class="el" href="structOS__VersionBin.html" title="OS_VersionBin. Format of the system version: "<major>.<minor>.<build>-<nupver><region>".">OS_VersionBin</a> structure for the data read from NVer, can be NULL. </td></tr>
|
|
<tr><td class="paramname">cver_versionbin</td><td>Optional output <a class="el" href="structOS__VersionBin.html" title="OS_VersionBin. Format of the system version: "<major>.<minor>.<build>-<nupver><region>".">OS_VersionBin</a> structure for the data read from CVer, can be NULL. </td></tr>
|
|
<tr><td class="paramname">sysverstr</td><td>Output string where the printed system-version will be written, in the same format displayed by the System Settings title. </td></tr>
|
|
<tr><td class="paramname">sysverstr_maxsize</td><td>Max size of the above string buffer, <em>including</em> NULL-terminator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>See osGetSystemVersionData. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a05661250c79188dc1c54cd2776d9fb21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a05661250c79188dc1c54cd2776d9fb21">◆ </a></span>osGetTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> osGetTime </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 current time. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of milliseconds since 1st Jan 1900 00:00. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a558cbe8dfd6cb624ca4350a3036cdcf5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a558cbe8dfd6cb624ca4350a3036cdcf5">◆ </a></span>osGetTimeRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structosTimeRef__s.html">osTimeRef_s</a> osGetTimeRef </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the latest reference timepoint published by PTM. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Structure (see <a class="el" href="structosTimeRef__s.html">osTimeRef_s</a>). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa38acca606f2880ac3ee9f6c531a6eaa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa38acca606f2880ac3ee9f6c531a6eaa">◆ </a></span>osGetWifiStrength()</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#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> osGetWifiStrength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></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>Gets the current Wifi signal strength. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current Wifi signal strength.</dd></dl>
|
|
<p>Valid values are 0-3:</p><ul>
|
|
<li>0 means the signal strength is terrible or the 3DS is disconnected from all networks.</li>
|
|
<li>1 means the signal strength is bad.</li>
|
|
<li>2 means the signal strength is decent.</li>
|
|
<li>3 means the signal strength is good.</li>
|
|
</ul>
|
|
<p>Values outside the range of 0-3 should never be returned.</p>
|
|
<p>These values correspond with the number of wifi bars displayed by Home Menu. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8e0cfa91ba702211f3a235a36b7901a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e0cfa91ba702211f3a235a36b7901a5">◆ </a></span>osIsHeadsetConnected()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool osIsHeadsetConnected </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></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>Checks whether a headset is connected. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true or false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7484b739da8ae26a3df6d363eeb13d98"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7484b739da8ae26a3df6d363eeb13d98">◆ </a></span>osSetSpeedupEnable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void osSetSpeedupEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures the New 3DS speedup. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>Specifies whether to enable or disable the speedup. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a061ac8524aac2414f830fa821da7df03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a061ac8524aac2414f830fa821da7df03">◆ </a></span>osStrError()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* osStrError </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td>
|
|
<td class="paramname"><em>error</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves basic information about a service error. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">error</td><td>Error to retrieve information about. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string containing a summary of an error.</dd></dl>
|
|
<p>This can be used to get some details about an error returned by a service call. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a64822647ef4d119deea35ed971683c35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a64822647ef4d119deea35ed971683c35">◆ </a></span>osTickCounterRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double osTickCounterRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structTickCounter.html">TickCounter</a> * </td>
|
|
<td class="paramname"><em>cnt</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the elapsed time in a tick counter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cnt</td><td>The tick counter. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of milliseconds elapsed. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae51bb4cd74ac9cda5f40cb23b8e5b146"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae51bb4cd74ac9cda5f40cb23b8e5b146">◆ </a></span>osTickCounterStart()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void osTickCounterStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structTickCounter.html">TickCounter</a> * </td>
|
|
<td class="paramname"><em>cnt</em></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>Starts a tick counter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cnt</td><td>The tick counter. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2b5624b8fab29f0d4f2d9e996d0a7d21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2b5624b8fab29f0d4f2d9e996d0a7d21">◆ </a></span>osTickCounterUpdate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void osTickCounterUpdate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structTickCounter.html">TickCounter</a> * </td>
|
|
<td class="paramname"><em>cnt</em></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>Updates the elapsed time in a tick counter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cnt</td><td>The tick counter. </td></tr>
|
|
</table>
|
|
</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>
|