Documentation/media/uapi/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 Name
  10 ====
  11
  12 FE_READ_UNCORRECTED_BLOCKS
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 ========
  18
  19 .. c:function:: int ioctl( int fd, FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
  20     :name: FE_READ_UNCORRECTED_BLOCKS
  21
  22
  23 Arguments
  24 =========
  25
  26 ``fd``
  27     File descriptor returned by :c:func:`open() <dvb-fe-open>`.
  28
  29 ``ublocks``
  30     The total number of uncorrected blocks seen by the driver so far.
  31
  32
  33 Description
  34 ===========
  35
  36 This ioctl call returns the number of uncorrected blocks detected by the
  37 device driver during its lifetime. For meaningful measurements, the
  38 increment in block count during a specific time interval should be
  39 calculated. For this command, read-only access to the device is
  40 sufficient.
  41
  42
  43 Return Value
  44 ============
  45
  46 On success 0 is returned.
  47
  48 On error -1 is returned, and the ``errno`` variable is set
  49 appropriately.
  50
  51 Generic error codes are described at the
  52 :ref:`Generic Error Codes <gen-errors>` chapter.