elua/inc/xmodem.h

/*! \file xmodem.h \brief XModem Transmit/Receive Implementation with CRC and 1K support. */
//*****************************************************************************
//
// File Name  : 'xmodem.h'
// Title    : XModem Transmit/Receive Implementation with CRC and 1K support
// Author     : Pascal Stang - Copyright (C) 2006
// Created    : 4/22/2006
// Revised    : 7/22/2006
// Version    : 0.1
// Target MCU   : AVR processors
// Editor Tabs  : 4
//
///   \ingroup general
/// \defgroup xmodem XModem Transmit/Receive Implementation with CRC and 1K support (xmodem.c)
/// \code #include "xmodem.h" \endcode
/// \par Overview
///     This XModem implementation supports both 128b and 1K packets with or
///     without CRC checking.  The xmodem library must be initialized to use
///     a particular I/O stream by passing appropriate getbyte() and sendbyte()
///     functions to xmodemInit().  The xmodem transfer routines also expect
///     function pointers to read and write data blocks on the local system.
///     While this use of function pointers increases code size, it has great
///     adaptability.  The generalized read/write data functions mean that it
///     is easy to pipe data to/from any storage device like EEPROMs or flash
///     cards, rather than being limited to just processor RAM.
//
// This code is distributed under the GNU Public License
//    which can be found at http://www.gnu.org/licenses/gpl.txt
//
//*****************************************************************************
// Modified by BogdanM for the eLua project
//*****************************************************************************
//@{

#ifndef XMODEM_H
#define XMODEM_H

#include "type.h"

// XMODEM constants
#define XMODEM_INITIAL_BUFFER_SIZE    1024
#define XMODEM_INCREMENT_AMMOUNT      512
#define XMODEM_BUFFER_SIZE            128

#define SOH       0x01
#define STX       0x02
#define EOT       0x04
#define ACK       0x06
#define NAK       0x15
#define XMODEM_CAN  0x18
#define CTRLZ     0x1A

// xmodem timeout/retry parameters
#define XMODEM_TIMEOUT_DELAY  1000000
#define XMODEM_RETRY_LIMIT    16

// error return codes
#define XMODEM_ERROR_REMOTECANCEL (-1)
#define XMODEM_ERROR_OUTOFSYNC    (-2)
#define XMODEM_ERROR_RETRYEXCEED  (-3)
#define XMODEM_ERROR_OUTOFMEM     (-4)

// Send/recv functions
typedef void ( *p_xm_send_func )( u8 );
typedef int ( *p_xm_recv_func )( u32 );

//! xmodem receive
long xmodem_receive( char** dest );

//! initialize xmodem stream I/O routines
void xmodem_init( p_xm_send_func send_func, p_xm_recv_func recv_func );

#endif // #ifndef XMODEM_H

//@}