18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci.. c:namespace:: RC
38c2ecf20Sopenharmony_ci
48c2ecf20Sopenharmony_ci.. _lirc_set_transmitter_mask:
58c2ecf20Sopenharmony_ci
68c2ecf20Sopenharmony_ci*******************************
78c2ecf20Sopenharmony_ciioctl LIRC_SET_TRANSMITTER_MASK
88c2ecf20Sopenharmony_ci*******************************
98c2ecf20Sopenharmony_ci
108c2ecf20Sopenharmony_ciName
118c2ecf20Sopenharmony_ci====
128c2ecf20Sopenharmony_ci
138c2ecf20Sopenharmony_ciLIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ciSynopsis
168c2ecf20Sopenharmony_ci========
178c2ecf20Sopenharmony_ci
188c2ecf20Sopenharmony_ci.. c:macro:: LIRC_SET_TRANSMITTER_MASK
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
218c2ecf20Sopenharmony_ci
228c2ecf20Sopenharmony_ciArguments
238c2ecf20Sopenharmony_ci=========
248c2ecf20Sopenharmony_ci
258c2ecf20Sopenharmony_ci``fd``
268c2ecf20Sopenharmony_ci    File descriptor returned by open().
278c2ecf20Sopenharmony_ci
288c2ecf20Sopenharmony_ci``mask``
298c2ecf20Sopenharmony_ci    Mask with channels to enable tx. Channel 0 is the least significant bit.
308c2ecf20Sopenharmony_ci
318c2ecf20Sopenharmony_ciDescription
328c2ecf20Sopenharmony_ci===========
338c2ecf20Sopenharmony_ci
348c2ecf20Sopenharmony_ciSome IR TX devices have multiple output channels, in such case,
358c2ecf20Sopenharmony_ci:ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
368c2ecf20Sopenharmony_cireturned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
378c2ecf20Sopenharmony_cisend IR codes.
388c2ecf20Sopenharmony_ci
398c2ecf20Sopenharmony_ciThis ioctl enables the given set of transmitters. The first transmitter is
408c2ecf20Sopenharmony_ciencoded by the least significant bit and so on.
418c2ecf20Sopenharmony_ci
428c2ecf20Sopenharmony_ciWhen an invalid bit mask is given, i.e. a bit is set, even though the device
438c2ecf20Sopenharmony_cidoes not have so many transitters, then this ioctl returns the number of
448c2ecf20Sopenharmony_ciavailable transitters and does nothing otherwise.
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ciReturn Value
478c2ecf20Sopenharmony_ci============
488c2ecf20Sopenharmony_ci
498c2ecf20Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
508c2ecf20Sopenharmony_ciappropriately. The generic error codes are described at the
518c2ecf20Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
52