samples: nrf9160: modem_shell: a kill button #1

Pressing a long press of button #1 to kill/abort running
ping/iperf instances, including all th -command threads.
Jira: MOSH-143

Signed-off-by: Jani Hirsimäki <[email protected]>

Author: jhirsi

samples/nrf9160/modem_shell/README.rst

@@ -379,6 +379,17 @@ Building and running
 
 .. include:: /includes/build_and_run_nrf9160.txt
 
+DK buttons
+==========
+
+The buttons have the following functions:
+
+Button 1:
+   Raises a kill or abort signal. A long press of the button will kill or abort all supported running commands. You can abort commands ``iperf3`` (also with ``th``), ``curl``, ``ping`` and ``sock send``.
+
+Button 2:
+   Enables or disables the UARTs for power consumption measurements. Toggles between UARTs enabled and disabled.
+
 Testing
 =======
 

samples/nrf9160/modem_shell/src/main.c

@@ -47,9 +47,12 @@
 #if defined(CONFIG_MOSH_WORKER_THREADS)
 #include "th/th_ctrl.h"
 #endif
+#include "mosh_defines.h"
 
 /* global variables */
 struct modem_param_info modem_param;
+struct k_poll_signal mosh_signal;
+
 /**
  * @brief Global shell pointer that can be used for printing.
  *
@@ -87,6 +90,17 @@ static void mosh_print_version_info(void)
 
 static void button_handler(uint32_t button_states, uint32_t has_changed)
 {
+	if (has_changed & button_states & DK_BTN1_MSK) {
+		shell_print(shell_global, "Button 1 pressed - raising a kill signal");
+		k_poll_signal_raise(&mosh_signal, MOSH_SIGNAL_KILL);
+#if defined(CONFIG_MOSH_WORKER_THREADS)
+		th_ctrl_kill_em_all();
+#endif
+	} else if (has_changed & ~button_states & DK_BTN1_MSK) {
+		shell_print(shell_global, "Button 1 released - resetting a kill signal");
+		k_poll_signal_reset(&mosh_signal);
+	}
+
 	if (has_changed & button_states & DK_BTN2_MSK) {
 		shell_print(shell_global, "Button 2 pressed, toggling UART power state");
 		uart_toggle_power_state(shell_global);
@@ -182,6 +196,7 @@ void main(void)
 #if defined(CONFIG_BOOTLOADER_MCUBOOT)
 	boot_write_img_confirmed();
 #endif
+	k_poll_signal_init(&mosh_signal);
 
 	/* Resize terminal width and height of the shell to have proper command editing. */
 	shell_execute_cmd(shell_global, "resize");

samples/nrf9160/modem_shell/src/mosh_defines.h

@@ -17,4 +17,8 @@
 
 #define MOSH_AT_CMD_RESPONSE_MAX_LEN 2700
 
+enum mosh_signals {
+	MOSH_SIGNAL_KILL,
+};
+
 #endif /* MOSH_DEFINES_H */

samples/nrf9160/modem_shell/src/ping/icmp_ping.c

@@ -22,6 +22,7 @@
 
 #include "utils/net_utils.h"
 #include "link_api.h"
+#include "mosh_defines.h"
 
 #include "icmp_ping.h"
 
@@ -39,6 +40,8 @@
 #define ICMP6_ECHO_REQ 128
 #define ICMP6_ECHO_REP 129
 
+extern struct k_poll_signal mosh_signal;
+
 enum ping_rai {
 	PING_RAI_NONE,
 	PING_RAI_ONGOING,
@@ -525,6 +528,7 @@ static void icmp_ping_tasks_execute(const struct shell *shell)
 	uint32_t count = 0;
 	uint32_t rtt_min = 0xFFFFFFFF;
 	uint32_t rtt_max = 0;
+	int set, res;
 	enum ping_rai rai;
 	uint32_t ping_t;
 
@@ -540,6 +544,13 @@ static void icmp_ping_tasks_execute(const struct shell *shell)
 		}
 		ping_t = send_ping_wait_reply(shell, rai);
 
+		k_poll_signal_check(&mosh_signal, &set, &res);
+		if (set && res == MOSH_SIGNAL_KILL) {
+			k_poll_signal_reset(&mosh_signal);
+			shell_error(shell, "KILL signal received - exiting");
+			break;
+		}
+
 		if (ping_t > 0) {
 			count++;
 			sum += ping_t;

samples/nrf9160/modem_shell/src/shell.c

@@ -44,7 +44,7 @@
 
 extern const struct shell *shell_global;
 extern struct k_sem nrf_modem_lib_initialized;
-
+extern struct k_poll_signal mosh_signal;
 /**
  * @brief Overriding modem library error handler.
  */
@@ -162,7 +162,7 @@ int lwm2m_carrier_event_handler(const lwm2m_carrier_event_t *event)
 #if defined(CONFIG_MOSH_IPERF3)
 static int cmd_iperf3(const struct shell *shell, size_t argc, char **argv)
 {
-	(void)iperf_main(argc, argv, NULL, 0, NULL);
+	(void)iperf_main(argc, argv, NULL, 0, &mosh_signal);
 	return 0;
 }
 #endif

samples/nrf9160/modem_shell/src/th/th_ctrl.c

@@ -159,6 +159,16 @@ void th_ctrl_status_print(const struct shell *shell)
 	th_ctrl_data_status_print(shell, &th_work_data_2);
 }
 
+void th_ctrl_kill_em_all(void)
+{
+	if (k_work_is_pending(&(th_work_data_1.work))) {
+		k_poll_signal_raise(&th_work_data_1.kill_signal, 1);
+	}
+	if (k_work_is_pending(&(th_work_data_2.work))) {
+		k_poll_signal_raise(&th_work_data_2.kill_signal, 2);
+	}
+}
+
 void th_ctrl_kill(const struct shell *shell, int nbr)
 {
 	if (nbr == 1) {

samples/nrf9160/modem_shell/src/th/th_ctrl.h

@@ -16,5 +16,6 @@ void th_ctrl_status_print(const struct shell *shell);
 void th_ctrl_start(const struct shell *shell, size_t argc, char **argv,
 		   bool bg_thread);
 void th_ctrl_kill(const struct shell *shell, int nbr);
+void th_ctrl_kill_em_all(void);
 
 #endif /* TH_CTRL_H */