doc/release: Add notes on MCUmgr Kconfig renames

Adds information on renaming of MCUmgr Kconfig options
and migration script that can be used to help with transition.

Signed-off-by: Dominik Ermel <[email protected]>

Author: de-nordic

doc/releases/release-notes-3.3.rst

@@ -468,8 +468,176 @@ Libraries / Subsystems
     the kernel and application, allowing application-level extensibility
     see :ref:`mcumgr_os_application_info` for details.
 
- * MCUMgr :kconfig:option:`CONFIG_APP_LINK_WITH_MCUMGR` has been removed as
-   it has not been doing anything.
+  * MCUMgr :kconfig:option:`CONFIG_APP_LINK_WITH_MCUMGR` has been removed as
+    it has not been doing anything.
+
+  * MCUmgr Kconfig option names have been standardised. Script
+    :zephyr_file:`scripts/utils/migrate_mcumgr_kconfigs.py` has been provided
+    to make transition to new Kconfig options easier.
+    Below table provides information on old names and new equivalents:
+
+    .. table::
+       :align: center
+
+       +------------------------------------------------+-------------------------------------------------------+
+       | Old Kconfig option name                        | New Kconfig option name                               |
+       +================================================+=======================================================+
+       | MCUMGR_SMP_WORKQUEUE_STACK_SIZE                | MCUMGR_TRANSPORT_WORKQUEUE_STACK_SIZE                 |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_WORKQUEUE_THREAD_PRIO               | MCUMGR_TRANSPORT_WORKQUEUE_THREAD_PRIO                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MAX_MAIN_MAP_ENTRIES                      | MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MIN_DECODING_LEVELS                       | MCUMGR_SMP_CBOR_MIN_DECODING_LEVELS                   |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MIN_DECODING_LEVEL_1                      | MCUMGR_SMP_CBOR_MIN_DECODING_LEVEL_1                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MIN_DECODING_LEVEL_2                      | MCUMGR_SMP_CBOR_MIN_DECODING_LEVEL_2                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MIN_DECODING_LEVEL_3                      | MCUMGR_SMP_CBOR_MIN_DECODING_LEVEL_3                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MIN_DECODING_LEVEL_4                      | MCUMGR_SMP_CBOR_MIN_DECODING_LEVEL_4                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MIN_DECODING_LEVEL_5                      | MCUMGR_SMP_CBOR_MIN_DECODING_LEVEL_5                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_MAX_DECODING_LEVELS                       | MCUMGR_SMP_CBOR_MAX_DECODING_LEVELS                   |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_CMD_FS_MGMT                             | MCUMGR_GRP_FS                                         |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_MAX_FILE_SIZE_64KB                     | MCUMGR_GRP_FS_MAX_FILE_SIZE_64KB                      |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_MAX_FILE_SIZE_4GB                      | MCUMGR_GRP_FS_MAX_FILE_SIZE_4GB                       |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_MAX_OFFSET_LEN                         | MCUMGR_GRP_FS_MAX_OFFSET_LEN                          |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_DL_CHUNK_SIZE_LIMIT                    | MCUMGR_GRP_FS_DL_CHUNK_SIZE_LIMIT                     |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_DL_CHUNK_SIZE                          | MCUMGR_GRP_FS_DL_CHUNK_SIZE                           |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_FILE_STATUS                            | MCUMGR_GRP_FS_FILE_STATUS                             |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_CHECKSUM_HASH                          | MCUMGR_GRP_FS_CHECKSUM_HASH                           |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_CHECKSUM_HASH_CHUNK_SIZE               | MCUMGR_GRP_FS_CHECKSUM_HASH_CHUNK_SIZE                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_CHECKSUM_IEEE_CRC32                    | MCUMGR_GRP_FS_CHECKSUM_IEEE_CRC32                     |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_HASH_SHA256                            | MCUMGR_GRP_FS_HASH_SHA256                             |
+       +------------------------------------------------+-------------------------------------------------------+
+       | FS_MGMT_PATH_SIZE                              | MCUMGR_GRP_FS_PATH_LEN                                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_CMD_IMG_MGMT                            | MCUMGR_GRP_IMG                                        |
+       +------------------------------------------------+-------------------------------------------------------+
+       | IMG_MGMT_USE_HEAP_FOR_FLASH_IMG_CONTEXT        | MCUMGR_GRP_IMG_USE_HEAP_FOR_FLASH_IMG_CONTEXT         |
+       +------------------------------------------------+-------------------------------------------------------+
+       | IMG_MGMT_UPDATABLE_IMAGE_NUMBER                | MCUMGR_GRP_IMG_UPDATABLE_IMAGE_NUMBER                 |
+       +------------------------------------------------+-------------------------------------------------------+
+       | IMG_MGMT_VERBOSE_ERR                           | MCUMGR_GRP_IMG_VERBOSE_ERR                            |
+       +------------------------------------------------+-------------------------------------------------------+
+       | IMG_MGMT_DUMMY_HDR                             | MCUMGR_GRP_IMG_DUMMY_HDR                              |
+       +------------------------------------------------+-------------------------------------------------------+
+       | IMG_MGMT_DIRECT_IMAGE_UPLOAD                   | MCUMGR_GRP_IMG_DIRECT_UPLOAD                          |
+       +------------------------------------------------+-------------------------------------------------------+
+       | IMG_MGMT_REJECT_DIRECT_XIP_MISMATCHED_SLOT     | MCUMGR_GRP_IMG_REJECT_DIRECT_XIP_MISMATCHED_SLOT      |
+       +------------------------------------------------+-------------------------------------------------------+
+       | IMG_MGMT_FRUGAL_LIST                           | MCUMGR_GRP_IMG_FRUGAL_LIST                            |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_CMD_OS_MGMT                             | MCUMGR_GRP_OS                                         |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_RESET_MS                               | MCUMGR_GRP_OS_RESET_MS                                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_TASKSTAT                               | MCUMGR_GRP_OS_TASKSTAT                                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_TASKSTAT_ONLY_SUPPORTED_STATS          | MCUMGR_GRP_OS_TASKSTAT_ONLY_SUPPORTED_STATS           |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_TASKSTAT_MAX_NUM_THREADS               | MCUMGR_GRP_OS_TASKSTAT_MAX_NUM_THREADS                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_TASKSTAT_THREAD_NAME_LEN               | MCUMGR_GRP_OS_TASKSTAT_THREAD_NAME_LEN                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_TASKSTAT_SIGNED_PRIORITY               | MCUMGR_GRP_OS_TASKSTAT_SIGNED_PRIORITY                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_TASKSTAT_STACK_INFO                    | MCUMGR_GRP_OS_TASKSTAT_STACK_INFO                     |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_ECHO                                   | MCUMGR_GRP_OS_ECHO                                    |
+       +------------------------------------------------+-------------------------------------------------------+
+       | OS_MGMT_MCUMGR_PARAMS                          | MCUMGR_GRP_OS_MCUMGR_PARAMS                           |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_CMD_SHELL_MGMT                          | MCUMGR_GRP_SHELL                                      |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_CMD_SHELL_MGMT_LEGACY_RC_RETURN_CODE    | MCUMGR_GRP_SHELL_LEGACY_RC_RETURN_CODE                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_CMD_STAT_MGMT                           | MCUMGR_GRP_STAT                                       |
+       +------------------------------------------------+-------------------------------------------------------+
+       | STAT_MGMT_MAX_NAME_LEN                         | MCUMGR_GRP_STAT_MAX_NAME_LEN                          |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_GRP_ZEPHYR_BASIC                        | MCUMGR_GRP_ZBASIC                                     |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_GRP_BASIC_CMD_STORAGE_ERASE             | MCUMGR_GRP_ZBASIC_STORAGE_ERASE                       |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MGMT_VERBOSE_ERR_RESPONSE                      | MCUMGR_SMP_VERBOSE_ERR_RESPONSE                       |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_REASSEMBLY                          | MCUMGR_TRANSPORT_REASSEMBLY                           |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_BUF_COUNT                               | MCUMGR_TRANSPORT_NETBUF_COUNT                         |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_BUF_SIZE                                | MCUMGR_TRANSPORT_NETBUF_SIZE                          |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_BUF_USER_DATA_SIZE                      | MCUMGR_TRANSPORT_NETBUF_USER_DATA_SIZE                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT                                  | MCUMGR_TRANSPORT_BT                                   |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_REASSEMBLY_BT                       | MCUMGR_TRANSPORT_BT_REASSEMBLY                        |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_AUTHEN                           | MCUMGR_TRANSPORT_BT_AUTHEN                            |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_CONN_PARAM_CONTROL               | MCUMGR_TRANSPORT_BT_CONN_PARAM_CONTROL                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_CONN_PARAM_CONTROL_MIN_INT       | MCUMGR_TRANSPORT_BT_CONN_PARAM_CONTROL_MIN_INT        |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_CONN_PARAM_CONTROL_MAX_INT       | MCUMGR_TRANSPORT_BT_CONN_PARAM_CONTROL_MAX_INT        |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_CONN_PARAM_CONTROL_LATENCY       | MCUMGR_TRANSPORT_BT_CONN_PARAM_CONTROL_LATENCY        |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_CONN_PARAM_CONTROL_TIMEOUT       | MCUMGR_TRANSPORT_BT_CONN_PARAM_CONTROL_TIMEOUT        |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_CONN_PARAM_CONTROL_RESTORE_TIME  | MCUMGR_TRANSPORT_BT_CONN_PARAM_CONTROL_RESTORE_TIME   |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_BT_CONN_PARAM_CONTROL_RETRY_TIME    | MCUMGR_TRANSPORT_BT_CONN_PARAM_CONTROL_RETRY_TIME     |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_DUMMY                               | MCUMGR_TRANSPORT_DUMMY                                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_DUMMY_RX_BUF_SIZE                   | MCUMGR_TRANSPORT_DUMMY_RX_BUF_SIZE                    |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_SHELL                               | MCUMGR_TRANSPORT_SHELL                                |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_SHELL_MTU                           | MCUMGR_TRANSPORT_SHELL_MTU                            |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_SHELL_RX_BUF_COUNT                  | MCUMGR_TRANSPORT_SHELL_RX_BUF_COUNT                   |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UART                                | MCUMGR_TRANSPORT_UART                                 |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UART_ASYNC                          | MCUMGR_TRANSPORT_UART_ASYNC                           |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UART_ASYNC_BUFS                     | MCUMGR_TRANSPORT_UART_ASYNC_BUFS                      |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UART_ASYNC_BUF_SIZE                 | MCUMGR_TRANSPORT_UART_ASYNC_BUF_SIZE                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UART_MTU                            | MCUMGR_TRANSPORT_UART_MTU                             |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UDP                                 | MCUMGR_TRANSPORT_UDP                                  |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UDP_IPV4                            | MCUMGR_TRANSPORT_UDP_IPV4                             |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UDP_IPV6                            | MCUMGR_TRANSPORT_UDP_IPV6                             |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UDP_PORT                            | MCUMGR_TRANSPORT_UDP_PORT                             |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UDP_STACK_SIZE                      | MCUMGR_TRANSPORT_UDP_STACK_SIZE                       |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UDP_THREAD_PRIO                     | MCUMGR_TRANSPORT_UDP_THREAD_PRIO                      |
+       +------------------------------------------------+-------------------------------------------------------+
+       | MCUMGR_SMP_UDP_MTU                             | MCUMGR_TRANSPORT_UDP_MTU                              |
+       +------------------------------------------------+-------------------------------------------------------+
 
   * MCUmgr responses where ``rc`` (result code) is 0 (no error) will no longer
     be present in responses and in cases where there is only an ``rc`` result,