4.8.0.0R6
Software Development Kit
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules
Firmware Upgrade

Functions

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

Detailed Description

Firmware Upgrade provides a method to upgrade the devide firmware.

Function Documentation

struct ltrx_firmware_upgrade_context* ltrx_firmware_upgrade_begin ( const char * optRequiredVersion  )

Begin firmware upgrade.

Returns
Context for remaining firmware upgrade operation.
Return values
NULLFailure.
!NULLSuccess.
Parameters
[in]optRequiredVersionOptional version string. Fails if firmware header does not match.
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
falseFailure.
trueSuccess.
Parameters
[in,out]fThe firmware upgrade context.
[in]dataPointer to data to write.
[in]lengthLength of data to write.
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
falseFailure.
trueSuccess.
Parameters
[in,out]fThe firmware upgrade context.
[in]goodFinishSet false to abort, true to validate the firmware.
[out]rebootOptional flag, set true if reboot is required.
[out]validPartitionOptional flag, set true if partition is valid.