X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=Documentation%2FDocBook%2Fmedia%2Fv4l%2Fio.xml;h=5a2e97bbc6bf38da54fc31724ab883f55838e845;hb=939f1377fbdb5d0d6d6ee1e234b8ab9328ca77ef;hp=89544e4495a9eaa0a2ed2c36cb8f735515b19b4b;hpb=c6c092135d4f61b038a41685147c79e966c2399c;p=firefly-linux-kernel-4.4.55.git
diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml
index 89544e4495a9..5a2e97bbc6bf 100644
--- a/Documentation/DocBook/media/v4l/io.xml
+++ b/Documentation/DocBook/media/v4l/io.xml
@@ -990,7 +990,7 @@ should set this to 0.
V4L2_BUF_FLAG_MAPPED
- 0x0001
+ 0x00000001The buffer resides in device memory and has been mapped
into the application's address space, see for details.
Drivers set or clear this flag when the
@@ -1000,7 +1000,7 @@ Drivers set or clear this flag when the
V4L2_BUF_FLAG_QUEUED
- 0x0002
+ 0x00000002Internally drivers maintain two buffer queues, an
incoming and outgoing queue. When this flag is set, the buffer is
currently on the incoming queue. It automatically moves to the
@@ -1013,7 +1013,7 @@ cleared.V4L2_BUF_FLAG_DONE
- 0x0004
+ 0x00000004When this flag is set, the buffer is currently on
the outgoing queue, ready to be dequeued from the driver. Drivers set
or clear this flag when the VIDIOC_QUERYBUF ioctl
@@ -1027,7 +1027,7 @@ state, in the application domain to say so.V4L2_BUF_FLAG_ERROR
- 0x0040
+ 0x00000040When this flag is set, the buffer has been dequeued
successfully, although the data might have been corrupted.
This is recoverable, streaming may continue as normal and
@@ -1037,7 +1037,7 @@ state, in the application domain to say so.V4L2_BUF_FLAG_KEYFRAME
- 0x0008
+ 0x00000008Drivers set or clear this flag when calling the
VIDIOC_DQBUF ioctl. It may be set by video
capture devices when the buffer contains a compressed image which is a
@@ -1045,27 +1045,27 @@ key frame (or field), &ie; can be decompressed on its own.V4L2_BUF_FLAG_PFRAME
- 0x0010
+ 0x00000010Similar to V4L2_BUF_FLAG_KEYFRAME
this flags predicted frames or fields which contain only differences to a
previous key frame.V4L2_BUF_FLAG_BFRAME
- 0x0020
+ 0x00000020Similar to V4L2_BUF_FLAG_PFRAME
this is a bidirectional predicted frame or field. [ooc tbd]V4L2_BUF_FLAG_TIMECODE
- 0x0100
+ 0x00000100The timecode field is valid.
Drivers set or clear this flag when the VIDIOC_DQBUF
ioctl is called.V4L2_BUF_FLAG_PREPARED
- 0x0400
+ 0x00000400The buffer has been prepared for I/O and can be queued by the
application. Drivers set or clear this flag when the
VIDIOC_QUERYBUF,
V4L2_BUF_FLAG_NO_CACHE_INVALIDATE
- 0x0800
+ 0x00000800Caches do not have to be invalidated for this buffer.
Typically applications shall use this flag if the data captured in the buffer
is not going to be touched by the CPU, instead the buffer will, probably, be
@@ -1084,7 +1084,7 @@ passed on to a DMA-capable hardware unit for further processing or output.
V4L2_BUF_FLAG_NO_CACHE_CLEAN
- 0x1000
+ 0x00001000Caches do not have to be cleaned for this buffer.
Typically applications shall use this flag for output buffers if the data
in this buffer has not been created by the CPU but by some DMA-capable unit,
@@ -1092,7 +1092,7 @@ in which case caches have not been used.V4L2_BUF_FLAG_TIMESTAMP_MASK
- 0xe000
+ 0x0000e000Mask for timestamp types below. To test the
timestamp type, mask out bits not belonging to timestamp
type by performing a logical and operation with buffer
@@ -1100,7 +1100,7 @@ in which case caches have not been used.V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN
- 0x0000
+ 0x00000000Unknown timestamp type. This type is used by
drivers before Linux 3.9 and may be either monotonic (see
below) or realtime (wall clock). Monotonic clock has been
@@ -1113,7 +1113,7 @@ in which case caches have not been used.V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC
- 0x2000
+ 0x00002000The buffer timestamp has been taken from the
CLOCK_MONOTONIC clock. To access the
same clock outside V4L2, use
@@ -1121,7 +1121,7 @@ in which case caches have not been used.V4L2_BUF_FLAG_TIMESTAMP_COPY
- 0x4000
+ 0x00004000The CAPTURE buffer timestamp has been taken from the
corresponding OUTPUT buffer. This flag applies only to mem2mem devices.