firmware.h File Reference

#include "xbee/xmodem.h"

Go to the source code of this file.

Data Structures
struct	xbee_fw_oem_state_t
struct	xbee_fw_source_t
struct	xbee_fw_buffer_t

Macros
#define	XBEE_FW_LOAD_TIMEOUT   5000
#define	xbee_fw_install_hcs08_state(source)   xbee_fw_install_ebl_state( source)
	See documentation for xbee_fw_install_ebl_state().
#define	xbee_fw_status_hcs08(source, buff)   xbee_fw_status_ebl( source, buff)
	See documentation for xbee_fw_status_ebl().

Functions
int	xbee_fw_install_init (xbee_dev_t *xbee, const wpan_address_t FAR *target, xbee_fw_source_t *source)
	Prepare to install new firmware on an attached XBee module. More...
int	xbee_fw_install_ebl_tick (xbee_fw_source_t *source)
	Drive the firmware update process for boards that use .EBL/.GBL files to store their firmware. More...
unsigned int	xbee_fw_install_ebl_state (xbee_fw_source_t *source)
	Returns a unique value indicating the state of the .EBL/.GBL install process. More...
char FAR *	xbee_fw_status_ebl (xbee_fw_source_t *source, char FAR *buffer)
	Update \a buffer with the current install status of \a source. More...
int	xbee_fw_install_hcs08_tick (xbee_fw_source_t *source)
	Drive the firmware update process for the HCS08 application on Programmable XBee modules. More...
int	xbee_fw_install_oem_tick (xbee_fw_source_t *source)
	Install the firmware image stored in source. More...
char FAR *	xbee_fw_status_oem (xbee_fw_source_t *source, char FAR *buffer)
	Update buffer with the current install status of source. More...
int	xbee_fw_buffer_init (xbee_fw_buffer_t *fw, uint32_t length, const char FAR *address)
	Helper function for setting up an xbee_fw_buffer_t for use with a source firmware image held entirely in a buffer. More...

Detailed Description

Todo:

Create typedefs for xbee_fw_source_t read() and seek() handlers, write documentation including what the return values are.

We will have to check existing functions to confirm the API, but I'm guessing <0 for error, >=0 for number of bytes read. Make sure calls to the read() function check for errors! _xbee_oem_verify() does not!