linux-media.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Hans Verkuil <hans.verkuil@cisco.com>,
	Ricardo Ribalda Delgado <ricardo.ribalda@gmail.com>
Subject: [PATCH v4 1/7] media: add glossary.rst with a glossary of terms used at V4L2 spec
Date: Sat, 26 Aug 2017 08:53:19 -0300	[thread overview]
Message-ID: <e529a2ac2346e50c5c314d1f1352d88fdb7180c4.1503747774.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1503747774.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1503747774.git.mchehab@s-opensource.com>

Add a glossary of terms for V4L2, as several concepts are complex
enough to cause misunderstandings.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/media/uapi/v4l/glossary.rst | 98 +++++++++++++++++++++++++++++++
 Documentation/media/uapi/v4l/v4l2.rst     |  1 +
 2 files changed, 99 insertions(+)
 create mode 100644 Documentation/media/uapi/v4l/glossary.rst

diff --git a/Documentation/media/uapi/v4l/glossary.rst b/Documentation/media/uapi/v4l/glossary.rst
new file mode 100644
index 000000000000..e55cd357dad3
--- /dev/null
+++ b/Documentation/media/uapi/v4l/glossary.rst
@@ -0,0 +1,98 @@
+========
+Glossary
+========
+
+.. note::
+
+   This goal of section is to standardize the terms used within the V4L2
+   documentation. It is written incrementally as they're standardized at
+   the V4L2 documentation. So, it is an incomplete Work In Progress.
+
+.. Please keep the glossary entries in alphabetical order
+
+.. glossary::
+
+    Bridge driver
+	 The same as V4L2 main driver.
+
+    Device Node
+	 A character device node at the file system used to control and do
+	 input/output data transfers to a Kernel driver.
+
+    Driver
+	 The part of the Linux Kernel that implements support
+	 for a hardware component.
+
+    Inter-Integrated Circuit - I²C
+	 A  multi-master, multi-slave, packet switched, single-ended,
+	 serial computer bus used to control V4L2 sub-devices
+
+    Hardware component
+	 a subset of the media hardware.
+
+    Hardware peripheral
+	 A group of hardware components that together make a larger
+	 user-facing functional peripheral. For instance the SoC ISP IP
+	 cores and external camera sensors together make a
+	 camera hardware peripheral.
+	 Also known as peripheral.
+
+    Hardware peripheral control
+	 Type of control that it is possible for a V4L2 hardware peripheral.
+
+	 See :ref:`v4l2_hardware_control`.
+
+    Peripheral
+	 The same as hardware peripheral.
+
+    Media Controller
+	 An API used to identify the hardware components.
+
+	 See :ref:`media_controller`.
+
+    MC-centric
+	 V4L2 hardware that requires a Media controller to be controlled.
+
+	 See :ref:`v4l2_hardware_control`.
+
+    SMBus
+	 A subset of I²C, with defines a stricter usage of the bus.
+
+    Serial Peripheral Interface Bus - SPI
+	 Synchronous serial communication interface specification used for
+	 short distance communication, primarily in embedded systems.
+
+    Sub-device hardware components
+	 hardware components that aren't controlled by the
+	 V4L2 main driver.
+
+    V4L2 device node
+	 A device node that it is associated to a V4L2 main driver,
+	 as specified at :ref:`v4l2_device_naming`.
+
+    V4L2 hardware
+	 A hardware used to on a media device supported by the V4L2
+	 subsystem.
+
+    V4L2 hardware control
+	 The type of hardware control that a device supports.
+
+	 See :ref:`v4l2_hardware_control`.
+
+    V4L2 main driver
+	 The V4L2 device driver that implements the main logic to talk with
+	 the V4L2 hardware.
+	 Also known as bridge driver.
+
+	 See :ref:`v4l2_hardware_control`.
+
+    V4L2 sub-device
+	 part of the media hardware that it is implemented by a device
+	 driver that is not part of the main V4L2 driver.
+
+	 See :ref:`subdev`.
+
+    Vdev-centric
+	 V4L2 hardware that it is controlled via V4L2 device nodes.
+
+	 See :ref:`v4l2_hardware_control`.
diff --git a/Documentation/media/uapi/v4l/v4l2.rst b/Documentation/media/uapi/v4l/v4l2.rst
index f52a11c949d3..1ee4b86d18e1 100644
--- a/Documentation/media/uapi/v4l/v4l2.rst
+++ b/Documentation/media/uapi/v4l/v4l2.rst
@@ -31,6 +31,7 @@ This part describes the Video for Linux API version 2 (V4L2 API) specification.
     videodev
     capture-example
     v4l2grab-example
+    glossary
     biblio
 
 
-- 
2.13.3

  reply	other threads:[~2017-08-26 11:53 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-08-26 11:53 [PATCH v4 0/7] document types of hardware control for V4L2 Mauro Carvalho Chehab
2017-08-26 11:53 ` Mauro Carvalho Chehab [this message]
2017-08-28  9:06   ` [PATCH v4 1/7] media: add glossary.rst with a glossary of terms used at V4L2 spec Hans Verkuil
2017-08-26 11:53 ` [PATCH v4 2/7] media: open.rst: better document device node naming Mauro Carvalho Chehab
2017-08-26 11:53 ` [PATCH v4 3/7] media: open.rst: remove the minor number range Mauro Carvalho Chehab
2017-08-28  9:09   ` Hans Verkuil
2017-08-26 11:53 ` [PATCH v4 4/7] media: open.rst: document devnode-centric and mc-centric types Mauro Carvalho Chehab
2017-08-28  9:36   ` Hans Verkuil
2017-08-28 12:43     ` Mauro Carvalho Chehab
2017-08-26 11:53 ` [PATCH v4 5/7] media: open.rst: Adjust some terms to match the glossary Mauro Carvalho Chehab
2017-08-28  9:37   ` Hans Verkuil
2017-08-26 11:53 ` [PATCH v4 6/7] media: videodev2: add a flag for MC-centric devices Mauro Carvalho Chehab
2017-08-28  9:41   ` Hans Verkuil
2017-08-28 13:27     ` V4L2 device node centric - Was: " Mauro Carvalho Chehab
2017-08-26 11:53 ` [PATCH v4 7/7] media: open.rst: add a notice about subdev-API on vdev-centric Mauro Carvalho Chehab
2017-08-28 10:05   ` Hans Verkuil
2017-08-28 10:30     ` Mauro Carvalho Chehab
2017-08-28 10:55       ` Hans Verkuil
2017-08-29  8:31         ` Ramesh Shanmugasundaram
2017-08-29  8:39           ` Hans Verkuil
2017-08-29  9:14             ` 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=e529a2ac2346e50c5c314d1f1352d88fdb7180c4.1503747774.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=hans.verkuil@cisco.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=ricardo.ribalda@gmail.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 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).