Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
_ARM_UPDATE_MONITOR Struct Reference
Structure definition holding API function pointers. More...
#include <arm_uc_monitor.h>
Data Fields | |
| uint32_t(* | GetVersion )(void) |
| Get driver version. | |
| ARM_MONITOR_CAPABILITIES(* | GetCapabilities )(void) |
| Get Source capabilities. | |
| arm_uc_error_t(* | Initialize )(void(*notification_handler)(void)) |
| Initialize Monitor. | |
| arm_uc_error_t(* | Uninitialize )(void) |
| Uninitialized Monitor. | |
| arm_uc_error_t(* | SendState )(arm_uc_monitor_state_t state) |
| Send Update Client state. | |
| arm_uc_error_t(* | SendUpdateResult )(arm_uc_monitor_result_t updateResult) |
| Send update result. | |
| arm_uc_error_t(* | SendName )(arm_uc_buffer_t *name) |
| Send current firmware name. | |
| arm_uc_error_t(* | SendVersion )(uint64_t version) |
| Send current firmware version. | |
| arm_uc_error_t(* | SetBootloaderHash )(arm_uc_buffer_t *hash) |
| Set the bootloader hash. | |
| arm_uc_error_t(* | SetOEMBootloaderHash )(arm_uc_buffer_t *hash) |
| Set the OEM bootloader hash. | |
Detailed Description
Structure definition holding API function pointers.
Definition at line 48 of file arm_uc_monitor.h.
Field Documentation
| ARM_MONITOR_CAPABILITIES(* GetCapabilities)(void) |
Get Source capabilities.
- Returns:
- Struct containing capabilites. See definition above.
Definition at line 60 of file arm_uc_monitor.h.
| uint32_t(* GetVersion)(void) |
| arm_uc_error_t(* Initialize)(void(*notification_handler)(void)) |
| arm_uc_error_t(* SendName)(arm_uc_buffer_t *name) |
Send current firmware name.
The firmware name is the SHA256 hash.
- Parameters:
-
name Pointer to buffer struct. Hash is stored as byte array.
- Returns:
- Error code.
Definition at line 113 of file arm_uc_monitor.h.
| arm_uc_error_t(* SendState)(arm_uc_monitor_state_t state) |
Send Update Client state.
From the OMA LWM2M Technical Specification:
If writing the firmware package to Package Resource is done, or, if the device has downloaded the firmware package from the Package URI the state changes to Downloaded.
If writing an empty string to Package Resource is done or writing an empty string to Package URI is done, the state changes to Idle.
When in Downloaded state, and the executable Resource Update is triggered, the state changes to Updating. If the Update Resource failed, the state returns at Downloaded. If performing the Update Resource was successful, the state changes from Updating to Idle.
- Parameters:
-
state Any member element of arm_uc_monitor_state_t
- Returns:
- Error code.
Definition at line 95 of file arm_uc_monitor.h.
| arm_uc_error_t(* SendUpdateResult)(arm_uc_monitor_result_t updateResult) |
Send update result.
From the OMA LWM2M Technical Specification: This Resource MAY be reported by sending Observe operation.
- Parameters:
-
result Valid results: Any member element of arm_uc_monitor_result_t.
- Returns:
- Error code.
Definition at line 104 of file arm_uc_monitor.h.
| arm_uc_error_t(* SendVersion)(uint64_t version) |
Send current firmware version.
The firmware version is the timestamp from the manifest that authorized the firmware.
- Parameters:
-
version Timestamp, 64 bit unsigned integer.
- Returns:
- Error code.
Definition at line 123 of file arm_uc_monitor.h.
| arm_uc_error_t(* SetBootloaderHash)(arm_uc_buffer_t *hash) |
Set the bootloader hash.
The bootloader hash is a hash of the bootloader. This is used for tracking the version of the bootloader used.
- Parameters:
-
name Pointer to buffer struct. Hash is stored as byte array.
- Returns:
- Error code.
Definition at line 133 of file arm_uc_monitor.h.
| arm_uc_error_t(* SetOEMBootloaderHash)(arm_uc_buffer_t *hash) |
Set the OEM bootloader hash.
If the end-user has modified the bootloader the hash of the modified bootloader can be set here.
- Parameters:
-
name Pointer to buffer struct. Hash is stored as byte array.
- Returns:
- Error code.
Definition at line 143 of file arm_uc_monitor.h.
| arm_uc_error_t(* Uninitialize)(void) |
Generated on Mon Aug 29 2022 19:53:43 by
1.7.2