1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1. 1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: RC 2 .. c:namespace:: RC
3 3
4 .. _lirc_set_transmitter_mask: 4 .. _lirc_set_transmitter_mask:
5 5
6 ******************************* 6 *******************************
7 ioctl LIRC_SET_TRANSMITTER_MASK 7 ioctl LIRC_SET_TRANSMITTER_MASK
8 ******************************* 8 *******************************
9 9
10 Name 10 Name
11 ==== 11 ====
12 12
13 LIRC_SET_TRANSMITTER_MASK - Enables send codes 13 LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
14 14
15 Synopsis 15 Synopsis
16 ======== 16 ========
17 17
18 .. c:macro:: LIRC_SET_TRANSMITTER_MASK 18 .. c:macro:: LIRC_SET_TRANSMITTER_MASK
19 19
20 ``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, 20 ``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
21 21
22 Arguments 22 Arguments
23 ========= 23 =========
24 24
25 ``fd`` 25 ``fd``
26 File descriptor returned by open(). 26 File descriptor returned by open().
27 27
28 ``mask`` 28 ``mask``
29 Mask with channels to enable tx. Channel 0 29 Mask with channels to enable tx. Channel 0 is the least significant bit.
30 30
31 Description 31 Description
32 =========== 32 ===========
33 33
34 Some IR TX devices have multiple output channe 34 Some IR TX devices have multiple output channels, in such case,
35 :ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN- 35 :ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
36 returned via :ref:`LIRC_GET_FEATURES` and this 36 returned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
37 send IR codes. 37 send IR codes.
38 38
39 This ioctl enables the given set of transmitte 39 This ioctl enables the given set of transmitters. The first transmitter is
40 encoded by the least significant bit and so on 40 encoded by the least significant bit and so on.
41 41
42 When an invalid bit mask is given, i.e. a bit 42 When an invalid bit mask is given, i.e. a bit is set, even though the device
43 does not have so many transitters, then this i 43 does not have so many transitters, then this ioctl returns the number of
44 available transitters and does nothing otherwi 44 available transitters and does nothing otherwise.
45 45
46 Return Value 46 Return Value
47 ============ 47 ============
48 48
49 On success 0 is returned, on error -1 and the 49 On success 0 is returned, on error -1 and the ``errno`` variable is set
50 appropriately. The generic error codes are des 50 appropriately. The generic error codes are described at the
51 :ref:`Generic Error Codes <gen-errors>` chapte 51 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.