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