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
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
  19
  20
  21 Arguments
  22 =========
  23
  24 .. flat-table::
  25     :header-rows:  0
  26     :stub-columns: 0
  27
  28
  29     -  .. row 1
  30
  31        -  int fd
  32
  33        -  File descriptor returned by a previous call to open().
  34
  35     -  .. row 2
  36
  37        -  int request
  38
  39        -  Equals
  40           :ref:`FE_READ_UNCORRECTED_BLOCKS`
  41           for this command.
  42
  43     -  .. row 3
  44
  45        -  uint32_t \*ublocks
  46
  47        -  The total number of uncorrected blocks seen by the driver so far.
  48
  49
  50 Description
  51 ===========
  52
  53 This ioctl call returns the number of uncorrected blocks detected by the
  54 device driver during its lifetime. For meaningful measurements, the
  55 increment in block count during a specific time interval should be
  56 calculated. For this command, read-only access to the device is
  57 sufficient.
  58
  59
  60 Return Value
  61 ============
  62
  63 On success 0 is returned, on error -1 and the ``errno`` variable is set
  64 appropriately. The generic error codes are described at the
  65 :ref:`Generic Error Codes <gen-errors>` chapter.