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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_READ_BER:
   4
   5 ***********
   6 FE_READ_BER
   7 ***********
   8
   9 Name
  10 ====
  11
  12 FE_READ_BER
  13
  14 Synopsis
  15 ========
  16
  17 .. cpp:function:: int  ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
  18
  19
  20 Arguments
  21 =========
  22
  23 .. flat-table::
  24     :header-rows:  0
  25     :stub-columns: 0
  26
  27
  28     -  .. row 1
  29
  30        -  int fd
  31
  32        -  File descriptor returned by a previous call to open().
  33
  34     -  .. row 2
  35
  36        -  int request
  37
  38        -  Equals :ref:`FE_READ_BER` for this command.
  39
  40     -  .. row 3
  41
  42        -  uint32_t \*ber
  43
  44        -  The bit error rate is stored into \*ber.
  45
  46
  47 Description
  48 ===========
  49
  50 This ioctl call returns the bit error rate for the signal currently
  51 received/demodulated by the front-end. For this command, read-only
  52 access to the device is sufficient.
  53
  54
  55 Return Value
  56 ============
  57
  58 On success 0 is returned, on error -1 and the ``errno`` variable is set
  59 appropriately. The generic error codes are described at the
  60 :ref:`Generic Error Codes <gen-errors>` chapter.