All of lore.kernel.org
 help / color / mirror / Atom feed
From: Daniel Scally <djrscally@gmail.com>
To: linux-media@vger.kernel.org, libcamera-devel@lists.libcamera.org
Cc: sakari.ailus@linux.intel.com, laurent.pinchart@ideasonboard.com,
	hanlinchen@chromium.org, tfiga@chromium.org, hdegoede@redhat.com,
	kieran.bingham@ideasonboard.com, hpa@redhat.com
Subject: [PATCH v2 3/6] media: docs: Add entries documenting ancillary links
Date: Sun, 30 Jan 2022 23:58:18 +0000	[thread overview]
Message-ID: <20220130235821.48076-4-djrscally@gmail.com> (raw)
In-Reply-To: <20220130235821.48076-1-djrscally@gmail.com>

Add some elements to the uAPI documentation to explain the new link
type, their purpose and some aspects of their current implementation.

Signed-off-by: Daniel Scally <djrscally@gmail.com>
---
Changes since v1:

	- New patch

 .../media/mediactl/media-controller-model.rst            | 6 ++++++
 .../userspace-api/media/mediactl/media-types.rst         | 9 ++++++++-
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/Documentation/userspace-api/media/mediactl/media-controller-model.rst b/Documentation/userspace-api/media/mediactl/media-controller-model.rst
index 222cb99debb5..f77cb9d952e5 100644
--- a/Documentation/userspace-api/media/mediactl/media-controller-model.rst
+++ b/Documentation/userspace-api/media/mediactl/media-controller-model.rst
@@ -33,3 +33,9 @@ are:
 
 -  An **interface link** is a point-to-point bidirectional control
    connection between a Linux Kernel interface and an entity.
+
+- An **ancillary link** is a point-to-point connection describing a physical
+  relationship between two entities. For example this could represent the
+  fact that a particular camera sensor and lens controller form a single
+  physical module, meaning this lens controller drives the lens for this
+  camera sensor.
\ No newline at end of file
diff --git a/Documentation/userspace-api/media/mediactl/media-types.rst b/Documentation/userspace-api/media/mediactl/media-types.rst
index 0a26397bd01d..d69bae359e5b 100644
--- a/Documentation/userspace-api/media/mediactl/media-types.rst
+++ b/Documentation/userspace-api/media/mediactl/media-types.rst
@@ -413,7 +413,7 @@ must be set for every pad.
 
     *  -  ``MEDIA_LNK_FL_LINK_TYPE``
        -  This is a bitmask that defines the type of the link. Currently,
-	  two types of links are supported:
+	  three types of links are supported:
 
 	  .. _MEDIA-LNK-FL-DATA-LINK:
 
@@ -423,3 +423,10 @@ must be set for every pad.
 
 	  ``MEDIA_LNK_FL_INTERFACE_LINK`` if the link is between an
 	  interface and an entity
+
+	  .. _MEDIA-LNK-FL-ANCILLARY-LINK:
+
+	  ``MEDIA_LNK_FL_ANCILLARY_LINK`` if the link is between two
+	  different entities. This at present implies both MEDIA_LNK_FL_ENABLED
+	  and MEDIA_LNK_FL_IMMUTABLE, however applications should not rely on
+	  that being the case in the future.
-- 
2.25.1


  parent reply	other threads:[~2022-01-30 23:59 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-30 23:58 [PATCH v2 0/6] Introduce ancillary links Daniel Scally
2022-01-30 23:58 ` [PATCH v2 1/6] media: entity: Skip non-data links in graph iteration Daniel Scally
2022-01-30 23:58 ` [PATCH v2 2/6] media: media.h: Add new media link type Daniel Scally
2022-02-02 23:15   ` Laurent Pinchart
2022-01-30 23:58 ` Daniel Scally [this message]
2022-02-02 23:25   ` [PATCH v2 3/6] media: docs: Add entries documenting ancillary links Laurent Pinchart
2022-01-30 23:58 ` [PATCH v2 4/6] media: entity: Add link_type_name() helper Daniel Scally
2022-01-30 23:58 ` [PATCH v2 5/6] media: entity: Add support for ancillary links Daniel Scally
2022-01-31 16:00   ` kernel test robot
2022-01-31 16:00     ` kernel test robot
2022-02-02 23:32   ` Laurent Pinchart
2022-02-02 23:32     ` Laurent Pinchart
2022-01-30 23:58 ` [PATCH v2 6/6] media: v4l2-async: Create links during v4l2_async_match_notify() Daniel Scally
2022-02-02 16:38   ` Sakari Ailus
2022-02-02 21:48     ` Daniel Scally
2022-02-10 23:51       ` Daniel Scally
2022-02-11 11:26       ` 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=20220130235821.48076-4-djrscally@gmail.com \
    --to=djrscally@gmail.com \
    --cc=hanlinchen@chromium.org \
    --cc=hdegoede@redhat.com \
    --cc=hpa@redhat.com \
    --cc=kieran.bingham@ideasonboard.com \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=libcamera-devel@lists.libcamera.org \
    --cc=linux-media@vger.kernel.org \
    --cc=sakari.ailus@linux.intel.com \
    --cc=tfiga@chromium.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.