You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
267 lines
11 KiB
267 lines
11 KiB
7 years ago
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
||
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
<title>EmbeddedEtcher: os/queues.h File Reference</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">
|
||
|
$(document).ready(initResizable);
|
||
|
</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">EmbeddedEtcher
|
||
|
</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</tbody>
|
||
|
</table>
|
||
|
</div>
|
||
|
<!-- end header part -->
|
||
|
<!-- Generated by Doxygen 1.8.13 -->
|
||
|
<script type="text/javascript">
|
||
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
</script>
|
||
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
<script type="text/javascript">
|
||
|
$(function() {
|
||
|
initMenu('',true,false,'search.php','Search');
|
||
|
$(document).ready(function() { init_search(); });
|
||
|
});
|
||
|
</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">
|
||
|
$(document).ready(function(){initNavTree('queues_8h.html','');});
|
||
|
</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">queues.h File Reference</div> </div>
|
||
|
</div><!--header-->
|
||
|
<div class="contents">
|
||
|
|
||
|
<p>Implementation for queues.
|
||
|
<a href="#details">More...</a></p>
|
||
|
<div class="textblock"><code>#include <stm32f10x.h></code><br />
|
||
|
<code>#include "<a class="el" href="ostypes_8h_source.html">ostypes.h</a>"</code><br />
|
||
|
<code>#include <stdlib.h></code><br />
|
||
|
</div><div class="textblock"><div class="dynheader">
|
||
|
Include dependency graph for queues.h:</div>
|
||
|
<div class="dyncontent">
|
||
|
<div class="center"><img src="queues_8h__incl.png" border="0" usemap="#os_2queues_8h" alt=""/></div>
|
||
|
<map name="os_2queues_8h" id="os_2queues_8h">
|
||
|
<area shape="rect" id="node3" href="ostypes_8h.html" title="Different types the operating system uses are defined here. " alt="" coords="124,80,203,107"/>
|
||
|
<area shape="rect" id="node5" href="ossettings_8h.html" title="File where all settings take place. " alt="" coords="169,155,262,181"/>
|
||
|
</map>
|
||
|
</div>
|
||
|
</div>
|
||
|
<p><a href="queues_8h_source.html">Go to the source code of this file.</a></p>
|
||
|
<table class="memberdecls">
|
||
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||
|
Functions</h2></td></tr>
|
||
|
<tr class="memitem:a164dd36f8a083fd39b238b6d05910320"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="queues_8h.html#a164dd36f8a083fd39b238b6d05910320">osQInit</a> (<a class="el" href="structos_q_u_e_u_e__t.html">osQUEUE_t</a> *q, size_t ivarsize, uint16_t iqsize, void *istart)</td></tr>
|
||
|
<tr class="separator:a164dd36f8a083fd39b238b6d05910320"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a78b4d06b91514e747007d1cc03029b44"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="queues_8h.html#a78b4d06b91514e747007d1cc03029b44">osEnqueue</a> (<a class="el" href="structos_q_u_e_u_e__t.html">osQUEUE_t</a> *q, void *data)</td></tr>
|
||
|
<tr class="separator:a78b4d06b91514e747007d1cc03029b44"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
<tr class="memitem:a0037677933e9d9d089327009032edf2c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="queues_8h.html#a0037677933e9d9d089327009032edf2c">osDequeue</a> (<a class="el" href="structos_q_u_e_u_e__t.html">osQUEUE_t</a> *q, void *data)</td></tr>
|
||
|
<tr class="separator:a0037677933e9d9d089327009032edf2c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
</table>
|
||
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
<div class="textblock"><p>Implementation for queues. </p>
|
||
|
<dl class="section author"><dt>Author</dt><dd>Maximilian Stiefel </dd></dl>
|
||
|
<dl class="section date"><dt>Date</dt><dd>8 Jan 2018 </dd></dl>
|
||
|
</div><h2 class="groupheader">Function Documentation</h2>
|
||
|
<a id="a0037677933e9d9d089327009032edf2c"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#a0037677933e9d9d089327009032edf2c">◆ </a></span>osDequeue()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">uint8_t osDequeue </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="structos_q_u_e_u_e__t.html">osQUEUE_t</a> * </td>
|
||
|
<td class="paramname"><em>q</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">void * </td>
|
||
|
<td class="paramname"><em>data</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
<p>Copy data from the q.</p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">q</td><td>Q we are talking about. </td></tr>
|
||
|
<tr><td class="paramname">data</td><td>Pointer to a local variable where the data from the q shall end up. </td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="retval"><dt>Return values</dt><dd>
|
||
|
<table class="retval">
|
||
|
<tr><td class="paramname">1</td><td>(data successfully copied) or 0 (q is empty). </td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a id="a78b4d06b91514e747007d1cc03029b44"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#a78b4d06b91514e747007d1cc03029b44">◆ </a></span>osEnqueue()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">uint8_t osEnqueue </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="structos_q_u_e_u_e__t.html">osQUEUE_t</a> * </td>
|
||
|
<td class="paramname"><em>q</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">void * </td>
|
||
|
<td class="paramname"><em>data</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
<p>Copy data to the q.</p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">q</td><td>Q we are talking about. </td></tr>
|
||
|
<tr><td class="paramname">data</td><td>Pointer to a local variable where data is stored. </td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
<dl class="retval"><dt>Return values</dt><dd>
|
||
|
<table class="retval">
|
||
|
<tr><td class="paramname">1</td><td>(data successfully copied) or 0 (q is full). </td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
<a id="a164dd36f8a083fd39b238b6d05910320"></a>
|
||
|
<h2 class="memtitle"><span class="permalink"><a href="#a164dd36f8a083fd39b238b6d05910320">◆ </a></span>osQInit()</h2>
|
||
|
|
||
|
<div class="memitem">
|
||
|
<div class="memproto">
|
||
|
<table class="memname">
|
||
|
<tr>
|
||
|
<td class="memname">void osQInit </td>
|
||
|
<td>(</td>
|
||
|
<td class="paramtype"><a class="el" href="structos_q_u_e_u_e__t.html">osQUEUE_t</a> * </td>
|
||
|
<td class="paramname"><em>q</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">size_t </td>
|
||
|
<td class="paramname"><em>ivarsize</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">uint16_t </td>
|
||
|
<td class="paramname"><em>iqsize</em>, </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td class="paramkey"></td>
|
||
|
<td></td>
|
||
|
<td class="paramtype">void * </td>
|
||
|
<td class="paramname"><em>istart</em> </td>
|
||
|
</tr>
|
||
|
<tr>
|
||
|
<td></td>
|
||
|
<td>)</td>
|
||
|
<td></td><td></td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</div><div class="memdoc">
|
||
|
<p>Function to initialize a queue properly.</p>
|
||
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
<table class="params">
|
||
|
<tr><td class="paramname">q</td><td>Pointer to the memory where the q is stored. </td></tr>
|
||
|
<tr><td class="paramname">ivarsize</td><td>Size of the variable type stored in the q in bytes. </td></tr>
|
||
|
<tr><td class="paramname">iqsize</td><td>Number of slots of the q. </td></tr>
|
||
|
<tr><td class="paramname">istart</td><td>Pointer to the array where the actual data of the q is stored. </td></tr>
|
||
|
</table>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
|
||
|
</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="navelem"><a class="el" href="dir_8b7cb6c889a10e2a101a7e90c854ca4d.html">os</a></li><li class="navelem"><a class="el" href="queues_8h.html">queues.h</a></li>
|
||
|
<li class="footer">Generated by
|
||
|
<a href="http://www.doxygen.org/index.html">
|
||
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|