public inbox for linux-media@vger.kernel.org
 help / color / mirror / Atom feed
From: Sakari Ailus <sakari.ailus@linux.intel.com>
To: linux-media@vger.kernel.org
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
	tomi.valkeinen@ideasonboard.com, bingbu.cao@intel.com,
	hongju.wang@intel.com, hverkuil@xs4all.nl
Subject: [PATCH 4/7] media: uapi: v4l: Document source routes
Date: Fri, 30 Jun 2023 23:43:35 +0300	[thread overview]
Message-ID: <20230630204338.126583-5-sakari.ailus@linux.intel.com> (raw)
In-Reply-To: <20230630204338.126583-1-sakari.ailus@linux.intel.com>

Document how internal pads are used on source routes.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 .../userspace-api/media/v4l/dev-subdev.rst    | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/Documentation/userspace-api/media/v4l/dev-subdev.rst b/Documentation/userspace-api/media/v4l/dev-subdev.rst
index a4f1df7093e8..5a46c9a9d352 100644
--- a/Documentation/userspace-api/media/v4l/dev-subdev.rst
+++ b/Documentation/userspace-api/media/v4l/dev-subdev.rst
@@ -551,6 +551,26 @@ A stream at a specific point in the media pipeline is identified by the
 sub-device and a (pad, stream) pair. For sub-devices that do not support
 multiplexed streams the 'stream' field is always 0.
 
+.. _v4l2-subdev-source-routes:
+
+Source routes
+^^^^^^^^^^^^^
+
+Cases where a single sub-device pad is a source of multiple streams are special
+as there is no external sink pad for such a route. In those cases, the sources
+of the streams are indicated by source routes that have an internal source pad
+as the sink pad of such a route. Internal source pads have the
+:ref:`MEDIA_PAD_FL_INTERNAL <MEDIA-PAD-FL-INTERNAL>` and ``MEDIA_PAD_FL_SINK``
+pad flags set.
+
+Internal source pads have all the properties of a sink pad in such case,
+including formats and selections. The format in this case is the source format
+of the stream. An internal pad always has a single stream only (0).
+
+Generally source routes are not modifiable but they can be activated and
+deactivated using the :ref:`V4L2_SUBDEV_ROUTE_FL_ACTIVE
+<v4l2-subdev-routing-flags>` flag, depending on driver capabilities.
+
 Interaction between routes, streams, formats and selections
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- 
2.39.2


  parent reply	other threads:[~2023-06-30 20:43 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-30 20:43 [PATCH 0/7] Generic line based metadata support, internal pads Sakari Ailus
2023-06-30 20:43 ` [PATCH 1/7] media: mc: Check pad flag validity Sakari Ailus
2023-07-03  7:53   ` Jacopo Mondi
2023-07-05 14:40     ` Sakari Ailus
2023-06-30 20:43 ` [PATCH 2/7] media: mc: Add INTERNAL pad flag Sakari Ailus
2023-06-30 20:43 ` [PATCH 3/7] media: v4l: subdev: Support INTERNAL pads in routing IOCTLs Sakari Ailus
2023-07-02 11:57   ` Andrey Konovalov
2023-07-05 14:39     ` Sakari Ailus
2023-06-30 20:43 ` Sakari Ailus [this message]
2023-07-03  7:47   ` [PATCH 4/7] media: uapi: v4l: Document source routes Jacopo Mondi
2023-07-06 10:20     ` Sakari Ailus
2023-07-08 12:13     ` Sakari Ailus
2023-07-10 12:53       ` Jacopo Mondi
2023-08-01 14:56         ` Sakari Ailus
2023-06-30 20:43 ` [PATCH 5/7] media: uapi: Add generic serial metadata mbus formats Sakari Ailus
2023-06-30 20:43 ` [PATCH 6/7] media: uapi: Add generic 8-bit metadata format definitions Sakari Ailus
2023-06-30 20:43 ` [PATCH 7/7] media: v4l: Support line-based metadata capture Sakari Ailus
2023-07-04 12:57 ` [PATCH 0/7] Generic line based metadata support, internal pads Laurent Pinchart
2023-07-05  8:27   ` Sakari Ailus

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=20230630204338.126583-5-sakari.ailus@linux.intel.com \
    --to=sakari.ailus@linux.intel.com \
    --cc=bingbu.cao@intel.com \
    --cc=hongju.wang@intel.com \
    --cc=hverkuil@xs4all.nl \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-media@vger.kernel.org \
    --cc=tomi.valkeinen@ideasonboard.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