Project

General

Profile

Revision 241

Added by Brian Coltin over 16 years ago

Updated libdragonfly documentation.

View differences:

group__usb.html
1 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">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3 
<title>libdragonfly: USB Input / Output</title>
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.4.6 -->
7 
<!-- Generated by Doxygen 1.5.3 -->
8 8 
<div class="tabs">
9 9 
  <ul>
10 10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 12 
    <li><a href="files.html"><span>Files</span></a></li>
13 
  </ul></div>
13 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14 
  </ul>
15 
</div>
14 16 
<h1>USB Input / Output</h1>Functions for USB input / output.
15 17 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
16 18 
<tr><td></td></tr>
......
43 45 
Functions for USB input / output.
44 46 
<p>
45 47 
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">
48 
<a class="anchor" name="g053a5d887edfe8e8be543ec53a3f60ae"></a><!-- doxytag: member="serial.h::usb_getc" ref="g053a5d887edfe8e8be543ec53a3f60ae" args="(void)" -->
49 
<div class="memitem">
50 
<div class="memproto">
51 
      <table class="memname">
51 52 
        <tr>
52 
          <td class="md" nowrap valign="top">int usb_getc           </td>
53 
          <td class="md" valign="top">(&nbsp;</td>
54 
          <td class="md" nowrap valign="top">void&nbsp;</td>
55 
          <td class="mdname1" valign="top" nowrap>          </td>
56 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
57 
          <td class="md" nowrap></td>
53 
          <td class="memname">int usb_getc           </td>
54 
          <td>(</td>
55 
          <td class="paramtype">void&nbsp;</td>
56 
          <td class="paramname">          </td>
57 
          <td>&nbsp;)&nbsp;</td>
58 
          <td width="100%"></td>
58 59 
        </tr>
59 60 
      </table>
60 
    </td>
61 
  </tr>
62 
</table>
63 
<table cellspacing="5" cellpadding="0" border="0">
64 
  <tr>
65 
    <td>
66 
      &nbsp;
67 
    </td>
68 
    <td>
61 
</div>
62 
<div class="memdoc">
69 63 

  		




  70
  64
  
    
<p>


  		




  71
  65
  
    
Read a character from USB. 


  		




  72
  66
  
    
<p>


  		




  73
  67
  
    
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">


  		




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


  		




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


  		




  
  70
  
    

  		




  
  71
  
    
</div>


  		




  
  72
  
    
</div><p>


  		




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


  		




  
  74
  
    
<div class="memitem">


  		




  
  75
  
    
<div class="memproto">


  		




  
  76
  
    
      <table class="memname">


  		




  84
  77
  
    
        <tr>


  		




  85
  
  
    
          <td class="md" nowrap valign="top">int usb_getc_nb           </td>


  		




  86
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  87
  
  
    
          <td class="md" nowrap valign="top">char *&nbsp;</td>


  		




  88
  
  
    
          <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>


  		




  89
  
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  90
  
  
    
          <td class="md" nowrap></td>


  		




  
  78
  
    
          <td class="memname">int usb_getc_nb           </td>


  		




  
  79
  
    
          <td>(</td>


  		




  
  80
  
    
          <td class="paramtype">char *&nbsp;</td>


  		




  
  81
  
    
          <td class="paramname"> <em>c</em>          </td>


  		




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


  		




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


  		




  91
  84
  
    
        </tr>


  		




  92
  85
  
    
      </table>


  		




  93
  
  
    
    </td>


  		




  94
  
  
    
  </tr>


  		




  95
  
  
    
</table>


  		




  96
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  97
  
  
    
  <tr>


  		




  98
  
  
    
    <td>


  		




  99
  
  
    
      &nbsp;


  		




  100
  
  
    
    </td>


  		




  101
  
  
    
    <td>


  		




  
  86
  
    
</div>


  		




  
  87
  
    
<div class="memdoc">


  		




  102
  88
  
    

  		




  103
  89
  
    
<p>


  		




  104
  90
  
    
Read a character from USB without blocking. 


  		




  ......




  109
  95
  
    
    <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>the received character. This will be set if a character has been received.</td></tr>


  		




  110
  96
  
    
  </table>


  		




  111
  97
  
    
</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">


  		




  
  98
  
    
<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if no character is available, 0 otherwise</dd></dl>


  		




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


  		




  
  100
  
    

  		




  
  101
  
    
</div>


  		




  
  102
  
    
</div><p>


  		




  
  103
  
    
<a class="anchor" name="gddfbdb66f507ffcd08b4496531ed0a3d"></a><!-- doxytag: member="serial.h::usb_init" ref="gddfbdb66f507ffcd08b4496531ed0a3d" args="(void)" -->


  		




  
  104
  
    
<div class="memitem">


  		




  
  105
  
    
<div class="memproto">


  		




  
  106
  
    
      <table class="memname">


  		




  122
  107
  
    
        <tr>


  		




  123
  
  
    
          <td class="md" nowrap valign="top">void usb_init           </td>


  		




  124
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  125
  
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  126
  
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  127
  
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  128
  
  
    
          <td class="md" nowrap></td>


  		




  
  108
  
    
          <td class="memname">void usb_init           </td>


  		




  
  109
  
    
          <td>(</td>


  		




  
  110
  
    
          <td class="paramtype">void&nbsp;</td>


  		




  
  111
  
    
          <td class="paramname">          </td>


  		




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


  		




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


  		




  129
  114
  
    
        </tr>


  		




  130
  115
  
    
      </table>


  		




  131
  
  
    
    </td>


  		




  132
  
  
    
  </tr>


  		




  133
  
  
    
</table>


  		




  134
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  135
  
  
    
  <tr>


  		




  136
  
  
    
    <td>


  		




  137
  
  
    
      &nbsp;


  		




  138
  
  
    
    </td>


  		




  139
  
  
    
    <td>


  		




  
  116
  
    
</div>


  		




  
  117
  
    
<div class="memdoc">


  		




  140
  118
  
    

  		




  141
  119
  
    
<p>


  		




  142
  120
  
    
Initialize the USB. 


  		




  143
  121
  
    
<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">


  		




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


  		




  
  123
  
    
</div>


  		




  
  124
  
    
</div><p>


  		




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


  		




  
  126
  
    
<div class="memitem">


  		




  
  127
  
    
<div class="memproto">


  		




  
  128
  
    
      <table class="memname">


  		




  152
  129
  
    
        <tr>


  		




  153
  
  
    
          <td class="md" nowrap valign="top">int usb_putc           </td>


  		




  154
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  155
  
  
    
          <td class="md" nowrap valign="top">char&nbsp;</td>


  		




  156
  
  
    
          <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>


  		




  157
  
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  158
  
  
    
          <td class="md" nowrap></td>


  		




  
  130
  
    
          <td class="memname">int usb_putc           </td>


  		




  
  131
  
    
          <td>(</td>


  		




  
  132
  
    
          <td class="paramtype">char&nbsp;</td>


  		




  
  133
  
    
          <td class="paramname"> <em>c</em>          </td>


  		




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


  		




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


  		




  159
  136
  
    
        </tr>


  		




  160
  137
  
    
      </table>


  		




  161
  
  
    
    </td>


  		




  162
  
  
    
  </tr>


  		




  163
  
  
    
</table>


  		




  164
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  165
  
  
    
  <tr>


  		




  166
  
  
    
    <td>


  		




  167
  
  
    
      &nbsp;


  		




  168
  
  
    
    </td>


  		




  169
  
  
    
    <td>


  		




  
  138
  
    
</div>


  		




  
  139
  
    
<div class="memdoc">


  		




  170
  140
  
    

  		




  171
  141
  
    
<p>


  		




  172
  142
  
    
Print a character to USB. 


  		




  ......




  177
  147
  
    
    <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>the character to send </td></tr>


  		




  178
  148
  
    
  </table>


  		




  179
  149
  
    
</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">


  		




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


  		




  
  151
  
    

  		




  
  152
  
    
</div>


  		




  
  153
  
    
</div><p>


  		




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


  		




  
  155
  
    
<div class="memitem">


  		




  
  156
  
    
<div class="memproto">


  		




  
  157
  
    
      <table class="memname">


  		




  189
  158
  
    
        <tr>


  		




  190
  
  
    
          <td class="md" nowrap valign="top">int usb_puti           </td>


  		




  191
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  192
  
  
    
          <td class="md" nowrap valign="top">int&nbsp;</td>


  		




  193
  
  
    
          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>


  		




  194
  
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  195
  
  
    
          <td class="md" nowrap></td>


  		




  
  159
  
    
          <td class="memname">int usb_puti           </td>


  		




  
  160
  
    
          <td>(</td>


  		




  
  161
  
    
          <td class="paramtype">int&nbsp;</td>


  		




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


  		




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


  		




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


  		




  196
  165
  
    
        </tr>


  		




  197
  166
  
    
      </table>


  		




  198
  
  
    
    </td>


  		




  199
  
  
    
  </tr>


  		




  200
  
  
    
</table>


  		




  201
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  202
  
  
    
  <tr>


  		




  203
  
  
    
    <td>


  		




  204
  
  
    
      &nbsp;


  		




  205
  
  
    
    </td>


  		




  206
  
  
    
    <td>


  		




  
  167
  
    
</div>


  		




  
  168
  
    
<div class="memdoc">


  		




  207
  169
  
    

  		




  208
  170
  
    
<p>


  		




  209
  171
  
    
Print an integer to USB. 


  		




  ......




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


  		




  215
  177
  
    
  </table>


  		




  216
  178
  
    
</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">


  		




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


  		




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


  		




  
  181
  
    

  		




  
  182
  
    
</div>


  		




  
  183
  
    
</div><p>


  		




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


  		




  
  185
  
    
<div class="memitem">


  		




  
  186
  
    
<div class="memproto">


  		




  
  187
  
    
      <table class="memname">


  		




  227
  188
  
    
        <tr>


  		




  228
  
  
    
          <td class="md" nowrap valign="top">int usb_puts           </td>


  		




  229
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  230
  
  
    
          <td class="md" nowrap valign="top">char *&nbsp;</td>


  		




  231
  
  
    
          <td class="mdname1" valign="top" nowrap> <em>s</em>          </td>


  		




  232
  
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  233
  
  
    
          <td class="md" nowrap></td>


  		




  
  189
  
    
          <td class="memname">int usb_puts           </td>


  		




  
  190
  
    
          <td>(</td>


  		




  
  191
  
    
          <td class="paramtype">char *&nbsp;</td>


  		




  
  192
  
    
          <td class="paramname"> <em>s</em>          </td>


  		




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


  		




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


  		




  234
  195
  
    
        </tr>


  		




  235
  196
  
    
      </table>


  		




  236
  
  
    
    </td>


  		




  237
  
  
    
  </tr>


  		




  238
  
  
    
</table>


  		




  239
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  240
  
  
    
  <tr>


  		




  241
  
  
    
    <td>


  		




  242
  
  
    
      &nbsp;


  		




  243
  
  
    
    </td>


  		




  244
  
  
    
    <td>


  		




  
  197
  
    
</div>


  		




  
  198
  
    
<div class="memdoc">


  		




  245
  199
  
    

  		




  246
  200
  
    
<p>


  		




  247
  201
  
    
Print a string to USB. 


  		




  ......




  252
  206
  
    
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>the string to send </td></tr>


  		




  253
  207
  
    
  </table>


  		




  254
  208
  
    
</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 26 17:39:31 2007 for libdragonfly by&nbsp;


  		




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


  		




  
  210
  
    

  		




  
  211
  
    
</div>


  		




  
  212
  
    
</div><p>


  		




  
  213
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by&nbsp;


  		




  260
  214
  
    
<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>


  		




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


  		




  262
  216
  
    
</body>


  		




  263
  217
  
    
</html>


  		












Also available in:  Unified diff