mirror of
https://github.com/switchbrew/libnx.git
synced 2025-07-03 01:52:14 +02:00
159 lines
16 KiB
HTML
159 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" 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/levent.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">levent.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="levent_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 levent.h</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Light event synchronization primitive [4.0.0+]</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author fincs</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 "../types.h"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "../result.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "<a class="code" href="svc_8h.html">svc.h</a>"</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">/// User-mode light event 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="structLEvent.html"> 13</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structLEvent.html">LEvent</a> {</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> counter;</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordtype">bool</span> autoclear;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>} <a class="code hl_struct" href="structLEvent.html">LEvent</a>;</div>
|
|
</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">/**</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * @brief Initializes a user-mode light event.</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * @param[out] le Pointer to \ref LEvent structure.</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * @param[in] signaled Whether the event starts off in signaled state.</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @param[in] autoclear Autoclear flag.</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> */</span></div>
|
|
<div class="foldopen" id="foldopen00024" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="levent_8h.html#a2496108d9905cdf20d14189c2bf04f44"> 24</a></span><a class="code hl_define" href="types_8h.html#ae2a0903442f062ed4f9f0568a6f1a297">NX_CONSTEXPR</a> <span class="keywordtype">void</span> <a class="code hl_function" href="levent_8h.html#a2496108d9905cdf20d14189c2bf04f44">leventInit</a>(<a class="code hl_struct" href="structLEvent.html">LEvent</a>* le, <span class="keywordtype">bool</span> signaled, <span class="keywordtype">bool</span> autoclear) {</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> le->counter = signaled ? 2 : 0;</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> le->autoclear = autoclear;</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"></span> </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"> * @brief Waits on a user-mode light event.</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @param[in] le Pointer to \ref LEvent structure.</span></div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param[in] timeout_ns Timeout in nanoseconds (pass UINT64_MAX to wait indefinitely).</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @return true if wait succeeded, false if wait timed out.</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="levent_8h.html#a585115dbfe161aeba5646c708276f6df"> 35</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="levent_8h.html#a585115dbfe161aeba5646c708276f6df">leventWait</a>(<a class="code hl_struct" href="structLEvent.html">LEvent</a>* le, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout_ns);</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"> 37</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @brief Polls a user-mode light event.</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @param[in] le Pointer to \ref LEvent structure.</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @return true if event is signaled, false otherwise.</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"><a class="line" href="levent_8h.html#af1f2b5065b0dc51847a39b2f53a5f462"> 42</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="levent_8h.html#af1f2b5065b0dc51847a39b2f53a5f462">leventTryWait</a>(<a class="code hl_struct" href="structLEvent.html">LEvent</a>* le);</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"></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"> * @brief Signals a user-mode light event.</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @param[in] le Pointer to \ref LEvent structure.</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="levent_8h.html#a947dadc8c57ec9631826f7b3d0a7641e"> 48</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="levent_8h.html#a947dadc8c57ec9631826f7b3d0a7641e">leventSignal</a>(<a class="code hl_struct" href="structLEvent.html">LEvent</a>* le);</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 Clears a user-mode light event.</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @param[in] le Pointer to \ref LEvent structure.</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="levent_8h.html#a1414c8d6b33ef406745ee1c16ee194c3"> 54</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="levent_8h.html#a1414c8d6b33ef406745ee1c16ee194c3">leventClear</a>(<a class="code hl_struct" href="structLEvent.html">LEvent</a>* le);</div>
|
|
<div class="ttc" id="alevent_8h_html_a1414c8d6b33ef406745ee1c16ee194c3"><div class="ttname"><a href="levent_8h.html#a1414c8d6b33ef406745ee1c16ee194c3">leventClear</a></div><div class="ttdeci">void leventClear(LEvent *le)</div><div class="ttdoc">Clears a user-mode light event.</div></div>
|
|
<div class="ttc" id="alevent_8h_html_a2496108d9905cdf20d14189c2bf04f44"><div class="ttname"><a href="levent_8h.html#a2496108d9905cdf20d14189c2bf04f44">leventInit</a></div><div class="ttdeci">static void leventInit(LEvent *le, bool signaled, bool autoclear)</div><div class="ttdoc">Initializes a user-mode light event.</div><div class="ttdef"><b>Definition</b> levent.h:24</div></div>
|
|
<div class="ttc" id="alevent_8h_html_a585115dbfe161aeba5646c708276f6df"><div class="ttname"><a href="levent_8h.html#a585115dbfe161aeba5646c708276f6df">leventWait</a></div><div class="ttdeci">bool leventWait(LEvent *le, u64 timeout_ns)</div><div class="ttdoc">Waits on a user-mode light event.</div></div>
|
|
<div class="ttc" id="alevent_8h_html_a947dadc8c57ec9631826f7b3d0a7641e"><div class="ttname"><a href="levent_8h.html#a947dadc8c57ec9631826f7b3d0a7641e">leventSignal</a></div><div class="ttdeci">void leventSignal(LEvent *le)</div><div class="ttdoc">Signals a user-mode light event.</div></div>
|
|
<div class="ttc" id="alevent_8h_html_af1f2b5065b0dc51847a39b2f53a5f462"><div class="ttname"><a href="levent_8h.html#af1f2b5065b0dc51847a39b2f53a5f462">leventTryWait</a></div><div class="ttdeci">bool leventTryWait(LEvent *le)</div><div class="ttdoc">Polls a user-mode light event.</div></div>
|
|
<div class="ttc" id="astructLEvent_html"><div class="ttname"><a href="structLEvent.html">LEvent</a></div><div class="ttdoc">User-mode light event structure.</div><div class="ttdef"><b>Definition</b> levent.h:13</div></div>
|
|
<div class="ttc" id="asvc_8h_html"><div class="ttname"><a href="svc_8h.html">svc.h</a></div><div class="ttdoc">Wrappers for kernel syscalls.</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_ae2a0903442f062ed4f9f0568a6f1a297"><div class="ttname"><a href="types_8h.html#ae2a0903442f062ed4f9f0568a6f1a297">NX_CONSTEXPR</a></div><div class="ttdeci">#define NX_CONSTEXPR</div><div class="ttdoc">Flags a function as constexpr in C++14 and above; or as (always) inline otherwise.</div><div class="ttdef"><b>Definition</b> types.h:92</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 <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>
|