lirc-set-rec-carrier-range.rst 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
  2. .. c:namespace:: RC
  3. .. _lirc_set_rec_carrier_range:
  4. ********************************
  5. ioctl LIRC_SET_REC_CARRIER_RANGE
  6. ********************************
  7. Name
  8. ====
  9. LIRC_SET_REC_CARRIER_RANGE - Set lower bound of the carrier used to modulate
  10. IR receive.
  11. Synopsis
  12. ========
  13. .. c:macro:: LIRC_SET_REC_CARRIER_RANGE
  14. ``int ioctl(int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency)``
  15. Arguments
  16. =========
  17. ``fd``
  18. File descriptor returned by open().
  19. ``frequency``
  20. Frequency of the carrier that modulates PWM data, in Hz.
  21. Description
  22. ===========
  23. This ioctl sets the upper range of carrier frequency that will be recognized
  24. by the IR receiver.
  25. .. note::
  26. To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE
  27. <LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call
  28. :ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound.
  29. Return Value
  30. ============
  31. On success 0 is returned, on error -1 and the ``errno`` variable is set
  32. appropriately. The generic error codes are described at the
  33. :ref:`Generic Error Codes <gen-errors>` chapter.