Commit eed22358 authored by Steve Longerbeam's avatar Steve Longerbeam Committed by Mauro Carvalho Chehab
Browse files

media: imx.rst: Update doc to reflect fixes to interlaced capture 



Also add an example pipeline for unconverted capture with interweave
on SabreAuto.

Cleanup some language in various places in the process.

Signed-off-by: default avatarSteve Longerbeam <slongerbeam@gmail.com>
Reviewed-by: default avatarPhilipp Zabel <p.zabel@pengutronix.de>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent 3c6640a6

Documentation/media/v4l-drivers/imx.rst

+66 −37
Original line number Original line Diff line number Diff line
@@ -24,8 +24,8 @@ memory. Various dedicated DMA channels exist for both video capture and 
display paths. During transfer, the IDMAC is also capable of vertical

display paths. During transfer, the IDMAC is also capable of vertical

image flip, 8x8 block transfer (see IRT description), pixel component

image flip, 8x8 block transfer (see IRT description), pixel component

re-ordering (for example UYVY to YUYV) within the same colorspace, and

re-ordering (for example UYVY to YUYV) within the same colorspace, and

even packed <--> planar conversion. It can also perform a simple

packed <--> planar conversion. The IDMAC can also perform a simple

de-interlacing by interleaving even and odd lines during transfer

de-interlacing by interweaving even and odd lines during transfer

(without motion compensation which requires the VDIC).

(without motion compensation which requires the VDIC).





The CSI is the backend capture unit that interfaces directly with

The CSI is the backend capture unit that interfaces directly with
@@ -175,15 +175,21 @@ via the SMFC and an IDMAC channel, bypassing IC pre-processing. This 
source pad is routed to a capture device node, with a node name of the

source pad is routed to a capture device node, with a node name of the

format "ipuX_csiY capture".

format "ipuX_csiY capture".





Note that since the IDMAC source pad makes use of an IDMAC channel, it

Note that since the IDMAC source pad makes use of an IDMAC channel,

can do pixel reordering within the same colorspace. For example, the

pixel reordering within the same colorspace can be carried out by the

sink pad can take UYVY2X8, but the IDMAC source pad can output YUYV2X8.

IDMAC channel. For example, if the CSI sink pad is receiving in UYVY

If the sink pad is receiving YUV, the output at the capture device can

order, the capture device linked to the IDMAC source pad can capture

also be converted to a planar YUV format such as YUV420.

in YUYV order. Also, if the CSI sink pad is receiving a packed YUV



format, the capture device can capture a planar YUV format such as

It will also perform simple de-interlace without motion compensation,

YUV420.

which is activated if the sink pad's field type is an interlaced type,



and the IDMAC source pad field type is set to none.

The IDMAC channel at the IDMAC source pad also supports simple

interweave without motion compensation, which is activated if the source

pad's field type is sequential top-bottom or bottom-top, and the

requested capture interface field type is set to interlaced (t-b, b-t,

or unqualified interlaced). The capture interface will enforce the same

field order as the source pad field order (interlaced-bt if source pad

is seq-bt, interlaced-tb if source pad is seq-tb).





This subdev can generate the following event when enabling the second

This subdev can generate the following event when enabling the second

IDMAC source pad:

IDMAC source pad:
@@ -325,14 +331,14 @@ ipuX_vdic 




The VDIC carries out motion compensated de-interlacing, with three

The VDIC carries out motion compensated de-interlacing, with three

motion compensation modes: low, medium, and high motion. The mode is

motion compensation modes: low, medium, and high motion. The mode is

specified with the menu control V4L2_CID_DEINTERLACING_MODE. It has

specified with the menu control V4L2_CID_DEINTERLACING_MODE. The VDIC

two sink pads and a single source pad.

has two sink pads and a single source pad.





The direct sink pad receives from an ipuX_csiY direct pad. With this

The direct sink pad receives from an ipuX_csiY direct pad. With this

link the VDIC can only operate in high motion mode.

link the VDIC can only operate in high motion mode.





When the IDMAC sink pad is activated, it receives from an output

When the IDMAC sink pad is activated, it receives from an output

or mem2mem device node. With this pipeline, it can also operate

or mem2mem device node. With this pipeline, the VDIC can also operate

in low and medium modes, because these modes require receiving

in low and medium modes, because these modes require receiving

frames from memory buffers. Note that an output or mem2mem device

frames from memory buffers. Note that an output or mem2mem device

is not implemented yet, so this sink pad currently has no links.

is not implemented yet, so this sink pad currently has no links.
@@ -345,8 +351,8 @@ ipuX_ic_prp 
This is the IC pre-processing entity. It acts as a router, routing

This is the IC pre-processing entity. It acts as a router, routing

data from its sink pad to one or both of its source pads.

data from its sink pad to one or both of its source pads.





It has a single sink pad. The sink pad can receive from the ipuX_csiY

This entity has a single sink pad. The sink pad can receive from the

direct pad, or from ipuX_vdic.

ipuX_csiY direct pad, or from ipuX_vdic.





This entity has two source pads. One source pad routes to the

This entity has two source pads. One source pad routes to the

pre-process encode task entity (ipuX_ic_prpenc), the other to the

pre-process encode task entity (ipuX_ic_prpenc), the other to the
@@ -369,8 +375,8 @@ color-space conversion, resizing (downscaling and upscaling), 
horizontal and vertical flip, and 90/270 degree rotation. Flip

horizontal and vertical flip, and 90/270 degree rotation. Flip

and rotation are provided via standard V4L2 controls.

and rotation are provided via standard V4L2 controls.





Like the ipuX_csiY IDMAC source, it can also perform simple de-interlace

Like the ipuX_csiY IDMAC source, this entity also supports simple

without motion compensation, and pixel reordering.

de-interlace without motion compensation, and pixel reordering.





ipuX_ic_prpvf

ipuX_ic_prpvf

-------------

-------------
@@ -380,18 +386,18 @@ pad from ipuX_ic_prp, and a single source pad. The source pad is routed 
to a capture device node, with a node name of the format

to a capture device node, with a node name of the format

"ipuX_ic_prpvf capture".

"ipuX_ic_prpvf capture".





It is identical in operation to ipuX_ic_prpenc, with the same resizing

This entity is identical in operation to ipuX_ic_prpenc, with the same

and CSC operations and flip/rotation controls. It will receive and

resizing and CSC operations and flip/rotation controls. It will receive

process de-interlaced frames from the ipuX_vdic if ipuX_ic_prp is

and process de-interlaced frames from the ipuX_vdic if ipuX_ic_prp is

receiving from ipuX_vdic.

receiving from ipuX_vdic.





Like the ipuX_csiY IDMAC source, it can perform simple de-interlace

Like the ipuX_csiY IDMAC source, this entity supports simple

without motion compensation. However, note that if the ipuX_vdic is

interweaving without motion compensation. However, note that if the

included in the pipeline (ipuX_ic_prp is receiving from ipuX_vdic),

ipuX_vdic is included in the pipeline (ipuX_ic_prp is receiving from

it's not possible to use simple de-interlace in ipuX_ic_prpvf, since

ipuX_vdic), it's not possible to use interweave in ipuX_ic_prpvf,

the ipuX_vdic has already carried out de-interlacing (with motion

since the ipuX_vdic has already carried out de-interlacing (with

compensation) and therefore the field type output from ipuX_ic_prp can

motion compensation) and therefore the field type output from

only be none.

ipuX_vdic can only be none (progressive).





Capture Pipelines

Capture Pipelines

-----------------

-----------------
@@ -516,10 +522,33 @@ On the SabreAuto, an on-board ADV7180 SD decoder is connected to the 
parallel bus input on the internal video mux to IPU1 CSI0.

parallel bus input on the internal video mux to IPU1 CSI0.





The following example configures a pipeline to capture from the ADV7180

The following example configures a pipeline to capture from the ADV7180

video decoder, assuming NTSC 720x480 input signals, with Motion

video decoder, assuming NTSC 720x480 input signals, using simple

Compensated de-interlacing. Pad field types assume the adv7180 outputs

interweave (unconverted and without motion compensation). The adv7180

"interlaced". $outputfmt can be any format supported by the ipu1_ic_prpvf

must output sequential or alternating fields (field type 'seq-bt' for

entity at its output pad:

NTSC, or 'alternate'):



.. code-block:: none



   # Setup links

   media-ctl -l "'adv7180 3-0021':0 -> 'ipu1_csi0_mux':1[1]"

   media-ctl -l "'ipu1_csi0_mux':2 -> 'ipu1_csi0':0[1]"

   media-ctl -l "'ipu1_csi0':2 -> 'ipu1_csi0 capture':0[1]"

   # Configure pads

   media-ctl -V "'adv7180 3-0021':0 [fmt:UYVY2X8/720x480 field:seq-bt]"

   media-ctl -V "'ipu1_csi0_mux':2 [fmt:UYVY2X8/720x480]"

   media-ctl -V "'ipu1_csi0':2 [fmt:AYUV32/720x480]"

   # Configure "ipu1_csi0 capture" interface (assumed at /dev/video4)

   v4l2-ctl -d4 --set-fmt-video=field=interlaced_bt



Streaming can then begin on /dev/video4. The v4l2-ctl tool can also be

used to select any supported YUV pixelformat on /dev/video4.



This example configures a pipeline to capture from the ADV7180

video decoder, assuming PAL 720x576 input signals, with Motion

Compensated de-interlacing. The adv7180 must output sequential or

alternating fields (field type 'seq-tb' for PAL, or 'alternate').

$outputfmt can be any format supported by the ipu1_ic_prpvf entity

at its output pad:





.. code-block:: none

.. code-block:: none
@@ -531,11 +560,11 @@ entity at its output pad: 
   media-ctl -l "'ipu1_ic_prp':2 -> 'ipu1_ic_prpvf':0[1]"

   media-ctl -l "'ipu1_ic_prp':2 -> 'ipu1_ic_prpvf':0[1]"

   media-ctl -l "'ipu1_ic_prpvf':1 -> 'ipu1_ic_prpvf capture':0[1]"

   media-ctl -l "'ipu1_ic_prpvf':1 -> 'ipu1_ic_prpvf capture':0[1]"

   # Configure pads

   # Configure pads

   media-ctl -V "'adv7180 3-0021':0 [fmt:UYVY2X8/720x480]"

   media-ctl -V "'adv7180 3-0021':0 [fmt:UYVY2X8/720x576 field:seq-tb]"

   media-ctl -V "'ipu1_csi0_mux':2 [fmt:UYVY2X8/720x480 field:interlaced]"

   media-ctl -V "'ipu1_csi0_mux':2 [fmt:UYVY2X8/720x576]"

   media-ctl -V "'ipu1_csi0':1 [fmt:AYUV32/720x480 field:interlaced]"

   media-ctl -V "'ipu1_csi0':1 [fmt:AYUV32/720x576]"

   media-ctl -V "'ipu1_vdic':2 [fmt:AYUV32/720x480 field:none]"

   media-ctl -V "'ipu1_vdic':2 [fmt:AYUV32/720x576 field:none]"

   media-ctl -V "'ipu1_ic_prp':2 [fmt:AYUV32/720x480 field:none]"

   media-ctl -V "'ipu1_ic_prp':2 [fmt:AYUV32/720x576 field:none]"

   media-ctl -V "'ipu1_ic_prpvf':1 [fmt:$outputfmt field:none]"

   media-ctl -V "'ipu1_ic_prpvf':1 [fmt:$outputfmt field:none]"





Streaming can then begin on the capture device node at

Streaming can then begin on the capture device node at