Skip to content

Commit

Permalink
[media] V4L doc fixes
Browse files Browse the repository at this point in the history 
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>
  • Loading branch information
Hans Verkuil authored and Mauro Carvalho Chehab committed Mar 22, 2011
1 parent 941f896 commit 665bf36
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 58 deletions.
46 changes: 23 additions & 23 deletions Documentation/DocBook/v4l/dev-subdev.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
driver and the V4L2 device driver support this, sub-devices will feature a
character device node on which ioctls can be called to
<itemizedlist>
<listitem>query, read and write sub-devices controls</listitem>
<listitem>subscribe and unsubscribe to events and retrieve them</listitem>
<listitem>negotiate image formats on individual pads</listitem>
<listitem><para>query, read and write sub-devices controls</para></listitem>
<listitem><para>subscribe and unsubscribe to events and retrieve them</para></listitem>
<listitem><para>negotiate image formats on individual pads</para></listitem>
</itemizedlist>
</para>

Expand Down Expand Up @@ -67,14 +67,14 @@
<section id="pad-level-formats">
<title>Pad-level Formats</title>

<warning>Pad-level formats are only applicable to very complex device that
<warning><para>Pad-level formats are only applicable to very complex device that
need to expose low-level format configuration to user space. Generic V4L2
applications do <emphasis>not</emphasis> need to use the API described in
this section.</warning>
this section.</para></warning>

<note>For the purpose of this section, the term
<note><para>For the purpose of this section, the term
<wordasword>format</wordasword> means the combination of media bus data
format, frame width and frame height.</note>
format, frame width and frame height.</para></note>

<para>Image formats are typically negotiated on video capture and output
devices using the <link linkend="crop">cropping and scaling</link> ioctls.
Expand All @@ -84,8 +84,8 @@

<para>For complex devices, such as often found in embedded systems,
identical image sizes at the output of a pipeline can be achieved using
different hardware configurations. One such exemple is shown on
<xref linkend="pipeline-scaling" xrefstyle="template: Figure %n" />, where
different hardware configurations. One such example is shown on
<xref linkend="pipeline-scaling" />, where
image scaling can be performed on both the video sensor and the host image
processing hardware.</para>

Expand Down Expand Up @@ -168,13 +168,13 @@
modify formats as required by the device. However, they should comply with
the following rules when possible:
<itemizedlist>
<listitem>Formats should be propagated from sink pads to source pads.
<listitem><para>Formats should be propagated from sink pads to source pads.
Modifying a format on a source pad should not modify the format on any
sink pad.</listitem>
<listitem>Sub-devices that scale frames using variable scaling factors
sink pad.</para></listitem>
<listitem><para>Sub-devices that scale frames using variable scaling factors
should reset the scale factors to default values when sink pads formats
are modified. If the 1:1 scaling ratio is supported, this means that
source pads formats should be reset to the sink pads formats.</listitem>
source pads formats should be reset to the sink pads formats.</para></listitem>
</itemizedlist>
</para>

Expand All @@ -185,9 +185,9 @@
guaranteed to be compatible. Drivers are free to accept different formats
matching device requirements as being compatible.</para>

<para><xref linkend="sample-pipeline-config" xrefstyle="template:Table %n"/>
<para><xref linkend="sample-pipeline-config" />
shows a sample configuration sequence for the pipeline described in
<xref linkend="pipeline-scaling" xrefstyle="template:Figure %n"/> (table
<xref linkend="pipeline-scaling" /> (table
columns list entity names and pad numbers).</para>

<table pgwide="0" frame="none" id="sample-pipeline-config">
Expand Down Expand Up @@ -248,19 +248,19 @@

<para>
<orderedlist>
<listitem>Initial state. The sensor output is set to its native 3MP
<listitem><para>Initial state. The sensor output is set to its native 3MP
resolution. Resolutions on the host frontend and scaler input and output
pads are undefined.</listitem>
<listitem>The application configures the frontend input pad resolution to
pads are undefined.</para></listitem>
<listitem><para>The application configures the frontend input pad resolution to
2048x1536. The driver propagates the format to the frontend output pad.
Note that the propagated output format can be different, as in this case,
than the input format, as the hardware might need to crop pixels (for
instance when converting a Bayer filter pattern to RGB or YUV).</listitem>
<listitem>The application configures the scaler input pad resolution to
instance when converting a Bayer filter pattern to RGB or YUV).</para></listitem>
<listitem><para>The application configures the scaler input pad resolution to
2046x1534 to match the frontend output resolution. The driver propagates
the format to the scaler output pad.</listitem>
<listitem>The application configures the scaler output pad resolution to
1280x960.</listitem>
the format to the scaler output pad.</para></listitem>
<listitem><para>The application configures the scaler output pad resolution to
1280x960.</para></listitem>
</orderedlist>
</para>

Expand Down
6 changes: 3 additions & 3 deletions Documentation/DocBook/v4l/media-ioc-enum-entities.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@
<structfield>group_id</structfield> value are considered as logically
grouped. Groups are used to report
<itemizedlist>
<listitem>ALSA, VBI and video nodes that carry the same media
stream</listitem>
<listitem>lens and flash controllers associated with a sensor</listitem>
<listitem><para>ALSA, VBI and video nodes that carry the same media
stream</para></listitem>
<listitem><para>lens and flash controllers associated with a sensor</para></listitem>
</itemizedlist>
</para>

Expand Down
64 changes: 32 additions & 32 deletions Documentation/DocBook/v4l/subdev-formats.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,22 +63,22 @@
<para>Those formats transfer pixel data as red, green and blue components.
The format code is made of the following information.
<itemizedlist>
<listitem>The red, green and blue components order code, as encoded in a
pixel sample. Possible values are RGB and BGR.</listitem>
<listitem>The number of bits per component, for each component. The values
can be different for all components. Common values are 555 and 565.
<listitem><para>The red, green and blue components order code, as encoded in a
pixel sample. Possible values are RGB and BGR.</para></listitem>
<listitem><para>The number of bits per component, for each component. The values
can be different for all components. Common values are 555 and 565.</para>
</listitem>
<listitem>The number of bus samples per pixel. Pixels that are wider than
<listitem><para>The number of bus samples per pixel. Pixels that are wider than
the bus width must be transferred in multiple samples. Common values are
1 and 2.</listitem>
<listitem>The bus width.</listitem>
<listitem>For formats where the total number of bits per pixel is smaller
1 and 2.</para></listitem>
<listitem><para>The bus width.</para></listitem>
<listitem><para>For formats where the total number of bits per pixel is smaller
than the number of bus samples per pixel times the bus width, a padding
value stating if the bytes are padded in their most high order bits
(PADHI) or low order bits (PADLO).</listitem>
<listitem>For formats where the number of bus samples per pixel is larger
(PADHI) or low order bits (PADLO).</para></listitem>
<listitem><para>For formats where the number of bus samples per pixel is larger
than 1, an endianness value stating if the pixel is transferred MSB first
(BE) or LSB first (LE).</listitem>
(BE) or LSB first (LE).</para></listitem>
</itemizedlist>
</para>

Expand Down Expand Up @@ -347,26 +347,26 @@
<para>Those formats transfer pixel data as red, green and blue components.
The format code is made of the following information.
<itemizedlist>
<listitem>The red, green and blue components order code, as encoded in a
<listitem><para>The red, green and blue components order code, as encoded in a
pixel sample. The possible values are shown in <xref
linkend="bayer-patterns" />.</listitem>
<listitem>The number of bits per pixel component. All components are
transferred on the same number of bits. Common values are 8, 10 and 12.
linkend="bayer-patterns" />.</para></listitem>
<listitem><para>The number of bits per pixel component. All components are
transferred on the same number of bits. Common values are 8, 10 and 12.</para>
</listitem>
<listitem>If the pixel components are DPCM-compressed, a mention of the
DPCM compression and the number of bits per compressed pixel component.
<listitem><para>If the pixel components are DPCM-compressed, a mention of the
DPCM compression and the number of bits per compressed pixel component.</para>
</listitem>
<listitem>The number of bus samples per pixel. Pixels that are wider than
<listitem><para>The number of bus samples per pixel. Pixels that are wider than
the bus width must be transferred in multiple samples. Common values are
1 and 2.</listitem>
<listitem>The bus width.</listitem>
<listitem>For formats where the total number of bits per pixel is smaller
1 and 2.</para></listitem>
<listitem><para>The bus width.</para></listitem>
<listitem><para>For formats where the total number of bits per pixel is smaller
than the number of bus samples per pixel times the bus width, a padding
value stating if the bytes are padded in their most high order bits
(PADHI) or low order bits (PADLO).</listitem>
<listitem>For formats where the number of bus samples per pixel is larger
(PADHI) or low order bits (PADLO).</para></listitem>
<listitem><para>For formats where the number of bus samples per pixel is larger
than 1, an endianness value stating if the pixel is transferred MSB first
(BE) or LSB first (LE).</listitem>
(BE) or LSB first (LE).</para></listitem>
</itemizedlist>
</para>

Expand Down Expand Up @@ -824,19 +824,19 @@
<para>Those data formats transfer pixel data as (possibly downsampled) Y, U
and V components. The format code is made of the following information.
<itemizedlist>
<listitem>The Y, U and V components order code, as transferred on the
bus. Possible values are YUYV, UYVY, YVYU and VYUY.</listitem>
<listitem>The number of bits per pixel component. All components are
transferred on the same number of bits. Common values are 8, 10 and 12.
<listitem><para>The Y, U and V components order code, as transferred on the
bus. Possible values are YUYV, UYVY, YVYU and VYUY.</para></listitem>
<listitem><para>The number of bits per pixel component. All components are
transferred on the same number of bits. Common values are 8, 10 and 12.</para>
</listitem>
<listitem>The number of bus samples per pixel. Pixels that are wider than
<listitem><para>The number of bus samples per pixel. Pixels that are wider than
the bus width must be transferred in multiple samples. Common values are
1, 1.5 (encoded as 1_5) and 2.</listitem>
<listitem>The bus width. When the bus width is larger than the number of
1, 1.5 (encoded as 1_5) and 2.</para></listitem>
<listitem><para>The bus width. When the bus width is larger than the number of
bits per pixel component, several components are packed in a single bus
sample. The components are ordered as specified by the order code, with
components on the left of the code transferred in the high order bits.
Common values are 8 and 16.
Common values are 8 and 16.</para>
</listitem>
</itemizedlist>
</para>
Expand Down

0 comments on commit 665bf36

Please sign in to comment.