241 lines
10 KiB
HTML
241 lines
10 KiB
HTML
<!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>SOEM: ethercatfoe.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">SOEM <span id="projectnumber">v1.3.1</span></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Data 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 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="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ethercatfoe.h File Reference</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
|
|
<p>Headerfile for <a class="el" href="ethercatfoe_8c.html" title="File over EtherCAT (FoE) module.">ethercatfoe.c</a>.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ethercatfoe_8h.html#aec93d4a29467cc0bdb9fc75ba7407f98">ecx_FOEdefinehook</a> (<a class="el" href="structecx__contextt.html">ecx_contextt</a> *context, void *hook)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ethercatfoe_8h.html#af35e58fe5ad113236426d97caf1f119f">ecx_FOEread</a> (<a class="el" href="structecx__contextt.html">ecx_contextt</a> *context, uint16 <a class="el" href="eepromtool_8c.html#a7f46665d1fe6d01a75a90942bb34cfaf">slave</a>, char *filename, uint32 password, int *psize, void *p, int timeout)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ethercatfoe_8h.html#ab3aacd710c4ae3f92a9da2b29199c345">ecx_FOEwrite</a> (<a class="el" href="structecx__contextt.html">ecx_contextt</a> *context, uint16 <a class="el" href="eepromtool_8c.html#a7f46665d1fe6d01a75a90942bb34cfaf">slave</a>, char *filename, uint32 password, int psize, void *p, int timeout)</td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>Headerfile for <a class="el" href="ethercatfoe_8c.html" title="File over EtherCAT (FoE) module.">ethercatfoe.c</a>. </p>
|
|
</div><hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="aec93d4a29467cc0bdb9fc75ba7407f98"></a><!-- doxytag: member="ethercatfoe.h::ecx_FOEdefinehook" ref="aec93d4a29467cc0bdb9fc75ba7407f98" args="(ecx_contextt *context, void *hook)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ecx_FOEdefinehook </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structecx__contextt.html">ecx_contextt</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>hook</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>FoE progress hook.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>= context struct </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">hook</td><td>= Pointer to hook function. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>1 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af35e58fe5ad113236426d97caf1f119f"></a><!-- doxytag: member="ethercatfoe.h::ecx_FOEread" ref="af35e58fe5ad113236426d97caf1f119f" args="(ecx_contextt *context, uint16 slave, char *filename, uint32 password, int *psize, void *p, int timeout)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ecx_FOEread </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structecx__contextt.html">ecx_contextt</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16 </td>
|
|
<td class="paramname"><em>slave</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32 </td>
|
|
<td class="paramname"><em>password</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>psize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>p</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>FoE read, blocking.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>= context struct </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">slave</td><td>= Slave number. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>= Filename of file to read. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>= password. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">psize</td><td>= Size in bytes of file buffer, returns bytes read from file. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">p</td><td>= Pointer to file buffer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>= Timeout per mailbox cycle in us, standard is EC_TIMEOUTRXM </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Workcounter from last slave response </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab3aacd710c4ae3f92a9da2b29199c345"></a><!-- doxytag: member="ethercatfoe.h::ecx_FOEwrite" ref="ab3aacd710c4ae3f92a9da2b29199c345" args="(ecx_contextt *context, uint16 slave, char *filename, uint32 password, int psize, void *p, int timeout)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ecx_FOEwrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structecx__contextt.html">ecx_contextt</a> * </td>
|
|
<td class="paramname"><em>context</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16 </td>
|
|
<td class="paramname"><em>slave</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32 </td>
|
|
<td class="paramname"><em>password</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>psize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>p</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>FoE write, blocking.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>= context struct </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">slave</td><td>= Slave number. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>= Filename of file to write. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>= password. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">psize</td><td>= Size in bytes of file buffer. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">p</td><td>= Pointer to file buffer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>= Timeout per mailbox cycle in us, standard is EC_TIMEOUTRXM </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Workcounter from last slave response </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 11 2015 20:44:23 for SOEM by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
|
</body>
|
|
</html>
|