<!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: Mutexes</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__mutex.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">Mutexes<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 Mutexes:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__mutex.png" border="0" usemap="#group____sys____mutex" 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:ga16336ce68b741e98204102ca4bc84dd9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__mutex.html#ga16336ce68b741e98204102ca4bc84dd9">sys_mutex_free</a> (<a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> *<a class="el" href="ubthread_8c.html#a18b6be9ca0cec4b0643171232d6f10de">mutex</a>)</td></tr>
<tr class="separator:ga16336ce68b741e98204102ca4bc84dd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4d4eb9afe5965fa2661dd54ff55d616a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__mutex.html#ga4d4eb9afe5965fa2661dd54ff55d616a">sys_mutex_lock</a> (<a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> *<a class="el" href="ubthread_8c.html#a18b6be9ca0cec4b0643171232d6f10de">mutex</a>)</td></tr>
<tr class="separator:ga4d4eb9afe5965fa2661dd54ff55d616a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga38e7dae1fd88b338eb1cd97f110f3897"><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__mutex.html#ga38e7dae1fd88b338eb1cd97f110f3897">sys_mutex_new</a> (<a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> *<a class="el" href="ubthread_8c.html#a18b6be9ca0cec4b0643171232d6f10de">mutex</a>)</td></tr>
<tr class="separator:ga38e7dae1fd88b338eb1cd97f110f3897"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f392725971dc837aa56dd7e45fa7ca8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__mutex.html#ga3f392725971dc837aa56dd7e45fa7ca8">sys_mutex_set_invalid</a> (<a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> *<a class="el" href="ubthread_8c.html#a18b6be9ca0cec4b0643171232d6f10de">mutex</a>)</td></tr>
<tr class="separator:ga3f392725971dc837aa56dd7e45fa7ca8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5568f68898fe9d5735f9ce2f665624fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__mutex.html#ga5568f68898fe9d5735f9ce2f665624fb">sys_mutex_unlock</a> (<a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> *<a class="el" href="ubthread_8c.html#a18b6be9ca0cec4b0643171232d6f10de">mutex</a>)</td></tr>
<tr class="separator:ga5568f68898fe9d5735f9ce2f665624fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaebe83ba90a6d9c23cdb3eb5d49562c4a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sys__mutex.html#gaebe83ba90a6d9c23cdb3eb5d49562c4a">sys_mutex_valid</a> (<a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> *<a class="el" href="ubthread_8c.html#a18b6be9ca0cec4b0643171232d6f10de">mutex</a>)</td></tr>
<tr class="separator:gaebe83ba90a6d9c23cdb3eb5d49562c4a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Mutexes are recommended to correctly handle priority inversion, especially if you use LWIP_CORE_LOCKING . </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga16336ce68b741e98204102ca4bc84dd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga16336ce68b741e98204102ca4bc84dd9">◆ </a></span>sys_mutex_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_mutex_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> * </td>
<td class="paramname"><em>mutex</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">mutex</td><td>the mutex to delete </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00149">149</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="ubthread_8c_source.html#l00043">mutex</a>, <a class="el" href="ubthread_8h_source.html#l00070">ubthread_mutex_list::mutex</a>, and <a class="el" href="ubthread_8c_source.html#l00077">ubthread_mutex_destroy()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__mutex_ga16336ce68b741e98204102ca4bc84dd9_cgraph.png" border="0" usemap="#group__sys__mutex_ga16336ce68b741e98204102ca4bc84dd9_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="ga4d4eb9afe5965fa2661dd54ff55d616a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d4eb9afe5965fa2661dd54ff55d616a">◆ </a></span>sys_mutex_lock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_mutex_lock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lock a mutex </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>the mutex to lock </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00153">153</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="ubthread_8c_source.html#l00043">mutex</a>, <a class="el" href="ubthread_8h_source.html#l00070">ubthread_mutex_list::mutex</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="mem_8c_source.html#l00603">mem_malloc()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__mutex_ga4d4eb9afe5965fa2661dd54ff55d616a_cgraph.png" border="0" usemap="#group__sys__mutex_ga4d4eb9afe5965fa2661dd54ff55d616a_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="ga38e7dae1fd88b338eb1cd97f110f3897"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga38e7dae1fd88b338eb1cd97f110f3897">◆ </a></span>sys_mutex_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_mutex_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new mutex. Note that mutexes are expected to not be taken recursively by the lwIP code, so both implementation types (recursive or non-recursive) should work. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>pointer to the mutex to create </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#l00144">144</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="err_8h_source.html#l00063">ERR_OK</a>, <a class="el" href="ubthread_8c_source.html#l00043">mutex</a>, <a class="el" href="ubthread_8h_source.html#l00070">ubthread_mutex_list::mutex</a>, <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, and <a class="el" href="ubthread_8h.html#ab6bfc2169b55532821582f24b68dc855">ubthread_mutex_init()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__sys__mutex_ga38e7dae1fd88b338eb1cd97f110f3897_cgraph.png" border="0" usemap="#group__sys__mutex_ga38e7dae1fd88b338eb1cd97f110f3897_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="ga3f392725971dc837aa56dd7e45fa7ca8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f392725971dc837aa56dd7e45fa7ca8">◆ </a></span>sys_mutex_set_invalid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_mutex_set_invalid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a mutex invalid so that sys_mutex_valid returns 0 </p>
</div>
</div>
<a id="ga5568f68898fe9d5735f9ce2f665624fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5568f68898fe9d5735f9ce2f665624fb">◆ </a></span>sys_mutex_unlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sys_mutex_unlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlock a mutex </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mutex</td><td>the mutex to unlock </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="sys__arch_8c_source.html#l00157">157</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="ubthread_8c_source.html#l00043">mutex</a>, <a class="el" href="ubthread_8h_source.html#l00070">ubthread_mutex_list::mutex</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__mutex_ga5568f68898fe9d5735f9ce2f665624fb_cgraph.png" border="0" usemap="#group__sys__mutex_ga5568f68898fe9d5735f9ce2f665624fb_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="gaebe83ba90a6d9c23cdb3eb5d49562c4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaebe83ba90a6d9c23cdb3eb5d49562c4a">◆ </a></span>sys_mutex_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sys_mutex_valid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sys__arch_8h.html#a222e7d52225fc3453d7a2240b9209849">sys_mutex_t</a> * </td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a mutex is valid/allocated: return 1 for valid, 0 for invalid </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>
