linux-kernel - Re: [PATCH 3/4] media: vimc: stream: add missing function documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <45507691-4836-8443-62f1-382383aa6e67@xs4all.nl>
Date:   Fri, 14 Jun 2019 09:23:09 +0200
From:   Hans Verkuil <hverkuil@...all.nl>
To:     André Almeida <andrealmeid@...labora.com>,
        linux-media@...r.kernel.org
Cc:     mchehab@...nel.org, helen.koike@...labora.com,
        kernel@...labora.com, lkcamp@...ts.libreplanetbr.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 3/4] media: vimc: stream: add missing function
 documentation

On 6/13/19 5:06 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@...labora.com>
> ---
>  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..8556cc6e8654 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, checks if there's no stream->kthread allocated. This should

checks -> check
there's -> there is

> + * indicates that a streaming is already running. Then, it's initialize

indicates -> indicate
it's initialize -> it initializes

> + * the pipeline, create and run a kthread to consume buffers through the

create and run -> creates and runs

> + * pipeline.
> + * When stopping, analogously check's it there's a streaming running, stops

check's it there's a streaming -> check if there is a stream



> + * the thread and terminate the pipeline.

terminate -> terminates

> + */
>  int vimc_streamer_s_stream(struct vimc_stream *stream,
>  			   struct vimc_ent_device *ved,
>  			   int enable)
> 

Regards,

	Hans