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

Commit 6d823a2e authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

[media] DocBook: document new v4l motion detection event 



Document the new motion detection event.

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <m.chehab@samsung.com>
parent 78ea6113

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

+44 −0
Original line number Diff line number Diff line
@@ -92,6 +92,12 @@ 
            <entry><structfield>frame_sync</structfield></entry>

	    <entry>Event data for event V4L2_EVENT_FRAME_SYNC.</entry>

	  </row>

	  <row>

	    <entry></entry>

	    <entry>&v4l2-event-motion-det;</entry>

            <entry><structfield>motion_det</structfield></entry>

	    <entry>Event data for event V4L2_EVENT_MOTION_DET.</entry>

	  </row>

	  <row>

	    <entry></entry>

	    <entry>__u8</entry>
@@ -258,6 +264,44 @@ 
      </tgroup>

    </table>



    <table frame="none" pgwide="1" id="v4l2-event-motion-det">

      <title>struct <structname>v4l2_event_motion_det</structname></title>

      <tgroup cols="3">

	&cs-str;

	<tbody valign="top">

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>flags</structfield></entry>

	    <entry>

	      Currently only one flag is available: if <constant>V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ</constant>

	      is set, then the <structfield>frame_sequence</structfield> field is valid,

	      otherwise that field should be ignored.

	    </entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>frame_sequence</structfield></entry>

	    <entry>

	      The sequence number of the frame being received. Only valid if the

	      <constant>V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ</constant> flag was set.

	    </entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry><structfield>region_mask</structfield></entry>

	    <entry>

	      The bitmask of the regions that reported motion. There is at least one

	      region. If this field is 0, then no motion was detected at all.

	      If there is no <constant>V4L2_CID_DETECT_MD_REGION_GRID</constant> control

	      (see <xref linkend="detect-controls" />) to assign a different region

	      to each cell in the motion detection grid, then that all cells

	      are automatically assigned to the default region 0.

	    </entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



    <table pgwide="1" frame="none" id="changes-flags">

      <title>Changes</title>

      <tgroup cols="3">

Documentation/DocBook/media/v4l/vidioc-subscribe-event.xml

+8 −0
Original line number Diff line number Diff line
@@ -174,6 +174,14 @@ 
	      will have the ORed value of all the events generated.</para>

	    </entry>

	  </row>

	  <row>

	    <entry><constant>V4L2_EVENT_MOTION_DET</constant></entry>

	    <entry>5</entry>

	    <entry>

	      <para>Triggered whenever the motion detection state for one or more of the regions

	      changes. This event has a &v4l2-event-motion-det; associated with it.</para>

	    </entry>

	  </row>

	  <row>

	    <entry><constant>V4L2_EVENT_PRIVATE_START</constant></entry>

	    <entry>0x08000000</entry>