Application Parser InterfaceApplication Interface


Application interface for interfacing with the bootloader image parser.

The Parser Interface can be used to parse upgrade images from the context of the application.

Data Structures

struct  BootloaderParserCallbacks_t
 Function pointers to parser callbacks.


typedef void(* BootloaderParserCallback_t) (uint32_t address, uint8_t *data, size_t length, void *context)
typedef struct BootloaderParserContext BootloaderParserContext_t
 Context for the bootloader image parser routine.


int32_t bootloader_initParser (BootloaderParserContext_t *context, size_t contextSize)
int32_t bootloader_parseBuffer (BootloaderParserContext_t *context, BootloaderParserCallbacks_t *callbacks, uint8_t data[], size_t numBytes)

Typedef Documentation

typedef void(* BootloaderParserCallback_t) (uint32_t address, uint8_t *data, size_t length, void *context)

Bootloader parser callback

addressAddress of the data
dataRaw data
lengthSize in bytes of raw data.
ctxA context variable defined by the implementation that is implementing this callback.

Definition at line 48 of file btl_interface_parser.h.

Function Documentation

int32_t bootloader_initParser ( BootloaderParserContext_t context,
size_t  contextSize 

Initialize image parser

[in]contextPointer to parser context struct
[in]contextSizeSize of context struct
BOOTLOADER_OK if success, BOOTLOADER_ERROR_PARSE_CONTEXT if context struct is too small.
int32_t bootloader_parseBuffer ( BootloaderParserContext_t context,
BootloaderParserCallbacks_t callbacks,
uint8_t  data[],
size_t  numBytes 

Parse a buffer

[in]contextPointer to parser context struct
[in]callbacksCallbacks to be called by the parser
[in]dataData to be parsed
[in]numBytesSize of data buffer
BOOTLOADER_ERROR_PARSE_CONTINUE if the chunk was parsed correcly, and a new chunk is expected. BOOTLOADER_ERROR_PARSE_ERROR if something went wrong during parsing. BOOTLOADER_ERROR_PARSE_SUCCESS if the entire file was successfully parsed.