public inbox for linux-media@vger.kernel.org
 help / color / mirror / Atom feed
From: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
To: Hans Verkuil <hverkuil@xs4all.nl>
Cc: linux-media@vger.kernel.org, ismael.luceno@corp.bluecherry.net,
	pete@sensoray.com, sylvester.nawrocki@gmail.com,
	sakari.ailus@iki.fi, Hans Verkuil <hans.verkuil@cisco.com>
Subject: Re: [RFCv2 PATCH 09/10] DocBook: document the new v4l2 matrix ioctls.
Date: Wed, 21 Aug 2013 23:58:13 +0200	[thread overview]
Message-ID: <1527473.WFxGOHRo9q@avalon> (raw)
In-Reply-To: <1376305113-17128-10-git-send-email-hverkuil@xs4all.nl>

Hi Hans,

Thank you for the patch.

On Monday 12 August 2013 12:58:32 Hans Verkuil wrote:
> From: Hans Verkuil <hans.verkuil@cisco.com>
> 
> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
> ---
>  Documentation/DocBook/media/v4l/v4l2.xml           |   2 +
>  .../DocBook/media/v4l/vidioc-g-matrix.xml          | 115 +++++++++++++
>  .../DocBook/media/v4l/vidioc-query-matrix.xml      | 178 ++++++++++++++++++
>  3 files changed, 295 insertions(+)
>  create mode 100644 Documentation/DocBook/media/v4l/vidioc-g-matrix.xml
>  create mode 100644 Documentation/DocBook/media/v4l/vidioc-query-matrix.xml

[snip]

> diff --git a/Documentation/DocBook/media/v4l/vidioc-query-matrix.xml
> b/Documentation/DocBook/media/v4l/vidioc-query-matrix.xml new file mode
> 100644
> index 0000000..c2845c7
> --- /dev/null
> +++ b/Documentation/DocBook/media/v4l/vidioc-query-matrix.xml
> @@ -0,0 +1,178 @@
> +<refentry id="vidioc-query-matrix">
> +  <refmeta>
> +    <refentrytitle>ioctl VIDIOC_QUERY_MATRIX</refentrytitle>
> +    &manvol;
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>VIDIOC_QUERY_MATRIX</refname>
> +    <refpurpose>Query the attributes of a matrix</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <funcsynopsis>
> +      <funcprototype>
> +	<funcdef>int <function>ioctl</function></funcdef>
> +	<paramdef>int <parameter>fd</parameter></paramdef>
> +	<paramdef>int <parameter>request</parameter></paramdef>
> +	<paramdef>struct v4l2_query_matrix
> +*<parameter>argp</parameter></paramdef>
> +      </funcprototype>
> +    </funcsynopsis>
> +  </refsynopsisdiv>
> +
> +  <refsect1>
> +    <title>Arguments</title>
> +
> +    <variablelist>
> +      <varlistentry>
> +	<term><parameter>fd</parameter></term>
> +	<listitem>
> +	  <para>&fd;</para>
> +	</listitem>
> +      </varlistentry>
> +      <varlistentry>
> +	<term><parameter>request</parameter></term>
> +	<listitem>
> +	  <para>VIDIOC_QUERY_MATRIX</para>
> +	</listitem>
> +      </varlistentry>
> +      <varlistentry>
> +	<term><parameter>argp</parameter></term>
> +	<listitem>
> +	  <para></para>
> +	</listitem>
> +      </varlistentry>
> +    </variablelist>
> +  </refsect1>
> +
> +  <refsect1>
> +    <title>Description</title>
> +
> +    <para>Query the attributes of a matrix. The application fills in the
> +    <structfield>type</structfield> and optionally the
> <structfield>ref</structfield>
> +    fields of &v4l2-query-matrix;. All other fields will be returned by the
> driver.
> +    </para>
> +
> +    <table frame="none" pgwide="1" id="v4l2-query-matrix">
> +      <title>struct <structname>v4l2_query_matrix</structname></title>
> +      <tgroup cols="4">
> +	&cs-str;
> +	<tbody valign="top">
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>type</structfield></entry>
> +            <entry></entry>
> +	    <entry>Type of the matrix, see <xref linkend="v4l2-matrix-type"
> />.</entry> +	  </row>
> +	  <row>
> +	    <entry>union</entry>
> +	    <entry><structfield>ref</structfield></entry>
> +            <entry></entry>
> +	    <entry>This union makes it possible to identify the object owning the
> +	    matrix. Currently the only defined matrix types are identified
> through
> +	    the filehandle used to call the ioctl, so this union isn't used
> (yet).</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>columns</structfield></entry>
> +            <entry></entry>
> +	    <entry>Number of columns in the matrix.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>rows</structfield></entry>
> +            <entry></entry>
> +	    <entry>Number of rows in the matrix.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>union</entry>
> +	    <entry><structfield>elem_min</structfield></entry>
> +            <entry></entry>
> +            <entry></entry>
> +	  </row>
> +	  <row>
> +	    <entry></entry>
> +            <entry>__s64</entry>
> +	    <entry><structfield>val</structfield></entry>
> +            <entry>The minimal signed value of each matrix element.</entry>
> +	  </row>
> +	  <row>
> +	    <entry></entry>
> +            <entry>__u64</entry>
> +	    <entry><structfield>uval</structfield></entry>
> +            <entry>The minimal unsigned value of each matrix
> element.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>union</entry>
> +	    <entry><structfield>elem_max</structfield></entry>
> +            <entry></entry>
> +            <entry></entry>
> +	  </row>
> +	  <row>
> +	    <entry></entry>
> +            <entry>__s64</entry>
> +	    <entry><structfield>val</structfield></entry>
> +            <entry>The maximal signed value of each matrix element.</entry>
> +	  </row>
> +	  <row>
> +	    <entry></entry>
> +            <entry>__u64</entry>
> +	    <entry><structfield>uval</structfield></entry>
> +            <entry>The maximal unsigned value of each matrix
> element.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>elem_size</structfield></entry>
> +            <entry></entry>
> +	    <entry>The size in bytes of a single matrix element.
> +	    The full matrix size will be <structfield>columns</structfield> *
> +	    <structfield>rows</structfield> *
> <structfield>elem_size</structfield>.</entry>
> +	  </row>
> +	  <row>
> +	    <entry>__u32</entry>
> +	    <entry><structfield>reserved</structfield>[12]</entry>
> +            <entry></entry>
> +	    <entry>Reserved for future extensions. Drivers must set
> +	    the array to zero.</entry>
> +	  </row>
> +	</tbody>
> +      </tgroup>
> +    </table>
> +
> +    <table pgwide="1" frame="none" id="v4l2-matrix-type">
> +      <title>Matrix Types</title>
> +      <tgroup cols="2" align="left">
> +	<colspec colwidth="30*" />
> +	<colspec colwidth="55*" />
> +	<thead>
> +	  <row>
> +	    <entry>Type</entry>
> +	    <entry>Description</entry>
> +	  </row>
> +	</thead>
> +	<tbody valign="top">
> +	  <row>
> +	    <entry><constant>V4L2_MATRIX_T_MD_REGION</constant></entry>
> +	    <entry>Hardware motion detection often divides the image into several
> +	    regions, and each region can have its own motion detection
> thresholds.
> +	    This matrix assigns a region number to each element. Each element is
> a __u8.
> +	    Generally each element refers to a block of pixels in the image.

>From the description I have trouble understanding what the matrix type is for. 
Do you think we could make the explanation more detailed ?

> +	    </entry>
> +	  </row>
> +	  <row>
> +	    <entry><constant>V4L2_MATRIX_T_MD_THRESHOLD</constant></entry>
> +	    <entry>Hardware motion detection can assign motion detection 
threshold
> +	    values to each element of an image. Each element is a __u16. +       
>     Generally each element refers to a block of pixels in the image. +	   
> </entry>
> +	  </row>
> +	</tbody>
> +      </tgroup>
> +    </table>
> +
> +  </refsect1>
> +  <refsect1>
> +    &return-value;
> +  </refsect1>
> +</refentry>

-- 
Regards,

Laurent Pinchart


  reply	other threads:[~2013-08-21 21:57 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-08-12 10:58 [RFCv2 PATCH 00/10] Matrix and Motion Detection support Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 01/10] v4l2-controls: add motion detection controls Hans Verkuil
2013-08-21 21:36   ` Laurent Pinchart
2013-08-22  6:32     ` Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 02/10] v4l2: add matrix support Hans Verkuil
2013-08-14 14:33   ` Sakari Ailus
2013-08-15  6:35     ` Hans Verkuil
2013-08-15  8:23       ` Sakari Ailus
2013-08-12 10:58 ` [RFCv2 PATCH 03/10] v4l2-compat-ioctl32: add g/s_matrix support Hans Verkuil
2013-08-21 22:02   ` Laurent Pinchart
2013-08-22  6:41     ` Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 04/10] solo: implement the new matrix ioctls instead of the custom ones Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 05/10] v4l2: add a motion detection event Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 06/10] solo6x10: implement motion detection events and controls Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 07/10] DocBook: add the new v4l detection class controls Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 08/10] DocBook: document new v4l motion detection event Hans Verkuil
2013-08-21 21:41   ` Laurent Pinchart
2013-08-22  6:38     ` Hans Verkuil
2013-08-22 10:35       ` Laurent Pinchart
2013-08-12 10:58 ` [RFCv2 PATCH 09/10] DocBook: document the new v4l2 matrix ioctls Hans Verkuil
2013-08-21 21:58   ` Laurent Pinchart [this message]
2013-08-22  6:56     ` Hans Verkuil
2013-08-22 10:34       ` Laurent Pinchart
2013-08-22 10:42         ` Hans Verkuil
2013-08-12 10:58 ` [RFCv2 PATCH 10/10] go7007: add motion detection support Hans Verkuil

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1527473.WFxGOHRo9q@avalon \
    --to=laurent.pinchart@ideasonboard.com \
    --cc=hans.verkuil@cisco.com \
    --cc=hverkuil@xs4all.nl \
    --cc=ismael.luceno@corp.bluecherry.net \
    --cc=linux-media@vger.kernel.org \
    --cc=pete@sensoray.com \
    --cc=sakari.ailus@iki.fi \
    --cc=sylvester.nawrocki@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox