Documentation/linux_tv/media/dvb/FE_READ_SNR.rst

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