modules: network: Add test cases and fix implementation accordingly

Add more test cases to cover all input and output event types
that the network module supports.
Implementation added and fixed for those not working as intended.

Signed-off-by: Jan Tore Guggedal <jantore.guggedal@nordicsemi.no>

Author: jtguggedal

app/src/common/message_channel.h

@@ -55,25 +55,85 @@ struct payload {
 
 enum network_msg_type {
 	/* Output message types */
+
+	/* The device is disconnected from the network */
 	NETWORK_DISCONNECTED = 0x1,
+
+	/* The device is connected to the network and has an IP address */
 	NETWORK_CONNECTED,
+
+	/* The modem has detected a reset loop with too many attach requests within a short time.
+	 * Refer to the AT command manual for more information on the details for your specific
+	 * modem firmware version.
+	 */
 	NETWORK_MODEM_RESET_LOOP,
+
+	/* The modem has detected an error with the SIM card. Confirm that it is installed
+	 * correctly.
+	 */
 	NETWORK_UICC_FAILURE,
+
+	/* The modem has completed a light search based on previous cell hostory for network to
+	 * attach to without finding a suitable cell accoring to 3GPP selection rules.
+	 * The modem will continue with a more thorough search unless it is explicitly stopped.
+	 */
 	NETWORK_LIGHT_SERACH_DONE,
+
+	/* A network attach request has been rejected by the network. */
 	NETWORK_ATTACH_REJECTED,
+
+	/* Updated PSM parameters have been received and are found as payload in the message.
+	 * The parameters are located in the .psm_cfg field of the message.
+	 */
 	NETWORK_PSM_PARAMS,
+
+	/* Updated eDRX parameters have been received and are found as payload in the message.
+	 * The parameters are located in the .edrx_cfg field of the message.
+	 */
 	NETWORK_EDRX_PARAMS,
+
+	/* Response message to a request for the current system mode. The current system mode is
+	 * found in the .system_mode field of the message. In this context, "current system mode"
+	 * refers to the system mode that the modem is currently configured to use and may include
+	 * both LTE-M and NB-IoT. It does not reflect if the modem is currently connected to a
+	 * network using a specific system mode.
+	 */
 	NETWORK_SYSTEM_MODE_RESPONSE,
+
+	/* Response message to a request for a network quality sample. The sample is found in the
+	 * .conn_eval_params field of the message.
+	 */
 	NETWORK_QUALITY_SAMPLE_RESPONSE,
 
 	/* Input message types */
+
+	/* Request to connect to the network, which includes searching for a suitable network
+	 * and attempting to attach to it if a usable cell is found.
+	 */
 	NETWORK_CONNECT,
+
+	/* Request to disconnect from the network */
 	NETWORK_DISCONNECT,
+
+	/* Stop searching for a network. This will stop the modem's search for a suitable network
+	 * and it will not resume before explicitly requested to do so by a NETWORK_CONNECT message.
+	 */
 	NETWORK_SEARCH_STOP,
-	NETWORK_SEARCH_START,
+
+	/* Request to sample the current network connection quality. The result is sent as a
+	 * NETWORK_QUALITY_SAMPLE_RESPONSE message if possible to obtain.
+	 */
 	NETWORK_QUALITY_SAMPLE_REQUEST,
+
+	/* Request to set the system mode to only use LTE-M access technology. */
 	NETWORK_SYSTEM_MODE_SET_LTE_M,
+
+	/* Request to set the system mode to only use NB-IoT access technology. */
 	NETWORK_SYSTEM_MODE_SET_NBIOT,
+
+	/* Request to retrieve the current system mode. The response is sent as a
+	 * NETWORK_SYSTEM_MODE_RESPONSE message.
+	 */
 	NETWORK_SYSTEM_MODE_REQUEST,
 };
 

app/src/modules/network/network.c

@@ -67,7 +67,7 @@ enum network_module_state {
 /* State object.
  * Used to transfer context data between state changes.
  */
-struct state_object {
+struct network_state_object {
 	/* This must be first */
 	struct smf_ctx ctx;
 
@@ -87,10 +87,11 @@ static void state_disconnected_idle_run(void *obj);
 static void state_disconnected_searching_entry(void *obj);
 static void state_disconnected_searching_run(void *obj);
 static void state_disconnecting_entry(void *obj);
+static void state_disconnecting_run(void *obj);
 static void state_connected_run(void *obj);
 static void state_connected_entry(void *obj);
 
-static struct state_object network_state;
+static struct network_state_object network_state;
 
 /* State machine definition */
 static const struct smf_state states[] = {
@@ -116,7 +117,7 @@ static const struct smf_state states[] = {
 				 &states[STATE_RUNNING],
 				 NULL), /* No initial transition */
 	[STATE_DISCONNECTING] =
-		SMF_CREATE_STATE(state_disconnecting_entry, NULL, NULL,
+		SMF_CREATE_STATE(state_disconnecting_entry, state_disconnecting_run, NULL,
 				 &states[STATE_RUNNING],
 				 NULL), /* No initial transition */
 };
@@ -221,7 +222,7 @@ static void lte_lc_evt_handler(const struct lte_lc_evt *const evt)
 			.edrx_cfg = evt->edrx_cfg,
 		};
 
-		LOG_DBG("eDRX parameters received, mode: %d, eDRX: %0.2f s, PTW: %f s",
+		LOG_DBG("eDRX parameters received, mode: %d, eDRX: %0.2f s, PTW: %.02f s",
 			msg.edrx_cfg.mode, (double)msg.edrx_cfg.edrx, (double)msg.edrx_cfg.ptw);
 
 		network_msg_send(&msg);
@@ -256,6 +257,24 @@ static void sample_network_quality(void)
 	network_msg_send(&msg);
 }
 
+static void request_system_mode(void)
+{
+	int err;
+	struct network_msg msg = {
+		.type = NETWORK_SYSTEM_MODE_RESPONSE,
+	};
+	enum lte_lc_system_mode_preference dummy_preference;
+
+	err = lte_lc_system_mode_get(&msg.system_mode, &dummy_preference);
+	if (err) {
+		LOG_ERR("lte_lc_system_mode_get, error: %d", err);
+		SEND_FATAL_ERROR();
+		return;
+	}
+
+	network_msg_send(&msg);
+}
+
 static int network_disconnect(void)
 {
 	int err;
@@ -306,7 +325,7 @@ static void state_running_entry(void *obj)
 
 static void state_running_run(void *obj)
 {
-	struct state_object const *state_object = obj;
+	struct network_state_object const *state_object = obj;
 
 	LOG_DBG("state_running_run");
 
@@ -323,6 +342,9 @@ static void state_running_run(void *obj)
 		case NETWORK_QUALITY_SAMPLE_REQUEST:
 			sample_network_quality();
 			break;
+		case NETWORK_SYSTEM_MODE_REQUEST:
+			request_system_mode();
+			break;
 		default:
 			break;
 		}
@@ -350,7 +372,7 @@ static void state_disconnected_entry(void *obj)
 
 static void state_disconnected_run(void *obj)
 {
-	struct state_object const *state_object = obj;
+	struct network_state_object const *state_object = obj;
 
 	LOG_DBG("state_disconnected_run");
 
@@ -398,7 +420,7 @@ static void state_disconnected_searching_entry(void *obj)
 
 static void state_disconnected_searching_run(void *obj)
 {
-	struct state_object const *state_object = obj;
+	struct network_state_object const *state_object = obj;
 
 	LOG_DBG("state_disconnected_searching_run");
 
@@ -421,7 +443,7 @@ static void state_disconnected_searching_run(void *obj)
 
 static void state_disconnected_idle_run(void *obj)
 {
-	struct state_object const *state_object = obj;
+	struct network_state_object const *state_object = obj;
 
 	LOG_DBG("state_disconnected_idle_run");
 
@@ -432,7 +454,6 @@ static void state_disconnected_idle_run(void *obj)
 		case NETWORK_DISCONNECT:
 			STATE_EVENT_HANDLED(network_state);
 			break;
-		case NETWORK_SEARCH_START: __fallthrough;
 		case NETWORK_CONNECT:
 			STATE_SET(network_state, STATE_DISCONNECTED_SEARCHING);
 			break;
@@ -451,7 +472,7 @@ static void state_connected_entry(void *obj)
 
 static void state_connected_run(void *obj)
 {
-	struct state_object const *state_object = obj;
+	struct network_state_object const *state_object = obj;
 
 	LOG_DBG("state_connected_run");
 
@@ -492,6 +513,21 @@ static void state_disconnecting_entry(void *obj)
 	}
 }
 
+static void state_disconnecting_run(void *obj)
+{
+	struct network_state_object const *state_object = obj;
+
+	LOG_DBG("state_disconnecting_run");
+
+	if (&NETWORK_CHAN == state_object->chan) {
+		struct network_msg msg = MSG_TO_NETWORK_MSG(state_object->msg_buf);
+
+		if (msg.type == NETWORK_DISCONNECTED) {
+			STATE_SET(network_state, STATE_DISCONNECTED_IDLE);
+		}
+	}
+}
+
 static void network_wdt_callback(int channel_id, void *user_data)
 {
 	LOG_ERR("Network watchdog expired, Channel: %d, Thread: %s",

tests/module/network/prj.conf

@@ -7,6 +7,7 @@
 CONFIG_UNITY=y
 CONFIG_ZBUS=y
 CONFIG_LOG=y
+CONFIG_LOG_MODE_IMMEDIATE=y
 CONFIG_ZBUS_OBSERVER_NAME=y
 CONFIG_ZBUS_CHANNEL_NAME=y
 CONFIG_ZBUS_MSG_SUBSCRIBER=y