Component: Add comp_get_copy_limits() function for copy() preparations

singalsu · lgirdwood · commit 22ecaa41e159 · 2019-04-02T09:53:29.000+01:00
This patch adds into component.c/h an utility function and
a data structure to simplify audio component's copy() method code.

The do-nothing function pipeline_xrun() is added to avoid cmocka test
fail due to adding function comp_get_copy_limits().

Signed-off-by: Seppo Ingalsuo &lt;seppo.ingalsuo@linux.intel.com&gt;
diff --git a/src/audio/component.c b/src/audio/component.c
@@ -248,3 +248,36 @@ void sys_comp_init(void)
 		((void(*)(void))(*comp_init))();
 	}
 }
+
+int comp_get_copy_limits(struct comp_dev *dev, struct comp_copy_limits *cl)
+{
+	/* Get source and sink buffer addresses */
+	cl->source = list_first_item(&dev->bsource_list, struct comp_buffer,
+				     sink_list);
+	cl->sink = list_first_item(&dev->bsink_list, struct comp_buffer,
+				   source_list);
+
+	/* check for underrun */
+	if (cl->source->avail == 0) {
+		trace_comp_error("comp_get_copy_limits() error: "
+				 "source component buffer"
+				 " has not enough data available");
+		comp_underrun(dev, cl->source, 0, 0);
+		return -EIO;
+	}
+
+	/* check for overrun */
+	if (cl->sink->free == 0) {
+		trace_comp_error("comp_get_copy_limits() error: "
+				 "sink component buffer"
+				 " has not enough free bytes for copy");
+		comp_overrun(dev, cl->sink, 0, 0);
+		return -EIO;
+	}
+
+	cl->frames = comp_avail_frames(cl->source, cl->sink);
+	cl->source_bytes = cl->frames * comp_frame_bytes(cl->source->source);
+	cl->sink_bytes = cl->frames * comp_frame_bytes(cl->sink->sink);
+
+	return 0;
+}
diff --git a/src/include/sof/audio/component.h b/src/include/sof/audio/component.h
@@ -272,6 +272,15 @@ struct comp_dev {
  *  @{
  */
 
+/** \brief Struct for use with comp_get_copy_limits() function. */
+struct comp_copy_limits {
+	struct comp_buffer *sink;
+	struct comp_buffer *source;
+	int frames;
+	int source_bytes;
+	int sink_bytes;
+};
+
 /** \brief Computes size of the component device including ipc config. */
 #define COMP_SIZE(x) \
 	(sizeof(struct comp_dev) - sizeof(struct sof_ipc_comp) + sizeof(x))
@@ -697,6 +706,13 @@ static inline void comp_overrun(struct comp_dev *dev, struct comp_buffer *sink,
 	pipeline_xrun(dev->pipeline, dev, (int32_t)copy_bytes - sink->free);
 }
 
+/**
+ * Called by component in copy.
+ * @param dev Component device.
+ * @param cl Struct of parameters for use in copy function.
+ */
+int comp_get_copy_limits(struct comp_dev *dev, struct comp_copy_limits *cl);
+
 /** @}*/
 
 /** @}*/
diff --git a/test/cmocka/src/audio/component/mock.c b/test/cmocka/src/audio/component/mock.c
@@ -48,4 +48,8 @@ void *rzalloc(int zone, uint32_t caps, size_t bytes)
 	return calloc(bytes, 1);
 }
 
+void pipeline_xrun(struct pipeline *p, struct comp_dev *dev, int32_t bytes)
+{
+}
+
 #endif

Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,8 @@ void *rzalloc(int zone, uint32_t caps, size_t bytes)`
`48`	`48`	`return calloc(bytes, 1);`
`49`	`49`	`}`
`50`	`50`
	`51`	`+void pipeline_xrun(struct pipeline p, struct comp_dev dev, int32_t bytes)`
	`52`	`+{`
	`53`	`+}`
	`54`	`+`
`51`	`55`	`#endif`