Application Parser Interface#
Application interface for the bootloader image parser.
The Parser Interface can be used to parse upgrade images from the context of the application.
Modules#
Typedefs#
Bootloader parser callback.
Functions#
Initialize the image parser.
Parse a buffer.
Parse a buffer and get application and bootloader upgrade metadata from the buffer.
Find the size of the context struct BootloaderParserContext used by the bootloader image parser to store parser state.
Typedef Documentation#
BootloaderParserCallback_t#
typedef void(* BootloaderParserCallback_t) (uint32_t address, uint8_t *data, size_t length, void *context) )(uint32_t address, uint8_t *data, size_t length, void *context)
Bootloader parser callback.
N/A | address | Address of the data |
N/A | data | Raw data |
N/A | length | Size in bytes of raw data. |
N/A | context | A context variable defined by the implementation that is implementing this callback. |
48
of file platform/bootloader/api/btl_interface_parser.h
Function Documentation#
bootloader_initParser#
int32_t bootloader_initParser (BootloaderParserContext_t * context, size_t contextSize)
Initialize the image parser.
[in] | context | Pointer to the parser context struct. |
[in] | contextSize | Size of the context struct. |
Returns
BOOTLOADER_OK if success, BOOTLOADER_ERROR_PARSE_CONTEXT if context struct is too small.
77
of file platform/bootloader/api/btl_interface_parser.h
bootloader_parseBuffer#
int32_t bootloader_parseBuffer (BootloaderParserContext_t * context, BootloaderParserCallbacks_t * callbacks, uint8_t data, size_t numBytes)
Parse a buffer.
[in] | context | Pointer to the parser context struct. |
[in] | callbacks | Callbacks to be called by the parser. |
[in] | data | Data to be parsed. |
[in] | numBytes | Size of the data buffer. |
Returns
BOOTLOADER_ERROR_PARSE_CONTINUE if the chunk was parsed correctly, and a new chunk is expected. BOOTLOADER_ERROR_PARSE_ERROR if something went wrong while parsing. BOOTLOADER_ERROR_PARSE_SUCCESS if the entire file was successfully parsed.
93
of file platform/bootloader/api/btl_interface_parser.h
bootloader_parseImageInfo#
int32_t bootloader_parseImageInfo (BootloaderParserContext_t * context, uint8_t data, size_t numBytes, ApplicationData_t * appInfo, uint32_t * bootloaderVersion)
Parse a buffer and get application and bootloader upgrade metadata from the buffer.
[in] | context | Pointer to the parser context struct. |
[in] | data | Data to be parsed. |
[in] | numBytes | Size of the data buffer. |
[out] | appInfo | Pointer to ApplicationData_t struct. |
[out] | bootloaderVersion | Pointer to an integer representing bootloader version. |
Note
appInfo
andbootloaderVersion
will default to zeros.
Returns
BOOTLOADER_OK if metadata was filled successfully.
115
of file platform/bootloader/api/btl_interface_parser.h
bootloader_parserContextSize#
uint32_t bootloader_parserContextSize (void )
Find the size of the context struct BootloaderParserContext used by the bootloader image parser to store parser state.
N/A |
Returns
size of BootloaderParserContext, returns 0 if something went wrong.
133
of file platform/bootloader/api/btl_interface_parser.h