Audio: Copier: Add error handling for audio_stream_fmt_conversion()

This patch re-arranges function audio_stream_fmt_conversion()
to use switch-case for IPC4 sample types handling. Errors
are returned for non-enabled formats and for illegal depth
and valid values.

The U8 format must be unsigned type. The normal s16/s24/s32
SOF types are allowed to be MSB integer, LSB integer, or signed
integer as relaxed check. Currently topology uses LSB integer as
default. The handling of MSB integer that is used in some parts
of topologies is done elsewhere.

The SOF_IPC_FRAME_INVALID is added as second error indicator.
It avoids e.g. in IPC helper function use of uninitialized
frame_fmt. The function audio_stream_fmt_conversion() is called
from a large number of other functions without check for return
code. But the components usually check their format and without
a handler for it, will block processing with unsupported format.

Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

Author: singalsu

src/audio/copier/copier_host.c

@@ -149,15 +149,28 @@ __cold int copier_host_create(struct comp_dev *dev, struct copier_data *cd,
 	config->type = SOF_COMP_HOST;
 	cd->gtw_type = ipc4_gtw_host;
 
-	audio_stream_fmt_conversion(copier_cfg->base.audio_fmt.depth,
-				    copier_cfg->base.audio_fmt.valid_bit_depth,
-				    &in_frame_fmt, &in_valid_fmt,
-				    copier_cfg->base.audio_fmt.s_type);
-
-	audio_stream_fmt_conversion(copier_cfg->out_fmt.depth,
-				    copier_cfg->out_fmt.valid_bit_depth,
-				    &out_frame_fmt, &out_valid_fmt,
-				    copier_cfg->out_fmt.s_type);
+	ret = audio_stream_fmt_conversion(copier_cfg->base.audio_fmt.depth,
+					  copier_cfg->base.audio_fmt.valid_bit_depth,
+					  &in_frame_fmt, &in_valid_fmt,
+					  copier_cfg->base.audio_fmt.s_type);
+	if (ret) {
+		comp_err(dev, "failed with input format: depth %d, valid %d, type %d",
+			 copier_cfg->base.audio_fmt.depth,
+			 copier_cfg->base.audio_fmt.valid_bit_depth,
+			 copier_cfg->base.audio_fmt.s_type);
+		return ret;
+	}
+
+	ret = audio_stream_fmt_conversion(copier_cfg->out_fmt.depth,
+					  copier_cfg->out_fmt.valid_bit_depth,
+					  &out_frame_fmt, &out_valid_fmt,
+					  copier_cfg->out_fmt.s_type);
+	if (ret) {
+		comp_err(dev, "failed with output format: depth %d, valid %d, type %d",
+			 copier_cfg->out_fmt.depth, copier_cfg->out_fmt.valid_bit_depth,
+			 copier_cfg->out_fmt.s_type);
+		return ret;
+	}
 
 	memset(&ipc_host, 0, sizeof(ipc_host));
 	ipc_host.direction = dir;

src/include/module/ipc/stream.h

@@ -25,6 +25,7 @@ enum sof_ipc_frame {
 	SOF_IPC_FRAME_S16_4LE,		/* 16-bit in 32-bit container */
 	SOF_IPC_FRAME_A_LAW,
 	SOF_IPC_FRAME_MU_LAW,
+	SOF_IPC_FRAME_INVALID,		/* keep last */
 };
 
 #endif /* __MODULE_IPC_STREAM_H__ */

src/include/sof/audio/audio_stream.h

@@ -1007,54 +1007,74 @@ static inline void cir_buf_set_zero(void *ptr, void *buf_addr, void *buf_end, ui
 		memset(buf_addr, 0, tail_size);
 }
 
-static inline void audio_stream_fmt_conversion(enum ipc4_bit_depth depth,
-					       enum ipc4_bit_depth valid,
-					       enum sof_ipc_frame *frame_fmt,
-					       enum sof_ipc_frame *valid_fmt,
-					       enum ipc4_sample_type type)
+static inline int audio_stream_fmt_conversion(enum ipc4_bit_depth depth,
+					      enum ipc4_bit_depth valid,
+					      enum sof_ipc_frame *frame_fmt,
+					      enum sof_ipc_frame *valid_fmt,
+					      enum ipc4_sample_type type)
 {
-	/* IPC4_DEPTH_16BIT (16) <---> SOF_IPC_FRAME_S16_LE (0)
-	 * IPC4_DEPTH_24BIT (24) <---> SOF_IPC_FRAME_S24_4LE (1)
-	 * IPC4_DEPTH_32BIT (32) <---> SOF_IPC_FRAME_S32_LE (2)
-	 */
-	*frame_fmt = (enum sof_ipc_frame)((depth >> 3) - 2);
-	*valid_fmt = (enum sof_ipc_frame)((valid >> 3) - 2);
-
+	int ret = -EINVAL;
+	*frame_fmt = SOF_IPC_FRAME_INVALID;
+	*valid_fmt = SOF_IPC_FRAME_INVALID;
+
+	switch (type) {
+	case IPC4_TYPE_FLOAT:
+#ifdef CONFIG_FORMAT_FLOAT
+		if (depth == 32 && valid == 32) {
+			*frame_fmt = SOF_IPC_FRAME_FLOAT;
+			*valid_fmt = SOF_IPC_FRAME_FLOAT;
+			ret = 0;
+		}
+#endif
+		break;
+	case IPC4_TYPE_MSB_INTEGER:
+	case IPC4_TYPE_LSB_INTEGER:
+	case IPC4_TYPE_SIGNED_INTEGER:
+		if (depth == 24 && valid == 24) {
+#ifdef CONFIG_FORMAT_S24_3LE
+			*frame_fmt = SOF_IPC_FRAME_S24_3LE;
+			*valid_fmt = SOF_IPC_FRAME_S24_3LE;
+			ret = 0;
+#endif
+		} else {
+			/* IPC4_DEPTH_16BIT (16) <---> SOF_IPC_FRAME_S16_LE (0)
+			 * IPC4_DEPTH_24BIT (24) <---> SOF_IPC_FRAME_S24_4LE (1)
+			 * IPC4_DEPTH_32BIT (32) <---> SOF_IPC_FRAME_S32_LE (2)
+			 */
+			*frame_fmt = (enum sof_ipc_frame)((depth >> 3) - 2);
+			*valid_fmt = (enum sof_ipc_frame)((valid >> 3) - 2);
+			ret = 0;
+		}
+		break;
+	case IPC4_TYPE_UNSIGNED_INTEGER:
 #ifdef CONFIG_FORMAT_U8
-	if (depth == 8)
-		*frame_fmt = SOF_IPC_FRAME_U8;
-
-	if (valid == 8)
-		*valid_fmt = SOF_IPC_FRAME_U8;
+		if (depth == 8 && valid == 8) {
+			*frame_fmt = SOF_IPC_FRAME_U8;
+			*valid_fmt = SOF_IPC_FRAME_U8;
+			ret = 0;
+		}
 #endif /* CONFIG_FORMAT_U8 */
-
+		break;
+	case IPC4_TYPE_A_LAW:
 #ifdef CONFIG_FORMAT_A_LAW
-	if (type == IPC4_TYPE_A_LAW && depth == 8) {
-		*frame_fmt = SOF_IPC_FRAME_A_LAW;
-		*valid_fmt = SOF_IPC_FRAME_A_LAW;
-	}
+		if (depth == 8 && valid == 8) {
+			*frame_fmt = SOF_IPC_FRAME_A_LAW;
+			*valid_fmt = SOF_IPC_FRAME_A_LAW;
+			ret = 0;
+		}
 #endif
-
+		break;
+	case IPC4_TYPE_MU_LAW:
 #ifdef CONFIG_FORMAT_MU_LAW
-	if (type == IPC4_TYPE_MU_LAW && depth == 8) {
-		*frame_fmt = SOF_IPC_FRAME_MU_LAW;
-		*valid_fmt = SOF_IPC_FRAME_MU_LAW;
-	}
-#endif
-
-	if (valid == 24) {
-#ifdef CONFIG_FORMAT_S24_3LE
-		if (depth == 24) {
-			*frame_fmt = SOF_IPC_FRAME_S24_3LE;
-			*valid_fmt = SOF_IPC_FRAME_S24_3LE;
+		if (depth == 8 && valid == 8) {
+			*frame_fmt = SOF_IPC_FRAME_MU_LAW;
+			*valid_fmt = SOF_IPC_FRAME_MU_LAW;
+			ret = 0;
 		}
 #endif
+		break;
 	}
-
-	if (type == IPC4_TYPE_FLOAT && depth == 32) {
-		*frame_fmt = SOF_IPC_FRAME_FLOAT;
-		*valid_fmt = SOF_IPC_FRAME_FLOAT;
-	}
+	return ret;
 }
 /** @}*/