ln-dotnet
/
SOES
mirror of https://github.com/OpenEtherCATsociety/SOES.git
3
0
Fork 0
Code Issues Projects Releases Wiki Activity
SOES/soes/doc/html/esc__foe_8h.html

159 lines
7.1 KiB
HTML
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"/>
<title>SOES: esc_foe.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SOES&#160;<span id="projectnumber">v1.0.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">esc_foe.h File Reference</div> </div>
</div>
<div class="contents">
<p>Headerfile for <a class="el" href="esc__foe_8c.html" title="File over EtherCAT (FoE) module.">esc_foe.c</a>.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfoe__writefile__cfg.html">foe_writefile_cfg_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfoe__cfg__t.html">foe_cfg_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__FOEvar.html">_FOEvar</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__foe_8h.html#a67c78bb265f195309e12db00ead5e50e">FOE_FN_MAX</a>&#160;&#160;&#160;15</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__foe_8h.html#a0b138231b97d90990427644659e92e0c">FOE_config</a> (<a class="el" href="structfoe__cfg__t.html">foe_cfg_t</a> *cfg, foe_writefile_cfg_t *cfg_files)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__foe_8h.html#a0fc65c1e2994bf93b40bdf2bcdbad8a0">FOE_init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="esc__foe_8h.html#a57ace265be44ccc2a0af313d007261b2">ESC_foeprocess</a> (void)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Headerfile for <a class="el" href="esc__foe_8c.html" title="File over EtherCAT (FoE) module.">esc_foe.c</a>. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a67c78bb265f195309e12db00ead5e50e"></a><!-- doxytag: member="esc_foe.h::FOE_FN_MAX" ref="a67c78bb265f195309e12db00ead5e50e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FOE_FN_MAX&#160;&#160;&#160;15</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maximum number of characters allowed in a file name. </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a57ace265be44ccc2a0af313d007261b2"></a><!-- doxytag: member="esc_foe.h::ESC_foeprocess" ref="a57ace265be44ccc2a0af313d007261b2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ESC_foeprocess </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Main FoE function checking the status on current mailbox buffers carrying data, distributing the mailboxes to appropriate FOE functions depending on requested opcode. On Error an FoE Error or FoE Abort will be sent. </p>
</div>
</div>
<a class="anchor" id="a0b138231b97d90990427644659e92e0c"></a><!-- doxytag: member="esc_foe.h::FOE_config" ref="a0b138231b97d90990427644659e92e0c" args="(foe_cfg_t *cfg, foe_writefile_cfg_t *cfg_files)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FOE_config </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structfoe__cfg__t.html">foe_cfg_t</a> *&#160;</td>
<td class="paramname"><em>cfg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">foe_writefile_cfg_t *&#160;</td>
<td class="paramname"><em>cfg_files</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function copying the application configuration variable to the FoE module local pointer variable.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cfg</td><td>= Pointer to by the Application static declared configuration variable holding application specific details. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cfg_files</td><td>= Pointer to by the Application static declared configuration variable holding file specific details for files to be handled by FoE </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0fc65c1e2994bf93b40bdf2bcdbad8a0"></a><!-- doxytag: member="esc_foe.h::FOE_init" ref="a0fc65c1e2994bf93b40bdf2bcdbad8a0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FOE_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize by clearing all current status variables. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Jul 10 2013 11:14:19 for SOES by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink