mgmt: ec_host_cmd: uart: improve error handling

Add an array with the states names and use it while logging an error
messages.

Additionally unify the error message format. Do not add
"UART HOST CMD ERROR", because the LOG_ERR macro already informs that
it is an error message.

Signed-off-by: Dawid Niedzwiecki <[email protected]>

Author: niedzwiecki-dawid

subsys/mgmt/ec_host_cmd/backends/ec_host_cmd_backend_uart.c

@@ -67,6 +67,16 @@ enum uart_host_command_state {
 	UART_HOST_CMD_RX_OVERRUN,
 };
 
+static const char * const state_name[] = {
+	[UART_HOST_CMD_STATE_DISABLED] = "DISABLED",
+	[UART_HOST_CMD_READY_TO_RX] = "READY_TO_RX",
+	[UART_HOST_CMD_RECEIVING] = "RECEIVING",
+	[UART_HOST_CMD_PROCESSING] = "PROCESSING",
+	[UART_HOST_CMD_SENDING] = "SENDING",
+	[UART_HOST_CMD_RX_BAD] = "RX_BAD",
+	[UART_HOST_CMD_RX_OVERRUN] = "RX_OVERRUN",
+};
+
 struct ec_host_cmd_uart_ctx {
 	const struct device *uart_dev;
 	struct ec_host_cmd_rx_ctx *rx_ctx;
@@ -115,27 +125,7 @@ static void rx_timeout(struct k_work *work)
 		CONTAINER_OF(dwork, struct ec_host_cmd_uart_ctx, timeout_work);
 	int res;
 
-	switch (hc_uart->state) {
-	case UART_HOST_CMD_RECEIVING:
-		/* If state is receiving then timeout was hit due to underrun */
-		LOG_ERR("Request underrun detected");
-		break;
-	case UART_HOST_CMD_RX_OVERRUN:
-		/* If state is rx_overrun then timeout was hit because
-		 * process request was cancelled and extra rx bytes were
-		 * dropped
-		 */
-		LOG_ERR("Request overrun detected");
-		break;
-	case UART_HOST_CMD_RX_BAD:
-		/* If state is rx_bad then packet header was bad and process
-		 * request was cancelled to drop all incoming bytes.
-		 */
-		LOG_ERR("Bad packet header detected");
-		break;
-	default:
-		LOG_ERR("Request timeout mishandled, state: %d", hc_uart->state);
-	}
+	LOG_ERR("Request error in state: %s", state_name[hc_uart->state]);
 
 	res = uart_rx_disable(hc_uart->uart_dev);
 	res = uart_rx_enable(hc_uart->uart_dev, hc_uart->rx_ctx->buf, hc_uart->rx_buf_size, 0);
@@ -157,7 +147,7 @@ static void uart_callback(const struct device *dev, struct uart_event *evt, void
 					  K_MSEC(CONFIG_EC_HOST_CMD_BACKEND_UART_TIMEOUT));
 		} else if (hc_uart->state == UART_HOST_CMD_PROCESSING ||
 			   hc_uart->state == UART_HOST_CMD_SENDING) {
-			LOG_ERR("UART HOST CMD ERROR: Received data while processing or sending");
+			LOG_ERR("Received data while in state: %s", state_name[hc_uart->state]);
 			return;
 		} else if (hc_uart->state == UART_HOST_CMD_RX_BAD ||
 			   hc_uart->state == UART_HOST_CMD_RX_OVERRUN) {
@@ -215,13 +205,13 @@ static void uart_callback(const struct device *dev, struct uart_event *evt, void
 		break;
 	case UART_TX_DONE:
 		if (hc_uart->state != UART_HOST_CMD_SENDING) {
-			LOG_ERR("UART HOST CMD ERROR: unexpected end of sending");
+			LOG_ERR("Unexpected end of sending");
 		}
 		/* Receiving is already enabled in the send function. */
 		hc_uart->state = UART_HOST_CMD_READY_TO_RX;
 		break;
 	case UART_RX_STOPPED:
-		LOG_ERR("UART HOST CMD ERROR: Receiving data stopped");
+		LOG_ERR("Receiving data stopped");
 		break;
 	default:
 		break;
@@ -271,7 +261,7 @@ static int ec_host_cmd_uart_send(const struct ec_host_cmd_backend *backend)
 	int ret;
 
 	if (hc_uart->state != UART_HOST_CMD_PROCESSING) {
-		LOG_ERR("UART HOST CMD ERROR: unexpected state while sending");
+		LOG_ERR("Unexpected state while sending");
 	}
 
 	/* The state is changed to UART_HOST_CMD_READY_TO_RX in the UART_TX_DONE event */
@@ -291,7 +281,7 @@ static int ec_host_cmd_uart_send(const struct ec_host_cmd_backend *backend)
 	/* If sending fails, reset the state */
 	if (ret) {
 		hc_uart->state = UART_HOST_CMD_READY_TO_RX;
-		LOG_ERR("UART HOST CMD ERROR: sending failed");
+		LOG_ERR("Sending failed");
 	}
 
 	return ret;