mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
156 lines
15 KiB
HTML
156 lines
15 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: spi_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.6.3 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<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="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>spi_lld.h</h1><a href="templates_2spi__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/spi_lld.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief SPI 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 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">#ifndef _SPI_LLD_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _SPI_LLD_H_</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
|
<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 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
|
|
<a name="l00048"></a>00048 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00049"></a>00049 <span class="comment">/* Derived constants and error checks. */</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 data structures and types. */</span>
|
|
<a name="l00054"></a>00054 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00055"></a>00055 <span class="comment"></span>
|
|
<a name="l00056"></a>00056 <span class="comment">/**</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> * @brief Driver configuration structure.</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> */</span>
|
|
<a name="l00059"></a><a class="code" href="struct_s_p_i_config.html">00059</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00060"></a>00060
|
|
<a name="l00061"></a>00061 } <a class="code" href="struct_s_p_i_config.html" title="Driver configuration structure.">SPIConfig</a>;
|
|
<a name="l00062"></a>00062 <span class="comment"></span>
|
|
<a name="l00063"></a>00063 <span class="comment">/**</span>
|
|
<a name="l00064"></a>00064 <span class="comment"> * @brief Structure representing a SPI driver.</span>
|
|
<a name="l00065"></a>00065 <span class="comment"> */</span>
|
|
<a name="l00066"></a><a class="code" href="struct_s_p_i_driver.html">00066</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{<span class="comment"></span>
|
|
<a name="l00067"></a>00067 <span class="comment"> /**</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * @brief Driver state.</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> */</span>
|
|
<a name="l00070"></a><a class="code" href="struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a">00070</a> <a class="code" href="group___s_p_i.html#ga2570f8c1ee9fc0dceaa8f77b999013c3" title="Driver state machine possible states.">spistate_t</a> spd_state;
|
|
<a name="l00071"></a>00071 <span class="preprocessor">#if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)</span>
|
|
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#if CH_USE_MUTEXES || defined(__DOXYGEN__)</span>
|
|
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="comment"> /**</span>
|
|
<a name="l00074"></a>00074 <span class="comment"> * @brief Mutex protecting the bus.</span>
|
|
<a name="l00075"></a>00075 <span class="comment"> */</span>
|
|
<a name="l00076"></a><a class="code" href="struct_s_p_i_driver.html#aad4a0dbb074013406c4bce20d1cb9326">00076</a> <a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> spd_mutex;
|
|
<a name="l00077"></a>00077 <span class="preprocessor">#elif CH_USE_SEMAPHORES</span>
|
|
<a name="l00078"></a>00078 <span class="preprocessor"></span> <a class="code" href="struct_semaphore.html" title="Semaphore structure.">Semaphore</a> spd_semaphore;
|
|
<a name="l00079"></a>00079 <span class="preprocessor">#endif</span>
|
|
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* SPI_USE_MUTUAL_EXCLUSION */</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> /**</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> * @brief Current configuration data.</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> */</span>
|
|
<a name="l00084"></a><a class="code" href="struct_s_p_i_driver.html#a5dd4d2ee17acb22bf3e14dc8fa392195">00084</a> <span class="keyword">const</span> <a class="code" href="struct_s_p_i_config.html" title="Driver configuration structure.">SPIConfig</a> *spd_config;
|
|
<a name="l00085"></a>00085 <span class="comment">/* End of the mandatory fields.*/</span>
|
|
<a name="l00086"></a>00086 } <a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a>;
|
|
<a name="l00087"></a>00087
|
|
<a name="l00088"></a>00088 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00089"></a>00089 <span class="comment">/* Driver macros. */</span>
|
|
<a name="l00090"></a>00090 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00091"></a>00091
|
|
<a name="l00092"></a>00092 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00093"></a>00093 <span class="comment">/* External declarations. */</span>
|
|
<a name="l00094"></a>00094 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00095"></a>00095
|
|
<a name="l00096"></a>00096 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00098"></a>00098 <span class="preprocessor">#endif</span>
|
|
<a name="l00099"></a>00099 <span class="preprocessor"></span> <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="l00100"></a>00100 <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="l00101"></a>00101 <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="l00102"></a>00102 <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="l00103"></a>00103 <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="l00104"></a>00104 <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="l00105"></a>00105 <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="l00106"></a>00106 <span class="keyword">const</span> <span class="keywordtype">void</span> *txbuf, <span class="keywordtype">void</span> *rxbuf);
|
|
<a name="l00107"></a>00107 <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="l00108"></a>00108 <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="l00109"></a>00109 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00110"></a>00110 <span class="preprocessor"></span>}
|
|
<a name="l00111"></a>00111 <span class="preprocessor">#endif</span>
|
|
<a name="l00112"></a>00112 <span class="preprocessor"></span>
|
|
<a name="l00113"></a>00113 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_SPI */</span>
|
|
<a name="l00114"></a>00114
|
|
<a name="l00115"></a>00115 <span class="preprocessor">#endif </span><span class="comment">/* _SPI_LLD_H_ */</span>
|
|
<a name="l00116"></a>00116 <span class="comment"></span>
|
|
<a name="l00117"></a>00117 <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 <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>
|