xref: /linux/Documentation/userspace-api/media/dvb/fe-read-uncorrected-blocks.rst (revision 95298d63c67673c654c08952672d016212b26054)
1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _FE_READ_UNCORRECTED_BLOCKS:
11
12**************************
13FE_READ_UNCORRECTED_BLOCKS
14**************************
15
16Name
17====
18
19FE_READ_UNCORRECTED_BLOCKS
20
21.. attention:: This ioctl is deprecated.
22
23Synopsis
24========
25
26.. c:function:: int ioctl( int fd, FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
27    :name: FE_READ_UNCORRECTED_BLOCKS
28
29
30Arguments
31=========
32
33``fd``
34    File descriptor returned by :c:func:`open() <dvb-fe-open>`.
35
36``ublocks``
37    The total number of uncorrected blocks seen by the driver so far.
38
39
40Description
41===========
42
43This ioctl call returns the number of uncorrected blocks detected by the
44device driver during its lifetime. For meaningful measurements, the
45increment in block count during a specific time interval should be
46calculated. For this command, read-only access to the device is
47sufficient.
48
49
50Return Value
51============
52
53On success 0 is returned.
54
55On error -1 is returned, and the ``errno`` variable is set
56appropriately.
57
58Generic error codes are described at the
59:ref:`Generic Error Codes <gen-errors>` chapter.
60