root / trunk / docs / libdragonfly / i2c_8h.html @ 87
History | View | Annotate | Download (5.19 KB)
1 | 87 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
3 | <title>libdragonfly: i2c.h File Reference</title> |
||
4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
||
5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
||
6 | </head><body> |
||
7 | <!-- Generated by Doxygen 1.4.6 -->
|
||
8 | <div class="tabs"> |
||
9 | <ul>
|
||
10 | <li><a href="index.html"><span>Main Page</span></a></li> |
||
11 | <li><a href="modules.html"><span>Modules</span></a></li> |
||
12 | <li id="current"><a href="files.html"><span>Files</span></a></li> |
||
13 | </ul></div> |
||
14 | <div class="tabs"> |
||
15 | <ul>
|
||
16 | <li><a href="files.html"><span>File List</span></a></li> |
||
17 | <li><a href="globals.html"><span>Globals</span></a></li> |
||
18 | </ul></div> |
||
19 | <h1>i2c.h File Reference</h1>Header file for I2C. <a href="#_details">More...</a> |
||
20 | <p>
|
||
21 | <code>#include <stddef.h></code><br> |
||
22 | |||
23 | <p>
|
||
24 | <a href="i2c_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
25 | <tr><td></td></tr> |
||
26 | <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> |
||
27 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1453fbad57354c82d465c704edeead5"></a><!-- doxytag: member="i2c.h::fun_srecv_t" ref="e1453fbad57354c82d465c704edeead5" args=")(char)" --> |
||
28 | typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="i2c_8h.html#e1453fbad57354c82d465c704edeead5">fun_srecv_t</a> )(char)</td></tr> |
||
29 | |||
30 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Address of slave receive handler function. <br></td></tr> |
||
31 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e550321eadebd4a697a3016e6ee918b"></a><!-- doxytag: member="i2c.h::fun_mrecv_t" ref="3e550321eadebd4a697a3016e6ee918b" args=")(char)" --> |
||
32 | typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="i2c_8h.html#3e550321eadebd4a697a3016e6ee918b">fun_mrecv_t</a> )(char)</td></tr> |
||
33 | |||
34 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Address of master receive handler function. <br></td></tr> |
||
35 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b946a38c2f1c58d838f59c6099feba1"></a><!-- doxytag: member="i2c.h::fun_send_t" ref="4b946a38c2f1c58d838f59c6099feba1" args=")(void)" --> |
||
36 | typedef char(* </td><td class="memItemRight" valign="bottom"><a class="el" href="i2c_8h.html#4b946a38c2f1c58d838f59c6099feba1">fun_send_t</a> )(void)</td></tr> |
||
37 | |||
38 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Address of slave send handler function. <br></td></tr> |
||
39 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
40 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c.html#g28bd4994859c49763a282579c4c772a1">i2c_init</a> (char addr, <a class="el" href="i2c_8h.html#3e550321eadebd4a697a3016e6ee918b">fun_mrecv_t</a> master_recv, <a class="el" href="i2c_8h.html#e1453fbad57354c82d465c704edeead5">fun_srecv_t</a> slave_recv, <a class="el" href="i2c_8h.html#4b946a38c2f1c58d838f59c6099feba1">fun_send_t</a> slave_send)</td></tr> |
||
41 | |||
42 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the i2c module. <a href="group__i2c.html#g28bd4994859c49763a282579c4c772a1"></a><br></td></tr> |
||
43 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c.html#g15f534819e0f3405c4e05769af1f1e19">i2c_send</a> (char dest, char *data, size_t bytes)</td></tr> |
||
44 | |||
45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a byte array over I2C as a master. <a href="group__i2c.html#g15f534819e0f3405c4e05769af1f1e19"></a><br></td></tr> |
||
46 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__i2c.html#gf5d4ed96f03670ca300298019b7f2f72">i2c_request</a> (char dest)</td></tr> |
||
47 | |||
48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Send a master request to the destination. <a href="group__i2c.html#gf5d4ed96f03670ca300298019b7f2f72"></a><br></td></tr> |
||
49 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bfcebf80506ab066e9865ef78a9f131c"></a><!-- doxytag: member="i2c.h::i2c_packet_rec" ref="bfcebf80506ab066e9865ef78a9f131c" args="(char i2c_byte)" --> |
||
50 | void </td><td class="memItemRight" valign="bottom"><b>i2c_packet_rec</b> (char i2c_byte)</td></tr> |
||
51 | |||
52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2df6559c9db1fe4c1424ad643b233b0d"></a><!-- doxytag: member="i2c.h::i2c_packet_sniff" ref="2df6559c9db1fe4c1424ad643b233b0d" args="(char data)" --> |
||
53 | void </td><td class="memItemRight" valign="bottom"><b>i2c_packet_sniff</b> (char data)</td></tr> |
||
54 | |||
55 | </table>
|
||
56 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
57 | Header file for I2C. |
||
58 | <p>
|
||
59 | <dl compact><dt><b>Author:</b></dt><dd>CMU Robotics Club, Kevin Woo, Suresh Nidhiry </dd></dl> |
||
60 | <hr size="1"><address style="align: right;"><small>Generated on Wed Sep 26 17:39:30 2007 for libdragonfly by |
||
61 | <a href="http://www.doxygen.org/index.html"> |
||
62 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
||
63 | </body>
|
||
64 | </html> |