roboot/boot/xmodem.h

Go to the documentation of this file.

#ifndef XMODEM_H_
#define XMODEM_H_
/* ================================================================================ *//* ================================================================================= */


#include <stdint.h>

// 1024b for Xmodem 1K
// 128 bytes for Xmodem std.
#define XMODEM_BUFFER_SIZE          1024


#define XMODEM_TRANSMISSION_OK      0

// error return codes
#define XMODEM_ERROR_REMOTECANCEL   -1
#define XMODEM_ERROR_OUTOFSYNC      -2
#define XMODEM_ERROR_RETRYEXCEED    -3
#define XMODEM_ERROR_DATAPROCESSING -4


// xmodem timeout/retry parameters
// 1s default timeout
#define XMODEM_TIMEOUT_DELAY        10
#define XMODEM_FLUSH_TIMEOUT        1
#define XMODEM_RETRY_LIMIT          6

// initialize xmodem stream I/O routines
void xmodemInit(uint8_t *buf, void (*sendbyte_func)(uint8_t c), int16_t (*getbyte_func)(void));

// xmodem receive
int8_t xmodemReceive(int8_t (*process_packet)(uint32_t size, uint8_t **new_buf));


#endif // XMODEM_H_

---