gnuk/ChibiOS_2.0.6/docs/html/struct_s_p_i_driver.html

230 lines
15 KiB
HTML
Raw Normal View History

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: SPIDriver Struct 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">
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
2010-11-22 05:53:37 +00:00
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
2010-08-10 03:11:02 +00:00
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
2010-08-10 03:11:02 +00:00
<h1>SPIDriver Struct Reference<br/>
<small>
[<a class="el" href="group___s_p_i___l_l_d.html">SPI Low Level Driver</a>,&nbsp;<a class="el" href="group___l_p_c214x___s_p_i.html">LPC214x SPI Support</a>,&nbsp;<a class="el" href="group___s_t_m32___s_p_i.html">STM32 SPI Support</a>]</small>
2010-11-22 05:53:37 +00:00
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="SPIDriver" -->
2010-08-10 03:11:02 +00:00
<p>Structure representing a SPI driver.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="templates_2spi__lld_8h_source.html">spi_lld.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for SPIDriver:</div>
2010-11-22 05:53:37 +00:00
<div class="dyncontent">
2010-08-10 03:11:02 +00:00
<div class="center"><img src="struct_s_p_i_driver__coll__graph.png" border="0" usemap="#_s_p_i_driver_coll__map" alt="Collaboration graph"/></div>
<map name="_s_p_i_driver_coll__map" id="_s_p_i_driver_coll__map">
2010-11-22 05:53:37 +00:00
<area shape="rect" id="node2" href="struct_s_p_i_config.html" title="Driver configuration structure." alt="" coords="5,896,91,1032"/> <area shape="rect" id="node4" href="struct_thread.html" title="Structure representing a thread." alt="" coords="333,147,427,533"/> <area shape="rect" id="node6" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element." alt="" coords="364,739,457,831"/> <area shape="rect" id="node8" href="struct_threads_list.html" title="Generic threads single link list, it works like a stack." alt="" coords="469,597,547,675"/> <area shape="rect" id="node15" href="struct_mutex.html" title="Mutex structure." alt="" coords="228,911,305,1017"/> <area shape="rect" id="node13" href="structcontext.html" title="Platform dependent part of the Thread structure." alt="" coords="351,5,409,83"/> </map>
2010-08-10 03:11:02 +00:00
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
2010-11-22 05:53:37 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_p_i.html#ga2570f8c1ee9fc0dceaa8f77b999013c3">spistate_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a">spd_state</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Driver state. <a href="#ae6b2b959753b948d1333885c745abc2a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_mutex.html">Mutex</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#aad4a0dbb074013406c4bce20d1cb9326">spd_mutex</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="struct_mutex.html" title="Mutex structure.">Mutex</a> protecting the bus. <a href="#aad4a0dbb074013406c4bce20d1cb9326"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_s_p_i_config.html">SPIConfig</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#a5dd4d2ee17acb22bf3e14dc8fa392195">spd_config</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current configuration data. <a href="#a5dd4d2ee17acb22bf3e14dc8fa392195"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_thread.html">Thread</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#a8f42be6ee846cc356634f84fd802bf96">spd_thread</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> waiting for I/O completion. <a href="#a8f42be6ee846cc356634f84fd802bf96"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPI_TypeDef *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#ab95454f3fdda79a98d54d50dcf45bfca">spd_spi</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the SPIx registers block. <a href="#ab95454f3fdda79a98d54d50dcf45bfca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DMA_Channel_TypeDef *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#aabd55e8e6e7284bba7faff00e15f237b">spd_dmarx</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the receive DMA channel registers block. <a href="#aabd55e8e6e7284bba7faff00e15f237b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DMA_Channel_TypeDef *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#a79c2b5729c997e888a0fc3f5e9cab415">spd_dmatx</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to the transmit DMA channel registers block. <a href="#a79c2b5729c997e888a0fc3f5e9cab415"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_s_p_i_driver.html#afefc772619c483d3d27b855ce03d66f2">spd_dmaprio</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">DMA priority bit mask. <a href="#afefc772619c483d3d27b855ce03d66f2"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Structure representing a SPI driver. </p>
<p>Definition at line <a class="el" href="templates_2spi__lld_8h_source.html#l00066">66</a> of file <a class="el" href="templates_2spi__lld_8h_source.html">templates/spi_lld.h</a>.</p>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="ae6b2b959753b948d1333885c745abc2a"></a><!-- doxytag: member="SPIDriver::spd_state" ref="ae6b2b959753b948d1333885c745abc2a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___s_p_i.html#ga2570f8c1ee9fc0dceaa8f77b999013c3">spistate_t</a> <a class="el" href="struct_s_p_i_driver.html#ae6b2b959753b948d1333885c745abc2a">SPIDriver::spd_state</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Driver state. </p>
<p>Definition at line <a class="el" href="templates_2spi__lld_8h_source.html#l00070">70</a> of file <a class="el" href="templates_2spi__lld_8h_source.html">templates/spi_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___s_p_i.html#gaf1c59f3fd2f85620a5253c23d9586095">spiExchange()</a>, <a class="el" href="group___s_p_i.html#ga43889a7d4c473f653596f8c0acafce2a">spiIgnore()</a>, <a class="el" href="group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf">spiObjectInit()</a>, <a class="el" href="group___s_p_i.html#gadd99ad823b391dde114f04dedafe5e80">spiReceive()</a>, <a class="el" href="group___s_p_i.html#ga00809152c869db80192aa3e04266a99a">spiSelect()</a>, <a class="el" href="group___s_p_i.html#ga382cfbdffd2df57cf3843d45164e8bfc">spiSend()</a>, <a class="el" href="group___s_p_i.html#ga6752c9f736f8de774a5bef6dfe2aae2e">spiStart()</a>, <a class="el" href="group___s_p_i.html#gad3a359eea03e68e95899886ae93a06e4">spiStop()</a>, and <a class="el" href="group___s_p_i.html#gae291c012872da9c89dec23581f701b5f">spiUnselect()</a>.</p>
</div>
</div>
<a class="anchor" id="aad4a0dbb074013406c4bce20d1cb9326"></a><!-- doxytag: member="SPIDriver::spd_mutex" ref="aad4a0dbb074013406c4bce20d1cb9326" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_mutex.html">Mutex</a> <a class="el" href="struct_s_p_i_driver.html#aad4a0dbb074013406c4bce20d1cb9326">SPIDriver::spd_mutex</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="struct_mutex.html" title="Mutex structure.">Mutex</a> protecting the bus. </p>
<p>Definition at line <a class="el" href="templates_2spi__lld_8h_source.html#l00076">76</a> of file <a class="el" href="templates_2spi__lld_8h_source.html">templates/spi_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___s_p_i.html#ga803cec73f6dd8d3d1f18fb6a61b8255a">spiAcquireBus()</a>, and <a class="el" href="group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf">spiObjectInit()</a>.</p>
</div>
</div>
<a class="anchor" id="a5dd4d2ee17acb22bf3e14dc8fa392195"></a><!-- doxytag: member="SPIDriver::spd_config" ref="a5dd4d2ee17acb22bf3e14dc8fa392195" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_s_p_i_config.html">SPIConfig</a> * <a class="el" href="struct_s_p_i_driver.html#a5dd4d2ee17acb22bf3e14dc8fa392195">SPIDriver::spd_config</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current configuration data. </p>
<p>Definition at line <a class="el" href="templates_2spi__lld_8h_source.html#l00084">84</a> of file <a class="el" href="templates_2spi__lld_8h_source.html">templates/spi_lld.h</a>.</p>
<p>Referenced by <a class="el" href="group___s_p_i.html#ga87a7bdc554b8e8fdfc77064e67689fcf">spiObjectInit()</a>, and <a class="el" href="group___s_p_i.html#ga6752c9f736f8de774a5bef6dfe2aae2e">spiStart()</a>.</p>
</div>
</div>
<a class="anchor" id="a8f42be6ee846cc356634f84fd802bf96"></a><!-- doxytag: member="SPIDriver::spd_thread" ref="a8f42be6ee846cc356634f84fd802bf96" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_thread.html">Thread</a>* <a class="el" href="struct_s_p_i_driver.html#a8f42be6ee846cc356634f84fd802bf96">SPIDriver::spd_thread</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="struct_thread.html" title="Structure representing a thread.">Thread</a> waiting for I/O completion. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html#l00170">170</a> of file <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html">platforms/STM32/spi_lld.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab95454f3fdda79a98d54d50dcf45bfca"></a><!-- doxytag: member="SPIDriver::spd_spi" ref="ab95454f3fdda79a98d54d50dcf45bfca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPI_TypeDef* <a class="el" href="struct_s_p_i_driver.html#ab95454f3fdda79a98d54d50dcf45bfca">SPIDriver::spd_spi</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the SPIx registers block. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html#l00174">174</a> of file <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html">platforms/STM32/spi_lld.h</a>.</p>
</div>
</div>
<a class="anchor" id="aabd55e8e6e7284bba7faff00e15f237b"></a><!-- doxytag: member="SPIDriver::spd_dmarx" ref="aabd55e8e6e7284bba7faff00e15f237b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DMA_Channel_TypeDef* <a class="el" href="struct_s_p_i_driver.html#aabd55e8e6e7284bba7faff00e15f237b">SPIDriver::spd_dmarx</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the receive DMA channel registers block. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html#l00178">178</a> of file <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html">platforms/STM32/spi_lld.h</a>.</p>
</div>
</div>
<a class="anchor" id="a79c2b5729c997e888a0fc3f5e9cab415"></a><!-- doxytag: member="SPIDriver::spd_dmatx" ref="a79c2b5729c997e888a0fc3f5e9cab415" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DMA_Channel_TypeDef* <a class="el" href="struct_s_p_i_driver.html#a79c2b5729c997e888a0fc3f5e9cab415">SPIDriver::spd_dmatx</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the transmit DMA channel registers block. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html#l00182">182</a> of file <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html">platforms/STM32/spi_lld.h</a>.</p>
</div>
</div>
<a class="anchor" id="afefc772619c483d3d27b855ce03d66f2"></a><!-- doxytag: member="SPIDriver::spd_dmaprio" ref="afefc772619c483d3d27b855ce03d66f2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="el" href="struct_s_p_i_driver.html#afefc772619c483d3d27b855ce03d66f2">SPIDriver::spd_dmaprio</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>DMA priority bit mask. </p>
<p>Definition at line <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html#l00186">186</a> of file <a class="el" href="platforms_2_s_t_m32_2spi__lld_8h_source.html">platforms/STM32/spi_lld.h</a>.</p>
</div>
</div>
</div>
<hr size="1"><address style="text-align: right;"><small>
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:49 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>
2010-08-10 03:11:02 +00:00
</body>
</html>