coelner/gnuk
1
0
Fork 0
mirror of https://salsa.debian.org/gnuk-team/gnuk/gnuk.git synced 2024-09-21 11:20:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
6e6d97db5f
gnuk/ChibiOS_2.0.2/docs/html/templates_2mac__lld_8c_source.html

222 lines
21 KiB
HTML
Raw Normal View History

Initial import
2010-08-10 03:11:02 +00:00
<!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.c 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.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>mac_lld.c</h1><a href="templates_2mac__lld_8c.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 &lt;http://www.gnu.org/licenses/&gt;.</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.c</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief MAC Driver subsystem low level driver source 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">#include &quot;<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>&quot;</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;<a class="code" href="hal_8h.html" title="HAL subsystem header.">hal.h</a>&quot;</span>
<a name="l00037"></a>00037
<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 exported variables. */</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 local variables. */</span>
<a name="l00046"></a>00046 <span class="comment">/*===========================================================================*/</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">/*===========================================================================*/</span>
<a name="l00049"></a>00049 <span class="comment">/* Driver local functions. */</span>
<a name="l00050"></a>00050 <span class="comment">/*===========================================================================*/</span>
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">/*===========================================================================*/</span>
<a name="l00053"></a>00053 <span class="comment">/* Driver interrupt handlers. */</span>
<a name="l00054"></a>00054 <span class="comment">/*===========================================================================*/</span>
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">/*===========================================================================*/</span>
<a name="l00057"></a>00057 <span class="comment">/* Driver exported functions. */</span>
<a name="l00058"></a>00058 <span class="comment">/*===========================================================================*/</span>
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment">/**</span>
<a name="l00061"></a>00061 <span class="comment"> * @brief Low level MAC initialization.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <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="l00064"></a>00064
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/**</span>
<a name="l00068"></a>00068 <span class="comment"> * @brief Low level MAC address setup.</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * @param[in] macp pointer to the @p MACDriver object</span>
<a name="l00071"></a>00071 <span class="comment"> * @param[in] p pointer to a six bytes buffer containing the MAC</span>
<a name="l00072"></a>00072 <span class="comment"> * address. If this parameter is set to @p NULL then</span>
<a name="l00073"></a>00073 <span class="comment"> * a system default MAC is used.</span>
<a name="l00074"></a>00074 <span class="comment"> */</span>
<a name="l00075"></a>00075 <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="l00076"></a>00076
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment">/**</span>
<a name="l00080"></a>00080 <span class="comment"> * @brief Returns a transmission descriptor.</span>
<a name="l00081"></a>00081 <span class="comment"> * @details One of the available transmission descriptors is locked and</span>
<a name="l00082"></a>00082 <span class="comment"> * returned.</span>
<a name="l00083"></a>00083 <span class="comment"> *</span>
<a name="l00084"></a>00084 <span class="comment"> * @param[in] macp pointer to the @p MACDriver object</span>
<a name="l00085"></a>00085 <span class="comment"> * @param[out] tdp pointer to a @p MACTransmitDescriptor structure</span>
<a name="l00086"></a>00086 <span class="comment"> * @return The operation status.</span>
<a name="l00087"></a>00087 <span class="comment"> * @retval RDY_OK a descriptor was obtained.</span>
<a name="l00088"></a>00088 <span class="comment"> * @retval RDY_TIMEOUT descriptor not available.</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a>00090 <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="l00091"></a>00091 <a class="code" href="struct_m_a_c_transmit_descriptor.html" title="Structure representing a transmit descriptor.">MACTransmitDescriptor</a> *tdp) {
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordflow">return</span> <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>;
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment">/**</span>
<a name="l00097"></a>00097 <span class="comment"> * @brief Writes to a transmit descriptor&#39;s stream.</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * @param[in] tdp pointer to a @p MACTransmitDescriptor structure</span>
<a name="l00100"></a>00100 <span class="comment"> * @param[in] buf pointer to the buffer containing the data to be</span>
<a name="l00101"></a>00101 <span class="comment"> * written</span>
<a name="l00102"></a>00102 <span class="comment"> * @param[in] size number of bytes to be written</span>
<a name="l00103"></a>00103 <span class="comment"> * @return The number of bytes written into the descriptor&#39;s</span>
<a name="l00104"></a>00104 <span class="comment"> * stream, this value can be less than the amount</span>
<a name="l00105"></a>00105 <span class="comment"> * specified in the parameter @p size if the maximum</span>
<a name="l00106"></a>00106 <span class="comment"> * frame size is reached.</span>
<a name="l00107"></a>00107 <span class="comment"> */</span>
<a name="l00108"></a>00108 <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&amp;#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="l00109"></a>00109 <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buf,
<a name="l00110"></a>00110 <span class="keywordtype">size_t</span> size) {
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keywordflow">return</span> 0;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">/**</span>
<a name="l00116"></a>00116 <span class="comment"> * @brief Releases a transmit descriptor and starts the transmission of the</span>
<a name="l00117"></a>00117 <span class="comment"> * enqueued data as a single frame.</span>
<a name="l00118"></a>00118 <span class="comment"> *</span>
<a name="l00119"></a>00119 <span class="comment"> * @param[in] tdp pointer to a @p MACTransmitDescriptor structure</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <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...">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="l00122"></a>00122
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment">/**</span>
<a name="l00126"></a>00126 <span class="comment"> * @brief Returns a receive descriptor.</span>
<a name="l00127"></a>00127 <span class="comment"> *</span>
<a name="l00128"></a>00128 <span class="comment"> * @param[in] macp pointer to a @p MACDriver object</span>
<a name="l00129"></a>00129 <span class="comment"> * @param[out] rdp pointer to a @p MACReceiveDescriptor structure</span>
<a name="l00130"></a>00130 <span class="comment"> * @return The operation status.</span>
<a name="l00131"></a>00131 <span class="comment"> * @retval RDY_OK a descriptor was obtained.</span>
<a name="l00132"></a>00132 <span class="comment"> * @retval RDY_TIMEOUT descriptor not available.</span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134 <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="l00135"></a>00135 <a class="code" href="struct_m_a_c_receive_descriptor.html" title="Structure representing a receive descriptor.">MACReceiveDescriptor</a> *rdp) {
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keywordflow">return</span> <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>;
<a name="l00138"></a>00138 }
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment">/**</span>
<a name="l00141"></a>00141 <span class="comment"> * @brief Reads from a receive descriptor&#39;s stream.</span>
<a name="l00142"></a>00142 <span class="comment"> *</span>
<a name="l00143"></a>00143 <span class="comment"> * @param[in] rdp pointer to a @p MACReceiveDescriptor structure</span>
<a name="l00144"></a>00144 <span class="comment"> * @param[in] buf pointer to a buffer that will receive the read data</span>
<a name="l00145"></a>00145 <span class="comment"> * @param[in] size number of bytes to be read</span>
<a name="l00146"></a>00146 <span class="comment"> * @return The number of bytes read from the descriptor&#39;s stream,</span>
<a name="l00147"></a>00147 <span class="comment"> * this value can be less than the amount specified in</span>
<a name="l00148"></a>00148 <span class="comment"> * the parameter @p size if there are no more bytes to read.</span>
<a name="l00149"></a>00149 <span class="comment"> */</span>
<a name="l00150"></a>00150 <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&amp;#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="l00151"></a>00151 <a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buf,
<a name="l00152"></a>00152 <span class="keywordtype">size_t</span> size) {
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keywordflow">return</span> 0;
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment">/**</span>
<a name="l00158"></a>00158 <span class="comment"> * @brief Releases a receive descriptor.</span>
<a name="l00159"></a>00159 <span class="comment"> * @details The descriptor and its buffer are made available for more incoming</span>
<a name="l00160"></a>00160 <span class="comment"> * frames.</span>
<a name="l00161"></a>00161 <span class="comment"> *</span>
<a name="l00162"></a>00162 <span class="comment"> * @param[in] rdp pointer to a @p MACReceiveDescriptor structure</span>
<a name="l00163"></a>00163 <span class="comment"> */</span>
<a name="l00164"></a>00164 <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="l00165"></a>00165
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167 <span class="comment"></span>
<a name="l00168"></a>00168 <span class="comment">/**</span>
<a name="l00169"></a>00169 <span class="comment"> * @brief Updates and returns the link status.</span>
<a name="l00170"></a>00170 <span class="comment"> *</span>
<a name="l00171"></a>00171 <span class="comment"> * @param[in] macp pointer to a @p MACDriver object</span>
<a name="l00172"></a>00172 <span class="comment"> * @return The link status.</span>
<a name="l00173"></a>00173 <span class="comment"> * @retval TRUE if the link is active.</span>
<a name="l00174"></a>00174 <span class="comment"> * @retval FALSE if the link is down.</span>
<a name="l00175"></a>00175 <span class="comment"> */</span>
<a name="l00176"></a>00176 <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="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keywordflow">return</span> FALSE;
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180
<a name="l00181"></a>00181 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_MAC */</span>
<a name="l00182"></a>00182 <span class="comment"></span>
<a name="l00183"></a>00183 <span class="comment">/** @} */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Jul 11 13:13:01 2010 for ChibiOS/RT by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.3</small></address>
</body>
</html>
Reference in New Issue Copy Permalink