diff options
author | Hans Verkuil <hverkuil@xs4all.nl> | 2010-03-27 13:10:57 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2010-05-19 11:58:10 -0400 |
commit | 0e1de38db83606d802cf2b3e00cf95fc693b8ca2 (patch) | |
tree | 02ec06545f3c2cb101816f631612aaf230c5af97 /Documentation/DocBook | |
parent | 37089368c1b1bea3c71217163e6d5d3b01ef1f19 (diff) |
V4L/DVB: v4l spec: document new events
Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/media-entities.tmpl | 2 | ||||
-rw-r--r-- | Documentation/DocBook/v4l/vidioc-dqevent.xml | 9 | ||||
-rw-r--r-- | Documentation/DocBook/v4l/vidioc-subscribe-event.xml | 29 |
3 files changed, 39 insertions, 1 deletions
diff --git a/Documentation/DocBook/media-entities.tmpl b/Documentation/DocBook/media-entities.tmpl index 770be3c3ba75..5d4d40f429a5 100644 --- a/Documentation/DocBook/media-entities.tmpl +++ b/Documentation/DocBook/media-entities.tmpl | |||
@@ -85,6 +85,7 @@ | |||
85 | <!ENTITY VIDIOC-TRY-ENCODER-CMD "<link linkend='vidioc-encoder-cmd'><constant>VIDIOC_TRY_ENCODER_CMD</constant></link>"> | 85 | <!ENTITY VIDIOC-TRY-ENCODER-CMD "<link linkend='vidioc-encoder-cmd'><constant>VIDIOC_TRY_ENCODER_CMD</constant></link>"> |
86 | <!ENTITY VIDIOC-TRY-EXT-CTRLS "<link linkend='vidioc-g-ext-ctrls'><constant>VIDIOC_TRY_EXT_CTRLS</constant></link>"> | 86 | <!ENTITY VIDIOC-TRY-EXT-CTRLS "<link linkend='vidioc-g-ext-ctrls'><constant>VIDIOC_TRY_EXT_CTRLS</constant></link>"> |
87 | <!ENTITY VIDIOC-TRY-FMT "<link linkend='vidioc-g-fmt'><constant>VIDIOC_TRY_FMT</constant></link>"> | 87 | <!ENTITY VIDIOC-TRY-FMT "<link linkend='vidioc-g-fmt'><constant>VIDIOC_TRY_FMT</constant></link>"> |
88 | <!ENTITY VIDIOC-UNSUBSCRIBE-EVENT "<link linkend='vidioc-subscribe-event'><constant>VIDIOC_UNSUBSCRIBE_EVENT</constant></link>"> | ||
88 | 89 | ||
89 | <!-- Types --> | 90 | <!-- Types --> |
90 | <!ENTITY v4l2-std-id "<link linkend='v4l2-std-id'>v4l2_std_id</link>"> | 91 | <!ENTITY v4l2-std-id "<link linkend='v4l2-std-id'>v4l2_std_id</link>"> |
@@ -145,6 +146,7 @@ | |||
145 | <!ENTITY v4l2-encoder-cmd "struct <link linkend='v4l2-encoder-cmd'>v4l2_encoder_cmd</link>"> | 146 | <!ENTITY v4l2-encoder-cmd "struct <link linkend='v4l2-encoder-cmd'>v4l2_encoder_cmd</link>"> |
146 | <!ENTITY v4l2-event "struct <link linkend='v4l2-event'>v4l2_event</link>"> | 147 | <!ENTITY v4l2-event "struct <link linkend='v4l2-event'>v4l2_event</link>"> |
147 | <!ENTITY v4l2-event-subscription "struct <link linkend='v4l2-event-subscription'>v4l2_event_subscription</link>"> | 148 | <!ENTITY v4l2-event-subscription "struct <link linkend='v4l2-event-subscription'>v4l2_event_subscription</link>"> |
149 | <!ENTITY v4l2-event-vsync "struct <link linkend='v4l2-event-vsync'>v4l2_event_vsync</link>"> | ||
148 | <!ENTITY v4l2-ext-control "struct <link linkend='v4l2-ext-control'>v4l2_ext_control</link>"> | 150 | <!ENTITY v4l2-ext-control "struct <link linkend='v4l2-ext-control'>v4l2_ext_control</link>"> |
149 | <!ENTITY v4l2-ext-controls "struct <link linkend='v4l2-ext-controls'>v4l2_ext_controls</link>"> | 151 | <!ENTITY v4l2-ext-controls "struct <link linkend='v4l2-ext-controls'>v4l2_ext_controls</link>"> |
150 | <!ENTITY v4l2-fmtdesc "struct <link linkend='v4l2-fmtdesc'>v4l2_fmtdesc</link>"> | 152 | <!ENTITY v4l2-fmtdesc "struct <link linkend='v4l2-fmtdesc'>v4l2_fmtdesc</link>"> |
diff --git a/Documentation/DocBook/v4l/vidioc-dqevent.xml b/Documentation/DocBook/v4l/vidioc-dqevent.xml index eb45c1695d8c..4e0a7cc30812 100644 --- a/Documentation/DocBook/v4l/vidioc-dqevent.xml +++ b/Documentation/DocBook/v4l/vidioc-dqevent.xml | |||
@@ -74,6 +74,13 @@ | |||
74 | </row> | 74 | </row> |
75 | <row> | 75 | <row> |
76 | <entry></entry> | 76 | <entry></entry> |
77 | <entry>&v4l2-event-vsync;</entry> | ||
78 | <entry><structfield>vsync</structfield></entry> | ||
79 | <entry>Event data for event V4L2_EVENT_VSYNC. | ||
80 | </entry> | ||
81 | </row> | ||
82 | <row> | ||
83 | <entry></entry> | ||
77 | <entry>__u8</entry> | 84 | <entry>__u8</entry> |
78 | <entry><structfield>data</structfield>[64]</entry> | 85 | <entry><structfield>data</structfield>[64]</entry> |
79 | <entry>Event data. Defined by the event type. The union | 86 | <entry>Event data. Defined by the event type. The union |
@@ -97,7 +104,7 @@ | |||
97 | </entry> | 104 | </entry> |
98 | </row> | 105 | </row> |
99 | <row> | 106 | <row> |
100 | <entry>struct timeval</entry> | 107 | <entry>struct timespec</entry> |
101 | <entry><structfield>timestamp</structfield></entry> | 108 | <entry><structfield>timestamp</structfield></entry> |
102 | <entry></entry> | 109 | <entry></entry> |
103 | <entry>Event timestamp.</entry> | 110 | <entry>Event timestamp.</entry> |
diff --git a/Documentation/DocBook/v4l/vidioc-subscribe-event.xml b/Documentation/DocBook/v4l/vidioc-subscribe-event.xml index 71ab88cb76b3..8b501791aa68 100644 --- a/Documentation/DocBook/v4l/vidioc-subscribe-event.xml +++ b/Documentation/DocBook/v4l/vidioc-subscribe-event.xml | |||
@@ -85,6 +85,21 @@ | |||
85 | </entry> | 85 | </entry> |
86 | </row> | 86 | </row> |
87 | <row> | 87 | <row> |
88 | <entry><constant>V4L2_EVENT_VSYNC</constant></entry> | ||
89 | <entry>1</entry> | ||
90 | <entry>This event is triggered on the vertical sync. | ||
91 | This event has &v4l2-event-vsync; associated with it. | ||
92 | </entry> | ||
93 | </row> | ||
94 | <row> | ||
95 | <entry><constant>V4L2_EVENT_EOS</constant></entry> | ||
96 | <entry>2</entry> | ||
97 | <entry>This event is triggered when the end of a stream is reached. | ||
98 | This is typically used with MPEG decoders to report to the application | ||
99 | when the last of the MPEG stream has been decoded. | ||
100 | </entry> | ||
101 | </row> | ||
102 | <row> | ||
88 | <entry><constant>V4L2_EVENT_PRIVATE_START</constant></entry> | 103 | <entry><constant>V4L2_EVENT_PRIVATE_START</constant></entry> |
89 | <entry>0x08000000</entry> | 104 | <entry>0x08000000</entry> |
90 | <entry>Base event number for driver-private events.</entry> | 105 | <entry>Base event number for driver-private events.</entry> |
@@ -93,6 +108,20 @@ | |||
93 | </tgroup> | 108 | </tgroup> |
94 | </table> | 109 | </table> |
95 | 110 | ||
111 | <table frame="none" pgwide="1" id="v4l2-event-vsync"> | ||
112 | <title>struct <structname>v4l2_event_vsync</structname></title> | ||
113 | <tgroup cols="3"> | ||
114 | &cs-str; | ||
115 | <tbody valign="top"> | ||
116 | <row> | ||
117 | <entry>__u8</entry> | ||
118 | <entry><structfield>field</structfield></entry> | ||
119 | <entry>The upcoming field. See &v4l2-field;.</entry> | ||
120 | </row> | ||
121 | </tbody> | ||
122 | </tgroup> | ||
123 | </table> | ||
124 | |||
96 | </refsect1> | 125 | </refsect1> |
97 | </refentry> | 126 | </refentry> |
98 | <!-- | 127 | <!-- |