Commit 43c1daa4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: Use the generic ioctl error codes for all V4L ioctl's 



Be sure that all VIDIOC_* ioctl are using the return error macro, and
aren't specifying generic error codes internally.

Acked-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 6d172492

Documentation/DocBook/media/v4l/gen-errors.xml

+18 −1
Original line number Diff line number Diff line
@@ -10,7 +10,24 @@ 
	<entry>The ioctl can't be handled because the device is busy. This is

	       typically return while device is streaming, and an ioctl tried to

	       change something that would affect the stream, or would require the

	       usage of a hardware resource that was already allocated.</entry>

	       usage of a hardware resource that was already allocated. The ioctl

	       must not be retried without performing another action to fix the

	       problem first (typically: stop the stream before retrying).</entry>

      </row>

      <row>

	<entry>EINVAL</entry>

	<entry>The ioctl is not supported by the driver, actually meaning that

	       the required functionality is not available.</entry>

      </row>

      <row>

	<entry>ENOMEM</entry>

	<entry>There's not enough memory to handle the desired operation.</entry>

      </row>

      <row>

	<entry>ENOSPC</entry>

	<entry>On USB devices, the stream ioctl's can return this error meaning

	       that this request would overcommit the usb bandwidth reserved

	       for periodic transfers (up to 80% of the USB bandwidth).</entry>

      </row>

    </tbody>

  </tgroup>

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

+2 −11
Original line number Diff line number Diff line
@@ -156,19 +156,10 @@ 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 or the ioctl is not supported. This is not permitted for

video capture, output and overlay devices, which must support

<constant>VIDIOC_CROPCAP</constant>.</para>

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

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

	</listitem>

      </varlistentry>

    </variablelist>

  </refsect1>

</refentry>
 


<!--

Local Variables:

mode: sgml

sgml-parent-document: "v4l2.sgml"

indent-tabs-mode: nil

End:

-->

Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-ident.xml

+1 −10
Original line number Diff line number Diff line
@@ -258,18 +258,9 @@ could not identify it.</entry> 
      <varlistentry>

	<term><errorcode>EINVAL</errorcode></term>

	<listitem>

	  <para>The driver does not support this ioctl, or the

<structfield>match_type</structfield> is invalid.</para>

	  <para>The <structfield>match_type</structfield> is invalid.</para>

	</listitem>

      </varlistentry>

     </variablelist>

  </refsect1>

</refentry>
 


<!--

Local Variables:

mode: sgml

sgml-parent-document: "v4l2.sgml"

indent-tabs-mode: nil

End:

-->

Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml

+0 −17
Original line number Diff line number Diff line
@@ -246,15 +246,6 @@ register.</entry> 
    &return-value;



    <variablelist>

      <varlistentry>

	<term><errorcode>EINVAL</errorcode></term>

	<listitem>

	  <para>The driver does not support this ioctl, or the kernel

was not compiled with the <constant>CONFIG_VIDEO_ADV_DEBUG</constant>

option, or the <structfield>match_type</structfield> is invalid, or the

selected chip or register does not exist.</para>

	</listitem>

      </varlistentry>

      <varlistentry>

	<term><errorcode>EPERM</errorcode></term>

	<listitem>
@@ -265,11 +256,3 @@ to execute these ioctls.</para> 
    </variablelist>

  </refsect1>

</refentry>
 


<!--

Local Variables:

mode: sgml

sgml-parent-document: "v4l2.sgml"

indent-tabs-mode: nil

End:

-->

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

+3 −7
Original line number Diff line number Diff line
@@ -136,11 +136,7 @@ 
    </table>



  </refsect1>

  <refsect1>

    &return-value;

  </refsect1>

</refentry>
 
<!--

Local Variables:

mode: sgml

sgml-parent-document: "v4l2.sgml"

indent-tabs-mode: nil

End:

-->