lib: lte_link_control: Add PDN suspend/resume support

Added new PDN events LTE_LC_EVT_PDN_SUSPENDED and
LTE_LC_EVT_PDN_RESUMED. These events supported by the
mfw_nrf9151-ntn modem firmware are used with
cellular profiles to indicate when PDNs are active,
but temporarily not usable.

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

Author: tokangas

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

@@ -406,7 +406,9 @@ Security libraries
 Modem libraries
 ---------------
 
-|no_changes_yet_note|
+* :ref:`lte_lc_readme` library:
+
+  * Added support for new PDN events :c:enumerator:`LTE_LC_EVT_PDN_SUSPENDED` and :c:enumerator:`LTE_LC_EVT_PDN_RESUMED`.
 
 Multiprotocol Service Layer libraries
 -------------------------------------

include/modem/lte_lc.h

@@ -455,8 +455,8 @@ enum lte_lc_evt_type {
 	 * @ref lte_lc_rai_cfg in the event.
 	 *
 	 * @note This is only supported by the following modem firmware:
-	 * - mfw_nrf91x1 >= v2.0.2
-	 * - mfw_nrf9151-ntn
+	 *       - mfw_nrf91x1 >= v2.0.2
+	 *       - mfw_nrf9151-ntn
 	 */
 	LTE_LC_EVT_RAI_UPDATE			= 12,
 #endif /* CONFIG_LTE_LC_RAI_MODULE */
@@ -1481,6 +1481,36 @@ enum lte_lc_pdn_evt_type {
 	 */
 	LTE_LC_EVT_PDN_IPV6_DOWN,
 
+	/**
+	 * PDN is suspended.
+	 *
+	 * PDNs can be suspended when cellular profiles are used. While suspended, the PDNs remain
+	 * active, but can not be used for data transmission. PDNs associated with a cellular
+	 * profile are suspended when the device is switched to flight mode using
+	 * @ref LTE_LC_FUNC_MODE_OFFLINE_KEEP_REG or @ref LTE_LC_FUNC_MODE_OFFLINE_KEEP_REG_UICC_ON.
+	 * The PDNs remain suspended when switching to a different access technology. When the
+	 * device is switched back to the original access technology and LTE is activated, the
+	 * associated PDNs are resumed.
+	 *
+	 * The associated payload is the @c lte_lc_evt.pdn member of type
+	 * @ref lte_lc_pdn_evt in the event.
+	 *
+	 * @note This is only supported by the following modem firmware:
+	 *       - mfw_nrf9151-ntn
+	 */
+	LTE_LC_EVT_PDN_SUSPENDED,
+
+	/**
+	 * PDN is resumed.
+	 *
+	 * The associated payload is the @c lte_lc_evt.pdn member of type
+	 * @ref lte_lc_pdn_evt in the event.
+	 *
+	 * @note This is only supported by the following modem firmware:
+	 *       - mfw_nrf9151-ntn
+	 */
+	LTE_LC_EVT_PDN_RESUMED,
+
 	/**
 	 * Network detached.
 	 *

lib/lte_link_control/modules/pdn.c

@@ -196,6 +196,10 @@ static void parse_cgev(const char *notif)
 		{"ME PDN DEACT ", LTE_LC_EVT_PDN_DEACTIVATED},
 		/* +CGEV: NW PDN DEACT <cid> */
 		{"NW PDN DEACT ", LTE_LC_EVT_PDN_DEACTIVATED},
+		/* +CGEV: ME PDN SUSPENDED <cid> */
+		{"ME PDN SUSPENDED ", LTE_LC_EVT_PDN_SUSPENDED},
+		/* +CGEV: ME PDN RESUMED <cid> */
+		{"ME PDN RESUMED ", LTE_LC_EVT_PDN_RESUMED},
 		/* +CGEV: ME DETACH [<cp_id>] */
 		{"ME DETACH",  LTE_LC_EVT_PDN_NETWORK_DETACH},
 		/* +CGEV: NW DETACH [<cp_id>] */
@@ -244,6 +248,8 @@ static void parse_cgev(const char *notif)
 			case LTE_LC_EVT_PDN_DEACTIVATED:
 			case LTE_LC_EVT_PDN_IPV6_UP:
 			case LTE_LC_EVT_PDN_IPV6_DOWN:
+			case LTE_LC_EVT_PDN_SUSPENDED:
+			case LTE_LC_EVT_PDN_RESUMED:
 				evt.pdn.cid = (int8_t)strtoul(p, &p, 10);
 
 				break;

samples/cellular/modem_shell/src/link/link_shell_pdn.c

@@ -41,6 +41,8 @@ const char *link_pdn_event_to_string(enum lte_lc_evt_type event, char *out_str_b
 		{ LTE_LC_EVT_PDN_DEACTIVATED, "deactivated" },
 		{ LTE_LC_EVT_PDN_IPV6_UP, "IPv6 up" },
 		{ LTE_LC_EVT_PDN_IPV6_DOWN, "IPv6 down" },
+		{ LTE_LC_EVT_PDN_SUSPENDED, "suspended" },
+		{ LTE_LC_EVT_PDN_RESUMED, "resumed" },
 		{ LTE_LC_EVT_PDN_NETWORK_DETACH, "network detach" },
 		{ LTE_LC_EVT_PDN_APN_RATE_CONTROL_ON, "APN rate control on" },
 		{ LTE_LC_EVT_PDN_APN_RATE_CONTROL_OFF, "APN rate control off" },

tests/lib/lte_lc_pdn/src/main.c

@@ -943,6 +943,8 @@ static void lte_lc_event_handler(const struct lte_lc_evt *const evt)
 		case LTE_LC_EVT_PDN_DEACTIVATED:
 		case LTE_LC_EVT_PDN_IPV6_UP:
 		case LTE_LC_EVT_PDN_IPV6_DOWN:
+		case LTE_LC_EVT_PDN_SUSPENDED:
+		case LTE_LC_EVT_PDN_RESUMED:
 		case LTE_LC_EVT_PDN_NETWORK_DETACH:
 		case LTE_LC_EVT_PDN_APN_RATE_CONTROL_ON:
 		case LTE_LC_EVT_PDN_APN_RATE_CONTROL_OFF:
@@ -1388,6 +1390,22 @@ void test_lte_lc_pdn_deactivate(void)
 	TEST_ASSERT_EQUAL(LTE_LC_EVT_PDN_DEACTIVATED, pdn_evt.pdn.type);
 }
 
+void test_lte_lc_pdn_suspended(void)
+{
+	on_cgev("+CGEV: ME PDN SUSPENDED " STRINGIFY(CID_0) "\r\n");
+	TEST_ASSERT_EQUAL(LTE_LC_EVT_PDN, pdn_evt.type);
+	TEST_ASSERT_EQUAL(LTE_LC_EVT_PDN_SUSPENDED, pdn_evt.pdn.type);
+	TEST_ASSERT_EQUAL(CID_0, pdn_evt.pdn.cid);
+}
+
+void test_lte_lc_pdn_resumed(void)
+{
+	on_cgev("+CGEV: ME PDN RESUMED " STRINGIFY(CID_1) "\r\n");
+	TEST_ASSERT_EQUAL(LTE_LC_EVT_PDN, pdn_evt.type);
+	TEST_ASSERT_EQUAL(LTE_LC_EVT_PDN_RESUMED, pdn_evt.pdn.type);
+	TEST_ASSERT_EQUAL(CID_1, pdn_evt.pdn.cid);
+}
+
 void test_lte_lc_pdn_detach(void)
 {
 	on_cgev("+CGEV: NW DETACH\r\n");