Commit 0e1de38d authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

V4L/DVB: v4l spec: document new events 



Signed-off-by: default avatarHans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 37089368

Documentation/DocBook/media-entities.tmpl

+2 −0
Original line number Original line Diff line number Diff line
@@ -85,6 +85,7 @@ 
<!ENTITY VIDIOC-TRY-ENCODER-CMD "<link linkend='vidioc-encoder-cmd'><constant>VIDIOC_TRY_ENCODER_CMD</constant></link>">

<!ENTITY VIDIOC-TRY-ENCODER-CMD "<link linkend='vidioc-encoder-cmd'><constant>VIDIOC_TRY_ENCODER_CMD</constant></link>">

<!ENTITY VIDIOC-TRY-EXT-CTRLS "<link linkend='vidioc-g-ext-ctrls'><constant>VIDIOC_TRY_EXT_CTRLS</constant></link>">

<!ENTITY VIDIOC-TRY-EXT-CTRLS "<link linkend='vidioc-g-ext-ctrls'><constant>VIDIOC_TRY_EXT_CTRLS</constant></link>">

<!ENTITY VIDIOC-TRY-FMT "<link linkend='vidioc-g-fmt'><constant>VIDIOC_TRY_FMT</constant></link>">

<!ENTITY VIDIOC-TRY-FMT "<link linkend='vidioc-g-fmt'><constant>VIDIOC_TRY_FMT</constant></link>">

<!ENTITY VIDIOC-UNSUBSCRIBE-EVENT "<link linkend='vidioc-subscribe-event'><constant>VIDIOC_UNSUBSCRIBE_EVENT</constant></link>">





<!-- Types -->

<!-- Types -->

<!ENTITY v4l2-std-id "<link linkend='v4l2-std-id'>v4l2_std_id</link>">

<!ENTITY v4l2-std-id "<link linkend='v4l2-std-id'>v4l2_std_id</link>">
@@ -145,6 +146,7 @@ 
<!ENTITY v4l2-encoder-cmd "struct&nbsp;<link linkend='v4l2-encoder-cmd'>v4l2_encoder_cmd</link>">

<!ENTITY v4l2-encoder-cmd "struct&nbsp;<link linkend='v4l2-encoder-cmd'>v4l2_encoder_cmd</link>">

<!ENTITY v4l2-event "struct&nbsp;<link linkend='v4l2-event'>v4l2_event</link>">

<!ENTITY v4l2-event "struct&nbsp;<link linkend='v4l2-event'>v4l2_event</link>">

<!ENTITY v4l2-event-subscription "struct&nbsp;<link linkend='v4l2-event-subscription'>v4l2_event_subscription</link>">

<!ENTITY v4l2-event-subscription "struct&nbsp;<link linkend='v4l2-event-subscription'>v4l2_event_subscription</link>">

<!ENTITY v4l2-event-vsync "struct&nbsp;<link linkend='v4l2-event-vsync'>v4l2_event_vsync</link>">

<!ENTITY v4l2-ext-control "struct&nbsp;<link linkend='v4l2-ext-control'>v4l2_ext_control</link>">

<!ENTITY v4l2-ext-control "struct&nbsp;<link linkend='v4l2-ext-control'>v4l2_ext_control</link>">

<!ENTITY v4l2-ext-controls "struct&nbsp;<link linkend='v4l2-ext-controls'>v4l2_ext_controls</link>">

<!ENTITY v4l2-ext-controls "struct&nbsp;<link linkend='v4l2-ext-controls'>v4l2_ext_controls</link>">

<!ENTITY v4l2-fmtdesc "struct&nbsp;<link linkend='v4l2-fmtdesc'>v4l2_fmtdesc</link>">

<!ENTITY v4l2-fmtdesc "struct&nbsp;<link linkend='v4l2-fmtdesc'>v4l2_fmtdesc</link>">

Documentation/DocBook/v4l/vidioc-dqevent.xml

+8 −1
Original line number Original line Diff line number Diff line
@@ -72,6 +72,13 @@ 
            <entry></entry>

            <entry></entry>

	    <entry></entry>

	    <entry></entry>

	  </row>

	  </row>

	  <row>

	    <entry></entry>

	    <entry>&v4l2-event-vsync;</entry>

            <entry><structfield>vsync</structfield></entry>

	    <entry>Event data for event V4L2_EVENT_VSYNC.

            </entry>

	  </row>

	  <row>

	  <row>

	    <entry></entry>

	    <entry></entry>

	    <entry>__u8</entry>

	    <entry>__u8</entry>
@@ -97,7 +104,7 @@ 
	    </entry>

	    </entry>

	  </row>

	  </row>

	  <row>

	  <row>

	    <entry>struct timeval</entry>

	    <entry>struct timespec</entry>

	    <entry><structfield>timestamp</structfield></entry>

	    <entry><structfield>timestamp</structfield></entry>

            <entry></entry>

            <entry></entry>

	    <entry>Event timestamp.</entry>

	    <entry>Event timestamp.</entry>

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

+29 −0
Original line number Original line Diff line number Diff line
@@ -84,6 +84,21 @@ 
	    VIDIOC_UNSUBSCRIBE_EVENT for unsubscribing all events at once.

	    VIDIOC_UNSUBSCRIBE_EVENT for unsubscribing all events at once.

	    </entry>

	    </entry>

	  </row>

	  </row>

	  <row>

	    <entry><constant>V4L2_EVENT_VSYNC</constant></entry>

	    <entry>1</entry>

	    <entry>This event is triggered on the vertical sync.

	    This event has &v4l2-event-vsync; associated with it.

	    </entry>

	  </row>

	  <row>

	    <entry><constant>V4L2_EVENT_EOS</constant></entry>

	    <entry>2</entry>

	    <entry>This event is triggered when the end of a stream is reached.

	    This is typically used with MPEG decoders to report to the application

	    when the last of the MPEG stream has been decoded.

	    </entry>

	  </row>

	  <row>

	  <row>

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

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

	    <entry>0x08000000</entry>

	    <entry>0x08000000</entry>
@@ -93,6 +108,20 @@ 
      </tgroup>

      </tgroup>

    </table>

    </table>





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

      <title>struct <structname>v4l2_event_vsync</structname></title>

      <tgroup cols="3">

	&cs-str;

	<tbody valign="top">

	  <row>

	    <entry>__u8</entry>

	    <entry><structfield>field</structfield></entry>

	    <entry>The upcoming field. See &v4l2-field;.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>



  </refsect1>

  </refsect1>

</refentry>

</refentry>

<!--

<!--