lirc-set-send-duty-cycle.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_set_send_duty_cycle:
  4. ******************************
  5. ioctl LIRC_SET_SEND_DUTY_CYCLE
  6. ******************************
  7. Name
  8. ====
  9. LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle of the carrier signal for
  10. IR transmit.
  11. Synopsis
  12. ========
  13. .. c:macro:: LIRC_SET_SEND_DUTY_CYCLE
  14. ``int ioctl(int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)``
  15. Arguments
  16. =========
  17. ``fd``
  18. File descriptor returned by open().
  19. ``duty_cycle``
  20. Duty cicle, describing the pulse width in percent (from 1 to 99) of
  21. the total cycle. Values 0 and 100 are reserved.
  22. Description
  23. ===========
  24. Get/set the duty cycle of the carrier signal for IR transmit.
  25. Currently, no special meaning is defined for 0 or 100, but this
  26. could be used to switch off carrier generation in the future, so
  27. these values should be reserved.
  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.