aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/v4l/dev-subdev.xml
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/v4l/dev-subdev.xml
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/v4l/dev-subdev.xml')
-rw-r--r--Documentation/DocBook/v4l/dev-subdev.xml46
1 files changed, 23 insertions, 23 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