aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/v4l/io.xml
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/DocBook/v4l/io.xml')
-rw-r--r--Documentation/DocBook/v4l/io.xml21
1 files changed, 16 insertions, 5 deletions
diff --git a/Documentation/DocBook/v4l/io.xml b/Documentation/DocBook/v4l/io.xml
index f92f24323b2a..d424886beda0 100644
--- a/Documentation/DocBook/v4l/io.xml
+++ b/Documentation/DocBook/v4l/io.xml
@@ -589,7 +589,8 @@ number of a video input as in &v4l2-input; field
589 <entry></entry> 589 <entry></entry>
590 <entry>A place holder for future extensions and custom 590 <entry>A place holder for future extensions and custom
591(driver defined) buffer types 591(driver defined) buffer types
592<constant>V4L2_BUF_TYPE_PRIVATE</constant> and higher.</entry> 592<constant>V4L2_BUF_TYPE_PRIVATE</constant> and higher. Applications
593should set this to 0.</entry>
593 </row> 594 </row>
594 </tbody> 595 </tbody>
595 </tgroup> 596 </tgroup>
@@ -701,6 +702,16 @@ They can be both cleared however, then the buffer is in "dequeued"
701state, in the application domain to say so.</entry> 702state, in the application domain to say so.</entry>
702 </row> 703 </row>
703 <row> 704 <row>
705 <entry><constant>V4L2_BUF_FLAG_ERROR</constant></entry>
706 <entry>0x0040</entry>
707 <entry>When this flag is set, the buffer has been dequeued
708 successfully, although the data might have been corrupted.
709 This is recoverable, streaming may continue as normal and
710 the buffer may be reused normally.
711 Drivers set this flag when the <constant>VIDIOC_DQBUF</constant>
712 ioctl is called.</entry>
713 </row>
714 <row>
704 <entry><constant>V4L2_BUF_FLAG_KEYFRAME</constant></entry> 715 <entry><constant>V4L2_BUF_FLAG_KEYFRAME</constant></entry>
705 <entry>0x0008</entry> 716 <entry>0x0008</entry>
706 <entry>Drivers set or clear this flag when calling the 717 <entry>Drivers set or clear this flag when calling the
@@ -917,8 +928,8 @@ order</emphasis>.</para>
917 928
918 <para>When the driver provides or accepts images field by field 929 <para>When the driver provides or accepts images field by field
919rather than interleaved, it is also important applications understand 930rather than interleaved, it is also important applications understand
920how the fields combine to frames. We distinguish between top and 931how the fields combine to frames. We distinguish between top (aka odd) and
921bottom fields, the <emphasis>spatial order</emphasis>: The first line 932bottom (aka even) fields, the <emphasis>spatial order</emphasis>: The first line
922of the top field is the first line of an interlaced frame, the first 933of the top field is the first line of an interlaced frame, the first
923line of the bottom field is the second line of that frame.</para> 934line of the bottom field is the second line of that frame.</para>
924 935
@@ -971,12 +982,12 @@ between <constant>V4L2_FIELD_TOP</constant> and
971 <row> 982 <row>
972 <entry><constant>V4L2_FIELD_TOP</constant></entry> 983 <entry><constant>V4L2_FIELD_TOP</constant></entry>
973 <entry>2</entry> 984 <entry>2</entry>
974 <entry>Images consist of the top field only.</entry> 985 <entry>Images consist of the top (aka odd) field only.</entry>
975 </row> 986 </row>
976 <row> 987 <row>
977 <entry><constant>V4L2_FIELD_BOTTOM</constant></entry> 988 <entry><constant>V4L2_FIELD_BOTTOM</constant></entry>
978 <entry>3</entry> 989 <entry>3</entry>
979 <entry>Images consist of the bottom field only. 990 <entry>Images consist of the bottom (aka even) field only.
980Applications may wish to prevent a device from capturing interlaced 991Applications may wish to prevent a device from capturing interlaced
981images because they will have "comb" or "feathering" artefacts around 992images because they will have "comb" or "feathering" artefacts around
982moving objects.</entry> 993moving objects.</entry>