Added doxygen output of current emulator branch.
This commit is contained in:
Timo Lang
231
group__system.html
Normal file
231
group__system.html
Normal file
@@ -0,0 +1,231 @@
|
||||
<!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.9.1"/>
|
||||
<title>discoverpixy: System</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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 style="padding-left: 0.5em;">
|
||||
<div id="projectname">discoverpixy
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.9.1 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<!-- 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">System</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ga3bc3f0cc729bc8f6bf8c0702c4d058dd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__system.html#ga3bc3f0cc729bc8f6bf8c0702c4d058dd">system_init</a> ()</td></tr>
|
||||
<tr class="separator:ga3bc3f0cc729bc8f6bf8c0702c4d058dd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga871412ab92d1b0c853f5c77f9d06abdc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__system.html#ga871412ab92d1b0c853f5c77f9d06abdc">system_delay</a> (uint32_t msec)</td></tr>
|
||||
<tr class="separator:ga871412ab92d1b0c853f5c77f9d06abdc"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga222cd9a0957fe56d9bb3e745acfb7f1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__system.html#ga222cd9a0957fe56d9bb3e745acfb7f1f">system_process</a> ()</td></tr>
|
||||
<tr class="separator:ga222cd9a0957fe56d9bb3e745acfb7f1f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab93c255fb3f413ae70ccaa7600c56c26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__system.html#gab93c255fb3f413ae70ccaa7600c56c26">system_toggle_led</a> ()</td></tr>
|
||||
<tr class="separator:gab93c255fb3f413ae70ccaa7600c56c26"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>The System Module provides access to delay functions, leds and provides a system init function </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga871412ab92d1b0c853f5c77f9d06abdc"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void system_delay </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>msec</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Sleeps for a certain amount of time </p><dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">msec</td><td>The number of milliseconds to sleep </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p><div class="dynheader">
|
||||
Here is the call graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group__system_ga871412ab92d1b0c853f5c77f9d06abdc_cgraph.png" border="0" usemap="#group__system_ga871412ab92d1b0c853f5c77f9d06abdc_cgraph" alt=""/></div>
|
||||
<map name="group__system_ga871412ab92d1b0c853f5c77f9d06abdc_cgraph" id="group__system_ga871412ab92d1b0c853f5c77f9d06abdc_cgraph">
|
||||
<area shape="rect" id="node2" href="ll__system_8h.html#a02dc69a2258a680c99ace8167652ea91" title="ll_system_delay" alt="" coords="156,5,272,32"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga3bc3f0cc729bc8f6bf8c0702c4d058dd"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool system_init </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Initializes the system. Call this method at the start of your <a class="el" href="group__app.html#ga8c6e58bb7e2a0dcf8537fc940ebfa385">app_init()</a> function and before using any system_* functions </p><dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
||||
|
||||
<p><div class="dynheader">
|
||||
Here is the call graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_cgraph.png" border="0" usemap="#group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_cgraph" alt=""/></div>
|
||||
<map name="group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_cgraph" id="group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_cgraph">
|
||||
<area shape="rect" id="node2" href="ll__system_8h.html#ad6c3b701d60604cc59b68e1af81c8f85" title="ll_system_init" alt="" coords="143,5,245,32"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
<p><div class="dynheader">
|
||||
Here is the caller graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_icgraph.png" border="0" usemap="#group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_icgraph" alt=""/></div>
|
||||
<map name="group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_icgraph" id="group__system_ga3bc3f0cc729bc8f6bf8c0702c4d058dd_icgraph">
|
||||
<area shape="rect" id="node2" href="group__app.html#ga8c6e58bb7e2a0dcf8537fc940ebfa385" title="app_init" alt="" coords="143,5,209,32"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga222cd9a0957fe56d9bb3e745acfb7f1f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void system_process </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Executes pending system events (like handling usb, timers etc). Call this somewhere in <a class="el" href="group__app.html#ga071d403b77a003f23a0d2ab1fbb67a36">app_process()</a>. </p>
|
||||
|
||||
<p><div class="dynheader">
|
||||
Here is the call graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_cgraph.png" border="0" usemap="#group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_cgraph" alt=""/></div>
|
||||
<map name="group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_cgraph" id="group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_cgraph">
|
||||
<area shape="rect" id="node2" href="ll__system_8h.html#a1314af5893cdde97e48bf135b6996b1c" title="ll_system_process" alt="" coords="172,5,303,32"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
<p><div class="dynheader">
|
||||
Here is the caller graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_icgraph.png" border="0" usemap="#group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_icgraph" alt=""/></div>
|
||||
<map name="group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_icgraph" id="group__system_ga222cd9a0957fe56d9bb3e745acfb7f1f_icgraph">
|
||||
<area shape="rect" id="node2" href="group__app.html#ga071d403b77a003f23a0d2ab1fbb67a36" title="app_process" alt="" coords="172,5,268,32"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gab93c255fb3f413ae70ccaa7600c56c26"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void system_toggle_led </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Toggles a Status Led. Use this function for debugging or to show activity </p>
|
||||
|
||||
<p><div class="dynheader">
|
||||
Here is the call graph for this function:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="group__system_gab93c255fb3f413ae70ccaa7600c56c26_cgraph.png" border="0" usemap="#group__system_gab93c255fb3f413ae70ccaa7600c56c26_cgraph" alt=""/></div>
|
||||
<map name="group__system_gab93c255fb3f413ae70ccaa7600c56c26_cgraph" id="group__system_gab93c255fb3f413ae70ccaa7600c56c26_cgraph">
|
||||
<area shape="rect" id="node2" href="ll__system_8h.html#a619ececb655f5b1bf378ced866103952" title="ll_system_toggle_led" alt="" coords="184,5,328,32"/></map>
|
||||
</div>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Tue May 12 2015 11:11:45 for discoverpixy by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.9.1
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user