mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Helen Koike <helen.koike@collabora.com>
To: hverkuil-cisco@xs4all.nl, mchehab@kernel.org,
	linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
	kernel@collabora.com
Cc: Helen Koike <helen.koike@collabora.com>
Subject: [PATCH] media: vidioc-queryctrl.rst: clarify combining READ_ONLY with WRITE_ONLY
Date: Wed, 25 Sep 2019 12:09:45 -0300	[thread overview]
Message-ID: <20190925150945.27706-1-helen.koike@collabora.com> (raw)

Make it clear in the documentation that V4L2_CTRL_FLAG_READ_ONLY doesn't
conflict with V4L2_CTRL_FLAG_WRITE_ONLY. Also make it clear that
if both are combined then the control has read and write permissions.

Signed-off-by: Helen Koike <helen.koike@collabora.com>

---
Hi,

v4l2-compliance expects both flags for read and write permissions, so I
would like to make it clear in the docs.
Please let me know if this is not the case.

Thanks
Helen
---
 Documentation/media/uapi/v4l/vidioc-queryctrl.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
index a3d56ffbf4cc..1d3aecdf679f 100644
--- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
+++ b/Documentation/media/uapi/v4l/vidioc-queryctrl.rst
@@ -500,6 +500,11 @@ See also the examples in :ref:`control`.
       - 0x0004
       - This control is permanently readable only. Any attempt to change
 	the control will result in an ``EINVAL`` error code.
+
+	.. note::
+
+	   If combined with ``V4L2_CTRL_FLAG_WRITE_ONLY``, then both, read
+	   and write are allowed.
     * - ``V4L2_CTRL_FLAG_UPDATE``
       - 0x0008
       - A hint that changing this control may affect the value of other
@@ -523,6 +528,11 @@ See also the examples in :ref:`control`.
 	where writing a value will cause the device to carry out a given
 	action (e. g. motor control) but no meaningful value can be
 	returned.
+
+	.. note::
+
+	   If combined with ``V4L2_CTRL_FLAG_READ_ONLY``, then both, read
+	   and write are allowed.
     * - ``V4L2_CTRL_FLAG_VOLATILE``
       - 0x0080
       - This control is volatile, which means that the value of the
-- 
2.22.0


             reply	other threads:[~2019-09-25 15:10 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-25 15:09 Helen Koike [this message]
2019-09-25 15:17 ` Hans Verkuil
2019-09-25 16:29   ` Helen Koike
2019-09-25 16: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=20190925150945.27706-1-helen.koike@collabora.com \
    --to=helen.koike@collabora.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=kernel@collabora.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.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 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®