<!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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS V2: Semaphores</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">UbixOS V2
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__sys__sem.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Semaphores<div class="ingroups"><a class="el" href="group__sys__layer.html">Porting (system abstraction layer)</a> » <a class="el" href="group__sys__os.html">OS abstraction layer</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Semaphores:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__sem.png" border="0" usemap="#group____sys____sem" alt=""/></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga28aa725e8a36dd0cfde89875af4f3ec9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="include_2sys_2types_8h.html#a0238af00180b6d9278fa1c6aa790fdf4">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__sem.html#ga28aa725e8a36dd0cfde89875af4f3ec9">sys_arch_sem_wait</a> (struct <a class="el" href="structsys__sem.html">sys_sem</a> **s, <a class="el" href="include_2sys_2types_8h.html#a0238af00180b6d9278fa1c6aa790fdf4">uint32_t</a> timeout)</td></tr>
<tr class="separator:ga28aa725e8a36dd0cfde89875af4f3ec9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4d02e29e5dfa092559efc04dee985822"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__sem.html#ga4d02e29e5dfa092559efc04dee985822">sys_sem_free</a> (<a class="el" href="sem_8h.html#a900e36da93bb688c29fc8148f2f44e04">sys_sem_t</a> **sem)</td></tr>
<tr class="separator:ga4d02e29e5dfa092559efc04dee985822"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb68acad14b34550b9891bc11bbf4e63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__sem.html#gadb68acad14b34550b9891bc11bbf4e63">sys_sem_new</a> (<a class="el" href="sem_8h.html#a900e36da93bb688c29fc8148f2f44e04">sys_sem_t</a> **sem, <a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> count)</td></tr>
<tr class="separator:gadb68acad14b34550b9891bc11bbf4e63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6b618ddf0c8e73302f1dae7821661457"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__sem.html#ga6b618ddf0c8e73302f1dae7821661457">sys_sem_set_invalid</a> (struct <a class="el" href="structsys__sem.html">sys_sem</a> **s)</td></tr>
<tr class="separator:ga6b618ddf0c8e73302f1dae7821661457"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff1dd2af219b75ae812e0b1660bd7455"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__sem.html#gaff1dd2af219b75ae812e0b1660bd7455">sys_sem_signal</a> (struct <a class="el" href="structsys__sem.html">sys_sem</a> **s)</td></tr>
<tr class="separator:gaff1dd2af219b75ae812e0b1660bd7455"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac7ff314270976b80559d043f6098817b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__sem.html#gac7ff314270976b80559d043f6098817b">sys_sem_valid</a> (struct <a class="el" href="structsys__sem.html">sys_sem</a> **s)</td></tr>
<tr class="separator:gac7ff314270976b80559d043f6098817b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga28aa725e8a36dd0cfde89875af4f3ec9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga28aa725e8a36dd0cfde89875af4f3ec9">◆ </a></span>sys_arch_sem_wait()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="include_2sys_2types_8h.html#a0238af00180b6d9278fa1c6aa790fdf4">uint32_t</a> sys_arch_sem_wait </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsys__sem.html">sys_sem</a> ** </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="include_2sys_2types_8h.html#a0238af00180b6d9278fa1c6aa790fdf4">uint32_t</a> </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for a semaphore for the specified timeout </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sem</td><td>the semaphore to wait for </td></tr>
<tr><td class="paramname">timeout</td><td>timeout in milliseconds to wait (0 = wait forever) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>time (in milliseconds) waited for the semaphore or SYS_ARCH_TIMEOUT on timeout </dd></dl>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00105">105</a> of file <a class="el" href="sys__arch_8c_source.html">sys_arch.c</a>.</p>
<p class="reference">References <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="sem_8h_source.html#l00039">mutex</a>, <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, <a class="el" href="sem_8h_source.html#l00037">signaled</a>, and <a class="el" href="ubthread_8c_source.html#l00088">ubthread_mutex_lock()</a>.</p>
<p class="reference">Referenced by <a class="el" href="sys_8c_source.html#l00093">sys_msleep()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__sem_ga28aa725e8a36dd0cfde89875af4f3ec9_cgraph.png" border="0" usemap="#group__sys__sem_ga28aa725e8a36dd0cfde89875af4f3ec9_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="ga4d02e29e5dfa092559efc04dee985822"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d02e29e5dfa092559efc04dee985822">◆ </a></span>sys_sem_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_sem_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sem_8h.html#a900e36da93bb688c29fc8148f2f44e04">sys_sem_t</a> ** </td>
<td class="paramname"><em>sem</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a semaphore </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sem</td><td>semaphore to delete </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00075">75</a> of file <a class="el" href="sys__arch_8c_source.html">sys_arch.c</a>.</p>
<p class="reference">References <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, <a class="el" href="sem_8c_source.html#l00087">sem_destroy()</a>, and <a class="el" href="sys__arch_8h_source.html#l00008">SYS_SEM_NULL</a>.</p>
<p class="reference">Referenced by <a class="el" href="sys_8c_source.html#l00093">sys_msleep()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__sem_ga4d02e29e5dfa092559efc04dee985822_cgraph.png" border="0" usemap="#group__sys__sem_ga4d02e29e5dfa092559efc04dee985822_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="gadb68acad14b34550b9891bc11bbf4e63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadb68acad14b34550b9891bc11bbf4e63">◆ </a></span>sys_sem_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> sys_sem_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sem_8h.html#a900e36da93bb688c29fc8148f2f44e04">sys_sem_t</a> ** </td>
<td class="paramname"><em>sem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new semaphore </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sem</td><td>pointer to the semaphore to create </td></tr>
<tr><td class="paramname">count</td><td>initial count of the semaphore </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ERR_OK if successful, another err_t otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00052">52</a> of file <a class="el" href="sys__arch_8c_source.html">sys_arch.c</a>.</p>
<p class="reference">References <a class="el" href="sem_8h_source.html#l00038">cond</a>, <a class="el" href="err_8h_source.html#l00063">ERR_OK</a>, <a class="el" href="kmalloc_8c_source.html#l00241">kmalloc()</a>, <a class="el" href="kprintf_8c_source.html#l00259">kprintf()</a>, <a class="el" href="sem_8h_source.html#l00039">mutex</a>, <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, <a class="el" href="sem_8c_source.html#l00056">sem_init()</a>, <a class="el" href="sem_8h_source.html#l00037">signaled</a>, <a class="el" href="ubthread_8h.html#acbb7170a68758468ab5b02512a320112">ubthread_cond_init()</a>, and <a class="el" href="ubthread_8h.html#ab6bfc2169b55532821582f24b68dc855">ubthread_mutex_init()</a>.</p>
<p class="reference">Referenced by <a class="el" href="sys_8c_source.html#l00093">sys_msleep()</a>, and <a class="el" href="tcpip_8c_source.html#l00356">tcpip_api_call()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__sem_gadb68acad14b34550b9891bc11bbf4e63_cgraph.png" border="0" usemap="#group__sys__sem_gadb68acad14b34550b9891bc11bbf4e63_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="ga6b618ddf0c8e73302f1dae7821661457"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6b618ddf0c8e73302f1dae7821661457">◆ </a></span>sys_sem_set_invalid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_sem_set_invalid </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsys__sem.html">sys_sem</a> ** </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a semaphore invalid so that sys_sem_valid returns 0 </p>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00140">140</a> of file <a class="el" href="sys__arch_8c_source.html">sys_arch.c</a>.</p>
</div>
</div>
<a id="gaff1dd2af219b75ae812e0b1660bd7455"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaff1dd2af219b75ae812e0b1660bd7455">◆ </a></span>sys_sem_signal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_sem_signal </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsys__sem.html">sys_sem</a> ** </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals a semaphore </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sem</td><td>the semaphore to signal </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00089">89</a> of file <a class="el" href="sys__arch_8c_source.html">sys_arch.c</a>.</p>
<p class="reference">References <a class="el" href="sem_8h_source.html#l00038">cond</a>, <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="sem_8h_source.html#l00039">mutex</a>, <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, <a class="el" href="sem_8h_source.html#l00037">signaled</a>, <a class="el" href="ubthread_8c_source.html#l00164">ubthread_cond_broadcast()</a>, <a class="el" href="ubthread_8c_source.html#l00088">ubthread_mutex_lock()</a>, and <a class="el" href="ubthread_8c_source.html#l00109">ubthread_mutex_unlock()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__sem_gaff1dd2af219b75ae812e0b1660bd7455_cgraph.png" border="0" usemap="#group__sys__sem_gaff1dd2af219b75ae812e0b1660bd7455_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="gac7ff314270976b80559d043f6098817b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac7ff314270976b80559d043f6098817b">◆ </a></span>sys_sem_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sys_sem_valid </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structsys__sem.html">sys_sem</a> ** </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a semaphore is valid/allocated: return 1 for valid, 0 for invalid </p>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00132">132</a> of file <a class="el" href="sys__arch_8c_source.html">sys_arch.c</a>.</p>
<p class="reference">Referenced by <a class="el" href="tcpip_8c_source.html#l00322">tcpip_send_msg_wait_sem()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
