linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: dillon.minfei@gmail.com
To: mchehab@kernel.org, mchehab+huawei@kernel.org,
	hverkuil-cisco@xs4all.nl, ezequiel@collabora.com,
	gnurou@gmail.com, pihsun@chromium.org, mcoquelin.stm32@gmail.com,
	alexandre.torgue@foss.st.com, mturquette@baylibre.com,
	sboyd@kernel.org, robh+dt@kernel.org
Cc: patrice.chotard@foss.st.com, hugues.fruchet@foss.st.com,
	linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-stm32@st-md-mailman.stormreply.com,
	linux-arm-kernel@lists.infradead.org, linux-clk@vger.kernel.org,
	devicetree@vger.kernel.org, Dillon Min <dillon.minfei@gmail.com>
Subject: [PATCH v2 7/9] media: docs: add doc for the stm32 dma2d driver
Date: Thu, 15 Jul 2021 17:24:26 +0800	[thread overview]
Message-ID: <1626341068-20253-18-git-send-email-dillon.minfei@gmail.com> (raw)
In-Reply-To: <1626341068-20253-1-git-send-email-dillon.minfei@gmail.com>

From: Dillon Min <dillon.minfei@gmail.com>

add stm32-uapi.rst for stm32's dma2d driver, explain the details of ioctl
V4L2_CID_DMA2D_R2M_MODE, V4L2_CID_DMA2D_R2M_COLOR.

Signed-off-by: Dillon Min <dillon.minfei@gmail.com>
---
v2: introduce the stm32-uapi.rst to explain the detail of dma2d's ioctl.

 .../userspace-api/media/drivers/index.rst          |  1 +
 .../userspace-api/media/drivers/stm32-uapi.rst     | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+)
 create mode 100644 Documentation/userspace-api/media/drivers/stm32-uapi.rst

diff --git a/Documentation/userspace-api/media/drivers/index.rst b/Documentation/userspace-api/media/drivers/index.rst
index 12e3c512d718..ce42915d48f4 100644
--- a/Documentation/userspace-api/media/drivers/index.rst
+++ b/Documentation/userspace-api/media/drivers/index.rst
@@ -38,4 +38,5 @@ For more details see the file COPYING in the source distribution of Linux.
 	max2175
 	meye-uapi
 	omap3isp-uapi
+	stm32-uapi
 	uvcvideo
diff --git a/Documentation/userspace-api/media/drivers/stm32-uapi.rst b/Documentation/userspace-api/media/drivers/stm32-uapi.rst
new file mode 100644
index 000000000000..d7a4f717387d
--- /dev/null
+++ b/Documentation/userspace-api/media/drivers/stm32-uapi.rst
@@ -0,0 +1,22 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+STM32 Chrom-Art 2D Graphics Accelerator unit (DMA2D) driver
+================================================
+
+The DMA2D driver implements the following driver-specific controls:
+
+``V4L2_CID_DMA2D_R2M_MODE``
+-------------------------
+    Enable/Disable the Register-To-Memory mode, filling a part or the
+    whole of a destination image with a specific color.
+
+    1 for enable, 0 for disable.
+
+``V4L2_CID_DMA2D_R2M_COLOR``
+-------------------------------
+    Set the color to fill a part or the whole of a destination image.
+    only used under Register-To-Memory mode, to set the DMA2D_OCOLR register
+    (RED, GREEN, BLUE) which is:
+
+    31 .. 24    23 .. 16  15 .. 8     7 .. 0
+    ALPHA[7:0]  RED[7:0]  GREEN[7:0]  BLUE[7:0]
-- 
2.7.4


  parent reply	other threads:[~2021-07-15  9:25 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-15  9:24 [PATCH v2 0/9] Add support for DMA2D of STMicroelectronics STM32 Soc series dillon.minfei
2021-07-15  9:24 ` [PATCH v2 1/9] media: admin-guide: add stm32-dma2d description dillon.minfei
2021-07-15  9:24 ` [PATCH v2 2/9] media: dt-bindings: media: add document for STM32 DMA2d bindings dillon.minfei
2021-07-15  9:24 ` [PATCH v2 3/9] clk: stm32: Fix ltdc's clock turn off by clk_disable_unused() after kernel startup dillon.minfei
2021-07-15  9:24 ` [PATCH v2 4/9] ARM: dts: stm32: Enable DMA2D support on STM32F429 MCU dillon.minfei
2021-07-15  9:24 ` [PATCH v2 5/9] ARM: dts: stm32: Enable DMA2D on STM32F469-DISCO board dillon.minfei
2021-07-15  9:24 ` [PATCH v2 6/9] media: v4l2-mem2mem: add v4l2_m2m_get_unmapped_area for no-mmu platform dillon.minfei
2021-07-15  9:24 ` [PATCH v2 7/9] media: docs: add doc for the stm32 dma2d driver dillon.minfei
2021-07-15  9:24 ` [PATCH v2 8/9] media: v4l: uapi: Add user control base for stm32 dma2d controls dillon.minfei
2021-07-15  9:24 ` [PATCH v2 9/9] media: stm32-dma2d: STM32 DMA2D driver dillon.minfei
2021-07-15  9:24 ` [PATCH v2 0/9] Add support for DMA2D of STMicroelectronics STM32 Soc series dillon.minfei
2021-07-15  9:24 ` [PATCH v2 1/9] media: admin-guide: add stm32-dma2d description dillon.minfei
2021-07-15  9:24 ` [PATCH v2 2/9] media: dt-bindings: media: add document for STM32 DMA2d bindings dillon.minfei
2021-07-15  9:24 ` [PATCH v2 3/9] clk: stm32: Fix ltdc's clock turn off by clk_disable_unused() after kernel startup dillon.minfei
2021-07-15  9:24 ` [PATCH v2 4/9] ARM: dts: stm32: Enable DMA2D support on STM32F429 MCU dillon.minfei
2021-07-15  9:24 ` [PATCH v2 5/9] ARM: dts: stm32: Enable DMA2D on STM32F469-DISCO board dillon.minfei
2021-07-15  9:24 ` [PATCH v2 6/9] media: v4l2-mem2mem: add v4l2_m2m_get_unmapped_area for no-mmu platform dillon.minfei
2021-07-15  9:24 ` dillon.minfei [this message]
2021-08-09  9:15   ` [PATCH v2 7/9] media: docs: add doc for the stm32 dma2d driver Hans Verkuil
2021-08-10  8:52     ` Dillon Min
2021-07-15  9:24 ` [PATCH v2 8/9] media: v4l: uapi: Add user control base for stm32 dma2d controls dillon.minfei
2021-07-15  9:24 ` [PATCH v2 9/9] media: stm32-dma2d: STM32 DMA2D driver dillon.minfei
2021-08-09  9:09   ` Hans Verkuil
2021-08-10  8:51     ` Dillon Min
2021-08-05  8:59 ` [PATCH v2 0/9] Add support for DMA2D of STMicroelectronics STM32 Soc series Dillon Min

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=1626341068-20253-18-git-send-email-dillon.minfei@gmail.com \
    --to=dillon.minfei@gmail.com \
    --cc=alexandre.torgue@foss.st.com \
    --cc=devicetree@vger.kernel.org \
    --cc=ezequiel@collabora.com \
    --cc=gnurou@gmail.com \
    --cc=hugues.fruchet@foss.st.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-stm32@st-md-mailman.stormreply.com \
    --cc=mchehab+huawei@kernel.org \
    --cc=mchehab@kernel.org \
    --cc=mcoquelin.stm32@gmail.com \
    --cc=mturquette@baylibre.com \
    --cc=patrice.chotard@foss.st.com \
    --cc=pihsun@chromium.org \
    --cc=robh+dt@kernel.org \
    --cc=sboyd@kernel.org \
    --subject='Re: [PATCH v2 7/9] media: docs: add doc for the stm32 dma2d driver' \
    /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

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).