doc: releases: hawkbit: add infos about changes

add infos about changes and improvements in the hawkbit subsystem. Signed-off-by: Fin Maaß <[email protected]>
zephyrproject-rtos · Jan 10, 2025 · f80492f · f80492f
1 parent bc6eded
commit f80492f
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/doc/releases/migration-guide-4.1.rst b/doc/releases/migration-guide-4.1.rst
@@ -385,6 +385,10 @@ Flash map
 hawkBit
 =======
 
+* The Kconfig symbols :kconfig:option:`CONFIG_SMF` and
+  :kconfig:option:`CONFIG_SMF_ANCESTOR_SUPPORT` are now required to be enabled to use the
+  hawkBit subsystem.
+
 MCUmgr
 ======
 

diff --git a/doc/releases/release-notes-4.1.rst b/doc/releases/release-notes-4.1.rst
@@ -350,6 +350,31 @@ Libraries / Subsystems
 
 * Management
 
+  * hawkBit
+
+    * The hawkBit subsystem now uses the State Machine Framework internally.
+      The Kconfig symbols :kconfig:option:`CONFIG_SMF` and
+      :kconfig:option:`CONFIG_SMF_ANCESTOR_SUPPORT` are now required to be enabled to use the
+      hawkBit subsystem.
+
+    * The hawkBit subsystem now uses supports hawkBit instances, that run as a multi tenant system
+      and require the tenant to be configurable and don't use the default tenant ``default``. This
+      enables the use of some solutions, that require this. The Kconfig symbol
+      :kconfig:option:`CONFIG_HAWKBIT_TENANT` can be used to set the tenant name.
+
+    * The hawkBit subsystem now supports callbacks on specific events. The Kconfig symbol
+      :kconfig:option:`CONFIG_HAWKBIT_EVENT_CALLBACKS` can be used to enable this feature.
+      See .. doxygengroup:: hawkbit__event for more information or check out the source code of
+      :zephyr:code-sample:`hawkbit-api` for more information.
+
+    * The hawkBit subsystem now supports the save and restore of the download progress. When
+      enabled, the download progress is periodically saved to non-volatile storage. If a download
+      is interrupted, it can be resumed from the last saved point rather than starting over,
+      saving bandwidth and time. The Kconfig symbol :kconfig:option:`CONFIG_HAWKBIT_SAVE_PROGRESS`
+      can be used to enable this feature.
+      Use :kconfig:option:`CONFIG_HAWKBIT_SAVE_PROGRESS_INTERVAL` to set the interval in percent
+      when the progress is saved.
+
 * Logging
 
 * Modem modules
-Original file line number
+Diff line change
@@ Expand Up / @@ -385,6 +385,10 @@ Flash map @@
     hawkBit
     =======
+    * The Kconfig symbols :kconfig:option:`CONFIG_SMF` and
+      :kconfig:option:`CONFIG_SMF_ANCESTOR_SUPPORT` are now required to be enabled to use the
+      hawkBit subsystem.
     MCUmgr
     ======
@@ Expand Down @@