From 191fbb903ba3636e5ebcb2f9313367f39e00c2ac Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 12 Jul 2016 07:38:58 -0300 Subject: [media] doc-rst: document LIRC_SET_TRANSMITTER_MASK Add proper documentation for this ioctl, providing some additional information about its usage. Signed-off-by: Mauro Carvalho Chehab --- .../media/uapi/rc/lirc-set-transmitter-mask.rst | 53 ++++++++++++++++++++++ .../media/uapi/rc/lirc_device_interface.rst | 1 + Documentation/media/uapi/rc/lirc_ioctl.rst | 10 ---- 3 files changed, 54 insertions(+), 10 deletions(-) create mode 100644 Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst (limited to 'Documentation') diff --git a/Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst b/Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst new file mode 100644 index 000000000000..2b35e21b9bb9 --- /dev/null +++ b/Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst @@ -0,0 +1,53 @@ +.. -*- 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 +======== + +.. cpp:function:: int ioctl( int fd, int request, __u32 *mask ) + +Arguments +========= + +``fd`` + File descriptor returned by open(). + +``request`` + LIRC_SET_TRANSMITTER_MASK + +``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 ` 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 ` chapter. diff --git a/Documentation/media/uapi/rc/lirc_device_interface.rst b/Documentation/media/uapi/rc/lirc_device_interface.rst index 06257caa82db..96765eccaa69 100644 --- a/Documentation/media/uapi/rc/lirc_device_interface.rst +++ b/Documentation/media/uapi/rc/lirc_device_interface.rst @@ -22,4 +22,5 @@ LIRC Device Interface lirc-set-rec-carrier lirc-set-rec-carrier-range lirc-set-send-carrier + lirc-set-transmitter-mask lirc_ioctl diff --git a/Documentation/media/uapi/rc/lirc_ioctl.rst b/Documentation/media/uapi/rc/lirc_ioctl.rst index b1cca1465997..86bd70dba290 100644 --- a/Documentation/media/uapi/rc/lirc_ioctl.rst +++ b/Documentation/media/uapi/rc/lirc_ioctl.rst @@ -54,16 +54,6 @@ device can rely on working with the default settings initially. Set send/receive mode. Largely obsolete for send, as only ``LIRC_MODE_PULSE`` is supported. -.. _LIRC_SET_TRANSMITTER_MASK: - -``LIRC_SET_TRANSMITTER_MASK`` - - This enables the given set of transmitters. The first transmitter is - encoded by the least significant bit, etc. 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. - .. _LIRC_SET_REC_TIMEOUT: ``LIRC_SET_REC_TIMEOUT`` -- cgit v1.2.3