Project

General

Profile

Revision 1145

Added by Martin Herrmann about 15 years ago

Generated documentation for new orbs code

View differences:

group__usb.html
4 4 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.3 -->
8 
<div class="tabs">
9 
  <ul>
10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 
    <li><a href="files.html"><span>Files</span></a></li>
14 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 
  </ul>
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&nbsp;Page</span></a></li>
12 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13 
      <li><a href="modules.html"><span>Modules</span></a></li>
14 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15 
      <li><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
16 18 
</div>
19 
<div class="contents">
17 20 
<h1>USB Input / Output</h1>Functions for USB input / output.
18 21 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
19 22 
<tr><td></td></tr>
......
41 44 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gcd371dedbff10f0c52dca4b3b7af9e3d">usb_puti</a> (int value)</td></tr>
42 45 

  		




  43
  46
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print an integer to USB.  <a href="#gcd371dedbff10f0c52dca4b3b7af9e3d"></a><br></td></tr>


  		




  
  47
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g94d47853c33da12c71dec155f819cfeb">hex_digit</a> (uint8_t value)</td></tr>


  		




  
  48
  
    

  		




  
  49
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determine a hexadecimal digit.  <a href="#g94d47853c33da12c71dec155f819cfeb"></a><br></td></tr>


  		




  
  50
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g8e7e31f1e45721ac032267b13d0f759b">usb_puth16</a> (uint16_t value)</td></tr>


  		




  
  51
  
    

  		




  
  52
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a fixed width hexadecimal representation to USB.  <a href="#g8e7e31f1e45721ac032267b13d0f759b"></a><br></td></tr>


  		




  
  53
  
    
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g21462df541911e0611416e85be6ea34d">usb_puth8</a> (uint8_t value)</td></tr>


  		




  
  54
  
    

  		




  
  55
  
    
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a fixed width hexadecimal representation to USB.  <a href="#g21462df541911e0611416e85be6ea34d"></a><br></td></tr>


  		




  44
  56
  
    
</table>


  		




  45
  57
  
    
<hr><a name="_details"></a><h2>Detailed Description</h2>


  		




  46
  58
  
    
Functions for USB input / output. 


  		




  47
  59
  
    
<p>


  		




  48
  60
  
    
Low level functions for USB input and output. <hr><h2>Function Documentation</h2>


  		




  
  61
  
    
<a class="anchor" name="g94d47853c33da12c71dec155f819cfeb"></a><!-- doxytag: member="serial.h::hex_digit" ref="g94d47853c33da12c71dec155f819cfeb" args="(uint8_t value)" -->


  		




  
  62
  
    
<div class="memitem">


  		




  
  63
  
    
<div class="memproto">


  		




  
  64
  
    
      <table class="memname">


  		




  
  65
  
    
        <tr>


  		




  
  66
  
    
          <td class="memname">uint8_t hex_digit           </td>


  		




  
  67
  
    
          <td>(</td>


  		




  
  68
  
    
          <td class="paramtype">uint8_t&nbsp;</td>


  		




  
  69
  
    
          <td class="paramname"> <em>value</em>          </td>


  		




  
  70
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  
  71
  
    
          <td width="100%"></td>


  		




  
  72
  
    
        </tr>


  		




  
  73
  
    
      </table>


  		




  
  74
  
    
</div>


  		




  
  75
  
    
<div class="memdoc">


  		




  
  76
  
    

  		




  
  77
  
    
<p>


  		




  
  78
  
    
Determine a hexadecimal digit. 


  		




  
  79
  
    
<p>


  		




  
  80
  
    
Determines a hexadecimal digit in ASCII code.<p>


  		




  
  81
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  
  82
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  
  83
  
    
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>the value of the digit (0&lt;=value&lt;=15)</td></tr>


  		




  
  84
  
    
  </table>


  		




  
  85
  
    
</dl>


  		




  
  86
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the hexadecimal digit in ASCII code, or '?' if the input is invalid. </dd></dl>


  		




  
  87
  
    

  		




  
  88
  
    
<p>Referenced by <a class="el" href="serial_8c-source.html#l00305">usb_puth16()</a>, and <a class="el" href="serial_8c-source.html#l00323">usb_puth8()</a>.</p>


  		




  
  89
  
    

  		




  
  90
  
    
</div>


  		




  
  91
  
    
</div><p>


  		




  49
  92
  
    
<a class="anchor" name="g053a5d887edfe8e8be543ec53a3f60ae"></a><!-- doxytag: member="serial.h::usb_getc" ref="g053a5d887edfe8e8be543ec53a3f60ae" args="(void)" -->


  		




  50
  93
  
    
<div class="memitem">


  		




  51
  94
  
    
<div class="memproto">


  		




  ......




  69
  112
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the first character in the usb buffer</dd></dl>


  		




  70
  113
  
    
<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>


  		




  71
  114
  
    

  		




  
  115
  
    
<p>Referenced by <a class="el" href="serial_8c-source.html#l00048">usb_init()</a>.</p>


  		




  
  116
  
    

  		




  72
  117
  
    
</div>


  		




  73
  118
  
    
</div><p>


  		




  74
  119
  
    
<a class="anchor" name="g6b1209b19e7fd2bbedc7407e0218453c"></a><!-- doxytag: member="serial.h::usb_getc_nb" ref="g6b1209b19e7fd2bbedc7407e0218453c" args="(char *c)" -->


  		




  ......




  121
  166
  
    
Initialize the USB. 


  		




  122
  167
  
    
<p>


  		




  123
  168
  
    
Initializes communication over the USB serial port. This must be called before any other usb function may be used. 


  		




  
  169
  
    
<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>


  		




  
  170
  
    

  		




  
  171
  
    
<p>Referenced by <a class="el" href="dragonfly__lib_8c-source.html#l00068">dragonfly_init()</a>.</p>


  		




  
  172
  
    

  		




  124
  173
  
    
</div>


  		




  125
  174
  
    
</div><p>


  		




  126
  175
  
    
<a class="anchor" name="g3ee898cfe59d05c428c56021c2ccf946"></a><!-- doxytag: member="serial.h::usb_putc" ref="g3ee898cfe59d05c428c56021c2ccf946" args="(char c)" -->


  		




  ......




  150
  199
  
    
</dl>


  		




  151
  200
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl>


  		




  152
  201
  
    

  		




  
  202
  
    
<p>Referenced by <a class="el" href="serial_8c-source.html#l00048">usb_init()</a>, <a class="el" href="serial_8c-source.html#l00305">usb_puth16()</a>, <a class="el" href="serial_8c-source.html#l00323">usb_puth8()</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>


  		




  
  203
  
    

  		




  153
  204
  
    
</div>


  		




  154
  205
  
    
</div><p>


  		




  
  206
  
    
<a class="anchor" name="g8e7e31f1e45721ac032267b13d0f759b"></a><!-- doxytag: member="serial.h::usb_puth16" ref="g8e7e31f1e45721ac032267b13d0f759b" args="(uint16_t value)" -->


  		




  
  207
  
    
<div class="memitem">


  		




  
  208
  
    
<div class="memproto">


  		




  
  209
  
    
      <table class="memname">


  		




  
  210
  
    
        <tr>


  		




  
  211
  
    
          <td class="memname">void usb_puth16           </td>


  		




  
  212
  
    
          <td>(</td>


  		




  
  213
  
    
          <td class="paramtype">uint16_t&nbsp;</td>


  		




  
  214
  
    
          <td class="paramname"> <em>value</em>          </td>


  		




  
  215
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  
  216
  
    
          <td width="100%"></td>


  		




  
  217
  
    
        </tr>


  		




  
  218
  
    
      </table>


  		




  
  219
  
    
</div>


  		




  
  220
  
    
<div class="memdoc">


  		




  
  221
  
    

  		




  
  222
  
    
<p>


  		




  
  223
  
    
Print a fixed width hexadecimal representation to USB. 


  		




  
  224
  
    
<p>


  		




  
  225
  
    
Prints a fixed width hexadecimal representation of an unsigned 16 bit integer in ASCII code to USB. usb_init must be called before this function can be used.<p>


  		




  
  226
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  
  227
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  
  228
  
    
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>the value to print</td></tr>


  		




  
  229
  
    
  </table>


  		




  
  230
  
    
</dl>


  		




  
  231
  
    
<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>


  		




  
  232
  
    

  		




  
  233
  
    
<p>References <a class="el" href="serial_8c-source.html#l00288">hex_digit()</a>, and <a class="el" href="serial_8c-source.html#l00117">usb_putc()</a>.</p>


  		




  
  234
  
    

  		




  
  235
  
    
</div>


  		




  
  236
  
    
</div><p>


  		




  
  237
  
    
<a class="anchor" name="g21462df541911e0611416e85be6ea34d"></a><!-- doxytag: member="serial.h::usb_puth8" ref="g21462df541911e0611416e85be6ea34d" args="(uint8_t value)" -->


  		




  
  238
  
    
<div class="memitem">


  		




  
  239
  
    
<div class="memproto">


  		




  
  240
  
    
      <table class="memname">


  		




  
  241
  
    
        <tr>


  		




  
  242
  
    
          <td class="memname">void usb_puth8           </td>


  		




  
  243
  
    
          <td>(</td>


  		




  
  244
  
    
          <td class="paramtype">uint8_t&nbsp;</td>


  		




  
  245
  
    
          <td class="paramname"> <em>value</em>          </td>


  		




  
  246
  
    
          <td>&nbsp;)&nbsp;</td>


  		




  
  247
  
    
          <td width="100%"></td>


  		




  
  248
  
    
        </tr>


  		




  
  249
  
    
      </table>


  		




  
  250
  
    
</div>


  		




  
  251
  
    
<div class="memdoc">


  		




  
  252
  
    

  		




  
  253
  
    
<p>


  		




  
  254
  
    
Print a fixed width hexadecimal representation to USB. 


  		




  
  255
  
    
<p>


  		




  
  256
  
    
Prints a fixed width hexadecimal representation of an unsigned 8 bit integer in ASCII code to USB. usb_init must be called before this function can be used.<p>


  		




  
  257
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  
  258
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  
  259
  
    
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>the value to print</td></tr>


  		




  
  260
  
    
  </table>


  		




  
  261
  
    
</dl>


  		




  
  262
  
    
<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>


  		




  
  263
  
    

  		




  
  264
  
    
<p>References <a class="el" href="serial_8c-source.html#l00288">hex_digit()</a>, and <a class="el" href="serial_8c-source.html#l00117">usb_putc()</a>.</p>


  		




  
  265
  
    

  		




  
  266
  
    
</div>


  		




  
  267
  
    
</div><p>


  		




  155
  268
  
    
<a class="anchor" name="gcd371dedbff10f0c52dca4b3b7af9e3d"></a><!-- doxytag: member="serial.h::usb_puti" ref="gcd371dedbff10f0c52dca4b3b7af9e3d" args="(int value)" -->


  		




  156
  269
  
    
<div class="memitem">


  		




  157
  270
  
    
<div class="memproto">


  		




  ......




  180
  293
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful, nonzero otherwise</dd></dl>


  		




  181
  294
  
    
<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>


  		




  182
  295
  
    

  		




  
  296
  
    
<p>References <a class="el" href="serial_8c-source.html#l00117">usb_putc()</a>.</p>


  		




  
  297
  
    

  		




  183
  298
  
    
</div>


  		




  184
  299
  
    
</div><p>


  		




  185
  300
  
    
<a class="anchor" name="g6e101f68856f272f67923c4fb35a99e0"></a><!-- doxytag: member="serial.h::usb_puts" ref="g6e101f68856f272f67923c4fb35a99e0" args="(char *s)" -->


  		




  ......




  209
  324
  
    
</dl>


  		




  210
  325
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl>


  		




  211
  326
  
    

  		




  
  327
  
    
<p>References <a class="el" href="serial_8c-source.html#l00117">usb_putc()</a>.</p>


  		




  
  328
  
    

  		




  212
  329
  
    
</div>


  		




  213
  330
  
    
</div><p>


  		




  214
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:43 2008 for libdragonfly by&nbsp;


  		




  
  331
  
    
</div>


  		




  
  332
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 16 18:33:23 2009 for libdragonfly by&nbsp;


  		




  215
  333
  
    
<a href="http://www.doxygen.org/index.html">


  		




  216
  
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>


  		




  
  334
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>


  		




  217
  335
  
    
</body>


  		




  218
  336
  
    
</html>


  		












Also available in:  Unified diff