doc-rst: linux_tv: simplify references
[linux-2.6-block.git] / Documentation / linux_tv / media / dvb / FE_READ_UNCORRECTED_BLOCKS.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _FE_READ_UNCORRECTED_BLOCKS:
4
5 **************************
6 FE_READ_UNCORRECTED_BLOCKS
7 **************************
8
9 DESCRIPTION
10
11 This ioctl call returns the number of uncorrected blocks detected by the
12 device driver during its lifetime. For meaningful measurements, the
13 increment in block count during a specific time interval should be
14 calculated. For this command, read-only access to the device is
15 sufficient.
16
17 SYNOPSIS
18
19 int ioctl( int fd, int request =
20 :ref:`FE_READ_UNCORRECTED_BLOCKS`,
21 uint32_t *ublocks);
22
23 PARAMETERS
24
25
26
27 .. flat-table::
28     :header-rows:  0
29     :stub-columns: 0
30
31
32     -  .. row 1
33
34        -  int fd
35
36        -  File descriptor returned by a previous call to open().
37
38     -  .. row 2
39
40        -  int request
41
42        -  Equals
43           :ref:`FE_READ_UNCORRECTED_BLOCKS`
44           for this command.
45
46     -  .. row 3
47
48        -  uint32_t *ublocks
49
50        -  The total number of uncorrected blocks seen by the driver so far.
51
52
53 RETURN VALUE
54
55 On success 0 is returned, on error -1 and the ``errno`` variable is set
56 appropriately. The generic error codes are described at the
57 :ref:`Generic Error Codes <gen-errors>` chapter.
58
59
60 .. ------------------------------------------------------------------------------
61 .. This file was automatically converted from DocBook-XML with the dbxml
62 .. library (https://github.com/return42/sphkerneldoc). The origin XML comes
63 .. from the linux kernel, refer to:
64 ..
65 .. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
66 .. ------------------------------------------------------------------------------