Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst

   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/media/uapi/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 *******************************
  13 ioctl LIRC_SET_TRANSMITTER_MASK
  14 *******************************
  15
  16 Name
  17 ====
  18
  19 LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
  20
  21 Synopsis
  22 ========
  23
  24 .. c:function:: int ioctl( int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask )
  25     :name: LIRC_SET_TRANSMITTER_MASK
  26
  27 Arguments
  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
  37 Description
  38 ===========
  39
  40 Some IR TX devices have multiple output channels, in such case,
  41 :ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
  42 returned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
  43 send IR codes.
  44
  45 This ioctl enables the given set of transmitters. The first transmitter is
  46 encoded by the least significant bit and so on.
  47
  48 When an invalid bit mask is given, i.e. a bit is set, even though the device
  49 does not have so many transitters, then this ioctl returns the number of
  50 available transitters and does nothing otherwise.
  51
  52
  53 Return Value
  54 ============
  55
  56 On success 0 is returned, on error -1 and the ``errno`` variable is set
  57 appropriately. The generic error codes are described at the
  58 :ref:`Generic Error Codes <gen-errors>` chapter.