📄 uart2_8h-source.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Procyon AVRlib: uart2.h Source File</title><link href="dox.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.6 --><div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>uart2.h</h1><a href="uart2_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*! \file uart2.h \brief Dual UART driver with buffer support. */</span>00002 <span class="comment">//*****************************************************************************</span>00003 <span class="comment">//</span>00004 <span class="comment">// File Name : 'uart2.h'</span>00005 <span class="comment">// Title : Dual UART driver with buffer support</span>00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2000-2002</span>00007 <span class="comment">// Created : 11/20/2000</span>00008 <span class="comment">// Revised : 07/04/2004</span>00009 <span class="comment">// Version : 1.0</span>00010 <span class="comment">// Target MCU : ATMEL AVR Series</span>00011 <span class="comment">// Editor Tabs : 4</span>00012 <span class="comment">//</span>00013 <span class="comment">// Description : This is a UART driver for AVR-series processors with two</span>00014 <span class="comment">// hardware UARTs such as the mega161 and mega128 </span>00015 <span class="comment">//</span>00016 <span class="comment">// This code is distributed under the GNU Public License</span>00017 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span>00018 <span class="comment">//</span>00019 <span class="comment">//*****************************************************************************</span>00020 00021 <span class="preprocessor">#ifndef UART2_H</span>00022 <span class="preprocessor"></span><span class="preprocessor">#define UART2_H</span>00023 <span class="preprocessor"></span>00024 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span>00025 <span class="preprocessor">#include "<a class="code" href="buffer_8h.html">buffer.h</a>"</span>00026 00027 <span class="comment">// default baud rate</span>00028 <span class="comment">// can be changed by using uartSetBaudRate()</span><a name="l00029"></a><a class="code" href="uart2_8h.html#a0">00029</a> <span class="preprocessor">#define UART0_DEFAULT_BAUD_RATE 9600 </span><span class="comment">///< default baud rate for UART0</span><a name="l00030"></a><a class="code" href="uart2_8h.html#a1">00030</a> <span class="comment"></span>#define UART1_DEFAULT_BAUD_RATE 9600 <span class="comment">///< default baud rate for UART1</span>00031 <span class="comment"></span>00032 <span class="comment">// buffer memory allocation defines</span>00033 <span class="comment">// buffer sizes</span>00034 <span class="preprocessor">#ifndef UART0_TX_BUFFER_SIZE</span><a name="l00035"></a><a class="code" href="uart2_8h.html#a2">00035</a> <span class="preprocessor"></span><span class="preprocessor">#define UART0_TX_BUFFER_SIZE 0x0010 </span><span class="comment">///< number of bytes for uart0 transmit buffer</span>00036 <span class="comment"></span>#endif00037 <span class="preprocessor">#ifndef UART0_RX_BUFFER_SIZE</span><a name="l00038"></a><a class="code" href="uart2_8h.html#a3">00038</a> <span class="preprocessor"></span><span class="preprocessor">#define UART0_RX_BUFFER_SIZE 0x0080 </span><span class="comment">///< number of bytes for uart0 receive buffer</span>00039 <span class="comment"></span>#endif00040 <span class="preprocessor">#ifndef UART1_TX_BUFFER_SIZE</span><a name="l00041"></a><a class="code" href="uart2_8h.html#a4">00041</a> <span class="preprocessor"></span><span class="preprocessor">#define UART1_TX_BUFFER_SIZE 0x0010 </span><span class="comment">///< number of bytes for uart1 transmit buffer</span>00042 <span class="comment"></span>#endif00043 <span class="preprocessor">#ifndef UART1_RX_BUFFER_SIZE</span><a name="l00044"></a><a class="code" href="uart2_8h.html#a5">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define UART1_RX_BUFFER_SIZE 0x0080 </span><span class="comment">///< number of bytes for uart1 receive buffer</span>00045 <span class="comment"></span>#endif00046 00047 <span class="comment">// define this key if you wish to use</span>00048 <span class="comment">// external RAM for the UART buffers</span>00049 <span class="comment">//#define UART_BUFFER_EXTERNAL_RAM</span>00050 <span class="preprocessor">#ifdef UART_BUFFER_EXTERNAL_RAM</span>00051 <span class="preprocessor"></span> <span class="comment">// absolute address of uart0 buffers</span>00052 <span class="preprocessor"> #define UART0_TX_BUFFER_ADDR 0x1000</span>00053 <span class="preprocessor"></span><span class="preprocessor"> #define UART0_RX_BUFFER_ADDR 0x1100</span>00054 <span class="preprocessor"></span> <span class="comment">// absolute address of uart1 buffers</span>00055 <span class="preprocessor"> #define UART1_TX_BUFFER_ADDR 0x1200</span>00056 <span class="preprocessor"></span><span class="preprocessor"> #define UART1_RX_BUFFER_ADDR 0x1300</span>00057 <span class="preprocessor"></span><span class="preprocessor">#endif</span>00058 <span class="preprocessor"></span>00059 <span class="comment">// type of interrupt handler to use</span>00060 <span class="comment">// *do not change unless you know what you're doing</span>00061 <span class="comment">// Value may be SIGNAL or INTERRUPT</span>00062 <span class="preprocessor">#ifndef UART_INTERRUPT_HANDLER</span>00063 <span class="preprocessor"></span><span class="preprocessor">#define UART_INTERRUPT_HANDLER SIGNAL</span>00064 <span class="preprocessor"></span><span class="preprocessor">#endif</span>00065 <span class="preprocessor"></span>00066 <span class="comment">// compatibility for the mega161</span>00067 <span class="preprocessor">#ifndef RXCIE</span>00068 <span class="preprocessor"></span><span class="preprocessor"> #define RXCIE RXCIE0</span>00069 <span class="preprocessor"></span><span class="preprocessor"> #define TXCIE TXCIE0</span>00070 <span class="preprocessor"></span><span class="preprocessor"> #define UDRIE UDRIE0</span>00071 <span class="preprocessor"></span><span class="preprocessor"> #define RXEN RXEN0</span>00072 <span class="preprocessor"></span><span class="preprocessor"> #define TXEN TXEN0</span>00073 <span class="preprocessor"></span><span class="preprocessor"> #define CHR9 CHR90</span>00074 <span class="preprocessor"></span><span class="preprocessor"> #define RXB8 RXB80</span>00075 <span class="preprocessor"></span><span class="preprocessor"> #define TXB8 TXB80</span>00076 <span class="preprocessor"></span><span class="preprocessor">#endif</span>00077 <span class="preprocessor"></span><span class="preprocessor">#ifndef UBRR0L</span>00078 <span class="preprocessor"></span><span class="preprocessor"> #define UBRR0L UBRR0</span>00079 <span class="preprocessor"></span><span class="preprocessor"> #define UBRR1L UBRR1</span>00080 <span class="preprocessor"></span><span class="preprocessor">#endif</span>00081 <span class="preprocessor"></span>00082 <span class="comment">// functions</span>00083 <span class="comment"></span>00084 <span class="comment">//! initializes both uarts</span>00085 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart_8c.html#a9">uartInit</a>(<span class="keywordtype">void</span>);00086 <span class="comment"></span>00087 <span class="comment">//! initializes UART0 only</span>00088 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart2_8c.html#a12">uart0Init</a>(<span class="keywordtype">void</span>);00089 <span class="comment"></span>00090 <span class="comment">//! initializes UART1 only</span>00091 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart2_8c.html#a13">uart1Init</a>(<span class="keywordtype">void</span>);00092 <span class="comment"></span>00093 <span class="comment">//! initializes transmit and receive buffers</span>00094 <span class="comment"></span><span class="comment">// called from uartInit()</span>00095 <span class="keywordtype">void</span> <a class="code" href="uart2_8c.html#a14">uart0InitBuffers</a>(<span class="keywordtype">void</span>);00096 <span class="keywordtype">void</span> uart1InitBuffers(<span class="keywordtype">void</span>);00097 <span class="comment"></span>00098 <span class="comment">//! redirects received data to a user function</span>00099 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart2_8h.html#a22">uartSetRxHandler</a>(u08 nUart, <span class="keywordtype">void</span> (*rx_func)(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c));00100 <span class="comment"></span>00101 <span class="comment">//! sets the uart baud rate</span>00102 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart2_8h.html#a23">uartSetBaudRate</a>(u08 nUart, u32 baudrate);00103 <span class="comment"></span>00104 <span class="comment">//! returns pointer to the receive buffer structure</span>00105 <span class="comment"></span>cBuffer* <a class="code" href="uart_8c.html#a13">uartGetRxBuffer</a>(u08 nUart);00106 <span class="comment"></span>00107 <span class="comment">//! returns pointer to the transmit buffer structure</span>00108 <span class="comment"></span>cBuffer* <a class="code" href="uart_8c.html#a14">uartGetTxBuffer</a>(u08 nUart);00109 <span class="comment"></span>00110 <span class="comment">//! sends a single byte over the uart</span>00111 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart2_8h.html#a26">uartSendByte</a>(u08 nUart, u08 data);<span class="comment"></span>00112 <span class="comment">//! SendByte commands with the UART number hardcoded</span>00113 <span class="comment"></span><span class="comment">// use this with printfInit() - example: printfInit(uart0SendByte);</span>00114 <span class="keywordtype">void</span> <a class="code" href="uart2_8h.html#a27">uart0SendByte</a>(u08 data);00115 <span class="keywordtype">void</span> uart1SendByte(u08 data);00116 <span class="comment"></span>00117 <span class="comment">//! gets a single byte from the uart receive buffer (getchar-style)</span>00118 <span class="comment"></span><span class="comment">// returns the byte, or -1 if no byte is available</span>00119 <span class="keywordtype">int</span> <a class="code" href="uart2_8c.html#a23">uart0GetByte</a>(<span class="keywordtype">void</span>);00120 <span class="keywordtype">int</span> uart1GetByte(<span class="keywordtype">void</span>);00121 <span class="comment"></span>00122 <span class="comment">//! gets a single byte from the uart receive buffer</span>00123 <span class="comment"></span><span class="comment">// function returns TRUE if data was available, FALSE if not</span>00124 <span class="comment">// actual data is returned in variable pointed to by "data"</span>00125 <span class="comment">// example usage:</span>00126 <span class="comment">// char myReceivedByte;</span>00127 <span class="comment">// uartReceiveByte( &myReceivedByte );</span>00128 u08 <a class="code" href="uart2_8h.html#a31">uartReceiveByte</a>(u08 nUart, u08* data);00129 <span class="comment"></span>00130 <span class="comment">//! returns TRUE/FALSE if receive buffer is empty/not-empty</span>00131 <span class="comment"></span>u08 <a class="code" href="uart_8c.html#a19">uartReceiveBufferIsEmpty</a>(u08 nUart);00132 <span class="comment"></span>00133 <span class="comment">//! flushes (deletes) all data from receive buffer</span>00134 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart_8c.html#a18">uartFlushReceiveBuffer</a>(u08 nUart);00135 <span class="comment"></span>00136 <span class="comment">//! add byte to end of uart Tx buffer</span>00137 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart2_8h.html#a34">uartAddToTxBuffer</a>(u08 nUart, u08 data);<span class="comment"></span>00138 <span class="comment">//! AddToTxBuffer commands with the UART number hardcoded</span>00139 <span class="comment"></span><span class="comment">// use this with printfInit() - example: printfInit(uart0AddToTxBuffer);</span>00140 <span class="keywordtype">void</span> <a class="code" href="uart2_8h.html#a35">uart0AddToTxBuffer</a>(u08 data);00141 <span class="keywordtype">void</span> uart1AddToTxBuffer(u08 data);00142 <span class="comment"></span>00143 <span class="comment">//! begins transmission of the transmit buffer under interrupt control</span>00144 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart_8c.html#a21">uartSendTxBuffer</a>(u08 nUart);00145 <span class="comment"></span>00146 <span class="comment">//! sends a buffer of length nBytes via the uart using interrupt control</span>00147 <span class="comment"></span>u08 <a class="code" href="uart2_8h.html#a38">uartSendBuffer</a>(u08 nUart, <span class="keywordtype">char</span> *buffer, u16 nBytes);00148 <span class="comment"></span>00149 <span class="comment">//! interrupt service handlers</span>00150 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="uart2_8h.html#a39">uartTransmitService</a>(u08 nUart);00151 <span class="keywordtype">void</span> uartReceiveService(u08 nUart);00152 00153 <span class="preprocessor">#endif</span>00154 <span class="preprocessor"></span></pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Oct 15 03:50:22 2004 for Procyon AVRlib by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.6 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -