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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _FE_READ_SNR:
  11
  12 ***********
  13 FE_READ_SNR
  14 ***********
  15
  16 Name
  17 ====
  18
  19 FE_READ_SNR
  20
  21 .. attention:: This ioctl is deprecated.
  22
  23 Synopsis
  24 ========
  25
  26 .. c:function:: int  ioctl(int fd, FE_READ_SNR, int16_t *snr)
  27     :name: FE_READ_SNR
  28
  29
  30 Arguments
  31 =========
  32
  33 ``fd``
  34     File descriptor returned by :c:func:`open() <dvb-fe-open>`.
  35
  36 ``snr``
  37     The signal-to-noise ratio is stored into \*snr.
  38
  39
  40 Description
  41 ===========
  42
  43 This ioctl call returns the signal-to-noise ratio for the signal
  44 currently received by the front-end. For this command, read-only access
  45 to the device is sufficient.
  46
  47
  48 Return Value
  49 ============
  50
  51 On success 0 is returned.
  52
  53 On error -1 is returned, and the ``errno`` variable is set
  54 appropriately.
  55
  56 Generic error codes are described at the
  57 :ref:`Generic Error Codes <gen-errors>` chapter.