All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Hans Verkuil <hverkuil-cisco@xs4all.nl>,
	Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
	Sakari Ailus <sakari.ailus@linux.intel.com>
Subject: [PATCH v9 4/5] media: glossary.rst: add terms for MC-centric video-node-centric
Date: Fri,  8 May 2020 15:10:36 +0200	[thread overview]
Message-ID: <0c083fffe63499a9ce49d30f3c907668299401f1.1588943181.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1588943181.git.mchehab+huawei@kernel.org>

Now that we have a chapter describing hardware control, let's
add the terms used there to the glossary.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../userspace-api/media/glossary.rst          | 42 ++++++++++++++++---
 1 file changed, 37 insertions(+), 5 deletions(-)

diff --git a/Documentation/userspace-api/media/glossary.rst b/Documentation/userspace-api/media/glossary.rst
index 18a1ace00159..8cdb7900e994 100644
--- a/Documentation/userspace-api/media/glossary.rst
+++ b/Documentation/userspace-api/media/glossary.rst
@@ -69,6 +69,20 @@ Glossary
 
 	See https://en.wikipedia.org/wiki/Field-programmable_gate_array.
 
+    Hardware Component
+	A subset of the :term:`media hardware`. For example an :term:`I²C` or
+	:term:`SPI` device, or an :term:`IP block` inside a
+	:term:`SoC` or :term:`FPGA`.
+
+    Hardware Peripheral
+	A group of :term:`hardware components <hardware component>` that
+	together make a larger user-facing functional peripheral. For
+	instance the :term:`SoC` :term:`ISP` :term:`IP	block <ip block>`
+	and external camera sensors together make a camera hardware
+	peripheral.
+
+	Also known as :term:`peripheral`.
+
     I²C
 	**Inter-Integrated Circuit**
 
@@ -126,6 +140,14 @@ Glossary
 
 	See :ref:`media_controller`.
 
+    MC-Centric
+	:term:`V4L2 hardware` that requires a :term:`MC API`.
+
+	Such hardware have ``V4L2_CAP_IO_MC`` device_caps field unset
+	(see :ref:`VIDIOC_QUERYCAP`).
+
+	See :ref:`v4l2_hardware_control` for more details.
+
     Media Hardware
 	Subset of the hardware that is supported by the Linux Media API.
 
@@ -139,6 +161,9 @@ Glossary
 	control and input/output (I/O) operations specified by the
 	instructions on a single integrated circuit.
 
+    Peripheral
+	The same as :term:`hardware peripheral`.
+
     RC API
 	**Remote Controller API**
 
@@ -168,15 +193,22 @@ Glossary
 	The userspace API defined in :ref:`v4l2spec`, which is used to
 	control a V4L2 hardware.
 
+    V4L2 Device Node
+	A :term:`device node` that is associated to a V4L driver.
+
+	The V4L2 device node naming is specified at :ref:`v4l2_device_naming`.
+
     V4L2 Hardware
 	Part of a media hardware with is supported by the :term:`V4L2 API`.
 
     V4L2 Sub-device
 	V4L2 hardware components that aren't controlled by a
-	:term:`bridge driver`.
+	:term:`bridge driver`. See :ref:`subdev`.
 
-    V4L2 Sub-device API
-	Part of the :term:`V4L2 API` which control
-	:term:`V4L2 sub-devices <V4L2 Sub-device>`.
+    Video-node-Centric
+	V4L2 hardware that doesn't require a media controller to be used.
 
-	See :ref:`subdev`.
+	Such hardware have ``V4L2_CAP_IO_MC`` device_caps field unset
+	(see :ref:`VIDIOC_QUERYCAP`).
+
+	See :ref:`v4l2_hardware_control` for more details.
-- 
2.26.2


  parent reply	other threads:[~2020-05-08 13:10 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-08 13:10 [PATCH v9 0/5] Add a glossary for the media subsystem Mauro Carvalho Chehab
2020-05-08 13:10 ` [PATCH v9 1/5] media: open.rst: better document device node naming Mauro Carvalho Chehab
2020-05-08 13:24   ` Hans Verkuil
2020-05-08 13:35     ` Mauro Carvalho Chehab
2020-05-08 13:55       ` Hans Verkuil
2020-05-08 13:10 ` [PATCH v9 2/5] media: open.rst: remove the minor number range Mauro Carvalho Chehab
2020-05-08 13:10 ` [PATCH v9 3/5] media: docs: add glossary.rst with common terms used at V4L2 spec Mauro Carvalho Chehab
2020-05-08 13:40   ` Hans Verkuil
2020-05-08 14:25     ` Mauro Carvalho Chehab
2020-05-08 14:54       ` Hans Verkuil
2020-05-08 13:10 ` Mauro Carvalho Chehab [this message]
2020-05-08 13:46   ` [PATCH v9 4/5] media: glossary.rst: add terms for MC-centric video-node-centric Hans Verkuil
2020-05-08 14:36     ` Mauro Carvalho Chehab
2020-05-08 13:10 ` [PATCH v9 5/5] media: open.rst: document mc-centric and video-node-centric Mauro Carvalho Chehab
2020-05-08 13:54   ` 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=0c083fffe63499a9ce49d30f3c907668299401f1.1588943181.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-media@vger.kernel.org \
    --cc=sakari.ailus@linux.intel.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.