mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-23 05:12:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/ins_8h_source.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

160 lines
18 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" 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/services/ins.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">&#160;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&amp;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&amp;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&amp;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_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">ins.h</div></div>
</div><!--header-->
<div class="contents">
<a href="ins_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 ins.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief INS services IPC wrapper.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author averne</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"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;../types.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../kernel/event.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;../sf/service.h&quot;</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">/// Initialize ins:r.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="ins_8h.html#a48e901ea701feda7cac2425b441e8a18"> 13</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="ins_8h.html#a48e901ea701feda7cac2425b441e8a18">insrInitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"></span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">/// Exit ins:r.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="ins_8h.html#af4ac8a3122f98ad71da3dc3465b4f0a3"> 16</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="ins_8h.html#af4ac8a3122f98ad71da3dc3465b4f0a3">insrExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">/// Gets the Service object for the actual ins:r service session.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="ins_8h.html#aab70bd135bccc3e8655f9c39c522b257"> 19</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="ins_8h.html#aab70bd135bccc3e8655f9c39c522b257">insrGetServiceSession</a>(<span class="keywordtype">void</span>);</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 Retrieves the last system tick the event corresponding to the ID was signaled at.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @param[in] id Ins request ID (should be 0..4).</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @param[out] tick.</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @note The tick is only updated once per second at minimum.</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="ins_8h.html#aab6b764d87f526f5017262709ebf512a"> 28</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="ins_8h.html#aab6b764d87f526f5017262709ebf512a">insrGetLastTick</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <span class="keywordtype">id</span>, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *tick);</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 Retrieves the event corresponding to the ID.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param[in] id Ins request ID (should be 0..4).</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param[out] out.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> * @note The event is only signaled once per second at minimum.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> */</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="ins_8h.html#a16fb2ad0031eb01e5033090ccf7634e0"> 37</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="ins_8h.html#a16fb2ad0031eb01e5033090ccf7634e0">insrGetReadableEvent</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <span class="keywordtype">id</span>, <a class="code hl_struct" href="structEvent.html">Event</a> *out);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"></span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment">/// Initialize ins:s.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="ins_8h.html#aefe7f4c0b51a833022f15517e7bccbf8"> 40</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="ins_8h.html#aefe7f4c0b51a833022f15517e7bccbf8">inssInitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"></span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">/// Exit ins:s.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="ins_8h.html#abcd500856c6a3914e97b6c7ce7e01ea6"> 43</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="ins_8h.html#abcd500856c6a3914e97b6c7ce7e01ea6">inssExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"></span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">/// Gets the Service object for the actual ins:s service session.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="ins_8h.html#ada4f1f08b5d128dca8a4fad34f9ed9b1"> 46</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="ins_8h.html#ada4f1f08b5d128dca8a4fad34f9ed9b1">inssGetServiceSession</a>(<span class="keywordtype">void</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"> 48</span><span class="comment">/**</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @brief Retrieves the event corresponding to the ID.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param[in] id Ins send ID (should be 0..11).</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @param[out] out.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * @note The returned event cannot be waited on, only signaled. Clearing is handled by the service.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> */</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="ins_8h.html#a27d591028196cc5f1e8904e000e90034"> 55</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="ins_8h.html#a27d591028196cc5f1e8904e000e90034">inssGetWritableEvent</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <span class="keywordtype">id</span>, <a class="code hl_struct" href="structEvent.html">Event</a> *out);</div>
<div class="ttc" id="ains_8h_html_a16fb2ad0031eb01e5033090ccf7634e0"><div class="ttname"><a href="ins_8h.html#a16fb2ad0031eb01e5033090ccf7634e0">insrGetReadableEvent</a></div><div class="ttdeci">Result insrGetReadableEvent(u32 id, Event *out)</div><div class="ttdoc">Retrieves the event corresponding to the ID.</div></div>
<div class="ttc" id="ains_8h_html_a27d591028196cc5f1e8904e000e90034"><div class="ttname"><a href="ins_8h.html#a27d591028196cc5f1e8904e000e90034">inssGetWritableEvent</a></div><div class="ttdeci">Result inssGetWritableEvent(u32 id, Event *out)</div><div class="ttdoc">Retrieves the event corresponding to the ID.</div></div>
<div class="ttc" id="ains_8h_html_a48e901ea701feda7cac2425b441e8a18"><div class="ttname"><a href="ins_8h.html#a48e901ea701feda7cac2425b441e8a18">insrInitialize</a></div><div class="ttdeci">Result insrInitialize(void)</div><div class="ttdoc">Initialize ins:r.</div></div>
<div class="ttc" id="ains_8h_html_aab6b764d87f526f5017262709ebf512a"><div class="ttname"><a href="ins_8h.html#aab6b764d87f526f5017262709ebf512a">insrGetLastTick</a></div><div class="ttdeci">Result insrGetLastTick(u32 id, u64 *tick)</div><div class="ttdoc">Retrieves the last system tick the event corresponding to the ID was signaled at.</div></div>
<div class="ttc" id="ains_8h_html_aab70bd135bccc3e8655f9c39c522b257"><div class="ttname"><a href="ins_8h.html#aab70bd135bccc3e8655f9c39c522b257">insrGetServiceSession</a></div><div class="ttdeci">Service * insrGetServiceSession(void)</div><div class="ttdoc">Gets the Service object for the actual ins:r service session.</div></div>
<div class="ttc" id="ains_8h_html_abcd500856c6a3914e97b6c7ce7e01ea6"><div class="ttname"><a href="ins_8h.html#abcd500856c6a3914e97b6c7ce7e01ea6">inssExit</a></div><div class="ttdeci">void inssExit(void)</div><div class="ttdoc">Exit ins:s.</div></div>
<div class="ttc" id="ains_8h_html_ada4f1f08b5d128dca8a4fad34f9ed9b1"><div class="ttname"><a href="ins_8h.html#ada4f1f08b5d128dca8a4fad34f9ed9b1">inssGetServiceSession</a></div><div class="ttdeci">Service * inssGetServiceSession(void)</div><div class="ttdoc">Gets the Service object for the actual ins:s service session.</div></div>
<div class="ttc" id="ains_8h_html_aefe7f4c0b51a833022f15517e7bccbf8"><div class="ttname"><a href="ins_8h.html#aefe7f4c0b51a833022f15517e7bccbf8">inssInitialize</a></div><div class="ttdeci">Result inssInitialize(void)</div><div class="ttdoc">Initialize ins:s.</div></div>
<div class="ttc" id="ains_8h_html_af4ac8a3122f98ad71da3dc3465b4f0a3"><div class="ttname"><a href="ins_8h.html#af4ac8a3122f98ad71da3dc3465b4f0a3">insrExit</a></div><div class="ttdeci">void insrExit(void)</div><div class="ttdoc">Exit ins:r.</div></div>
<div class="ttc" id="astructEvent_html"><div class="ttname"><a href="structEvent.html">Event</a></div><div class="ttdoc">Kernel-mode event structure.</div><div class="ttdef"><b>Definition</b> event.h:13</div></div>
<div class="ttc" id="astructService_html"><div class="ttname"><a href="structService.html">Service</a></div><div class="ttdoc">Service object structure.</div><div class="ttdef"><b>Definition</b> service.h:14</div></div>
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</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 class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:21</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink