root / branches / wireless / docs / libdragonfly / html / group__usb.html @ 1578
History | View | Annotate | Download (17.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=UTF-8"> |
3 |
<title>Colony: USB Input / Output</title> |
4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.5.8 -->
|
8 |
<div class="navigation" id="top"> |
9 |
<div class="tabs"> |
10 |
<ul>
|
11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
12 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
13 |
<li><a href="modules.html"><span>Modules</span></a></li> |
14 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
15 |
<li><a href="files.html"><span>Files</span></a></li> |
16 |
</ul>
|
17 |
</div>
|
18 |
</div>
|
19 |
<div class="contents"> |
20 |
<h1>USB Input / Output</h1>Functions for USB input / output. |
21 |
<a href="#_details">More...</a> |
22 |
<p>
|
23 |
<table border="0" cellpadding="0" cellspacing="0"> |
24 |
<tr><td></td></tr> |
25 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g378065b4d75b008228ee41cc335474a7"></a><!-- doxytag: member="usb::USB_BAUD" ref="g378065b4d75b008228ee41cc335474a7" args="" --> |
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g378065b4d75b008228ee41cc335474a7">USB_BAUD</a> 115200</td></tr> |
28 |
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">the USB baud rate <br></td></tr> |
30 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#ge227d2d613cf288a240925ac43baea5f">usb_init</a> (void)</td></tr> |
32 |
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the USB. <a href="#ge227d2d613cf288a240925ac43baea5f"></a><br></td></tr> |
34 |
<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> |
35 |
|
36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a character to USB. <a href="#g3ee898cfe59d05c428c56021c2ccf946"></a><br></td></tr> |
37 |
<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> |
38 |
|
39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from USB. <a href="#g053a5d887edfe8e8be543ec53a3f60ae"></a><br></td></tr> |
40 |
<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> |
41 |
|
42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a character from USB without blocking. <a href="#g6b1209b19e7fd2bbedc7407e0218453c"></a><br></td></tr> |
43 |
<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> |
44 |
|
45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a string to USB. <a href="#g6e101f68856f272f67923c4fb35a99e0"></a><br></td></tr> |
46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gc23e678fb810ce254accca5dc6b9ab22">usb_puts_P</a> (PGM_P s)</td></tr> |
47 |
|
48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a string from program space to USB. <a href="#gc23e678fb810ce254accca5dc6b9ab22"></a><br></td></tr> |
49 |
<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> |
50 |
|
51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print an integer to USB. <a href="#gcd371dedbff10f0c52dca4b3b7af9e3d"></a><br></td></tr> |
52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g94d47853c33da12c71dec155f819cfeb">hex_digit</a> (uint8_t value)</td></tr> |
53 |
|
54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine a hexadecimal digit. <a href="#g94d47853c33da12c71dec155f819cfeb"></a><br></td></tr> |
55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#g4ea9f8eee421d1603fec75b99e8585db">usb_puth16</a> (uint16_t value)</td></tr> |
56 |
|
57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a fixed width hexadecimal representation to USB. <a href="#g4ea9f8eee421d1603fec75b99e8585db"></a><br></td></tr> |
58 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__usb.html#gd8203ca6f5246066f1c88b790d63d3de">usb_puth8</a> (uint8_t value)</td></tr> |
59 |
|
60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a fixed width hexadecimal representation to USB. <a href="#gd8203ca6f5246066f1c88b790d63d3de"></a><br></td></tr> |
61 |
</table>
|
62 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
63 |
Functions for USB input / output. |
64 |
<p>
|
65 |
Low level functions for USB input and output. <hr><h2>Function Documentation</h2> |
66 |
<a class="anchor" name="g94d47853c33da12c71dec155f819cfeb"></a><!-- doxytag: member="serial.h::hex_digit" ref="g94d47853c33da12c71dec155f819cfeb" args="(uint8_t value)" --> |
67 |
<div class="memitem"> |
68 |
<div class="memproto"> |
69 |
<table class="memname"> |
70 |
<tr>
|
71 |
<td class="memname">uint8_t hex_digit </td> |
72 |
<td>(</td> |
73 |
<td class="paramtype">uint8_t </td> |
74 |
<td class="paramname"> <em>value</em> </td> |
75 |
<td> ) </td> |
76 |
<td></td> |
77 |
</tr>
|
78 |
</table>
|
79 |
</div>
|
80 |
<div class="memdoc"> |
81 |
|
82 |
<p>
|
83 |
Determine a hexadecimal digit. |
84 |
<p>
|
85 |
Determines a hexadecimal digit in ASCII code.<p>
|
86 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
87 |
<table border="0" cellspacing="2" cellpadding="0"> |
88 |
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value of the digit (0<=value<=15)</td></tr> |
89 |
</table>
|
90 |
</dl>
|
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> |
92 |
|
93 |
</div>
|
94 |
</div><p> |
95 |
<a class="anchor" name="g053a5d887edfe8e8be543ec53a3f60ae"></a><!-- doxytag: member="serial.h::usb_getc" ref="g053a5d887edfe8e8be543ec53a3f60ae" args="(void)" --> |
96 |
<div class="memitem"> |
97 |
<div class="memproto"> |
98 |
<table class="memname"> |
99 |
<tr>
|
100 |
<td class="memname">int usb_getc </td> |
101 |
<td>(</td> |
102 |
<td class="paramtype">void </td> |
103 |
<td class="paramname"> </td> |
104 |
<td> ) </td> |
105 |
<td></td> |
106 |
</tr>
|
107 |
</table>
|
108 |
</div>
|
109 |
<div class="memdoc"> |
110 |
|
111 |
<p>
|
112 |
Read a character from USB. |
113 |
<p>
|
114 |
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>
|
115 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the first character in the usb buffer, -1 on error</dd></dl> |
116 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#ge227d2d613cf288a240925ac43baea5f" 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 |
|
118 |
</div>
|
119 |
</div><p> |
120 |
<a class="anchor" name="g6b1209b19e7fd2bbedc7407e0218453c"></a><!-- doxytag: member="serial.h::usb_getc_nb" ref="g6b1209b19e7fd2bbedc7407e0218453c" args="(char *c)" --> |
121 |
<div class="memitem"> |
122 |
<div class="memproto"> |
123 |
<table class="memname"> |
124 |
<tr>
|
125 |
<td class="memname">int usb_getc_nb </td> |
126 |
<td>(</td> |
127 |
<td class="paramtype">char * </td> |
128 |
<td class="paramname"> <em>c</em> </td> |
129 |
<td> ) </td> |
130 |
<td></td> |
131 |
</tr>
|
132 |
</table>
|
133 |
</div>
|
134 |
<div class="memdoc"> |
135 |
|
136 |
<p>
|
137 |
Read a character from USB without blocking. |
138 |
<p>
|
139 |
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>
|
140 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
141 |
<table border="0" cellspacing="2" cellpadding="0"> |
142 |
<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> |
143 |
</table>
|
144 |
</dl>
|
145 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 if no character is available, 0 otherwise, positive for error</dd></dl> |
146 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#ge227d2d613cf288a240925ac43baea5f" 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> |
147 |
|
148 |
</div>
|
149 |
</div><p> |
150 |
<a class="anchor" name="ge227d2d613cf288a240925ac43baea5f"></a><!-- doxytag: member="serial.h::usb_init" ref="ge227d2d613cf288a240925ac43baea5f" args="(void)" --> |
151 |
<div class="memitem"> |
152 |
<div class="memproto"> |
153 |
<table class="memname"> |
154 |
<tr>
|
155 |
<td class="memname">int usb_init </td> |
156 |
<td>(</td> |
157 |
<td class="paramtype">void </td> |
158 |
<td class="paramname"> </td> |
159 |
<td> ) </td> |
160 |
<td></td> |
161 |
</tr>
|
162 |
</table>
|
163 |
</div>
|
164 |
<div class="memdoc"> |
165 |
|
166 |
<p>
|
167 |
Initialize the USB. |
168 |
<p>
|
169 |
Initializes communication over the USB serial port. This must be called before any other usb function may be used. |
170 |
</div>
|
171 |
</div><p> |
172 |
<a class="anchor" name="g3ee898cfe59d05c428c56021c2ccf946"></a><!-- doxytag: member="serial.h::usb_putc" ref="g3ee898cfe59d05c428c56021c2ccf946" args="(char c)" --> |
173 |
<div class="memitem"> |
174 |
<div class="memproto"> |
175 |
<table class="memname"> |
176 |
<tr>
|
177 |
<td class="memname">int usb_putc </td> |
178 |
<td>(</td> |
179 |
<td class="paramtype">char </td> |
180 |
<td class="paramname"> <em>c</em> </td> |
181 |
<td> ) </td> |
182 |
<td></td> |
183 |
</tr>
|
184 |
</table>
|
185 |
</div>
|
186 |
<div class="memdoc"> |
187 |
|
188 |
<p>
|
189 |
Print a character to USB. |
190 |
<p>
|
191 |
Sends a character over USB.<p>
|
192 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
193 |
<table border="0" cellspacing="2" cellpadding="0"> |
194 |
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the character to send </td></tr> |
195 |
</table>
|
196 |
</dl>
|
197 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
198 |
|
199 |
</div>
|
200 |
</div><p> |
201 |
<a class="anchor" name="g4ea9f8eee421d1603fec75b99e8585db"></a><!-- doxytag: member="serial.h::usb_puth16" ref="g4ea9f8eee421d1603fec75b99e8585db" args="(uint16_t value)" --> |
202 |
<div class="memitem"> |
203 |
<div class="memproto"> |
204 |
<table class="memname"> |
205 |
<tr>
|
206 |
<td class="memname">int usb_puth16 </td> |
207 |
<td>(</td> |
208 |
<td class="paramtype">uint16_t </td> |
209 |
<td class="paramname"> <em>value</em> </td> |
210 |
<td> ) </td> |
211 |
<td></td> |
212 |
</tr>
|
213 |
</table>
|
214 |
</div>
|
215 |
<div class="memdoc"> |
216 |
|
217 |
<p>
|
218 |
Print a fixed width hexadecimal representation to USB. |
219 |
<p>
|
220 |
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>
|
221 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
222 |
<table border="0" cellspacing="2" cellpadding="0"> |
223 |
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to print</td></tr> |
224 |
</table>
|
225 |
</dl>
|
226 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#ge227d2d613cf288a240925ac43baea5f" 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#gd8203ca6f5246066f1c88b790d63d3de" 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> |
227 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if init succesfull, an error code otherwise </dd></dl> |
228 |
|
229 |
</div>
|
230 |
</div><p> |
231 |
<a class="anchor" name="gd8203ca6f5246066f1c88b790d63d3de"></a><!-- doxytag: member="serial.h::usb_puth8" ref="gd8203ca6f5246066f1c88b790d63d3de" args="(uint8_t value)" --> |
232 |
<div class="memitem"> |
233 |
<div class="memproto"> |
234 |
<table class="memname"> |
235 |
<tr>
|
236 |
<td class="memname">int usb_puth8 </td> |
237 |
<td>(</td> |
238 |
<td class="paramtype">uint8_t </td> |
239 |
<td class="paramname"> <em>value</em> </td> |
240 |
<td> ) </td> |
241 |
<td></td> |
242 |
</tr>
|
243 |
</table>
|
244 |
</div>
|
245 |
<div class="memdoc"> |
246 |
|
247 |
<p>
|
248 |
Print a fixed width hexadecimal representation to USB. |
249 |
<p>
|
250 |
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>
|
251 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
252 |
<table border="0" cellspacing="2" cellpadding="0"> |
253 |
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value to print</td></tr> |
254 |
</table>
|
255 |
</dl>
|
256 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#ge227d2d613cf288a240925ac43baea5f" 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#g4ea9f8eee421d1603fec75b99e8585db" 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> |
257 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if init succesfull, an error code otherwise </dd></dl> |
258 |
|
259 |
</div>
|
260 |
</div><p> |
261 |
<a class="anchor" name="gcd371dedbff10f0c52dca4b3b7af9e3d"></a><!-- doxytag: member="serial.h::usb_puti" ref="gcd371dedbff10f0c52dca4b3b7af9e3d" args="(int value)" --> |
262 |
<div class="memitem"> |
263 |
<div class="memproto"> |
264 |
<table class="memname"> |
265 |
<tr>
|
266 |
<td class="memname">int usb_puti </td> |
267 |
<td>(</td> |
268 |
<td class="paramtype">int </td> |
269 |
<td class="paramname"> <em>value</em> </td> |
270 |
<td> ) </td> |
271 |
<td></td> |
272 |
</tr>
|
273 |
</table>
|
274 |
</div>
|
275 |
<div class="memdoc"> |
276 |
|
277 |
<p>
|
278 |
Print an integer to USB. |
279 |
<p>
|
280 |
Prints an integer, converted to ASCII, to usb. usb_init must be called before this function can be used.<p>
|
281 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
282 |
<table border="0" cellspacing="2" cellpadding="0"> |
283 |
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the integer to print</td></tr> |
284 |
</table>
|
285 |
</dl>
|
286 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful, nonzero otherwise</dd></dl> |
287 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__usb.html#ge227d2d613cf288a240925ac43baea5f" 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> |
288 |
|
289 |
</div>
|
290 |
</div><p> |
291 |
<a class="anchor" name="g6e101f68856f272f67923c4fb35a99e0"></a><!-- doxytag: member="serial.h::usb_puts" ref="g6e101f68856f272f67923c4fb35a99e0" args="(char *s)" --> |
292 |
<div class="memitem"> |
293 |
<div class="memproto"> |
294 |
<table class="memname"> |
295 |
<tr>
|
296 |
<td class="memname">int usb_puts </td> |
297 |
<td>(</td> |
298 |
<td class="paramtype">char * </td> |
299 |
<td class="paramname"> <em>s</em> </td> |
300 |
<td> ) </td> |
301 |
<td></td> |
302 |
</tr>
|
303 |
</table>
|
304 |
</div>
|
305 |
<div class="memdoc"> |
306 |
|
307 |
<p>
|
308 |
Print a string to USB. |
309 |
<p>
|
310 |
Sends a sequence of characters over USB.<p>
|
311 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
312 |
<table border="0" cellspacing="2" cellpadding="0"> |
313 |
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>the string to send </td></tr> |
314 |
</table>
|
315 |
</dl>
|
316 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 for success, nonzero for failure </dd></dl> |
317 |
|
318 |
</div>
|
319 |
</div><p> |
320 |
<a class="anchor" name="gc23e678fb810ce254accca5dc6b9ab22"></a><!-- doxytag: member="serial.h::usb_puts_P" ref="gc23e678fb810ce254accca5dc6b9ab22" args="(PGM_P s)" --> |
321 |
<div class="memitem"> |
322 |
<div class="memproto"> |
323 |
<table class="memname"> |
324 |
<tr>
|
325 |
<td class="memname">int usb_puts_P </td> |
326 |
<td>(</td> |
327 |
<td class="paramtype">PGM_P </td> |
328 |
<td class="paramname"> <em>s</em> </td> |
329 |
<td> ) </td> |
330 |
<td></td> |
331 |
</tr>
|
332 |
</table>
|
333 |
</div>
|
334 |
<div class="memdoc"> |
335 |
|
336 |
<p>
|
337 |
Print a string from program space to USB. |
338 |
<p>
|
339 |
Sends a sequence of characters from program space over USB.<p>
|
340 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
341 |
<table border="0" cellspacing="2" cellpadding="0"> |
342 |
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>the string to send</td></tr> |
343 |
</table>
|
344 |
</dl>
|
345 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if init succesfull, an error code otherwise </dd></dl> |
346 |
|
347 |
</div>
|
348 |
</div><p> |
349 |
</div>
|
350 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Nov 20 21:51:59 2009 for Colony by |
351 |
<a href="http://www.doxygen.org/index.html"> |
352 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
353 |
</body>
|
354 |
</html>
|