samples: use modem_antenna library for configuring GNSS LNA

Updated samples and applications to use the new modem_antenna
library for configuring GNSS Low Noise Amplifier (LNA) instead
of having the same implementation in multiple places.

Signed-off-by: Tommi Kangas <[email protected]>

Author: tokangas

applications/asset_tracker_v2/doc/asset_tracker_v2_description.rst

@@ -243,6 +243,10 @@ You can add the following optional configurations to configure the heap or to pr
 * :kconfig:option:`CONFIG_PDN_DEFAULTS_OVERRIDE` - Used for manual configuration of the APN. Set the option to ``y`` to override the default PDP context configuration.
 * :kconfig:option:`CONFIG_PDN_DEFAULT_APN` - Used for manual configuration of the APN. An example is ``apn.example.com``.
 
+If you use an external GNSS antenna, add the following configuration:
+
+* :kconfig:option:`CONFIG_MODEM_ANTENNA_GNSS_EXTERNAL` - Selects an external GNSS antenna.
+
 Configuration files
 ===================
 
@@ -292,7 +296,7 @@ See :ref:`Building with overlays <building_with_overlays>` for information on ho
 
 .. note::
 
-   When you build the application for the nRF9160 DK v0.15.0 and later, set the :ref:`CONFIG_GNSS_MODULE_ANTENNA_EXTERNAL <CONFIG_GNSS_MODULE_ANTENNA_EXTERNAL>` option to ``y`` to achieve the best external antenna performance.
+   When you build the application for the nRF9160 DK v0.15.0 and later, set the :kconfig:option:`CONFIG_MODEM_ANTENNA_GNSS_EXTERNAL` option to ``y`` to achieve the best external antenna performance.
 
 .. external_antenna_note_end
 

applications/asset_tracker_v2/doc/gnss_module.rst

@@ -41,8 +41,9 @@ LNA configuration
 =================
 
 Different devices have different antenna and LNA setups depending on the antenna type (onboard or external).
-The module has Kconfig options to control the LNA using either the COEX0 or MAGPIO interface of the nRF9160.
-See :ref:`configuration_options` for more details on how to configure the antenna and LNA.
+The application uses the :ref:`lib_modem_antenna` library for configuring the LNA.
+The library has Kconfig options to control the LNA using either the COEX0 or MAGPIO interface of the nRF9160.
+See the library documentation for more details on how to configure the antenna and LNA.
 
 GPS assistance data
 ===================
@@ -84,16 +85,6 @@ CONFIG_GNSS_MODULE_PVT
 CONFIG_GNSS_MODULE_NMEA
    Selects the NMEA format. Includes an NMEA string of the GGA type in the ``GNSS_EVT_DATA_READY`` events that are sent when the GNSS acquires a position fix.
 
-.. _CONFIG_GNSS_MODULE_ANTENNA_ONBOARD:
-
-CONFIG_GNSS_MODULE_ANTENNA_ONBOARD
-   This configures the target to use an onboard GNSS antenna. Sends antenna configurations to the modem when you compile for Thingy:91 or nRF9160 DK.
-
-.. _CONFIG_GNSS_MODULE_ANTENNA_EXTERNAL:
-
-CONFIG_GNSS_MODULE_ANTENNA_EXTERNAL
-   This configures the target to use an external GNSS antenna.
-
 If P-GPS is used, the last known position from a GNSS fix can be stored and injected to the modem together with the relevant ephemeris.
 This may, depending on the use case and the device's movements, reduce the time to fix.
 To enable this feature, use the following option:

applications/asset_tracker_v2/src/modules/Kconfig.gnss_module

@@ -49,34 +49,6 @@ config GNSS_MODULE_ELEVATION_MASK
 	default NRF_CLOUD_AGPS_ELEVATION_MASK
 	depends on NRF_CLOUD_AGPS_FILTERED
 
-choice GNSS_MODULE_ANTENNA
-	default GNSS_MODULE_ANTENNA_ONBOARD
-	prompt "Select which antenna to use for GNSS"
-
-config GNSS_MODULE_ANTENNA_ONBOARD
-	bool "Use onboard antenna"
-
-config GNSS_MODULE_ANTENNA_EXTERNAL
-	bool "Use external antenna"
-
-endchoice
-
-config GNSS_MODULE_AT_MAGPIO
-	string "AT%XMAGPIO command"
-	default "AT\%XMAGPIO=1,0,0,1,1,1574,1577" if BOARD_NRF9160DK_NRF9160_NS
-	default "AT\%XMAGPIO=1,1,1,7,1,746,803,2,698,748,2,1710,2200,3,824,894,4,880,960,5,791,849,7,1565,1586" if BOARD_THINGY91_NRF9160_NS
-	help
-	  Defines what is the AT%XMAGPIO command to be sent to GNSS module. Leave
-	  empty if this command should not be sent.
-
-config GNSS_MODULE_AT_COEX0
-	string "AT%XCOEX0 command"
-	default "AT\%XCOEX0=1,1,1565,1586" if (BOARD_NRF9160DK_NRF9160_NS || BOARD_THINGY91_NRF9160_NS) && GNSS_MODULE_ANTENNA_ONBOARD
-	default "AT\%XCOEX0" if (BOARD_NRF9160DK_NRF9160_NS || BOARD_THINGY91_NRF9160_NS) && GNSS_MODULE_ANTENNA_EXTERNAL
-	help
-	  Defines what is the AT%XCOEX0 command to be sent to GNSS module. Leave
-	  empty if this command should not be sent.
-
 endif # GNSS_MODULE
 
 module = GNSS_MODULE

applications/asset_tracker_v2/src/modules/gnss_module.c

@@ -508,43 +508,10 @@ static bool gnss_data_requested(enum app_module_data_type *data_list,
 	return false;
 }
 
-static int lna_configure(void)
-{
-	int err;
-	const char *xmagpio_command = CONFIG_GNSS_MODULE_AT_MAGPIO;
-	const char *xcoex0_command = CONFIG_GNSS_MODULE_AT_COEX0;
-
-	LOG_DBG("MAGPIO command: %s", log_strdup(xmagpio_command));
-	LOG_DBG("COEX0 command: %s", log_strdup(xcoex0_command));
-
-	/* Make sure the AT command is not empty. */
-	if (xmagpio_command[0] != '\0') {
-		err = nrf_modem_at_printf("%s", xmagpio_command);
-		if (err) {
-			return err;
-		}
-	}
-
-	if (xcoex0_command[0] != '\0') {
-		err = nrf_modem_at_printf("%s", xcoex0_command);
-		if (err) {
-			return err;
-		}
-	}
-
-	return 0;
-}
-
 static int setup(void)
 {
 	int err;
 
-	err = lna_configure();
-	if (err) {
-		LOG_ERR("Failed to configure LNA, error %d", err);
-		return err;
-	}
-
 	err = nrf_modem_gnss_event_handler_set(gnss_event_handler);
 	if (err) {
 		LOG_ERR("Failed to set GNSS event handler, error %d", err);

applications/asset_tracker_v2/tests/gnss_module/CMakeLists.txt

@@ -38,6 +38,4 @@ target_include_directories(app PRIVATE ${ZEPHYR_BASE}/../nrf/modules/cjson/inclu
 # Options that cannot be passed through Kconfig fragments.
 target_compile_options(app PRIVATE
 	-DCONFIG_ASSET_TRACKER_V2_APP_VERSION_MAX_LEN=20
-	-DCONFIG_GNSS_MODULE_NMEA
-	-DCONFIG_GNSS_MODULE_AT_MAGPIO="AT%XMAGPIO"
-	-DCONFIG_GNSS_MODULE_AT_COEX0="AT%XCOEX0")
+	-DCONFIG_GNSS_MODULE_NMEA)

applications/asset_tracker_v2/tests/gnss_module/src/gnss_module_test.c

@@ -256,10 +256,6 @@ static void setup_gnss_module_in_init_state(void)
 	__wrap_app_event_manager_free_ExpectAnyArgs();
 	struct app_module_event *app_module_event = new_app_module_event();
 
-	/* AT%XMAGPIO and AT%XCOEX0 AT commands for LNA configuration. */
-	__wrap_nrf_modem_at_printf_ExpectAnyArgsAndReturn(0);
-	__wrap_nrf_modem_at_printf_ExpectAnyArgsAndReturn(0);
-
 	__wrap_nrf_modem_gnss_event_handler_set_AddCallback(
 		&nrf_modem_gnss_event_handler_set_callback);
 	__wrap_nrf_modem_gnss_event_handler_set_ExpectAnyArgsAndReturn(0);

samples/nrf9160/gnss/Kconfig

@@ -60,34 +60,6 @@ config GNSS_SAMPLE_NMEA_ONLY
 	help
 	  Outputs only NMEA strings from the GNSS.
 
-choice
-	default GNSS_SAMPLE_ANTENNA_ONBOARD
-	prompt "Select which antenna to use for GNSS"
-
-config GNSS_SAMPLE_ANTENNA_ONBOARD
-	bool "Use onboard antenna"
-
-config GNSS_SAMPLE_ANTENNA_EXTERNAL
-	bool "Use external antenna"
-
-endchoice
-
-config GNSS_SAMPLE_AT_MAGPIO
-	string "AT%XMAGPIO command"
-	default "AT\%XMAGPIO=1,0,0,1,1,1574,1577" if BOARD_NRF9160DK_NRF9160_NS
-	default "AT\%XMAGPIO=1,1,1,7,1,746,803,2,698,748,2,1710,2200,3,824,894,4,880,960,5,791,849,7,1565,1586" if BOARD_THINGY91_NRF9160_NS
-	help
-	  Defines the AT%XMAGPIO command to be sent to GNSS module. Leave
-	  empty if this command should not be sent.
-
-config GNSS_SAMPLE_AT_COEX0
-	string "AT%XCOEX0 command"
-	default "AT\%XCOEX0=1,1,1565,1586" if (BOARD_NRF9160DK_NRF9160_NS || BOARD_THINGY91_NRF9160_NS) && GNSS_SAMPLE_ANTENNA_ONBOARD
-	default "AT\%XCOEX0" if (BOARD_NRF9160DK_NRF9160_NS || BOARD_THINGY91_NRF9160_NS) && GNSS_SAMPLE_ANTENNA_EXTERNAL
-	help
-	  Defines the AT%XCOEX0 command to be sent to GNSS module. Leave
-	  empty if this command should not be sent.
-
 endmenu
 
 choice

samples/nrf9160/gnss/README.rst

@@ -154,6 +154,13 @@ CONFIG_GNSS_SAMPLE_LTE_ON_DEMAND - To disable LTE after assistance download
    When using assistance, LTE may block the GNSS operation and increase the time needed to get a fix.
    This configuration option disables LTE after the assistance data has been downloaded, so that GNSS can run without interruptions.
 
+Additional configuration
+========================
+
+Check and configure the following library option that is used by the sample:
+
+* :kconfig:option:`CONFIG_MODEM_ANTENNA_GNSS_EXTERNAL` - Selects an external GNSS antenna.
+
 Building and running
 ********************
 

samples/nrf9160/gnss/prj.conf

@@ -15,8 +15,6 @@ CONFIG_LOG=y
 CONFIG_LOG_MODE_IMMEDIATE=y
 
 # GNSS sample
-# Enable to use an external GNSS antenna
-CONFIG_GNSS_SAMPLE_ANTENNA_EXTERNAL=n
 # Enable to use nRF Cloud A-GPS
 CONFIG_GNSS_SAMPLE_ASSISTANCE_NRF_CLOUD=n
 

samples/nrf9160/gnss/src/main.c

@@ -331,20 +331,6 @@ static void date_time_evt_handler(const struct date_time_evt *evt)
 
 static int modem_init(void)
 {
-	if (strlen(CONFIG_GNSS_SAMPLE_AT_MAGPIO) > 0) {
-		if (nrf_modem_at_printf("%s", CONFIG_GNSS_SAMPLE_AT_MAGPIO) != 0) {
-			LOG_ERR("Failed to set MAGPIO configuration");
-			return -1;
-		}
-	}
-
-	if (strlen(CONFIG_GNSS_SAMPLE_AT_COEX0) > 0) {
-		if (nrf_modem_at_printf("%s", CONFIG_GNSS_SAMPLE_AT_COEX0) != 0) {
-			LOG_ERR("Failed to set COEX0 configuration");
-			return -1;
-		}
-	}
-
 	if (IS_ENABLED(CONFIG_DATE_TIME)) {
 		date_time_register_handler(date_time_evt_handler);
 	}