Documentation/media/uapi/dvb/fe-read-signal-strength.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_READ_SIGNAL_STRENGTH:
   4
   5 ***********************
   6 FE_READ_SIGNAL_STRENGTH
   7 ***********************
   8
   9 Name
  10 ====
  11
  12 FE_READ_SIGNAL_STRENGTH
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
  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_SIGNAL_STRENGTH`
  41           for this command.
  42
  43     -  .. row 3
  44
  45        -  uint16_t \*strength
  46
  47        -  The signal strength value is stored into \*strength.
  48
  49
  50 Description
  51 ===========
  52
  53 This ioctl call returns the signal strength value for the signal
  54 currently received by the front-end. For this command, read-only access
  55 to the device is sufficient.
  56
  57
  58 Return Value
  59 ============
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.