aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/dmx-fopen.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/media/uapi/dvb/dmx-fopen.rst')
-rw-r--r--Documentation/media/uapi/dvb/dmx-fopen.rst66
1 files changed, 29 insertions, 37 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-fopen.rst b/Documentation/media/uapi/dvb/dmx-fopen.rst
index a697e33c32ea..55628a18ba67 100644
--- a/Documentation/media/uapi/dvb/dmx-fopen.rst
+++ b/Documentation/media/uapi/dvb/dmx-fopen.rst
@@ -2,14 +2,14 @@
.. _dmx_fopen:
-================
-DVB demux open()
-================
+=======================
+Digital TV demux open()
+=======================
Name
----
-DVB demux open()
+Digital TV demux open()
Synopsis
@@ -22,25 +22,28 @@ Arguments
---------
``name``
- Name of specific DVB demux device.
+ Name of specific Digital TV demux device.
``flags``
A bit-wise OR of the following flags:
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
+
.. flat-table::
:header-rows: 0
:stub-columns: 0
+ :widths: 1 16
-
- - O_RDONLY
+ - ``O_RDONLY``
- read-only access
-
- - O_RDWR
+ - ``O_RDWR``
- read/write access
-
- - O_NONBLOCK
+ - ``O_NONBLOCK``
- open in non-blocking mode
(blocking mode is the default)
@@ -48,52 +51,41 @@ Arguments
Description
-----------
-This system call, used with a device name of /dev/dvb/adapter0/demux0,
+This system call, used with a device name of ``/dev/dvb/adapter?/demux?``,
allocates a new filter and returns a handle which can be used for
subsequent control of that filter. This call has to be made for each
filter to be used, i.e. every returned file descriptor is a reference to
-a single filter. /dev/dvb/adapter0/dvr0 is a logical device to be used
+a single filter. ``/dev/dvb/adapter?/dvr?`` is a logical device to be used
for retrieving Transport Streams for digital video recording. When
reading from this device a transport stream containing the packets from
all PES filters set in the corresponding demux device
-(/dev/dvb/adapter0/demux0) having the output set to DMX_OUT_TS_TAP. A
-recorded Transport Stream is replayed by writing to this device.
+(``/dev/dvb/adapter?/demux?``) having the output set to ``DMX_OUT_TS_TAP``.
+A recorded Transport Stream is replayed by writing to this device.
The significance of blocking or non-blocking mode is described in the
documentation for functions where there is a difference. It does not
-affect the semantics of the open() call itself. A device opened in
-blocking mode can later be put into non-blocking mode (and vice versa)
-using the F_SETFL command of the fcntl system call.
+affect the semantics of the ``open()`` call itself. A device opened
+in blocking mode can later be put into non-blocking mode (and vice versa)
+using the ``F_SETFL`` command of the fcntl system call.
Return Value
------------
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``ENODEV``
-
- - Device driver not loaded/available.
+On success 0 is returned.
- - .. row 2
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
- - ``EINVAL``
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
- - Invalid argument.
-
- - .. row 3
-
- - ``EMFILE``
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+ :widths: 1 16
+ - - ``EMFILE``
- “Too many open files”, i.e. no more filters available.
- - .. row 4
-
- - ``ENOMEM``
-
- - The driver failed to allocate enough memory.
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.