mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
157 lines
17 KiB
HTML
157 lines
17 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.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>spi.h</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="spi_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 spi.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief SPI Driver macros and structures.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup SPI</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_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _SPI_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 <span class="comment"></span>
|
|
<a name="l00048"></a>00048 <span class="comment">/**</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * @brief Enables the mutual exclusion APIs on the SPI bus.</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> */</span>
|
|
<a name="l00051"></a>00051 <span class="preprocessor">#if !defined(SPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)</span>
|
|
<a name="l00052"></a><a class="code" href="group___s_p_i.html#ga36d1818f9631f955f7cc94629b1d5498">00052</a> <span class="preprocessor"></span><span class="preprocessor">#define SPI_USE_MUTUAL_EXCLUSION TRUE</span>
|
|
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00054"></a>00054 <span class="preprocessor"></span>
|
|
<a name="l00055"></a>00055 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00056"></a>00056 <span class="comment">/* Derived constants and error checks. */</span>
|
|
<a name="l00057"></a>00057 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00058"></a>00058
|
|
<a name="l00059"></a>00059 <span class="preprocessor">#if SPI_USE_MUTUAL_EXCLUSION && !CH_USE_MUTEXES && !CH_USE_SEMAPHORES</span>
|
|
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#error "SPI_USE_MUTUAL_EXCLUSION requires CH_USE_MUTEXES and/or CH_USE_SEMAPHORES"</span>
|
|
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00062"></a>00062 <span class="preprocessor"></span>
|
|
<a name="l00063"></a>00063 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00064"></a>00064 <span class="comment">/* Driver data structures and types. */</span>
|
|
<a name="l00065"></a>00065 <span class="comment">/*===========================================================================*/</span>
|
|
<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 Driver state machine possible states.</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> */</span>
|
|
<a name="l00070"></a><a class="code" href="group___s_p_i.html#ga2570f8c1ee9fc0dceaa8f77b999013c3">00070</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
|
|
<a name="l00071"></a><a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a1f6aeb0405018546d0679b424bfb0f50">00071</a> <a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a1f6aeb0405018546d0679b424bfb0f50" title="Not initialized.">SPI_UNINIT</a> = 0, <span class="comment">/**< @brief Not initialized. */</span>
|
|
<a name="l00072"></a><a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a22a603b07f381cba1ced3de36a0c3ce7">00072</a> <a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a22a603b07f381cba1ced3de36a0c3ce7" title="Stopped.">SPI_STOP</a> = 1, <span class="comment">/**< @brief Stopped. */</span>
|
|
<a name="l00073"></a><a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba">00073</a> <a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba" title="Ready.">SPI_READY</a> = 2, <span class="comment">/**< @brief Ready. */</span>
|
|
<a name="l00074"></a><a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f">00074</a> <a class="code" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f" title="Slave selected.">SPI_ACTIVE</a> = 3 <span class="comment">/**< @brief Slave selected. */</span>
|
|
<a name="l00075"></a>00075 } spistate_t;
|
|
<a name="l00076"></a>00076
|
|
<a name="l00077"></a>00077 <span class="preprocessor">#include "<a class="code" href="platforms_2_s_t_m32_2spi__lld_8h.html" title="STM32 SPI subsystem low level driver header.">spi_lld.h</a>"</span>
|
|
<a name="l00078"></a>00078
|
|
<a name="l00079"></a>00079 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00080"></a>00080 <span class="comment">/* Driver macros. */</span>
|
|
<a name="l00081"></a>00081 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00082"></a>00082
|
|
<a name="l00083"></a>00083 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00084"></a>00084 <span class="comment">/* External declarations. */</span>
|
|
<a name="l00085"></a>00085 <span class="comment">/*===========================================================================*/</span>
|
|
<a name="l00086"></a>00086
|
|
<a name="l00087"></a>00087 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00089"></a>00089 <span class="preprocessor">#endif</span>
|
|
<a name="l00090"></a>00090 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#ga3c484a97cdec02c5dbf46a11245e3395" title="SPI Driver initialization.">spiInit</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00091"></a>00091 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf" title="Initializes the standard part of a SPIDriver structure.">spiObjectInit</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip);
|
|
<a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#ga6752c9f736f8de774a5bef6dfe2aae2e" title="Configures and activates the SPI peripheral.">spiStart</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip, <span class="keyword">const</span> <a class="code" href="struct_s_p_i_config.html" title="Driver configuration structure.">SPIConfig</a> *config);
|
|
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#gad3a359eea03e68e95899886ae93a06e4" title="Deactivates the SPI peripheral.">spiStop</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip);
|
|
<a name="l00094"></a>00094 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#ga00809152c869db80192aa3e04266a99a" title="Asserts the slave select signal and prepares for transfers.">spiSelect</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 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#gae291c012872da9c89dec23581f701b5f" title="Deasserts the slave select signal.">spiUnselect</a>(<a class="code" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a> *spip);
|
|
<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#ga43889a7d4c473f653596f8c0acafce2a" title="Ignores data on the SPI bus.">spiIgnore</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="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#gaf1c59f3fd2f85620a5253c23d9586095" title="Exchanges data on the SPI bus.">spiExchange</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, <span class="keywordtype">void</span> *rxbuf);
|
|
<a name="l00098"></a>00098 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#ga382cfbdffd2df57cf3843d45164e8bfc" title="Sends data over the SPI bus.">spiSend</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="l00099"></a>00099 <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#gadd99ad823b391dde114f04dedafe5e80" title="Receives data from the SPI bus.">spiReceive</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="l00100"></a>00100 <span class="preprocessor">#if SPI_USE_MUTUAL_EXCLUSION</span>
|
|
<a name="l00101"></a>00101 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group___s_p_i.html#ga803cec73f6dd8d3d1f18fb6a61b8255a" title="Gains exclusive access to the SPI bus.">spiAcquireBus</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.html#ga1b04a2410ef4323ee4e37c63f320c18f" title="Releases exclusive access to the SPI bus.">spiReleaseBus</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="preprocessor">#endif </span><span class="comment">/* SPI_USE_MUTUAL_EXCLUSION */</span>
|
|
<a name="l00104"></a>00104 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00105"></a>00105 <span class="preprocessor"></span>}
|
|
<a name="l00106"></a>00106 <span class="preprocessor">#endif</span>
|
|
<a name="l00107"></a>00107 <span class="preprocessor"></span>
|
|
<a name="l00108"></a>00108 <span class="preprocessor">#endif </span><span class="comment">/* CH_HAL_USE_SPI */</span>
|
|
<a name="l00109"></a>00109
|
|
<a name="l00110"></a>00110 <span class="preprocessor">#endif </span><span class="comment">/* _SPI_H_ */</span>
|
|
<a name="l00111"></a>00111 <span class="comment"></span>
|
|
<a name="l00112"></a>00112 <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>
|