All of lore.kernel.org
 help / color / mirror / Atom feed
From: Xavier Roumegue <xavier.roumegue@oss.nxp.com>
To: mchehab@kernel.org, hverkuil-cisco@xs4all.nl,
	stanimir.varbanov@linaro.org, laurent.pinchart@ideasonboard.com,
	tomi.valkeinen@ideasonboard.com, robh+dt@kernel.org,
	nicolas@ndufresne.ca, alexander.stein@ew.tq-group.com
Cc: Xavier Roumegue <xavier.roumegue@oss.nxp.com>,
	linux-media@vger.kernel.org, devicetree@vger.kernel.org
Subject: [PATCH v4 4/9] media: Documentation: dw100: Add user documentation for the DW100 driver
Date: Mon, 28 Mar 2022 16:13:04 +0200	[thread overview]
Message-ID: <20220328141309.177611-5-xavier.roumegue@oss.nxp.com> (raw)
In-Reply-To: <20220328141309.177611-1-xavier.roumegue@oss.nxp.com>

Add user documentation for the DW100 driver.

Signed-off-by: Xavier Roumegue <xavier.roumegue@oss.nxp.com>
---
 .../userspace-api/media/drivers/dw100.rst     | 23 +++++++++++++++++++
 .../userspace-api/media/drivers/index.rst     |  1 +
 2 files changed, 24 insertions(+)
 create mode 100644 Documentation/userspace-api/media/drivers/dw100.rst

diff --git a/Documentation/userspace-api/media/drivers/dw100.rst b/Documentation/userspace-api/media/drivers/dw100.rst
new file mode 100644
index 000000000000..4cd55c75628e
--- /dev/null
+++ b/Documentation/userspace-api/media/drivers/dw100.rst
@@ -0,0 +1,23 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+DW100 dewarp driver
+===========================
+
+The Vivante DW100 Dewarp Processor IP core found on i.MX8MP SoC applies a
+programmable geometrical transformation on input image to correct distorsion
+introduced by lenses.
+
+The transformation function is exposed by the hardware as a grid map with 16x16
+pixel macroblocks indexed using X, Y vertex coordinates. Each x, y coordinate
+register uses 16 bits to record the coordinate address in UQ12.4 fixed point
+format.
+
+The dewarping map can be set from application through a dedicated v4l2 control.
+If not set or invalid, the driver computes an identity map prior to start the
+processing engine. The map is evaluated as invalid if the array size does not
+match the expected size inherited from the destination image resolution.
+
+More details on the DW100 hardware operations can be found in
+*chapter 13.15 DeWarp* of IMX8MP_ reference manuel.
+
+.. _IMX8MP: https://www.nxp.com/webapp/Download?colCode=IMX8MPRM
diff --git a/Documentation/userspace-api/media/drivers/index.rst b/Documentation/userspace-api/media/drivers/index.rst
index 12e3c512d718..8826777321b0 100644
--- a/Documentation/userspace-api/media/drivers/index.rst
+++ b/Documentation/userspace-api/media/drivers/index.rst
@@ -33,6 +33,7 @@ For more details see the file COPYING in the source distribution of Linux.
 
 	ccs
 	cx2341x-uapi
+	dw100
         hantro
 	imx-uapi
 	max2175
-- 
2.35.1


  parent reply	other threads:[~2022-03-28 14:14 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-28 14:13 [PATCH v4 0/9] i.MX8MP DW100 dewarper driver Xavier Roumegue
2022-03-28 14:13 ` [PATCH v4 1/9] videodev2.h: add V4L2_CTRL_FLAG_DYNAMIC_ARRAY Xavier Roumegue
2022-03-28 14:13 ` [PATCH v4 2/9] v4l2-ctrls: add support for dynamically allocated arrays Xavier Roumegue
2022-03-28 14:13 ` [PATCH v4 3/9] vivid: add dynamic array test control Xavier Roumegue
2022-03-28 14:13 ` Xavier Roumegue [this message]
2022-04-25  6:18   ` [PATCH v4 4/9] media: Documentation: dw100: Add user documentation for the DW100 driver Hans Verkuil
2022-04-26 21:26     ` Laurent Pinchart
2022-04-25  6:41   ` Hans Verkuil
2022-03-28 14:13 ` [PATCH v4 5/9] media: v4l: uapi: Add user control base for DW100 controls Xavier Roumegue
2022-04-26 21:10   ` Laurent Pinchart
2022-03-28 14:13 ` [PATCH v4 6/9] media: uapi: Add a control for DW100 driver Xavier Roumegue
2022-04-25  6:57   ` Hans Verkuil
2022-04-25  7:11     ` Laurent Pinchart
2022-04-25  7:38       ` Hans Verkuil
2022-04-26 21:03         ` Xavier Roumegue (OSS)
2022-04-26 21:34     ` Xavier Roumegue (OSS)
2022-04-26 21:44       ` Laurent Pinchart
2022-03-28 14:13 ` [PATCH v4 7/9] media: dt-bindings: media: Add i.MX8MP DW100 binding Xavier Roumegue
2022-03-28 19:32   ` Rob Herring
2022-03-28 14:13 ` [PATCH v4 8/9] media: dw100: Add i.MX8MP dw100 dewarper driver Xavier Roumegue
2022-04-25  7:21   ` Hans Verkuil
2022-03-28 14:13 ` [PATCH v4 9/9] media: MAINTAINERS: add entry for i.MX8MP DW100 v4l2 mem2mem driver Xavier Roumegue
2022-04-26 21:27   ` Laurent Pinchart
2022-04-25  7:25 ` [PATCH v4 0/9] i.MX8MP DW100 dewarper driver Hans Verkuil

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220328141309.177611-5-xavier.roumegue@oss.nxp.com \
    --to=xavier.roumegue@oss.nxp.com \
    --cc=alexander.stein@ew.tq-group.com \
    --cc=devicetree@vger.kernel.org \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=nicolas@ndufresne.ca \
    --cc=robh+dt@kernel.org \
    --cc=stanimir.varbanov@linaro.org \
    --cc=tomi.valkeinen@ideasonboard.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.