diff options
Diffstat (limited to 'Documentation/DocBook')
| -rw-r--r-- | Documentation/DocBook/media/v4l/gen-errors.xml | 16 | ||||
| -rw-r--r-- | Documentation/DocBook/media/v4l/media-func-ioctl.xml | 48 | ||||
| -rw-r--r-- | Documentation/DocBook/media/v4l/media-ioc-device-info.xml | 3 |
3 files changed, 18 insertions, 49 deletions
diff --git a/Documentation/DocBook/media/v4l/gen-errors.xml b/Documentation/DocBook/media/v4l/gen-errors.xml index 6ef476a5401..9bf9ca7f46d 100644 --- a/Documentation/DocBook/media/v4l/gen-errors.xml +++ b/Documentation/DocBook/media/v4l/gen-errors.xml @@ -5,6 +5,11 @@ <tgroup cols="2"> &cs-str; <tbody valign="top"> + <!-- Keep it ordered alphabetically --> + <row> + <entry>EBADF</entry> + <entry><parameter>fd</parameter> is not a valid open file descriptor.</entry> + </row> <row> <entry>EBUSY</entry> <entry>The ioctl can't be handled because the device is busy. This is @@ -15,7 +20,16 @@ problem first (typically: stop the stream before retrying).</entry> </row> <row> + <entry>EFAULT</entry> + <entry><parameter>fd</parameter> is not a valid open file descriptor.</entry> + </row> + <row> <entry>EINVAL</entry> + <entry>One or more of the ioctl parameters are invalid. This is a widely + used error code. See the individual ioctl requests for actual causes.</entry> + </row> + <row> + <entry>EINVAL or ENOTTY</entry> <entry>The ioctl is not supported by the driver, actually meaning that the required functionality is not available.</entry> </row> @@ -25,7 +39,7 @@ </row> <row> <entry>ENOSPC</entry> - <entry>On USB devices, the stream ioctl's can return this error meaning + <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> diff --git a/Documentation/DocBook/media/v4l/media-func-ioctl.xml b/Documentation/DocBook/media/v4l/media-func-ioctl.xml index bda8604de15..e0ee285baf1 100644 --- a/Documentation/DocBook/media/v4l/media-func-ioctl.xml +++ b/Documentation/DocBook/media/v4l/media-func-ioctl.xml @@ -63,54 +63,10 @@ </refsect1> <refsect1> - <title>Return Value</title> - - <para><function>ioctl()</function> returns <returnvalue>0</returnvalue> on - success. On failure, <returnvalue>-1</returnvalue> is returned, and the - <varname>errno</varname> variable is set appropriately. Generic error codes - are listed below, and request-specific error codes are listed in the + &return-value; + <para>Request-specific error codes are listed in the individual requests descriptions.</para> <para>When an ioctl that takes an output or read/write parameter fails, the parameter remains unmodified.</para> - - <variablelist> - <varlistentry> - <term><errorcode>EBADF</errorcode></term> - <listitem> - <para><parameter>fd</parameter> is not a valid open file descriptor. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><errorcode>EFAULT</errorcode></term> - <listitem> - <para><parameter>argp</parameter> references an inaccessible memory - area.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><errorcode>EINVAL</errorcode></term> - <listitem> - <para>The <parameter>request</parameter> or the data pointed to by - <parameter>argp</parameter> is not valid. This is a very common error - code, see the individual ioctl requests listed in - <xref linkend="media-user-func" /> for actual causes.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><errorcode>ENOMEM</errorcode></term> - <listitem> - <para>Insufficient kernel memory was available to complete the - request.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><errorcode>ENOTTY</errorcode></term> - <listitem> - <para><parameter>fd</parameter> is not associated with a character - special device.</para> - </listitem> - </varlistentry> - </variablelist> </refsect1> </refentry> diff --git a/Documentation/DocBook/media/v4l/media-ioc-device-info.xml b/Documentation/DocBook/media/v4l/media-ioc-device-info.xml index 1f3237351bb..2ce521419e6 100644 --- a/Documentation/DocBook/media/v4l/media-ioc-device-info.xml +++ b/Documentation/DocBook/media/v4l/media-ioc-device-info.xml @@ -127,7 +127,6 @@ </refsect1> <refsect1> - <title>Return value</title> - <para>This function doesn't return specific error codes.</para> + &return-value; </refsect1> </refentry> |