root / trunk / docs / libdragonfly / group__usb.html @ 862
History | View | Annotate | Download (11.5 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: USB Input / Output</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.5.5 -->
|
| 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>USB Input / Output</h1>Functions for USB input / output. |
| 21 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 22 |
<tr><td></td></tr> |
| 23 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 24 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g378065b4d75b008228ee41cc335474a7"></a><!-- doxytag: member="usb::USB_BAUD" ref="g378065b4d75b008228ee41cc335474a7" args="" --> |
| 25 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g378065b4d75b008228ee41cc335474a7">USB_BAUD</a> 115200</td></tr> |
| 26 |
|
| 27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">the USB baud rate <br></td></tr> |
| 28 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 29 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d">usb_init</a> (void)</td></tr> |
| 30 |
|
| 31 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the USB. <a href="#gddfbdb66f507ffcd08b4496531ed0a3d"></a><br></td></tr> |
| 32 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g3ee898cfe59d05c428c56021c2ccf946">usb_putc</a> (char c)</td></tr> |
| 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a character to USB. <a href="#g3ee898cfe59d05c428c56021c2ccf946"></a><br></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g053a5d887edfe8e8be543ec53a3f60ae">usb_getc</a> (void)</td></tr> |
| 36 |
|
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from USB. <a href="#g053a5d887edfe8e8be543ec53a3f60ae"></a><br></td></tr> |
| 38 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g6b1209b19e7fd2bbedc7407e0218453c">usb_getc_nb</a> (char *c)</td></tr> |
| 39 |
|
| 40 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from USB without blocking. <a href="#g6b1209b19e7fd2bbedc7407e0218453c"></a><br></td></tr> |
| 41 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g6e101f68856f272f67923c4fb35a99e0">usb_puts</a> (char *s)</td></tr> |
| 42 |
|
| 43 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a string to USB. <a href="#g6e101f68856f272f67923c4fb35a99e0"></a><br></td></tr> |
| 44 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gcd371dedbff10f0c52dca4b3b7af9e3d">usb_puti</a> (int value)</td></tr> |
| 45 |
|
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print an integer to USB. <a href="#gcd371dedbff10f0c52dca4b3b7af9e3d"></a><br></td></tr> |
| 47 |
</table>
|
| 48 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 49 |
Functions for USB input / output. |
| 50 |
<p>
|
| 51 |
Low level functions for USB input and output. <hr><h2>Function Documentation</h2> |
| 52 |
<a class="anchor" name="g053a5d887edfe8e8be543ec53a3f60ae"></a><!-- doxytag: member="serial.h::usb_getc" ref="g053a5d887edfe8e8be543ec53a3f60ae" args="(void)" --> |
| 53 |
<div class="memitem"> |
| 54 |
<div class="memproto"> |
| 55 |
<table class="memname"> |
| 56 |
<tr>
|
| 57 |
<td class="memname">int usb_getc </td> |
| 58 |
<td>(</td> |
| 59 |
<td class="paramtype">void </td> |
| 60 |
<td class="paramname"> </td> |
| 61 |
<td> ) </td> |
| 62 |
<td width="100%"></td> |
| 63 |
</tr>
|
| 64 |
</table>
|
| 65 |
</div>
|
| 66 |
<div class="memdoc"> |
| 67 |
|
| 68 |
<p>
|
| 69 |
Read a character from USB. |
| 70 |
<p>
|
| 71 |
Returns the first character in the buffer received from USB. This function blocks execution until a character has been received. xbee_init must be called before this function may be used.<p>
|
| 72 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the first character in the usb buffer</dd></dl> |
| 73 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d" title="Initialize the USB.">usb_init</a>, <a class="el" href="group__usb.html#g6b1209b19e7fd2bbedc7407e0218453c" title="Read a character from USB without blocking.">usb_getc_nb</a> </dd></dl> |
| 74 |
|
| 75 |
<p>Referenced by <a class="el" href="serial_8c-source.html#l00048">usb_init()</a>.</p> |
| 76 |
|
| 77 |
</div>
|
| 78 |
</div><p> |
| 79 |
<a class="anchor" name="g6b1209b19e7fd2bbedc7407e0218453c"></a><!-- doxytag: member="serial.h::usb_getc_nb" ref="g6b1209b19e7fd2bbedc7407e0218453c" args="(char *c)" --> |
| 80 |
<div class="memitem"> |
| 81 |
<div class="memproto"> |
| 82 |
<table class="memname"> |
| 83 |
<tr>
|
| 84 |
<td class="memname">int usb_getc_nb </td> |
| 85 |
<td>(</td> |
| 86 |
<td class="paramtype">char * </td> |
| 87 |
<td class="paramname"> <em>c</em> </td> |
| 88 |
<td> ) </td> |
| 89 |
<td width="100%"></td> |
| 90 |
</tr>
|
| 91 |
</table>
|
| 92 |
</div>
|
| 93 |
<div class="memdoc"> |
| 94 |
|
| 95 |
<p>
|
| 96 |
Read a character from USB without blocking. |
| 97 |
<p>
|
| 98 |
Non blocking version of usb_getc. If a character is present in the buffer, it is returned, otherwise -1 is returned immediately. usb_init must be called before this function can be used.<p>
|
| 99 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 100 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 101 |
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the received character. This will be set if a character has been received.</td></tr> |
| 102 |
</table>
|
| 103 |
</dl>
|
| 104 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if no character is available, 0 otherwise</dd></dl> |
| 105 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d" title="Initialize the USB.">usb_init</a>, <a class="el" href="group__usb.html#g053a5d887edfe8e8be543ec53a3f60ae" title="Read a character from USB.">usb_getc</a> </dd></dl> |
| 106 |
|
| 107 |
</div>
|
| 108 |
</div><p> |
| 109 |
<a class="anchor" name="gddfbdb66f507ffcd08b4496531ed0a3d"></a><!-- doxytag: member="serial.h::usb_init" ref="gddfbdb66f507ffcd08b4496531ed0a3d" args="(void)" --> |
| 110 |
<div class="memitem"> |
| 111 |
<div class="memproto"> |
| 112 |
<table class="memname"> |
| 113 |
<tr>
|
| 114 |
<td class="memname">void usb_init </td> |
| 115 |
<td>(</td> |
| 116 |
<td class="paramtype">void </td> |
| 117 |
<td class="paramname"> </td> |
| 118 |
<td> ) </td> |
| 119 |
<td width="100%"></td> |
| 120 |
</tr>
|
| 121 |
</table>
|
| 122 |
</div>
|
| 123 |
<div class="memdoc"> |
| 124 |
|
| 125 |
<p>
|
| 126 |
Initialize the USB. |
| 127 |
<p>
|
| 128 |
Initializes communication over the USB serial port. This must be called before any other usb function may be used. |
| 129 |
<p>References <a class="el" href="serial_8c-source.html#l00165">usb_getc()</a>, and <a class="el" href="serial_8c-source.html#l00117">usb_putc()</a>.</p> |
| 130 |
|
| 131 |
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00071">dragonfly_init()</a>.</p> |
| 132 |
|
| 133 |
</div>
|
| 134 |
</div><p> |
| 135 |
<a class="anchor" name="g3ee898cfe59d05c428c56021c2ccf946"></a><!-- doxytag: member="serial.h::usb_putc" ref="g3ee898cfe59d05c428c56021c2ccf946" args="(char c)" --> |
| 136 |
<div class="memitem"> |
| 137 |
<div class="memproto"> |
| 138 |
<table class="memname"> |
| 139 |
<tr>
|
| 140 |
<td class="memname">int usb_putc </td> |
| 141 |
<td>(</td> |
| 142 |
<td class="paramtype">char </td> |
| 143 |
<td class="paramname"> <em>c</em> </td> |
| 144 |
<td> ) </td> |
| 145 |
<td width="100%"></td> |
| 146 |
</tr>
|
| 147 |
</table>
|
| 148 |
</div>
|
| 149 |
<div class="memdoc"> |
| 150 |
|
| 151 |
<p>
|
| 152 |
Print a character to USB. |
| 153 |
<p>
|
| 154 |
Sends a character over USB.<p>
|
| 155 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 156 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 157 |
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the character to send </td></tr> |
| 158 |
</table>
|
| 159 |
</dl>
|
| 160 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
| 161 |
|
| 162 |
<p>Referenced by <a class="el" href="serial_8c-source.html#l00048">usb_init()</a>, <a class="el" href="serial_8c-source.html#l00256">usb_puti()</a>, and <a class="el" href="serial_8c-source.html#l00147">usb_puts()</a>.</p> |
| 163 |
|
| 164 |
</div>
|
| 165 |
</div><p> |
| 166 |
<a class="anchor" name="gcd371dedbff10f0c52dca4b3b7af9e3d"></a><!-- doxytag: member="serial.h::usb_puti" ref="gcd371dedbff10f0c52dca4b3b7af9e3d" args="(int value)" --> |
| 167 |
<div class="memitem"> |
| 168 |
<div class="memproto"> |
| 169 |
<table class="memname"> |
| 170 |
<tr>
|
| 171 |
<td class="memname">int usb_puti </td> |
| 172 |
<td>(</td> |
| 173 |
<td class="paramtype">int </td> |
| 174 |
<td class="paramname"> <em>value</em> </td> |
| 175 |
<td> ) </td> |
| 176 |
<td width="100%"></td> |
| 177 |
</tr>
|
| 178 |
</table>
|
| 179 |
</div>
|
| 180 |
<div class="memdoc"> |
| 181 |
|
| 182 |
<p>
|
| 183 |
Print an integer to USB. |
| 184 |
<p>
|
| 185 |
Prints an integer, converted to ASCII, to usb. usb_init must be called before this function can be used.<p>
|
| 186 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 187 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 188 |
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the integer to print</td></tr> |
| 189 |
</table>
|
| 190 |
</dl>
|
| 191 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful, nonzero otherwise</dd></dl> |
| 192 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d" title="Initialize the USB.">usb_init</a>, <a class="el" href="group__usb.html#g3ee898cfe59d05c428c56021c2ccf946" title="Print a character to USB.">usb_putc</a> </dd></dl> |
| 193 |
|
| 194 |
<p>References <a class="el" href="serial_8c-source.html#l00117">usb_putc()</a>.</p> |
| 195 |
|
| 196 |
</div>
|
| 197 |
</div><p> |
| 198 |
<a class="anchor" name="g6e101f68856f272f67923c4fb35a99e0"></a><!-- doxytag: member="serial.h::usb_puts" ref="g6e101f68856f272f67923c4fb35a99e0" args="(char *s)" --> |
| 199 |
<div class="memitem"> |
| 200 |
<div class="memproto"> |
| 201 |
<table class="memname"> |
| 202 |
<tr>
|
| 203 |
<td class="memname">int usb_puts </td> |
| 204 |
<td>(</td> |
| 205 |
<td class="paramtype">char * </td> |
| 206 |
<td class="paramname"> <em>s</em> </td> |
| 207 |
<td> ) </td> |
| 208 |
<td width="100%"></td> |
| 209 |
</tr>
|
| 210 |
</table>
|
| 211 |
</div>
|
| 212 |
<div class="memdoc"> |
| 213 |
|
| 214 |
<p>
|
| 215 |
Print a string to USB. |
| 216 |
<p>
|
| 217 |
Sends a sequence of characters over USB.<p>
|
| 218 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 219 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 220 |
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>the string to send </td></tr> |
| 221 |
</table>
|
| 222 |
</dl>
|
| 223 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
| 224 |
|
| 225 |
<p>References <a class="el" href="serial_8c-source.html#l00117">usb_putc()</a>.</p> |
| 226 |
|
| 227 |
</div>
|
| 228 |
</div><p> |
| 229 |
</div>
|
| 230 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by |
| 231 |
<a href="http://www.doxygen.org/index.html"> |
| 232 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
| 233 |
</body>
|
| 234 |
</html>
|