mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Steve Longerbeam <slongerbeam@gmail.com>
To: linux-media@vger.kernel.org
Cc: Steve Longerbeam <steve_longerbeam@mentor.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v5 17/17] [media] v4l2-subdev.rst: Update doc regarding subdev descriptors
Date: Fri, 29 Jun 2018 11:50:01 -0700	[thread overview]
Message-ID: <1530298220-5097-18-git-send-email-steve_longerbeam@mentor.com> (raw)
In-Reply-To: <1530298220-5097-1-git-send-email-steve_longerbeam@mentor.com>

Update the doc to describe the new method of adding subdevice
descriptors to async notifiers.

Signed-off-by: Steve Longerbeam <steve_longerbeam@mentor.com>
---
 Documentation/media/kapi/v4l2-subdev.rst | 28 +++++++++++++++++-----------
 1 file changed, 17 insertions(+), 11 deletions(-)

diff --git a/Documentation/media/kapi/v4l2-subdev.rst b/Documentation/media/kapi/v4l2-subdev.rst
index e1f0b72..7197eeb 100644
--- a/Documentation/media/kapi/v4l2-subdev.rst
+++ b/Documentation/media/kapi/v4l2-subdev.rst
@@ -247,20 +247,26 @@ performed using the :c:func:`v4l2_async_unregister_subdev` call. Subdevices
 registered this way are stored in a global list of subdevices, ready to be
 picked up by bridge drivers.
 
-Bridge drivers in turn have to register a notifier object with an array of
-subdevice descriptors that the bridge device needs for its operation. This is
+Bridge drivers in turn have to register a notifier object. This is
 performed using the :c:func:`v4l2_async_notifier_register` call. To
 unregister the notifier the driver has to call
 :c:func:`v4l2_async_notifier_unregister`. The former of the two functions
-takes two arguments: a pointer to struct :c:type:`v4l2_device` and a pointer to
-struct :c:type:`v4l2_async_notifier`. The latter contains a pointer to an array
-of pointers to subdevice descriptors of type struct :c:type:`v4l2_async_subdev`
-type. The V4L2 core will then use these descriptors to match asynchronously
-registered
-subdevices to them. If a match is detected the ``.bound()`` notifier callback
-is called. After all subdevices have been located the .complete() callback is
-called. When a subdevice is removed from the system the .unbind() method is
-called. All three callbacks are optional.
+takes two arguments: a pointer to struct :c:type:`v4l2_device` and a
+pointer to struct :c:type:`v4l2_async_notifier`.
+
+Before registering the notifier, bridge drivers form a list of
+subdevice descriptors that the bridge device needs for its operation.
+Subdevice descriptors are added to the notifier using the
+:c:func:`v4l2_async_notifier_add_subdev` call. This function takes
+two arguments: a pointer to struct :c:type:`v4l2_async_notifier`, and
+a pointer to the subdevice descripter, which is of type struct
+:c:type:`v4l2_async_subdev`.
+
+The V4L2 core will then use these descriptors to match asynchronously
+registered subdevices to them. If a match is detected the ``.bound()``
+notifier callback is called. After all subdevices have been located the
+.complete() callback is called. When a subdevice is removed from the
+system the .unbind() method is called. All three callbacks are optional.
 
 V4L2 sub-device userspace API
 -----------------------------
-- 
2.7.4


  parent reply	other threads:[~2018-06-29 18:53 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-29 18:49 [PATCH v5 00/17] media: imx: Switch to subdev notifiers Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 01/17] media: v4l2-fwnode: ignore endpoints that have no remote port parent Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 02/17] media: v4l2: async: Allow searching for asd of any type Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 03/17] media: v4l2: async: Add v4l2_async_notifier_add_subdev Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 04/17] media: v4l2: async: Add convenience functions to allocate and add asd's Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 05/17] media: v4l2-fwnode: Switch to v4l2_async_notifier_add_subdev Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 06/17] media: v4l2-fwnode: Add a convenience function for registering subdevs with notifiers Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 07/17] media: platform: video-mux: Register a subdev notifier Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 08/17] media: imx: csi: " Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 09/17] media: imx: mipi csi-2: " Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 10/17] media: staging/imx: of: Remove recursive graph walk Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 11/17] media: staging/imx: Loop through all registered subdevs for media links Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 12/17] media: staging/imx: Rename root notifier Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 13/17] media: staging/imx: Switch to v4l2_async_notifier_add_*_subdev Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 14/17] media: staging/imx: TODO: Remove one assumption about OF graph parsing Steve Longerbeam
2018-06-29 18:49 ` [PATCH v5 15/17] media: platform: Switch to v4l2_async_notifier_add_subdev Steve Longerbeam
2018-07-02  6:09   ` Dan Carpenter
2018-07-07 21:06     ` Steve Longerbeam
2018-07-02 11:23   ` Sakari Ailus
2018-07-07 21:09     ` Steve Longerbeam
2018-06-29 18:50 ` [PATCH v5 16/17] media: v4l2: async: Remove notifier subdevs array Steve Longerbeam
2018-06-29 18:50 ` Steve Longerbeam [this message]
2018-07-02  9:51 ` [PATCH v5 00/17] media: imx: Switch to subdev notifiers Sakari Ailus
2018-07-07 21:15   ` Steve Longerbeam

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=1530298220-5097-18-git-send-email-steve_longerbeam@mentor.com \
    --to=slongerbeam@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=steve_longerbeam@mentor.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

all inboxes | Powered by JetHome®