aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/v4l/vidioc-cropcap.xml
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2012-09-14 06:40:43 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-09-26 09:41:41 -0400
commit06fce2861d5a4ebcff65e253b2b3e4406dc3ab24 (patch)
tree5d28082d4c0aa2f20201e9c5b97ef4b0fcbc468c /Documentation/DocBook/media/v4l/vidioc-cropcap.xml
parent0b1f8149a5e7ee71f36af75bb516eb8219158f2d (diff)
[media] DocBook: Mark CROPCAP as optional instead of as compulsory
While the documentation says that VIDIOC_CROPCAP is compulsory for all video capture and output devices, in practice VIDIOC_CROPCAP is only implemented for devices that can do cropping and/or scaling. Update the documentation to no longer require VIDIOC_CROPCAP if the driver does not support cropping or scaling or non-square pixels. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Reviewed-by: Sakari Ailus <sakari.ailus@iki.fi> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook/media/v4l/vidioc-cropcap.xml')
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-cropcap.xml10
1 files changed, 7 insertions, 3 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-cropcap.xml b/Documentation/DocBook/media/v4l/vidioc-cropcap.xml
index 4559c452a613..bf7cc979fdfa 100644
--- a/Documentation/DocBook/media/v4l/vidioc-cropcap.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-cropcap.xml
@@ -59,6 +59,9 @@ constant except when switching the video standard. Remember this
59switch can occur implicit when switching the video input or 59switch can occur implicit when switching the video input or
60output.</para> 60output.</para>
61 61
62 <para>This ioctl must be implemented for video capture or output devices that
63support cropping and/or scaling and/or have non-square pixels, and for overlay devices.</para>
64
62 <table pgwide="1" frame="none" id="v4l2-cropcap"> 65 <table pgwide="1" frame="none" id="v4l2-cropcap">
63 <title>struct <structname>v4l2_cropcap</structname></title> 66 <title>struct <structname>v4l2_cropcap</structname></title>
64 <tgroup cols="3"> 67 <tgroup cols="3">
@@ -70,7 +73,9 @@ output.</para>
70 <entry>Type of the data stream, set by the application. 73 <entry>Type of the data stream, set by the application.
71Only these types are valid here: 74Only these types are valid here:
72<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>, 75<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>,
73<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> and 76<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>,
77<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant>,
78<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant> and
74<constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>. See <xref linkend="v4l2-buf-type" />.</entry> 79<constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>. See <xref linkend="v4l2-buf-type" />.</entry>
75 </row> 80 </row>
76 <row> 81 <row>
@@ -154,8 +159,7 @@ on 22 Oct 2002 subject "Re:[V4L][patches!] Re:v4l2/kernel-2.5" -->
154 <term><errorcode>EINVAL</errorcode></term> 159 <term><errorcode>EINVAL</errorcode></term>
155 <listitem> 160 <listitem>
156 <para>The &v4l2-cropcap; <structfield>type</structfield> is 161 <para>The &v4l2-cropcap; <structfield>type</structfield> is
157invalid. This is not permitted for video capture, output and overlay devices, 162invalid.</para>
158which must support <constant>VIDIOC_CROPCAP</constant>.</para>
159 </listitem> 163 </listitem>
160 </varlistentry> 164 </varlistentry>
161 </variablelist> 165 </variablelist>