fe-read-snr.rst 852 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2. .. c:namespace:: DTV.fe
  3. .. _FE_READ_SNR:
  4. ***********
  5. FE_READ_SNR
  6. ***********
  7. Name
  8. ====
  9. FE_READ_SNR
  10. .. attention:: This ioctl is deprecated.
  11. Synopsis
  12. ========
  13. .. c:macro:: FE_READ_SNR
  14. ``int ioctl(int fd, FE_READ_SNR, int16_t *snr)``
  15. Arguments
  16. =========
  17. ``fd``
  18. File descriptor returned by :c:func:`open()`.
  19. ``snr``
  20. The signal-to-noise ratio is stored into \*snr.
  21. Description
  22. ===========
  23. This ioctl call returns the signal-to-noise ratio for the signal
  24. currently received by the front-end. For this command, read-only access
  25. to the device is sufficient.
  26. Return Value
  27. ============
  28. On success 0 is returned.
  29. On error -1 is returned, and the ``errno`` variable is set
  30. appropriately.
  31. Generic error codes are described at the
  32. :ref:`Generic Error Codes <gen-errors>` chapter.