Project

General

Profile

Revision 497

Added by Kevin Woo about 16 years ago

Updated the documentation for libdragonfly.

View differences:

serial_8h-source.html
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 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
12 13 
    <li class="current"><a href="files.html"><span>Files</span></a></li>
13 14 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14 15 
  </ul>
15 16 
</div>
16 17 
<h1>serial.h</h1><a href="serial_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
17 18 
<a name="l00038"></a>00038 <span class="comment">/*</span>
18 
<a name="l00039"></a>00039 <span class="comment">        serial.h - Contains definitions and function prototypes for the RS232 serial port</span>
19 
<a name="l00039"></a>00039 <span class="comment">  serial.h - Contains definitions and function prototypes for the RS232 serial port</span>
19 20 
<a name="l00040"></a>00040 <span class="comment">  author(s): pkv</span>
20 21 
<a name="l00041"></a>00041 <span class="comment">  </span>
21 22 
<a name="l00042"></a>00042 <span class="comment">  Directions:</span>
......
24 25 
<a name="l00045"></a>00045 <span class="comment">  write characters to the serial ports.</span>
25 26 
<a name="l00046"></a>00046 <span class="comment">  </span>
26 27 
<a name="l00047"></a>00047 <span class="comment">  UART Mapping:</span>
27 
<a name="l00048"></a>00048 <span class="comment">    usb_*() -&gt; UART0</span>
28 
<a name="l00049"></a>00049 <span class="comment">    xbee_*() -&gt; UART1</span>
28 
<a name="l00048"></a>00048 <span class="comment">  usb_*() -&gt; UART0</span>
29 
<a name="l00049"></a>00049 <span class="comment">  xbee_*() -&gt; UART1</span>
29 30 
<a name="l00050"></a>00050 <span class="comment">  </span>
30 31 
<a name="l00051"></a>00051 <span class="comment">  Options: (Add the following defines to your code to configure this library)</span>
31 
<a name="l00052"></a>00052 <span class="comment">    #define USB_BAUD { 115200 | 9600 } &lt;= pick ONE value from in here</span>
32 
<a name="l00053"></a>00053 <span class="comment">    #define XBEE_BAUD { 115200 | 9600 } &lt;= pick ONE value from in here</span>
33 
<a name="l00054"></a>00054 <span class="comment">    #define USE_STDIO</span>
32 
<a name="l00052"></a>00052 <span class="comment">  #define USB_BAUD { 115200 | 9600 } &lt;= pick ONE value from in here</span>
33 
<a name="l00053"></a>00053 <span class="comment">  #define XBEE_BAUD { 115200 | 9600 } &lt;= pick ONE value from in here</span>
34 
<a name="l00054"></a>00054 <span class="comment">  #define USE_STDIO</span>
34 35 
<a name="l00055"></a>00055 <span class="comment">  </span>
35 36 
<a name="l00056"></a>00056 <span class="comment">  Note: If you enable USE_STDIO, the first init function that is called will </span>
36 37 
<a name="l00057"></a>00057 <span class="comment">  automatically be linked to stdin, stdout, and stderr.  To use the baud rate </span>
......
77 78 
<a name="l00128"></a>00128
78 79 
<a name="l00129"></a>00129 <span class="preprocessor">#endif</span>
79 80 
<a name="l00130"></a>00130 <span class="preprocessor"></span>
80 
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by&nbsp;
81 
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:38 2008 for libdragonfly by&nbsp;
81 82 
<a href="http://www.doxygen.org/index.html">
82 83 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
83 84 
</body>

Also available in: Unified diff