1
0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-03 01:52:14 +02:00
libnx/uevent_8h_source.html
2025-05-08 06:59:12 +00:00

150 lines
14 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/uevent.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_36b4ff30955378a33ed199d75bfba1a9.html">kernel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">uevent.h</div></div>
</div><!--header-->
<div class="contents">
<a href="uevent_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 uevent.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief User-mode event synchronization primitive.</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"> */</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;<a class="code" href="wait_8h.html">wait.h</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structUEvent.html">UEvent</a> <a class="code hl_struct" href="structUEvent.html">UEvent</a>;</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 event object.</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="structUEvent.html"> 13</a></span><span class="comment"></span><span class="keyword">struct </span><a class="code hl_struct" href="structUEvent.html">UEvent</a> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_struct" href="structWaitable.html">Waitable</a> waitable;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordtype">bool</span> signal;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keywordtype">bool</span> auto_clear;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>};</div>
</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">/// Creates a waiter for a user-mode event.</span></div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="}">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="uevent_8h.html#ab75b2622b68fa65ebbf16e4d1bac400d"> 20</a></span><span class="comment"></span><span class="keyword">static</span> <span class="keyword">inline</span> <a class="code hl_struct" href="structWaiter.html">Waiter</a> <a class="code hl_function" href="uevent_8h.html#ab75b2622b68fa65ebbf16e4d1bac400d">waiterForUEvent</a>(<a class="code hl_struct" href="structUEvent.html">UEvent</a>* e)</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_struct" href="structWaiter.html">Waiter</a> wait_obj;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> wait_obj.type = WaiterType_Waitable;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> wait_obj.waitable = &amp;e-&gt;waitable;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordflow">return</span> wait_obj;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>}</div>
</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"> 28</span><span class="comment">/**</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @brief Creates a user-mode event.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> * @param[out] e UEvent object.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @param[in] auto_clear Whether to automatically clear the event.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @note It is safe to wait on this event with several threads simultaneously.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @note If more than one thread is listening on it, at least one thread will get the signal. No other guarantees.</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="uevent_8h.html#ae90845ef66c2359cbc1b4969ed570ab1"> 35</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="uevent_8h.html#ae90845ef66c2359cbc1b4969ed570ab1">ueventCreate</a>(<a class="code hl_struct" href="structUEvent.html">UEvent</a>* e, <span class="keywordtype">bool</span> auto_clear);</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 Clears the event signal.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @param[in] e UEvent object.</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"><a class="line" href="uevent_8h.html#adf0807e6a514b9a31f4e0ed74485357e"> 41</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="uevent_8h.html#adf0807e6a514b9a31f4e0ed74485357e">ueventClear</a>(<a class="code hl_struct" href="structUEvent.html">UEvent</a>* e);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </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"> * @brief Signals the event.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * @param[in] e UEvent object.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> */</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="uevent_8h.html#ac7b1648405299ea5cf3d7850b9b10aa7"> 47</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="uevent_8h.html#ac7b1648405299ea5cf3d7850b9b10aa7">ueventSignal</a>(<a class="code hl_struct" href="structUEvent.html">UEvent</a>* e);</div>
<div class="ttc" id="astructUEvent_html"><div class="ttname"><a href="structUEvent.html">UEvent</a></div><div class="ttdoc">User-mode event object.</div><div class="ttdef"><b>Definition</b> uevent.h:13</div></div>
<div class="ttc" id="astructWaitable_html"><div class="ttname"><a href="structWaitable.html">Waitable</a></div><div class="ttdef"><b>Definition</b> wait.h:21</div></div>
<div class="ttc" id="astructWaiter_html"><div class="ttname"><a href="structWaiter.html">Waiter</a></div><div class="ttdoc">Waiter structure, representing any generic waitable synchronization object; both kernel-mode and user...</div><div class="ttdef"><b>Definition</b> wait.h:36</div></div>
<div class="ttc" id="auevent_8h_html_ab75b2622b68fa65ebbf16e4d1bac400d"><div class="ttname"><a href="uevent_8h.html#ab75b2622b68fa65ebbf16e4d1bac400d">waiterForUEvent</a></div><div class="ttdeci">static Waiter waiterForUEvent(UEvent *e)</div><div class="ttdoc">Creates a waiter for a user-mode event.</div><div class="ttdef"><b>Definition</b> uevent.h:20</div></div>
<div class="ttc" id="auevent_8h_html_ac7b1648405299ea5cf3d7850b9b10aa7"><div class="ttname"><a href="uevent_8h.html#ac7b1648405299ea5cf3d7850b9b10aa7">ueventSignal</a></div><div class="ttdeci">void ueventSignal(UEvent *e)</div><div class="ttdoc">Signals the event.</div></div>
<div class="ttc" id="auevent_8h_html_adf0807e6a514b9a31f4e0ed74485357e"><div class="ttname"><a href="uevent_8h.html#adf0807e6a514b9a31f4e0ed74485357e">ueventClear</a></div><div class="ttdeci">void ueventClear(UEvent *e)</div><div class="ttdoc">Clears the event signal.</div></div>
<div class="ttc" id="auevent_8h_html_ae90845ef66c2359cbc1b4969ed570ab1"><div class="ttname"><a href="uevent_8h.html#ae90845ef66c2359cbc1b4969ed570ab1">ueventCreate</a></div><div class="ttdeci">void ueventCreate(UEvent *e, bool auto_clear)</div><div class="ttdoc">Creates a user-mode event.</div></div>
<div class="ttc" id="await_8h_html"><div class="ttname"><a href="wait_8h.html">wait.h</a></div><div class="ttdoc">User mode synchronization primitive waiting operations.</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>