root / trunk / docs / libdragonfly / group__spi.html @ 1398
History | View | Annotate | Download (8.25 KB)
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 |
<title>libdragonfly: Spi</title> |
4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.5.9 -->
|
8 |
<div class="navigation" id="top"> |
9 |
<div class="tabs"> |
10 |
<ul>
|
11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
12 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
15 |
<li><a href="files.html"><span>Files</span></a></li> |
16 |
</ul>
|
17 |
</div>
|
18 |
</div>
|
19 |
<div class="contents"> |
20 |
<h1>Spi</h1><table border="0" cellpadding="0" cellspacing="0"> |
21 |
<tr><td></td></tr> |
22 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
23 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9ec59021db2f662198a0d215153a8006"></a><!-- doxytag: member="spi::DOUBLE_SCK" ref="g9ec59021db2f662198a0d215153a8006" args="" --> |
24 |
#define </td><td class="memItemRight" valign="bottom"><b>DOUBLE_SCK</b> 1</td></tr> |
25 |
|
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6ac0756a27d9e5e85f078f63d69a8809"></a><!-- doxytag: member="spi::SPR0_BIT" ref="g6ac0756a27d9e5e85f078f63d69a8809" args="" --> |
27 |
#define </td><td class="memItemRight" valign="bottom"><b>SPR0_BIT</b> 1</td></tr> |
28 |
|
29 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3fa2d3bf1901157f734a584d47b25d8b"></a><!-- doxytag: member="spi::MASTER" ref="g3fa2d3bf1901157f734a584d47b25d8b" args="" --> |
30 |
#define </td><td class="memItemRight" valign="bottom"><b>MASTER</b> 1</td></tr> |
31 |
|
32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge342da5a4630c191c1c983958808edd8"></a><!-- doxytag: member="spi::SLAVE" ref="ge342da5a4630c191c1c983958808edd8" args="" --> |
33 |
#define </td><td class="memItemRight" valign="bottom"><b>SLAVE</b> 0</td></tr> |
34 |
|
35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5d3f11f2fdf8a7e27b975291e0c2c8cc"></a><!-- doxytag: member="spi::MOSI" ref="g5d3f11f2fdf8a7e27b975291e0c2c8cc" args="" --> |
36 |
#define </td><td class="memItemRight" valign="bottom"><b>MOSI</b> _BV(PB2)</td></tr> |
37 |
|
38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7334c540878c8c4d801fd75ed9fd8063"></a><!-- doxytag: member="spi::MISO" ref="g7334c540878c8c4d801fd75ed9fd8063" args="" --> |
39 |
#define </td><td class="memItemRight" valign="bottom"><b>MISO</b> _BV(PB3)</td></tr> |
40 |
|
41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g88f7782e210e61586baf33b93240d905"></a><!-- doxytag: member="spi::SS" ref="g88f7782e210e61586baf33b93240d905" args="" --> |
42 |
#define </td><td class="memItemRight" valign="bottom"><b>SS</b> _BV(PB0)</td></tr> |
43 |
|
44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1b39f68c76d4942d903c0a16f1882728"></a><!-- doxytag: member="spi::SCLK" ref="g1b39f68c76d4942d903c0a16f1882728" args="" --> |
45 |
#define </td><td class="memItemRight" valign="bottom"><b>SCLK</b> _BV(PB1)</td></tr> |
46 |
|
47 |
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> |
48 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g20347e3e581f26a4aa299405a1f3995b"></a><!-- doxytag: member="spi::spi_fun_recv_t" ref="g20347e3e581f26a4aa299405a1f3995b" args=")(char)" --> |
49 |
typedef void(* </td><td class="memItemRight" valign="bottom"><b>spi_fun_recv_t</b> )(char)</td></tr> |
50 |
|
51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g601ffbbc8c0fa67bfdd097d9ccc7bfa3"></a><!-- doxytag: member="spi::spi_fun_recv_complete_t" ref="g601ffbbc8c0fa67bfdd097d9ccc7bfa3" args=")(void)" --> |
52 |
typedef void(* </td><td class="memItemRight" valign="bottom"><b>spi_fun_recv_complete_t</b> )(void)</td></tr> |
53 |
|
54 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#g3c6e10adc9421c1f15c8abd2a41867bf">spi_init</a> (spi_fun_recv_t, spi_fun_recv_complete_t)</td></tr> |
56 |
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize SPI. <a href="#g3c6e10adc9421c1f15c8abd2a41867bf"></a><br></td></tr> |
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#g2c2ccf462042c16ecfee9b57c4438d54">spi_transfer</a> (char)</td></tr> |
59 |
|
60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize SPI transfer. <a href="#g2c2ccf462042c16ecfee9b57c4438d54"></a><br></td></tr> |
61 |
</table>
|
62 |
<hr><h2>Function Documentation</h2> |
63 |
<a class="anchor" name="g3c6e10adc9421c1f15c8abd2a41867bf"></a><!-- doxytag: member="spi.h::spi_init" ref="g3c6e10adc9421c1f15c8abd2a41867bf" args="(spi_fun_recv_t, spi_fun_recv_complete_t)" --> |
64 |
<div class="memitem"> |
65 |
<div class="memproto"> |
66 |
<table class="memname"> |
67 |
<tr>
|
68 |
<td class="memname">void spi_init </td> |
69 |
<td>(</td> |
70 |
<td class="paramtype">spi_fun_recv_t </td> |
71 |
<td class="paramname"> <em>recv_func</em>, </td> |
72 |
</tr>
|
73 |
<tr>
|
74 |
<td class="paramkey"></td> |
75 |
<td></td> |
76 |
<td class="paramtype">spi_fun_recv_complete_t </td> |
77 |
<td class="paramname"> <em>recv_complete_func</em></td><td> </td> |
78 |
</tr>
|
79 |
<tr>
|
80 |
<td></td> |
81 |
<td>)</td> |
82 |
<td></td><td></td><td></td> |
83 |
</tr>
|
84 |
</table>
|
85 |
</div>
|
86 |
<div class="memdoc"> |
87 |
|
88 |
<p>
|
89 |
Initialize SPI. |
90 |
<p>
|
91 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
92 |
<table border="0" cellspacing="2" cellpadding="0"> |
93 |
<tr><td valign="top"></td><td valign="top"><em>spi_fun_recv_t</em> </td><td>The function that handles SPI data, byte for byte. </td></tr> |
94 |
<tr><td valign="top"></td><td valign="top"><em>spi_fun_recv_complete_t</em> </td><td>Called on a completed transmission - typically for cleaning up.</td></tr> |
95 |
</table>
|
96 |
</dl>
|
97 |
Initialize SPI.<p>
|
98 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
99 |
<table border="0" cellspacing="2" cellpadding="0"> |
100 |
<tr><td valign="top"></td><td valign="top"><em>recv_func</em> </td><td>The function to be called for each byte of data received. </td></tr> |
101 |
<tr><td valign="top"></td><td valign="top"><em>recv_complete_func</em> </td><td>The function to be called at the end of a complete transmission. </td></tr> |
102 |
</table>
|
103 |
</dl>
|
104 |
|
105 |
<p>Referenced by <a class="el" href="encoders_8c_source.html#l00048">encoders_init()</a>.</p> |
106 |
|
107 |
</div>
|
108 |
</div><p> |
109 |
<a class="anchor" name="g2c2ccf462042c16ecfee9b57c4438d54"></a><!-- doxytag: member="spi.h::spi_transfer" ref="g2c2ccf462042c16ecfee9b57c4438d54" args="(char)" --> |
110 |
<div class="memitem"> |
111 |
<div class="memproto"> |
112 |
<table class="memname"> |
113 |
<tr>
|
114 |
<td class="memname">void spi_transfer </td> |
115 |
<td>(</td> |
116 |
<td class="paramtype">char </td> |
117 |
<td class="paramname"> <em>bytes</em> </td> |
118 |
<td> ) </td> |
119 |
<td></td> |
120 |
</tr>
|
121 |
</table>
|
122 |
</div>
|
123 |
<div class="memdoc"> |
124 |
|
125 |
<p>
|
126 |
Initialize SPI transfer. |
127 |
<p>
|
128 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
129 |
<table border="0" cellspacing="2" cellpadding="0"> |
130 |
<tr><td valign="top"></td><td valign="top"><em>char</em> </td><td>The number of bytes to transfer.</td></tr> |
131 |
</table>
|
132 |
</dl>
|
133 |
Initialize SPI transfer.<p>
|
134 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
135 |
<table border="0" cellspacing="2" cellpadding="0"> |
136 |
<tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>The number of bytes to be transferred. </td></tr> |
137 |
</table>
|
138 |
</dl>
|
139 |
|
140 |
<p>Referenced by <a class="el" href="encoders_8c_source.html#l00048">encoders_init()</a>.</p> |
141 |
|
142 |
</div>
|
143 |
</div><p> |
144 |
</div>
|
145 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by |
146 |
<a href="http://www.doxygen.org/index.html"> |
147 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
148 |
</body>
|
149 |
</html>
|