Em Mon, 1 Oct 2018 17:20:26 +0200 Hans Verkuil <hverkuil@xxxxxxxxx> escreveu: > On 09/25/2018 09:14 PM, Mauro Carvalho Chehab wrote: > > From: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> > > > > Add a glossary of terms used within the media userspace API > > documentation, as several concepts are complex enough to cause > > misunderstandings. > > > > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx> > > --- > > > > v3: > > - Add SPDX header and dual-license the glossary > > - Make glossary generic enough to be used for all media uAPI documentation; > > - Add a few new items to the glossary, to imply that it covers not only V4L2; > > - Move it to the uAPI document as a hole. > > > > v2: Did some changes based on Sakari's feedback. > > > > Documentation/media/media_uapi.rst | 3 + > > Documentation/media/uapi/glossary.rst | 162 ++++++++++++++++++++++++++ > > 2 files changed, 165 insertions(+) > > create mode 100644 Documentation/media/uapi/glossary.rst > > > > diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst > > index 28eb35a1f965..41f091a26003 100644 > > --- a/Documentation/media/media_uapi.rst > > +++ b/Documentation/media/media_uapi.rst > > @@ -2,6 +2,8 @@ > > > > .. include:: <isonum.txt> > > > > +.. _media_uapi: > > + > > ######################################## > > Linux Media Infrastructure userspace API > > ######################################## > > @@ -31,3 +33,4 @@ License". > > uapi/cec/cec-api > > uapi/gen-errors > > uapi/fdl-appendix > > + uapi/glossary > > diff --git a/Documentation/media/uapi/glossary.rst b/Documentation/media/uapi/glossary.rst > > new file mode 100644 > > index 000000000000..9e2a2b29e8b2 > > --- /dev/null > > +++ b/Documentation/media/uapi/glossary.rst > > @@ -0,0 +1,162 @@ > > +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-or-later > > + > > +.. For GPL-2.0, see LICENSES/preferred/GPL-2.0 > > +.. > > +.. For GFDL-1.1-or-later, see: > > +.. > > +.. Permission is granted to copy, distribute and/or modify this document > > +.. under the terms of the GNU Free Documentation License, Version 1.1 or > > +.. any later version published by the Free Software Foundation, with no > > +.. Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. > > +.. A copy of the license is included at > > +.. Documentation/media/uapi/fdl-appendix.rst. > > + > > +======== > > +Glossary > > +======== > > + > > +.. note:: > > + > > + This goal of section is to standardize the terms used within the media > > + userspace API documentation. It is written incrementally as they are > > + standardized in the media documentation. > > + > > + So, it is a Work In Progress. > > + > > +.. Please keep the glossary entries in alphabetical order > > + > > +.. glossary:: > > + > > + Bridge driver > > + A device driver that implements the main logic to talk with > > + a media hardware. > > s/a // > > > + > > + For V4L2 hardware, this is also known as V4L2 main driver. > > s/as/as the/ > > > + > > + Consumer Electronics Control API > > + An API designed to receive and transmit data via a HDMI > > + CEC interface. > > + > > + See :ref:`cec`. > > + > > + Device Node > > + A character device node in the file system used to control and do > > + input/output data transfers from/to a Kernel driver. > > + > > + Digital TV API - DVB API > > + An API designed to control the media device components related to > > + digital TV, including frontends, demuxes, streaming, conditional > > + access, etc. > > To be added to this glossary in the future: > > - Frontend > - Demux > - Conditional Access Yeah. The idea here is just to place a boilerplate for it. We should in the future add more terms to the glossary. After having the glossary added, it should be reviewed along the other documents. Then, I'll add digital TV specific terms. > > > + > > + See :ref:`dvbapi`. > > + > > + Digital Signal Processor - DSP > > + A specialized microprocessor, with its architecture optimized for > > + the operational needs of digital signal processing. > > + > > + Driver > > + Part of the Linux Kernel that implements support for a hardware > > + component. > > + > > + Field-programmable Gate Array - FPGA > > + A field-programmable gate array (FPGA) is an integrated circuit > > + designed to be configured by a customer or a designer after > > + manufacturing. > > + > > + See https://en.wikipedia.org/wiki/Field-programmable_gate_array. > > + > > + Inter-Integrated Circuit - I²C > > + A multi-master, multi-slave, packet switched, single-ended, > > + serial computer bus used to control some hardware components > > + like sub-device hardware components. > > + > > + See http://www.nxp.com/docs/en/user-guide/UM10204.pdf. > > + > > + Integrated circuit - IC > > + A set of electronic circuits on one small flat piece of > > + semiconductor material, normally silicon. > > + > > + Also known as chip. > > + > > + Intelectual property core - IP block > > Intelectual -> Intellectual > > > + In electronic design a semiconductor intellectual property core, > > + is a reusable unit of logic, cell, or integrated circuit layout > > + design that is the intellectual property of one party. > > + IP cores may be licensed to another party or can be owned > > + and used by a single party alone. > > + > > + See https://en.wikipedia.org/wiki/Semiconductor_intellectual_property_core). > > + > > + Image Signal Processor - ISP > > + A specialised processor that implements a set of algorithms for > > + processing image data. ISPs may implement algorithms for lens > > + shading correction, demosaic, scaling and pixel format conversion > > demosaicing > > > + as well as produce statistics for the use of the control > > + algorithms (e.g. automatic exposure, white balance and focus). > > + > > + Media API > > + A set of userspace APIs used to control a media hardware. > > + > > + See :ref:`media_uapi`. > > + > > + Media Controller > > + An API designed to expose and control devices and sub-devices' > > + relationships to applications. > > I'd rephrase this: > > An API designed to expose and control the relationships between > devices and sub-devices. > > It's an API, so no need to add 'to applications', since that's already > implicit in the name 'API'. > > > + > > + See :ref:`media_controller`. > > + > > + Media Hardware > > + Subset of a hardware that is supported by the Linux Media API. > > s/a/the/ > > > + > > + Includes audio and video capture and playback hardware, > > s/Includes/This includes/ > > > + digital and analog TV, camera sensors, ISPs, remote controllers, > > + codecs, HDMI Consumer Electronics Control, HDMI capture, etc. > > + > > + > > + See :ref:`media_uapi`. > > + > > + > > + Microprocessor > > + An electronic circuitry that carries out the instructions > > s/An electronic/Electronic/ > > > + of a computer program by performing the basic arithmetic, logical, > > + control and input/output (I/O) operations specified by the > > + instructions on a single integrated circuit. > > + > > + Remote Controller API > > + An API designed to receive and transmit data from remote > > + controllers. > > + > > + See :ref:`remote_controllers`. > > + > > + SMBus > > + A subset of I²C, with defines a stricter usage of the bus. > > with -> which > > > + > > + Serial Peripheral Interface Bus - SPI > > + Synchronous serial communication interface specification used for > > + short distance communication, primarily in embedded systems. > > + > > + System on a Chip - SoC > > + An integrated circuit that integrates all components of a computer > > + or other electronic systems. > > + > > + Sub-device hardware components > > + V4L2 hardware components that aren't controlled by a > > + V4L2 main driver. > > + > > + V4L2 userspace API - V4L2 API > > + The userspace API defined at :ref:`v4l2spec`, with is used to control > > with -> which > > > + a V4L2 hardware. > > + > > + V4L2 hardware > > + Part of a media hardware with is supported by the V4L2 > > with -> which > > > + userspace API. > > + > > + V4L2 main driver > > + A V4L2 device driver that implements the main logic to talk with > > + a V4L2 hardware. > > s/a// > > > + > > + V4L2 sub-device > > + Part of a media hardware that it is implemented by a device > > s/a/the/ > s/it// > > > + driver that is not part of the main V4L2 driver. > > + > > + See :ref:`subdev`. > > > > Regards, > > Hans Except for the Digital TV new terms, all suggestions accepted. I'm enclosing the diff against v3. Thanks, Mauro - diff --git a/Documentation/media/uapi/glossary.rst b/Documentation/media/uapi/glossary.rst index 9e2a2b29e8b2..4307decd345f 100644 --- a/Documentation/media/uapi/glossary.rst +++ b/Documentation/media/uapi/glossary.rst @@ -29,9 +29,9 @@ Glossary Bridge driver A device driver that implements the main logic to talk with - a media hardware. + media hardware. - For V4L2 hardware, this is also known as V4L2 main driver. + For V4L2 hardware, this is also known as the V4L2 main driver. Consumer Electronics Control API An API designed to receive and transmit data via a HDMI @@ -78,7 +78,7 @@ Glossary Also known as chip. - Intelectual property core - IP block + Intellectual property core - IP block In electronic design a semiconductor intellectual property core, is a reusable unit of logic, cell, or integrated circuit layout design that is the intellectual property of one party. @@ -90,7 +90,7 @@ Glossary Image Signal Processor - ISP A specialised processor that implements a set of algorithms for processing image data. ISPs may implement algorithms for lens - shading correction, demosaic, scaling and pixel format conversion + shading correction, demosaicing, scaling and pixel format conversion as well as produce statistics for the use of the control algorithms (e.g. automatic exposure, white balance and focus). @@ -100,15 +100,15 @@ Glossary See :ref:`media_uapi`. Media Controller - An API designed to expose and control devices and sub-devices' - relationships to applications. + An API designed to expose and control the relationships between + devices and sub-devices. See :ref:`media_controller`. Media Hardware - Subset of a hardware that is supported by the Linux Media API. + Subset of the hardware that is supported by the Linux Media API. - Includes audio and video capture and playback hardware, + This includes audio and video capture and playback hardware, digital and analog TV, camera sensors, ISPs, remote controllers, codecs, HDMI Consumer Electronics Control, HDMI capture, etc. @@ -117,8 +117,8 @@ Glossary Microprocessor - An electronic circuitry that carries out the instructions - of a computer program by performing the basic arithmetic, logical, + Electronic circuitry that carries out the instructions of a + computer program by performing the basic arithmetic, logical, control and input/output (I/O) operations specified by the instructions on a single integrated circuit. @@ -129,7 +129,7 @@ Glossary See :ref:`remote_controllers`. SMBus - A subset of I²C, with defines a stricter usage of the bus. + A subset of I²C, whith defines a stricter usage of the bus. Serial Peripheral Interface Bus - SPI Synchronous serial communication interface specification used for @@ -144,19 +144,19 @@ Glossary V4L2 main driver. V4L2 userspace API - V4L2 API - The userspace API defined at :ref:`v4l2spec`, with is used to control - a V4L2 hardware. + The userspace API defined at :ref:`v4l2spec`, whith is used to + control a V4L2 hardware. V4L2 hardware - Part of a media hardware with is supported by the V4L2 - userspace API. + Part of a media hardware with is supported by the V4L2 + userspace API. V4L2 main driver A V4L2 device driver that implements the main logic to talk with - a V4L2 hardware. + V4L2 hardware. V4L2 sub-device - Part of a media hardware that it is implemented by a device + Part of the media hardware that is implemented by a device driver that is not part of the main V4L2 driver. See :ref:`subdev`.
