Firmware Upgrade

Functions
struct ltrx_firmware_upgrade_context *	ltrx_firmware_upgrade_begin (const char *optRequiredVersion)
	Begin firmware upgrade.
bool	ltrx_firmware_upgrade_data (struct ltrx_firmware_upgrade_context *f, const void *data, size_t length)
	Write data for firmware upgrade.
bool	ltrx_firmware_upgrade_end (struct ltrx_firmware_upgrade_context *f, bool goodFinish, bool *reboot, bool *validPartition)
	Wrap up firmware upgrade.

Detailed Description

Firmware Upgrade provides a method to upgrade the devide firmware.

Function Documentation

ltrx_firmware_upgrade_begin()

struct ltrx_firmware_upgrade_context * ltrx_firmware_upgrade_begin

(

const char *

optRequiredVersion

)

Begin firmware upgrade.

Returns

Context for remaining firmware upgrade operation.

Return values

NULL	Failure.
!NULL	Success.

Parameters

[in]

optRequiredVersion

Optional version string. Fails if firmware header does not match.

ltrx_firmware_upgrade_data()

bool ltrx_firmware_upgrade_data	(	struct ltrx_firmware_upgrade_context *	f,
		const void *	data,
		size_t	length )

Write data for firmware upgrade.

Call this multiple times until all of the firmware image has been provided.

Return values

false	Failure.
true	Success.

Parameters

	f	[in,out] The firmware upgrade context.
[in]	data	Pointer to data to write.
[in]	length	Length of data to write.

ltrx_firmware_upgrade_end()

bool ltrx_firmware_upgrade_end	(	struct ltrx_firmware_upgrade_context *	f,
		bool	goodFinish,
		bool *	reboot,
		bool *	validPartition )

Wrap up firmware upgrade.

Call this once; the firmware upgrade context will no longer be valid.

Return values

false	Failure.
true	Success.

Parameters

	f	[in,out] The firmware upgrade context.
[in]	goodFinish	Set false to abort, true to validate the firmware.
[out]	reboot	Optional flag, set true if reboot is required.
[out]	validPartition	Optional flag, set true if partition is valid.