From: Helen Koike <helen.koike@collabora.com>
To: linux-media@vger.kernel.org
Cc: lucmaga@gmail.com, linux-kernel@vger.kernel.org,
lkcamp@lists.libreplanetbr.org, andrealmeid@collabora.com,
Hans Verkuil <hverkuil@xs4all.nl>,
kernel@collabora.com
Subject: [PATCH 6/8] media: vimc: stream: add docs to struct vimc_stream
Date: Wed, 6 Mar 2019 19:42:42 -0300 [thread overview]
Message-ID: <20190306224244.21070-7-helen.koike@collabora.com> (raw)
In-Reply-To: <20190306224244.21070-1-helen.koike@collabora.com>
Add missing documentation for struct vimc_stream
Signed-off-by: Helen Koike <helen.koike@collabora.com>
---
drivers/media/platform/vimc/vimc-streamer.h | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/drivers/media/platform/vimc/vimc-streamer.h b/drivers/media/platform/vimc/vimc-streamer.h
index dc1d0be431cb..a7c5ac5ace4f 100644
--- a/drivers/media/platform/vimc/vimc-streamer.h
+++ b/drivers/media/platform/vimc/vimc-streamer.h
@@ -15,6 +15,21 @@
#define VIMC_STREAMER_PIPELINE_MAX_SIZE 16
+/**
+ * struct vimc_stream - struct that represents a stream in the pipeline
+ *
+ * @pipe: the media pipeline object associated with this stream
+ * @ved_pipeline: array containing all the entities participating in the
+ * stream. The order is from a video device (usually a capture device) where
+ * stream_on was called, to the entity generating the first base image to be
+ * processed in the pipeline.
+ * @pipe_size: size of @ved_pipeline
+ * @kthread: thread that generates the frames of the stream.
+ *
+ * When the user call stream_on in a video device, struct vimc_stream is
+ * used to keep track of all entities and subdevices that generates and
+ * process frames for the stream.
+ */
struct vimc_stream {
struct media_pipeline pipe;
struct vimc_ent_device *ved_pipeline[VIMC_STREAMER_PIPELINE_MAX_SIZE];
--
2.20.1
next prev parent reply other threads:[~2019-03-06 22:43 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-06 22:42 [PATCH 0/8] media: vimc: remove media bus code limitation Helen Koike
2019-03-06 22:42 ` [PATCH 1/8] media: vimc: deb: fix default sink bayer format Helen Koike
2019-03-06 22:42 ` [PATCH 2/8] media: vimc: stream: fix thread state before sleep Helen Koike
2019-03-06 22:42 ` [PATCH 3/8] media: vimc: cap: fix step width/height in enum framesize Helen Koike
2019-03-06 22:42 ` [PATCH 4/8] media: v4l2-common: add bayer formats in v4l2_format_info Helen Koike
2019-03-06 22:42 ` [PATCH 5/8] media: vimc: stream: cleanup frame field from struct vimc_stream Helen Koike
2019-03-07 20:19 ` André Almeida
2019-03-06 22:42 ` Helen Koike [this message]
2019-03-06 22:42 ` [PATCH 7/8] media: vimc: stream: init/terminate the first entity Helen Koike
2019-03-07 20:21 ` André Almeida
2019-03-06 22:42 ` [PATCH 8/8] media: vimc: propagate pixel format in the stream Helen Koike
2019-03-07 20:23 ` André Almeida
2019-03-08 13:43 ` Hans Verkuil
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190306224244.21070-7-helen.koike@collabora.com \
--to=helen.koike@collabora.com \
--cc=andrealmeid@collabora.com \
--cc=hverkuil@xs4all.nl \
--cc=kernel@collabora.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=lkcamp@lists.libreplanetbr.org \
--cc=lucmaga@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).