Commit 1c5e4cf1 authored by Michael Riesch's avatar Michael Riesch Committed by Hans Verkuil
Browse files

Documentation: admin-guide: media: add rockchip camera interface 



Add a document that describes the different variants of the Rockchip
Camera Interface (CIF), their hardware layout, as well as their
representation in the media controller centric rkcif device driver,
which is located under drivers/media/platform/rockchip/rkcif.

Reviewed-by: default avatarHeiko Stuebner <heiko@sntech.de>
Reviewed-by: default avatarBryan O'Donoghue <bryan.odonoghue@linaro.org>
Signed-off-by: default avatarMichael Riesch <michael.riesch@collabora.com>
Signed-off-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: default avatarHans Verkuil <hverkuil+cisco@kernel.org>
parent 2f1e8881

Documentation/admin-guide/media/rkcif-rk3568-vicap.dot

0 → 100644
+8 −0
Original line number Diff line number Diff line 
digraph board {

        rankdir=TB

        n00000001 [label="{{<port0> 0} | rkcif-dvp0\n/dev/v4l-subdev0 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]

        n00000001:port1 -> n00000004

        n00000004 [label="rkcif-dvp0-id0\n/dev/video0", shape=box, style=filled, fillcolor=yellow]

        n00000025 [label="{{} | it6801 2-0048\n/dev/v4l-subdev1 | {<port0> 0}}", shape=Mrecord, style=filled, fillcolor=green]

        n00000025:port0 -> n00000001:port0

}

Documentation/admin-guide/media/rkcif.rst

0 → 100644
+79 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



=========================================

Rockchip Camera Interface (CIF)

=========================================



Introduction

============



The Rockchip Camera Interface (CIF) is featured in many Rockchip SoCs in

different variants.

The different variants are combinations of common building blocks, such as



* INTERFACE blocks of different types, namely



  * the Digital Video Port (DVP, a parallel data interface)

  * the interface block for the MIPI CSI-2 receiver



* CROP units



* MIPI CSI-2 receiver (not available on all variants): This unit is referred

  to as MIPI CSI HOST in the Rockchip documentation.

  Technically, it is a separate hardware block, but it is strongly coupled to

  the CIF and therefore included here.



* MUX units (not available on all variants) that pass the video data to an

  image signal processor (ISP)



* SCALE units (not available on all variants)



* DMA engines that transfer video data into system memory using a

  double-buffering mechanism called ping-pong mode



* Support for four streams per INTERFACE block (not available on all

  variants), e.g., for MIPI CSI-2 Virtual Channels (VCs)



This document describes the different variants of the CIF, their hardware

layout, as well as their representation in the media controller centric rkcif

device driver, which is located under drivers/media/platform/rockchip/rkcif.



Variants

========



Rockchip PX30 Video Input Processor (VIP)

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



The PX30 Video Input Processor (VIP) features a digital video port that accepts

parallel video data or BT.656.

Since these protocols do not feature multiple streams, the VIP has one DMA

engine that transfers the input video data into system memory.



The rkcif driver represents this hardware variant by exposing one V4L2 subdevice

(the DVP INTERFACE/CROP block) and one V4L2 device (the DVP DMA engine).



Rockchip RK3568 Video Capture (VICAP)

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



The RK3568 Video Capture (VICAP) unit features a digital video port and a MIPI

CSI-2 receiver that can receive video data independently.

The DVP accepts parallel video data, BT.656 and BT.1120.

Since the BT.1120 protocol may feature more than one stream, the RK3568 VICAP

DVP features four DMA engines that can capture different streams.

Similarly, the RK3568 VICAP MIPI CSI-2 receiver features four DMA engines to

handle different Virtual Channels (VCs).



The rkcif driver represents this hardware variant by exposing up the following

V4L2 subdevices:



* rkcif-dvp0: INTERFACE/CROP block for the DVP



and the following video devices:



* rkcif-dvp0-id0: The support for multiple streams on the DVP is not yet

  implemented, as it is hard to find test hardware. Thus, this video device

  represents the first DMA engine of the RK3568 DVP.



.. kernel-figure:: rkcif-rk3568-vicap.dot

    :alt:   Topology of the RK3568 Video Capture (VICAP) unit

    :align: center

Documentation/admin-guide/media/v4l-drivers.rst

+1 −0
Original line number Diff line number Diff line
@@ -26,6 +26,7 @@ Video4Linux (V4L) driver-specific documentation 
	qcom_camss

	raspberrypi-pisp-be

	rcar-fdp1

	rkcif

	rkisp1

	raspberrypi-rp1-cfe

	saa7134

MAINTAINERS

+7 −0
Original line number Diff line number Diff line
@@ -22263,6 +22263,13 @@ S: Maintained 
F:	Documentation/devicetree/bindings/net/can/rockchip,rk3568v2-canfd.yaml

F:	drivers/net/can/rockchip/









ROCKCHIP CAMERA INTERFACE (RKCIF) DRIVER









M:	Mehdi Djait <mehdi.djait@linux.intel.com>









M:	Michael Riesch <michael.riesch@collabora.com>









L:	linux-media@vger.kernel.org









S:	Maintained









F:	Documentation/admin-guide/media/rkcif*

















ROCKCHIP CRYPTO DRIVERS









M:	Corentin Labbe <clabbe@baylibre.com>









L:	linux-crypto@vger.kernel.org