Revision 1398
recompiled libdragonfly to include new rangefinder doxygen comments
| group__usb.html | ||
|---|---|---|
| 1 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 | 3 |
<title>libdragonfly: USB Input / Output</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 4 | 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
|
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.5 -->
|
|
| 7 |
<!-- Generated by Doxygen 1.5.9 -->
|
|
| 8 | 8 |
<div class="navigation" id="top"> |
| 9 | 9 |
<div class="tabs"> |
| 10 | 10 |
<ul> |
| ... | ... | |
| 18 | 18 |
</div> |
| 19 | 19 |
<div class="contents"> |
| 20 | 20 |
<h1>USB Input / Output</h1>Functions for USB input / output. |
| 21 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
|
| 21 |
<a href="#_details">More...</a> |
|
| 22 |
<p> |
|
| 23 |
<table border="0" cellpadding="0" cellspacing="0"> |
|
| 22 | 24 |
<tr><td></td></tr> |
| 23 | 25 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 24 | 26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g378065b4d75b008228ee41cc335474a7"></a><!-- doxytag: member="usb::USB_BAUD" ref="g378065b4d75b008228ee41cc335474a7" args="" --> |
| ... | ... | |
| 71 | 73 |
<td class="paramtype">uint8_t </td> |
| 72 | 74 |
<td class="paramname"> <em>value</em> </td> |
| 73 | 75 |
<td> ) </td> |
| 74 |
<td width="100%"></td>
|
|
| 76 |
<td></td> |
|
| 75 | 77 |
</tr> |
| 76 | 78 |
</table> |
| 77 | 79 |
</div> |
| ... | ... | |
| 88 | 90 |
</dl> |
| 89 | 91 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the hexadecimal digit in ASCII code, or '?' if the input is invalid. </dd></dl> |
| 90 | 92 |
|
| 91 |
<p>Referenced by <a class="el" href="serial_8c-source.html#l00328">usb_puth16()</a>, and <a class="el" href="serial_8c-source.html#l00345">usb_puth8()</a>.</p>
|
|
| 93 |
<p>Referenced by <a class="el" href="serial_8c_source.html#l00328">usb_puth16()</a>, and <a class="el" href="serial_8c_source.html#l00345">usb_puth8()</a>.</p>
|
|
| 92 | 94 |
|
| 93 | 95 |
</div> |
| 94 | 96 |
</div><p> |
| ... | ... | |
| 102 | 104 |
<td class="paramtype">void </td> |
| 103 | 105 |
<td class="paramname"> </td> |
| 104 | 106 |
<td> ) </td> |
| 105 |
<td width="100%"></td>
|
|
| 107 |
<td></td> |
|
| 106 | 108 |
</tr> |
| 107 | 109 |
</table> |
| 108 | 110 |
</div> |
| ... | ... | |
| 115 | 117 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the first character in the usb buffer</dd></dl> |
| 116 | 118 |
<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> |
| 117 | 119 |
|
| 118 |
<p>Referenced by <a class="el" href="serial_8c-source.html#l00055">usb_init()</a>.</p>
|
|
| 120 |
<p>Referenced by <a class="el" href="serial_8c_source.html#l00055">usb_init()</a>.</p>
|
|
| 119 | 121 |
|
| 120 | 122 |
</div> |
| 121 | 123 |
</div><p> |
| ... | ... | |
| 129 | 131 |
<td class="paramtype">char * </td> |
| 130 | 132 |
<td class="paramname"> <em>c</em> </td> |
| 131 | 133 |
<td> ) </td> |
| 132 |
<td width="100%"></td>
|
|
| 134 |
<td></td> |
|
| 133 | 135 |
</tr> |
| 134 | 136 |
</table> |
| 135 | 137 |
</div> |
| ... | ... | |
| 159 | 161 |
<td class="paramtype">void </td> |
| 160 | 162 |
<td class="paramname"> </td> |
| 161 | 163 |
<td> ) </td> |
| 162 |
<td width="100%"></td>
|
|
| 164 |
<td></td> |
|
| 163 | 165 |
</tr> |
| 164 | 166 |
</table> |
| 165 | 167 |
</div> |
| ... | ... | |
| 169 | 171 |
Initialize the USB. |
| 170 | 172 |
<p> |
| 171 | 173 |
Initializes communication over the USB serial port. This must be called before any other usb function may be used. |
| 172 |
<p>References <a class="el" href="serial_8c-source.html#l00043">usb_fd</a>, <a class="el" href="serial_8c-source.html#l00188">usb_getc()</a>, and <a class="el" href="serial_8c-source.html#l00124">usb_putc()</a>.</p>
|
|
| 174 |
<p>References <a class="el" href="serial_8c_source.html#l00043">usb_fd</a>, <a class="el" href="serial_8c_source.html#l00188">usb_getc()</a>, and <a class="el" href="serial_8c_source.html#l00124">usb_putc()</a>.</p>
|
|
| 173 | 175 |
|
| 174 |
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p>
|
|
| 176 |
<p>Referenced by <a class="el" href="dragonfly__lib_8c_source.html#l00068">dragonfly_init()</a>.</p>
|
|
| 175 | 177 |
|
| 176 | 178 |
</div> |
| 177 | 179 |
</div><p> |
| ... | ... | |
| 185 | 187 |
<td class="paramtype">char </td> |
| 186 | 188 |
<td class="paramname"> <em>c</em> </td> |
| 187 | 189 |
<td> ) </td> |
| 188 |
<td width="100%"></td>
|
|
| 190 |
<td></td> |
|
| 189 | 191 |
</tr> |
| 190 | 192 |
</table> |
| 191 | 193 |
</div> |
| ... | ... | |
| 202 | 204 |
</dl> |
| 203 | 205 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
| 204 | 206 |
|
| 205 |
<p>Referenced by <a class="el" href="serial_8c-source.html#l00055">usb_init()</a>, <a class="el" href="serial_8c-source.html#l00328">usb_puth16()</a>, <a class="el" href="serial_8c-source.html#l00345">usb_puth8()</a>, <a class="el" href="serial_8c-source.html#l00279">usb_puti()</a>, <a class="el" href="serial_8c-source.html#l00154">usb_puts()</a>, and <a class="el" href="serial_8c-source.html#l00168">usb_puts_P()</a>.</p>
|
|
| 207 |
<p>Referenced by <a class="el" href="serial_8c_source.html#l00055">usb_init()</a>, <a class="el" href="serial_8c_source.html#l00328">usb_puth16()</a>, <a class="el" href="serial_8c_source.html#l00345">usb_puth8()</a>, <a class="el" href="serial_8c_source.html#l00279">usb_puti()</a>, <a class="el" href="serial_8c_source.html#l00154">usb_puts()</a>, and <a class="el" href="serial_8c_source.html#l00168">usb_puts_P()</a>.</p>
|
|
| 206 | 208 |
|
| 207 | 209 |
</div> |
| 208 | 210 |
</div><p> |
| ... | ... | |
| 216 | 218 |
<td class="paramtype">uint16_t </td> |
| 217 | 219 |
<td class="paramname"> <em>value</em> </td> |
| 218 | 220 |
<td> ) </td> |
| 219 |
<td width="100%"></td>
|
|
| 221 |
<td></td> |
|
| 220 | 222 |
</tr> |
| 221 | 223 |
</table> |
| 222 | 224 |
</div> |
| ... | ... | |
| 233 | 235 |
</dl> |
| 234 | 236 |
<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#gcd371dedbff10f0c52dca4b3b7af9e3d" title="Print an integer to USB.">usb_puti</a>, <a class="el" href="group__usb.html#g6e101f68856f272f67923c4fb35a99e0" title="Print a string to USB.">usb_puts</a>, <a class="el" href="group__usb.html#g21462df541911e0611416e85be6ea34d" title="Print a fixed width hexadecimal representation to USB.">usb_puth8</a>, <a class="el" href="group__usb.html#g94d47853c33da12c71dec155f819cfeb" title="Determine a hexadecimal digit.">hex_digit</a> </dd></dl> |
| 235 | 237 |
|
| 236 |
<p>References <a class="el" href="serial_8c-source.html#l00311">hex_digit()</a>, and <a class="el" href="serial_8c-source.html#l00124">usb_putc()</a>.</p>
|
|
| 238 |
<p>References <a class="el" href="serial_8c_source.html#l00311">hex_digit()</a>, and <a class="el" href="serial_8c_source.html#l00124">usb_putc()</a>.</p>
|
|
| 237 | 239 |
|
| 238 | 240 |
</div> |
| 239 | 241 |
</div><p> |
| ... | ... | |
| 247 | 249 |
<td class="paramtype">uint8_t </td> |
| 248 | 250 |
<td class="paramname"> <em>value</em> </td> |
| 249 | 251 |
<td> ) </td> |
| 250 |
<td width="100%"></td>
|
|
| 252 |
<td></td> |
|
| 251 | 253 |
</tr> |
| 252 | 254 |
</table> |
| 253 | 255 |
</div> |
| ... | ... | |
| 264 | 266 |
</dl> |
| 265 | 267 |
<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#gcd371dedbff10f0c52dca4b3b7af9e3d" title="Print an integer to USB.">usb_puti</a>, <a class="el" href="group__usb.html#g6e101f68856f272f67923c4fb35a99e0" title="Print a string to USB.">usb_puts</a>, <a class="el" href="group__usb.html#g8e7e31f1e45721ac032267b13d0f759b" title="Print a fixed width hexadecimal representation to USB.">usb_puth16</a>, <a class="el" href="group__usb.html#g94d47853c33da12c71dec155f819cfeb" title="Determine a hexadecimal digit.">hex_digit</a> </dd></dl> |
| 266 | 268 |
|
| 267 |
<p>References <a class="el" href="serial_8c-source.html#l00311">hex_digit()</a>, and <a class="el" href="serial_8c-source.html#l00124">usb_putc()</a>.</p>
|
|
| 269 |
<p>References <a class="el" href="serial_8c_source.html#l00311">hex_digit()</a>, and <a class="el" href="serial_8c_source.html#l00124">usb_putc()</a>.</p>
|
|
| 268 | 270 |
|
| 269 | 271 |
</div> |
| 270 | 272 |
</div><p> |
| ... | ... | |
| 278 | 280 |
<td class="paramtype">int </td> |
| 279 | 281 |
<td class="paramname"> <em>value</em> </td> |
| 280 | 282 |
<td> ) </td> |
| 281 |
<td width="100%"></td>
|
|
| 283 |
<td></td> |
|
| 282 | 284 |
</tr> |
| 283 | 285 |
</table> |
| 284 | 286 |
</div> |
| ... | ... | |
| 296 | 298 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful, nonzero otherwise</dd></dl> |
| 297 | 299 |
<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> |
| 298 | 300 |
|
| 299 |
<p>References <a class="el" href="serial_8c-source.html#l00124">usb_putc()</a>.</p>
|
|
| 301 |
<p>References <a class="el" href="serial_8c_source.html#l00124">usb_putc()</a>.</p>
|
|
| 300 | 302 |
|
| 301 | 303 |
</div> |
| 302 | 304 |
</div><p> |
| ... | ... | |
| 310 | 312 |
<td class="paramtype">char * </td> |
| 311 | 313 |
<td class="paramname"> <em>s</em> </td> |
| 312 | 314 |
<td> ) </td> |
| 313 |
<td width="100%"></td>
|
|
| 315 |
<td></td> |
|
| 314 | 316 |
</tr> |
| 315 | 317 |
</table> |
| 316 | 318 |
</div> |
| ... | ... | |
| 327 | 329 |
</dl> |
| 328 | 330 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
| 329 | 331 |
|
| 330 |
<p>References <a class="el" href="serial_8c-source.html#l00124">usb_putc()</a>.</p>
|
|
| 332 |
<p>References <a class="el" href="serial_8c_source.html#l00124">usb_putc()</a>.</p>
|
|
| 331 | 333 |
|
| 332 | 334 |
</div> |
| 333 | 335 |
</div><p> |
| ... | ... | |
| 341 | 343 |
<td class="paramtype">PGM_P </td> |
| 342 | 344 |
<td class="paramname"> <em>s</em> </td> |
| 343 | 345 |
<td> ) </td> |
| 344 |
<td width="100%"></td>
|
|
| 346 |
<td></td> |
|
| 345 | 347 |
</tr> |
| 346 | 348 |
</table> |
| 347 | 349 |
</div> |
| ... | ... | |
| 357 | 359 |
</table> |
| 358 | 360 |
</dl> |
| 359 | 361 |
|
| 360 |
<p>References <a class="el" href="serial_8c-source.html#l00124">usb_putc()</a>.</p>
|
|
| 362 |
<p>References <a class="el" href="serial_8c_source.html#l00124">usb_putc()</a>.</p>
|
|
| 361 | 363 |
|
| 362 | 364 |
</div> |
| 363 | 365 |
</div><p> |
| 364 | 366 |
</div> |
| 365 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 23:20:09 2009 for libdragonfly by
|
|
| 367 |
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 7 19:07:28 2009 for libdragonfly by
|
|
| 366 | 368 |
<a href="http://www.doxygen.org/index.html"> |
| 367 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
| 369 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
|
|
| 368 | 370 |
</body> |
| 369 | 371 |
</html> |
Also available in: Unified diff