Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 06fce286 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

[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: default avatarHans Verkuil <hans.verkuil@cisco.com>
Reviewed-by: default avatarSakari Ailus <sakari.ailus@iki.fi>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 0b1f8149

Documentation/DocBook/media/v4l/vidioc-cropcap.xml

+7 −3
Original line number Diff line number Diff line
@@ -59,6 +59,9 @@ constant except when switching the video standard. Remember this 
switch can occur implicit when switching the video input or

output.</para>



    <para>This ioctl must be implemented for video capture or output devices that

support cropping and/or scaling and/or have non-square pixels, and for overlay devices.</para>



    <table pgwide="1" frame="none" id="v4l2-cropcap">

      <title>struct <structname>v4l2_cropcap</structname></title>

      <tgroup cols="3">
@@ -70,7 +73,9 @@ output.</para> 
	    <entry>Type of the data stream, set by the application.

Only these types are valid here:

<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>,

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> and

<constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>,

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant>,

<constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant> and

<constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>. See <xref linkend="v4l2-buf-type" />.</entry>

	  </row>

	  <row>
@@ -154,8 +159,7 @@ on 22 Oct 2002 subject "Re:[V4L][patches!] Re:v4l2/kernel-2.5" --> 
	<term><errorcode>EINVAL</errorcode></term>

	<listitem>

	  <para>The &v4l2-cropcap; <structfield>type</structfield> is

invalid. This is not permitted for video capture, output and overlay devices,

which must support <constant>VIDIOC_CROPCAP</constant>.</para>

invalid.</para>

	</listitem>

      </varlistentry>

    </variablelist>