wut/semaphore_8h_source.html
2020-03-26 16:49:18 +11:00

159 lines
17 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">
<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: /home/ash/Code/wut2/include/coreinit/semaphore.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 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>
<!-- 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 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_5050f3de292bd66075be80c4b119f1df.html">coreinit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">semaphore.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="semaphore_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="wut_8h.html">wut.h</a>&gt;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="threadqueue_8h.html">threadqueue.h</a>&quot;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="group__coreinit__semaphore.html#ga46989e5d6706438811f38e7b76e803a7"> 17</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a> <a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a>;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="group__coreinit__semaphore.html#ga888ed45dfac53be5a7023823c826ed64"> 19</a></span>&#160;<span class="preprocessor">#define OS_SEMAPHORE_TAG 0x73506852u</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="group__coreinit__semaphore.html"> 21</a></span>&#160;<span class="keyword">struct </span><a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="group__coreinit__semaphore.html#a1c50fcd1195659821729f52af8f3bb7d"> 24</a></span>&#160; uint32_t <a class="code" href="group__coreinit__semaphore.html#a1c50fcd1195659821729f52af8f3bb7d">tag</a>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="group__coreinit__semaphore.html#a8f8f80d37794cde9472343e4487ba3eb"> 27</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__coreinit__semaphore.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; WUT_UNKNOWN_BYTES(4);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="group__coreinit__semaphore.html#a4858b400f708a13bd514376ab941b27d"> 32</a></span>&#160; int32_t <a class="code" href="group__coreinit__semaphore.html#a4858b400f708a13bd514376ab941b27d">count</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="group__coreinit__semaphore.html#a4c72ffd2d6a41665aa8203649acbb46d"> 35</a></span>&#160; <a class="code" href="group__coreinit__threadq.html#structOSThreadQueue">OSThreadQueue</a> <a class="code" href="group__coreinit__semaphore.html#a4c72ffd2d6a41665aa8203649acbb46d">queue</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;};</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;WUT_CHECK_OFFSET(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a>, 0x00, tag);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;WUT_CHECK_OFFSET(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a>, 0x04, name);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;WUT_CHECK_OFFSET(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a>, 0x0C, count);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;WUT_CHECK_OFFSET(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a>, 0x10, queue);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;WUT_CHECK_SIZE(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a>, 0x20);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<a class="code" href="group__coreinit__semaphore.html#gaf135af1869002a8137894aabbbd061b1">OSInitSemaphore</a>(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a> *semaphore,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; int32_t count);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<a class="code" href="group__coreinit__semaphore.html#gad4af5a89ce56153ce57b9145f2e51e0a">OSInitSemaphoreEx</a>(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a> *semaphore,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; int32_t count,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;int32_t</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<a class="code" href="group__coreinit__semaphore.html#gac520cef5f6f40bbd3f917b486d9fec33">OSGetSemaphoreCount</a>(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a> *semaphore);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;int32_t</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<a class="code" href="group__coreinit__semaphore.html#ga5a1ba1984a871044aa31ff0f40d52806">OSSignalSemaphore</a>(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a> *semaphore);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;int32_t</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<a class="code" href="group__coreinit__semaphore.html#ga02e41ca9da26f52a7c3867531e2711ac">OSWaitSemaphore</a>(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a> *semaphore);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;int32_t</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<a class="code" href="group__coreinit__semaphore.html#ga289bfdb3843d8615c365e91d196f008b">OSTryWaitSemaphore</a>(<a class="code" href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a> *semaphore);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;}</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="agroup__coreinit__semaphore_html_a4c72ffd2d6a41665aa8203649acbb46d"><div class="ttname"><a href="group__coreinit__semaphore.html#a4c72ffd2d6a41665aa8203649acbb46d">OSSemaphore::queue</a></div><div class="ttdeci">OSThreadQueue queue</div><div class="ttdoc">Queue of threads waiting on semaphore object with OSWaitSemaphore.</div><div class="ttdef"><b>Definition:</b> <a href="semaphore_8h_source.html#l00035">semaphore.h:35</a></div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_structOSSemaphore"><div class="ttname"><a href="group__coreinit__semaphore.html#structOSSemaphore">OSSemaphore</a></div><div class="ttdef"><b>Definition:</b> <a href="semaphore_8h_source.html#l00021">semaphore.h:21</a></div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_gad4af5a89ce56153ce57b9145f2e51e0a"><div class="ttname"><a href="group__coreinit__semaphore.html#gad4af5a89ce56153ce57b9145f2e51e0a">OSInitSemaphoreEx</a></div><div class="ttdeci">void OSInitSemaphoreEx(OSSemaphore *semaphore, int32_t count, const char *name)</div><div class="ttdoc">Initialise semaphore object with count and name.</div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_a1c50fcd1195659821729f52af8f3bb7d"><div class="ttname"><a href="group__coreinit__semaphore.html#a1c50fcd1195659821729f52af8f3bb7d">OSSemaphore::tag</a></div><div class="ttdeci">uint32_t tag</div><div class="ttdoc">Should always be set to the value OS_SEMAPHORE_TAG.</div><div class="ttdef"><b>Definition:</b> <a href="semaphore_8h_source.html#l00024">semaphore.h:24</a></div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_gac520cef5f6f40bbd3f917b486d9fec33"><div class="ttname"><a href="group__coreinit__semaphore.html#gac520cef5f6f40bbd3f917b486d9fec33">OSGetSemaphoreCount</a></div><div class="ttdeci">int32_t OSGetSemaphoreCount(OSSemaphore *semaphore)</div><div class="ttdoc">Get the current semaphore count.</div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_ga5a1ba1984a871044aa31ff0f40d52806"><div class="ttname"><a href="group__coreinit__semaphore.html#ga5a1ba1984a871044aa31ff0f40d52806">OSSignalSemaphore</a></div><div class="ttdeci">int32_t OSSignalSemaphore(OSSemaphore *semaphore)</div><div class="ttdoc">Increase the semaphore value.</div></div>
<div class="ttc" id="athreadqueue_8h_html"><div class="ttname"><a href="threadqueue_8h.html">threadqueue.h</a></div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_gaf135af1869002a8137894aabbbd061b1"><div class="ttname"><a href="group__coreinit__semaphore.html#gaf135af1869002a8137894aabbbd061b1">OSInitSemaphore</a></div><div class="ttdeci">void OSInitSemaphore(OSSemaphore *semaphore, int32_t count)</div><div class="ttdoc">Initialise semaphore object with count.</div></div>
<div class="ttc" id="awut_8h_html"><div class="ttname"><a href="wut_8h.html">wut.h</a></div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_a4858b400f708a13bd514376ab941b27d"><div class="ttname"><a href="group__coreinit__semaphore.html#a4858b400f708a13bd514376ab941b27d">OSSemaphore::count</a></div><div class="ttdeci">int32_t count</div><div class="ttdoc">Current count of semaphore.</div><div class="ttdef"><b>Definition:</b> <a href="semaphore_8h_source.html#l00032">semaphore.h:32</a></div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_ga289bfdb3843d8615c365e91d196f008b"><div class="ttname"><a href="group__coreinit__semaphore.html#ga289bfdb3843d8615c365e91d196f008b">OSTryWaitSemaphore</a></div><div class="ttdeci">int32_t OSTryWaitSemaphore(OSSemaphore *semaphore)</div><div class="ttdoc">Try to decrease the semaphore value.</div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_ga02e41ca9da26f52a7c3867531e2711ac"><div class="ttname"><a href="group__coreinit__semaphore.html#ga02e41ca9da26f52a7c3867531e2711ac">OSWaitSemaphore</a></div><div class="ttdeci">int32_t OSWaitSemaphore(OSSemaphore *semaphore)</div><div class="ttdoc">Decrease the semaphore value.</div></div>
<div class="ttc" id="agroup__coreinit__semaphore_html_a8f8f80d37794cde9472343e4487ba3eb"><div class="ttname"><a href="group__coreinit__semaphore.html#a8f8f80d37794cde9472343e4487ba3eb">OSSemaphore::name</a></div><div class="ttdeci">const char * name</div><div class="ttdoc">Name set by OSInitMutexEx.</div><div class="ttdef"><b>Definition:</b> <a href="semaphore_8h_source.html#l00027">semaphore.h:27</a></div></div>
<div class="ttc" id="agroup__coreinit__threadq_html_structOSThreadQueue"><div class="ttname"><a href="group__coreinit__threadq.html#structOSThreadQueue">OSThreadQueue</a></div><div class="ttdef"><b>Definition:</b> <a href="threadqueue_8h_source.html#l00029">threadqueue.h:29</a></div></div>
<!-- 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>