1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _lirc_set_transmitter_mask:
11
12*******************************
13ioctl LIRC_SET_TRANSMITTER_MASK
14*******************************
15
16Name
17====
18
19LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
20
21Synopsis
22========
23
24.. c:function:: int ioctl( int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask )
25    :name: LIRC_SET_TRANSMITTER_MASK
26
27Arguments
28=========
29
30``fd``
31    File descriptor returned by open().
32
33``mask``
34    Mask with channels to enable tx. Channel 0 is the least significant bit.
35
36
37Description
38===========
39
40Some IR TX devices have multiple output channels, in such case,
41:ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
42returned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
43send IR codes.
44
45This ioctl enables the given set of transmitters. The first transmitter is
46encoded by the least significant bit and so on.
47
48When an invalid bit mask is given, i.e. a bit is set, even though the device
49does not have so many transitters, then this ioctl returns the number of
50available transitters and does nothing otherwise.
51
52
53Return Value
54============
55
56On success 0 is returned, on error -1 and the ``errno`` variable is set
57appropriately. The generic error codes are described at the
58:ref:`Generic Error Codes <gen-errors>` chapter.
59