Mirror
/
ardupilot
mirror of https://github.com/ArduPilot/ardupilot
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ardupilot/libraries/doc/html/_fast_serial_8h.html

363 lines
19 KiB
HTML
Raw Blame History

<!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>ArduPilot Libraries: FastSerial.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.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<h1>FastSerial.h File Reference</h1> </div>
</div>
<div class="contents">
<code>#include &lt;inttypes.h&gt;</code><br/>
<code>#include &lt;stdlib.h&gt;</code><br/>
<code>#include &lt;avr/io.h&gt;</code><br/>
<code>#include &lt;avr/interrupt.h&gt;</code><br/>
<code>#include &quot;<a class="el" href="_better_stream_8h_source.html">BetterStream.h</a>&quot;</code><br/>
<div class="dynheader">
Include dependency graph for FastSerial.h:</div>
<div class="dyncontent">
<div class="center"><img src="_fast_serial_8h__incl.png" border="0" usemap="#_fast_serial_8h" alt=""/></div>
<map name="_fast_serial_8h" id="_fast_serial_8h">
<area shape="rect" id="node11" href="_better_stream_8h.html" title="BetterStream.h" alt="" coords="435,83,557,112"/></map>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="_fast_serial_8h__dep__incl.png" border="0" usemap="#_fast_serial_8hdep" alt=""/></div>
<map name="_fast_serial_8hdep" id="_fast_serial_8hdep">
<area shape="rect" id="node3" href="menu_8cpp.html" title="menu.cpp" alt="" coords="11,83,96,112"/><area shape="rect" id="node5" href="_a_p___d_c_m___h_i_l_8h.html" title="AP_DCM_HIL.h" alt="" coords="32,237,147,267"/><area shape="rect" id="node7" href="_a_p___d_c_m_8h.html" title="AP_DCM.h" alt="" coords="160,315,248,344"/><area shape="rect" id="node14" href="_a_p___g_p_s___auto_8h.html" title="AP_GPS_Auto.h" alt="" coords="221,83,344,112"/><area shape="rect" id="node22" href="_a_p___g_p_s__406_8cpp.html" title="AP_GPS_406.cpp" alt="" coords="368,83,499,112"/><area shape="rect" id="node24" href="_a_p___i_m_u___oilpan_8cpp.html" title="AP_IMU_Oilpan.cpp" alt="" coords="523,83,667,112"/><area shape="rect" id="node26" href="_a_p___rc_channel_8h.html" title="AP_RcChannel manager." alt="" coords="691,83,816,112"/><area shape="rect" id="node30" href="_fast_serial_8cpp.html" title="FastSerial.cpp" alt="" coords="840,83,949,112"/><area shape="rect" id="node11" href="_a_p___d_c_m___h_i_l_8cpp.html" title="AP_DCM_HIL.cpp" alt="" coords="5,315,136,344"/><area shape="rect" id="node9" href="_a_p___d_c_m_8cpp.html" title="AP_DCM.cpp" alt="" coords="153,392,255,421"/><area shape="rect" id="node16" href="_a_p___g_p_s_8h.html" title="Catch&#45;all header that defines all supported GPS classes." alt="" coords="231,160,316,189"/><area shape="rect" id="node20" href="_a_p___g_p_s___auto_8cpp.html" title="AP_GPS_Auto.cpp" alt="" coords="272,237,408,267"/><area shape="rect" id="node28" href="_a_p___rc_channel_8cpp.html" title="AP_RcChannel.cpp" alt="" coords="684,160,823,189"/></map>
</div>
<p><a href="_fast_serial_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html">FastSerial</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_fast_serial_1_1_buffer.html">FastSerial::Buffer</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#a303b63294d669d2c5a269c92bdb700d5">HardwareSerial_h</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#ab0863c843132b67a13d6a953a2dceae8">FastSerialHandler</a>(_PORT, _RXVECTOR, _TXVECTOR, _UDR, _UCSRB, _TXBITS)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#ae9b997f0fe57adea67535f5bc3f4d212">FastSerialPort</a>(_name, _num)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#aa5f40a33be03eb43f0e1f1a31df74989">FastSerialPort0</a>(_portName)&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#a949c2517a50e34ee121c1fea9cb15b64">FastSerialPort1</a>(_portName)&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#ae93a07eece1f83c892496f5c6ef3e60e">FastSerialPort2</a>(_portName)&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#a9da84dd26ddee4197fcd3536d416b964">FastSerialPort3</a>(_portName)&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 3)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class <a class="el" href="class_fast_serial.html">FastSerial</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#a8e6f49b84135f0158fe250cb7338ddad">Serial</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class <a class="el" href="class_fast_serial.html">FastSerial</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#ad8026a4f12a38f848340968d0db7b4fd">Serial1</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class <a class="el" href="class_fast_serial.html">FastSerial</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#aab2db3cc91ed9cc8e13464e176fd05c4">Serial2</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class <a class="el" href="class_fast_serial.html">FastSerial</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#a86283126649840a9437389a9bd8e5448">Serial3</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_fast_serial_1_1_buffer.html">FastSerial::Buffer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#ad2687d3a6a3d7444849df9edc5597f6b">__FastSerial__rxBuffer</a> []</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_fast_serial_1_1_buffer.html">FastSerial::Buffer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_fast_serial_8h.html#a50dd604252dbc7918b4da78e2229e0ce">__FastSerial__txBuffer</a> []</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ab0863c843132b67a13d6a953a2dceae8"></a><!-- doxytag: member="FastSerial.h::FastSerialHandler" ref="ab0863c843132b67a13d6a953a2dceae8" args="(_PORT, _RXVECTOR, _TXVECTOR, _UDR, _UCSRB, _TXBITS)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FastSerialHandler</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_PORT, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_RXVECTOR, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_TXVECTOR, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_UDR, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_UCSRB, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_TXBITS</td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00149">149</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae9b997f0fe57adea67535f5bc3f4d212"></a><!-- doxytag: member="FastSerial.h::FastSerialPort" ref="ae9b997f0fe57adea67535f5bc3f4d212" args="(_name, _num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FastSerialPort</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_num</td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="class_fast_serial.html">FastSerial</a> _name(_num, \
&amp;UBRR##_num##H, \
&amp;UBRR##_num##L, \
&amp;UCSR##_num##A, \
&amp;UCSR##_num##B, \
U2X##_num, \
(_BV(RXEN##_num) | _BV(TXEN##_num) | _BV(RXCIE##_num)), \
(_BV(UDRIE##_num))); \
<a class="code" href="_fast_serial_8h.html#ab0863c843132b67a13d6a953a2dceae8">FastSerialHandler</a>(_num, \
USART##_num##_RX_vect, \
USART##_num##_UDRE_vect, \
UDR##_num, \
UCSR##_num##B, \
_BV(UDRIE##_num))
</pre></div>
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00221">221</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa5f40a33be03eb43f0e1f1a31df74989"></a><!-- doxytag: member="FastSerial.h::FastSerialPort0" ref="aa5f40a33be03eb43f0e1f1a31df74989" args="(_portName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FastSerialPort0</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_portName</td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00245">245</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="a949c2517a50e34ee121c1fea9cb15b64"></a><!-- doxytag: member="FastSerial.h::FastSerialPort1" ref="a949c2517a50e34ee121c1fea9cb15b64" args="(_portName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FastSerialPort1</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_portName</td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 1)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00246">246</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae93a07eece1f83c892496f5c6ef3e60e"></a><!-- doxytag: member="FastSerial.h::FastSerialPort2" ref="ae93a07eece1f83c892496f5c6ef3e60e" args="(_portName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FastSerialPort2</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_portName</td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 2)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00247">247</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9da84dd26ddee4197fcd3536d416b964"></a><!-- doxytag: member="FastSerial.h::FastSerialPort3" ref="a9da84dd26ddee4197fcd3536d416b964" args="(_portName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FastSerialPort3</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">_portName</td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;FastSerialPort(_portName, 3)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00248">248</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
</div>
</div>
<a class="anchor" id="a303b63294d669d2c5a269c92bdb700d5"></a><!-- doxytag: member="FastSerial.h::HardwareSerial_h" ref="a303b63294d669d2c5a269c92bdb700d5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define HardwareSerial_h</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00049">49</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="ad2687d3a6a3d7444849df9edc5597f6b"></a><!-- doxytag: member="FastSerial.h::__FastSerial__rxBuffer" ref="ad2687d3a6a3d7444849df9edc5597f6b" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_fast_serial_1_1_buffer.html">FastSerial::Buffer</a> <a class="el" href="_fast_serial_8h.html#ad2687d3a6a3d7444849df9edc5597f6b">__FastSerial__rxBuffer</a>[]</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00046">46</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a50dd604252dbc7918b4da78e2229e0ce"></a><!-- doxytag: member="FastSerial.h::__FastSerial__txBuffer" ref="a50dd604252dbc7918b4da78e2229e0ce" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_fast_serial_1_1_buffer.html">FastSerial::Buffer</a> <a class="el" href="_fast_serial_8h.html#a50dd604252dbc7918b4da78e2229e0ce">__FastSerial__txBuffer</a>[]</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00047">47</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8e6f49b84135f0158fe250cb7338ddad"></a><!-- doxytag: member="FastSerial.h::Serial" ref="a8e6f49b84135f0158fe250cb7338ddad" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">class <a class="el" href="class_fast_serial.html">FastSerial</a> <a class="el" href="_fast_serial_8h.html#a8e6f49b84135f0158fe250cb7338ddad">Serial</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad8026a4f12a38f848340968d0db7b4fd"></a><!-- doxytag: member="FastSerial.h::Serial1" ref="ad8026a4f12a38f848340968d0db7b4fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">class <a class="el" href="class_fast_serial.html">FastSerial</a> <a class="el" href="_fast_serial_8h.html#ad8026a4f12a38f848340968d0db7b4fd">Serial1</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aab2db3cc91ed9cc8e13464e176fd05c4"></a><!-- doxytag: member="FastSerial.h::Serial2" ref="aab2db3cc91ed9cc8e13464e176fd05c4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">class <a class="el" href="class_fast_serial.html">FastSerial</a> <a class="el" href="_fast_serial_8h.html#aab2db3cc91ed9cc8e13464e176fd05c4">Serial2</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a86283126649840a9437389a9bd8e5448"></a><!-- doxytag: member="FastSerial.h::Serial3" ref="a86283126649840a9437389a9bd8e5448" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">class <a class="el" href="class_fast_serial.html">FastSerial</a> <a class="el" href="_fast_serial_8h.html#a86283126649840a9437389a9bd8e5448">Serial3</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated for ArduPilot Libraries by&nbsp;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a></small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink