media: dvb uAPI docs: minor editorial changes

+13 -12

Documentation/media/uapi/dvb/ca-fopen.rst

··· 28 28 ``flags`` 29 29 A bit-wise OR of the following flags: 30 30 31 + .. tabularcolumns:: |p{2.5cm}|p{15.0cm}| 32 + 31 33 .. flat-table:: 32 34 :header-rows: 0 33 35 :stub-columns: 0 36 + :widths: 1 16 34 37 35 - - 36 - - O_RDONLY 38 + - - ``O_RDONLY`` 37 39 - read-only access 38 40 39 - - 40 - - O_RDWR 41 + - - ``O_RDWR`` 41 42 - read/write access 42 43 43 - - 44 - - O_NONBLOCK 44 + - - ``O_NONBLOCK`` 45 45 - open in non-blocking mode 46 46 (blocking mode is the default) 47 47 ··· 52 52 This system call opens a named ca device (e.g. ``/dev/dvb/adapter?/ca?``) 53 53 for subsequent use. 54 54 55 - When an open() call has succeeded, the device will be ready for use. The 55 + When an ``open()`` call has succeeded, the device will be ready for use. The 56 56 significance of blocking or non-blocking mode is described in the 57 57 documentation for functions where there is a difference. It does not 58 - affect the semantics of the open() call itself. A device opened in 58 + affect the semantics of the ``open()`` call itself. A device opened in 59 59 blocking mode can later be put into non-blocking mode (and vice versa) 60 - using the F_SETFL command of the fcntl system call. This is a standard 61 - system call, documented in the Linux manual page for fcntl. Only one 62 - user can open the CA Device in O_RDWR mode. All other attempts to open 63 - the device in this mode will fail, and an error code will be returned. 60 + using the ``F_SETFL`` command of the ``fcntl`` system call. This is a 61 + standard system call, documented in the Linux manual page for fcntl. 62 + Only one user can open the CA Device in ``O_RDWR`` mode. All other 63 + attempts to open the device in this mode will fail, and an error code 64 + will be returned. 64 65 65 66 66 67 Return Value

+2 -2

Documentation/media/uapi/dvb/dmx-add-pid.rst

··· 33 33 ----------- 34 34 35 35 This ioctl call allows to add multiple PIDs to a transport stream filter 36 - previously set up with DMX_SET_PES_FILTER and output equal to 37 - DMX_OUT_TSDEMUX_TAP. 36 + previously set up with :ref:`DMX_SET_PES_FILTER` and output equal to 37 + :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`. 38 38 39 39 40 40 Return Value

+3 -2

Documentation/media/uapi/dvb/dmx-fclose.rst

··· 23 23 --------- 24 24 25 25 ``fd`` 26 - File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. 26 + File descriptor returned by a previous call to 27 + :c:func:`open() <dvb-dmx-open>`. 27 28 28 29 Description 29 30 ----------- 30 31 31 32 This system call deactivates and deallocates a filter that was 32 - previously allocated via the open() call. 33 + previously allocated via the :c:func:`open() <dvb-dmx-open>` call. 33 34 34 35 35 36 Return Value

+13 -10

Documentation/media/uapi/dvb/dmx-fopen.rst

··· 27 27 ``flags`` 28 28 A bit-wise OR of the following flags: 29 29 30 + .. tabularcolumns:: |p{2.5cm}|p{15.0cm}| 31 + 30 32 .. flat-table:: 31 33 :header-rows: 0 32 34 :stub-columns: 0 35 + :widths: 1 16 33 36 34 37 - 35 - - O_RDONLY 38 + - ``O_RDONLY`` 36 39 - read-only access 37 40 38 41 - 39 - - O_RDWR 42 + - ``O_RDWR`` 40 43 - read/write access 41 44 42 45 - 43 - - O_NONBLOCK 46 + - ``O_NONBLOCK`` 44 47 - open in non-blocking mode 45 48 (blocking mode is the default) 46 49 ··· 51 48 Description 52 49 ----------- 53 50 54 - This system call, used with a device name of /dev/dvb/adapter0/demux0, 51 + This system call, used with a device name of ``/dev/dvb/adapter?/demux?``, 55 52 allocates a new filter and returns a handle which can be used for 56 53 subsequent control of that filter. This call has to be made for each 57 54 filter to be used, i.e. every returned file descriptor is a reference to 58 - a single filter. /dev/dvb/adapter0/dvr0 is a logical device to be used 55 + a single filter. ``/dev/dvb/adapter?/dvr?`` is a logical device to be used 59 56 for retrieving Transport Streams for digital video recording. When 60 57 reading from this device a transport stream containing the packets from 61 58 all PES filters set in the corresponding demux device 62 - (/dev/dvb/adapter0/demux0) having the output set to DMX_OUT_TS_TAP. A 63 - recorded Transport Stream is replayed by writing to this device. 59 + (``/dev/dvb/adapter?/demux?``) having the output set to ``DMX_OUT_TS_TAP``. 60 + A recorded Transport Stream is replayed by writing to this device. 64 61 65 62 The significance of blocking or non-blocking mode is described in the 66 63 documentation for functions where there is a difference. It does not 67 - affect the semantics of the open() call itself. A device opened in 68 - blocking mode can later be put into non-blocking mode (and vice versa) 69 - using the F_SETFL command of the fcntl system call. 64 + affect the semantics of the ``open()`` call itself. A device opened 65 + in blocking mode can later be put into non-blocking mode (and vice versa) 66 + using the ``F_SETFL`` command of the fcntl system call. 70 67 71 68 72 69 Return Value

+4 -4

Documentation/media/uapi/dvb/dmx-fread.rst

··· 33 33 Description 34 34 ----------- 35 35 36 - This system call returns filtered data, which might be section or PES 37 - data. The filtered data is transferred from the driver’s internal 38 - circular buffer to buf. The maximum amount of data to be transferred is 39 - implied by count. 36 + This system call returns filtered data, which might be section or Packetized 37 + Elementary Stream (PES) data. The filtered data is transferred from 38 + the driver’s internal circular buffer to ``buf``. The maximum amount of data 39 + to be transferred is implied by count. 40 40 41 41 .. note:: 42 42

+2 -2

Documentation/media/uapi/dvb/dmx-fwrite.rst

··· 34 34 ----------- 35 35 36 36 This system call is only provided by the logical device 37 - /dev/dvb/adapter0/dvr0, associated with the physical demux device that 37 + ``/dev/dvb/adapter?/dvr?``, associated with the physical demux device that 38 38 provides the actual DVR functionality. It is used for replay of a 39 39 digitally recorded Transport Stream. Matching filters have to be defined 40 - in the corresponding physical demux device, /dev/dvb/adapter0/demux0. 40 + in the corresponding physical demux device, ``/dev/dvb/adapter?/demux?``. 41 41 The amount of data to be transferred is implied by count. 42 42 43 43

+7 -6

Documentation/media/uapi/dvb/dmx-get-stc.rst

··· 25 25 File descriptor returned by :c:func:`open() <dvb-dmx-open>`. 26 26 27 27 ``stc`` 28 - Pointer to the location where the stc is to be stored. 28 + Pointer to :c:type:`dmx_stc` where the stc data is to be stored. 29 29 30 30 31 31 Description 32 32 ----------- 33 33 34 34 This ioctl call returns the current value of the system time counter 35 - (which is driven by a PES filter of type DMX_PES_PCR). Some hardware 36 - supports more than one STC, so you must specify which one by setting the 37 - num field of stc before the ioctl (range 0...n). The result is returned 38 - in form of a ratio with a 64 bit numerator and a 32 bit denominator, so 39 - the real 90kHz STC value is stc->stc / stc->base . 35 + (which is driven by a PES filter of type :c:type:`DMX_PES_PCR <dmx_ts_pes>`). 36 + Some hardware supports more than one STC, so you must specify which one by 37 + setting the :c:type:`num <dmx_stc>` field of stc before the ioctl (range 0...n). 38 + The result is returned in form of a ratio with a 64 bit numerator 39 + and a 32 bit denominator, so the real 90kHz STC value is 40 + ``stc->stc / stc->base``. 40 41 41 42 42 43 Return Value

+2 -2

Documentation/media/uapi/dvb/dmx-remove-pid.rst

··· 34 34 35 35 This ioctl call allows to remove a PID when multiple PIDs are set on a 36 36 transport stream filter, e. g. a filter previously set up with output 37 - equal to DMX_OUT_TSDEMUX_TAP, created via either 38 - DMX_SET_PES_FILTER or DMX_ADD_PID. 37 + equal to :c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`, created via either 38 + :ref:`DMX_SET_PES_FILTER` or :ref:`DMX_ADD_PID`. 39 39 40 40 41 41 Return Value

+1 -1

Documentation/media/uapi/dvb/dmx-set-buffer-size.rst

··· 33 33 34 34 This ioctl call is used to set the size of the circular buffer used for 35 35 filtered data. The default size is two maximum sized sections, i.e. if 36 - this function is not called a buffer size of 2 \* 4096 bytes will be 36 + this function is not called a buffer size of ``2 * 4096`` bytes will be 37 37 used. 38 38 39 39

+2 -2

Documentation/media/uapi/dvb/dmx-set-filter.rst

··· 40 40 be a ”one-shot” filter, i.e. if the filtering operation should be 41 41 stopped after the first section is received, and whether the filtering 42 42 operation should be started immediately (without waiting for a 43 - DMX_START ioctl call). If a filter was previously set-up, this filter 44 - will be canceled, and the receive buffer will be flushed. 43 + :ref:`DMX_START` ioctl call). If a filter was previously set-up, this 44 + filter will be canceled, and the receive buffer will be flushed. 45 45 46 46 47 47 Return Value

+2 -2

Documentation/media/uapi/dvb/dmx-stop.rst

··· 29 29 ----------- 30 30 31 31 This ioctl call is used to stop the actual filtering operation defined 32 - via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and 33 - started via the DMX_START command. 32 + via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and 33 + started via the :ref:`DMX_START` command. 34 34 35 35 36 36 Return Value

+1 -1

Documentation/media/uapi/dvb/dvb-fe-read-status.rst

··· 20 20 .. note:: 21 21 22 22 Most statistics require the demodulator to be fully locked 23 - (e. g. with FE_HAS_LOCK bit set). See 23 + (e. g. with :c:type:`FE_HAS_LOCK <fe_status>` bit set). See 24 24 :ref:`Frontend statistics indicators <frontend-stat-properties>` for 25 25 more details.

+2 -1

Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst

··· 33 33 Description 34 34 =========== 35 35 36 - Sends the DiSEqC command pointed by ``argp`` to the antenna subsystem. 36 + Sends the DiSEqC command pointed by :c:type:`dvb_diseqc_master_cmd` 37 + to the antenna subsystem. 37 38 38 39 Return Value 39 40 ============

+2 -2

Documentation/media/uapi/dvb/fe-get-info.rst

··· 34 34 Description 35 35 =========== 36 36 37 - All Digital TV frontend devices support the ``FE_GET_INFO`` ioctl. It is used 38 - to identify kernel devices compatible with this specification and to 37 + All Digital TV frontend devices support the :ref:`FE_GET_INFO` ioctl. It is 38 + used to identify kernel devices compatible with this specification and to 39 39 obtain information about driver and hardware capabilities. The ioctl 40 40 takes a pointer to dvb_frontend_info which is filled by the driver. 41 41 When the driver is not compatible with this specification the ioctl

+2 -2

Documentation/media/uapi/dvb/fe-set-frontend-tune-mode.rst

··· 30 30 31 31 - 0 - normal tune mode 32 32 33 - - FE_TUNE_MODE_ONESHOT - When set, this flag will disable any 33 + - ``FE_TUNE_MODE_ONESHOT`` - When set, this flag will disable any 34 34 zigzagging or other "normal" tuning behaviour. Additionally, 35 35 there will be no automatic monitoring of the lock status, and 36 36 hence no frontend events will be generated. If a frontend device ··· 42 42 =========== 43 43 44 44 Allow setting tuner mode flags to the frontend, between 0 (normal) or 45 - FE_TUNE_MODE_ONESHOT mode 45 + ``FE_TUNE_MODE_ONESHOT`` mode 46 46 47 47 48 48 Return Value

+1 -1

Documentation/media/uapi/dvb/fe-type-t.rst

··· 78 78 79 79 In the old days, struct :c:type:`dvb_frontend_info` 80 80 used to contain ``fe_type_t`` field to indicate the delivery systems, 81 - filled with either FE_QPSK, FE_QAM, FE_OFDM or FE_ATSC. While this 81 + filled with either ``FE_QPSK, FE_QAM, FE_OFDM`` or ``FE_ATSC``. While this 82 82 is still filled to keep backward compatibility, the usage of this field 83 83 is deprecated, as it can report just one delivery system, but some 84 84 devices support multiple delivery systems. Please use