xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: RC
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _lirc_set_transmitter_mask:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun*******************************
7*4882a593Smuzhiyunioctl LIRC_SET_TRANSMITTER_MASK
8*4882a593Smuzhiyun*******************************
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun====
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunLIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunSynopsis
16*4882a593Smuzhiyun========
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun.. c:macro:: LIRC_SET_TRANSMITTER_MASK
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunArguments
23*4882a593Smuzhiyun=========
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun``fd``
26*4882a593Smuzhiyun    File descriptor returned by open().
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun``mask``
29*4882a593Smuzhiyun    Mask with channels to enable tx. Channel 0 is the least significant bit.
30*4882a593Smuzhiyun
31*4882a593SmuzhiyunDescription
32*4882a593Smuzhiyun===========
33*4882a593Smuzhiyun
34*4882a593SmuzhiyunSome IR TX devices have multiple output channels, in such case,
35*4882a593Smuzhiyun:ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
36*4882a593Smuzhiyunreturned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
37*4882a593Smuzhiyunsend IR codes.
38*4882a593Smuzhiyun
39*4882a593SmuzhiyunThis ioctl enables the given set of transmitters. The first transmitter is
40*4882a593Smuzhiyunencoded by the least significant bit and so on.
41*4882a593Smuzhiyun
42*4882a593SmuzhiyunWhen an invalid bit mask is given, i.e. a bit is set, even though the device
43*4882a593Smuzhiyundoes not have so many transitters, then this ioctl returns the number of
44*4882a593Smuzhiyunavailable transitters and does nothing otherwise.
45*4882a593Smuzhiyun
46*4882a593SmuzhiyunReturn Value
47*4882a593Smuzhiyun============
48*4882a593Smuzhiyun
49*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set
50*4882a593Smuzhiyunappropriately. The generic error codes are described at the
51*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
52