ipc: Added const specifier to protect IPC message content in sending functions.

Adrian Warecki · lgirdwood · commit 42025e551a8c · 2022-02-21T15:42:43.000Z
Added the const specifier to protect the message passed to
ipc_platform_send_msg and ipc_prepare_to_send functions. The deletion of
the message from the list has been moved to ipc_send_queued_msg function.

Signed-off-by: Adrian Warecki &lt;adrianx.warecki@intel.com&gt;
diff --git a/src/drivers/amd/renoir/ipc.c b/src/drivers/amd/renoir/ipc.c
@@ -166,7 +166,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 	}
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	int ret = 0;
 	acp_sw_intr_trig_t  sw_intr_trig;
@@ -198,7 +198,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)
 		goto out;
 	/* Write new message in the mailbox */
 	mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);
-	list_item_del(&msg->list);
+
 	/* Need to set DSP message flag */
 	sof_ipc_dsp_msg_set();
 	/* now interrupt host to tell it we have sent a message */
diff --git a/src/drivers/imx/ipc.c b/src/drivers/imx/ipc.c
@@ -123,7 +123,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 	}
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	struct ipc *ipc = ipc_get();
 	int ret = 0;
@@ -137,7 +137,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)
 
 	/* now send the message */
 	mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);
-	list_item_del(&msg->list);
+
 	tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);
 
 	ipc->is_notification_pending = true;
diff --git a/src/drivers/intel/baytrail/ipc.c b/src/drivers/intel/baytrail/ipc.c
@@ -111,7 +111,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 	shim_write(SHIM_IMRD, shim_read(SHIM_IMRD) & ~SHIM_IMRD_BUSY);
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	struct ipc *ipc = ipc_get();
 	int ret = 0;
@@ -125,7 +125,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)
 
 	/* now send the message */
 	mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);
-	list_item_del(&msg->list);
+
 	tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);
 
 	ipc->is_notification_pending = true;
diff --git a/src/drivers/intel/cavs/ipc.c b/src/drivers/intel/cavs/ipc.c
@@ -214,7 +214,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 	ipc_write(IPC_DIPCCTL, ipc_read(IPC_DIPCCTL) | IPC_DIPCCTL_IPCTBIE);
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	struct ipc *ipc = ipc_get();
 	ipc_cmd_hdr *hdr;
@@ -231,7 +231,6 @@ int ipc_platform_send_msg(struct ipc_msg *msg)
 		goto out;
 	}
 
-	list_item_del(&msg->list);
 	tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);
 
 	ipc->is_notification_pending = true;
diff --git a/src/drivers/intel/cavs/sue-ipc.c b/src/drivers/intel/cavs/sue-ipc.c
@@ -65,11 +65,11 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 {
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	/* now send the message */
 	mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);
-	list_item_del(&msg->list);
+
 	tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);
 
 	/* now interrupt host to tell it we have message sent */
diff --git a/src/drivers/intel/haswell/ipc.c b/src/drivers/intel/haswell/ipc.c
@@ -113,7 +113,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	struct ipc *ipc = ipc_get();
 	int ret = 0;
@@ -127,7 +127,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)
 
 	/* now send the message */
 	mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);
-	list_item_del(&msg->list);
+
 	tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);
 
 	ipc->is_notification_pending = true;
diff --git a/src/drivers/mediatek/mt8186/ipc.c b/src/drivers/mediatek/mt8186/ipc.c
@@ -89,7 +89,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 		wait_for_interrupt(0);
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	struct ipc *ipc = ipc_get();
 
@@ -98,7 +98,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)
 
 	/* now send the message */
 	mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);
-	list_item_del(&msg->list);
+
 	ipc->is_notification_pending = true;
 
 	/* now interrupt host to tell it we have sent a message */
diff --git a/src/drivers/mediatek/mt8195/ipc.c b/src/drivers/mediatek/mt8195/ipc.c
@@ -88,7 +88,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)
 		wait_for_interrupt(0);
 }
 
-int ipc_platform_send_msg(struct ipc_msg *msg)
+int ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	struct ipc *ipc = ipc_get();
 
@@ -97,7 +97,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)
 
 	/* now send the message */
 	mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);
-	list_item_del(&msg->list);
+
 	ipc->is_notification_pending = true;
 
 	/* now interrupt host to tell it we have sent a message */
diff --git a/src/include/sof/ipc/common.h b/src/include/sof/ipc/common.h
@@ -178,7 +178,7 @@ int ipc_compact_write_msg(ipc_cmd_hdr *hdr);
  * @param[in] msg The ipc msg.
  * @return pointer to raw header or NULL.
  */
-ipc_cmd_hdr *ipc_prepare_to_send(struct ipc_msg *msg);
+ipc_cmd_hdr *ipc_prepare_to_send(const struct ipc_msg *msg);
 
 /**
  * \brief Validate mailbox contents for valid IPC header.
diff --git a/src/include/sof/ipc/driver.h b/src/include/sof/ipc/driver.h
@@ -50,7 +50,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc);
  * @param msg The IPC message to send to host.
  * @return 0 on success.
  */
-int ipc_platform_send_msg(struct ipc_msg *msg);
+int ipc_platform_send_msg(const struct ipc_msg *msg);
 
 /**
  * \brief Retrieves the ipc_data_host_buffer allocated by the platform ipc.
diff --git a/src/ipc/ipc-common.c b/src/ipc/ipc-common.c
@@ -187,8 +187,9 @@ void ipc_send_queued_msg(void)
 	msg = list_first_item(&ipc->msg_list, struct ipc_msg,
 			      list);
 
-	ipc_platform_send_msg(msg);
-
+	if (ipc_platform_send_msg(msg) == 0)
+		/* Remove the message from the list if it has been successfully sent. */
+		list_item_del(&msg->list);
 out:
 	k_spin_unlock(&ipc->lock, key);
 }
diff --git a/src/ipc/ipc3/handler.c b/src/ipc/ipc3/handler.c
@@ -1538,7 +1538,7 @@ ipc_cmd_hdr *ipc_compact_read_msg(void)
 #endif
 
 /* prepare the message using ABI major layout */
-ipc_cmd_hdr *ipc_prepare_to_send(struct ipc_msg *msg)
+ipc_cmd_hdr *ipc_prepare_to_send(const struct ipc_msg *msg)
 {
 	static uint32_t hdr[2];
 
diff --git a/src/ipc/ipc4/handler.c b/src/ipc/ipc4/handler.c
@@ -828,7 +828,7 @@ ipc_cmd_hdr *ipc_compact_read_msg(void)
 	return ipc_to_hdr(msg_data.msg_in);
 }
 
-ipc_cmd_hdr *ipc_prepare_to_send(struct ipc_msg *msg)
+ipc_cmd_hdr *ipc_prepare_to_send(const struct ipc_msg *msg)
 {
 	uint32_t size;
 
diff --git a/src/platform/library/include/platform/platform.h b/src/platform/library/include/platform/platform.h
@@ -68,7 +68,7 @@ static inline void platform_wait_for_interrupt(int level)
 	arch_wait_for_interrupt(level);
 }
 
-static inline int ipc_platform_send_msg(struct ipc_msg *msg) { return 0; }
+static inline int ipc_platform_send_msg(const struct ipc_msg *msg) { return 0; }
 
 #endif /* __PLATFORM_PLATFORM_H__ */
 
diff --git a/test/cmocka/src/common_mocks.c b/test/cmocka/src/common_mocks.c
@@ -219,7 +219,7 @@ void WEAK ipc_platform_complete_cmd(struct ipc *ipc)
 }
 
 #if !CONFIG_LIBRARY
-int WEAK ipc_platform_send_msg(struct ipc_msg *msg)
+int WEAK ipc_platform_send_msg(const struct ipc_msg *msg)
 {
 	return 0;
 }

Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`
`169`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`169`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`170`	`170`	`{`
`171`	`171`	`int ret = 0;`
`172`	`172`	`acp_sw_intr_trig_t sw_intr_trig;`
`@@ -198,7 +198,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)`
`198`	`198`	`goto out;`
`199`	`199`	`/* Write new message in the mailbox */`
`200`	`200`	`mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);`
`201`		`- list_item_del(&msg->list);`
	`201`	`+`
`202`	`202`	`/* Need to set DSP message flag */`
`203`	`203`	`sof_ipc_dsp_msg_set();`
`204`	`204`	`/* now interrupt host to tell it we have sent a message */`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`123`	`123`	`}`
`124`	`124`	`}`
`125`	`125`
`126`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`126`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`127`	`127`	`{`
`128`	`128`	`struct ipc *ipc = ipc_get();`
`129`	`129`	`int ret = 0;`
`@@ -137,7 +137,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)`
`137`	`137`
`138`	`138`	`/* now send the message */`
`139`	`139`	`mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);`
`140`		`- list_item_del(&msg->list);`
	`140`	`+`
`141`	`141`	`tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);`
`142`	`142`
`143`	`143`	`ipc->is_notification_pending = true;`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`111`	`111`	`shim_write(SHIM_IMRD, shim_read(SHIM_IMRD) & ~SHIM_IMRD_BUSY);`
`112`	`112`	`}`
`113`	`113`
`114`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`114`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`115`	`115`	`{`
`116`	`116`	`struct ipc *ipc = ipc_get();`
`117`	`117`	`int ret = 0;`
`@@ -125,7 +125,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)`
`125`	`125`
`126`	`126`	`/* now send the message */`
`127`	`127`	`mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);`
`128`		`- list_item_del(&msg->list);`
	`128`	`+`
`129`	`129`	`tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);`
`130`	`130`
`131`	`131`	`ipc->is_notification_pending = true;`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`214`	`214`	`ipc_write(IPC_DIPCCTL, ipc_read(IPC_DIPCCTL) \| IPC_DIPCCTL_IPCTBIE);`
`215`	`215`	`}`
`216`	`216`
`217`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`217`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`218`	`218`	`{`
`219`	`219`	`struct ipc *ipc = ipc_get();`
`220`	`220`	`ipc_cmd_hdr *hdr;`
`@@ -231,7 +231,6 @@ int ipc_platform_send_msg(struct ipc_msg *msg)`
`231`	`231`	`goto out;`
`232`	`232`	`}`
`233`	`233`
`234`		`- list_item_del(&msg->list);`
`235`	`234`	`tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);`
`236`	`235`
`237`	`236`	`ipc->is_notification_pending = true;`
Original file line number	Diff line number	Diff line change
`@@ -65,11 +65,11 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`65`	`65`	`{`
`66`	`66`	`}`
`67`	`67`
`68`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`68`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`69`	`69`	`{`
`70`	`70`	`/* now send the message */`
`71`	`71`	`mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);`
`72`		`- list_item_del(&msg->list);`
	`72`	`+`
`73`	`73`	`tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);`
`74`	`74`
`75`	`75`	`/* now interrupt host to tell it we have message sent */`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`113`	`113`
`114`	`114`	`}`
`115`	`115`
`116`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`116`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`117`	`117`	`{`
`118`	`118`	`struct ipc *ipc = ipc_get();`
`119`	`119`	`int ret = 0;`
`@@ -127,7 +127,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)`
`127`	`127`
`128`	`128`	`/* now send the message */`
`129`	`129`	`mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);`
`130`		`- list_item_del(&msg->list);`
	`130`	`+`
`131`	`131`	`tr_dbg(&ipc_tr, "ipc: msg tx -> 0x%x", msg->header);`
`132`	`132`
`133`	`133`	`ipc->is_notification_pending = true;`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`89`	`89`	`wait_for_interrupt(0);`
`90`	`90`	`}`
`91`	`91`
`92`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`92`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`93`	`93`	`{`
`94`	`94`	`struct ipc *ipc = ipc_get();`
`95`	`95`
`@@ -98,7 +98,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)`
`98`	`98`
`99`	`99`	`/* now send the message */`
`100`	`100`	`mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);`
`101`		`- list_item_del(&msg->list);`
	`101`	`+`
`102`	`102`	`ipc->is_notification_pending = true;`
`103`	`103`
`104`	`104`	`/* now interrupt host to tell it we have sent a message */`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ void ipc_platform_complete_cmd(struct ipc *ipc)`
`88`	`88`	`wait_for_interrupt(0);`
`89`	`89`	`}`
`90`	`90`
`91`		`-int ipc_platform_send_msg(struct ipc_msg *msg)`
	`91`	`+int ipc_platform_send_msg(const struct ipc_msg *msg)`
`92`	`92`	`{`
`93`	`93`	`struct ipc *ipc = ipc_get();`
`94`	`94`
`@@ -97,7 +97,7 @@ int ipc_platform_send_msg(struct ipc_msg *msg)`
`97`	`97`
`98`	`98`	`/* now send the message */`
`99`	`99`	`mailbox_dspbox_write(0, msg->tx_data, msg->tx_size);`
`100`		`- list_item_del(&msg->list);`
	`100`	`+`
`101`	`101`	`ipc->is_notification_pending = true;`
`102`	`102`
`103`	`103`	`/* now interrupt host to tell it we have sent a message */`