xref: /openbmc/linux/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst (revision cdd38c5f1ce4398ec58fec95904b75824daab7b5)
1*ac7f9d02SMauro Carvalho Chehab.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
25f536f4aSMauro Carvalho Chehab.. c:namespace:: RC
354f38fcaSMauro Carvalho Chehab
454f38fcaSMauro Carvalho Chehab.. _lirc_set_transmitter_mask:
554f38fcaSMauro Carvalho Chehab
654f38fcaSMauro Carvalho Chehab*******************************
754f38fcaSMauro Carvalho Chehabioctl LIRC_SET_TRANSMITTER_MASK
854f38fcaSMauro Carvalho Chehab*******************************
954f38fcaSMauro Carvalho Chehab
1054f38fcaSMauro Carvalho ChehabName
1154f38fcaSMauro Carvalho Chehab====
1254f38fcaSMauro Carvalho Chehab
1354f38fcaSMauro Carvalho ChehabLIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
1454f38fcaSMauro Carvalho Chehab
1554f38fcaSMauro Carvalho ChehabSynopsis
1654f38fcaSMauro Carvalho Chehab========
1754f38fcaSMauro Carvalho Chehab
185f536f4aSMauro Carvalho Chehab.. c:macro:: LIRC_SET_TRANSMITTER_MASK
195f536f4aSMauro Carvalho Chehab
205f536f4aSMauro Carvalho Chehab``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
2154f38fcaSMauro Carvalho Chehab
2254f38fcaSMauro Carvalho ChehabArguments
2354f38fcaSMauro Carvalho Chehab=========
2454f38fcaSMauro Carvalho Chehab
2554f38fcaSMauro Carvalho Chehab``fd``
2654f38fcaSMauro Carvalho Chehab    File descriptor returned by open().
2754f38fcaSMauro Carvalho Chehab
2854f38fcaSMauro Carvalho Chehab``mask``
2954f38fcaSMauro Carvalho Chehab    Mask with channels to enable tx. Channel 0 is the least significant bit.
3054f38fcaSMauro Carvalho Chehab
3154f38fcaSMauro Carvalho ChehabDescription
3254f38fcaSMauro Carvalho Chehab===========
3354f38fcaSMauro Carvalho Chehab
3454f38fcaSMauro Carvalho ChehabSome IR TX devices have multiple output channels, in such case,
3554f38fcaSMauro Carvalho Chehab:ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
3654f38fcaSMauro Carvalho Chehabreturned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
3754f38fcaSMauro Carvalho Chehabsend IR codes.
3854f38fcaSMauro Carvalho Chehab
3954f38fcaSMauro Carvalho ChehabThis ioctl enables the given set of transmitters. The first transmitter is
4054f38fcaSMauro Carvalho Chehabencoded by the least significant bit and so on.
4154f38fcaSMauro Carvalho Chehab
4254f38fcaSMauro Carvalho ChehabWhen an invalid bit mask is given, i.e. a bit is set, even though the device
4354f38fcaSMauro Carvalho Chehabdoes not have so many transitters, then this ioctl returns the number of
4454f38fcaSMauro Carvalho Chehabavailable transitters and does nothing otherwise.
4554f38fcaSMauro Carvalho Chehab
4654f38fcaSMauro Carvalho ChehabReturn Value
4754f38fcaSMauro Carvalho Chehab============
4854f38fcaSMauro Carvalho Chehab
4954f38fcaSMauro Carvalho ChehabOn success 0 is returned, on error -1 and the ``errno`` variable is set
5054f38fcaSMauro Carvalho Chehabappropriately. The generic error codes are described at the
5154f38fcaSMauro Carvalho Chehab:ref:`Generic Error Codes <gen-errors>` chapter.
52