commit | e71063a3c01d6ea8b73a06f14c1d3006f2de9e7a | [log] [tgz] |
---|---|---|
author | Dominik Ermel <dominik.ermel@nordicsemi.no> | Wed Jun 09 13:15:52 2021 +0000 |
committer | Fabio Utzig <utzig@utzig.org> | Wed Jun 16 07:21:13 2021 -0300 |
tree | 782aa27897aee9cd784b42b7ab22d823d0e0c3fc | |
parent | e215d26bb7c7ea1352bc954b2b59a6fc0a234a46 [diff] |
zephyr: Improve and rename img_mgmt_find_best_area_id The img_mgmt_find_best_area_id has been renamed to img_mgmt_get_unused_slot_area_id and now takes one integer parameter, that is a slot number to check. The parameter may be -1, in which case the function will check the first two slots for availability to perform DFU. In case when positive integer is provided the function will address directly selected slot, and will perform the same tests, as in auto-select, for first two slots, but in case of slot numbers above 1, it will just check if the slot has been defined. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
This is mcumgr, version 0.2.0
mcumgr is a management library for 32-bit MCUs. The goal of mcumgr is to define a common management infrastructure with pluggable transport and encoding components. In addition, mcumgr provides definitions and handlers for some core commands: image management, file system management, and OS management.
mcumgr is operating system and hardware independent. It relies on hardware porting layers from the operating system it runs on. Currently, mcumgr runs on both the Apache Mynewt and Zephyr operating systems.
For tips on using mcumgr with your particular OS, see the appropriate file from the list below:
To use mcumgr's image management support, your device must be running version 1.1.0 or later of the MCUboot boot loader. The other mcumgr features do not require MCUboot.
The mcumgr
command line tool is available at: https://github.com/apache/mynewt-mcumgr-cli. The command line tool requires Go 1.7 or later. Once Go is installed and set up on your system, you can install the mcumgr CLI tool by issuing the following go get
command:
$ go get github.com/apache/mynewt-mcumgr-cli/mcumgr
The mcumgr
tool allows you to manage devices running an mcumgr server.
The mcumgr stack has the following layout:
+---------------------+---------------------+ | <command handlers> | +---------------------+---------------------+ | mgmt | +---------------------+---------------------+ | <transfer encoding(s)> | +---------------------+---------------------+ | <transport(s)> | +---------------------+---------------------+
Items enclosed in angled brackets represent generic components that can be plugged into mcumgr. The items in this stack diagram are defined below:
Each transport is configured with a single transfer encoding.
As an example, the sample application smp_svr
uses the following components:
img_mgmt
)fs_mgmt
)log_mgmt
)os_mgmt
)yielding the following stack diagram:
+----------+----------+----------+----------+ | img_mgmt | fs_mgmt | log_mgmt | os_mgmt | +----------+----------+----------+----------+ | mgmt | +---------------------+---------------------+ | SMP | SMP | +---------------------+---------------------+ | Bluetooth | Shell | +---------------------+---------------------+
An mcumgr request or response consists of the following two components:
How these two components are encoded and parsed depends on the transfer encoding used.
The mcumgr header structure is defined in mgmt/include/mgmt/mgmt.h
as struct mgmt_hdr
.
The contents of the CBOR key-value map are specified per command type.
Mcumgr comes with one built-in transfer encoding: Simple Management Protocol (SMP). SMP requests and responses have a very basic structure. For details, see the comments at the top of smp/include/smp/smp.h
.
The mcumgr project defines two transports:
Implementations, being hardware- and OS-specific, are not included.
Information and documentation for mcumgr is stored within the source.
For more information in the source, here are some pointers:
mgmt
layer of mcumgr.Developers welcome!