Documentation/userspace-api/media/dvb/fe-read-snr.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.fe
   3
   4 .. _FE_READ_SNR:
   5
   6 ***********
   7 FE_READ_SNR
   8 ***********
   9
  10 Name
  11 ====
  12
  13 FE_READ_SNR
  14
  15 .. attention:: This ioctl is deprecated.
  16
  17 Synopsis
  18 ========
  19
  20 .. c:macro:: FE_READ_SNR
  21
  22 ``int ioctl(int fd, FE_READ_SNR, int16_t *snr)``
  23
  24 Arguments
  25 =========
  26
  27 ``fd``
  28     File descriptor returned by :c:func:`open()`.
  29
  30 ``snr``
  31     The signal-to-noise ratio is stored into \*snr.
  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 Return Value
  41 ============
  42
  43 On success 0 is returned.
  44
  45 On error -1 is returned, and the ``errno`` variable is set
  46 appropriately.
  47
  48 Generic error codes are described at the
  49 :ref:`Generic Error Codes <gen-errors>` chapter.