Skip to content

Commit e4f0b8d

Browse files
committed
Added new wolfBoot_get_image_version() API
1 parent 27a306b commit e4f0b8d

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

docs/API.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,27 @@ For more information about flash partitions, flags and states see [Flash partiti
1919
libwolfboot provides low-level access interface to flash partition states. The state
2020
of each partition can be retrieved and altered by the application.
2121

22-
Basic interaction from the application is provided via the two high-level function calls:
22+
Basic interaction from the application is provided via the following high-level function calls:
23+
24+
`uint32_t wolfBoot_get_image_version(uint8_t part)`
2325

2426
`void wolfBoot_update(void)`
2527

28+
`void wolfBoot_success(void)`
29+
30+
### Firmware version
31+
32+
Current (boot) firmware and update firmware versions can be retrieved from the application using:
33+
34+
`uint32_t wolfBoot_get_image_version(uint8_t part)`
35+
36+
Or via the shortcut macros:
37+
38+
`wolfBoot_current_firmware_version()`
39+
2640
and
2741

28-
`void wolfBoot_success(void)`
42+
`wolfBoot_update_firmware_version()`
2943

3044
### Trigger an update
3145

0 commit comments

Comments
 (0)