aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorHans Verkuil <hverkuil@xs4all.nl>2011-03-11 14:22:21 -0500
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-03-22 03:54:31 -0400
commit665bf368fdc1e7afc9616eda128fe83d6053d5bc (patch)
tree393975b5ae9dfef149efbf7c19303794756e36f2 /Documentation/DocBook
parent941f896071c5c9120c8473c77246beaf36155247 (diff)
[media] V4L doc fixes
The xmlto validation produced a number of errors that are now fixed. Sadly, the DocBook/Makefile still adds --skip-validation to xmlto, so these errors are missed during a normal compile. 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/v4l/dev-subdev.xml46
-rw-r--r--Documentation/DocBook/v4l/media-ioc-enum-entities.xml6
-rw-r--r--Documentation/DocBook/v4l/subdev-formats.xml64
3 files changed, 58 insertions, 58 deletions
diff --git a/Documentation/DocBook/v4l/dev-subdev.xml b/Documentation/DocBook/v4l/dev-subdev.xml
index e9eb8af0f303..21caff6d159b 100644
--- a/Documentation/DocBook/v4l/dev-subdev.xml
+++ b/Documentation/DocBook/v4l/dev-subdev.xml
@@ -23,9 +23,9 @@
23 driver and the V4L2 device driver support this, sub-devices will feature a 23 driver and the V4L2 device driver support this, sub-devices will feature a
24 character device node on which ioctls can be called to 24 character device node on which ioctls can be called to
25 <itemizedlist> 25 <itemizedlist>
26 <listitem>query, read and write sub-devices controls</listitem> 26 <listitem><para>query, read and write sub-devices controls</para></listitem>
27 <listitem>subscribe and unsubscribe to events and retrieve them</listitem> 27 <listitem><para>subscribe and unsubscribe to events and retrieve them</para></listitem>
28 <listitem>negotiate image formats on individual pads</listitem> 28 <listitem><para>negotiate image formats on individual pads</para></listitem>
29 </itemizedlist> 29 </itemizedlist>
30 </para> 30 </para>
31 31
@@ -67,14 +67,14 @@
67 <section id="pad-level-formats"> 67 <section id="pad-level-formats">
68 <title>Pad-level Formats</title> 68 <title>Pad-level Formats</title>
69 69
70 <warning>Pad-level formats are only applicable to very complex device that 70 <warning><para>Pad-level formats are only applicable to very complex device that
71 need to expose low-level format configuration to user space. Generic V4L2 71 need to expose low-level format configuration to user space. Generic V4L2
72 applications do <emphasis>not</emphasis> need to use the API described in 72 applications do <emphasis>not</emphasis> need to use the API described in
73 this section.</warning> 73 this section.</para></warning>
74 74
75 <note>For the purpose of this section, the term 75 <note><para>For the purpose of this section, the term
76 <wordasword>format</wordasword> means the combination of media bus data 76 <wordasword>format</wordasword> means the combination of media bus data
77 format, frame width and frame height.</note> 77 format, frame width and frame height.</para></note>
78 78
79 <para>Image formats are typically negotiated on video capture and output 79 <para>Image formats are typically negotiated on video capture and output
80 devices using the <link linkend="crop">cropping and scaling</link> ioctls. 80 devices using the <link linkend="crop">cropping and scaling</link> ioctls.
@@ -84,8 +84,8 @@
84 84
85 <para>For complex devices, such as often found in embedded systems, 85 <para>For complex devices, such as often found in embedded systems,
86 identical image sizes at the output of a pipeline can be achieved using 86 identical image sizes at the output of a pipeline can be achieved using
87 different hardware configurations. One such exemple is shown on 87 different hardware configurations. One such example is shown on
88 <xref linkend="pipeline-scaling" xrefstyle="template: Figure %n" />, where 88 <xref linkend="pipeline-scaling" />, where
89 image scaling can be performed on both the video sensor and the host image 89 image scaling can be performed on both the video sensor and the host image
90 processing hardware.</para> 90 processing hardware.</para>
91 91
@@ -168,13 +168,13 @@
168 modify formats as required by the device. However, they should comply with 168 modify formats as required by the device. However, they should comply with
169 the following rules when possible: 169 the following rules when possible:
170 <itemizedlist> 170 <itemizedlist>
171 <listitem>Formats should be propagated from sink pads to source pads. 171 <listitem><para>Formats should be propagated from sink pads to source pads.
172 Modifying a format on a source pad should not modify the format on any 172 Modifying a format on a source pad should not modify the format on any
173 sink pad.</listitem> 173 sink pad.</para></listitem>
174 <listitem>Sub-devices that scale frames using variable scaling factors 174 <listitem><para>Sub-devices that scale frames using variable scaling factors
175 should reset the scale factors to default values when sink pads formats 175 should reset the scale factors to default values when sink pads formats
176 are modified. If the 1:1 scaling ratio is supported, this means that 176 are modified. If the 1:1 scaling ratio is supported, this means that
177 source pads formats should be reset to the sink pads formats.</listitem> 177 source pads formats should be reset to the sink pads formats.</para></listitem>
178 </itemizedlist> 178 </itemizedlist>
179 </para> 179 </para>
180 180
@@ -185,9 +185,9 @@
185 guaranteed to be compatible. Drivers are free to accept different formats 185 guaranteed to be compatible. Drivers are free to accept different formats
186 matching device requirements as being compatible.</para> 186 matching device requirements as being compatible.</para>
187 187
188 <para><xref linkend="sample-pipeline-config" xrefstyle="template:Table %n"/> 188 <para><xref linkend="sample-pipeline-config" />
189 shows a sample configuration sequence for the pipeline described in 189 shows a sample configuration sequence for the pipeline described in
190 <xref linkend="pipeline-scaling" xrefstyle="template:Figure %n"/> (table 190 <xref linkend="pipeline-scaling" /> (table
191 columns list entity names and pad numbers).</para> 191 columns list entity names and pad numbers).</para>
192 192
193 <table pgwide="0" frame="none" id="sample-pipeline-config"> 193 <table pgwide="0" frame="none" id="sample-pipeline-config">
@@ -248,19 +248,19 @@
248 248
249 <para> 249 <para>
250 <orderedlist> 250 <orderedlist>
251 <listitem>Initial state. The sensor output is set to its native 3MP 251 <listitem><para>Initial state. The sensor output is set to its native 3MP
252 resolution. Resolutions on the host frontend and scaler input and output 252 resolution. Resolutions on the host frontend and scaler input and output
253 pads are undefined.</listitem> 253 pads are undefined.</para></listitem>
254 <listitem>The application configures the frontend input pad resolution to 254 <listitem><para>The application configures the frontend input pad resolution to
255 2048x1536. The driver propagates the format to the frontend output pad. 255 2048x1536. The driver propagates the format to the frontend output pad.
256 Note that the propagated output format can be different, as in this case, 256 Note that the propagated output format can be different, as in this case,
257 than the input format, as the hardware might need to crop pixels (for 257 than the input format, as the hardware might need to crop pixels (for
258 instance when converting a Bayer filter pattern to RGB or YUV).</listitem> 258 instance when converting a Bayer filter pattern to RGB or YUV).</para></listitem>
259 <listitem>The application configures the scaler input pad resolution to 259 <listitem><para>The application configures the scaler input pad resolution to
260 2046x1534 to match the frontend output resolution. The driver propagates 260 2046x1534 to match the frontend output resolution. The driver propagates
261 the format to the scaler output pad.</listitem> 261 the format to the scaler output pad.</para></listitem>
262 <listitem>The application configures the scaler output pad resolution to 262 <listitem><para>The application configures the scaler output pad resolution to
263 1280x960.</listitem> 263 1280x960.</para></listitem>
264 </orderedlist> 264 </orderedlist>
265 </para> 265 </para>
266 266
diff --git a/Documentation/DocBook/v4l/media-ioc-enum-entities.xml b/Documentation/DocBook/v4l/media-ioc-enum-entities.xml
index 13d0cc44865a..576b68b33f2c 100644
--- a/Documentation/DocBook/v4l/media-ioc-enum-entities.xml
+++ b/Documentation/DocBook/v4l/media-ioc-enum-entities.xml
@@ -63,9 +63,9 @@
63 <structfield>group_id</structfield> value are considered as logically 63 <structfield>group_id</structfield> value are considered as logically
64 grouped. Groups are used to report 64 grouped. Groups are used to report
65 <itemizedlist> 65 <itemizedlist>
66 <listitem>ALSA, VBI and video nodes that carry the same media 66 <listitem><para>ALSA, VBI and video nodes that carry the same media
67 stream</listitem> 67 stream</para></listitem>
68 <listitem>lens and flash controllers associated with a sensor</listitem> 68 <listitem><para>lens and flash controllers associated with a sensor</para></listitem>
69 </itemizedlist> 69 </itemizedlist>
70 </para> 70 </para>
71 71
diff --git a/Documentation/DocBook/v4l/subdev-formats.xml b/Documentation/DocBook/v4l/subdev-formats.xml
index b5376e263d10..7041127d6dfc 100644
--- a/Documentation/DocBook/v4l/subdev-formats.xml
+++ b/Documentation/DocBook/v4l/subdev-formats.xml
@@ -63,22 +63,22 @@
63 <para>Those formats transfer pixel data as red, green and blue components. 63 <para>Those formats transfer pixel data as red, green and blue components.
64 The format code is made of the following information. 64 The format code is made of the following information.
65 <itemizedlist> 65 <itemizedlist>
66 <listitem>The red, green and blue components order code, as encoded in a 66 <listitem><para>The red, green and blue components order code, as encoded in a
67 pixel sample. Possible values are RGB and BGR.</listitem> 67 pixel sample. Possible values are RGB and BGR.</para></listitem>
68 <listitem>The number of bits per component, for each component. The values 68 <listitem><para>The number of bits per component, for each component. The values
69 can be different for all components. Common values are 555 and 565. 69 can be different for all components. Common values are 555 and 565.</para>
70 </listitem> 70 </listitem>
71 <listitem>The number of bus samples per pixel. Pixels that are wider than 71 <listitem><para>The number of bus samples per pixel. Pixels that are wider than
72 the bus width must be transferred in multiple samples. Common values are 72 the bus width must be transferred in multiple samples. Common values are
73 1 and 2.</listitem> 73 1 and 2.</para></listitem>
74 <listitem>The bus width.</listitem> 74 <listitem><para>The bus width.</para></listitem>
75 <listitem>For formats where the total number of bits per pixel is smaller 75 <listitem><para>For formats where the total number of bits per pixel is smaller
76 than the number of bus samples per pixel times the bus width, a padding 76 than the number of bus samples per pixel times the bus width, a padding
77 value stating if the bytes are padded in their most high order bits 77 value stating if the bytes are padded in their most high order bits
78 (PADHI) or low order bits (PADLO).</listitem> 78 (PADHI) or low order bits (PADLO).</para></listitem>
79 <listitem>For formats where the number of bus samples per pixel is larger 79 <listitem><para>For formats where the number of bus samples per pixel is larger
80 than 1, an endianness value stating if the pixel is transferred MSB first 80 than 1, an endianness value stating if the pixel is transferred MSB first
81 (BE) or LSB first (LE).</listitem> 81 (BE) or LSB first (LE).</para></listitem>
82 </itemizedlist> 82 </itemizedlist>
83 </para> 83 </para>
84 84
@@ -347,26 +347,26 @@
347 <para>Those formats transfer pixel data as red, green and blue components. 347 <para>Those formats transfer pixel data as red, green and blue components.
348 The format code is made of the following information. 348 The format code is made of the following information.
349 <itemizedlist> 349 <itemizedlist>
350 <listitem>The red, green and blue components order code, as encoded in a 350 <listitem><para>The red, green and blue components order code, as encoded in a
351 pixel sample. The possible values are shown in <xref 351 pixel sample. The possible values are shown in <xref
352 linkend="bayer-patterns" />.</listitem> 352 linkend="bayer-patterns" />.</para></listitem>
353 <listitem>The number of bits per pixel component. All components are 353 <listitem><para>The number of bits per pixel component. All components are
354 transferred on the same number of bits. Common values are 8, 10 and 12. 354 transferred on the same number of bits. Common values are 8, 10 and 12.</para>
355 </listitem> 355 </listitem>
356 <listitem>If the pixel components are DPCM-compressed, a mention of the 356 <listitem><para>If the pixel components are DPCM-compressed, a mention of the
357 DPCM compression and the number of bits per compressed pixel component. 357 DPCM compression and the number of bits per compressed pixel component.</para>
358 </listitem> 358 </listitem>
359 <listitem>The number of bus samples per pixel. Pixels that are wider than 359 <listitem><para>The number of bus samples per pixel. Pixels that are wider than
360 the bus width must be transferred in multiple samples. Common values are 360 the bus width must be transferred in multiple samples. Common values are
361 1 and 2.</listitem> 361 1 and 2.</para></listitem>
362 <listitem>The bus width.</listitem> 362 <listitem><para>The bus width.</para></listitem>
363 <listitem>For formats where the total number of bits per pixel is smaller 363 <listitem><para>For formats where the total number of bits per pixel is smaller
364 than the number of bus samples per pixel times the bus width, a padding 364 than the number of bus samples per pixel times the bus width, a padding
365 value stating if the bytes are padded in their most high order bits 365 value stating if the bytes are padded in their most high order bits
366 (PADHI) or low order bits (PADLO).</listitem> 366 (PADHI) or low order bits (PADLO).</para></listitem>
367 <listitem>For formats where the number of bus samples per pixel is larger 367 <listitem><para>For formats where the number of bus samples per pixel is larger
368 than 1, an endianness value stating if the pixel is transferred MSB first 368 than 1, an endianness value stating if the pixel is transferred MSB first
369 (BE) or LSB first (LE).</listitem> 369 (BE) or LSB first (LE).</para></listitem>
370 </itemizedlist> 370 </itemizedlist>
371 </para> 371 </para>
372 372
@@ -824,19 +824,19 @@
824 <para>Those data formats transfer pixel data as (possibly downsampled) Y, U 824 <para>Those data formats transfer pixel data as (possibly downsampled) Y, U
825 and V components. The format code is made of the following information. 825 and V components. The format code is made of the following information.
826 <itemizedlist> 826 <itemizedlist>
827 <listitem>The Y, U and V components order code, as transferred on the 827 <listitem><para>The Y, U and V components order code, as transferred on the
828 bus. Possible values are YUYV, UYVY, YVYU and VYUY.</listitem> 828 bus. Possible values are YUYV, UYVY, YVYU and VYUY.</para></listitem>
829 <listitem>The number of bits per pixel component. All components are 829 <listitem><para>The number of bits per pixel component. All components are
830 transferred on the same number of bits. Common values are 8, 10 and 12. 830 transferred on the same number of bits. Common values are 8, 10 and 12.</para>
831 </listitem> 831 </listitem>
832 <listitem>The number of bus samples per pixel. Pixels that are wider than 832 <listitem><para>The number of bus samples per pixel. Pixels that are wider than
833 the bus width must be transferred in multiple samples. Common values are 833 the bus width must be transferred in multiple samples. Common values are
834 1, 1.5 (encoded as 1_5) and 2.</listitem> 834 1, 1.5 (encoded as 1_5) and 2.</para></listitem>
835 <listitem>The bus width. When the bus width is larger than the number of 835 <listitem><para>The bus width. When the bus width is larger than the number of
836 bits per pixel component, several components are packed in a single bus 836 bits per pixel component, several components are packed in a single bus
837 sample. The components are ordered as specified by the order code, with 837 sample. The components are ordered as specified by the order code, with
838 components on the left of the code transferred in the high order bits. 838 components on the left of the code transferred in the high order bits.
839 Common values are 8 and 16. 839 Common values are 8 and 16.</para>
840 </listitem> 840 </listitem>
841 </itemizedlist> 841 </itemizedlist>
842 </para> 842 </para>