Documentation/media/uapi/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 Name
  10 ====
  11
  12 FE_READ_SNR
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 ========
  18
  19 .. c:function:: int  ioctl(int fd, FE_READ_SNR, int16_t *snr)
  20     :name: FE_READ_SNR
  21
  22
  23 Arguments
  24 =========
  25
  26 ``fd``
  27     File descriptor returned by :c:func:`open() <dvb-fe-open>`.
  28
  29 ``snr``
  30     The signal-to-noise ratio is stored into \*snr.
  31
  32
  33 Description
  34 ===========
  35
  36 This ioctl call returns the signal-to-noise ratio for the signal
  37 currently received by the front-end. For this command, read-only access
  38 to the device is sufficient.
  39
  40
  41 Return Value
  42 ============
  43
  44 On success 0 is returned, on error -1 and the ``errno`` variable is set
  45 appropriately. The generic error codes are described at the
  46 :ref:`Generic Error Codes <gen-errors>` chapter.