forked from Minki/linux
15c190146c
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
52 lines
1.3 KiB
ReStructuredText
52 lines
1.3 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _lirc_set_transmitter_mask:
|
|
|
|
*******************************
|
|
ioctl LIRC_SET_TRANSMITTER_MASK
|
|
*******************************
|
|
|
|
Name
|
|
====
|
|
|
|
LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. c:function:: int ioctl( int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask )
|
|
:name: LIRC_SET_TRANSMITTER_MASK
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``fd``
|
|
File descriptor returned by open().
|
|
|
|
``mask``
|
|
Mask with channels to enable tx. Channel 0 is the least significant bit.
|
|
|
|
|
|
Description
|
|
===========
|
|
|
|
Some IR TX devices have multiple output channels, in such case,
|
|
:ref:`LIRC_CAN_SET_TRANSMITTER_MASK <LIRC-CAN-SET-TRANSMITTER-MASK>` is
|
|
returned via :ref:`LIRC_GET_FEATURES` and this ioctl sets what channels will
|
|
send IR codes.
|
|
|
|
This ioctl enables the given set of transmitters. The first transmitter is
|
|
encoded by the least significant bit and so on.
|
|
|
|
When an invalid bit mask is given, i.e. a bit is set, even though the device
|
|
does not have so many transitters, then this ioctl returns the number of
|
|
available transitters and does nothing otherwise.
|
|
|
|
|
|
Return Value
|
|
============
|
|
|
|
On success 0 is returned, on error -1 and the ``errno`` variable is set
|
|
appropriately. The generic error codes are described at the
|
|
:ref:`Generic Error Codes <gen-errors>` chapter.
|