0001 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: RC
0003
0004 .. _lirc_set_transmitter_mask:
0005
0006 *******************************
0007 ioctl LIRC_SET_TRANSMITTER_MASK
0008 *******************************
0009
0010 Name
0011 ====
0012
0013 LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
0014
0015 Synopsis
0016 ========
0017
0018 .. c:macro:: LIRC_SET_TRANSMITTER_MASK
0019
0020 ``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
0021
0022 Arguments
0023 =========
0024
0025 ``fd``
0026 File descriptor returned by open().
0027
0028 ``mask``
0029 Mask with channels to enable tx. Channel 0 is the least significant bit.
0030
0031 Description
0032 ===========
0033
0034 Some IR TX devices have multiple output channels, in such case,
0035 :ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
0036 returned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
0037 send IR codes.
0038
0039 This ioctl enables the given set of transmitters. The first transmitter is
0040 encoded by the least significant bit and so on.
0041
0042 When an invalid bit mask is given, i.e. a bit is set, even though the device
0043 does not have so many transitters, then this ioctl returns the number of
0044 available transitters and does nothing otherwise.
0045
0046 Return Value
0047 ============
0048
0049 On success 0 is returned, on error -1 and the ``errno`` variable is set
0050 appropriately. The generic error codes are described at the
0051 :ref:`Generic Error Codes <gen-errors>` chapter.
