mgmt/mcumgr: Add Kconfig option naming notes
The commit adds Kconfig option naming notes to Kconfig files of MCUmgr subsystem. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
This commit is contained in:
parent
c7378d0d84
commit
671625cd0c
13 changed files with 111 additions and 0 deletions
|
@ -2,6 +2,16 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to File System management group of
|
||||||
|
# of MCUmgr subsystem and provides Kconfig options to configure
|
||||||
|
# group commands behaviour and other aspects.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_GRP_FS_ -- general group options;
|
||||||
|
#
|
||||||
|
# When adding Kconfig options, that control the same feature,
|
||||||
|
# try to group them together by the same stem after prefix.
|
||||||
|
|
||||||
menuconfig MCUMGR_GRP_FS
|
menuconfig MCUMGR_GRP_FS
|
||||||
bool "Mcumgr handlers for file management (insecure)"
|
bool "Mcumgr handlers for file management (insecure)"
|
||||||
depends on FILE_SYSTEM
|
depends on FILE_SYSTEM
|
||||||
|
|
|
@ -2,6 +2,16 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to Application Image management group of
|
||||||
|
# of MCUmgr subsystem and provides Kconfig options to configure
|
||||||
|
# group commands behaviour and other aspects.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_GRP_IMG_ -- general group options;
|
||||||
|
#
|
||||||
|
# When adding Kconfig options, that control the same feature,
|
||||||
|
# try to group them together by the same stem after prefix.
|
||||||
|
|
||||||
menuconfig MCUMGR_GRP_IMG
|
menuconfig MCUMGR_GRP_IMG
|
||||||
bool "Mcumgr handlers for image management"
|
bool "Mcumgr handlers for image management"
|
||||||
select FLASH
|
select FLASH
|
||||||
|
|
|
@ -2,6 +2,16 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to OS management group of
|
||||||
|
# of MCUmgr subsystem and provides Kconfig options to configure
|
||||||
|
# group commands behaviour and other aspects.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_GRP_OS_ -- general group options;
|
||||||
|
#
|
||||||
|
# When adding Kconfig options, that control the same feature,
|
||||||
|
# try to group them together by the same stem after prefix.
|
||||||
|
|
||||||
menuconfig MCUMGR_GRP_OS
|
menuconfig MCUMGR_GRP_OS
|
||||||
bool "Mcumgr handlers for OS management"
|
bool "Mcumgr handlers for OS management"
|
||||||
select REBOOT
|
select REBOOT
|
||||||
|
|
|
@ -2,6 +2,16 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to Shell management group of
|
||||||
|
# of MCUmgr subsystem and provides Kconfig options to configure
|
||||||
|
# group commands behaviour and other aspects.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_GRP_SHELL_ -- general group options;
|
||||||
|
#
|
||||||
|
# When adding Kconfig options, that control the same feature,
|
||||||
|
# try to group them together by the same stem after prefix.
|
||||||
|
|
||||||
menuconfig MCUMGR_GRP_SHELL
|
menuconfig MCUMGR_GRP_SHELL
|
||||||
bool "Mcumgr handlers for shell management"
|
bool "Mcumgr handlers for shell management"
|
||||||
depends on SHELL
|
depends on SHELL
|
||||||
|
|
|
@ -2,6 +2,16 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to Stat management group of
|
||||||
|
# of MCUmgr subsystem and provides Kconfig options to configure
|
||||||
|
# group commands behaviour and other aspects.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_GRP_STAT_ -- general group options;
|
||||||
|
#
|
||||||
|
# When adding Kconfig options, that control the same feature,
|
||||||
|
# try to group them together by the same stem after prefix.
|
||||||
|
|
||||||
menuconfig MCUMGR_GRP_STAT
|
menuconfig MCUMGR_GRP_STAT
|
||||||
bool "Mcumgr handlers for statistics management"
|
bool "Mcumgr handlers for statistics management"
|
||||||
depends on STATS
|
depends on STATS
|
||||||
|
|
|
@ -2,6 +2,13 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig is dedicated to mgmt subsystem of MCUmgr. Kconfig options defined
|
||||||
|
# here affect behaviour of services provided by source code of mcumgr/mgmt/
|
||||||
|
# directory, like management group registration or overall hooks support.
|
||||||
|
#
|
||||||
|
# All Kconfig options defined with this file should begin with prefix:
|
||||||
|
# MCUMGR_MGMT_
|
||||||
|
|
||||||
config MCUMGR_MGMT_NOTIFICATION_HOOKS
|
config MCUMGR_MGMT_NOTIFICATION_HOOKS
|
||||||
bool "MCUmgr notification hook support"
|
bool "MCUmgr notification hook support"
|
||||||
help
|
help
|
||||||
|
|
|
@ -2,6 +2,15 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to smp subdirectory of MCUmgr
|
||||||
|
# subsystem and provides Kconfig options to control aspects of
|
||||||
|
# Simple Management Protocol (SMP) processing source code provided
|
||||||
|
# under the subdirectory.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_SMP_ -- for general SMP options;
|
||||||
|
# MCUMGR_SMP_CBOR -- for CBOR encoding specific options;
|
||||||
|
|
||||||
config MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES
|
config MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES
|
||||||
int "Number of predicted maximum entries to main response map"
|
int "Number of predicted maximum entries to main response map"
|
||||||
default 15
|
default 15
|
||||||
|
|
|
@ -2,6 +2,16 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to transport subdirectory of MCUmgr
|
||||||
|
# subsystem and provides Kconfig options to control aspects of
|
||||||
|
# transport, in general, that are not otherwise controlled by
|
||||||
|
# options belonging to transport specifically.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_TRANSPORT_ -- general transport options;
|
||||||
|
# MCUMGR_TRANSPORT_WORKQUEUE -- for workqueue configuration;
|
||||||
|
# MCUMGR_TRANSPORT_NETBUF -- for Net Buf related configuration.
|
||||||
|
|
||||||
config MCUMGR_TRANSPORT_WORKQUEUE_STACK_SIZE
|
config MCUMGR_TRANSPORT_WORKQUEUE_STACK_SIZE
|
||||||
int "MCUmgr transport workqueue stack size"
|
int "MCUmgr transport workqueue stack size"
|
||||||
default 2048
|
default 2048
|
||||||
|
|
|
@ -2,6 +2,13 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to Bluetooth transport of MCUmgr
|
||||||
|
# subsystem and provides Kconfig options to control aspects of
|
||||||
|
# the transport.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_TRANSPORT_BT_
|
||||||
|
|
||||||
menuconfig MCUMGR_TRANSPORT_BT
|
menuconfig MCUMGR_TRANSPORT_BT
|
||||||
bool "Bluetooth mcumgr SMP transport"
|
bool "Bluetooth mcumgr SMP transport"
|
||||||
select BT
|
select BT
|
||||||
|
|
|
@ -2,6 +2,13 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to Dummy transport of MCUmgr
|
||||||
|
# subsystem and provides Kconfig options to control aspects of
|
||||||
|
# the transport.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_TRANSPORT_DUMMY_
|
||||||
|
|
||||||
menuconfig MCUMGR_TRANSPORT_DUMMY
|
menuconfig MCUMGR_TRANSPORT_DUMMY
|
||||||
bool "Dummy SMP backend"
|
bool "Dummy SMP backend"
|
||||||
select BASE64
|
select BASE64
|
||||||
|
|
|
@ -2,6 +2,13 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to shell transport of MCUmgr
|
||||||
|
# subsystem and provides Kconfig options to control aspects of
|
||||||
|
# the transport.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_TRANSPORT_SHELL_
|
||||||
|
|
||||||
menuconfig MCUMGR_TRANSPORT_SHELL
|
menuconfig MCUMGR_TRANSPORT_SHELL
|
||||||
bool "Shell mcumgr SMP transport"
|
bool "Shell mcumgr SMP transport"
|
||||||
select SHELL
|
select SHELL
|
||||||
|
|
|
@ -2,6 +2,13 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to UART transport of MCUmgr
|
||||||
|
# subsystem and provides Kconfig options to control aspects of
|
||||||
|
# the transport.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_TRANSPORT_UART_
|
||||||
|
|
||||||
menuconfig MCUMGR_TRANSPORT_UART
|
menuconfig MCUMGR_TRANSPORT_UART
|
||||||
bool "UART mcumgr SMP transport"
|
bool "UART mcumgr SMP transport"
|
||||||
select UART_MCUMGR
|
select UART_MCUMGR
|
||||||
|
|
|
@ -2,6 +2,13 @@
|
||||||
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
# Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# The Kconfig file is dedicated to UDP transport of MCUmgr
|
||||||
|
# subsystem and provides Kconfig options to control aspects of
|
||||||
|
# the transport.
|
||||||
|
#
|
||||||
|
# Options defined in this file should be prefixed:
|
||||||
|
# MCUMGR_TRANSPORT_UDP_
|
||||||
|
|
||||||
menuconfig MCUMGR_TRANSPORT_UDP
|
menuconfig MCUMGR_TRANSPORT_UDP
|
||||||
bool "UDP mcumgr SMP transport"
|
bool "UDP mcumgr SMP transport"
|
||||||
select NETWORKING
|
select NETWORKING
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue