Back to home page

OSCL-LXR

 
 

    


0001 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: RC
0003 
0004 .. _lirc_set_send_duty_cycle:
0005 
0006 ******************************
0007 ioctl LIRC_SET_SEND_DUTY_CYCLE
0008 ******************************
0009 
0010 Name
0011 ====
0012 
0013 LIRC_SET_SEND_DUTY_CYCLE - Set the duty cycle of the carrier signal for
0014 IR transmit.
0015 
0016 Synopsis
0017 ========
0018 
0019 .. c:macro:: LIRC_SET_SEND_DUTY_CYCLE
0020 
0021 ``int ioctl(int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)``
0022 
0023 Arguments
0024 =========
0025 
0026 ``fd``
0027     File descriptor returned by open().
0028 
0029 ``duty_cycle``
0030     Duty cicle, describing the pulse width in percent (from 1 to 99) of
0031     the total cycle. Values 0 and 100 are reserved.
0032 
0033 Description
0034 ===========
0035 
0036 Get/set the duty cycle of the carrier signal for IR transmit.
0037 
0038 Currently, no special meaning is defined for 0 or 100, but this
0039 could be used to switch off carrier generation in the future, so
0040 these values should be reserved.
0041 
0042 Return Value
0043 ============
0044 
0045 On success 0 is returned, on error -1 and the ``errno`` variable is set
0046 appropriately. The generic error codes are described at the
0047 :ref:`Generic Error Codes <gen-errors>` chapter.