lirc-set-rec-timeout.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
  2. .. c:namespace:: RC
  3. .. _lirc_set_rec_timeout:
  4. .. _lirc_get_rec_timeout:
  5. ***************************************************
  6. ioctl LIRC_GET_REC_TIMEOUT and LIRC_SET_REC_TIMEOUT
  7. ***************************************************
  8. Name
  9. ====
  10. LIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR inactivity timeout.
  11. Synopsis
  12. ========
  13. .. c:macro:: LIRC_GET_REC_TIMEOUT
  14. ``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``
  15. .. c:macro:: LIRC_SET_REC_TIMEOUT
  16. ``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``
  17. Arguments
  18. =========
  19. ``fd``
  20. File descriptor returned by open().
  21. ``timeout``
  22. Timeout, in microseconds.
  23. Description
  24. ===========
  25. Get and set the integer value for IR inactivity timeout.
  26. If supported by the hardware, setting it to 0 disables all hardware timeouts
  27. and data should be reported as soon as possible. If the exact value
  28. cannot be set, then the next possible value _greater_ than the
  29. given value should be set.
  30. .. note::
  31. The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
  32. Return Value
  33. ============
  34. On success 0 is returned, on error -1 and the ``errno`` variable is set
  35. appropriately. The generic error codes are described at the
  36. :ref:`Generic Error Codes <gen-errors>` chapter.