lib: modem_antenna: add new library for setting antenna configuration

Created a new library to set the antenna configuration on nRF9160 DK
and Thingy:91. The library sets the modem MAGPIO and COEX0
configuration depending on the selected board and the used GNSS
antenna type.

Removed MAGPIO and COEX0 configuration from LTE LC and Thingy:91
board.

CIA-385

Signed-off-by: Tommi Kangas <[email protected]>
Co-authored-by: Emanuele Di Santo <[email protected]>

Author: 2 people

CODEOWNERS

@@ -91,6 +91,7 @@ Kconfig*                                  @tejlmand
 /lib/flash_patch/                         @hakonfam
 /lib/location/                            @trantanen @hiltunent @jhirsi @tokangas
 /lib/lte_link_control/                    @jtguggedal @tokangas @simensrostad
+/lib/modem_antenna/                       @tokangas
 /lib/modem_info/                          @rlubos
 /lib/modem_key_mgmt/                      @rlubos
 /lib/multicell_location/                  @jhirsi @tokangas

boards/arm/thingy91_nrf9160/board_nonsecure.c

@@ -13,10 +13,6 @@ LOG_MODULE_REGISTER(board_nonsecure, CONFIG_BOARD_LOG_LEVEL);
 
 #define AT_CMD_MAX_READ_LENGTH	128
 #define AT_CMD_LEN(cmd)		(sizeof (cmd) - 1)
-#define AT_CMD_MAGPIO		"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"
-#define AT_CMD_COEX0		"AT%%XCOEX0=1,1,1565,1586"
 #define AT_CMD_TRACE		"AT%%XMODEMTRACE=0"
 
 static int thingy91_magpio_configure(void)
@@ -50,22 +46,6 @@ static int thingy91_magpio_configure(void)
 		return -EIO;
 	}
 
-	LOG_DBG("AT CMD: %s", log_strdup(AT_CMD_MAGPIO));
-	err = nrf_modem_at_printf(AT_CMD_MAGPIO);
-	if (err) {
-		LOG_ERR("MAGPIO command failed");
-		return -EIO;
-	}
-
-	LOG_DBG("AT CMD: %s", log_strdup(AT_CMD_COEX0));
-	err = nrf_modem_at_printf(AT_CMD_COEX0);
-	if (err) {
-		LOG_ERR("MAGPIO command failed");
-		return -EIO;
-	}
-
-	LOG_DBG("MAGPIO successfully configured");
-
 #endif
 	return 0;
 }

doc/nrf/libraries/modem/modem_antenna.rst

@@ -0,0 +1,48 @@
+.. _lib_modem_antenna:
+
+Modem antenna
+#############
+
+.. contents::
+   :local:
+   :depth: 2
+
+You can use this library to set the antenna configuration on an nRF9160 DK or a Thingy:91.
+
+Overview
+********
+
+The library writes the MAGPIO and COEX0 configuration to the modem after the :ref:`nrfxlib:nrf_modem` library has been initialized.
+The configuration depends on the selected board and the used GNSS antenna type, onboard or external.
+
+For an nRF9160 DK, the library configures the Low Noise Amplifier (LNA) depending on the GNSS antenna type.
+
+For a Thingy:91, it configures the antenna matching network used with both LTE and GNSS.
+
+Configuration
+*************
+
+Set the following Kconfig option to enable this library:
+
+* :kconfig:option:`CONFIG_MODEM_ANTENNA` - Enables the Modem antenna library.
+
+.. note::
+
+   The library is enabled by default when building for targets ``nrf9160dk_nrf9160_ns`` and ``thingy91_nrf9160_ns``.
+
+Use one of the following options to select the used antenna type:
+
+* :kconfig:option:`CONFIG_MODEM_ANTENNA_GNSS_ONBOARD` - Selects the onboard GNSS antenna (default).
+* :kconfig:option:`CONFIG_MODEM_ANTENNA_GNSS_EXTERNAL` - Selects an external GNSS antenna.
+
+Use the following options to set custom AT commands for MAGPIO and COEX0 configuration:
+
+* :kconfig:option:`CONFIG_MODEM_ANTENNA_AT_MAGPIO` - Sets custom MAGPIO configuration.
+* :kconfig:option:`CONFIG_MODEM_ANTENNA_AT_COEX0` - Sets custom COEX0 configuration.
+
+Dependencies
+************
+
+This library uses the following `sdk-nrfxlib`_ library:
+
+* :ref:`nrfxlib:nrf_modem`

doc/nrf/releases/release-notes-changelog.rst

@@ -360,6 +360,12 @@ Bluetooth libraries and services
 Modem libraries
 ---------------
 
+* Added:
+
+  * :ref:`lib_modem_antenna` library:
+
+    * A new library for setting the antenna configuration on an nRF9160 DK or a Thingy:91.
+
 * Updated:
 
   * :ref:`sms_readme` library:

lib/CMakeLists.txt

@@ -34,3 +34,4 @@ add_subdirectory_ifdef(CONFIG_MODEM_ATTEST_TOKEN modem_attest_token)
 add_subdirectory_ifdef(CONFIG_MULTICELL_LOCATION multicell_location)
 add_subdirectory_ifdef(CONFIG_LOCATION location)
 add_subdirectory_ifdef(CONFIG_AT_SHELL at_shell)
+add_subdirectory_ifdef(CONFIG_MODEM_ANTENNA modem_antenna)

lib/Kconfig

@@ -35,5 +35,6 @@ rsource "modem_attest_token/Kconfig"
 rsource "multicell_location/Kconfig"
 rsource "location/Kconfig"
 rsource "at_shell/Kconfig"
+rsource "modem_antenna/Kconfig"
 
 endmenu

lib/lte_link_control/lte_lc_modem_hooks.c

@@ -12,27 +12,14 @@
 LOG_MODULE_DECLARE(lte_lc);
 
 NRF_MODEM_LIB_ON_INIT(lte_lc_init_hook, on_modem_init, NULL);
-NRF_MODEM_LIB_ON_SHUTDOWN(lte_lc_shutdown_hook, on_shutdown, NULL);
+NRF_MODEM_LIB_ON_SHUTDOWN(lte_lc_shutdown_hook, on_modem_shutdown, NULL);
 
 static void on_modem_init(int err, void *ctx)
 {
 	if (err) {
 		return;
 	}
 
-#if defined(CONFIG_BOARD_THINGY91_NRF9160_NS)
-	/* Configuring MAGPIO, so that the correct antenna
-	 * matching network is used for each LTE band and GPS.
-	 */
-	err = nrf_modem_at_printf("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 (err) {
-		LOG_ERR("Failed to configure MAGPIO, err %d", err);
-		return;
-	}
-#endif
-
 #if defined(CONFIG_LTE_EDRX_REQ)
 	/* Request configured eDRX settings to save power */
 	err = lte_lc_edrx_req(true);
@@ -81,7 +68,7 @@ static void on_modem_init(int err, void *ctx)
 #endif
 }
 
-static void on_shutdown(void *ctx)
+static void on_modem_shutdown(void *ctx)
 {
 	(void)lte_lc_deinit();
 }

lib/modem_antenna/CMakeLists.txt

@@ -0,0 +1,8 @@
+#
+# Copyright (c) 2022 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+zephyr_library()
+zephyr_library_sources(modem_antenna.c)

lib/modem_antenna/Kconfig

@@ -0,0 +1,47 @@
+#
+# Copyright (c) 2022 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+menuconfig MODEM_ANTENNA
+	bool "Modem antenna configuration"
+	depends on NRF_MODEM_LIB
+	default y if (BOARD_NRF9160DK_NRF9160_NS || BOARD_THINGY91_NRF9160_NS)
+
+if MODEM_ANTENNA
+
+choice
+	default MODEM_ANTENNA_GNSS_ONBOARD
+	prompt "Select which antenna to use for GNSS"
+
+config MODEM_ANTENNA_GNSS_ONBOARD
+	bool "Use onboard antenna"
+
+config MODEM_ANTENNA_GNSS_EXTERNAL
+	bool "Use external antenna"
+
+endchoice
+
+config MODEM_ANTENNA_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 the modem. Leave
+	  empty if this command should not be sent.
+
+config MODEM_ANTENNA_AT_COEX0
+	string "AT%XCOEX0 command"
+	default "AT\%XCOEX0=1,1,1565,1586" if (BOARD_NRF9160DK_NRF9160_NS || BOARD_THINGY91_NRF9160_NS) && MODEM_ANTENNA_GNSS_ONBOARD
+	default "AT\%XCOEX0" if (BOARD_NRF9160DK_NRF9160_NS || BOARD_THINGY91_NRF9160_NS) && MODEM_ANTENNA_GNSS_EXTERNAL
+	help
+	  Defines the AT%XCOEX0 command to be sent to the modem. Leave
+	  empty if this command should not be sent.
+
+module=MODEM_ANTENNA
+module-dep=LOG
+module-str=Modem antenna
+source "${ZEPHYR_BASE}/subsys/logging/Kconfig.template.log_config"
+
+endif # MODEM_ANTENNA

lib/modem_antenna/modem_antenna.c

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <string.h>
+#include <nrf_modem_at.h>
+#include <modem/nrf_modem_lib.h>
+#include <logging/log.h>
+
+LOG_MODULE_REGISTER(modem_antenna, CONFIG_MODEM_ANTENNA_LOG_LEVEL);
+
+NRF_MODEM_LIB_ON_INIT(gnss_cfg_init_hook, on_modem_lib_init, NULL);
+
+static void on_modem_lib_init(int ret, void *ctx)
+{
+	if (ret != 0) {
+		return;
+	}
+
+	if (strlen(CONFIG_MODEM_ANTENNA_AT_MAGPIO) > 0) {
+		LOG_DBG("Setting MAGPIO configuration: %s", CONFIG_MODEM_ANTENNA_AT_MAGPIO);
+		if (nrf_modem_at_printf("%s", CONFIG_MODEM_ANTENNA_AT_MAGPIO) != 0) {
+			LOG_ERR("Failed to set MAGPIO configuration");
+		}
+	}
+
+	if (strlen(CONFIG_MODEM_ANTENNA_AT_COEX0) > 0) {
+		LOG_DBG("Setting COEX0 configuration: %s", CONFIG_MODEM_ANTENNA_AT_COEX0);
+		if (nrf_modem_at_printf("%s", CONFIG_MODEM_ANTENNA_AT_COEX0) != 0) {
+			LOG_ERR("Failed to set COEX0 configuration");
+		}
+	}
+}