📄 uart_8h.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: uart.h File Reference</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>uart.h File Reference</h1>UART driver with buffer support. <a href="#_details">More...</a><p><code>#include "<a class="el" href="global_8h-source.html">global.h</a>"</code><br><code>#include "<a class="el" href="buffer_8h-source.html">buffer.h</a>"</code><br><p><a href="uart_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Defines</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a0">UART_DEFAULT_BAUD_RATE</a> 9600</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="uart.h::UART_TX_BUFFER_SIZE" ></a>#define </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a1">UART_TX_BUFFER_SIZE</a> 0x0040</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">number of bytes for uart transmit buffer <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="uart.h::UART_RX_BUFFER_SIZE" ></a>#define </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a2">UART_RX_BUFFER_SIZE</a> 0x0040</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">number of bytes for uart receive buffer <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="uart.h::UART_INTERRUPT_HANDLER" ></a>#define </td><td class="memItemRight" valign=bottom><b>UART_INTERRUPT_HANDLER</b> SIGNAL</td></tr><tr><td colspan=2><br><h2>Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="uart.h::uartInitBuffers" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a4">uartInitBuffers</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">initializes transmit and receive buffers <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="uart.h::uartInit" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a5">uartInit</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">initializes uart <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="uart.h::uartSetRxHandler" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a6">uartSetRxHandler</a> (void(*rx_func)(unsigned char c))</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">redirects received data to a user function <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="uart.h::uartSetBaudRate" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a7">uartSetBaudRate</a> (u32 baudrate)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the uart baud rate <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="uart.h::uartGetRxBuffer" ></a>cBuffer * </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a8">uartGetRxBuffer</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns pointer to the receive buffer structure <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="uart.h::uartGetTxBuffer" ></a>cBuffer * </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a9">uartGetTxBuffer</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns pointer to the transmit buffer structure <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="uart.h::uartSendByte" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a10">uartSendByte</a> (u08 data)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sends a single byte over the uart <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="uart.h::uartGetByte" ></a>int </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a11">uartGetByte</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">gets a single byte from the uart receive buffer (getchar-style) <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="uart.h::uartReceiveByte" ></a>u08 </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a12">uartReceiveByte</a> (u08 *data)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">gets a single byte from the uart receive buffer <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="uart.h::uartReceiveBufferIsEmpty" ></a>u08 </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a13">uartReceiveBufferIsEmpty</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns TRUE/FALSE if receive buffer is empty/not-empty <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a14" doxytag="uart.h::uartFlushReceiveBuffer" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a14">uartFlushReceiveBuffer</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">flushes (deletes) all data from receive buffer <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a15" doxytag="uart.h::uartAddToTxBuffer" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a15">uartAddToTxBuffer</a> (u08 data)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">add byte to end of uart Tx buffer <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a16" doxytag="uart.h::uartSendTxBuffer" ></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a16">uartSendTxBuffer</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">begins transmission of the transmit buffer under interrupt control <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a17" doxytag="uart.h::uartSendBuffer" ></a>u08 </td><td class="memItemRight" valign=bottom><a class="el" href="uart_8h.html#a17">uartSendBuffer</a> (char *buffer, u16 nBytes)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sends a buffer of length nBytes via the uart using interrupt control <br><br></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>UART driver with buffer support. <p><p>Definition in file <a class="el" href="uart_8h-source.html">uart.h</a>.<hr><h2>Define Documentation</h2><a class="anchor" name="a0" doxytag="uart.h::UART_DEFAULT_BAUD_RATE" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define UART_DEFAULT_BAUD_RATE 9600 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>default baud rate can be changed by using <a class="el" href="uart_8c.html#a12">uartSetBaudRate()</a> <p>Definition at line <a class="el" href="uart_8h-source.html#l00026">26</a> of file <a class="el" href="uart_8h-source.html">uart.h</a>.<p>Referenced by <a class="el" href="uart_8c-source.html#l00045">uartInit()</a>. </td> </tr></table><hr size="1"><address style="align: right;"><small>Generated on Fri Oct 15 03:50:23 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 + -