The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2024-12-05 03:24:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
wut/group__coreinit__memory.html
Ash Logan b225d3cb49 doxygen: rebuild against 1.0.0-beta9
2020-03-26 16:49:18 +11:00

426 lines
21 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: Memory</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">wut
&#160;<span id="projectnumber">1.0.0-beta9</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Memory<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga872e7b1a86d84d2c81bb8a50aff47ab7"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#ga872e7b1a86d84d2c81bb8a50aff47ab7">OSMemoryType</a></td></tr>
<tr class="separator:ga872e7b1a86d84d2c81bb8a50aff47ab7"><td class="memSeparator" colspan="2">&#160;</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:ga5adafa4b1651c95c686848b6873866ec"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a> { <br />
&#160;&#160;<a class="el" href="group__coreinit__memory.html#gga5adafa4b1651c95c686848b6873866eca46057099b28a70b64cfcaa5949d7a79d">OS_MEM1</a> = 1,
<br />
&#160;&#160;<a class="el" href="group__coreinit__memory.html#gga5adafa4b1651c95c686848b6873866eca5d4494dd03c6253b9688b016d91b0bac">OS_MEM2</a> = 2
<br />
}</td></tr>
<tr class="separator:ga5adafa4b1651c95c686848b6873866ec"><td class="memSeparator" colspan="2">&#160;</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:ga5e52e7faf134760ba17a37dcff0a6788"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#ga5e52e7faf134760ba17a37dcff0a6788">OSBlockMove</a> (void *dst, const void *src, uint32_t size, <a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> flush)</td></tr>
<tr class="memdesc:ga5e52e7faf134760ba17a37dcff0a6788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves chunks of memory around, similarly to memmove. <a href="group__coreinit__memory.html#ga5e52e7faf134760ba17a37dcff0a6788">More...</a><br /></td></tr>
<tr class="separator:ga5e52e7faf134760ba17a37dcff0a6788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ca4424434d82a1c79fd4fcd5493c1fa"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#ga2ca4424434d82a1c79fd4fcd5493c1fa">OSBlockSet</a> (void *dst, uint8_t val, uint32_t size)</td></tr>
<tr class="memdesc:ga2ca4424434d82a1c79fd4fcd5493c1fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills a chunk of memory with the given value, like memset. <a href="group__coreinit__memory.html#ga2ca4424434d82a1c79fd4fcd5493c1fa">More...</a><br /></td></tr>
<tr class="separator:ga2ca4424434d82a1c79fd4fcd5493c1fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabafbbb8aa2105c955064038989db76ab"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#gabafbbb8aa2105c955064038989db76ab">OSAllocFromSystem</a> (uint32_t size, int align)</td></tr>
<tr class="separator:gabafbbb8aa2105c955064038989db76ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1528594494814190475a913109146db8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#ga1528594494814190475a913109146db8">OSFreeToSystem</a> (void *ptr)</td></tr>
<tr class="separator:ga1528594494814190475a913109146db8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacf36057de0bc1f98db6a96217cc08b64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#gacf36057de0bc1f98db6a96217cc08b64">OSGetForegroundBucket</a> (uint32_t *outAddr, uint32_t *outSize)</td></tr>
<tr class="memdesc:gacf36057de0bc1f98db6a96217cc08b64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the location and size of the foreground bucket memory area. <a href="group__coreinit__memory.html#gacf36057de0bc1f98db6a96217cc08b64">More...</a><br /></td></tr>
<tr class="separator:gacf36057de0bc1f98db6a96217cc08b64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga381f32576f1c11cc6398be6b350a8619"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#ga381f32576f1c11cc6398be6b350a8619">OSGetForegroundBucketFreeArea</a> (uint32_t *outAddr, uint32_t *outSize)</td></tr>
<tr class="memdesc:ga381f32576f1c11cc6398be6b350a8619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the location and size of the application-usable portion of the foreground bucket area. <a href="group__coreinit__memory.html#ga381f32576f1c11cc6398be6b350a8619">More...</a><br /></td></tr>
<tr class="separator:ga381f32576f1c11cc6398be6b350a8619"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ca445b0dbea2a2063b1a84bb5b0ad40"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memory.html#ga4ca445b0dbea2a2063b1a84bb5b0ad40">OSGetMemBound</a> (<a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a> type, uint32_t *outAddr, uint32_t *outSize)</td></tr>
<tr class="memdesc:ga4ca445b0dbea2a2063b1a84bb5b0ad40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the location and size of available memory areas. <a href="group__coreinit__memory.html#ga4ca445b0dbea2a2063b1a84bb5b0ad40">More...</a><br /></td></tr>
<tr class="separator:ga4ca445b0dbea2a2063b1a84bb5b0ad40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga872e7b1a86d84d2c81bb8a50aff47ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga872e7b1a86d84d2c81bb8a50aff47ab7">&#9670;&nbsp;</a></span>OSMemoryType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a> <a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga5adafa4b1651c95c686848b6873866ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5adafa4b1651c95c686848b6873866ec">&#9670;&nbsp;</a></span>OSMemoryType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5adafa4b1651c95c686848b6873866eca46057099b28a70b64cfcaa5949d7a79d"></a>OS_MEM1&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="gga5adafa4b1651c95c686848b6873866eca5d4494dd03c6253b9688b016d91b0bac"></a>OS_MEM2&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="memory_8h_source.html#l00015">15</a> of file <a class="el" href="memory_8h_source.html">memory.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga5e52e7faf134760ba17a37dcff0a6788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5e52e7faf134760ba17a37dcff0a6788">&#9670;&nbsp;</a></span>OSBlockMove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* OSBlockMove </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td>
<td class="paramname"><em>flush</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves chunks of memory around, similarly to memmove. </p>
<p>Overlapping source and destination regions are supported.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>The destination address for the move.</td></tr>
<tr><td class="paramname">src</td><td>The source address for the move.</td></tr>
<tr><td class="paramname">size</td><td>The size of the data to be moved, in bytes.</td></tr>
<tr><td class="paramname">flush</td><td>Whether to flush the data caches for the source and destination.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>dst is returned.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function makes use of the cache to speed up the copy, so a flush is recommended. </dd></dl>
</div>
</div>
<a id="ga2ca4424434d82a1c79fd4fcd5493c1fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2ca4424434d82a1c79fd4fcd5493c1fa">&#9670;&nbsp;</a></span>OSBlockSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* OSBlockSet </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills a chunk of memory with the given value, like memset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Pointer to the memory to fill.</td></tr>
<tr><td class="paramname">val</td><td>Byte value to be set.</td></tr>
<tr><td class="paramname">size</td><td>Number of bytes to be set to val.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>dst is returned. </dd></dl>
</div>
</div>
<a id="gabafbbb8aa2105c955064038989db76ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabafbbb8aa2105c955064038989db76ab">&#9670;&nbsp;</a></span>OSAllocFromSystem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* OSAllocFromSystem </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>align</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga1528594494814190475a913109146db8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1528594494814190475a913109146db8">&#9670;&nbsp;</a></span>OSFreeToSystem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSFreeToSystem </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gacf36057de0bc1f98db6a96217cc08b64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacf36057de0bc1f98db6a96217cc08b64">&#9670;&nbsp;</a></span>OSGetForegroundBucket()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> OSGetForegroundBucket </td>
<td>(</td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>outAddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>outSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the location and size of the foreground bucket memory area. </p>
<dl class="section note"><dt>Note</dt><dd>This function may not account for the system reserved portion of the foreground bucket. Consider using <a class="el" href="group__coreinit__memory.html#ga381f32576f1c11cc6398be6b350a8619" title="Gets the location and size of the application-usable portion of the foreground bucket area.">OSGetForegroundBucketFreeArea()</a> instead.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outAddr</td><td>Pointer to write the foreground bucket's address to.</td></tr>
<tr><td class="paramname">outSize</td><td>Pointer to write the foreground bucket's size to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. </dd></dl>
</div>
</div>
<a id="ga381f32576f1c11cc6398be6b350a8619"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga381f32576f1c11cc6398be6b350a8619">&#9670;&nbsp;</a></span>OSGetForegroundBucketFreeArea()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> OSGetForegroundBucketFreeArea </td>
<td>(</td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>outAddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>outSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the location and size of the application-usable portion of the foreground bucket area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outAddr</td><td>Pointer to write the bucket area's address to.</td></tr>
<tr><td class="paramname">outSize</td><td>Pointer to write the bucket area's size to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. </dd></dl>
</div>
</div>
<a id="ga4ca445b0dbea2a2063b1a84bb5b0ad40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ca445b0dbea2a2063b1a84bb5b0ad40">&#9670;&nbsp;</a></span>OSGetMemBound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OSGetMemBound </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>outAddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>outSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the location and size of available memory areas. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Type of memory to get information about. See <a class="el" href="group__coreinit__memory.html#ga5adafa4b1651c95c686848b6873866ec">OSMemoryType</a>.</td></tr>
<tr><td class="paramname">outAddr</td><td>Pointer to write the area's address to.</td></tr>
<tr><td class="paramname">outSize</td><td>Pointer to write the area's size to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink