diff options
author | Hans Verkuil <hans.verkuil@cisco.com> | 2012-09-03 09:09:23 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2012-09-26 08:44:12 -0400 |
commit | 9495356f7ba958fa6b4fd7109caa292e4c233bd7 (patch) | |
tree | 422afc376c5b3bca41465215aa4a906d83913531 | |
parent | ff82b2118ede450e18f96226d96a1757dc0b52af (diff) |
[media] DocBook: deprecate V4L2_BUF_TYPE_PRIVATE
As per decision taken during the 2012 Media Workshop.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Acked-by: Sakari Ailus <sakari.ailus@iki.fi>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r-- | Documentation/DocBook/media/v4l/compat.xml | 2 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/io.xml | 14 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-cropcap.xml | 6 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-enum-fmt.xml | 6 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-g-crop.xml | 6 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-g-fmt.xml | 4 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-g-parm.xml | 4 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-reqbufs.xml | 5 |
8 files changed, 13 insertions, 34 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index 578135ec6b1f..c6ae4c9d0e0c 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml | |||
@@ -1476,7 +1476,7 @@ follows.<informaltable> | |||
1476 | </row> | 1476 | </row> |
1477 | <row> | 1477 | <row> |
1478 | <entry><constant>V4L2_BUF_TYPE_PRIVATE_BASE</constant></entry> | 1478 | <entry><constant>V4L2_BUF_TYPE_PRIVATE_BASE</constant></entry> |
1479 | <entry><constant>V4L2_BUF_TYPE_PRIVATE</constant></entry> | 1479 | <entry><constant>V4L2_BUF_TYPE_PRIVATE</constant> (but this is deprecated)</entry> |
1480 | </row> | 1480 | </row> |
1481 | </tbody> | 1481 | </tbody> |
1482 | </tgroup> | 1482 | </tgroup> |
diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml index 2512649b8e50..2dc39d81182f 100644 --- a/Documentation/DocBook/media/v4l/io.xml +++ b/Documentation/DocBook/media/v4l/io.xml | |||
@@ -685,18 +685,14 @@ memory, set by the application. See <xref linkend="userp" /> for details. | |||
685 | <entry>__u32</entry> | 685 | <entry>__u32</entry> |
686 | <entry><structfield>reserved2</structfield></entry> | 686 | <entry><structfield>reserved2</structfield></entry> |
687 | <entry></entry> | 687 | <entry></entry> |
688 | <entry>A place holder for future extensions and custom | 688 | <entry>A place holder for future extensions. Applications |
689 | (driver defined) buffer types | ||
690 | <constant>V4L2_BUF_TYPE_PRIVATE</constant> and higher. Applications | ||
691 | should set this to 0.</entry> | 689 | should set this to 0.</entry> |
692 | </row> | 690 | </row> |
693 | <row> | 691 | <row> |
694 | <entry>__u32</entry> | 692 | <entry>__u32</entry> |
695 | <entry><structfield>reserved</structfield></entry> | 693 | <entry><structfield>reserved</structfield></entry> |
696 | <entry></entry> | 694 | <entry></entry> |
697 | <entry>A place holder for future extensions and custom | 695 | <entry>A place holder for future extensions. Applications |
698 | (driver defined) buffer types | ||
699 | <constant>V4L2_BUF_TYPE_PRIVATE</constant> and higher. Applications | ||
700 | should set this to 0.</entry> | 696 | should set this to 0.</entry> |
701 | </row> | 697 | </row> |
702 | </tbody> | 698 | </tbody> |
@@ -829,12 +825,6 @@ should set this to 0.</entry> | |||
829 | <entry>Buffer for video output overlay (OSD), see <xref | 825 | <entry>Buffer for video output overlay (OSD), see <xref |
830 | linkend="osd" />.</entry> | 826 | linkend="osd" />.</entry> |
831 | </row> | 827 | </row> |
832 | <row> | ||
833 | <entry><constant>V4L2_BUF_TYPE_PRIVATE</constant></entry> | ||
834 | <entry>0x80</entry> | ||
835 | <entry>This and higher values are reserved for custom | ||
836 | (driver defined) buffer types.</entry> | ||
837 | </row> | ||
838 | </tbody> | 828 | </tbody> |
839 | </tgroup> | 829 | </tgroup> |
840 | </table> | 830 | </table> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-cropcap.xml b/Documentation/DocBook/media/v4l/vidioc-cropcap.xml index f1bac2c6e978..4559c452a613 100644 --- a/Documentation/DocBook/media/v4l/vidioc-cropcap.xml +++ b/Documentation/DocBook/media/v4l/vidioc-cropcap.xml | |||
@@ -70,10 +70,8 @@ output.</para> | |||
70 | <entry>Type of the data stream, set by the application. | 70 | <entry>Type of the data stream, set by the application. |
71 | Only these types are valid here: | 71 | Only these types are valid here: |
72 | <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>, | 72 | <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>, |
73 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant>, | 73 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> and |
74 | <constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>, and custom (driver | 74 | <constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>. See <xref linkend="v4l2-buf-type" />.</entry> |
75 | defined) types with code <constant>V4L2_BUF_TYPE_PRIVATE</constant> | ||
76 | and higher. See <xref linkend="v4l2-buf-type" />.</entry> | ||
77 | </row> | 75 | </row> |
78 | <row> | 76 | <row> |
79 | <entry>struct <link linkend="v4l2-rect-crop">v4l2_rect</link></entry> | 77 | <entry>struct <link linkend="v4l2-rect-crop">v4l2_rect</link></entry> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-enum-fmt.xml b/Documentation/DocBook/media/v4l/vidioc-enum-fmt.xml index 0bd332421407..f8dfeed34fca 100644 --- a/Documentation/DocBook/media/v4l/vidioc-enum-fmt.xml +++ b/Documentation/DocBook/media/v4l/vidioc-enum-fmt.xml | |||
@@ -81,10 +81,8 @@ Only these types are valid here: | |||
81 | <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>, | 81 | <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>, |
82 | <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>, | 82 | <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE</constant>, |
83 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant>, | 83 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant>, |
84 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant>, | 84 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE</constant> and |
85 | <constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>, and custom (driver | 85 | <constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>. See <xref linkend="v4l2-buf-type" />.</entry> |
86 | defined) types with code <constant>V4L2_BUF_TYPE_PRIVATE</constant> | ||
87 | and higher. See <xref linkend="v4l2-buf-type" />.</entry> | ||
88 | </row> | 86 | </row> |
89 | <row> | 87 | <row> |
90 | <entry>__u32</entry> | 88 | <entry>__u32</entry> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-crop.xml b/Documentation/DocBook/media/v4l/vidioc-g-crop.xml index c4ff3b1887fb..75c6a93de3c1 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-crop.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-crop.xml | |||
@@ -104,10 +104,8 @@ changed and <constant>VIDIOC_S_CROP</constant> returns the | |||
104 | <entry><structfield>type</structfield></entry> | 104 | <entry><structfield>type</structfield></entry> |
105 | <entry>Type of the data stream, set by the application. | 105 | <entry>Type of the data stream, set by the application. |
106 | Only these types are valid here: <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>, | 106 | Only these types are valid here: <constant>V4L2_BUF_TYPE_VIDEO_CAPTURE</constant>, |
107 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant>, | 107 | <constant>V4L2_BUF_TYPE_VIDEO_OUTPUT</constant> and |
108 | <constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>, and custom (driver | 108 | <constant>V4L2_BUF_TYPE_VIDEO_OVERLAY</constant>. See <xref linkend="v4l2-buf-type" />.</entry> |
109 | defined) types with code <constant>V4L2_BUF_TYPE_PRIVATE</constant> | ||
110 | and higher. See <xref linkend="v4l2-buf-type" />.</entry> | ||
111 | </row> | 109 | </row> |
112 | <row> | 110 | <row> |
113 | <entry>&v4l2-rect;</entry> | 111 | <entry>&v4l2-rect;</entry> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml b/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml index b4b0e0a28545..ee8f56e1bac0 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-fmt.xml | |||
@@ -174,9 +174,7 @@ capture and output devices.</entry> | |||
174 | <entry></entry> | 174 | <entry></entry> |
175 | <entry>__u8</entry> | 175 | <entry>__u8</entry> |
176 | <entry><structfield>raw_data</structfield>[200]</entry> | 176 | <entry><structfield>raw_data</structfield>[200]</entry> |
177 | <entry>Place holder for future extensions and custom | 177 | <entry>Place holder for future extensions.</entry> |
178 | (driver defined) formats with <structfield>type</structfield> | ||
179 | <constant>V4L2_BUF_TYPE_PRIVATE</constant> and higher.</entry> | ||
180 | </row> | 178 | </row> |
181 | </tbody> | 179 | </tbody> |
182 | </tgroup> | 180 | </tgroup> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-parm.xml b/Documentation/DocBook/media/v4l/vidioc-g-parm.xml index f83d2cdd1185..9058224d1bbf 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-parm.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-parm.xml | |||
@@ -108,9 +108,7 @@ devices.</para> | |||
108 | <entry></entry> | 108 | <entry></entry> |
109 | <entry>__u8</entry> | 109 | <entry>__u8</entry> |
110 | <entry><structfield>raw_data</structfield>[200]</entry> | 110 | <entry><structfield>raw_data</structfield>[200]</entry> |
111 | <entry>A place holder for future extensions and custom | 111 | <entry>A place holder for future extensions.</entry> |
112 | (driver defined) buffer types <constant>V4L2_BUF_TYPE_PRIVATE</constant> and | ||
113 | higher.</entry> | ||
114 | </row> | 112 | </row> |
115 | </tbody> | 113 | </tbody> |
116 | </tgroup> | 114 | </tgroup> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml b/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml index d7c95057bc51..2b50ef2007f3 100644 --- a/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml +++ b/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml | |||
@@ -109,9 +109,8 @@ as the &v4l2-format; <structfield>type</structfield> field. See <xref | |||
109 | <row> | 109 | <row> |
110 | <entry>__u32</entry> | 110 | <entry>__u32</entry> |
111 | <entry><structfield>reserved</structfield>[2]</entry> | 111 | <entry><structfield>reserved</structfield>[2]</entry> |
112 | <entry>A place holder for future extensions and custom | 112 | <entry>A place holder for future extensions. This array should |
113 | (driver defined) buffer types <constant>V4L2_BUF_TYPE_PRIVATE</constant> and | 113 | be zeroed by applications.</entry> |
114 | higher. This array should be zeroed by applications.</entry> | ||
115 | </row> | 114 | </row> |
116 | </tbody> | 115 | </tbody> |
117 | </tgroup> | 116 | </tgroup> |