162306a36Sopenharmony_ci.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
262306a36Sopenharmony_ci.. c:namespace:: RC
362306a36Sopenharmony_ci
462306a36Sopenharmony_ci.. _lirc_set_transmitter_mask:
562306a36Sopenharmony_ci
662306a36Sopenharmony_ci*******************************
762306a36Sopenharmony_ciioctl LIRC_SET_TRANSMITTER_MASK
862306a36Sopenharmony_ci*******************************
962306a36Sopenharmony_ci
1062306a36Sopenharmony_ciName
1162306a36Sopenharmony_ci====
1262306a36Sopenharmony_ci
1362306a36Sopenharmony_ciLIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
1462306a36Sopenharmony_ci
1562306a36Sopenharmony_ciSynopsis
1662306a36Sopenharmony_ci========
1762306a36Sopenharmony_ci
1862306a36Sopenharmony_ci.. c:macro:: LIRC_SET_TRANSMITTER_MASK
1962306a36Sopenharmony_ci
2062306a36Sopenharmony_ci``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
2162306a36Sopenharmony_ci
2262306a36Sopenharmony_ciArguments
2362306a36Sopenharmony_ci=========
2462306a36Sopenharmony_ci
2562306a36Sopenharmony_ci``fd``
2662306a36Sopenharmony_ci    File descriptor returned by open().
2762306a36Sopenharmony_ci
2862306a36Sopenharmony_ci``mask``
2962306a36Sopenharmony_ci    Mask with channels to enable tx. Channel 0 is the least significant bit.
3062306a36Sopenharmony_ci
3162306a36Sopenharmony_ciDescription
3262306a36Sopenharmony_ci===========
3362306a36Sopenharmony_ci
3462306a36Sopenharmony_ciSome IR TX devices have multiple output channels, in such case,
3562306a36Sopenharmony_ci:ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
3662306a36Sopenharmony_cireturned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
3762306a36Sopenharmony_cisend IR codes.
3862306a36Sopenharmony_ci
3962306a36Sopenharmony_ciThis ioctl enables the given set of transmitters. The first transmitter is
4062306a36Sopenharmony_ciencoded by the least significant bit and so on.
4162306a36Sopenharmony_ci
4262306a36Sopenharmony_ciWhen an invalid bit mask is given, i.e. a bit is set, even though the device
4362306a36Sopenharmony_cidoes not have so many transitters, then this ioctl returns the number of
4462306a36Sopenharmony_ciavailable transitters and does nothing otherwise.
4562306a36Sopenharmony_ci
4662306a36Sopenharmony_ciReturn Value
4762306a36Sopenharmony_ci============
4862306a36Sopenharmony_ci
4962306a36Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
5062306a36Sopenharmony_ciappropriately. The generic error codes are described at the
5162306a36Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
52