| Line No. | Rev | Author | Line |
|---|---|---|---|
| 1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
| 3 | <title>Procyon AVRlib: buffer.c File Reference</title> |
||
| 4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
| 5 | </head><body> |
||
| 6 | <!-- Generated by Doxygen 1.4.2 --> |
||
| 7 | <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="dirs.html">Directories</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> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
| 8 | <h1>buffer.c File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
| 9 | |||
| 10 | <p> |
||
| 11 | Definition in file <a class="el" href="buffer_8c-source.html">buffer.c</a>. |
||
| 12 | <p> |
||
| 13 | <code>#include "<a class="el" href="buffer_8h-source.html">buffer.h</a>"</code><br> |
||
| 14 | <code>#include "<a class="el" href="global_8h-source.html">global.h</a>"</code><br> |
||
| 15 | <code>#include "avr/io.h"</code><br> |
||
| 16 | |||
| 17 | <p> |
||
| 18 | <a href="buffer_8c-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
| 19 | <tr><td></td></tr> |
||
| 20 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
| 21 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="buffer.c::CRITICAL_SECTION_START"></a> |
||
| 22 | #define </td><td class="memItemRight" valign="bottom"><b>CRITICAL_SECTION_START</b> unsigned char _sreg = SREG; cli()</td></tr> |
||
| 23 | |||
| 24 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="buffer.c::CRITICAL_SECTION_END"></a> |
||
| 25 | #define </td><td class="memItemRight" valign="bottom"><b>CRITICAL_SECTION_END</b> SREG = _sreg</td></tr> |
||
| 26 | |||
| 27 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 28 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga1" doxytag="buffer.c::bufferInit"></a> |
||
| 29 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga1">bufferInit</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *buffer, unsigned char *start, unsigned short size)</td></tr> |
||
| 30 | |||
| 31 | <tr><td class="mdescLeft"> </td><td class="mdescRight">initialize a buffer to start at a given address and have given size <br></td></tr> |
||
| 32 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="buffer.c::bufferGetFromFront"></a> |
||
| 33 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga2">bufferGetFromFront</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *buffer)</td></tr> |
||
| 34 | |||
| 35 | <tr><td class="mdescLeft"> </td><td class="mdescRight">get the first byte from the front of the buffer <br></td></tr> |
||
| 36 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="buffer.c::bufferDumpFromFront"></a> |
||
| 37 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga3">bufferDumpFromFront</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *buffer, unsigned short numbytes)</td></tr> |
||
| 38 | |||
| 39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">dump (discard) the first numbytes from the front of the buffer <br></td></tr> |
||
| 40 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga4" doxytag="buffer.c::bufferGetAtIndex"></a> |
||
| 41 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga4">bufferGetAtIndex</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *buffer, unsigned short index)</td></tr> |
||
| 42 | |||
| 43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">get a byte at the specified index in the buffer (kind of like array access) <br></td></tr> |
||
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="buffer.c::bufferAddToEnd"></a> |
||
| 45 | unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga5">bufferAddToEnd</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *buffer, unsigned char data)</td></tr> |
||
| 46 | |||
| 47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">add a byte to the end of the buffer <br></td></tr> |
||
| 48 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="buffer.c::bufferIsNotFull"></a> |
||
| 49 | unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga6">bufferIsNotFull</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *buffer)</td></tr> |
||
| 50 | |||
| 51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">check if the buffer is full/not full (returns zero value if full) <br></td></tr> |
||
| 52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga7" doxytag="buffer.c::bufferFlush"></a> |
||
| 53 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__buffer.html#ga7">bufferFlush</a> (<a class="el" href="structstruct__cBuffer.html">cBuffer</a> *buffer)</td></tr> |
||
| 54 | |||
| 55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">flush (clear) the contents of the buffer <br></td></tr> |
||
| 56 | </table> |
||
| 57 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by |
||
| 58 | <a href="http://www.doxygen.org/index.html"> |
||
| 59 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 60 | </body> |
||
| 61 | </html> |
Powered by WebSVN v2.8.3