mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
186 lines
20 KiB
HTML
186 lines
20 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>ChibiOS/RT: mac_lld.h Source File</title>
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<table style="text-align: center; width: 100%;" border="0"
|
|
cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
|
<td style="width: 80px;"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr size="1">
|
|
<!-- Generated by Doxygen 1.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="main.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 class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div 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 class="header">
|
|
<div class="headertitle">
|
|
<h1>mac_lld.h</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="templates_2mac__lld_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"></span>
|
|
<a name="l00004"></a>00004 <span class="comment"> This file is part of ChibiOS/RT.</span>
|
|
<a name="l00005"></a>00005 <span class="comment"></span>
|
|
<a name="l00006"></a>00006 <span class="comment"> ChibiOS/RT is free software; you can redistribute it and/or modify</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
|
|
<a name="l00010"></a>00010 <span class="comment"></span>
|
|
<a name="l00011"></a>00011 <span class="comment"> ChibiOS/RT is distributed in the hope that it will be useful,</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
|
|
<a name="l00015"></a>00015 <span class="comment"></span>
|
|
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
|
|
<a name="l00018"></a>00018 <span class="comment"></span>
|
|
<a name="l00019"></a>00019 <span class="comment"> ---</span>
|
|
<a name="l00020"></a>00020 <span class="comment"></span>
|
|
<a name="l00021"></a>00021 <span class="comment"> A special exception to the GPL can be applied should you wish to distribute</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> a combined work that includes ChibiOS/RT, without being obliged to provide</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> the source code for any proprietary components. See the file exception.txt</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> for full details of how and when the exception can be applied.</span>
|
|
<a name="l00025"></a>00025 <span class="comment">*/</span>
|
|
<a name="l00026"></a>00026 <span class="comment"></span>
|
|
<a name="l00027"></a>00027 <span class="comment">/**</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * @file templates/mac_lld.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief MAC Driver subsystem low level driver header template.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup MAC_LLD</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * @{</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> */</span>
|
|
<a name="l00034"></a>00034
|
|
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _MAC_LLD_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _MAC_LLD_H_</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_HAL_USE_MAC || defined(__DOXYGEN__)</span>
|
|
<a name="l00039"></a>00039 <span class="preprocessor"></span>
|
|
<a name="l00040"></a>00040 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00041"></a>00041 <span class="comment">/* Driver constants. */</span>
|
|
<a name="l00042"></a>00042 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00043"></a>00043
|
|
<a name="l00044"></a>00044 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00045"></a>00045 <span class="comment">/* Driver pre-compile time settings. */</span>
|
|
<a name="l00046"></a>00046 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00047"></a>00047 <span class="comment"></span>
|
|
<a name="l00048"></a>00048 <span class="comment">/**</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * @brief Number of available transmit buffers.</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> */</span>
|
|
<a name="l00051"></a>00051 <span class="preprocessor">#if !defined(MAC_TRANSMIT_BUFFERS) || defined(__DOXYGEN__)</span>
|
|
<a name="l00052"></a><a class="code" href="group___m_a_c___l_l_d.html#ga70ef1dc547e538dc627556c4dd3b987f">00052</a> <span class="preprocessor"></span><span class="preprocessor">#define MAC_TRANSMIT_BUFFERS 2</span>
|
|
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00055"></a>00055 <span class="comment">/**</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> * @brief Number of available receive buffers.</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> */</span>
|
|
<a name="l00058"></a>00058 <span class="preprocessor">#if !defined(MAC_RECEIVE_BUFFERS) || defined(__DOXYGEN__)</span>
|
|
<a name="l00059"></a><a class="code" href="group___m_a_c___l_l_d.html#ga1b2ed91549cfb2e51cb26024e9b00d72">00059</a> <span class="preprocessor"></span><span class="preprocessor">#define MAC_RECEIVE_BUFFERS 2</span>
|
|
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00062"></a>00062 <span class="comment">/**</span>
|
|
<a name="l00063"></a>00063 <span class="comment"> * @brief Maximum supported frame size.</span>
|
|
<a name="l00064"></a>00064 <span class="comment"> */</span>
|
|
<a name="l00065"></a>00065 <span class="preprocessor">#if !defined(MAC_BUFFERS_SIZE) || defined(__DOXYGEN__)</span>
|
|
<a name="l00066"></a><a class="code" href="group___m_a_c___l_l_d.html#ga78ab6a03af35ab06f0a4074851f6e26c">00066</a> <span class="preprocessor"></span><span class="preprocessor">#define MAC_BUFFERS_SIZE 1518</span>
|
|
<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00068"></a>00068 <span class="preprocessor"></span>
|
|
<a name="l00069"></a>00069 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00070"></a>00070 <span class="comment">/* Derived constants and error checks. */</span>
|
|
<a name="l00071"></a>00071 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00072"></a>00072
|
|
<a name="l00073"></a>00073 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00074"></a>00074 <span class="comment">/* Driver data structures and types. */</span>
|
|
<a name="l00075"></a>00075 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00076"></a>00076 <span class="comment"></span>
|
|
<a name="l00077"></a>00077 <span class="comment">/**</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> * @brief Structure representing a MAC driver.</span>
|
|
<a name="l00079"></a>00079 <span class="comment"> */</span>
|
|
<a name="l00080"></a><a class="code" href="struct_m_a_c_driver.html">00080</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00081"></a><a class="code" href="struct_m_a_c_driver.html#a667cd08245f7f3cbd2c9fb7cf5abe2bd">00081</a> <a class="code" href="struct_semaphore.html" title="Semaphore structure.">Semaphore</a> md_tdsem; <span class="comment">/**< Transmit semaphore. */</span>
|
|
<a name="l00082"></a><a class="code" href="struct_m_a_c_driver.html#ade31ca2c5d242cd0418f3e44d92beaee">00082</a> <a class="code" href="struct_semaphore.html" title="Semaphore structure.">Semaphore</a> md_rdsem; <span class="comment">/**< Receive semaphore. */</span>
|
|
<a name="l00083"></a>00083 <span class="preprocessor">#if CH_USE_EVENTS</span>
|
|
<a name="l00084"></a><a class="code" href="struct_m_a_c_driver.html#a99d364bf90207cc47155765ae151bfc6">00084</a> <span class="preprocessor"></span> <a class="code" href="struct_event_source.html" title="Event Source structure.">EventSource</a> md_rdevent; <span class="comment">/**< Receive event source. */</span>
|
|
<a name="l00085"></a>00085 <span class="preprocessor">#endif</span>
|
|
<a name="l00086"></a>00086 <span class="preprocessor"></span> <span class="comment">/* End of the mandatory fields.*/</span>
|
|
<a name="l00087"></a>00087 } <a class="code" href="struct_m_a_c_driver.html" title="Structure representing a MAC driver.">MACDriver</a>;
|
|
<a name="l00088"></a>00088 <span class="comment"></span>
|
|
<a name="l00089"></a>00089 <span class="comment">/**</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> * @brief Structure representing a transmit descriptor.</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> */</span>
|
|
<a name="l00092"></a><a class="code" href="struct_m_a_c_transmit_descriptor.html">00092</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00093"></a><a class="code" href="struct_m_a_c_transmit_descriptor.html#ac2b2f6220b1a9eea09aa5b918f3b3260">00093</a> <span class="keywordtype">size_t</span> td_offset; <span class="comment">/**< Current write offset. */</span>
|
|
<a name="l00094"></a><a class="code" href="struct_m_a_c_transmit_descriptor.html#a75b88b6e242023604e6b6a6ec6c940ac">00094</a> <span class="keywordtype">size_t</span> td_size; <span class="comment">/**< Available space size. */</span>
|
|
<a name="l00095"></a>00095 <span class="comment">/* End of the mandatory fields.*/</span>
|
|
<a name="l00096"></a>00096 } <a class="code" href="struct_m_a_c_transmit_descriptor.html" title="Structure representing a transmit descriptor.">MACTransmitDescriptor</a>;
|
|
<a name="l00097"></a>00097 <span class="comment"></span>
|
|
<a name="l00098"></a>00098 <span class="comment">/**</span>
|
|
<a name="l00099"></a>00099 <span class="comment"> * @brief Structure representing a receive descriptor.</span>
|
|
<a name="l00100"></a>00100 <span class="comment"> */</span>
|
|
<a name="l00101"></a><a class="code" href="struct_m_a_c_receive_descriptor.html">00101</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00102"></a><a class="code" href="struct_m_a_c_receive_descriptor.html#ad7e063828e42d43778007eaf79f745a7">00102</a> <span class="keywordtype">size_t</span> rd_offset; <span class="comment">/**< Current read offset. */</span>
|
|
<a name="l00103"></a><a class="code" href="struct_m_a_c_receive_descriptor.html#a344a0ef042014f2149466a6d501d4b5f">00103</a> <span class="keywordtype">size_t</span> rd_size; <span class="comment">/**< Available data size. */</span>
|
|
<a name="l00104"></a>00104 <span class="comment">/* End of the mandatory fields.*/</span>
|
|
<a name="l00105"></a>00105 } <a class="code" href="struct_m_a_c_receive_descriptor.html" title="Structure representing a receive descriptor.">MACReceiveDescriptor</a>;
|
|
<a name="l00106"></a>00106
|
|
<a name="l00107"></a>00107 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00108"></a>00108 <span class="comment">/* Driver macros. */</span>
|
|
<a name="l00109"></a>00109 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00110"></a>00110
|
|
<a name="l00111"></a>00111 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00112"></a>00112 <span class="comment">/* External declarations. */</span>
|
|
<a name="l00113"></a>00113 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00114"></a>00114
|
|
<a name="l00115"></a>00115 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00116"></a>00116 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00117"></a>00117 <span class="preprocessor">#endif</span>
|
|
<a name="l00118"></a>00118 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group___m_a_c___l_l_d.html#ga37e276cbed823fb80fdce3df3f9f7ddf" title="Low level MAC initialization.">mac_lld_init</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00119"></a>00119 <span class="keywordtype">void</span> <a class="code" href="group___m_a_c___l_l_d.html#ga73678bb62809ae2a530ffe419c235afd" title="Low level MAC address setup.">mac_lld_set_address</a>(<a class="code" href="struct_m_a_c_driver.html" title="Structure representing a MAC driver.">MACDriver</a> *macp, <span class="keyword">const</span> <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *p);
|
|
<a name="l00120"></a>00120 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group___m_a_c___l_l_d.html#ga021a3cb5a0217df7e1891e614c84e087" title="Returns a transmission descriptor.">max_lld_get_transmit_descriptor</a>(<a class="code" href="struct_m_a_c_driver.html" title="Structure representing a MAC driver.">MACDriver</a> *macp,
|
|
<a name="l00121"></a>00121 <a class="code" href="struct_m_a_c_transmit_descriptor.html" title="Structure representing a transmit descriptor.">MACTransmitDescriptor</a> *tdp);
|
|
<a name="l00122"></a>00122 <span class="keywordtype">size_t</span> <a class="code" href="group___m_a_c___l_l_d.html#gafb8c9ab832baf5a87dfeeed680192c73" title="Writes to a transmit descriptor&#39;s stream.">mac_lld_write_transmit_descriptor</a>(<a class="code" href="struct_m_a_c_transmit_descriptor.html" title="Structure representing a transmit descriptor.">MACTransmitDescriptor</a> *tdp,
|
|
<a name="l00123"></a>00123 <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buf,
|
|
<a name="l00124"></a>00124 <span class="keywordtype">size_t</span> size);
|
|
<a name="l00125"></a>00125 <span class="keywordtype">void</span> <a class="code" href="group___m_a_c___l_l_d.html#ga29cd5df4ce571b7088c7107cf7901330" title="Releases a transmit descriptor and starts the transmission of the enqueued data as a single frame...">mac_lld_release_transmit_descriptor</a>(<a class="code" href="struct_m_a_c_transmit_descriptor.html" title="Structure representing a transmit descriptor.">MACTransmitDescriptor</a> *tdp);
|
|
<a name="l00126"></a>00126 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group___m_a_c___l_l_d.html#ga3420490c83eb7464185717f2044e1bc3" title="Returns a receive descriptor.">max_lld_get_receive_descriptor</a>(<a class="code" href="struct_m_a_c_driver.html" title="Structure representing a MAC driver.">MACDriver</a> *macp,
|
|
<a name="l00127"></a>00127 <a class="code" href="struct_m_a_c_receive_descriptor.html" title="Structure representing a receive descriptor.">MACReceiveDescriptor</a> *rdp);
|
|
<a name="l00128"></a>00128 <span class="keywordtype">size_t</span> <a class="code" href="group___m_a_c___l_l_d.html#ga2104ce3254db587b7a85dcd128d3cab7" title="Reads from a receive descriptor&#39;s stream.">mac_lld_read_receive_descriptor</a>(<a class="code" href="struct_m_a_c_receive_descriptor.html" title="Structure representing a receive descriptor.">MACReceiveDescriptor</a> *rdp,
|
|
<a name="l00129"></a>00129 <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buf,
|
|
<a name="l00130"></a>00130 <span class="keywordtype">size_t</span> size);
|
|
<a name="l00131"></a>00131 <span class="keywordtype">void</span> <a class="code" href="group___m_a_c___l_l_d.html#gaa04797c813452cbc715d4233e4c44f49" title="Releases a receive descriptor.">mac_lld_release_receive_descriptor</a>(<a class="code" href="struct_m_a_c_receive_descriptor.html" title="Structure representing a receive descriptor.">MACReceiveDescriptor</a> *rdp);
|
|
<a name="l00132"></a>00132 <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> <a class="code" href="group___m_a_c___l_l_d.html#ga5d9f510e66cbdd6f4968c5411c2de7a5" title="Updates and returns the link status.">mac_lld_poll_link_status</a>(<a class="code" href="struct_m_a_c_driver.html" title="Structure representing a MAC driver.">MACDriver</a> *macp);
|
|
<a name="l00133"></a>00133 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00134"></a>00134 <span class="preprocessor"></span>}
|
|
<a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
|
|
<a name="l00136"></a>00136 <span class="preprocessor"></span>
|
|
<a name="l00137"></a>00137 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_MAC */</span>
|
|
<a name="l00138"></a>00138
|
|
<a name="l00139"></a>00139 <span class="preprocessor">#endif </span><span class="comment">/* _MAC_LLD_H_ */</span>
|
|
<a name="l00140"></a>00140 <span class="comment"></span>
|
|
<a name="l00141"></a>00141 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|