forked from Traumflug/Teacup_Firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
/
serial_8h.html
264 lines (247 loc) · 13.1 KB
/
serial_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Teacup: serial.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>serial.h File Reference</h1> </div>
</div>
<div class="contents">
<code>#include <stdint.h></code><br/>
<code>#include <avr/io.h></code><br/>
<code>#include <avr/pgmspace.h></code><br/>
<p><a href="serial_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#ad2b461e9e9044364a28a61cfadcacdd8">serial_init</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">initialise serial subsystem <a href="#ad2b461e9e9044364a28a61cfadcacdd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a61f586f4a26eaa0098d5974fdbd6eb2c">serial_rxchars</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a1e3dcb4e8d06786117395b3c233c43e4">serial_popchar</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a218860ac8eaeb39d590e5d5ff84c6638">serial_writechar</a> (uint8_t data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#adef8272b64824c35e705eaa9870d7081">serial_writeblock</a> (void *data, int datalen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a7e9379b066254ccad5f6937dae095a3e">serial_writestr</a> (uint8_t *data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a15556d56d623c67eb1fc28b8c9eb068b">serial_writeblock_P</a> (PGM_P data, int datalen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a4ae3a1344cad5fd297b7d575b59bf520">serial_writestr_P</a> (PGM_P data)</td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ad2b461e9e9044364a28a61cfadcacdd8"></a><!-- doxytag: member="serial.h::serial_init" ref="ad2b461e9e9044364a28a61cfadcacdd8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void serial_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>initialise serial subsystem </p>
<p>set up baud generator and interrupts, clear buffers </p>
<p>Referenced by <a class="el" href="mendel_8c.html#a2858154e2009b0e6e616f313177762bc">init()</a>.</p>
</div>
</div>
<a class="anchor" id="a1e3dcb4e8d06786117395b3c233c43e4"></a><!-- doxytag: member="serial.h::serial_popchar" ref="a1e3dcb4e8d06786117395b3c233c43e4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t serial_popchar </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="mendel_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>
</div>
</div>
<a class="anchor" id="a61f586f4a26eaa0098d5974fdbd6eb2c"></a><!-- doxytag: member="serial.h::serial_rxchars" ref="a61f586f4a26eaa0098d5974fdbd6eb2c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t serial_rxchars </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="mendel_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>
</div>
</div>
<a class="anchor" id="adef8272b64824c35e705eaa9870d7081"></a><!-- doxytag: member="serial.h::serial_writeblock" ref="adef8272b64824c35e705eaa9870d7081" args="(void *data, int datalen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void serial_writeblock </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>datalen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a15556d56d623c67eb1fc28b8c9eb068b"></a><!-- doxytag: member="serial.h::serial_writeblock_P" ref="a15556d56d623c67eb1fc28b8c9eb068b" args="(PGM_P data, int datalen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void serial_writeblock_P </td>
<td>(</td>
<td class="paramtype">PGM_P </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>datalen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a218860ac8eaeb39d590e5d5ff84c6638"></a><!-- doxytag: member="serial.h::serial_writechar" ref="a218860ac8eaeb39d590e5d5ff84c6638" args="(uint8_t data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void serial_writechar </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"> <em>data</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="clock_8h.html#a31cac7fc4553f492b14c8853aaeae233">clock_250ms()</a>, <a class="el" href="dda_8h.html#a9f6cc78e86a3e19d661c4425feefd962">dda_create()</a>, <a class="el" href="gcode__parse_8h.html#a18866606182cff1b9b4e35b3c05e13ba">gcode_parse_char()</a>, <a class="el" href="gcode__parse_8h.html#aa6a4887a9acbce1f838fde166bfb797b">request_resend()</a>, <a class="el" href="sersendf_8c.html#a626b4564076b7b250d51f2b996823c4b">sersendf_P()</a>, <a class="el" href="sermsg_8h.html#a2934910ea7bad5f6946e45ae3ac410cb">serwrite_hex4()</a>, <a class="el" href="sermsg_8h.html#af6b7b5270dcaffcfcb46acb3deff7448">serwrite_int32()</a>, and <a class="el" href="sermsg_8h.html#ab9ee1d3b16107f800fe44cfa858e3635">serwrite_uint32()</a>.</p>
</div>
</div>
<a class="anchor" id="a7e9379b066254ccad5f6937dae095a3e"></a><!-- doxytag: member="serial.h::serial_writestr" ref="a7e9379b066254ccad5f6937dae095a3e" args="(uint8_t *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void serial_writestr </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"> <em>data</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4ae3a1344cad5fd297b7d575b59bf520"></a><!-- doxytag: member="serial.h::serial_writestr_P" ref="a4ae3a1344cad5fd297b7d575b59bf520" args="(PGM_P data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void serial_writestr_P </td>
<td>(</td>
<td class="paramtype">PGM_P </td>
<td class="paramname"> <em>data</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="dda_8h.html#a9f6cc78e86a3e19d661c4425feefd962">dda_create()</a>, <a class="el" href="gcode__parse_8h.html#a18866606182cff1b9b4e35b3c05e13ba">gcode_parse_char()</a>, <a class="el" href="mendel_8c.html#a2858154e2009b0e6e616f313177762bc">init()</a>, <a class="el" href="dda__queue_8h.html#adcd4cfb7a34832e2916b23979377fa90">next_move()</a>, <a class="el" href="gcode__process_8h.html#aacf0751b94da83f25183c908834686b6">process_gcode_command()</a>, <a class="el" href="dda__queue_8h.html#ab4a420428440a22e8eeaf2bcd0f62f7e">queue_step()</a>, <a class="el" href="gcode__parse_8h.html#aa6a4887a9acbce1f838fde166bfb797b">request_resend()</a>, and <a class="el" href="sersendf_8c.html#a626b4564076b7b250d51f2b996823c4b">sersendf_P()</a>.</p>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Mar 21 2011 23:43:44 for Teacup by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>