linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	linux-media@vger.kernel.org
Subject: [PATCH v2 12/22] media: docs: split uAPI info from fimc.rst
Date: Tue, 10 Mar 2020 14:43:03 +0100	[thread overview]
Message-ID: <ecd443e3b29035e1fdd9ebb20a0d8c40ae4cacbb.1583847556.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1583847556.git.mchehab+huawei@kernel.org>

This file contains both driver develompent documentation and
userspace API.

Split on two, as they're usually read by different audiences.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../media/v4l-drivers/fimc-devel.rst          | 33 +++++++++++++++++++
 Documentation/media/v4l-drivers/fimc.rst      | 22 ++-----------
 Documentation/media/v4l-drivers/index.rst     |  1 +
 3 files changed, 36 insertions(+), 20 deletions(-)
 create mode 100644 Documentation/media/v4l-drivers/fimc-devel.rst

diff --git a/Documentation/media/v4l-drivers/fimc-devel.rst b/Documentation/media/v4l-drivers/fimc-devel.rst
new file mode 100644
index 000000000000..956e3a9901f8
--- /dev/null
+++ b/Documentation/media/v4l-drivers/fimc-devel.rst
@@ -0,0 +1,33 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. include:: <isonum.txt>
+
+The Samsung S5P/EXYNOS4 FIMC driver
+===================================
+
+Copyright |copy| 2012 - 2013 Samsung Electronics Co., Ltd.
+
+Files partitioning
+------------------
+
+- media device driver
+
+  drivers/media/platform/exynos4-is/media-dev.[ch]
+
+- camera capture video device driver
+
+  drivers/media/platform/exynos4-is/fimc-capture.c
+
+- MIPI-CSI2 receiver subdev
+
+  drivers/media/platform/exynos4-is/mipi-csis.[ch]
+
+- video post-processor (mem-to-mem)
+
+  drivers/media/platform/exynos4-is/fimc-core.c
+
+- common files
+
+  drivers/media/platform/exynos4-is/fimc-core.h
+  drivers/media/platform/exynos4-is/fimc-reg.h
+  drivers/media/platform/exynos4-is/regs-fimc.h
diff --git a/Documentation/media/v4l-drivers/fimc.rst b/Documentation/media/v4l-drivers/fimc.rst
index 74585ba48b7f..0b8ddc4a3008 100644
--- a/Documentation/media/v4l-drivers/fimc.rst
+++ b/Documentation/media/v4l-drivers/fimc.rst
@@ -38,26 +38,6 @@ Not currently supported
 - LCD writeback input
 - per frame clock gating (mem-to-mem)
 
-Files partitioning
-------------------
-
-- media device driver
-  drivers/media/platform/exynos4-is/media-dev.[ch]
-
-- camera capture video device driver
-  drivers/media/platform/exynos4-is/fimc-capture.c
-
-- MIPI-CSI2 receiver subdev
-  drivers/media/platform/exynos4-is/mipi-csis.[ch]
-
-- video post-processor (mem-to-mem)
-  drivers/media/platform/exynos4-is/fimc-core.c
-
-- common files
-  drivers/media/platform/exynos4-is/fimc-core.h
-  drivers/media/platform/exynos4-is/fimc-reg.h
-  drivers/media/platform/exynos4-is/regs-fimc.h
-
 User space interfaces
 ---------------------
 
@@ -74,6 +54,7 @@ connections of the MIPI-CSIS device(s) to the FIMC entities.
 The media device interface allows to configure the SoC for capturing image
 data from the sensor through more than one FIMC instance (e.g. for simultaneous
 viewfinder and still capture setup).
+
 Reconfiguration is done by enabling/disabling media links created by the driver
 during initialization. The internal device topology can be easily discovered
 through media entity and links enumeration.
@@ -116,6 +97,7 @@ sensor subdev -> mipi-csi subdev -> fimc subdev -> video node
 When we configure these devices through sub-device API at user space, the
 configuration flow must be from left to right, and the video node is
 configured as last one.
+
 When we don't use sub-device user space API the whole configuration of all
 devices belonging to the pipeline is done at the video node driver.
 The sysfs entry allows to instruct the capture node driver not to configure
diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst
index 2d782a40a7b6..adf72937b119 100644
--- a/Documentation/media/v4l-drivers/index.rst
+++ b/Documentation/media/v4l-drivers/index.rst
@@ -70,6 +70,7 @@ For more details see the file COPYING in the source distribution of Linux.
 	cx2341x-devel
 	cx88-devel
 	davinci-vpbe-devel
+	fimc-devel
 	vimc-devel
 
 	cx2341x-uapi
-- 
2.24.1


  parent reply	other threads:[~2020-03-10 13:45 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-10 13:42 [PATCH v2 00/22] Move media documentation files Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 01/22] media: docs: avermedia.rst: mark a table as such Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 02/22] media: docs: move soc-camera.rst to staging Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 03/22] media: docs: split cpia2.rst on two files Mauro Carvalho Chehab
2020-03-12  7:18   ` Hans Verkuil
2020-03-10 13:42 ` [PATCH v2 04/22] media: docs: split ci.rst into uAPI and user guide docs Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 05/22] media: docs: split meye.rst into admin and uAPI docs Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 06/22] media: docs: split vimc.rst into devel and admin parts Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 07/22] media: docs: split development info from bttv.rst Mauro Carvalho Chehab
2020-03-10 13:42 ` [PATCH v2 08/22] media: docs: split development info from cx88.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 09/22] media: docs: split cx2341x.rst into different audiences Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 10/22] media: docs: cx18-streams.c: fix broken references to docs Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 11/22] media: docs: split uAPI info from davinci-vpbe.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` Mauro Carvalho Chehab [this message]
2020-03-10 13:43 ` [PATCH v2 13/22] media: docs: split uAPI info from saa7134-devel.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 14/22] media: docs: split uAPI info from omap3isp.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 15/22] media: docs: split uAPI info from imx.rst Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 17/22] media: docs: kAPI docs: move them to driver-api Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 18/22] media: docs: move fourcc file to the uAPI document Mauro Carvalho Chehab
2020-03-10 13:43 ` [PATCH v2 19/22] media: docs: move user-facing docs to the admin guide Mauro Carvalho Chehab
2020-03-12  7:25   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 20/22] media: docs: move driver-specific info to driver-api Mauro Carvalho Chehab
2020-03-12  7:26   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 21/22] media: docs: add an uAPI chapter for driver-specific stuff Mauro Carvalho Chehab
2020-03-12  7:31   ` Hans Verkuil
2020-03-10 13:43 ` [PATCH v2 22/22] media: docs: get rid of Documentation/media/ Mauro Carvalho Chehab

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=ecd443e3b29035e1fdd9ebb20a0d8c40ae4cacbb.1583847556.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    /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 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).