doc: guides: device_mgmt: smp: os: Add os reset hook details

Adds details about the os reset request hook that applications can use
to allow or decline the request or tidy up.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
This commit is contained in:
Jamie McCrae 2022-03-23 09:55:50 +00:00 committed by Marti Bolivar
commit f0bdb53927
2 changed files with 11 additions and 2 deletions

View file

@ -208,6 +208,9 @@ Libraries / Subsystems
* When hash/checksum query to mcumgr does not specify a type, then the order
of preference (most priority) is CRC32 followed by SHA256.
* Added mcumgr os hook to allow an application to accept or decline a reset
request; :kconfig:option:`CONFIG_OS_MGMT_RESET_HOOK` enables the callback.
HALs
****

View file

@ -408,8 +408,14 @@ where:
System reset
************
Performs reset of system. The device should issue response before resetting so that
the SMP client could receive information that the command has been accepted.
Performs reset of system. The device should issue response before resetting so
that the SMP client could receive information that the command has been
accepted. By default, this command is accepted in all conditions, however if the
:kconfig:option:`CONFIG_OS_MGMT_RESET_HOOK` is enabled and an application
registers a callback, the callback will be called when this command is issued
and can be used to perform any necessary tidy operations prior to the module
rebooting, or to reject the reset request outright altogether with an error
response.
System reset request
====================