?lang_form? ?lang_select? ?lang_submit? ?lang_endform?
{HEADER END}
{BLAME START}

library

?curdirlinks? -

Blame information for rev 6

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: xmodem.h Source File</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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
8 <h1>xmodem.h</h1><a href="xmodem_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file xmodem.h \brief XModem Transmit/Receive Implementation with CRC and 1K support. */</span>
9 00002 <span class="comment">//*****************************************************************************</span>
10 00003 <span class="comment">//</span>
11 00004 <span class="comment">// File Name : 'xmodem.h'</span>
12 00005 <span class="comment">// Title : XModem Transmit/Receive Implementation with CRC and 1K support</span>
13 00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2006</span>
14 00007 <span class="comment">// Created : 4/22/2006</span>
15 00008 <span class="comment">// Revised : 7/22/2006</span>
16 00009 <span class="comment">// Version : 0.1</span>
17 00010 <span class="comment">// Target MCU : AVR processors</span>
18 00011 <span class="comment">// Editor Tabs : 4</span>
19 00012 <span class="comment">//</span><span class="comment"></span>
20 00013 <span class="comment">/// \ingroup general</span>
21 00014 <span class="comment">/// \defgroup xmodem XModem Transmit/Receive Implementation with CRC and 1K support (xmodem.c)</span>
22 00015 <span class="comment">/// \code #include "xmodem.h" \endcode</span>
23 00016 <span class="comment">/// \par Overview</span>
24 00017 <span class="comment">/// This XModem implementation supports both 128b and 1K packets with or</span>
25 00018 <span class="comment">/// without CRC checking. The xmodem library must be initialized to use</span>
26 00019 <span class="comment">/// a particular I/O stream by passing appropriate getbyte() and sendbyte()</span>
27 00020 <span class="comment">/// functions to xmodemInit(). The xmodem transfer routines also expect</span>
28 00021 <span class="comment">/// function pointers to read and write data blocks on the local system.</span>
29 00022 <span class="comment">/// While this use of function pointers increases code size, it has great</span>
30 00023 <span class="comment">/// adaptability. The generalized read/write data functions mean that it</span>
31 00024 <span class="comment">/// is easy to pipe data to/from any storage device like EEPROMs or flash</span>
32 00025 <span class="comment">/// cards, rather than being limited to just processor RAM.</span>
33 00026 <span class="comment"></span><span class="comment">//</span>
34 00027 <span class="comment">// This code is distributed under the GNU Public License</span>
35 00028 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span>
36 00029 <span class="comment">//</span>
37 00030 <span class="comment">//*****************************************************************************</span><span class="comment"></span>
38 00031 <span class="comment">//@{</span>
39 00032 <span class="comment"></span>
40 00033 <span class="preprocessor">#ifndef XMODEM_H</span>
41 00034 <span class="preprocessor"></span><span class="preprocessor">#define XMODEM_H</span>
42 00035 <span class="preprocessor"></span>
43 00036 <span class="comment">// xmodem control characters</span>
44 00037 <span class="preprocessor">#define SOH 0x01</span>
45 00038 <span class="preprocessor"></span><span class="preprocessor">#define STX 0x02</span>
46 00039 <span class="preprocessor"></span><span class="preprocessor">#define EOT 0x04</span>
47 00040 <span class="preprocessor"></span><span class="preprocessor">#define ACK 0x06</span>
48 00041 <span class="preprocessor"></span><span class="preprocessor">#define NAK 0x15</span>
49 00042 <span class="preprocessor"></span><span class="preprocessor">#define CAN 0x18</span>
50 00043 <span class="preprocessor"></span><span class="preprocessor">#define CTRLZ 0x1A</span>
51 00044 <span class="preprocessor"></span>
52 00045 <span class="comment">// xmodem timeout/retry parameters</span>
53 00046 <span class="preprocessor">#define XMODEM_TIMEOUT_DELAY 1000</span>
54 00047 <span class="preprocessor"></span><span class="preprocessor">#define XMODEM_RETRY_LIMIT 16</span>
55 00048 <span class="preprocessor"></span>
56 00049 <span class="comment">// error return codes</span>
57 00050 <span class="preprocessor">#define XMODEM_ERROR_REMOTECANCEL -1</span>
58 00051 <span class="preprocessor"></span><span class="preprocessor">#define XMODEM_ERROR_OUTOFSYNC -2</span>
59 00052 <span class="preprocessor"></span><span class="preprocessor">#define XMODEM_ERROR_RETRYEXCEED -3</span>
60 00053 <span class="preprocessor"></span>
61 00054 <span class="comment"></span>
62 00055 <span class="comment">//! initialize xmodem stream I/O routines</span>
63 00056 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group__xmodem.html#ga0">xmodemInit</a>(<span class="keywordtype">void</span> (*sendbyte_func)(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c), <span class="keywordtype">int</span> (*getbyte_func)(<span class="keywordtype">void</span>));
64 00057 <span class="comment"></span>
65 00058 <span class="comment">//! xmodem receive</span>
66 00059 <span class="comment"></span><span class="keywordtype">long</span> <a class="code" href="group__xmodem.html#ga1">xmodemReceive</a>( <span class="keywordtype">int</span> (*write)(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> size) );
67 00060 <span class="comment"></span>
68 00061 <span class="comment">//! xmodem transmit</span>
69 00062 <span class="comment"></span><span class="keywordtype">long</span> <a class="code" href="group__xmodem.html#ga2">xmodemTransmit</a>( <span class="keywordtype">int</span> (*read)(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> size) );
70 00063 <span class="comment"></span>
71 00064 <span class="comment">//! xmodem CRC/checksum error checking</span>
72 00065 <span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="group__xmodem.html#ga3">xmodemCrcCheck</a>(<span class="keywordtype">int</span> crcflag, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> size);
73 00066
74 00067 <span class="comment">// extra stream I/O functions</span><span class="comment"></span>
75 00068 <span class="comment">//! get incoming character (wait for timeout)</span>
76 00069 <span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="group__xmodem.html#ga4">xmodemInTime</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> timeout);
77 00070 <span class="comment"></span>
78 00071 <span class="comment">//! flush incoming character stream</span>
79 00072 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group__xmodem.html#ga5">xmodemInFlush</a>(<span class="keywordtype">void</span>);
80 00073
81 00074 <span class="preprocessor">#endif</span>
82 00075 <span class="preprocessor"></span><span class="comment"></span>
83 00076 <span class="comment">//@}</span>
84 </span></pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by&nbsp;
85 <a href="http://www.doxygen.org/index.html">
86 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
87 </body>
88 </html>
{BLAME END}
{FOOTER START}

Powered by WebSVN v2.8.3