Commit Graph

24 Commits

Author SHA1 Message Date
Jamie McCrae
1bd05df1a9 doc: mgmt: mcumgr: callback: Improve documentation
Improves the documentation when OR'ing multiple events of the same
group together to describe that this is only supported for events
that are part of the same group, giving example of correct and
incorrect usage.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-01-09 17:36:04 -08:00
Jamie McCrae
29639624ea doc: mgmt: mcumgr: callbacks: Fix issues
Fixes some issues with code and formatting.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-12-24 16:57:57 +01:00
Dominik Ermel
a5488d64d4 doc: MCUmgr replaced Kconfig options to new format
Documentation fixes following renaming of Kconfig options
to the new standardised form.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-12-22 12:36:34 +01:00
Jamie McCrae
235ab90230 doc: device_mgmt: smp: Update rc documentation
Updates documentation on when the rc response is returned.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-12-20 11:57:22 +01:00
Dominik Ermel
1d5c9cf7fd doc/dfu: Add MCUboot API chapter to documentation
The DFU documentation has been extended with MCUboot API
chapter and API reference, from mcuboot_api Doxygen group.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-12-10 09:46:35 +01:00
Dominik Ermel
8873ad2b39 doc: Move Flash Img API under Device Management
The Flash img API is used for writting image application image
to flash and is rather part of DFU than storage.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-12-10 09:46:35 +01:00
Jamie McCrae
75c6f93ff6 doc: mgmt: smp group 0: Add OS info details
Adds details on the OS information mcumgr command.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-12-07 13:53:02 +00:00
Jamie McCrae
cc6a52ebd0 doc: mgmt: mcumgr: Clarify sha256 hash details in img_mgmt
Clarifies that a full SHA256 hash is required for the hash
in img_mgmt.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-12-07 10:13:02 +00:00
Dominik Ermel
7048383362 doc: Move SMP transport documentation under doc/services
The commit moves MCUmgr SMP transport documentation from
subsys/mgmt/mcumgr/lib to doc/services/device_mgmt.
Documentation have been rewritten for that purpose.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-11-17 15:31:17 +01:00
Jamie McCrae
d5693ed464 doc: device_mgmt: callbacks: Add initial documentation
Adds the initial documentation describing the mcumgr callback
system and how to use it, including API reference and samples.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-10 12:34:39 +01:00
Jamie McCrae
7f56c06ea8 doc: guides: device_mgmt: smp: fs: Add supported hash/checksum info
Adds information on the supported hash/checksum mcumgr command.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-10 11:10:03 +01:00
Jamie McCrae
21c7e3ba65 doc: mgmt: mcumgr: Add SMP groups to separate heading
This adds the SMP groups to a separate heading and makes them visible
in the contents list so that they can be selected without having to
go to a specific page to find them.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-26 15:11:11 +02:00
Jamie McCrae
100e0cf92f doc: mcumgr: Remove deprecated Kconfig tip
Removes a tip about using an old removed Kconfig value.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-06 16:34:58 +02:00
Jamie McCrae
5b96b3faac doc: device_mgmt: smp: Add slot number to erase command
A slot number can now be provided to the mcumgr erase command to erase
a specific slot instead of slot 1, this documents the change in the
SMP group 1 documentation page.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-09-02 10:56:58 +00:00
Jamie McCrae
4d0c07407d doc: mcumgr: group 9 (shell): Update shell command return code name
This updates the documentation to indicate that the shell response
code will now be returned in a variabled named ret instead of rc, and
that rc will contain the mcumgr result code only, if an mcumgr error
occurred

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-09-01 14:05:14 +02:00
Dominik Ermel
492e2ed741 doc/guides/device_mgmt/smp: Extend reset command with force option
The commit documents OS reset command extension that allows to
force reset, when OS responds with busy "rc" code to reset
attempts.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-06-21 11:55:19 +02:00
Dominik Ermel
0a5525358c mgmt/mcumgr/lib: Add BUSY error code
The commit reserves adds MGMT_ERR_EBUSY (10) error code and adds
documentaiton for it.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-06-21 11:55:19 +02:00
Jamie McCrae
9314259312 doc: guides: device_mgmt: smp: fs: Add fs hook details
Adds details about the file read/write request hook that applications
can use to allow or decline requests to files.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
2022-05-11 17:10:55 +02:00
Pavel Vasilyev
442e477116 doc: mcumgr: Update instruction for go version 1.18+
go get is deprecated starting from go tool version 1.18:
https://go.dev/doc/go-get-install-deprecation

Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
2022-04-15 11:52:44 -07:00
Jamie McCrae
f0bdb53927 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>
2022-04-13 14:05:57 -07:00
Jamie McCrae
51e3cecb31 doc: mcumgr: Fix reference formatting
Documentation build for 2.7 was failing due to using only a single
character instead of double for showing a module name.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
2022-04-13 13:40:16 -07:00
Jamie McCrae
13c00fb96d doc: guides: device_mgmt: smp: fs: Add hash/checksum/status details
This adds documentation which explains fs mcumgr commands for the status
and hash/checksum commands.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
2022-04-12 12:05:30 +02:00
Dominik Ermel
aa53dfab02 doc/guides/device_mgmt: Add MCUMGR parameters command to OS grp
The commit add description of a new OS group command for MCUMGR
parameters retrieval.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-04-11 12:10:20 +02:00
Anas Nashif
c2a64b5b70 doc: move device mgmt under services
Device management is an OS service.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00