| Message ID | 20190616020959.7360-1-andrealmeid@collabora.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2,1/2] media: vimc: stream: add missing function documentation | expand |
On 6/15/19 7:09 PM, André Almeida wrote: > Add comments at vimc_streamer_s_stream and vimc_streamer_thread, making > the vimc-stream totally documented. > > Signed-off-by: André Almeida <andrealmeid@collabora.com> > --- > Commit extracted from [PATCH 0/4] media: vimc: Minor code cleanup > and documentation > > Changes in v2: fix typos > > drivers/media/platform/vimc/vimc-streamer.c | 22 +++++++++++++++++++++ > 1 file changed, 22 insertions(+) > > diff --git a/drivers/media/platform/vimc/vimc-streamer.c b/drivers/media/platform/vimc/vimc-streamer.c > index 236ade38f1da..76435e87d609 100644 > --- a/drivers/media/platform/vimc/vimc-streamer.c > +++ b/drivers/media/platform/vimc/vimc-streamer.c > @@ -122,6 +122,14 @@ static int vimc_streamer_pipeline_init(struct vimc_stream *stream, > return -EINVAL; > } > > +/* > + * vimc_streamer_thread - process frames through the pipeline > + * > + * @data: vimc_stream struct of the current streaming of the current stream ?? > + * > + * From the source to the sink, gets a frame from each subdevice and send to > + * the next one of the pipeline in a fixed framerate. > + */ > static int vimc_streamer_thread(void *data) > { > struct vimc_stream *stream = data; > @@ -149,6 +157,20 @@ static int vimc_streamer_thread(void *data) > return 0; > } > > +/* > + * vimc_streamer_s_stream - start/stop the streaming on the media pipeline > + * > + * @stream: the pointer to the stream structure of the current stream > + * @ved: pointer to the vimc entity of the entity of the stream > + * @enable: flag to determine if stream should start/stop > + * > + * When starting, check if there is no stream->kthread allocated. This should > + * indicate that a streaming is already running. Then, it initializes > + * the pipeline, creates and runs a kthread to consume buffers through the > + * pipeline. > + * When stopping, analogously check if there is a stream running, stops > + * the thread and terminates the pipeline. > + */ > int vimc_streamer_s_stream(struct vimc_stream *stream, > struct vimc_ent_device *ved, > int enable) >
diff --git a/drivers/media/platform/vimc/vimc-streamer.c b/drivers/media/platform/vimc/vimc-streamer.c index 236ade38f1da..76435e87d609 100644 --- a/drivers/media/platform/vimc/vimc-streamer.c +++ b/drivers/media/platform/vimc/vimc-streamer.c @@ -122,6 +122,14 @@ static int vimc_streamer_pipeline_init(struct vimc_stream *stream, return -EINVAL; } +/* + * vimc_streamer_thread - process frames through the pipeline + * + * @data: vimc_stream struct of the current streaming + * + * From the source to the sink, gets a frame from each subdevice and send to + * the next one of the pipeline in a fixed framerate. + */ static int vimc_streamer_thread(void *data) { struct vimc_stream *stream = data; @@ -149,6 +157,20 @@ static int vimc_streamer_thread(void *data) return 0; } +/* + * vimc_streamer_s_stream - start/stop the streaming on the media pipeline + * + * @stream: the pointer to the stream structure of the current stream + * @ved: pointer to the vimc entity of the entity of the stream + * @enable: flag to determine if stream should start/stop + * + * When starting, check if there is no stream->kthread allocated. This should + * indicate that a streaming is already running. Then, it initializes + * the pipeline, creates and runs a kthread to consume buffers through the + * pipeline. + * When stopping, analogously check if there is a stream running, stops + * the thread and terminates the pipeline. + */ int vimc_streamer_s_stream(struct vimc_stream *stream, struct vimc_ent_device *ved, int enable)
Add comments at vimc_streamer_s_stream and vimc_streamer_thread, making the vimc-stream totally documented. Signed-off-by: André Almeida <andrealmeid@collabora.com> --- Commit extracted from [PATCH 0/4] media: vimc: Minor code cleanup and documentation Changes in v2: fix typos drivers/media/platform/vimc/vimc-streamer.c | 22 +++++++++++++++++++++ 1 file changed, 22 insertions(+)