GBL Parser#

GblParserState_t#

GblParserState_t

State in the GBL parser state machine.

gbl_getTagParsingInfoFromTagId#

const GblTagParsingInfo_t * gbl_getTagParsingInfoFromTagId (uint32_t tagId)

Function for looking up and retrieving the parsing information struct associated with a particular GBL tag type / tag ID.

Returns

• A pointer to the GblTagParsingInfo_t struct associated with tagId, or a NULL pointer if the provided tagId cannot be found.

parser_init#

int32_t parser_init (void * context, void * decryptContext, void * authContext, uint8_t flags)

Initialize the parser's context.

Returns

• BOOTLOADER_OK if OK, error code otherwise.

parser_parse#

int32_t parser_parse (void * context, ImageProperties_t * imageProperties, uint8_t buffer, size_t length, const BootloaderParserCallbacks_t * callbacks)

Parse an image file to extract the binary and some metadata.

Pushes data into the image file parser to be parsed.

Returns

• BOOTLOADER_OK if OK, error code otherwise.

parser_verifyCertificate#

int32_t parser_verifyCertificate (void * context, void * input, void * blProperties, void * shaState)

Verify the GBL certificate.

Note

• The behavior of this function depends on the context state.

Returns

• BOOTLOADER_ERROR_PARSER_PARSED if done parsing the current input buffer. BOOTLOADER_OK if input data is stored in the internal buffer. BOOTLOADER_OK if the certificate in GBL is accepted. BOOTLOADER_ERROR_PARSER_SIGNATURE if the certificate in GBL is rejected.

gbl_writeProgData#

int32_t gbl_writeProgData (ParserContext_t * context, uint8_t buffer, size_t length, const BootloaderParserCallbacks_t * callbacks)

Write application data.

This function is called when parsing any tag with GblProg_t structured content.

Returns

• Error code

gbl_getData#

int32_t gbl_getData (ParserContext_t * context, GblInputBuffer_t * input, uint8_t outputBuffer, size_t outputLength, bool applySHA, bool decrypt)

Get data from storage and internal input buffer.

This function advances the parser state.

Returns

• Error code

PARSER_FLAG_ENCRYPTED#

#define PARSER_FLAG_ENCRYPTED

(1U << 0U)

GBL file is encrypted.

PARSER_FLAG_PARSE_CUSTOM_TAGS#

#define PARSER_FLAG_PARSE_CUSTOM_TAGS

(1U << 5U)

Parse custom tags rather than silently traversing them.

PARSER_FLAGS_PUBLIC_MASK#

#define PARSER_FLAGS_PUBLIC_MASK

PARSER_FLAG_PARSE_CUSTOM_TAGS

Some flags are public, some are internal to the parser.

GBL_PARSER_BUFFER_SIZE#

#define GBL_PARSER_BUFFER_SIZE

64UL

GBL parser buffer size.

PARSER_REQUIRE_AUTHENTICITY#

#define PARSER_REQUIRE_AUTHENTICITY

(false)

Bootloader/parser configurations.

Parser requires upgrade images to be signed, providing authenticity, if true.

PARSER_REQUIRE_CONFIDENTIALITY#

#define PARSER_REQUIRE_CONFIDENTIALITY

(false)

Parser requires upgrade images to be encrypted, providing confidentiality, if true.

PARSER_REQUIRE_CERTIFICATE_AUTHENTICITY#

#define PARSER_REQUIRE_CERTIFICATE_AUTHENTICITY

(false)

Parser requires upgrade images to be authenticated by the bootloader certificate, if true.

PARSER_REQUIRE_ANTI_ROLLBACK_PROTECTION#

#define PARSER_REQUIRE_ANTI_ROLLBACK_PROTECTION

(false)

Parser requires rollback protection of applications, if true.

PARSER_APPLICATION_MINIMUM_VERSION_VALID#

#define PARSER_APPLICATION_MINIMUM_VERSION_VALID

(0UL)

Defines the minimum application version that can be accepted.

BTL_IMAGE_CONTENT_APPLICATION#

#define BTL_IMAGE_CONTENT_APPLICATION

0x01U

Upgrade image contains application upgrade.

BTL_IMAGE_CONTENT_BOOTLOADER#

#define BTL_IMAGE_CONTENT_BOOTLOADER

0x02U

Upgrade image contains bootloader upgrade.

BTL_IMAGE_CONTENT_SE#

#define BTL_IMAGE_CONTENT_SE

0x04U

Upgrade image contains SE upgrade.

BTL_IMAGE_INSTRUCTION_APPLICATION#

#define BTL_IMAGE_INSTRUCTION_APPLICATION

0x01U

Application upgrade should be applied from upgrade image.

BTL_IMAGE_INSTRUCTION_BOOTLOADER#

#define BTL_IMAGE_INSTRUCTION_BOOTLOADER

0x02U

Bootloader upgrade should be applied from upgrade image.

BTL_IMAGE_INSTRUCTION_SE#

#define BTL_IMAGE_INSTRUCTION_SE

0x04U

SE upgrade should be applied from upgrade image.