modem: cmux: Add struct cmux_config into struct cmux

Instead of copying all fields from cmux_config into run-time
struct cmux, just have the configuration structure as a member.

Signed-off-by: Seppo Takalo <[email protected]>

Author: SeppoTakalo

include/zephyr/modem/cmux.h

@@ -53,6 +53,30 @@ enum modem_cmux_event {
 typedef void (*modem_cmux_callback)(struct modem_cmux *cmux, enum modem_cmux_event event,
 				    void *user_data);
 
+/**
+ * @brief Contains CMUX instance configuration data
+ */
+struct modem_cmux_config {
+	/** Invoked when event occurs */
+	modem_cmux_callback callback;
+	/** Free to use pointer passed to event handler when invoked */
+	void *user_data;
+	/** Receive buffer */
+	uint8_t *receive_buf;
+	/** Size of receive buffer in bytes [127, ...] */
+	uint16_t receive_buf_size;
+	/** Transmit buffer */
+	uint8_t *transmit_buf;
+	/** Size of transmit buffer in bytes [149, ...] */
+	uint16_t transmit_buf_size;
+	/** Enable runtime power management */
+	bool enable_runtime_power_management;
+	/** Close pipe on power save */
+	bool close_pipe_on_power_save;
+	/** Idle timeout for power save */
+	k_timeout_t idle_timeout;
+};
+
 /**
  * @cond INTERNAL_HIDDEN
  */
@@ -148,34 +172,20 @@ struct modem_cmux {
 	/* Bus pipe */
 	struct modem_pipe *pipe;
 
-	/* Event handler */
-	modem_cmux_callback callback;
-	void *user_data;
-
 	/* DLCI channel contexts */
 	sys_slist_t dlcis;
 
 	/* State */
 	enum modem_cmux_state state;
 	bool flow_control_on : 1;
 	bool initiator : 1;
-	/** Enable runtime power management */
-	bool enable_runtime_power_management;
-	/** Close pipe on power save */
-	bool close_pipe_on_power_save;
-	/** Idle timeout for power save */
-	k_timeout_t idle_timeout;
 
 	/* Work lock */
 	bool attached : 1;
 	struct k_spinlock work_lock;
 
 	/* Receive state*/
 	enum modem_cmux_receive_state receive_state;
-
-	/* Receive buffer */
-	uint8_t *receive_buf;
-	uint16_t receive_buf_size;
 	uint16_t receive_buf_len;
 
 	uint8_t work_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
@@ -206,36 +216,13 @@ struct modem_cmux {
 	struct modem_stats_buffer receive_buf_stats;
 	struct modem_stats_buffer transmit_buf_stats;
 #endif
+	struct modem_cmux_config config;
 };
 
 /**
  * @endcond
  */
 
-/**
- * @brief Contains CMUX instance configuration data
- */
-struct modem_cmux_config {
-	/** Invoked when event occurs */
-	modem_cmux_callback callback;
-	/** Free to use pointer passed to event handler when invoked */
-	void *user_data;
-	/** Receive buffer */
-	uint8_t *receive_buf;
-	/** Size of receive buffer in bytes [127, ...] */
-	uint16_t receive_buf_size;
-	/** Transmit buffer */
-	uint8_t *transmit_buf;
-	/** Size of transmit buffer in bytes [149, ...] */
-	uint16_t transmit_buf_size;
-	/** Enable runtime power management */
-	bool enable_runtime_power_management;
-	/** Close pipe on power save */
-	bool close_pipe_on_power_save;
-	/** Idle timeout for power save */
-	k_timeout_t idle_timeout;
-};
-
 /**
  * @brief Initialize CMUX instance
  * @param cmux CMUX instance

subsys/modem/modem_cmux.c

@@ -224,7 +224,7 @@ static uint32_t modem_cmux_get_receive_buf_length(struct modem_cmux *cmux)
 
 static uint32_t modem_cmux_get_receive_buf_size(struct modem_cmux *cmux)
 {
-	return cmux->receive_buf_size;
+	return cmux->config.receive_buf_size;
 }
 
 static uint32_t modem_cmux_get_transmit_buf_length(struct modem_cmux *cmux)
@@ -307,11 +307,11 @@ static void modem_cmux_log_received_command(const struct modem_cmux_command *com
 
 static void modem_cmux_raise_event(struct modem_cmux *cmux, enum modem_cmux_event event)
 {
-	if (cmux->callback == NULL) {
+	if (cmux->config.callback == NULL) {
 		return;
 	}
 
-	cmux->callback(cmux, event, cmux->user_data);
+	cmux->config.callback(cmux, event, cmux->config.user_data);
 }
 
 static void modem_cmux_bus_callback(struct modem_pipe *pipe, enum modem_pipe_event event,
@@ -330,7 +330,7 @@ static void modem_cmux_bus_callback(struct modem_pipe *pipe, enum modem_pipe_eve
 		break;
 	case MODEM_PIPE_EVENT_TRANSMIT_IDLE:
 		/* If we keep UART open in power-save, we should avoid waking up on RX idle */
-		if (!cmux->close_pipe_on_power_save && is_powersaving(cmux)) {
+		if (!cmux->config.close_pipe_on_power_save && is_powersaving(cmux)) {
 			break;
 		}
 		modem_work_schedule(&cmux->transmit_work, K_NO_WAIT);
@@ -699,7 +699,7 @@ static void modem_cmux_on_psc_response(struct modem_cmux *cmux)
 	set_state(cmux, MODEM_CMUX_STATE_POWERSAVE);
 	k_mutex_unlock(&cmux->transmit_rb_lock);
 
-	if (cmux->close_pipe_on_power_save) {
+	if (cmux->config.close_pipe_on_power_save) {
 		modem_pipe_close_async(cmux->pipe);
 	}
 }
@@ -1046,8 +1046,8 @@ static void modem_cmux_drop_frame(struct modem_cmux *cmux)
 #if defined(CONFIG_MODEM_CMUX_LOG_LEVEL_DBG)
 	struct modem_cmux_frame *frame = &cmux->frame;
 
-	frame->data = cmux->receive_buf;
-	modem_cmux_log_frame(frame, "dropped", MIN(frame->data_len, cmux->receive_buf_size));
+	frame->data = cmux->config.receive_buf;
+	modem_cmux_log_frame(frame, "dropped", MIN(frame->data_len, cmux->config.receive_buf_size));
 #endif
 }
 
@@ -1171,9 +1171,9 @@ static void modem_cmux_process_received_byte(struct modem_cmux *cmux, uint8_t by
 			break;
 		}
 
-		if (cmux->frame.data_len > cmux->receive_buf_size) {
+		if (cmux->frame.data_len > cmux->config.receive_buf_size) {
 			LOG_ERR("Indicated frame data length %u exceeds receive buffer size %u",
-				cmux->frame.data_len, cmux->receive_buf_size);
+				cmux->frame.data_len, cmux->config.receive_buf_size);
 
 			modem_cmux_drop_frame(cmux);
 			break;
@@ -1185,8 +1185,8 @@ static void modem_cmux_process_received_byte(struct modem_cmux *cmux, uint8_t by
 
 	case MODEM_CMUX_RECEIVE_STATE_DATA:
 		/* Copy byte to data */
-		if (cmux->receive_buf_len < cmux->receive_buf_size) {
-			cmux->receive_buf[cmux->receive_buf_len] = byte;
+		if (cmux->receive_buf_len < cmux->config.receive_buf_size) {
+			cmux->config.receive_buf[cmux->receive_buf_len] = byte;
 		}
 		cmux->receive_buf_len++;
 
@@ -1199,9 +1199,9 @@ static void modem_cmux_process_received_byte(struct modem_cmux *cmux, uint8_t by
 		break;
 
 	case MODEM_CMUX_RECEIVE_STATE_FCS:
-		if (cmux->receive_buf_len > cmux->receive_buf_size) {
-			LOG_WRN("Receive buffer overrun (%u > %u)",
-				cmux->receive_buf_len, cmux->receive_buf_size);
+		if (cmux->receive_buf_len > cmux->config.receive_buf_size) {
+			LOG_WRN("Receive buffer overrun (%u > %u)", cmux->receive_buf_len,
+				cmux->config.receive_buf_size);
 			modem_cmux_drop_frame(cmux);
 			break;
 		}
@@ -1235,7 +1235,7 @@ static void modem_cmux_process_received_byte(struct modem_cmux *cmux, uint8_t by
 		}
 
 		/* Process frame */
-		cmux->frame.data = cmux->receive_buf;
+		cmux->frame.data = cmux->config.receive_buf;
 		modem_cmux_on_frame(cmux);
 
 		/* Await start of next frame */
@@ -1285,7 +1285,7 @@ static void modem_cmux_runtime_pm_handler(struct k_work *item)
 	struct k_work_delayable *dwork = k_work_delayable_from_work(item);
 	struct modem_cmux *cmux = CONTAINER_OF(dwork, struct modem_cmux, runtime_pm_work);
 
-	if (!cmux->enable_runtime_power_management) {
+	if (!cmux->config.enable_runtime_power_management) {
 		return;
 	}
 
@@ -1312,12 +1312,12 @@ static void modem_cmux_runtime_pm_handler(struct k_work *item)
 
 static void runtime_pm_keepalive(struct modem_cmux *cmux)
 {
-	if (cmux == NULL || !cmux->enable_runtime_power_management) {
+	if (cmux == NULL || !cmux->config.enable_runtime_power_management) {
 		return;
 	}
 
-	cmux->idle_timepoint = sys_timepoint_calc(cmux->idle_timeout);
-	k_work_reschedule(&cmux->runtime_pm_work, cmux->idle_timeout);
+	cmux->idle_timepoint = sys_timepoint_calc(cmux->config.idle_timeout);
+	k_work_reschedule(&cmux->runtime_pm_work, cmux->config.idle_timeout);
 }
 
 /** Transmit bytes bypassing the CMUX buffers.
@@ -1342,7 +1342,7 @@ static bool powersave_wait_wakeup(struct modem_cmux *cmux)
 		LOG_DBG("Power saving mode, wake up first");
 		set_state(cmux, MODEM_CMUX_STATE_WAKEUP);
 
-		if (cmux->close_pipe_on_power_save) {
+		if (cmux->config.close_pipe_on_power_save) {
 			ret = modem_pipe_open(cmux->pipe, K_FOREVER);
 			if (ret < 0) {
 				LOG_ERR("Failed to open pipe for wake up (%d)", ret);
@@ -1431,7 +1431,7 @@ static void modem_cmux_transmit_handler(struct k_work *item)
 		if (cmux->state == MODEM_CMUX_STATE_CONFIRM_POWERSAVE) {
 			set_state(cmux, MODEM_CMUX_STATE_POWERSAVE);
 			LOG_DBG("Entered power saving mode");
-			if (cmux->close_pipe_on_power_save) {
+			if (cmux->config.close_pipe_on_power_save) {
 				modem_pipe_close_async(cmux->pipe);
 			}
 		}
@@ -1734,18 +1734,13 @@ void modem_cmux_init(struct modem_cmux *cmux, const struct modem_cmux_config *co
 	__ASSERT_NO_MSG(config->transmit_buf != NULL);
 	__ASSERT_NO_MSG(config->transmit_buf_size >= MODEM_CMUX_DATA_FRAME_SIZE_MAX);
 
-	memset(cmux, 0x00, sizeof(*cmux));
-	cmux->callback = config->callback;
-	cmux->user_data = config->user_data;
-	cmux->receive_buf = config->receive_buf;
-	cmux->receive_buf_size = config->receive_buf_size;
-	cmux->t3_timepoint = sys_timepoint_calc(K_NO_WAIT);
-	cmux->enable_runtime_power_management = config->enable_runtime_power_management;
-	cmux->close_pipe_on_power_save = config->close_pipe_on_power_save;
-	cmux->idle_timeout =
-		cmux->enable_runtime_power_management ? config->idle_timeout : K_FOREVER;
+	*cmux = (struct modem_cmux){
+		.t3_timepoint = sys_timepoint_calc(K_NO_WAIT),
+		.config = *config,
+	};
 	sys_slist_init(&cmux->dlcis);
-	ring_buf_init(&cmux->transmit_rb, config->transmit_buf_size, config->transmit_buf);
+	ring_buf_init(&cmux->transmit_rb, cmux->config.transmit_buf_size,
+		      cmux->config.transmit_buf);
 	k_mutex_init(&cmux->transmit_rb_lock);
 	k_work_init_delayable(&cmux->receive_work, modem_cmux_receive_handler);
 	k_work_init_delayable(&cmux->transmit_work, modem_cmux_transmit_handler);