summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/v4l/vidioc-g-parm.rst
diff options
context:
space:
mode:
authorSakari Ailus <sakari.ailus@linux.intel.com>2018-11-21 18:29:35 +0100
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>2018-11-23 11:16:29 +0100
commit5f229dcabc4acfb4e233e7678569f0fb9ab9c469 (patch)
tree52363894f33e0e3a34a3e56607adff19b2f83345 /Documentation/media/uapi/v4l/vidioc-g-parm.rst
parentmedia: sun6i: Add A31 compatible (diff)
downloadlinux-5f229dcabc4acfb4e233e7678569f0fb9ab9c469.tar.xz
linux-5f229dcabc4acfb4e233e7678569f0fb9ab9c469.zip
media: v4l: uAPI doc: Changing frame interval won't change format
Document that changing the frame interval has no effect on frame size. While this was the assumption in the API, it was not documented as such. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Diffstat (limited to 'Documentation/media/uapi/v4l/vidioc-g-parm.rst')
-rw-r--r--Documentation/media/uapi/v4l/vidioc-g-parm.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/media/uapi/v4l/vidioc-g-parm.rst b/Documentation/media/uapi/v4l/vidioc-g-parm.rst
index e831fa5512f0..c31585a7701b 100644
--- a/Documentation/media/uapi/v4l/vidioc-g-parm.rst
+++ b/Documentation/media/uapi/v4l/vidioc-g-parm.rst
@@ -42,6 +42,9 @@ side. This is especially useful when using the :ref:`read() <func-read>` or
:ref:`write() <func-write>`, which are not augmented by timestamps or sequence
counters, and to avoid unnecessary data copying.
+Changing the frame interval shall never change the format. Changing the
+format, on the other hand, may change the frame interval.
+
Further these ioctls can be used to determine the number of buffers used
internally by a driver in read/write mode. For implications see the
section discussing the :ref:`read() <func-read>` function.