* [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1
@ 2020-08-18 10:27 Dafna Hirschfeld
2020-08-18 10:27 ` [PATCH v2 1/2] media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata formats in pixfmt-meta-rkisp1.rst Dafna Hirschfeld
` (2 more replies)
0 siblings, 3 replies; 7+ messages in thread
From: Dafna Hirschfeld @ 2020-08-18 10:27 UTC (permalink / raw)
To: linux-media
Cc: laurent.pinchart, dafna.hirschfeld, helen.koike, ezequiel,
hverkuil, kernel, dafna3, sakari.ailus, linux-rockchip, mchehab,
tfiga
Two patches that document the rkisp1 driver in the Documentation
directory.
patch 1 adds documentation to the specific metadata formats
used by the driver.
patch 2 adds a documentation of the driver.
The documentation assumes that the patchsets:
"v4l2: add support for colorspace conversion API (CSC) for video capture and subdevices"
https://patchwork.kernel.org/project/linux-media/list/?series=334393
"media: staging: rkisp1: add support to V4L2_CAP_IO_MC"
https://patchwork.kernel.org/cover/11680993/
were accepted and it documents the features that those patchsets add.
changes from v1:
----------------
- limit lines within 80 chars
- rephrasing and fixing issues due to comments
Dafna Hirschfeld (2):
media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata
formats in pixfmt-meta-rkisp1.rst
media: admin-guide: add documentation file rkisp1.rst
Documentation/admin-guide/media/rkisp1.dot | 18 ++
Documentation/admin-guide/media/rkisp1.rst | 181 ++++++++++++++++++
.../admin-guide/media/v4l-drivers.rst | 1 +
.../userspace-api/media/v4l/meta-formats.rst | 1 +
.../media/v4l/pixfmt-meta-rkisp1.rst | 49 +++++
.../uapi/v4l/pixfmt-meta-rkisp1-params.rst | 23 ---
.../uapi/v4l/pixfmt-meta-rkisp1-stat.rst | 22 ---
7 files changed, 250 insertions(+), 45 deletions(-)
create mode 100644 Documentation/admin-guide/media/rkisp1.dot
create mode 100644 Documentation/admin-guide/media/rkisp1.rst
create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
--
2.17.1
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH v2 1/2] media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata formats in pixfmt-meta-rkisp1.rst
2020-08-18 10:27 [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Dafna Hirschfeld
@ 2020-08-18 10:27 ` Dafna Hirschfeld
2020-08-25 13:04 ` Helen Koike
2020-08-18 10:27 ` [PATCH v2 2/2] media: admin-guide: add documentation file rkisp1.rst Dafna Hirschfeld
2020-09-17 10:52 ` [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Hans Verkuil
2 siblings, 1 reply; 7+ messages in thread
From: Dafna Hirschfeld @ 2020-08-18 10:27 UTC (permalink / raw)
To: linux-media
Cc: laurent.pinchart, dafna.hirschfeld, helen.koike, ezequiel,
hverkuil, kernel, dafna3, sakari.ailus, linux-rockchip, mchehab,
tfiga
The metadata formats V4L2_META_FMT_RK_ISP1_PARAMS,
V4L2_META_FMT_RK_ISP1_STAT_3A are currently described in
two files under
drivers/staging/media/rkisp1/Documentation/media/uapi/v4l
This patch moves the description to one file:
Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
The patch also extends the description and adds the rst file to
toctree.
Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
---
.../userspace-api/media/v4l/meta-formats.rst | 1 +
.../media/v4l/pixfmt-meta-rkisp1.rst | 49 +++++++++++++++++++
.../uapi/v4l/pixfmt-meta-rkisp1-params.rst | 23 ---------
.../uapi/v4l/pixfmt-meta-rkisp1-stat.rst | 22 ---------
4 files changed, 50 insertions(+), 45 deletions(-)
create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
diff --git a/Documentation/userspace-api/media/v4l/meta-formats.rst b/Documentation/userspace-api/media/v4l/meta-formats.rst
index 7dcc4bacbb0c..55a635534bc9 100644
--- a/Documentation/userspace-api/media/v4l/meta-formats.rst
+++ b/Documentation/userspace-api/media/v4l/meta-formats.rst
@@ -21,6 +21,7 @@ These formats are used for the :ref:`metadata` interface only.
pixfmt-meta-d4xx
pixfmt-meta-intel-ipu3
+ pixfmt-meta-rkisp1
pixfmt-meta-uvc
pixfmt-meta-vsp1-hgo
pixfmt-meta-vsp1-hgt
diff --git a/Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
new file mode 100644
index 000000000000..7e43837ed260
--- /dev/null
+++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. _v4l2-meta-fmt-params-rkisp1:
+.. _v4l2-meta-fmt-stat-rkisp1:
+
+*****************************************************************************
+V4L2_META_FMT_RK_ISP1_PARAMS ('rk1p'), V4L2_META_FMT_RK_ISP1_STAT_3A ('rk1s')
+*****************************************************************************
+
+Configuration parameters
+========================
+
+The configuration parameters are passed to the
+:ref:`rkisp1_params <rkisp1_params>` metadata output video node, using
+the :c:type:`v4l2_meta_format` interface. The buffer contains
+a single instance of the C structure :c:type:`rkisp1_params_cfg` defined in
+``rkisp1-config.h``. So the structure can be obtained from the buffer by:
+
+.. code-block:: c
+
+ struct rkisp1_params_cfg *params = (struct rkisp1_params_cfg*) buffer;
+
+.. rkisp1_stat_buffer
+
+3A and histogram statistics
+===========================
+
+The ISP1 device collects different statistics over an input Bayer frame.
+Those statistics are obtained from the :ref:`rkisp1_stats <rkisp1_stats>`
+metadata capture video node,
+using the :c:type:`v4l2_meta_format` interface. The buffer contains a single
+instance of the C structure :c:type:`rkisp1_stat_buffer` defined in
+``rkisp1-config.h``. So the structure can be obtained from the buffer by:
+
+.. code-block:: c
+
+ struct rkisp1_stat_buffer *stats = (struct rkisp1_stat_buffer*) buffer;
+
+The statistics collected are Exposure, AWB (Auto-white balance), Histogram and
+AF (Auto-focus). See :c:type:`rkisp1_stat_buffer` for details of the statistics.
+
+The 3A statistics and configuration parameters described here are usually
+consumed and produced by dedicated user space libraries that comprise the
+important tuning tools using software control loop.
+
+rkisp1 uAPI data types
+======================
+
+.. kernel-doc:: drivers/staging/media/rkisp1/uapi/rkisp1-config.h
diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
deleted file mode 100644
index 32034e481357..000000000000
--- a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
-
-.. _v4l2-meta-fmt-rkisp1-params:
-
-============================
-V4L2_META_FMT_RK_ISP1_PARAMS
-============================
-
-Rockchip ISP1 Parameters Data
-
-Description
-===========
-
-This format describes input parameters for the Rockchip ISP1.
-
-It uses c-struct :c:type:`rkisp1_params_cfg`, which is defined in
-the ``linux/rkisp1-config.h`` header file.
-
-The parameters consist of multiple modules.
-The module won't be updated if the corresponding bit was not set in module_*_update.
-
-.. kernel-doc:: include/uapi/linux/rkisp1-config.h
- :functions: rkisp1_params_cfg
diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
deleted file mode 100644
index 4ad303f96421..000000000000
--- a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
-
-.. _v4l2-meta-fmt-rkisp1-stat:
-
-=============================
-V4L2_META_FMT_RK_ISP1_STAT_3A
-=============================
-
-
-Rockchip ISP1 Statistics Data
-
-Description
-===========
-
-This format describes image color statistics information generated by the Rockchip
-ISP1.
-
-It uses c-struct :c:type:`rkisp1_stat_buffer`, which is defined in
-the ``linux/rkisp1-config.h`` header file.
-
-.. kernel-doc:: include/uapi/linux/rkisp1-config.h
- :functions: rkisp1_stat_buffer
--
2.17.1
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [PATCH v2 2/2] media: admin-guide: add documentation file rkisp1.rst
2020-08-18 10:27 [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Dafna Hirschfeld
2020-08-18 10:27 ` [PATCH v2 1/2] media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata formats in pixfmt-meta-rkisp1.rst Dafna Hirschfeld
@ 2020-08-18 10:27 ` Dafna Hirschfeld
2020-08-25 13:04 ` Helen Koike
2020-09-17 10:52 ` [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Hans Verkuil
2 siblings, 1 reply; 7+ messages in thread
From: Dafna Hirschfeld @ 2020-08-18 10:27 UTC (permalink / raw)
To: linux-media
Cc: laurent.pinchart, dafna.hirschfeld, helen.koike, ezequiel,
hverkuil, kernel, dafna3, sakari.ailus, linux-rockchip, mchehab,
tfiga
Add the file 'rkisp1.rst' that documents the rkisp1 driver.
Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
---
Documentation/admin-guide/media/rkisp1.dot | 18 ++
Documentation/admin-guide/media/rkisp1.rst | 181 ++++++++++++++++++
.../admin-guide/media/v4l-drivers.rst | 1 +
3 files changed, 200 insertions(+)
create mode 100644 Documentation/admin-guide/media/rkisp1.dot
create mode 100644 Documentation/admin-guide/media/rkisp1.rst
diff --git a/Documentation/admin-guide/media/rkisp1.dot b/Documentation/admin-guide/media/rkisp1.dot
new file mode 100644
index 000000000000..54c1953a6130
--- /dev/null
+++ b/Documentation/admin-guide/media/rkisp1.dot
@@ -0,0 +1,18 @@
+digraph board {
+ rankdir=TB
+ n00000001 [label="{{<port0> 0 | <port1> 1} | rkisp1_isp\n/dev/v4l-subdev0 | {<port2> 2 | <port3> 3}}", shape=Mrecord, style=filled, fillcolor=green]
+ n00000001:port2 -> n00000006:port0
+ n00000001:port2 -> n00000009:port0
+ n00000001:port3 -> n00000014 [style=bold]
+ n00000006 [label="{{<port0> 0} | rkisp1_resizer_mainpath\n/dev/v4l-subdev1 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
+ n00000006:port1 -> n0000000c [style=bold]
+ n00000009 [label="{{<port0> 0} | rkisp1_resizer_selfpath\n/dev/v4l-subdev2 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
+ n00000009:port1 -> n00000010 [style=bold]
+ n0000000c [label="rkisp1_mainpath\n/dev/video0", shape=box, style=filled, fillcolor=yellow]
+ n00000010 [label="rkisp1_selfpath\n/dev/video1", shape=box, style=filled, fillcolor=yellow]
+ n00000014 [label="rkisp1_stats\n/dev/video2", shape=box, style=filled, fillcolor=yellow]
+ n00000018 [label="rkisp1_params\n/dev/video3", shape=box, style=filled, fillcolor=yellow]
+ n00000018 -> n00000001:port1 [style=bold]
+ n0000001c [label="{{} | imx219 4-0010\n/dev/v4l-subdev3 | {<port0> 0}}", shape=Mrecord, style=filled, fillcolor=green]
+ n0000001c:port0 -> n00000001:port0
+}
diff --git a/Documentation/admin-guide/media/rkisp1.rst b/Documentation/admin-guide/media/rkisp1.rst
new file mode 100644
index 000000000000..42e37ed255f6
--- /dev/null
+++ b/Documentation/admin-guide/media/rkisp1.rst
@@ -0,0 +1,181 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. include:: <isonum.txt>
+
+=========================================
+Rockchip Image Signal Processor (rkisp1)
+=========================================
+
+Introduction
+============
+
+This file documents the driver for the Rockchip ISP1 that is part of RK3288
+and RK3399 SoCs. The driver is located under drivers/staging/media/rkisp1
+and uses the Media-Controller API.
+
+Topology
+========
+.. _rkisp1_topology_graph:
+
+.. kernel-figure:: rkisp1.dot
+ :alt: Diagram of the default media pipeline topology
+ :align: center
+
+
+The driver has 4 video devices:
+
+- rkisp1_mainpath: capture device for retrieving images, usually in higher
+ resolution.
+- rkisp1_selfpath: capture device for retrieving images.
+- rkisp1_stats: a metadata capture device that sends statistics.
+- rkisp1_params: a metadata output device that receives parameters
+ configurations from userspace.
+
+The driver has 3 subdevices:
+
+- rkisp1_resizer_mainpath: used to resize and downsample frames for the
+ mainpath capture device.
+- rkisp1_resizer_selfpath: used to resize and downsample frames for the
+ selfpath capture device.
+- rkisp1_isp: is connected to the sensor and is responsible for all the isp
+ operations.
+
+
+rkisp1_mainpath, rkisp1_selfpath - Frames Capture Video Nodes
+-------------------------------------------------------------
+Those are the `mainpath` and `selfpath` capture devices to capture frames.
+Those entities are the DMA engines that write the frames to memory.
+The selfpath video device can capture YUV/RGB formats. Its input is YUV encoded
+stream and it is able to convert it to RGB. The selfpath is not able to
+capture bayer formats.
+The mainpath can capture both bayer and YUV formats but it is not able to
+capture RGB formats.
+Both capture videos support
+the ``V4L2_CAP_IO_MC`` :ref:`capability <device-capabilities>`.
+
+
+rkisp1_resizer_mainpath, rkisp1_resizer_selfpath - Resizers Subdevices Nodes
+----------------------------------------------------------------------------
+Those are resizer entities for the mainpath and the selfpath. Those entities
+can scale the frames up and down and also change the YUV sampling (for example
+YUV4:2:2 -> YUV4:2:0). They also have cropping capability on the sink pad.
+The resizers entities can only operate on YUV:4:2:2 format
+(MEDIA_BUS_FMT_YUYV8_2X8).
+The mainpath capture device supports capturing video in bayer formats. In that
+case the resizer of the mainpath is set to 'bypass' mode - it just forward the
+frame without operating on it.
+
+rkisp1_isp - Image Signal Processing Subdevice Node
+---------------------------------------------------
+This is the isp entity. It is connected to the sensor on sink pad 0 and
+receives the frames using the CSI-2 protocol. It is responsible of configuring
+the CSI-2 protocol. It has a cropping capability on sink pad 0 that is
+connected to the sensor and on source pad 2 connected to the resizer entities.
+Cropping on sink pad 0 defines the image region from the sensor.
+Cropping on source pad 2 defines the region for the Image Stabilizer (IS).
+
+.. _rkisp1_stats:
+
+rkisp1_stats - Statistics Video Node
+------------------------------------
+The statistics video node outputs the 3A (auto focus, auto exposure and auto
+white balance) statistics, and also histogram statistics for the frames that
+are being processed by the rkisp1 to userspace applications.
+Using these data, applications can implement algorithms and re-parameterize
+the driver through the rkisp_params node to improve image quality during a
+video stream.
+The buffer format is defined by struct :c:type:`rkisp1_stat_buffer`, and
+userspace should set
+:ref:`V4L2_META_FMT_RK_ISP1_STAT_3A <v4l2-meta-fmt-stat-rkisp1>` as the
+dataformat.
+
+.. _rkisp1_params:
+
+rkisp1_params - Parameters Video Node
+-------------------------------------
+The rkisp1_params video node receives a set of parameters from userspace
+to be applied to the hardware during a video stream, allowing userspace
+to dynamically modify values such as black level, cross talk corrections
+and others.
+
+The buffer format is defined by struct :c:type:`rkisp1_params_cfg`, and
+userspace should set
+:ref:`V4L2_META_FMT_RK_ISP1_PARAMS <v4l2-meta-fmt-params-rkisp1>` as the
+dataformat.
+
+
+Capturing Video Frames Example
+==============================
+
+In the following example, the sensor connected to pad 0 of 'rkisp1_isp' is
+imx219.
+
+The following commands can be used to capture video from the selfpath video
+node with dimension 900x800 planar format YUV 4:2:2. It uses all cropping
+capabilities possible, (see explanation right below)
+
+.. code-block:: bash
+
+ # set the links
+ "media-ctl" "-d" "platform:rkisp1" "-r"
+ "media-ctl" "-d" "platform:rkisp1" "-l" "'imx219 4-0010':0 -> 'rkisp1_isp':0 [1]"
+ "media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
+ "media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_mainpath':0 [0]"
+
+ # set format for imx219 4-0010:0
+ "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"imx219 4-0010":0 [fmt:SRGGB10_1X10/1640x1232]'
+
+ # set format for rkisp1_isp pads:
+ "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":0 [fmt:SRGGB10_1X10/1640x1232 crop: (0,0)/1600x1200]'
+ "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":2 [fmt:YUYV8_2X8/1600x1200 crop: (0,0)/1500x1100]'
+
+ # set format for rkisp1_resizer_selfpath pads:
+ "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":0 [fmt:YUYV8_2X8/1500x1100 crop: (300,400)/1400x1000]'
+ "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":1 [fmt:YUYV8_2X8/900x800]'
+
+ # set format for rkisp1_selfpath:
+ "v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=900,height=800,"
+ "v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "pixelformat=422P"
+
+ # start streaming:
+ v4l2-ctl "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "10"
+
+
+In the above example the sensor is configured to bayer format:
+`SRGGB10_1X10/1640x1232`. The rkisp1_isp:0 pad should be configured to the
+same mbus format and dimensions as the sensor, otherwise streaming will fail
+with 'EPIPE' error. So it is also configured to `SRGGB10_1X10/1640x1232`.
+In addition, the rkisp1_isp:0 pad is configured to cropping `(0,0)/1600x1200`.
+
+The cropping dimensions are automatically propagated to be the format of the
+isp source pad `rkisp1_isp:2`. Another cropping operation is configured on
+the isp source pad: `(0,0)/1500x1100`.
+
+The resizer's sink pad `rkisp1_resizer_selfpath` should be configured to format
+`YUYV8_2X8/1500x1100` in order to match the format on the other side of the
+link. In addition a cropping `(300,400)/1400x1000` is configured on it.
+
+The source pad of the resizer, `rkisp1_resizer_selfpath:1` is configured to
+format `YUYV8_2X8/900x800`. That means that the resizer first crop a window
+of `(300,400)/1400x100` from the received frame and then scales this window
+to dimension `900x800`.
+
+Note that the above example does not uses the stats-params control loop.
+Therefore the capture frames will not go through the 3A algorithms and
+probably won't have a good quality, and can even look dark and greenish.
+
+Configuring Quantization
+========================
+
+The driver supports limited and full range quantization on YUV formats,
+where limited is the default.
+To switch between one or the other, userspace should use the Colorspace
+Conversion API (CSC) for subdevices on source pad 2 of the
+isp (`rkisp1_isp:2`). The quantization configured on this pad is the
+quantization of the captured video frames on the mainpath and selfpath
+video nodes.
+Note that the resizer and capture entities will always report
+``V4L2_QUANTIZATION_DEFAULT`` even if the quantization is configured to full
+range on `rkisp1_isp:2`. So in order to get the configured quantization,
+application should get it from pad `rkisp1_isp:2`.
+
diff --git a/Documentation/admin-guide/media/v4l-drivers.rst b/Documentation/admin-guide/media/v4l-drivers.rst
index 251cc4ede0b6..9c7ebe2ca3bd 100644
--- a/Documentation/admin-guide/media/v4l-drivers.rst
+++ b/Documentation/admin-guide/media/v4l-drivers.rst
@@ -25,6 +25,7 @@ Video4Linux (V4L) driver-specific documentation
philips
qcom_camss
rcar-fdp1
+ rkisp1
saa7134
si470x
si4713
--
2.17.1
^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH v2 1/2] media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata formats in pixfmt-meta-rkisp1.rst
2020-08-18 10:27 ` [PATCH v2 1/2] media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata formats in pixfmt-meta-rkisp1.rst Dafna Hirschfeld
@ 2020-08-25 13:04 ` Helen Koike
0 siblings, 0 replies; 7+ messages in thread
From: Helen Koike @ 2020-08-25 13:04 UTC (permalink / raw)
To: Dafna Hirschfeld, linux-media
Cc: laurent.pinchart, ezequiel, hverkuil, kernel, dafna3,
sakari.ailus, linux-rockchip, mchehab, tfiga
On 8/18/20 7:27 AM, Dafna Hirschfeld wrote:
> The metadata formats V4L2_META_FMT_RK_ISP1_PARAMS,
> V4L2_META_FMT_RK_ISP1_STAT_3A are currently described in
> two files under
> drivers/staging/media/rkisp1/Documentation/media/uapi/v4l
>
> This patch moves the description to one file:
> Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
> The patch also extends the description and adds the rst file to
> toctree.
>
> Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
lgtm
Acked-by: Helen Koike <helen.koike@collabora.com>
Thanks!
Helen
> ---
> .../userspace-api/media/v4l/meta-formats.rst | 1 +
> .../media/v4l/pixfmt-meta-rkisp1.rst | 49 +++++++++++++++++++
> .../uapi/v4l/pixfmt-meta-rkisp1-params.rst | 23 ---------
> .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst | 22 ---------
> 4 files changed, 50 insertions(+), 45 deletions(-)
> create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
> delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>
> diff --git a/Documentation/userspace-api/media/v4l/meta-formats.rst b/Documentation/userspace-api/media/v4l/meta-formats.rst
> index 7dcc4bacbb0c..55a635534bc9 100644
> --- a/Documentation/userspace-api/media/v4l/meta-formats.rst
> +++ b/Documentation/userspace-api/media/v4l/meta-formats.rst
> @@ -21,6 +21,7 @@ These formats are used for the :ref:`metadata` interface only.
>
> pixfmt-meta-d4xx
> pixfmt-meta-intel-ipu3
> + pixfmt-meta-rkisp1
> pixfmt-meta-uvc
> pixfmt-meta-vsp1-hgo
> pixfmt-meta-vsp1-hgt
> diff --git a/Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
> new file mode 100644
> index 000000000000..7e43837ed260
> --- /dev/null
> +++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
> @@ -0,0 +1,49 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. _v4l2-meta-fmt-params-rkisp1:
> +.. _v4l2-meta-fmt-stat-rkisp1:
> +
> +*****************************************************************************
> +V4L2_META_FMT_RK_ISP1_PARAMS ('rk1p'), V4L2_META_FMT_RK_ISP1_STAT_3A ('rk1s')
> +*****************************************************************************
> +
> +Configuration parameters
> +========================
> +
> +The configuration parameters are passed to the
> +:ref:`rkisp1_params <rkisp1_params>` metadata output video node, using
> +the :c:type:`v4l2_meta_format` interface. The buffer contains
> +a single instance of the C structure :c:type:`rkisp1_params_cfg` defined in
> +``rkisp1-config.h``. So the structure can be obtained from the buffer by:
> +
> +.. code-block:: c
> +
> + struct rkisp1_params_cfg *params = (struct rkisp1_params_cfg*) buffer;
> +
> +.. rkisp1_stat_buffer
> +
> +3A and histogram statistics
> +===========================
> +
> +The ISP1 device collects different statistics over an input Bayer frame.
> +Those statistics are obtained from the :ref:`rkisp1_stats <rkisp1_stats>`
> +metadata capture video node,
> +using the :c:type:`v4l2_meta_format` interface. The buffer contains a single
> +instance of the C structure :c:type:`rkisp1_stat_buffer` defined in
> +``rkisp1-config.h``. So the structure can be obtained from the buffer by:
> +
> +.. code-block:: c
> +
> + struct rkisp1_stat_buffer *stats = (struct rkisp1_stat_buffer*) buffer;
> +
> +The statistics collected are Exposure, AWB (Auto-white balance), Histogram and
> +AF (Auto-focus). See :c:type:`rkisp1_stat_buffer` for details of the statistics.
> +
> +The 3A statistics and configuration parameters described here are usually
> +consumed and produced by dedicated user space libraries that comprise the
> +important tuning tools using software control loop.
> +
> +rkisp1 uAPI data types
> +======================
> +
> +.. kernel-doc:: drivers/staging/media/rkisp1/uapi/rkisp1-config.h
> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> deleted file mode 100644
> index 32034e481357..000000000000
> --- a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> +++ /dev/null
> @@ -1,23 +0,0 @@
> -.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> -
> -.. _v4l2-meta-fmt-rkisp1-params:
> -
> -============================
> -V4L2_META_FMT_RK_ISP1_PARAMS
> -============================
> -
> -Rockchip ISP1 Parameters Data
> -
> -Description
> -===========
> -
> -This format describes input parameters for the Rockchip ISP1.
> -
> -It uses c-struct :c:type:`rkisp1_params_cfg`, which is defined in
> -the ``linux/rkisp1-config.h`` header file.
> -
> -The parameters consist of multiple modules.
> -The module won't be updated if the corresponding bit was not set in module_*_update.
> -
> -.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> - :functions: rkisp1_params_cfg
> diff --git a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst b/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> deleted file mode 100644
> index 4ad303f96421..000000000000
> --- a/drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
> +++ /dev/null
> @@ -1,22 +0,0 @@
> -.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> -
> -.. _v4l2-meta-fmt-rkisp1-stat:
> -
> -=============================
> -V4L2_META_FMT_RK_ISP1_STAT_3A
> -=============================
> -
> -
> -Rockchip ISP1 Statistics Data
> -
> -Description
> -===========
> -
> -This format describes image color statistics information generated by the Rockchip
> -ISP1.
> -
> -It uses c-struct :c:type:`rkisp1_stat_buffer`, which is defined in
> -the ``linux/rkisp1-config.h`` header file.
> -
> -.. kernel-doc:: include/uapi/linux/rkisp1-config.h
> - :functions: rkisp1_stat_buffer
>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v2 2/2] media: admin-guide: add documentation file rkisp1.rst
2020-08-18 10:27 ` [PATCH v2 2/2] media: admin-guide: add documentation file rkisp1.rst Dafna Hirschfeld
@ 2020-08-25 13:04 ` Helen Koike
0 siblings, 0 replies; 7+ messages in thread
From: Helen Koike @ 2020-08-25 13:04 UTC (permalink / raw)
To: Dafna Hirschfeld, linux-media
Cc: laurent.pinchart, ezequiel, hverkuil, kernel, dafna3,
sakari.ailus, linux-rockchip, mchehab, tfiga
On 8/18/20 7:27 AM, Dafna Hirschfeld wrote:
> Add the file 'rkisp1.rst' that documents the rkisp1 driver.
>
> Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
lgtm
Acked-by: Helen Koike <helen.koike@collabora.com>
Thanks!
Helen
> ---
> Documentation/admin-guide/media/rkisp1.dot | 18 ++
> Documentation/admin-guide/media/rkisp1.rst | 181 ++++++++++++++++++
> .../admin-guide/media/v4l-drivers.rst | 1 +
> 3 files changed, 200 insertions(+)
> create mode 100644 Documentation/admin-guide/media/rkisp1.dot
> create mode 100644 Documentation/admin-guide/media/rkisp1.rst
>
> diff --git a/Documentation/admin-guide/media/rkisp1.dot b/Documentation/admin-guide/media/rkisp1.dot
> new file mode 100644
> index 000000000000..54c1953a6130
> --- /dev/null
> +++ b/Documentation/admin-guide/media/rkisp1.dot
> @@ -0,0 +1,18 @@
> +digraph board {
> + rankdir=TB
> + n00000001 [label="{{<port0> 0 | <port1> 1} | rkisp1_isp\n/dev/v4l-subdev0 | {<port2> 2 | <port3> 3}}", shape=Mrecord, style=filled, fillcolor=green]
> + n00000001:port2 -> n00000006:port0
> + n00000001:port2 -> n00000009:port0
> + n00000001:port3 -> n00000014 [style=bold]
> + n00000006 [label="{{<port0> 0} | rkisp1_resizer_mainpath\n/dev/v4l-subdev1 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
> + n00000006:port1 -> n0000000c [style=bold]
> + n00000009 [label="{{<port0> 0} | rkisp1_resizer_selfpath\n/dev/v4l-subdev2 | {<port1> 1}}", shape=Mrecord, style=filled, fillcolor=green]
> + n00000009:port1 -> n00000010 [style=bold]
> + n0000000c [label="rkisp1_mainpath\n/dev/video0", shape=box, style=filled, fillcolor=yellow]
> + n00000010 [label="rkisp1_selfpath\n/dev/video1", shape=box, style=filled, fillcolor=yellow]
> + n00000014 [label="rkisp1_stats\n/dev/video2", shape=box, style=filled, fillcolor=yellow]
> + n00000018 [label="rkisp1_params\n/dev/video3", shape=box, style=filled, fillcolor=yellow]
> + n00000018 -> n00000001:port1 [style=bold]
> + n0000001c [label="{{} | imx219 4-0010\n/dev/v4l-subdev3 | {<port0> 0}}", shape=Mrecord, style=filled, fillcolor=green]
> + n0000001c:port0 -> n00000001:port0
> +}
> diff --git a/Documentation/admin-guide/media/rkisp1.rst b/Documentation/admin-guide/media/rkisp1.rst
> new file mode 100644
> index 000000000000..42e37ed255f6
> --- /dev/null
> +++ b/Documentation/admin-guide/media/rkisp1.rst
> @@ -0,0 +1,181 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. include:: <isonum.txt>
> +
> +=========================================
> +Rockchip Image Signal Processor (rkisp1)
> +=========================================
> +
> +Introduction
> +============
> +
> +This file documents the driver for the Rockchip ISP1 that is part of RK3288
> +and RK3399 SoCs. The driver is located under drivers/staging/media/rkisp1
> +and uses the Media-Controller API.
> +
> +Topology
> +========
> +.. _rkisp1_topology_graph:
> +
> +.. kernel-figure:: rkisp1.dot
> + :alt: Diagram of the default media pipeline topology
> + :align: center
> +
> +
> +The driver has 4 video devices:
> +
> +- rkisp1_mainpath: capture device for retrieving images, usually in higher
> + resolution.
> +- rkisp1_selfpath: capture device for retrieving images.
> +- rkisp1_stats: a metadata capture device that sends statistics.
> +- rkisp1_params: a metadata output device that receives parameters
> + configurations from userspace.
> +
> +The driver has 3 subdevices:
> +
> +- rkisp1_resizer_mainpath: used to resize and downsample frames for the
> + mainpath capture device.
> +- rkisp1_resizer_selfpath: used to resize and downsample frames for the
> + selfpath capture device.
> +- rkisp1_isp: is connected to the sensor and is responsible for all the isp
> + operations.
> +
> +
> +rkisp1_mainpath, rkisp1_selfpath - Frames Capture Video Nodes
> +-------------------------------------------------------------
> +Those are the `mainpath` and `selfpath` capture devices to capture frames.
> +Those entities are the DMA engines that write the frames to memory.
> +The selfpath video device can capture YUV/RGB formats. Its input is YUV encoded
> +stream and it is able to convert it to RGB. The selfpath is not able to
> +capture bayer formats.
> +The mainpath can capture both bayer and YUV formats but it is not able to
> +capture RGB formats.
> +Both capture videos support
> +the ``V4L2_CAP_IO_MC`` :ref:`capability <device-capabilities>`.
> +
> +
> +rkisp1_resizer_mainpath, rkisp1_resizer_selfpath - Resizers Subdevices Nodes
> +----------------------------------------------------------------------------
> +Those are resizer entities for the mainpath and the selfpath. Those entities
> +can scale the frames up and down and also change the YUV sampling (for example
> +YUV4:2:2 -> YUV4:2:0). They also have cropping capability on the sink pad.
> +The resizers entities can only operate on YUV:4:2:2 format
> +(MEDIA_BUS_FMT_YUYV8_2X8).
> +The mainpath capture device supports capturing video in bayer formats. In that
> +case the resizer of the mainpath is set to 'bypass' mode - it just forward the
> +frame without operating on it.
> +
> +rkisp1_isp - Image Signal Processing Subdevice Node
> +---------------------------------------------------
> +This is the isp entity. It is connected to the sensor on sink pad 0 and
> +receives the frames using the CSI-2 protocol. It is responsible of configuring
> +the CSI-2 protocol. It has a cropping capability on sink pad 0 that is
> +connected to the sensor and on source pad 2 connected to the resizer entities.
> +Cropping on sink pad 0 defines the image region from the sensor.
> +Cropping on source pad 2 defines the region for the Image Stabilizer (IS).
> +
> +.. _rkisp1_stats:
> +
> +rkisp1_stats - Statistics Video Node
> +------------------------------------
> +The statistics video node outputs the 3A (auto focus, auto exposure and auto
> +white balance) statistics, and also histogram statistics for the frames that
> +are being processed by the rkisp1 to userspace applications.
> +Using these data, applications can implement algorithms and re-parameterize
> +the driver through the rkisp_params node to improve image quality during a
> +video stream.
> +The buffer format is defined by struct :c:type:`rkisp1_stat_buffer`, and
> +userspace should set
> +:ref:`V4L2_META_FMT_RK_ISP1_STAT_3A <v4l2-meta-fmt-stat-rkisp1>` as the
> +dataformat.
> +
> +.. _rkisp1_params:
> +
> +rkisp1_params - Parameters Video Node
> +-------------------------------------
> +The rkisp1_params video node receives a set of parameters from userspace
> +to be applied to the hardware during a video stream, allowing userspace
> +to dynamically modify values such as black level, cross talk corrections
> +and others.
> +
> +The buffer format is defined by struct :c:type:`rkisp1_params_cfg`, and
> +userspace should set
> +:ref:`V4L2_META_FMT_RK_ISP1_PARAMS <v4l2-meta-fmt-params-rkisp1>` as the
> +dataformat.
> +
> +
> +Capturing Video Frames Example
> +==============================
> +
> +In the following example, the sensor connected to pad 0 of 'rkisp1_isp' is
> +imx219.
> +
> +The following commands can be used to capture video from the selfpath video
> +node with dimension 900x800 planar format YUV 4:2:2. It uses all cropping
> +capabilities possible, (see explanation right below)
> +
> +.. code-block:: bash
> +
> + # set the links
> + "media-ctl" "-d" "platform:rkisp1" "-r"
> + "media-ctl" "-d" "platform:rkisp1" "-l" "'imx219 4-0010':0 -> 'rkisp1_isp':0 [1]"
> + "media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_selfpath':0 [1]"
> + "media-ctl" "-d" "platform:rkisp1" "-l" "'rkisp1_isp':2 -> 'rkisp1_resizer_mainpath':0 [0]"
> +
> + # set format for imx219 4-0010:0
> + "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"imx219 4-0010":0 [fmt:SRGGB10_1X10/1640x1232]'
> +
> + # set format for rkisp1_isp pads:
> + "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":0 [fmt:SRGGB10_1X10/1640x1232 crop: (0,0)/1600x1200]'
> + "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_isp":2 [fmt:YUYV8_2X8/1600x1200 crop: (0,0)/1500x1100]'
> +
> + # set format for rkisp1_resizer_selfpath pads:
> + "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":0 [fmt:YUYV8_2X8/1500x1100 crop: (300,400)/1400x1000]'
> + "media-ctl" "-d" "platform:rkisp1" "--set-v4l2" '"rkisp1_resizer_selfpath":1 [fmt:YUYV8_2X8/900x800]'
> +
> + # set format for rkisp1_selfpath:
> + "v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "width=900,height=800,"
> + "v4l2-ctl" "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "-v" "pixelformat=422P"
> +
> + # start streaming:
> + v4l2-ctl "-z" "platform:rkisp1" "-d" "rkisp1_selfpath" "--stream-mmap" "--stream-count" "10"
> +
> +
> +In the above example the sensor is configured to bayer format:
> +`SRGGB10_1X10/1640x1232`. The rkisp1_isp:0 pad should be configured to the
> +same mbus format and dimensions as the sensor, otherwise streaming will fail
> +with 'EPIPE' error. So it is also configured to `SRGGB10_1X10/1640x1232`.
> +In addition, the rkisp1_isp:0 pad is configured to cropping `(0,0)/1600x1200`.
> +
> +The cropping dimensions are automatically propagated to be the format of the
> +isp source pad `rkisp1_isp:2`. Another cropping operation is configured on
> +the isp source pad: `(0,0)/1500x1100`.
> +
> +The resizer's sink pad `rkisp1_resizer_selfpath` should be configured to format
> +`YUYV8_2X8/1500x1100` in order to match the format on the other side of the
> +link. In addition a cropping `(300,400)/1400x1000` is configured on it.
> +
> +The source pad of the resizer, `rkisp1_resizer_selfpath:1` is configured to
> +format `YUYV8_2X8/900x800`. That means that the resizer first crop a window
> +of `(300,400)/1400x100` from the received frame and then scales this window
> +to dimension `900x800`.
> +
> +Note that the above example does not uses the stats-params control loop.
> +Therefore the capture frames will not go through the 3A algorithms and
> +probably won't have a good quality, and can even look dark and greenish.
> +
> +Configuring Quantization
> +========================
> +
> +The driver supports limited and full range quantization on YUV formats,
> +where limited is the default.
> +To switch between one or the other, userspace should use the Colorspace
> +Conversion API (CSC) for subdevices on source pad 2 of the
> +isp (`rkisp1_isp:2`). The quantization configured on this pad is the
> +quantization of the captured video frames on the mainpath and selfpath
> +video nodes.
> +Note that the resizer and capture entities will always report
> +``V4L2_QUANTIZATION_DEFAULT`` even if the quantization is configured to full
> +range on `rkisp1_isp:2`. So in order to get the configured quantization,
> +application should get it from pad `rkisp1_isp:2`.
> +
> diff --git a/Documentation/admin-guide/media/v4l-drivers.rst b/Documentation/admin-guide/media/v4l-drivers.rst
> index 251cc4ede0b6..9c7ebe2ca3bd 100644
> --- a/Documentation/admin-guide/media/v4l-drivers.rst
> +++ b/Documentation/admin-guide/media/v4l-drivers.rst
> @@ -25,6 +25,7 @@ Video4Linux (V4L) driver-specific documentation
> philips
> qcom_camss
> rcar-fdp1
> + rkisp1
> saa7134
> si470x
> si4713
>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1
2020-08-18 10:27 [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Dafna Hirschfeld
2020-08-18 10:27 ` [PATCH v2 1/2] media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata formats in pixfmt-meta-rkisp1.rst Dafna Hirschfeld
2020-08-18 10:27 ` [PATCH v2 2/2] media: admin-guide: add documentation file rkisp1.rst Dafna Hirschfeld
@ 2020-09-17 10:52 ` Hans Verkuil
2020-09-17 15:06 ` Dafna Hirschfeld
2 siblings, 1 reply; 7+ messages in thread
From: Hans Verkuil @ 2020-09-17 10:52 UTC (permalink / raw)
To: Dafna Hirschfeld, linux-media
Cc: laurent.pinchart, helen.koike, ezequiel, kernel, dafna3,
sakari.ailus, linux-rockchip, mchehab, tfiga
On 18/08/2020 12:27, Dafna Hirschfeld wrote:
> Two patches that document the rkisp1 driver in the Documentation
> directory.
>
> patch 1 adds documentation to the specific metadata formats
> used by the driver.
>
> patch 2 adds a documentation of the driver.
>
> The documentation assumes that the patchsets:
>
> "v4l2: add support for colorspace conversion API (CSC) for video capture and subdevices"
> https://patchwork.kernel.org/project/linux-media/list/?series=334393
>
> "media: staging: rkisp1: add support to V4L2_CAP_IO_MC"
> https://patchwork.kernel.org/cover/11680993/
The MAINTAINERS file needs to be updated for these new doc files. Just post a new patch for
this, no need for a v3.
Regards,
Hans
>
> were accepted and it documents the features that those patchsets add.
>
> changes from v1:
> ----------------
> - limit lines within 80 chars
> - rephrasing and fixing issues due to comments
>
> Dafna Hirschfeld (2):
> media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata
> formats in pixfmt-meta-rkisp1.rst
> media: admin-guide: add documentation file rkisp1.rst
>
> Documentation/admin-guide/media/rkisp1.dot | 18 ++
> Documentation/admin-guide/media/rkisp1.rst | 181 ++++++++++++++++++
> .../admin-guide/media/v4l-drivers.rst | 1 +
> .../userspace-api/media/v4l/meta-formats.rst | 1 +
> .../media/v4l/pixfmt-meta-rkisp1.rst | 49 +++++
> .../uapi/v4l/pixfmt-meta-rkisp1-params.rst | 23 ---
> .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst | 22 ---
> 7 files changed, 250 insertions(+), 45 deletions(-)
> create mode 100644 Documentation/admin-guide/media/rkisp1.dot
> create mode 100644 Documentation/admin-guide/media/rkisp1.rst
> create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
> delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
> delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1
2020-09-17 10:52 ` [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Hans Verkuil
@ 2020-09-17 15:06 ` Dafna Hirschfeld
0 siblings, 0 replies; 7+ messages in thread
From: Dafna Hirschfeld @ 2020-09-17 15:06 UTC (permalink / raw)
To: Hans Verkuil, linux-media
Cc: laurent.pinchart, helen.koike, ezequiel, kernel, dafna3,
sakari.ailus, linux-rockchip, mchehab, tfiga
Am 17.09.20 um 12:52 schrieb Hans Verkuil:
> On 18/08/2020 12:27, Dafna Hirschfeld wrote:
>> Two patches that document the rkisp1 driver in the Documentation
>> directory.
>>
>> patch 1 adds documentation to the specific metadata formats
>> used by the driver.
>>
>> patch 2 adds a documentation of the driver.
>>
>> The documentation assumes that the patchsets:
>>
>> "v4l2: add support for colorspace conversion API (CSC) for video capture and subdevices"
>> https://patchwork.kernel.org/project/linux-media/list/?series=334393
>>
>> "media: staging: rkisp1: add support to V4L2_CAP_IO_MC"
>> https://patchwork.kernel.org/cover/11680993/
>
> The MAINTAINERS file needs to be updated for these new doc files. Just post a new patch for
> this, no need for a v3.
Done,
thanks,
Dafna
>
> Regards,
>
> Hans
>
>>
>> were accepted and it documents the features that those patchsets add.
>>
>> changes from v1:
>> ----------------
>> - limit lines within 80 chars
>> - rephrasing and fixing issues due to comments
>>
>> Dafna Hirschfeld (2):
>> media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata
>> formats in pixfmt-meta-rkisp1.rst
>> media: admin-guide: add documentation file rkisp1.rst
>>
>> Documentation/admin-guide/media/rkisp1.dot | 18 ++
>> Documentation/admin-guide/media/rkisp1.rst | 181 ++++++++++++++++++
>> .../admin-guide/media/v4l-drivers.rst | 1 +
>> .../userspace-api/media/v4l/meta-formats.rst | 1 +
>> .../media/v4l/pixfmt-meta-rkisp1.rst | 49 +++++
>> .../uapi/v4l/pixfmt-meta-rkisp1-params.rst | 23 ---
>> .../uapi/v4l/pixfmt-meta-rkisp1-stat.rst | 22 ---
>> 7 files changed, 250 insertions(+), 45 deletions(-)
>> create mode 100644 Documentation/admin-guide/media/rkisp1.dot
>> create mode 100644 Documentation/admin-guide/media/rkisp1.rst
>> create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-meta-rkisp1.rst
>> delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-params.rst
>> delete mode 100644 drivers/staging/media/rkisp1/Documentation/media/uapi/v4l/pixfmt-meta-rkisp1-stat.rst
>>
>
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2020-09-17 15:06 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-18 10:27 [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Dafna Hirschfeld
2020-08-18 10:27 ` [PATCH v2 1/2] media: pixfmt-meta-rkisp1.rst: add description of rkisp1 metadata formats in pixfmt-meta-rkisp1.rst Dafna Hirschfeld
2020-08-25 13:04 ` Helen Koike
2020-08-18 10:27 ` [PATCH v2 2/2] media: admin-guide: add documentation file rkisp1.rst Dafna Hirschfeld
2020-08-25 13:04 ` Helen Koike
2020-09-17 10:52 ` [PATCH v2 0/2] media: admin-guide: add documentation for rkisp1 Hans Verkuil
2020-09-17 15:06 ` Dafna Hirschfeld
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).