External/f2838x_cm_cia402_solution
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
main
f2838x_cm_cia402_solution/docs/html/da/d44/foeappl_8c.html

180 lines
16 KiB
HTML
Raw Permalink Normal View History

doc: добавлена документация doxygen'a
2024-12-10 11:15:16 +03:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ECAT_Slave_in_ПЧ2П_c402: Файл foeappl.c</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>
<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="projectlogo"><img alt="Logo" src="../../Diakont3.jpg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ECAT_Slave_in_ПЧ2П_c402
&#160;<span id="projectnumber">0.8</span>
</div>
<div id="projectbrief">Реализация EtherCAT Slave для CM TMS320F28388D</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Создано системой Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Поиск','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Поиск');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('da/d44/foeappl_8c.html','../../'); initResizable(); });
/* @license-end */
</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="#define-members">Макросы</a> &#124;
<a href="#func-members">Функции</a> </div>
<div class="headertitle">
<div class="title">Файл foeappl.c<div class="ingroups"><a class="el" href="../../db/dcb/group___fo_e.html">FileTransfer over EtherCAT</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation This file contains an example how to use the FoE services.
<a href="#details">Подробнее...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="../../de/d55/ecat__def_8h_source.html">ecat_def.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d9/d8b/ecatslv_8h_source.html">ecatslv.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../db/d5c/ecatfoe_8h_source.html">ecatfoe.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d6/d05/foeappl_8h_source.html">foeappl.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d8/d60/appl_interface_8h_source.html">applInterface.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Граф включаемых заголовочных файлов для foeappl.c:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="../../d6/d88/foeappl_8c__incl.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div>
<p><a href="../../da/d44/foeappl_8c_source.html">См. исходные тексты.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Макросы</h2></td></tr>
<tr class="memitem:ga7c86a511f3cd79fa36cc9cc132353bb7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#ga7c86a511f3cd79fa36cc9cc132353bb7">_FOEAPPL_</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:ga7c86a511f3cd79fa36cc9cc132353bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7c86a511f3cd79fa36cc9cc132353bb7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#ga7c86a511f3cd79fa36cc9cc132353bb7">_FOEAPPL_</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:ga7c86a511f3cd79fa36cc9cc132353bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Функции</h2></td></tr>
<tr class="memitem:ga0ab77fb8746313fd5f5fe1d16d4944ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#ga0ab77fb8746313fd5f5fe1d16d4944ea">FOE_Read</a> (<a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> <a class="el" href="../../de/d55/ecat__def_8h.html#aa0fddd0a6a2fbcad8e365fbb1e7a50fa">MBXMEM</a> *pName, <a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> nameSize, <a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> <a class="el" href="../../de/d55/ecat__def_8h.html#aa0fddd0a6a2fbcad8e365fbb1e7a50fa">MBXMEM</a> *pData, <a class="el" href="../../de/d55/ecat__def_8h.html#a69afa2e50b905f4eab1f2df8a3fd9f23">UINT32</a> password)</td></tr>
<tr class="memdesc:ga0ab77fb8746313fd5f5fe1d16d4944ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function starts a file reading. <a href="../../db/dcb/group___fo_e.html#ga0ab77fb8746313fd5f5fe1d16d4944ea">Подробнее...</a><br /></td></tr>
<tr class="separator:ga0ab77fb8746313fd5f5fe1d16d4944ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab6a6b4b38171bb3126757d5a89748e28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#gab6a6b4b38171bb3126757d5a89748e28">FOE_Write</a> (<a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> <a class="el" href="../../de/d55/ecat__def_8h.html#aa0fddd0a6a2fbcad8e365fbb1e7a50fa">MBXMEM</a> *pName, <a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> nameSize, <a class="el" href="../../de/d55/ecat__def_8h.html#a69afa2e50b905f4eab1f2df8a3fd9f23">UINT32</a> password)</td></tr>
<tr class="memdesc:gab6a6b4b38171bb3126757d5a89748e28"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function starts a file writing. <a href="../../db/dcb/group___fo_e.html#gab6a6b4b38171bb3126757d5a89748e28">Подробнее...</a><br /></td></tr>
<tr class="separator:gab6a6b4b38171bb3126757d5a89748e28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3364595a9bfe21abf05270a7928c6ab5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#ga3364595a9bfe21abf05270a7928c6ab5">FOE_Data</a> (<a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> <a class="el" href="../../de/d55/ecat__def_8h.html#aa0fddd0a6a2fbcad8e365fbb1e7a50fa">MBXMEM</a> *pData, <a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> Size)</td></tr>
<tr class="memdesc:ga3364595a9bfe21abf05270a7928c6ab5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function is called to write the next part of a file. <a href="../../db/dcb/group___fo_e.html#ga3364595a9bfe21abf05270a7928c6ab5">Подробнее...</a><br /></td></tr>
<tr class="separator:ga3364595a9bfe21abf05270a7928c6ab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga580f033256860e72f4d06d8acffd1b6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#ga580f033256860e72f4d06d8acffd1b6d">FOE_Ack</a> (<a class="el" href="../../de/d55/ecat__def_8h.html#a69afa2e50b905f4eab1f2df8a3fd9f23">UINT32</a> fileOffset, <a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> <a class="el" href="../../de/d55/ecat__def_8h.html#aa0fddd0a6a2fbcad8e365fbb1e7a50fa">MBXMEM</a> *pData)</td></tr>
<tr class="memdesc:ga580f033256860e72f4d06d8acffd1b6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function is called when the reading of a part of a file is acknowledged. <a href="../../db/dcb/group___fo_e.html#ga580f033256860e72f4d06d8acffd1b6d">Подробнее...</a><br /></td></tr>
<tr class="separator:ga580f033256860e72f4d06d8acffd1b6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa909fcea36b2da8106c81d2b118cdad7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#gaa909fcea36b2da8106c81d2b118cdad7">FOE_Busy</a> (<a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> done, <a class="el" href="../../de/d55/ecat__def_8h.html#a69afa2e50b905f4eab1f2df8a3fd9f23">UINT32</a> fileOffset, <a class="el" href="../../de/d55/ecat__def_8h.html#ab1922c2d8643eb7da964d427604e992e">UINT16</a> <a class="el" href="../../de/d55/ecat__def_8h.html#aa0fddd0a6a2fbcad8e365fbb1e7a50fa">MBXMEM</a> *pData)</td></tr>
<tr class="memdesc:gaa909fcea36b2da8106c81d2b118cdad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function is called when the reading of a part of a file should be repeated. <a href="../../db/dcb/group___fo_e.html#gaa909fcea36b2da8106c81d2b118cdad7">Подробнее...</a><br /></td></tr>
<tr class="separator:gaa909fcea36b2da8106c81d2b118cdad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19c1585ae073cddb40871642d8f370ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcb/group___fo_e.html#ga19c1585ae073cddb40871642d8f370ca">FOE_Error</a> (<a class="el" href="../../de/d55/ecat__def_8h.html#a69afa2e50b905f4eab1f2df8a3fd9f23">UINT32</a> errorCode)</td></tr>
<tr class="memdesc:ga19c1585ae073cddb40871642d8f370ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function is called when a file transfer is aborted from the other station. <a href="../../db/dcb/group___fo_e.html#ga19c1585ae073cddb40871642d8f370ca">Подробнее...</a><br /></td></tr>
<tr class="separator:ga19c1585ae073cddb40871642d8f370ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Подробное описание</h2>
<div class="textblock"><p>Implementation This file contains an example how to use the FoE services. </p>
<dl class="section author"><dt>Автор</dt><dd><a href="#" onclick="location.href='mai'+'lto:'+'Eth'+'er'+'cat'+'SS'+'C@b'+'ec'+'kho'+'ff'+'.co'+'m'; return false;">Ether<span style="display: none;">.nosp@m.</span>catS<span style="display: none;">.nosp@m.</span>SC@be<span style="display: none;">.nosp@m.</span>ckho<span style="display: none;">.nosp@m.</span>ff.co<span style="display: none;">.nosp@m.</span>m</a></dd></dl>
<dl class="section version"><dt>Версия</dt><dd>5.12</dd></dl>
<p><br />
Changes to version V5.11:<br />
V5.12 FOE1: update new interface,move the FoE sample to sampleappl,add FoE application callback functions<br />
<br />
Changes to version V5.10:<br />
V5.11 FOE2: FoE_Read() check File name buffer before store the requested file name, add string terminator<br />
V5.11 TEST5: send a FoE busy on a FoE read request<br />
V5.11 TEST9: "add behaviour 0x2020.7 (SDO requests on 0x3006.0 are set to pending until an FoE read request on ""UnlockSdoResp"" is received or in case that no mbx queue is supported when a new mbx request was received)"<br />
<br />
Changes to version V5.0:<br />
V5.10 FOE2: Update file handling to support File sizes greater than 0x8000 Bytes (change value of "FOE_MAXDATA")<br />
<br />
Changes to version V4.20:<br />
V5.0 FOE3: Add additional file name copy operation to provide name byte swapping<br />
V5.0 FOE5: Add FoE test operation (FOE_SAVE_FILES need to be disabled). On download only the files size is save. On upload a file with incrementing content and the previous downloaded size will be created.<br />
V5.0 FOE6: Save file if MBX 16Bit access is enabled<br />
<br />
Changes to version V4.11:<br />
V4.20 FOE 2: Add File store compiler switch<br />
V4.20 FOE 1: Removed FILESUPPORT<br />
V4.11 FOE 1: nFileWriteOffset is now a 32bit variable to extend the maximum file size<br />
<br />
Changes to version V3.20:<br />
V4.10 FOE 1-14: Filetransfer over FoE: Files can be read and stored to harddisk<br />
without any filesizelimitation (FILESUPPORT must defined) </p>
<p class="definition">См. определение в файле <a class="el" href="../../da/d44/foeappl_8c_source.html">foeappl.c</a></p>
</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="../../da/d44/foeappl_8c.html">foeappl.c</a></li>
<li class="footer">Создано системой <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink