mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
85 lines
8.3 KiB
HTML
85 lines
8.3 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 File Reference</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>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>spi.h File Reference</h1>
|
|
<p>SPI Driver macros and structures.
|
|
<a href="#_details">More...</a></p>
|
|
<code>#include "<a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html">spi_lld.h</a>"</code><br/>
|
|
|
|
<p><a href="spi_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga36d1818f9631f955f7cc94629b1d5498">SPI_USE_MUTUAL_EXCLUSION</a> TRUE</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enables the mutual exclusion APIs on the SPI bus. <a href="group___s_p_i.html#ga36d1818f9631f955f7cc94629b1d5498"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga2570f8c1ee9fc0dceaa8f77b999013c3">spistate_t</a> { <a class="el" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a1f6aeb0405018546d0679b424bfb0f50">SPI_UNINIT</a> = 0,
|
|
<a class="el" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a22a603b07f381cba1ced3de36a0c3ce7">SPI_STOP</a> = 1,
|
|
<a class="el" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a2894d6080831bc10e8c6f7c33c60c4ba">SPI_READY</a> = 2,
|
|
<a class="el" href="group___s_p_i.html#gga2570f8c1ee9fc0dceaa8f77b999013c3a11bc2d5065a95dc8d721e2070708ba5f">SPI_ACTIVE</a> = 3
|
|
}</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Driver state machine possible states. </p>
|
|
<a href="group___s_p_i.html#ga2570f8c1ee9fc0dceaa8f77b999013c3">More...</a><br/></td></tr>
|
|
<tr><td colspan="2"><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga3c484a97cdec02c5dbf46a11245e3395">spiInit</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">SPI Driver initialization. <a href="group___s_p_i.html#ga3c484a97cdec02c5dbf46a11245e3395"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf">spiObjectInit</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the standard part of a <code><a class="el" href="struct_s_p_i_driver.html" title="Structure representing a SPI driver.">SPIDriver</a></code> structure. <a href="group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga6752c9f736f8de774a5bef6dfe2aae2e">spiStart</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip, const <a class="el" href="struct_s_p_i_config.html">SPIConfig</a> *config)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configures and activates the SPI peripheral. <a href="group___s_p_i.html#ga6752c9f736f8de774a5bef6dfe2aae2e"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#gad3a359eea03e68e95899886ae93a06e4">spiStop</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deactivates the SPI peripheral. <a href="group___s_p_i.html#gad3a359eea03e68e95899886ae93a06e4"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga00809152c869db80192aa3e04266a99a">spiSelect</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Asserts the slave select signal and prepares for transfers. <a href="group___s_p_i.html#ga00809152c869db80192aa3e04266a99a"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#gae291c012872da9c89dec23581f701b5f">spiUnselect</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deasserts the slave select signal. <a href="group___s_p_i.html#gae291c012872da9c89dec23581f701b5f"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga43889a7d4c473f653596f8c0acafce2a">spiIgnore</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip, size_t n)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ignores data on the SPI bus. <a href="group___s_p_i.html#ga43889a7d4c473f653596f8c0acafce2a"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#gaf1c59f3fd2f85620a5253c23d9586095">spiExchange</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip, size_t n, const void *txbuf, void *rxbuf)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exchanges data on the SPI bus. <a href="group___s_p_i.html#gaf1c59f3fd2f85620a5253c23d9586095"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#ga382cfbdffd2df57cf3843d45164e8bfc">spiSend</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip, size_t n, const void *txbuf)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends data ever the SPI bus. <a href="group___s_p_i.html#ga382cfbdffd2df57cf3843d45164e8bfc"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_p_i.html#gadd99ad823b391dde114f04dedafe5e80">spiReceive</a> (<a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip, size_t n, void *rxbuf)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receives data from the SPI bus. <a href="group___s_p_i.html#gadd99ad823b391dde114f04dedafe5e80"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>SPI Driver macros and structures. </p>
|
|
|
|
<p>Definition in file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Jul 11 13:13:03 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>
|