diff --git a/subsys/mgmt/mcumgr/grp/fs_mgmt/Kconfig b/subsys/mgmt/mcumgr/grp/fs_mgmt/Kconfig index 5f1bd60cf28..f431ad4327f 100644 --- a/subsys/mgmt/mcumgr/grp/fs_mgmt/Kconfig +++ b/subsys/mgmt/mcumgr/grp/fs_mgmt/Kconfig @@ -2,6 +2,16 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "Mcumgr handlers for file management (insecure)" depends on FILE_SYSTEM diff --git a/subsys/mgmt/mcumgr/grp/img_mgmt/Kconfig b/subsys/mgmt/mcumgr/grp/img_mgmt/Kconfig index 9669360ef09..a1ac3335ecd 100644 --- a/subsys/mgmt/mcumgr/grp/img_mgmt/Kconfig +++ b/subsys/mgmt/mcumgr/grp/img_mgmt/Kconfig @@ -2,6 +2,16 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "Mcumgr handlers for image management" select FLASH diff --git a/subsys/mgmt/mcumgr/grp/os_mgmt/Kconfig b/subsys/mgmt/mcumgr/grp/os_mgmt/Kconfig index 83ad34f653c..f484ce6d6a9 100644 --- a/subsys/mgmt/mcumgr/grp/os_mgmt/Kconfig +++ b/subsys/mgmt/mcumgr/grp/os_mgmt/Kconfig @@ -2,6 +2,16 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "Mcumgr handlers for OS management" select REBOOT diff --git a/subsys/mgmt/mcumgr/grp/shell_mgmt/Kconfig b/subsys/mgmt/mcumgr/grp/shell_mgmt/Kconfig index c0184f793af..bfdaac0061e 100644 --- a/subsys/mgmt/mcumgr/grp/shell_mgmt/Kconfig +++ b/subsys/mgmt/mcumgr/grp/shell_mgmt/Kconfig @@ -2,6 +2,16 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "Mcumgr handlers for shell management" depends on SHELL diff --git a/subsys/mgmt/mcumgr/grp/stat_mgmt/Kconfig b/subsys/mgmt/mcumgr/grp/stat_mgmt/Kconfig index 213ead24d43..f70a475e79a 100644 --- a/subsys/mgmt/mcumgr/grp/stat_mgmt/Kconfig +++ b/subsys/mgmt/mcumgr/grp/stat_mgmt/Kconfig @@ -2,6 +2,16 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "Mcumgr handlers for statistics management" depends on STATS diff --git a/subsys/mgmt/mcumgr/mgmt/Kconfig b/subsys/mgmt/mcumgr/mgmt/Kconfig index 2a4d4843f69..d1701627860 100644 --- a/subsys/mgmt/mcumgr/mgmt/Kconfig +++ b/subsys/mgmt/mcumgr/mgmt/Kconfig @@ -2,6 +2,13 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "MCUmgr notification hook support" help diff --git a/subsys/mgmt/mcumgr/smp/Kconfig b/subsys/mgmt/mcumgr/smp/Kconfig index 5ca7421de64..7d5673a6d45 100644 --- a/subsys/mgmt/mcumgr/smp/Kconfig +++ b/subsys/mgmt/mcumgr/smp/Kconfig @@ -2,6 +2,15 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 int "Number of predicted maximum entries to main response map" default 15 diff --git a/subsys/mgmt/mcumgr/transport/Kconfig b/subsys/mgmt/mcumgr/transport/Kconfig index 34e5ec3d45e..a966b943a9c 100644 --- a/subsys/mgmt/mcumgr/transport/Kconfig +++ b/subsys/mgmt/mcumgr/transport/Kconfig @@ -2,6 +2,16 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 int "MCUmgr transport workqueue stack size" default 2048 diff --git a/subsys/mgmt/mcumgr/transport/Kconfig.bluetooth b/subsys/mgmt/mcumgr/transport/Kconfig.bluetooth index 74459ed515e..22e25951a60 100644 --- a/subsys/mgmt/mcumgr/transport/Kconfig.bluetooth +++ b/subsys/mgmt/mcumgr/transport/Kconfig.bluetooth @@ -2,6 +2,13 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "Bluetooth mcumgr SMP transport" select BT diff --git a/subsys/mgmt/mcumgr/transport/Kconfig.dummy b/subsys/mgmt/mcumgr/transport/Kconfig.dummy index d008d2c9f0e..766c80e9b3a 100644 --- a/subsys/mgmt/mcumgr/transport/Kconfig.dummy +++ b/subsys/mgmt/mcumgr/transport/Kconfig.dummy @@ -2,6 +2,13 @@ # Copyright Nordic Semiconductor ASA 2022. All rights reserved. # 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 bool "Dummy SMP backend" select BASE64 diff --git a/subsys/mgmt/mcumgr/transport/Kconfig.shell b/subsys/mgmt/mcumgr/transport/Kconfig.shell index 21f4384c158..6346e1b746f 100644 --- a/subsys/mgmt/mcumgr/transport/Kconfig.shell +++ b/subsys/mgmt/mcumgr/transport/Kconfig.shell @@ -2,6 +2,13 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "Shell mcumgr SMP transport" select SHELL diff --git a/subsys/mgmt/mcumgr/transport/Kconfig.uart b/subsys/mgmt/mcumgr/transport/Kconfig.uart index 5919f646f64..1479b71f001 100644 --- a/subsys/mgmt/mcumgr/transport/Kconfig.uart +++ b/subsys/mgmt/mcumgr/transport/Kconfig.uart @@ -2,6 +2,13 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "UART mcumgr SMP transport" select UART_MCUMGR diff --git a/subsys/mgmt/mcumgr/transport/Kconfig.udp b/subsys/mgmt/mcumgr/transport/Kconfig.udp index caa4297fcc1..020770a4bc2 100644 --- a/subsys/mgmt/mcumgr/transport/Kconfig.udp +++ b/subsys/mgmt/mcumgr/transport/Kconfig.udp @@ -2,6 +2,13 @@ # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved. # 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 bool "UDP mcumgr SMP transport" select NETWORKING