net: lib: nrf_cloud: Fix Kconfig

pascal-nordic · rlubos · commit 8f5ecb5916de · 2025-02-12T17:43:04.000+01:00
Fixed extra Kconfig options for non nrf Cloud projects.

Signed-off-by: Pascal Hernandez &lt;pascal.hernandez@nordicsemi.no&gt;
diff --git a/applications/asset_tracker_v2/prj.conf b/applications/asset_tracker_v2/prj.conf
@@ -108,3 +108,6 @@ CONFIG_LOCATION_LOG_LEVEL_WRN=y
 CONFIG_NRF_CLOUD_MQTT=y
 CONFIG_HW_ID_LIBRARY=y
 CONFIG_HW_ID_LIBRARY_SOURCE_IMEI=y
+
+# nRF Cloud support
+CONFIG_NRF_CLOUD=y
diff --git a/applications/serial_lte_modem/prj.conf b/applications/serial_lte_modem/prj.conf
@@ -84,6 +84,7 @@ CONFIG_SETTINGS_NVS=y
 CONFIG_NVS=y
 
 # nRF Cloud
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_MQTT=y
 CONFIG_NRF_CLOUD_FOTA=n
 CONFIG_NRF_CLOUD_AGNSS=y
diff --git a/doc/nrf/libraries/modem/location.rst b/doc/nrf/libraries/modem/location.rst
@@ -247,11 +247,14 @@ Configure the following options to enable location methods of your choice:
 * :kconfig:option:`CONFIG_LOCATION_METHOD_CELLULAR` - Enables cellular location method.
 * :kconfig:option:`CONFIG_LOCATION_METHOD_WIFI` - Enables Wi-Fi location method.
 
-The following options control the use of GNSS assistance data:
+For external GNSS assistance data usage, set the :kconfig:option:`CONFIG_LOCATION_SERVICE_EXTERNAL` Kconfig option.
+It enables A-GNSS and P-GPS data retrieval, and cellular cell information and Wi-Fi APs sending to an external source, implemented separately by the application.
+If enabled, the library triggers a :c:enum:`LOCATION_EVT_GNSS_ASSISTANCE_REQUEST`, :c:enum:`LOCATION_EVT_GNSS_PREDICTION_REQUEST` or :c:enum:`LOCATION_EVT_CLOUD_LOCATION_EXT_REQUEST` event when additional information is needed.
+Once the application has obtained necessary information, it must call the :c:func:`location_agnss_data_process`, the :c:func:`location_pgps_data_process`, or the :c:func:`location_cloud_location_ext_result_set` function, respectively, to feed it into the library.
 
-* :kconfig:option:`CONFIG_LOCATION_SERVICE_EXTERNAL` - Enables A-GNSS and P-GPS data retrieval, and cellular cell information and Wi-Fi APs sending to an external source, implemented separately by the application.
-  If enabled, the library triggers a :c:enum:`LOCATION_EVT_GNSS_ASSISTANCE_REQUEST`, :c:enum:`LOCATION_EVT_GNSS_PREDICTION_REQUEST` or :c:enum:`LOCATION_EVT_CLOUD_LOCATION_EXT_REQUEST` event when additional information is needed.
-  Once the application has obtained necessary information, it must call the :c:func:`location_agnss_data_process`, the :c:func:`location_pgps_data_process`, or the :c:func:`location_cloud_location_ext_result_set` function, respectively, to feed it into the library.
+Set the following Kconfig options to retrieve GNSS assistance data from `nRF Cloud`_:
+
+* :kconfig:option:`CONFIG_NRF_CLOUD` - Enables `nRF Cloud`_ support.
 * :kconfig:option:`CONFIG_NRF_CLOUD_AGNSS` - Enables A-GNSS data retrieval from `nRF Cloud`_.
 * :kconfig:option:`CONFIG_NRF_CLOUD_PGPS` - Enables P-GPS data retrieval from `nRF Cloud`_.
 * :kconfig:option:`CONFIG_NRF_CLOUD_AGNSS_FILTERED` - Reduces assistance size by only downloading ephemerides for visible satellites.
@@ -270,7 +273,7 @@ The following options control the sensitivity of obstructed visibility detection
 These options set the threshold for how many satellites need to be found in how long a time period in order to conclude that the device is likely not indoors.
 Configuring the obstructed visibility detection is always a tradeoff between power consumption and the accuracy of detection.
 
-The following options control the transport method used with `nRF Cloud`_:
+To enable the transport method, set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option and select one of the following options:
 
 * :kconfig:option:`CONFIG_NRF_CLOUD_REST` - Uses REST APIs to communicate with `nRF Cloud`_ if :kconfig:option:`CONFIG_NRF_CLOUD_MQTT` is not set.
 * :kconfig:option:`CONFIG_NRF_CLOUD_MQTT` - Uses MQTT transport to communicate with `nRF Cloud`_.
diff --git a/doc/nrf/libraries/networking/lwm2m_location_assistance.rst b/doc/nrf/libraries/networking/lwm2m_location_assistance.rst
@@ -150,7 +150,7 @@ In such case, the device must resend the request after the previous request has
 Configuration
 *************
 
-To enable location assistance, configure either or both of the following Kconfig options:
+To enable location assistance, set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option and configure one or both of the following Kconfig options:
 
 * :kconfig:option:`CONFIG_LWM2M_CLIENT_UTILS_GNSS_ASSIST_OBJ_SUPPORT`
 * :kconfig:option:`CONFIG_LWM2M_CLIENT_UTILS_GROUND_FIX_OBJ_SUPPORT`
diff --git a/doc/nrf/libraries/networking/nrf_cloud.rst b/doc/nrf/libraries/networking/nrf_cloud.rst
@@ -25,7 +25,8 @@ The current implementation supports the following technologies:
 
 Initializing
 ************
-Before using any other APIs of the module, the application must call the :c:func:`nrf_cloud_init` function.
+
+Before using any other APIs of the module, set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option and call the :c:func:`nrf_cloud_init` function in the application.
 If this call fails, the application must not use any functions of the module.
 
 .. note::
diff --git a/doc/nrf/libraries/networking/nrf_cloud_agnss.rst b/doc/nrf/libraries/networking/nrf_cloud_agnss.rst
@@ -28,7 +28,7 @@ While ionospheric corrections can also be downloaded from the satellite broadcas
 Configuration
 *************
 
-Configure the following Kconfig options to enable or disable the use of this library:
+To enable this library, set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option and configure the following options:
 
 * :kconfig:option:`CONFIG_NRF_CLOUD_AGNSS`
 * :kconfig:option:`CONFIG_NRF_CLOUD_MQTT`, :kconfig:option:`CONFIG_NRF_CLOUD_REST`, or :kconfig:option:`CONFIG_NRF_CLOUD_COAP`
diff --git a/doc/nrf/libraries/networking/nrf_cloud_alert.rst b/doc/nrf/libraries/networking/nrf_cloud_alert.rst
@@ -53,7 +53,7 @@ The :c:func:`nrf_cloud_rest_alert_send` function initiates the connection as nee
 Configuration
 *************
 
-Configure the following Kconfig options to enable or disable the library and to select the data transport method:
+To enable this library, set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option and configure the following options to select the data transport method:
 
 * :kconfig:option:`CONFIG_NRF_CLOUD_ALERT`
 * :kconfig:option:`CONFIG_NRF_CLOUD_MQTT`, :kconfig:option:`CONFIG_NRF_CLOUD_REST`, or :kconfig:option:`CONFIG_NRF_CLOUD_COAP`.
diff --git a/doc/nrf/libraries/networking/nrf_cloud_coap.rst b/doc/nrf/libraries/networking/nrf_cloud_coap.rst
@@ -62,7 +62,7 @@ Connect the device to the network before calling the :c:func:`nrf_cloud_coap_con
 Configuration
 *************
 
-Configure the :kconfig:option:`CONFIG_NRF_CLOUD_COAP` option to enable or disable the use of this library.
+To enable this library, set the :kconfig:option:`CONFIG_NRF_CLOUD` and :kconfig:option:`CONFIG_NRF_CLOUD_COAP` Kconfig options.
 
 Additionally, the following Kconfig options are available:
 
diff --git a/doc/nrf/libraries/networking/nrf_cloud_location.rst b/doc/nrf/libraries/networking/nrf_cloud_location.rst
@@ -17,7 +17,7 @@ This library is an enhancement to the :ref:`lib_nrf_cloud` library.
 Configuration
 *************
 
-Configure the :kconfig:option:`CONFIG_NRF_CLOUD_LOCATION` Kconfig option to enable or disable the use of this library.
+To enable this library, set the :kconfig:option:`CONFIG_NRF_CLOUD` and :kconfig:option:`CONFIG_NRF_CLOUD_LOCATION` Kconfig options.
 
 Request and process location data
 *********************************
diff --git a/doc/nrf/libraries/networking/nrf_cloud_log.rst b/doc/nrf/libraries/networking/nrf_cloud_log.rst
@@ -75,7 +75,7 @@ The :c:func:`nrf_cloud_rest_log_send` function initiates the connection as neede
 Configuration
 *************
 
-Configure one or both of the following Kconfig options to enable direct log messages or the logging backend:
+To enable direct log messages or the logging backend, set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option and one or both of the following options:
 
 * :kconfig:option:`CONFIG_NRF_CLOUD_LOG_DIRECT`
 * :kconfig:option:`CONFIG_NRF_CLOUD_LOG_BACKEND`
diff --git a/doc/nrf/libraries/networking/nrf_cloud_pgps.rst b/doc/nrf/libraries/networking/nrf_cloud_pgps.rst
@@ -38,7 +38,7 @@ With A-GNSS, new ephemerides are needed on average every two hours, or if the fi
 Configuration
 *************
 
-Configure the :kconfig:option:`CONFIG_NRF_CLOUD_PGPS` Kconfig option to enable or disable the use of this library.
+To enable this library, set the :kconfig:option:`CONFIG_NRF_CLOUD` and :kconfig:option:`CONFIG_NRF_CLOUD_PGPS` Kconfig options.
 
 Configure one of the following options to control the network transport for P-GPS requests and responses:
 
diff --git a/doc/nrf/libraries/networking/nrf_cloud_rest.rst b/doc/nrf/libraries/networking/nrf_cloud_rest.rst
@@ -92,7 +92,7 @@ These are documented on the function itself.
 Configuration
 *************
 
-Configure the :kconfig:option:`CONFIG_NRF_CLOUD_REST` option to enable or disable the use of this library.
+To enable this library, set the :kconfig:option:`CONFIG_NRF_CLOUD` and :kconfig:option:`CONFIG_NRF_CLOUD_REST` Kconfig options.
 
 Additionally, configure the following options for the needs of your application:
 
diff --git a/doc/nrf/libraries/networking/nrf_provisioning.rst b/doc/nrf/libraries/networking/nrf_provisioning.rst
@@ -21,7 +21,7 @@ The current implementation supports the following technologies:
 Configuration
 *************
 
-To enable the library, set the :kconfig:option:`CONFIG_NRF_PROVISIONING` Kconfig option to ``y``.
+To enable the library, set the :kconfig:option:`CONFIG_NRF_CLOUD` and :kconfig:option:`CONFIG_NRF_PROVISIONING` Kconfig options.
 
 * :kconfig:option:`CONFIG_NRF_PROVISIONING_AUTO_INIT` - Initializes the client in the system initialization phase
 * :kconfig:option:`CONFIG_NRF_PROVISIONING_ROOT_CA_SEC_TAG` - Root CA security tag for the Provisioning Service
diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst
@@ -36,7 +36,15 @@ Libraries
 
 This section describes the changes related to libraries.
 
-|no_changes_yet_note|
+nRF Cloud library
+-----------------
+
+.. toggle::
+
+   For applications and samples using the :ref:`lib_nrf_cloud` library:
+
+   * You must set the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option to access the nRF Cloud libraries.
+     This option is now disabled by default to prevent the unintended inclusion of nRF Cloud Kconfig variables in non-nRF Cloud projects, addressing a previous issue.
 
 .. _migration_3.0_recommended:
 
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -644,6 +644,7 @@ Libraries for networking
 
 * :ref:`lib_nrf_cloud` library:
 
+  * Added the :kconfig:option:`CONFIG_NRF_CLOUD` Kconfig option to prevent unintended inclusion of nRF Cloud Kconfig variables in non-nRF Cloud projects.
   * Updated to use the :ref:`lib_downloader` library for CoAP downloads.
 
 Libraries for NFC
diff --git a/samples/cellular/gnss/prj.conf b/samples/cellular/gnss/prj.conf
@@ -15,6 +15,7 @@ CONFIG_LOG_MODE_IMMEDIATE=y
 
 # GNSS sample
 # Enable to use nRF Cloud A-GNSS
+CONFIG_NRF_CLOUD=y
 CONFIG_GNSS_SAMPLE_ASSISTANCE_NRF_CLOUD=n
 
 # LTE Link Control
diff --git a/samples/cellular/location/prj.conf b/samples/cellular/location/prj.conf
@@ -45,6 +45,7 @@ CONFIG_UART_INTERRUPT_DRIVEN=y
 CONFIG_AT_HOST_LIBRARY=y
 
 # nRF Cloud (for A-GNSS and cell location)
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_REST=y
 CONFIG_NRF_CLOUD_AGNSS=y
 CONFIG_MODEM_INFO=y # required by CONFIG_NRF_CLOUD_AGNSS
diff --git a/samples/cellular/lte_ble_gateway/prj.conf b/samples/cellular/lte_ble_gateway/prj.conf
@@ -28,6 +28,7 @@ CONFIG_NRF_MODEM_LIB_ON_FAULT_APPLICATION_SPECIFIC=y
 CONFIG_NRF_MODEM_LIB_TRACE=n
 
 # nRF Cloud
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_MQTT=y
 CONFIG_NRF_CLOUD_AGNSS=y
 
diff --git a/samples/cellular/modem_shell/prj.conf b/samples/cellular/modem_shell/prj.conf
@@ -128,6 +128,7 @@ CONFIG_LTE_LC_TAU_PRE_WARNING_MODULE=y
 CONFIG_DATE_TIME=y
 
 # nRF Cloud A-GNSS, disable this in case you want to enable SUPL below
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_AGNSS=y
 
 # SUPL A-GNSS support, needs the nRF9160 SiP SUPL client library from nRF9160 DK product page
diff --git a/samples/cellular/nrf_cloud_multi_service/prj.conf b/samples/cellular/nrf_cloud_multi_service/prj.conf
@@ -78,6 +78,7 @@ CONFIG_AT_HOST_LIBRARY=y
 CONFIG_NRF_CLOUD_CHECK_CREDENTIALS=y
 
 # nRF Cloud
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_MQTT=y # This also enables FOTA by implicitly setting CONFIG_NRF_CLOUD_FOTA=y
 
 # MQTT
diff --git a/samples/cellular/nrf_cloud_rest_cell_location/prj.conf b/samples/cellular/nrf_cloud_rest_cell_location/prj.conf
@@ -3,6 +3,7 @@ CONFIG_REST_CELL_LOCATION_DO_JITP=n
 CONFIG_NRF_CLOUD_REST_CELL_LOCATION_SAMPLE_LOG_LEVEL_INF=y
 
 # nRF Cloud REST
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_REST=y
 CONFIG_NRF_CLOUD_CLIENT_ID_SRC_IMEI=y
 CONFIG_NRF_CLOUD_REST_AUTOGEN_JWT=y
diff --git a/samples/cellular/nrf_cloud_rest_device_message/prj.conf b/samples/cellular/nrf_cloud_rest_device_message/prj.conf
@@ -7,6 +7,7 @@ CONFIG_MODEM_JWT=y
 CONFIG_NRF_CLOUD_REST_AUTOGEN_JWT=y
 
 # nRF Cloud REST
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_REST=y
 CONFIG_NRF_CLOUD_CLIENT_ID_SRC_IMEI=y
 CONFIG_NETWORKING=y
diff --git a/samples/cellular/nrf_cloud_rest_fota/prj.conf b/samples/cellular/nrf_cloud_rest_fota/prj.conf
@@ -3,6 +3,7 @@ CONFIG_REST_FOTA_DO_JITP=n
 CONFIG_NRF_CLOUD_REST_FOTA_SAMPLE_LOG_LEVEL_INF=y
 
 # nRF Cloud REST
+CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_REST=y
 CONFIG_NRF_CLOUD_CLIENT_ID_SRC_IMEI=y
 CONFIG_MODEM_JWT=y
diff --git a/subsys/net/lib/nrf_cloud/Kconfig b/subsys/net/lib/nrf_cloud/Kconfig
@@ -3,6 +3,13 @@
 # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 #
 
+config NRF_CLOUD
+	bool "nRF Cloud support"
+	help
+	  Enable configuration options for nRF Cloud.
+
+if NRF_CLOUD
+
 menu "nRF Cloud"
 
 menu "Transport"
@@ -165,3 +172,5 @@ module-help=Enables nRF Cloud log messages.
 source "subsys/logging/Kconfig.template.log_config"
 
 endmenu # "nRF Cloud"
+
+endif # NRF_CLOUD
diff --git a/tests/subsys/net/lib/nrf_cloud/client_id/prj.conf b/tests/subsys/net/lib/nrf_cloud/client_id/prj.conf
@@ -25,3 +25,6 @@ CONFIG_UART_INTERRUPT_DRIVEN=y
 CONFIG_MAIN_STACK_SIZE=3072
 CONFIG_HEAP_MEM_POOL_SIZE=16384
 CONFIG_AT_MONITOR_HEAP_SIZE=512
+
+# nRF Cloud support
+CONFIG_NRF_CLOUD=y
diff --git a/tests/subsys/net/lib/nrf_cloud/cloud/CMakeLists.txt b/tests/subsys/net/lib/nrf_cloud/cloud/CMakeLists.txt
@@ -85,3 +85,9 @@ if (CONFIG_NRF_CLOUD_MQTT OR CONFIG_NRF_CLOUD_FOTA OR CONFIG_NRF_MODEM_LIB)
 
 endif()
 # NRF CLOUD TEST END
+
+target_compile_options(app
+  PRIVATE
+  # Set the macro explicitly to log level DBG
+  -DCONFIG_NRF_CLOUD_LOG_LEVEL=4
+)
diff --git a/tests/subsys/net/lib/nrf_cloud/fota_common/prj.conf b/tests/subsys/net/lib/nrf_cloud/fota_common/prj.conf
@@ -20,3 +20,6 @@ CONFIG_FLASH_MAP=y
 CONFIG_STREAM_FLASH=y
 CONFIG_NEWLIB_LIBC=y
 CONFIG_NEWLIB_LIBC_FLOAT_PRINTF=y
+
+# nRF Cloud support
+CONFIG_NRF_CLOUD=y
