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
27543cfeca
gnuk/ChibiOS_2.0.6/docs/html/templates_2spi__lld_8c_source.html
NIIBE Yutaka 2c672210ff Imported ChibiOS/RT 2.0.6.
2010-11-22 14:53:37 +09:00

210 lines
18 KiB
HTML
Raw Blame History

<!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: spi_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.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>spi_lld.c</h1> </div>
</div>
<div class="contents">
<a href="templates_2spi__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/spi_lld.c</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief SPI 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 SPI_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_SPI || 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 SPI driver 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___s_p_i___l_l_d.html#ga5bdaf423b4fa6a78a1689b5a7721ea7e" title="Low level SPI driver initialization.">spi_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 Configures and activates the SPI peripheral.</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00071"></a>00071 <span class="comment"> */</span>
<a name="l00072"></a>00072 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#gaf35495bd4459608ae22a3f728fd4697b" title="Configures and activates the SPI peripheral.">spi_lld_start</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip) {
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keywordflow">if</span> (spip-&gt;<a class="code" href="struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a" title="Driver state.">spd_state</a> == <a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a22a603b07f381cba1ced3de36a0c3ce7" title="Stopped.">SPI_STOP</a>) {
<a name="l00075"></a>00075 <span class="comment">/* Clock activation.*/</span>
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 <span class="comment">/* Configuration.*/</span>
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">/**</span>
<a name="l00081"></a>00081 <span class="comment"> * @brief Deactivates the SPI peripheral.</span>
<a name="l00082"></a>00082 <span class="comment"> *</span>
<a name="l00083"></a>00083 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#ga8d6b2e0764d39b892b51e6abe4923f80" title="Deactivates the SPI peripheral.">spi_lld_stop</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip) {
<a name="l00086"></a>00086
<a name="l00087"></a>00087 }
<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 Asserts the slave select signal and prepares for transfers.</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#ga5a671d4e8d120120a26d9bfb0c016507" title="Asserts the slave select signal and prepares for transfers.">spi_lld_select</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip) {
<a name="l00095"></a>00095
<a name="l00096"></a>00096 }
<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 Deasserts the slave select signal.</span>
<a name="l00100"></a>00100 <span class="comment"> * @details The previously selected peripheral is unselected.</span>
<a name="l00101"></a>00101 <span class="comment"> *</span>
<a name="l00102"></a>00102 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#gafa343fd905298991aa4005015263bcd2" title="Deasserts the slave select signal.">spi_lld_unselect</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip) {
<a name="l00105"></a>00105
<a name="l00106"></a>00106 }
<a name="l00107"></a>00107 <span class="comment"></span>
<a name="l00108"></a>00108 <span class="comment">/**</span>
<a name="l00109"></a>00109 <span class="comment"> * @brief Ignores data on the SPI bus.</span>
<a name="l00110"></a>00110 <span class="comment"> * @details This function transmits a series of idle words on the SPI bus and</span>
<a name="l00111"></a>00111 <span class="comment"> * ignores the received data. This function can be invoked even</span>
<a name="l00112"></a>00112 <span class="comment"> * when a slave select signal has not been yet asserted.</span>
<a name="l00113"></a>00113 <span class="comment"> *</span>
<a name="l00114"></a>00114 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00115"></a>00115 <span class="comment"> * @param[in] n number of words to be ignored</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#ga076fdc5d74009a7917723b663984d502" title="Ignores data on the SPI bus.">spi_lld_ignore</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip, <span class="keywordtype">size_t</span> n) {
<a name="l00118"></a>00118
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment">/**</span>
<a name="l00122"></a>00122 <span class="comment"> * @brief Exchanges data on the SPI bus.</span>
<a name="l00123"></a>00123 <span class="comment"> * @details This function performs a simultaneous transmit/receive operation.</span>
<a name="l00124"></a>00124 <span class="comment"> * @note The buffers are organized as uint8_t arrays for data sizes below or</span>
<a name="l00125"></a>00125 <span class="comment"> * equal to 8 bits else it is organized as uint16_t arrays.</span>
<a name="l00126"></a>00126 <span class="comment"> *</span>
<a name="l00127"></a>00127 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00128"></a>00128 <span class="comment"> * @param[in] n number of words to be exchanged</span>
<a name="l00129"></a>00129 <span class="comment"> * @param[in] txbuf the pointer to the transmit buffer</span>
<a name="l00130"></a>00130 <span class="comment"> * @param[out] rxbuf the pointer to the receive buffer</span>
<a name="l00131"></a>00131 <span class="comment"> */</span>
<a name="l00132"></a>00132 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#ga61b61b0999c813c1d8a3ddc415e8b0c7" title="Exchanges data on the SPI bus.">spi_lld_exchange</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip, <span class="keywordtype">size_t</span> n,
<a name="l00133"></a>00133 <span class="keyword">const</span> <span class="keywordtype">void</span> *txbuf, <span class="keywordtype">void</span> *rxbuf) {
<a name="l00134"></a>00134
<a name="l00135"></a>00135 }
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment">/**</span>
<a name="l00138"></a>00138 <span class="comment"> * @brief Sends data ever the SPI bus.</span>
<a name="l00139"></a>00139 <span class="comment"> * @note The buffers are organized as uint8_t arrays for data sizes below or</span>
<a name="l00140"></a>00140 <span class="comment"> * equal to 8 bits else it is organized as uint16_t arrays.</span>
<a name="l00141"></a>00141 <span class="comment"> *</span>
<a name="l00142"></a>00142 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00143"></a>00143 <span class="comment"> * @param[in] n number of words to send</span>
<a name="l00144"></a>00144 <span class="comment"> * @param[in] txbuf the pointer to the transmit buffer</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#gaa460d53de2de1c3bac67f95fe04da0fe" title="Sends data ever the SPI bus.">spi_lld_send</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip, <span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">void</span> *txbuf) {
<a name="l00147"></a>00147
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">/**</span>
<a name="l00151"></a>00151 <span class="comment"> * @brief Receives data from the SPI bus.</span>
<a name="l00152"></a>00152 <span class="comment"> * @note The buffers are organized as uint8_t arrays for data sizes below or</span>
<a name="l00153"></a>00153 <span class="comment"> * equal to 8 bits else it is organized as uint16_t arrays.</span>
<a name="l00154"></a>00154 <span class="comment"> *</span>
<a name="l00155"></a>00155 <span class="comment"> * @param[in] spip pointer to the @p SPIDriver object</span>
<a name="l00156"></a>00156 <span class="comment"> * @param[in] n number of words to receive</span>
<a name="l00157"></a>00157 <span class="comment"> * @param[out] rxbuf the pointer to the receive buffer</span>
<a name="l00158"></a>00158 <span class="comment"> */</span>
<a name="l00159"></a>00159 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i___l_l_d.html#ga5b608b91dcec69818b2b3977a0d98bcb" title="Receives data from the SPI bus.">spi_lld_receive</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip, <span class="keywordtype">size_t</span> n, <span class="keywordtype">void</span> *rxbuf) {
<a name="l00160"></a>00160
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_SPI */</span>
<a name="l00164"></a>00164 <span class="comment"></span>
<a name="l00165"></a>00165 <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&nbsp;<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>
Reference in New Issue View Git Blame Copy Permalink