ContentsIndex
PreviousUpNext
Firmware
Topics | Functions | Structs, Records, Enums
Description

API to query firmware information and trigger firmware update process.

Introduction

The firmware module provides firmware-related APIs to query firmware information like version and build time. It also provides API to query if a specific functional module, e.g. Wi-Fi, is supported by the current running firmware. And to update firmware with LinkIt API, vm_firmware_trigger_update is provided to trigger the update process.

Limitation

A LinkIt application cannot execute during firmware update process. See documentation of vm_firmware_trigger_update to know how to check the result of update process.

Group
Functions
Function 
Description 
Get firmware information, e.g. firmware version, build date, and maximum memory that LinkIt application can use. 
Query if the specified module is supported or not. 
Calling this function causes the system to reboot immediately and then trigger the firmware update process in bootloader to update full firmware image. The path to the image must be "C:\image.bin". This function always returns VM_SUCCESS because the LinkIt application will be terminated before the actual updating process takes action. The result of the update process is written to a file named "C:\update_info" on the disk. The file type is binary with structure vm_firmware_update_status_t as the content. Use file system APIs to read and parse the update_info file to check if the firmware update procedure has performed successfully or not.... more 
Structs, Records, Enums
Struct, Record, Enum 
Description 
Information that can be queried by vm_firmware_get_info
Use this enum to query if a functional module is supported by firmware. 
The result code is stored in the error_code field of vm_firmware_update_status_t 
After vm_firmware_trigger_update is called and the system reboots, open "C:\update_info" in binary mode and read the content to this structure to know the result of update process. 
Links
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at support@toolsfactory.com.