m3x1m0m
/
embedded_etcher_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
4 Commits
1 Branch
0 Tags
1.1 MiB
 
Tree: 65d35434a5
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '65d35434a5'
${ noResults }
embedded_etcher_firmware/doc/html/scheduler_8c.html

361 lines
16 KiB
Raw Blame History

<!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/scheduler.c 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="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>
<!-- 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_8b7cb6c889a10e2a101a7e90c854ca4d.html">os</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">scheduler.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;<a class="el" href="scheduler_8h_source.html">scheduler.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="error_8h_source.html">error.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="heap_8h_source.html">heap.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="printf_8h_source.html">printf.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ossettings_8h_source.html">ossettings.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="system__timer_8h_source.html">../platform/system_timer.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for scheduler.c:</div>
<div class="dyncontent">
<div class="center"><img src="scheduler_8c__incl.png" border="0" usemap="#os_2scheduler_8c" alt=""/></div>
<map name="os_2scheduler_8c" id="os_2scheduler_8c">
<area shape="rect" id="node6" href="scheduler_8h.html" title="scheduler.h" alt="" coords="95,87,185,114"/>
<area shape="rect" id="node7" href="ossettings_8h.html" title="ossettings.h" alt="" coords="251,244,344,271"/>
<area shape="rect" id="node9" href="error_8h.html" title="error.h" alt="" coords="295,87,353,114"/>
<area shape="rect" id="node10" href="heap_8h.html" title="heap.h" alt="" coords="209,87,271,114"/>
<area shape="rect" id="node11" href="printf_8h.html" title="printf.h" alt="" coords="479,87,542,114"/>
<area shape="rect" id="node14" href="system__timer_8h.html" title="../platform/system\l_timer.h" alt="" coords="656,80,784,121"/>
<area shape="rect" id="node8" href="ostypes_8h.html" title="ostypes.h" alt="" coords="219,169,298,196"/>
</map>
</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:ac59673f226b3291f835a0faf010ad409"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#ac59673f226b3291f835a0faf010ad409">osSchedulerGetSysT</a> (void)</td></tr>
<tr class="separator:ac59673f226b3291f835a0faf010ad409"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76739fd1872ff1f867ea41e853131a21"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#a76739fd1872ff1f867ea41e853131a21">osTaskCreate</a> (void(*ifnc_ptr)(void *), char *itask_name, void *iarguments, uint8_t ipriority, const <a class="el" href="structos_t_c_b__t.html">osTCB_t</a> *oTaskHandle)</td></tr>
<tr class="separator:a76739fd1872ff1f867ea41e853131a21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a790ca9c0d2362305790eb3c4002e3da9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#a790ca9c0d2362305790eb3c4002e3da9">osTaskDelete</a> (<a class="el" href="structos_t_c_b__t.html">osTCB_t</a> *iotask)</td></tr>
<tr class="separator:a790ca9c0d2362305790eb3c4002e3da9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1e7565174265c0107749d7cdf486c01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#ae1e7565174265c0107749d7cdf486c01">osTaskDelay</a> (uint8_t idelay)</td></tr>
<tr class="separator:ae1e7565174265c0107749d7cdf486c01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4c7af5e41838a9299b00d455fb8f454"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#ae4c7af5e41838a9299b00d455fb8f454">osTaskDelayUntil</a> (uint32_t iwakeup_time, uint8_t idelay)</td></tr>
<tr class="separator:ae4c7af5e41838a9299b00d455fb8f454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada28e10d8b44223004cab16b201df2d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#ada28e10d8b44223004cab16b201df2d7">osRunScheduler</a> (void)</td></tr>
<tr class="separator:ada28e10d8b44223004cab16b201df2d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd27cd0dcb4e193125968decdd238ff9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#acd27cd0dcb4e193125968decdd238ff9">osPrintTask</a> (uint8_t iindex)</td></tr>
<tr class="separator:acd27cd0dcb4e193125968decdd238ff9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4967a4ccbd9e8901a1d79a9ee3ca79b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="scheduler_8c.html#ad4967a4ccbd9e8901a1d79a9ee3ca79b">osPrintAllTasks</a> (void)</td></tr>
<tr class="separator:ad4967a4ccbd9e8901a1d79a9ee3ca79b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad4967a4ccbd9e8901a1d79a9ee3ca79b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4967a4ccbd9e8901a1d79a9ee3ca79b">&#9670;&nbsp;</a></span>osPrintAllTasks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osPrintAllTasks </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print all information about all tasks. </p>
</div>
</div>
<a id="acd27cd0dcb4e193125968decdd238ff9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd27cd0dcb4e193125968decdd238ff9">&#9670;&nbsp;</a></span>osPrintTask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osPrintTask </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iindex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print all information about one task.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iindex</td><td>Index in the TCB array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ada28e10d8b44223004cab16b201df2d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada28e10d8b44223004cab16b201df2d7">&#9670;&nbsp;</a></span>osRunScheduler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osRunScheduler </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>System core. Scheduler needs to be executed by a timer interrupt. </p>
</div>
</div>
<a id="ac59673f226b3291f835a0faf010ad409"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac59673f226b3291f835a0faf010ad409">&#9670;&nbsp;</a></span>osSchedulerGetSysT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t osSchedulerGetSysT </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the system time.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">Gives</td><td>back the number of ticks since system has been initialized. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a76739fd1872ff1f867ea41e853131a21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76739fd1872ff1f867ea41e853131a21">&#9670;&nbsp;</a></span>osTaskCreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t osTaskCreate </td>
<td>(</td>
<td class="paramtype">void(*)(void *)&#160;</td>
<td class="paramname"><em>ifnc_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>itask_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>iarguments</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>ipriority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structos_t_c_b__t.html">osTCB_t</a> *&#160;</td>
<td class="paramname"><em>oTaskHandle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Spawn a task.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ifnc_ptr</td><td>Pointer to the task function. </td></tr>
<tr><td class="paramname">itask_name</td><td>Internal task name. </td></tr>
<tr><td class="paramname">iarguments</td><td>Enables passing user-defined arguments to the task. </td></tr>
<tr><td class="paramname">ipriority</td><td>A higher value means a higher priority of the task. </td></tr>
<tr><td class="paramname">oTaskHandle</td><td>Pointer to TCB. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">1</td><td>(task has been spawned) or 0 (FAILED) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae1e7565174265c0107749d7cdf486c01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1e7565174265c0107749d7cdf486c01">&#9670;&nbsp;</a></span>osTaskDelay()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osTaskDelay </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>idelay</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delay function. DO NOT USE FOR PERIODIC TASKS!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idelay</td><td>Delay in system ticks. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae4c7af5e41838a9299b00d455fb8f454"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4c7af5e41838a9299b00d455fb8f454">&#9670;&nbsp;</a></span>osTaskDelayUntil()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osTaskDelayUntil </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>iwakeup_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>idelay</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delay until function. DO USE FOR PERIODIC TASKS!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iwakeup_time</td><td>Time when the task execution started. </td></tr>
<tr><td class="paramname">idelay</td><td>Number of system ticks until the task shall be executed again. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a790ca9c0d2362305790eb3c4002e3da9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a790ca9c0d2362305790eb3c4002e3da9">&#9670;&nbsp;</a></span>osTaskDelete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osTaskDelete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structos_t_c_b__t.html">osTCB_t</a> *&#160;</td>
<td class="paramname"><em>iotask</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simply delete task by setting the function pointer to NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iotask</td><td>Pointer to TCB. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- 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.13
</small></address>
</body>
</html>