Project

General

Profile

Statistics
| Revision:

root / branches / encoders / docs / libdragonfly / group__usb.html @ 856

History | View | Annotate | Download (10.6 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.4 -->
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="files.html"><span>Files</span></a></li>
13
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14
  </ul>
15
</div>
16
<h1>USB Input / Output</h1>Functions for USB input / output.  
17
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
18
<tr><td></td></tr>
19
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
20
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g378065b4d75b008228ee41cc335474a7"></a><!-- doxytag: member="usb::USB_BAUD" ref="g378065b4d75b008228ee41cc335474a7" args="" -->
21
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g378065b4d75b008228ee41cc335474a7">USB_BAUD</a>&nbsp;&nbsp;&nbsp;115200</td></tr>
22

    
23
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the USB baud rate <br></td></tr>
24
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
25
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gddfbdb66f507ffcd08b4496531ed0a3d">usb_init</a> (void)</td></tr>
26

    
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the USB.  <a href="#gddfbdb66f507ffcd08b4496531ed0a3d"></a><br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g3ee898cfe59d05c428c56021c2ccf946">usb_putc</a> (char c)</td></tr>
29

    
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a character to USB.  <a href="#g3ee898cfe59d05c428c56021c2ccf946"></a><br></td></tr>
31
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g053a5d887edfe8e8be543ec53a3f60ae">usb_getc</a> (void)</td></tr>
32

    
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from USB.  <a href="#g053a5d887edfe8e8be543ec53a3f60ae"></a><br></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g6b1209b19e7fd2bbedc7407e0218453c">usb_getc_nb</a> (char *c)</td></tr>
35

    
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a character from USB without blocking.  <a href="#g6b1209b19e7fd2bbedc7407e0218453c"></a><br></td></tr>
37
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g6e101f68856f272f67923c4fb35a99e0">usb_puts</a> (char *s)</td></tr>
38

    
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a string to USB.  <a href="#g6e101f68856f272f67923c4fb35a99e0"></a><br></td></tr>
40
<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>
41

    
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print an integer to USB.  <a href="#gcd371dedbff10f0c52dca4b3b7af9e3d"></a><br></td></tr>
43
</table>
44
<hr><a name="_details"></a><h2>Detailed Description</h2>
45
Functions for USB input / output. 
46
<p>
47
Low level functions for USB input and output. <hr><h2>Function Documentation</h2>
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">
52
        <tr>
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>
59
        </tr>
60
      </table>
61
</div>
62
<div class="memdoc">
63

    
64
<p>
65
Read a character from USB. 
66
<p>
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>
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">
77
        <tr>
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>
84
        </tr>
85
      </table>
86
</div>
87
<div class="memdoc">
88

    
89
<p>
90
Read a character from USB without blocking. 
91
<p>
92
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>
93
<dl compact><dt><b>Parameters:</b></dt><dd>
94
  <table border="0" cellspacing="2" cellpadding="0">
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>
96
  </table>
97
</dl>
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">
107
        <tr>
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>
114
        </tr>
115
      </table>
116
</div>
117
<div class="memdoc">
118

    
119
<p>
120
Initialize the USB. 
121
<p>
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">
129
        <tr>
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>
136
        </tr>
137
      </table>
138
</div>
139
<div class="memdoc">
140

    
141
<p>
142
Print a character to USB. 
143
<p>
144
Sends a character over USB.<p>
145
<dl compact><dt><b>Parameters:</b></dt><dd>
146
  <table border="0" cellspacing="2" cellpadding="0">
147
    <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>the character to send </td></tr>
148
  </table>
149
</dl>
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">
158
        <tr>
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>
165
        </tr>
166
      </table>
167
</div>
168
<div class="memdoc">
169

    
170
<p>
171
Print an integer to USB. 
172
<p>
173
Prints an integer, converted to ASCII, to usb. usb_init must be called before this function can be used.<p>
174
<dl compact><dt><b>Parameters:</b></dt><dd>
175
  <table border="0" cellspacing="2" cellpadding="0">
176
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>the integer to print</td></tr>
177
  </table>
178
</dl>
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">
188
        <tr>
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>
195
        </tr>
196
      </table>
197
</div>
198
<div class="memdoc">
199

    
200
<p>
201
Print a string to USB. 
202
<p>
203
Sends a sequence of characters over USB.<p>
204
<dl compact><dt><b>Parameters:</b></dt><dd>
205
  <table border="0" cellspacing="2" cellpadding="0">
206
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>the string to send </td></tr>
207
  </table>
208
</dl>
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 Mon Sep 22 22:30:16 2008 for libdragonfly by&nbsp;
214
<a href="http://www.doxygen.org/index.html">
215
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
216
</body>
217
</html>