Skip to content

Commit

Permalink
deploy: 0269ed8
Browse files Browse the repository at this point in the history
  • Loading branch information
@robert-wm
robert-wm committed Oct 11, 2024
1 parent e78e77e commit 7c4d71d
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 27 deletions.
15 changes: 13 additions & 2 deletions group__mailbox__group.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -264,11 +264,22 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadc065e4155b29ed03896d2b
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pec</td><td>Pointer to ethercat master structure, which you got from <a class="el" href="group__ec__group.html#ga57814183337779bfc29a8c1170269c37">ec_open</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">slave</td><td>Number of ethercat slave. this depends on the physical order of the ethercat slaves (usually the n'th slave attached). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mbx_flag</td><td>Mailbox protocol flag to be checked</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mbx_flag</td><td>Mailbox protocols flag to be checked</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">EC_OK</td><td>If all requested protocols supported, otherwise ored error codes. </td></tr>
<tr><td class="paramname">EC_ERROR_MAILBOX_NOT_SUPPORTED_AOE</td><td>Mailbox AoE not supported. </td></tr>
<tr><td class="paramname">EC_ERROR_MAILBOX_NOT_SUPPORTED_EOE</td><td>Mailbox EoE not supported. </td></tr>
<tr><td class="paramname">EC_ERROR_MAILBOX_NOT_SUPPORTED_COE</td><td>Mailbox CoE not supported. </td></tr>
<tr><td class="paramname">EC_ERROR_MAILBOX_NOT_SUPPORTED_FOE</td><td>Mailbox FoE not supported. </td></tr>
<tr><td class="paramname">EC_ERROR_MAILBOX_NOT_SUPPORTED_SOE</td><td>Mailbox SoE not supported. </td></tr>
<tr><td class="paramname">EC_ERROR_MAILBOX_NOT_SUPPORTED_VOE</td><td>Mailbox VoE not supported. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if supported, 0 otherwise </dd></dl>

</div>
</div>
Expand Down
50 changes: 25 additions & 25 deletions mbx_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -239,33 +239,33 @@
<div class="line"><a name="l00228"></a><span class="lineno"><a class="line" href="group__mailbox__group.html#gac3892fc3f0a339ea3fba700240f2fd56"> 228</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__mailbox__group.html#gac3892fc3f0a339ea3fba700240f2fd56">ec_mbx_sched_read</a>(<a class="code" href="structec.html">ec_t</a> *pec, osal_uint16_t slave);</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; </div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; </div>
<div class="line"><a name="l00241"></a><span class="lineno"><a class="line" href="group__mailbox__group.html#gadc065e4155b29ed03896d2b86bedec70"> 241</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__mailbox__group.html#gadc065e4155b29ed03896d2b86bedec70">ec_mbx_check</a>(<a class="code" href="structec.html">ec_t</a> *pec, <span class="keywordtype">int</span> slave, osal_uint16_t mbx_flag);</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; </div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; </div>
<div class="line"><a name="l00254"></a><span class="lineno"><a class="line" href="group__mailbox__group.html#ga2426027ecde6a81073bdde7cffac12ec"> 254</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__mailbox__group.html#ga2426027ecde6a81073bdde7cffac12ec">ec_mbx_next_counter</a>(<a class="code" href="structec.html">ec_t</a> *pec, <span class="keywordtype">int</span> slave, <span class="keywordtype">int</span> *seq_counter); </div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; </div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;<span class="preprocessor">#define ec_mbx_get_free_recv_buffer(pec, slave, entry, timeout, lock) \</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;<span class="preprocessor"> pool_get(&amp;(pec)-&gt;mbx_message_pool_recv_free, &amp;(entry), (timeout))</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; </div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;<span class="preprocessor">#define ec_mbx_get_free_send_buffer_old(pec, slave, entry, timeout, lock) \</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;<span class="preprocessor"> pool_get(&amp;(pec)-&gt;mbx_message_pool_send_free, &amp;(entry), (timeout))</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"><a class="line" href="group__mailbox__group.html#gadc065e4155b29ed03896d2b86bedec70"> 247</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__mailbox__group.html#gadc065e4155b29ed03896d2b86bedec70">ec_mbx_check</a>(<a class="code" href="structec.html">ec_t</a> *pec, <span class="keywordtype">int</span> slave, osal_uint16_t mbx_flag);</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; </div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; </div>
<div class="line"><a name="l00260"></a><span class="lineno"><a class="line" href="group__mailbox__group.html#ga2426027ecde6a81073bdde7cffac12ec"> 260</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__mailbox__group.html#ga2426027ecde6a81073bdde7cffac12ec">ec_mbx_next_counter</a>(<a class="code" href="structec.html">ec_t</a> *pec, <span class="keywordtype">int</span> slave, <span class="keywordtype">int</span> *seq_counter); </div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160; </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; </div>
<div class="line"><a name="l00275"></a><span class="lineno"><a class="line" href="group__mailbox__group.html#gacac494640051492bea8a86b55ed46a82"> 275</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__mailbox__group.html#gacac494640051492bea8a86b55ed46a82">ec_mbx_get_free_send_buffer</a>(<a class="code" href="structec.html">ec_t</a> *pec, osal_uint16_t slave, <a class="code" href="structpool__entry.html">pool_entry_t</a> **pp_entry, osal_timer_t *timeout);</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;<span class="preprocessor">#define ec_mbx_return_free_send_buffer(pec, slave, entry) \</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;<span class="preprocessor"> pool_put(&amp;(pec)-&gt;mbx_message_pool_send_free, (entry)) </span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; </div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160;<span class="preprocessor">#define ec_mbx_return_free_recv_buffer(pec, slave, entry) \</span></div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160;<span class="preprocessor"> pool_put(&amp;(pec)-&gt;mbx_message_pool_recv_free, (entry))</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;<span class="preprocessor">#define ec_mbx_get_free_recv_buffer(pec, slave, entry, timeout, lock) \</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="preprocessor"> pool_get(&amp;(pec)-&gt;mbx_message_pool_recv_free, &amp;(entry), (timeout))</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; </div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;<span class="preprocessor">#define ec_mbx_get_free_send_buffer_old(pec, slave, entry, timeout, lock) \</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="preprocessor"> pool_get(&amp;(pec)-&gt;mbx_message_pool_send_free, &amp;(entry), (timeout))</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160; </div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; </div>
<div class="line"><a name="l00281"></a><span class="lineno"><a class="line" href="group__mailbox__group.html#gacac494640051492bea8a86b55ed46a82"> 281</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="group__mailbox__group.html#gacac494640051492bea8a86b55ed46a82">ec_mbx_get_free_send_buffer</a>(<a class="code" href="structec.html">ec_t</a> *pec, osal_uint16_t slave, <a class="code" href="structpool__entry.html">pool_entry_t</a> **pp_entry, osal_timer_t *timeout);</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; </div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; </div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;}</div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; </div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// LIBETHERCAT_MBX_H</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; </div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;<span class="preprocessor">#define ec_mbx_return_free_send_buffer(pec, slave, entry) \</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="preprocessor"> pool_put(&amp;(pec)-&gt;mbx_message_pool_send_free, (entry)) </span></div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; </div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;<span class="preprocessor">#define ec_mbx_return_free_recv_buffer(pec, slave, entry) \</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;<span class="preprocessor"> pool_put(&amp;(pec)-&gt;mbx_message_pool_recv_free, (entry))</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; </div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; </div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;}</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; </div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// LIBETHERCAT_MBX_H</span></div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; </div>
<div class="ttc" id="acoe_8h_html"><div class="ttname"><a href="coe_8h.html">coe.h</a></div><div class="ttdoc">EtherCAT coe functions.</div></div>
<div class="ttc" id="acommon_8h_html"><div class="ttname"><a href="common_8h.html">common.h</a></div><div class="ttdoc">ethercat master common stuff</div></div>
<div class="ttc" id="adatagram_8h_html"><div class="ttname"><a href="datagram_8h.html">datagram.h</a></div><div class="ttdoc">ethercat datagram</div></div>
Expand Down

0 comments on commit 7c4d71d

Please sign in to comment.