mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-21 20:42:44 +02:00
208 lines
29 KiB
HTML
208 lines
29 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libnx: include/switch/kernel/tmem.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">libnx<span id="projectnumber"> v4.9.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div 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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_36b4ff30955378a33ed199d75bfba1a9.html">kernel</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">tmem.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="tmem_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file tmem.h</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Transfer memory handling</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author plutoo</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @copyright libnx Authors</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * @remark Transfer memory differs from shared memory in the fact that the user process (as opposed to the kernel) allocates and owns its backing memory.</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "../types.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "../kernel/svc.h"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">/// Transfer memory information structure.</span></div>
|
|
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structTransferMemory.html"> 13</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structTransferMemory.html#a33cba4867d5bc3e2dc23638656185cad"> 14</a></span> <a class="code hl_typedef" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code hl_variable" href="structTransferMemory.html#a33cba4867d5bc3e2dc23638656185cad">handle</a>; <span class="comment">///< Kernel object handle.</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structTransferMemory.html#ad22907b009950aa1ff042f13fdea158d"> 15</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structTransferMemory.html#ad22907b009950aa1ff042f13fdea158d">size</a>; <span class="comment">///< Size of the transfer memory object.</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structTransferMemory.html#a31f60f0f83f3cfbf7ff35621edc431b8"> 16</a></span> <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> <a class="code hl_variable" href="structTransferMemory.html#a31f60f0f83f3cfbf7ff35621edc431b8">perm</a>; <span class="comment">///< Permissions of the transfer memory object.</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structTransferMemory.html#a989956b643d771502d751236546b1fc4"> 17</a></span> <span class="keywordtype">void</span>* <a class="code hl_variable" href="structTransferMemory.html#a989956b643d771502d751236546b1fc4">src_addr</a>; <span class="comment">///< Address of the source backing memory.</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structTransferMemory.html#ac4d1db71755bcc90c9aca1184e4865c3"> 18</a></span> <span class="keywordtype">void</span>* <a class="code hl_variable" href="structTransferMemory.html#ac4d1db71755bcc90c9aca1184e4865c3">map_addr</a>; <span class="comment">///< Address to which the transfer memory object is mapped.</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>} <a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @brief Creates a transfer memory object.</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @param t Transfer memory information structure that will be filled in.</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @param size Size of the transfer memory object to create.</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @param perm Permissions with which to protect the transfer memory in the local process.</span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @return Result code.</span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="tmem_8h.html#a6ed36c8b072834ce0450531c5b0730d1"> 28</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="tmem_8h.html#a6ed36c8b072834ce0450531c5b0730d1">tmemCreate</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t, <span class="keywordtype">size_t</span> size, <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> perm);</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @brief Creates a transfer memory object from existing memory.</span></div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param t Transfer memory information structure that will be filled in.</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param buf Pointer to a page-aligned buffer.</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @param size Size of the transfer memory object to create.</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> * @param perm Permissions with which to protect the transfer memory in the local process.</span></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> * @return Result code.</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="tmem_8h.html#a76c801699c473fc232c7f315e4debb51"> 38</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="tmem_8h.html#a76c801699c473fc232c7f315e4debb51">tmemCreateFromMemory</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t, <span class="keywordtype">void</span>* buf, <span class="keywordtype">size_t</span> size, <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> perm);</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @brief Loads a transfer memory object coming from a remote process.</span></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @param t Transfer memory information structure which will be filled in.</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> * @param handle Handle of the transfer memory object.</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> * @param size Size of the transfer memory object that is being loaded.</span></div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * @param perm Permissions which the transfer memory is expected to have in the process that owns the memory.</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @warning This is a privileged operation; in normal circumstances applications shouldn't use this function.</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="tmem_8h.html#a71f02408ca63722f70f68ee67f922d1d"> 48</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="tmem_8h.html#a71f02408ca63722f70f68ee67f922d1d">tmemLoadRemote</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t, <a class="code hl_typedef" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> handle, <span class="keywordtype">size_t</span> size, <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> perm);</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @brief Maps a transfer memory object.</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @param t Transfer memory information structure.</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * @return Result code.</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> * @warning This is a privileged operation; in normal circumstances applications cannot use this function.</span></div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="tmem_8h.html#a57ea58042b63493cbf981aa22d9bcff2"> 56</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="tmem_8h.html#a57ea58042b63493cbf981aa22d9bcff2">tmemMap</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t);</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @brief Unmaps a transfer memory object.</span></div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @param t Transfer memory information structure.</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> * @return Result code.</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @warning This is a privileged operation; in normal circumstances applications cannot use this function.</span></div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="tmem_8h.html#a081a44fe34a79f96d6bcfd5871c8401b"> 64</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="tmem_8h.html#a081a44fe34a79f96d6bcfd5871c8401b">tmemUnmap</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t);</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> * @brief Retrieves the mapped address of a transfer memory object.</span></div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> * @param t Transfer memory information structure.</span></div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @return Mapped address of the transfer memory object.</span></div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> */</span></div>
|
|
<div class="foldopen" id="foldopen00071" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="tmem_8h.html#a9b46597b02b4d44fcebd854869177a24"> 71</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>* <a class="code hl_function" href="tmem_8h.html#a9b46597b02b4d44fcebd854869177a24">tmemGetAddr</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t){</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordflow">return</span> t-><a class="code hl_variable" href="structTransferMemory.html#ac4d1db71755bcc90c9aca1184e4865c3">map_addr</a>;</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * @brief Closes handle of a transfer memory object.</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @param t Transfer memory information structure.</span></div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> * @return Result code.</span></div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="tmem_8h.html#ac93c2d42f03162ac284e697b49f0bc64"> 80</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="tmem_8h.html#ac93c2d42f03162ac284e697b49f0bc64">tmemCloseHandle</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t);</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> * @brief Waits until source backing memory permissions match perm.</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @param t Transfer memory information structure.</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> * @param perm Permissions which the source backing memory is expected to have before return.</span></div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * @return Result code.</span></div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="tmem_8h.html#aecec2057d8fdd990a77821d2c672e6d3"> 88</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="tmem_8h.html#aecec2057d8fdd990a77821d2c672e6d3">tmemWaitForPermission</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t, <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> perm);</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"> * @brief Frees up resources used by a transfer memory object, unmapping and closing handles, etc.</span></div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"> * @param t Transfer memory information structure.</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"> * @return Result code.</span></div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="tmem_8h.html#ad3456850e1ecfe2b9eac9a5d95aab064"> 95</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="tmem_8h.html#ad3456850e1ecfe2b9eac9a5d95aab064">tmemClose</a>(<a class="code hl_struct" href="structTransferMemory.html">TransferMemory</a>* t);</div>
|
|
<div class="ttc" id="astructTransferMemory_html"><div class="ttname"><a href="structTransferMemory.html">TransferMemory</a></div><div class="ttdoc">Transfer memory information structure.</div><div class="ttdef"><b>Definition</b> tmem.h:13</div></div>
|
|
<div class="ttc" id="astructTransferMemory_html_a31f60f0f83f3cfbf7ff35621edc431b8"><div class="ttname"><a href="structTransferMemory.html#a31f60f0f83f3cfbf7ff35621edc431b8">TransferMemory::perm</a></div><div class="ttdeci">Permission perm</div><div class="ttdoc">Permissions of the transfer memory object.</div><div class="ttdef"><b>Definition</b> tmem.h:16</div></div>
|
|
<div class="ttc" id="astructTransferMemory_html_a33cba4867d5bc3e2dc23638656185cad"><div class="ttname"><a href="structTransferMemory.html#a33cba4867d5bc3e2dc23638656185cad">TransferMemory::handle</a></div><div class="ttdeci">Handle handle</div><div class="ttdoc">Kernel object handle.</div><div class="ttdef"><b>Definition</b> tmem.h:14</div></div>
|
|
<div class="ttc" id="astructTransferMemory_html_a989956b643d771502d751236546b1fc4"><div class="ttname"><a href="structTransferMemory.html#a989956b643d771502d751236546b1fc4">TransferMemory::src_addr</a></div><div class="ttdeci">void * src_addr</div><div class="ttdoc">Address of the source backing memory.</div><div class="ttdef"><b>Definition</b> tmem.h:17</div></div>
|
|
<div class="ttc" id="astructTransferMemory_html_ac4d1db71755bcc90c9aca1184e4865c3"><div class="ttname"><a href="structTransferMemory.html#ac4d1db71755bcc90c9aca1184e4865c3">TransferMemory::map_addr</a></div><div class="ttdeci">void * map_addr</div><div class="ttdoc">Address to which the transfer memory object is mapped.</div><div class="ttdef"><b>Definition</b> tmem.h:18</div></div>
|
|
<div class="ttc" id="astructTransferMemory_html_ad22907b009950aa1ff042f13fdea158d"><div class="ttname"><a href="structTransferMemory.html#ad22907b009950aa1ff042f13fdea158d">TransferMemory::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Size of the transfer memory object.</div><div class="ttdef"><b>Definition</b> tmem.h:15</div></div>
|
|
<div class="ttc" id="asvc_8h_html_a1474fa581c530fcdc28ca0a11770200c"><div class="ttname"><a href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a></div><div class="ttdeci">Permission</div><div class="ttdoc">Memory permission bitmasks.</div><div class="ttdef"><b>Definition</b> svc.h:80</div></div>
|
|
<div class="ttc" id="atmem_8h_html_a081a44fe34a79f96d6bcfd5871c8401b"><div class="ttname"><a href="tmem_8h.html#a081a44fe34a79f96d6bcfd5871c8401b">tmemUnmap</a></div><div class="ttdeci">Result tmemUnmap(TransferMemory *t)</div><div class="ttdoc">Unmaps a transfer memory object.</div></div>
|
|
<div class="ttc" id="atmem_8h_html_a57ea58042b63493cbf981aa22d9bcff2"><div class="ttname"><a href="tmem_8h.html#a57ea58042b63493cbf981aa22d9bcff2">tmemMap</a></div><div class="ttdeci">Result tmemMap(TransferMemory *t)</div><div class="ttdoc">Maps a transfer memory object.</div></div>
|
|
<div class="ttc" id="atmem_8h_html_a6ed36c8b072834ce0450531c5b0730d1"><div class="ttname"><a href="tmem_8h.html#a6ed36c8b072834ce0450531c5b0730d1">tmemCreate</a></div><div class="ttdeci">Result tmemCreate(TransferMemory *t, size_t size, Permission perm)</div><div class="ttdoc">Creates a transfer memory object.</div></div>
|
|
<div class="ttc" id="atmem_8h_html_a71f02408ca63722f70f68ee67f922d1d"><div class="ttname"><a href="tmem_8h.html#a71f02408ca63722f70f68ee67f922d1d">tmemLoadRemote</a></div><div class="ttdeci">void tmemLoadRemote(TransferMemory *t, Handle handle, size_t size, Permission perm)</div><div class="ttdoc">Loads a transfer memory object coming from a remote process.</div></div>
|
|
<div class="ttc" id="atmem_8h_html_a76c801699c473fc232c7f315e4debb51"><div class="ttname"><a href="tmem_8h.html#a76c801699c473fc232c7f315e4debb51">tmemCreateFromMemory</a></div><div class="ttdeci">Result tmemCreateFromMemory(TransferMemory *t, void *buf, size_t size, Permission perm)</div><div class="ttdoc">Creates a transfer memory object from existing memory.</div></div>
|
|
<div class="ttc" id="atmem_8h_html_a9b46597b02b4d44fcebd854869177a24"><div class="ttname"><a href="tmem_8h.html#a9b46597b02b4d44fcebd854869177a24">tmemGetAddr</a></div><div class="ttdeci">static void * tmemGetAddr(TransferMemory *t)</div><div class="ttdoc">Retrieves the mapped address of a transfer memory object.</div><div class="ttdef"><b>Definition</b> tmem.h:71</div></div>
|
|
<div class="ttc" id="atmem_8h_html_ac93c2d42f03162ac284e697b49f0bc64"><div class="ttname"><a href="tmem_8h.html#ac93c2d42f03162ac284e697b49f0bc64">tmemCloseHandle</a></div><div class="ttdeci">Result tmemCloseHandle(TransferMemory *t)</div><div class="ttdoc">Closes handle of a transfer memory object.</div></div>
|
|
<div class="ttc" id="atmem_8h_html_ad3456850e1ecfe2b9eac9a5d95aab064"><div class="ttname"><a href="tmem_8h.html#ad3456850e1ecfe2b9eac9a5d95aab064">tmemClose</a></div><div class="ttdeci">Result tmemClose(TransferMemory *t)</div><div class="ttdoc">Frees up resources used by a transfer memory object, unmapping and closing handles,...</div></div>
|
|
<div class="ttc" id="atmem_8h_html_aecec2057d8fdd990a77821d2c672e6d3"><div class="ttname"><a href="tmem_8h.html#aecec2057d8fdd990a77821d2c672e6d3">tmemWaitForPermission</a></div><div class="ttdeci">Result tmemWaitForPermission(TransferMemory *t, Permission perm)</div><div class="ttdoc">Waits until source backing memory permissions match perm.</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Kernel object handle.</div><div class="ttdef"><b>Definition</b> types.h:43</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
|
|
</div><!-- fragment --></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.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|