mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" 

The usage of the term "DVB" at the dvb API docs is confusing,
as, right now, it can refer to either the European digital TV
standard or to the subsystem.

So, prefer calling it as "Digital TV" on most places, to avoid
ambiguity.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2017-09-01 12:28:16 -04:00
parent 0de6357aca
commit 699f19e3f1
41 changed files with 149 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/media/uapi/dvb/audio-channel-select.rst
View File

@ -44,7 +44,7 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
This ioctl call asks the Audio Device to select the requested channel if

8
Documentation/media/uapi/dvb/audio-fclose.rst
View File

@ -2,14 +2,14 @@
.. _audio_fclose:
=================
DVB audio close()
=================
========================
Digital TV audio close()
========================
Name
----
DVB audio close()
Digital TV audio close()
.. attention:: This ioctl is deprecated

8
Documentation/media/uapi/dvb/audio-fopen.rst
View File

@ -2,14 +2,14 @@
.. _audio_fopen:
================
DVB audio open()
================
=======================
Digital TV audio open()
=======================
Name
----
DVB audio open()
Digital TV audio open()
.. attention:: This ioctl is deprecated

8
Documentation/media/uapi/dvb/audio-fwrite.rst
View File

@ -2,14 +2,14 @@
.. _audio_fwrite:
=================
DVB audio write()
=================
=========================
Digital TV audio write()
=========================
Name
----
DVB audio write()
Digital TV audio write()
.. attention:: This ioctl is deprecated

2
Documentation/media/uapi/dvb/audio-set-av-sync.rst
View File

@ -38,7 +38,7 @@ Arguments
- boolean state
- Tells the DVB subsystem if A/V synchronization shall be ON or OFF.
- Tells the Digital TV subsystem if A/V synchronization shall be ON or OFF.
TRUE: AV-sync ON

6
Documentation/media/uapi/dvb/audio-set-bypass-mode.rst
View File

@ -38,7 +38,7 @@ Arguments
- boolean mode
- Enables or disables the decoding of the current Audio stream in
the DVB subsystem.
the Digital TV subsystem.
TRUE: Bypass is disabled
@ -50,8 +50,8 @@ Description
This ioctl call asks the Audio Device to bypass the Audio decoder and
forward the stream without decoding. This mode shall be used if streams
that can’t be handled by the DVB system shall be decoded. Dolby
DigitalTM streams are automatically forwarded by the DVB subsystem if
that can’t be handled by the Digial TV system shall be decoded. Dolby
DigitalTM streams are automatically forwarded by the Digital TV subsystem if
the hardware can handle it.

2
Documentation/media/uapi/dvb/audio-set-mute.rst
View File

@ -48,7 +48,7 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD` with the
``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.

13
Documentation/media/uapi/dvb/audio.rst
View File

@ -2,15 +2,16 @@
.. _dvb_audio:
################
DVB Audio Device
################
The DVB audio device controls the MPEG2 audio decoder of the DVB
hardware. It can be accessed through ``/dev/dvb/adapter?/audio?``. Data
#######################
Digital TV Audio Device
#######################
The Digital TV audio device controls the MPEG2 audio decoder of the Digital
TV hardware. It can be accessed through ``/dev/dvb/adapter?/audio?``. Data
types and and ioctl definitions can be accessed by including
``linux/dvb/audio.h`` in your application.
Please note that some DVB cards don’t have their own MPEG decoder, which
Please note that some Digital TV cards don’t have their own MPEG decoder, which
results in the omission of the audio and video device.
These ioctls were also used by V4L2 to control MPEG decoders implemented

8
Documentation/media/uapi/dvb/ca-fclose.rst
View File

@ -2,14 +2,14 @@
.. _ca_fclose:
==============
DVB CA close()
==============
=====================
Digital TV CA close()
=====================
Name
----
DVB CA close()
Digital TV CA close()
Synopsis

10
Documentation/media/uapi/dvb/ca-fopen.rst
View File

@ -2,14 +2,14 @@
.. _ca_fopen:
=============
DVB CA open()
=============
====================
Digital TV CA open()
====================
Name
----
DVB CA open()
Digital TV CA open()
Synopsis
@ -23,7 +23,7 @@ Arguments
---------
``name``
Name of specific DVB CA device.
Name of specific Digital TV CA device.
``flags``
A bit-wise OR of the following flags:

11
Documentation/media/uapi/dvb/ca.rst
View File

@ -2,11 +2,12 @@
.. _dvb_ca:
#############
DVB CA Device
#############
The DVB CA device controls the conditional access hardware. It can be
accessed through ``/dev/dvb/adapter?/ca?``. Data types and and ioctl
####################
Digital TV CA Device
####################
The Digital TV CA device controls the conditional access hardware. It
can be accessed through ``/dev/dvb/adapter?/ca?``. Data types and and ioctl
definitions can be accessed by including ``linux/dvb/ca.h`` in your
application.

13
Documentation/media/uapi/dvb/demux.rst
View File

@ -2,10 +2,15 @@
.. _dvb_demux:
################
DVB Demux Device
################
The DVB demux device controls the filters of the DVB hardware/software.
#######################
Digital TV Demux Device
#######################
The Digital TV demux device controls the MPEG-TS filters for the
digital TV. If the driver and hardware supports, those filters are
implemented at the hardware. Otherwise, the Kernel provides a software
emulation.
It can be accessed through ``/dev/adapter?/demux?``. Data types and and
ioctl definitions can be accessed by including ``linux/dvb/dmx.h`` in
your application.

8
Documentation/media/uapi/dvb/dmx-fclose.rst
View File

@ -2,14 +2,14 @@
.. _dmx_fclose:
=================
DVB demux close()
=================
========================
Digital TV demux close()
========================
Name
----
DVB demux close()
Digital TV demux close()
Synopsis

10
Documentation/media/uapi/dvb/dmx-fopen.rst
View File

@ -2,14 +2,14 @@
.. _dmx_fopen:
================
DVB demux open()
================
=======================
Digital TV demux open()
=======================
Name
----
DVB demux open()
Digital TV demux open()
Synopsis
@ -22,7 +22,7 @@ Arguments
---------
``name``
Name of specific DVB demux device.
Name of specific Digital TV demux device.
``flags``
A bit-wise OR of the following flags:

8
Documentation/media/uapi/dvb/dmx-fread.rst
View File

@ -2,14 +2,14 @@
.. _dmx_fread:
================
DVB demux read()
================
=======================
Digital TV demux read()
=======================
Name
----
DVB demux read()
Digital TV demux read()
Synopsis

8
Documentation/media/uapi/dvb/dmx-fwrite.rst
View File

@ -2,14 +2,14 @@
.. _dmx_fwrite:
=================
DVB demux write()
=================
========================
Digital TV demux write()
========================
Name
----
DVB demux write()
Digital TV demux write()
Synopsis

25
Documentation/media/uapi/dvb/dvbapi.rst
View File

@ -10,8 +10,21 @@ Part II - Digital TV API
.. note::
This API is also known as **DVB API**, although it is generic
enough to support all digital TV standards.
This API is also known as Linux **DVB API**.
It it was originally written to support the European digital TV
standard (DVB), and later extended to support all digital TV standards.
In order to avoid confusion, within this document, it was opted to refer to
it, and to associated hardware as **Digital TV**.
The word **DVB** is reserved to be used for:
- the Digital TV API version
(e. g. DVB API version 3 or DVB API version 5);
- digital TV data types (enums, structs, defines, etc);
- digital TV device nodes (``/dev/dvb/...``);
- the European DVB standard.
**Version 5.10**
@ -41,11 +54,11 @@ Authors:
- J. K. Metzler, Ralph <rjkm@metzlerbros.de>
- Original author of the DVB API documentation.
- Original author of the Digital TV API documentation.
- O. C. Metzler, Marcus <rjkm@metzlerbros.de>
- Original author of the DVB API documentation.
- Original author of the Digital TV API documentation.
- Carvalho Chehab, Mauro <m.chehab@kernel.org>
@ -63,11 +76,11 @@ Revision History
DocBook improvements and cleanups, in order to document the system calls
on a more standard way and provide more description about the current
DVB API.
Digital TV API.
:revision: 2.0.4 / 2011-05-06 (*mcc*)
Add more information about DVB APIv5, better describing the frontend
Add more information about DVBv5 API, better describing the frontend
GET/SET props ioctl's.

4
Documentation/media/uapi/dvb/dvbproperty.rst
View File

@ -13,7 +13,7 @@ antenna subsystem via Satellite Equipment Control - SEC (on satellite
systems). The actual parameters are specific to each particular digital
TV standards, and may change as the digital TV specs evolves.
In the past (up to DVB API version 3), the strategy used was to have a
In the past (up to DVB API version 3 - DVBv3), the strategy used was to have a
union with the parameters needed to tune for DVB-S, DVB-C, DVB-T and
ATSC delivery systems grouped there. The problem is that, as the second
generation standards appeared, the size of such union was not big
@ -41,7 +41,7 @@ with supports all digital TV delivery systems.
support to new standards and/or new hardware.
3. Nowadays, most frontends support multiple delivery systems.
Only with DVB v5 calls it is possible to switch between
Only with DVB API version 5 calls it is possible to switch between
the multiple delivery systems supported by a frontend.
4. DVB API version 5 is also called *S2API*, as the first

4
Documentation/media/uapi/dvb/examples.rst
View File

@ -6,8 +6,8 @@
Examples
********
In this section we would like to present some examples for using the DVB
API.
In this section we would like to present some examples for using the Digital
TV API.
.. note::

2
Documentation/media/uapi/dvb/fe-diseqc-reset-overload.rst
View File

@ -31,7 +31,7 @@ Description
If the bus has been automatically powered off due to power overload,
this ioctl call restores the power to the bus. The call requires
read/write access to the device. This call has no effect if the device
is manually powered off. Not all DVB adapters support this ioctl.
is manually powered off. Not all Digital TV adapters support this ioctl.
Return Value

5
Documentation/media/uapi/dvb/fe-get-info.rst
View File

@ -9,7 +9,8 @@ ioctl FE_GET_INFO
Name
====
FE_GET_INFO - Query DVB frontend capabilities and returns information about the - front-end. This call only requires read-only access to the device
FE_GET_INFO - Query Digital TV frontend capabilities and returns information
about the - front-end. This call only requires read-only access to the device.
Synopsis
@ -33,7 +34,7 @@ Arguments
Description
===========
All DVB frontend devices support the ``FE_GET_INFO`` ioctl. It is used
All Digital TV frontend devices support the ``FE_GET_INFO`` ioctl. It is used
to identify kernel devices compatible with this specification and to
obtain information about driver and hardware capabilities. The ioctl
takes a pointer to dvb_frontend_info which is filled by the driver.

2
Documentation/media/uapi/dvb/fe-get-property.rst
View File

@ -35,7 +35,7 @@ Arguments
Description
===========
All DVB frontend devices support the ``FE_SET_PROPERTY`` and
All Digital TV frontend devices support the ``FE_SET_PROPERTY`` and
``FE_GET_PROPERTY`` ioctls. The supported properties and statistics
depends on the delivery system and on the device:

2
Documentation/media/uapi/dvb/fe-read-status.rst
View File

@ -33,7 +33,7 @@ Arguments
Description
===========
All DVB frontend devices support the ``FE_READ_STATUS`` ioctl. It is
All Digital TV frontend devices support the ``FE_READ_STATUS`` ioctl. It is
used to check about the locking status of the frontend after being
tuned. The ioctl takes a pointer to an integer where the status will be
written.

4
Documentation/media/uapi/dvb/fe_property_parameters.rst
View File

@ -819,7 +819,7 @@ Possible values are the same as documented on enum
DTV_API_VERSION
===============
Returns the major/minor version of the DVB API
Returns the major/minor version of the Digital TV API
.. _DTV-CODE-RATE-HP:
@ -919,7 +919,7 @@ DTV_STREAM_ID
Used on DVB-S2, DVB-T2 and ISDB-S.
DVB-S2, DVB-T2 and ISDB-S support the transmission of several streams on
a single transport stream. This property enables the DVB driver to
a single transport stream. This property enables the digital TV driver to
handle substream filtering, when supported by the hardware. By default,
substream filtering is disabled.

2
Documentation/media/uapi/dvb/frontend-property-terrestrial-systems.rst
View File

@ -100,7 +100,7 @@ to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible that some
very sophisticated devices won't need certain parameters to tune.
The information given here should help application writers to know how
to handle ISDB-T and ISDB-Tsb hardware using the Linux DVB-API.
to handle ISDB-T and ISDB-Tsb hardware using the Linux Digital TV API.
The details given here about ISDB-T and ISDB-Tsb are just enough to
basically show the dependencies between the needed parameter values, but

10
Documentation/media/uapi/dvb/frontend.rst
View File

@ -2,11 +2,11 @@
.. _dvb_frontend:
################
DVB Frontend API
################
#######################
Digital TV Frontend API
#######################
The DVB frontend API was designed to support three groups of delivery
The Digital TV frontend API was designed to support three groups of delivery
systems: Terrestrial, cable and Satellite. Currently, the following
delivery systems are supported:
@ -17,7 +17,7 @@ delivery systems are supported:
- Satellite systems: DVB-S, DVB-S2, DVB Turbo, ISDB-S, DSS
The DVB frontend controls several sub-devices including:
The Digital TV frontend controls several sub-devices including:
- Tuner

6
Documentation/media/uapi/dvb/frontend_f_close.rst
View File

@ -2,9 +2,9 @@
.. _frontend_f_close:
********************
DVB frontend close()
********************
***************************
Digital TV frontend close()
***************************
Name
====

6
Documentation/media/uapi/dvb/frontend_f_open.rst
View File

@ -2,9 +2,9 @@
.. _frontend_f_open:
*******************
DVB frontend open()
*******************
***************************
Digital TV frontend open()
***************************
Name
====

6
Documentation/media/uapi/dvb/frontend_legacy_dvbv3_api.rst
View File

@ -2,9 +2,9 @@
.. _frontend_legacy_dvbv3_api:
****************************************
DVB Frontend legacy API (a. k. a. DVBv3)
****************************************
***********************************************
Digital TV Frontend legacy API (a. k. a. DVBv3)
***********************************************
The usage of this API is deprecated, as it doesn't support all digital
TV standards, doesn't provide good statistics measurements and provides

18
Documentation/media/uapi/dvb/intro.rst
View File

@ -33,19 +33,19 @@ use ioctl calls. This also includes the knowledge of C or C++.
History
=======
The first API for DVB cards we used at Convergence in late 1999 was an
The first API for Digital TV cards we used at Convergence in late 1999 was an
extension of the Video4Linux API which was primarily developed for frame
grabber cards. As such it was not really well suited to be used for DVB
cards and their new features like recording MPEG streams and filtering
grabber cards. As such it was not really well suited to be used for Digital
TV cards and their new features like recording MPEG streams and filtering
several section and PES data streams at the same time.
In early 2000, Convergence was approached by Nokia with a proposal for a new
standard Linux DVB API. As a commitment to the development of terminals
standard Linux Digital TV API. As a commitment to the development of terminals
based on open standards, Nokia and Convergence made it available to all
Linux developers and published it on https://linuxtv.org in September
2000. With the Linux driver for the Siemens/Hauppauge DVB PCI card,
Convergence provided a first implementation of the Linux DVB API.
Convergence was the maintainer of the Linux DVB API in the early
Convergence provided a first implementation of the Linux Digital TV API.
Convergence was the maintainer of the Linux Digital TV API in the early
days.
Now, the API is maintained by the LinuxTV community (i.e. you, the reader
@ -88,7 +88,7 @@ Conditional Access (CA) hardware like CI adapters and smartcard slots
Not every digital TV hardware provides conditional access hardware.
Demultiplexer which filters the incoming DVB stream
Demultiplexer which filters the incoming Digital TV MPEG-TS stream
The demultiplexer splits the TS into its components like audio and
video streams. Besides usually several of such audio and video
streams it also contains data streams with information about the
@ -124,8 +124,8 @@ The Linux Digital TV API lets you control these hardware components through
currently six Unix-style character devices for video, audio, frontend,
demux, CA and IP-over-DVB networking. The video and audio devices
control the MPEG2 decoder hardware, the frontend device the tuner and
the DVB demodulator. The demux device gives you control over the PES and
section filters of the hardware. If the hardware does not support
the Digital TV demodulator. The demux device gives you control over the PES
and section filters of the hardware. If the hardware does not support
filtering these filters can be implemented in software. Finally, the CA
device controls all the conditional access capabilities of the hardware.
It can depend on the individual security requirements of the platform,

6
Documentation/media/uapi/dvb/legacy_dvb_apis.rst
View File

@ -2,9 +2,9 @@
.. _legacy_dvb_apis:
*******************
DVB Deprecated APIs
*******************
***************************
Digital TV Deprecated APIs
***************************
The APIs described here are kept only for historical reasons. There's
just one driver for a very legacy hardware that uses this API. No modern

2
Documentation/media/uapi/dvb/net-add-if.rst
View File

@ -64,7 +64,7 @@ filled with the number of the created interface.
- ifnum
- number of the DVB interface.
- number of the Digital TV interface.
- .. row 4

13
Documentation/media/uapi/dvb/net.rst
View File

@ -2,10 +2,11 @@
.. _net:
###############
DVB Network API
###############
The DVB net device controls the mapping of data packages that are part
######################
Digital TV Network API
######################
The Digital TV net device controls the mapping of data packages that are part
of a transport stream to be mapped into a virtual network interface,
visible through the standard Linux network protocol stack.
@ -28,8 +29,8 @@ header.
.. _net_fcalls:
DVB net Function Calls
######################
Digital TV net Function Calls
#############################
.. toctree::
:maxdepth: 1

4
Documentation/media/uapi/dvb/query-dvb-frontend-info.rst
View File

@ -9,5 +9,5 @@ Querying frontend information
Usually, the first thing to do when the frontend is opened is to check
the frontend capabilities. This is done using
:ref:`FE_GET_INFO`. This ioctl will enumerate the
DVB API version and other characteristics about the frontend, and can be
opened either in read only or read/write mode.
Digital TV API version and other characteristics about the frontend, and can
be opened either in read only or read/write mode.

2
Documentation/media/uapi/dvb/video-continue.rst
View File

@ -44,7 +44,7 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call restarts decoding and playing processes of the video

4
Documentation/media/uapi/dvb/video-freeze.rst
View File

@ -44,14 +44,14 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call suspends the live video stream being played. Decoding
and playing are frozen. It is then possible to restart the decoding and
playing process of the video stream using the VIDEO_CONTINUE command.
If VIDEO_SOURCE_MEMORY is selected in the ioctl call
VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data
until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.

2
Documentation/media/uapi/dvb/video-get-event.rst
View File

@ -50,7 +50,7 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. To get events from a V4L2 decoder
This ioctl is for Digital TV devices only. To get events from a V4L2 decoder
use the V4L2 :ref:`VIDIOC_DQEVENT` ioctl instead.
This ioctl call returns an event of type video_event if available. If

2
Documentation/media/uapi/dvb/video-play.rst
View File

@ -44,7 +44,7 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call asks the Video Device to start playing a video stream

2
Documentation/media/uapi/dvb/video-select-source.rst
View File

@ -50,7 +50,7 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. This ioctl was also supported by the
This ioctl is for Digital TV devices only. This ioctl was also supported by the
V4L2 ivtv driver, but that has been replaced by the ivtv-specific
``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.

2
Documentation/media/uapi/dvb/video-stop.rst
View File

@ -60,7 +60,7 @@ Arguments
Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
This ioctl call asks the Video Device to stop playing the current

15
Documentation/media/uapi/dvb/video.rst
View File

@ -2,20 +2,21 @@
.. _dvb_video:
################
DVB Video Device
################
The DVB video device controls the MPEG2 video decoder of the DVB
hardware. It can be accessed through **/dev/dvb/adapter0/video0**. Data
#######################
Digital TV Video Device
#######################
The Digital TV video device controls the MPEG2 video decoder of the Digital
TV hardware. It can be accessed through **/dev/dvb/adapter0/video0**. Data
types and and ioctl definitions can be accessed by including
**linux/dvb/video.h** in your application.
Note that the DVB video device only controls decoding of the MPEG video
Note that the Digital TV video device only controls decoding of the MPEG video
stream, not its presentation on the TV or computer screen. On PCs this
is typically handled by an associated video4linux device, e.g.
**/dev/video**, which allows scaling and defining output windows.
Some DVB cards don’t have their own MPEG decoder, which results in the
Some Digital TV cards don’t have their own MPEG decoder, which results in the
omission of the audio and video device as well as the video4linux
device.