Re: [PATCH RFCv3 03/17] [media] DocBook: Use the generic error code page also for MC API

Hans Verkuil
2011-07-07T15:29:11Z

On Wednesday, July 06, 2011 20:03:52 Mauro Carvalho Chehab wrote:
> Instead of having their own generic error codes at the MC API, move
> its section to the generic one and be sure that all media ioctl's
> will point to it.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
>
> diff --git a/Documentation/DocBook/media/v4l/gen-errors.xml b/Documentation/DocBook/media/v4l/gen-errors.xml
> index 6ef476a..a7f73c9 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;
>
> +
> + <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>

This seems to be a copy-and-paste error. The original text in media-func-ioctl.xml says this:

<parameter>argp</parameter> references an inaccessible memory
area.

> + </row>
> + <row>
> <entry>EINVAL</entry>
> + <entry>One or more of the ioctl parameters are invalid. This is a widely

widely -> widely used

> + error code. see the individual ioctl requests for actual causes.</entry>

see -> See

Regards,

Hans

> + </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 bda8604..e0ee285 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>
> - Return Value
> -
> - <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;
> + Request-specific error codes are listed in the
> individual requests descriptions.
> When an ioctl that takes an output or read/write parameter fails,
> the parameter remains unmodified.
> -
> - <variablelist>
> - <varlistentry>
> - <term><errorcode>EBADF</errorcode></term>
> -
> - <parameter>fd</parameter> is not a valid open file descriptor.
> -
> -
> - </varlistentry>
> - <varlistentry>
> - <term><errorcode>EFAULT</errorcode></term>
> -
> - <parameter>argp</parameter> references an inaccessible memory
> - area.
> -
> - </varlistentry>
> - <varlistentry>
> - <term><errorcode>EINVAL</errorcode></term>
> -
> - 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
> - for actual causes.
> -
> - </varlistentry>
> - <varlistentry>
> - <term><errorcode>ENOMEM</errorcode></term>
> -
> - Insufficient kernel memory was available to complete the
> - request.
> -
> - </varlistentry>
> - <varlistentry>
> - <term><errorcode>ENOTTY</errorcode></term>
> -
> - <parameter>fd</parameter> is not associated with a character
> - special device.
> -
> - </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 1f32373..2ce5214 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>
> - Return value
> - This function doesn't return specific error codes.
> + &return-value;
> </refsect1>
> </refentry>
>