shell: modem shell sms error made more descriptive

Made modem shell SMS truncation warning more informative.

Signed-off-by: Jared Baumann <[email protected]>

Author: jtbaumann

drivers/modem/modem_shell.c

@@ -33,25 +33,23 @@ struct modem_shell_user_data {
 
 #if defined(CONFIG_MODEM_CONTEXT)
 #include "modem_context.h"
-#define ms_context		modem_context
-#define ms_max_context		CONFIG_MODEM_CONTEXT_MAX_NUM
-#define ms_send(ctx_, buf_, size_) \
-			(ctx_->iface.write(&ctx_->iface, buf_, size_))
-#define ms_context_from_id	modem_context_from_id
-#define UART_DEV_NAME(ctx)	(ctx->iface.dev->name)
+#define ms_context                 modem_context
+#define ms_max_context             CONFIG_MODEM_CONTEXT_MAX_NUM
+#define ms_send(ctx_, buf_, size_) (ctx_->iface.write(&ctx_->iface, buf_, size_))
+#define ms_context_from_id         modem_context_from_id
+#define UART_DEV_NAME(ctx)         (ctx->iface.dev->name)
 #elif defined(CONFIG_MODEM_RECEIVER)
 #include "modem_receiver.h"
-#define ms_context		mdm_receiver_context
-#define ms_max_context		CONFIG_MODEM_RECEIVER_MAX_CONTEXTS
-#define ms_send			mdm_receiver_send
-#define ms_context_from_id	mdm_receiver_context_from_id
-#define UART_DEV_NAME(ctx_)	(ctx_->uart_dev->name)
+#define ms_context          mdm_receiver_context
+#define ms_max_context      CONFIG_MODEM_RECEIVER_MAX_CONTEXTS
+#define ms_send             mdm_receiver_send
+#define ms_context_from_id  mdm_receiver_context_from_id
+#define UART_DEV_NAME(ctx_) (ctx_->uart_dev->name)
 #else
 #error "MODEM_CONTEXT or MODEM_RECEIVER need to be enabled"
 #endif
 
-static int cmd_modem_list(const struct shell *sh, size_t argc,
-			  char *argv[])
+static int cmd_modem_list(const struct shell *sh, size_t argc, char *argv[])
 {
 	struct ms_context *mdm_ctx;
 	int i, count = 0;
@@ -63,39 +61,33 @@ static int cmd_modem_list(const struct shell *sh, size_t argc,
 		if (mdm_ctx) {
 			count++;
 			shell_fprintf(sh, SHELL_NORMAL,
-			     "%d:\tIface Device: %s\n"
-				"\tManufacturer: %s\n"
-				"\tModel:        %s\n"
-				"\tRevision:     %s\n"
-				"\tIMEI:         %s\n"
+				      "%d:\tIface Device: %s\n"
+				      "\tManufacturer: %s\n"
+				      "\tModel:        %s\n"
+				      "\tRevision:     %s\n"
+				      "\tIMEI:         %s\n"
 #if defined(CONFIG_MODEM_SIM_NUMBERS)
-				"\tIMSI:         %s\n"
-				"\tICCID:        %s\n"
+				      "\tIMSI:         %s\n"
+				      "\tICCID:        %s\n"
 #endif
 #if defined(CONFIG_MODEM_CELL_INFO)
-				"\tOperator:     %d\n"
-				"\tLAC:          %d\n"
-				"\tCellId:       %d\n"
-				"\tAcT:          %d\n"
+				      "\tOperator:     %d\n"
+				      "\tLAC:          %d\n"
+				      "\tCellId:       %d\n"
+				      "\tAcT:          %d\n"
 #endif
-				"\tRSSI:         %d\n",
-			       i,
-			       UART_DEV_NAME(mdm_ctx),
-			       mdm_ctx->data_manufacturer,
-			       mdm_ctx->data_model,
-			       mdm_ctx->data_revision,
-			       mdm_ctx->data_imei,
+				      "\tRSSI:         %d\n",
+				      i, UART_DEV_NAME(mdm_ctx), mdm_ctx->data_manufacturer,
+				      mdm_ctx->data_model, mdm_ctx->data_revision,
+				      mdm_ctx->data_imei,
 #if defined(CONFIG_MODEM_SIM_NUMBERS)
-			       mdm_ctx->data_imsi,
-			       mdm_ctx->data_iccid,
+				      mdm_ctx->data_imsi, mdm_ctx->data_iccid,
 #endif
 #if defined(CONFIG_MODEM_CELL_INFO)
-			       mdm_ctx->data_operator,
-			       mdm_ctx->data_lac,
-			       mdm_ctx->data_cellid,
-			       mdm_ctx->data_act,
+				      mdm_ctx->data_operator, mdm_ctx->data_lac,
+				      mdm_ctx->data_cellid, mdm_ctx->data_act,
 #endif
-			       mdm_ctx->data_rssi ? *mdm_ctx->data_rssi : 0);
+				      mdm_ctx->data_rssi ? *mdm_ctx->data_rssi : 0);
 		}
 	}
 
@@ -106,25 +98,22 @@ static int cmd_modem_list(const struct shell *sh, size_t argc,
 	return 0;
 }
 
-static int cmd_modem_send(const struct shell *sh, size_t argc,
-			  char *argv[])
+static int cmd_modem_send(const struct shell *sh, size_t argc, char *argv[])
 {
 	struct ms_context *mdm_ctx;
 	char *endptr;
 	int ret, i, arg = 1;
 
 	/* list */
 	if (!argv[arg]) {
-		shell_fprintf(sh, SHELL_ERROR,
-			      "Please enter a modem index\n");
+		shell_fprintf(sh, SHELL_ERROR, "Please enter a modem index\n");
 		return -EINVAL;
 	}
 
 	/* <index> of modem receiver */
 	i = (int)strtol(argv[arg], &endptr, 10);
 	if (*endptr != '\0') {
-		shell_fprintf(sh, SHELL_ERROR,
-			      "Please enter a modem index\n");
+		shell_fprintf(sh, SHELL_ERROR, "Please enter a modem index\n");
 		return -EINVAL;
 	}
 
@@ -137,8 +126,7 @@ static int cmd_modem_send(const struct shell *sh, size_t argc,
 	for (i = arg + 1; i < argc; i++) {
 		ret = ms_send(mdm_ctx, argv[i], strlen(argv[i]));
 		if (ret < 0) {
-			shell_fprintf(sh, SHELL_ERROR,
-				      "Error sending '%s': %d\n", argv[i], ret);
+			shell_fprintf(sh, SHELL_ERROR, "Error sending '%s': %d\n", argv[i], ret);
 			return 0;
 		}
 
@@ -149,9 +137,7 @@ static int cmd_modem_send(const struct shell *sh, size_t argc,
 		}
 
 		if (ret < 0) {
-			shell_fprintf(sh, SHELL_ERROR,
-				      "Error sending (CRLF or space): %d\n",
-				      ret);
+			shell_fprintf(sh, SHELL_ERROR, "Error sending (CRLF or space): %d\n", ret);
 			return 0;
 		}
 	}
@@ -160,17 +146,16 @@ static int cmd_modem_send(const struct shell *sh, size_t argc,
 }
 
 #if defined(CONFIG_GSM_MUX)
-static void uart_mux_cb(const struct device *uart, const struct device *dev,
-			int dlci_address, void *user_data)
+static void uart_mux_cb(const struct device *uart, const struct device *dev, int dlci_address,
+			void *user_data)
 {
 	struct modem_shell_user_data *data = user_data;
 	const struct shell *shell = data->shell;
 	int *count = data->user_data;
 	const char *ch = "?";
 
 	if (*count == 0) {
-		shell_fprintf(shell, SHELL_NORMAL,
-			      "\nReal UART\tMUX UART\tDLCI\n");
+		shell_fprintf(shell, SHELL_NORMAL, "\nReal UART\tMUX UART\tDLCI\n");
 	}
 
 	(*count)++;
@@ -183,9 +168,8 @@ static void uart_mux_cb(const struct device *uart, const struct device *dev,
 		ch = "control";
 	}
 
-	shell_fprintf(shell, SHELL_NORMAL,
-		      "%s\t\t%s\t\t%d (%s)\n",
-		      uart->name, dev->name, dlci_address, ch);
+	shell_fprintf(shell, SHELL_NORMAL, "%s\t\t%s\t\t%d (%s)\n", uart->name, dev->name,
+		      dlci_address, ch);
 }
 #endif
 
@@ -197,16 +181,14 @@ static int cmd_modem_info(const struct shell *shell, size_t argc, char *argv[])
 
 	/* info */
 	if (!argv[arg]) {
-		shell_fprintf(shell, SHELL_ERROR,
-			      "Please enter a modem index\n");
+		shell_fprintf(shell, SHELL_ERROR, "Please enter a modem index\n");
 		return -EINVAL;
 	}
 
 	/* <index> of modem receiver */
 	i = (int)strtol(argv[arg], &endptr, 10);
 	if (*endptr != '\0') {
-		shell_fprintf(shell, SHELL_ERROR,
-			      "Please enter a modem index\n");
+		shell_fprintf(shell, SHELL_ERROR, "Please enter a modem index\n");
 		return -EINVAL;
 	}
 
@@ -224,16 +206,11 @@ static int cmd_modem_info(const struct shell *shell, size_t argc, char *argv[])
 		      "Revision         : %s\n"
 		      "IMEI             : %s\n"
 		      "RSSI             : %d\n",
-		      i,
-		      UART_DEV_NAME(mdm_ctx),
-		      mdm_ctx->data_manufacturer,
-		      mdm_ctx->data_model,
-		      mdm_ctx->data_revision,
-		      mdm_ctx->data_imei,
+		      i, UART_DEV_NAME(mdm_ctx), mdm_ctx->data_manufacturer, mdm_ctx->data_model,
+		      mdm_ctx->data_revision, mdm_ctx->data_imei,
 		      mdm_ctx->data_rssi ? *mdm_ctx->data_rssi : 0);
 
-	shell_fprintf(shell, SHELL_NORMAL,
-		      "GSM 07.10 muxing : %s\n",
+	shell_fprintf(shell, SHELL_NORMAL, "GSM 07.10 muxing : %s\n",
 		      IS_ENABLED(CONFIG_GSM_MUX) ? "enabled" : "disabled");
 
 #if defined(CONFIG_GSM_MUX)
@@ -250,8 +227,7 @@ static int cmd_modem_info(const struct shell *shell, size_t argc, char *argv[])
 }
 
 #if defined(CONFIG_MODEM_SMS)
-static int cmd_modem_sms_send(const struct shell *shell, size_t argc,
-			      char *argv[])
+static int cmd_modem_sms_send(const struct shell *shell, size_t argc, char *argv[])
 {
 	struct ms_context *ms_ctx;
 	struct sms_out sms;
@@ -266,41 +242,36 @@ static int cmd_modem_sms_send(const struct shell *shell, size_t argc,
 
 		ms_ctx = ms_context_from_id(modem_index);
 		if (ms_ctx == NULL) {
-			shell_fprintf(
-				shell, SHELL_ERROR,
-				"Couldn't open context for modem index %d\n",
-				modem_index);
+			shell_fprintf(shell, SHELL_ERROR,
+				      "Couldn't open context for modem index %d\n", modem_index);
 			return -ENOEXEC;
 		}
 
 		if (ms_ctx->send_sms == NULL) {
-			shell_fprintf(shell, SHELL_ERROR,
-				      "No function defined to send SMS\n");
+			shell_fprintf(shell, SHELL_ERROR, "No function defined to send SMS\n");
 			return -ENOEXEC;
 		}
 
 		if (strlen(argv[3]) > (sizeof(sms.msg) - 1)) {
 			shell_fprintf(shell, SHELL_WARNING,
-					  "Specified message longer than maximum, truncating message\n");
+				      "SMS message exceeds limit (%d>%d), truncating message",
+				      strlen(argv[3]), CONFIG_MODEM_SMS_OUT_MSG_MAX_LEN);
 		}
 
 		snprintk(sms.phone, sizeof(sms.phone), "%s", argv[2]);
 		snprintk(sms.msg, sizeof(sms.msg), "%s", argv[3]);
 
 		ret = ms_ctx->send_sms(&sms);
 		if (ret == 0) {
-			shell_fprintf(shell, SHELL_NORMAL,
-				      "SMS msg was sent\n");
+			shell_fprintf(shell, SHELL_NORMAL, "SMS msg was sent\n");
 		} else {
-			shell_fprintf(shell, SHELL_ERROR,
-				      "error: send_sms returned %d\n", ret);
+			shell_fprintf(shell, SHELL_ERROR, "error: send_sms returned %d\n", ret);
 		}
 	}
 	return ret;
 }
 
-static int cmd_modem_sms_recv(const struct shell *shell, size_t argc,
-			      char *argv[])
+static int cmd_modem_sms_recv(const struct shell *shell, size_t argc, char *argv[])
 {
 	struct ms_context *ms_ctx;
 	struct sms_in sms;
@@ -316,33 +287,27 @@ static int cmd_modem_sms_recv(const struct shell *shell, size_t argc,
 
 		ms_ctx = ms_context_from_id(modem_index);
 		if (ms_ctx == NULL) {
-			shell_fprintf(
-				shell, SHELL_ERROR,
-				"Couldn't open context for modem index %d\n",
-				modem_index);
+			shell_fprintf(shell, SHELL_ERROR,
+				      "Couldn't open context for modem index %d\n", modem_index);
 			return -ENOEXEC;
 		}
 
 		if (ms_ctx->recv_sms == NULL) {
-			shell_fprintf(shell, SHELL_ERROR,
-				      "No function defined to receive SMS\n");
+			shell_fprintf(shell, SHELL_ERROR, "No function defined to receive SMS\n");
 			return -ENOEXEC;
 		}
 
 		sms.timeout = K_SECONDS(wait);
 		ret = ms_ctx->recv_sms(&sms);
 		if (ret < 0) {
-			shell_fprintf(shell, SHELL_ERROR,
-				      "recv_sms returned error %d, errno:%d\n",
+			shell_fprintf(shell, SHELL_ERROR, "recv_sms returned error %d, errno:%d\n",
 				      ret, errno);
 		} else if (ret == 0) {
-			shell_fprintf(shell, SHELL_NORMAL,
-				      "No SMS msgs available\n");
+			shell_fprintf(shell, SHELL_NORMAL, "No SMS msgs available\n");
 		} else {
-			shell_fprintf(
-				shell, SHELL_NORMAL,
-				"Received SMS msg from %s dated %s: '%s'\n",
-				sms.phone, sms.time, sms.msg);
+			shell_fprintf(shell, SHELL_NORMAL,
+				      "Received SMS msg from %s dated %s: '%s'\n", sms.phone,
+				      sms.time, sms.msg);
 		}
 	}
 	return ret;
@@ -361,15 +326,16 @@ SHELL_STATIC_SUBCMD_SET_CREATE(modem_cmd_sms,
 
 #endif /* CONFIG_MODEM_SMS */
 
-SHELL_STATIC_SUBCMD_SET_CREATE(sub_modem,
-	SHELL_CMD(info, NULL, "Show information for a modem", cmd_modem_info),
+SHELL_STATIC_SUBCMD_SET_CREATE(
+	sub_modem, SHELL_CMD(info, NULL, "Show information for a modem", cmd_modem_info),
 	SHELL_CMD(list, NULL, "List registered modems", cmd_modem_list),
-	SHELL_CMD(send, NULL, "Send an AT <command> to a registered modem "
-						  "receiver", cmd_modem_send),
+	SHELL_CMD(send, NULL,
+		  "Send an AT <command> to a registered modem "
+		  "receiver",
+		  cmd_modem_send),
 #if defined(CONFIG_MODEM_SMS)
-	SHELL_CMD(sms, &modem_cmd_sms, "Send or receive SMS message via modem",
-		  NULL),
-#endif /* CONFIG_MODEM_SMS */
+	SHELL_CMD(sms, &modem_cmd_sms, "Send or receive SMS message via modem", NULL),
+#endif                       /* CONFIG_MODEM_SMS */
 	SHELL_SUBCMD_SET_END /* Array terminated. */
 );