lirc-get-rec-resolution.rst 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
  2. .. c:namespace:: RC
  3. .. _lirc_get_rec_resolution:
  4. *****************************
  5. ioctl LIRC_GET_REC_RESOLUTION
  6. *****************************
  7. Name
  8. ====
  9. LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds.
  10. Synopsis
  11. ========
  12. .. c:macro:: LIRC_GET_REC_RESOLUTION
  13. ``int ioctl(int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)``
  14. Arguments
  15. =========
  16. ``fd``
  17. File descriptor returned by open().
  18. ``microseconds``
  19. Resolution, in microseconds.
  20. Description
  21. ===========
  22. Some receivers have maximum resolution which is defined by internal
  23. sample rate or data format limitations. E.g. it's common that
  24. signals can only be reported in 50 microsecond steps.
  25. This ioctl returns the integer value with such resolution, with can be
  26. used by userspace applications like lircd to automatically adjust the
  27. tolerance value.
  28. Return Value
  29. ============
  30. On success 0 is returned, on error -1 and the ``errno`` variable is set
  31. appropriately. The generic error codes are described at the
  32. :ref:`Generic Error Codes <gen-errors>` chapter.