xmodem.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2019 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc., 9350 Excelsior Blvd., Suite 700, Hopkins, MN 55343
 * ===========================================================================
 */

#ifndef __XBEE_XMODEM
#define __XBEE_XMODEM

#include "xbee/platform.h"
#include "xbee/device.h"

XBEE_BEGIN_DECLS

#define XMODEM_NAK   0x15

#define XMODEM_CRC   'C'

#define XMODEM_SOH   0x01

#define XMODEM_STX   0x02

#define XMODEM_ACK   0x06

#define XMODEM_CAN   0x18

#define XMODEM_EOT   0x04     // end of transmission

typedef int (*xbee_xmodem_read_fn)( void FAR * context,
                                          void FAR *buffer, int16_t bytes);

typedef int (*xbee_xmodem_write_fn)( void FAR * context,
                                       const void FAR *buffer, int16_t bytes);

enum xbee_xmodem_state {
   XBEE_XMODEM_STATE_FLUSH,      
   XBEE_XMODEM_STATE_START,      
   XBEE_XMODEM_STATE_SEND,       
   XBEE_XMODEM_STATE_RESEND,     
   XBEE_XMODEM_STATE_SENDING,    
   XBEE_XMODEM_STATE_WAIT_ACK,   
   XBEE_XMODEM_STATE_EOF,        
   XBEE_XMODEM_STATE_FINAL_ACK,  
   XBEE_XMODEM_STATE_SUCCESS,    
   XBEE_XMODEM_STATE_FAILURE,    
};

typedef struct xbee_xmodem_state_t
{
   uint16_t                   flags;
      #define XBEE_XMODEM_FLAG_NONE       0x0000
      #define XBEE_XMODEM_FLAG_CHECKSUM   0x0001
      #define XBEE_XMODEM_FLAG_CRC        0x0002
      #define XBEE_XMODEM_FLAG_FORCE_CRC  0x0008
      #define XBEE_XMODEM_MASK_BLOCKSIZE  0x0300
      #define XBEE_XMODEM_FLAG_128        0x0000
      #define XBEE_XMODEM_FLAG_64         0x0100
      #define XBEE_XMODEM_FLAG_1K         0x0200
      #define XBEE_XMODEM_FLAG_1024       XBEE_XMODEM_FLAG_1K
#ifdef XBEE_XMODEM_TESTING
      // Macros for testing both sides of the xmodem transfer code
      #define XBEE_XMODEM_FLAG_DROP_ACK         0x1000
      #define XBEE_XMODEM_FLAG_DROP_FRAME       0x2000
      #define XBEE_XMODEM_FLAG_BAD_CRC          0x4000
      #define XBEE_XMODEM_FLAG_RESTORE_CRC      0x8000
#endif

      #define XBEE_XMODEM_FLAG_USER       \
         (XBEE_XMODEM_MASK_BLOCKSIZE | XBEE_XMODEM_FLAG_FORCE_CRC)

   uint16_t                   packet_num;

   uint16_t                   timer;

   enum xbee_xmodem_state     state;      
   uint_fast8_t               tries;      
   int                        offset;     
   char                 FAR   *buffer;    
   struct {
      xbee_xmodem_read_fn     read;       
      void              FAR   *context;   
   } file;     
   struct {
      xbee_xmodem_read_fn     read;       
      xbee_xmodem_write_fn    write;      
      void              FAR   *context;   
   } stream;   
} xbee_xmodem_state_t;

int xbee_xmodem_use_serport( xbee_xmodem_state_t *xbxm, xbee_serial_t *serport);

int xbee_xmodem_set_source( xbee_xmodem_state_t *xbxm,
   void FAR *buffer, xbee_xmodem_read_fn read, const void FAR *context);

int xbee_xmodem_set_stream( xbee_xmodem_state_t *xbxm,
   xbee_xmodem_read_fn read, xbee_xmodem_write_fn write,
   const void FAR *context);

int xbee_xmodem_tx_init( xbee_xmodem_state_t *xbxm, uint16_t flags);

int xbee_xmodem_tx_tick( xbee_xmodem_state_t *xbxm);

XBEE_END_DECLS

// If compiling in Dynamic C, automatically #use the appropriate C file.
#ifdef __DC__
   #use "xbee_xmodem.c"
#endif

#endif