diff options
| author | Mauro Carvalho Chehab | 2016-07-10 22:35:21 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab | 2016-07-11 13:07:41 -0300 |
| commit | 3f3427c46664cdf130b981aa833cf2ee3189b8d4 (patch) | |
| tree | 3d77b4181f4b02c6aa710fede7a830c6ed0dd49c | |
| parent | 1a2e50a4df07427f1d2196bc09c9dceedd77ed7b (diff) | |
[media] doc-rst: document ioctl LIRC_GET_SEND_MODE
Move the documentation of this ioctl from lirc_ioctl to its
own file, and add a short description about the pulse mode
used by IR TX.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
| -rw-r--r-- | Documentation/media/uapi/rc/lirc-get-send-mode.rst | 48 | ||||
| -rw-r--r-- | Documentation/media/uapi/rc/lirc_device_interface.rst | 1 | ||||
| -rw-r--r-- | Documentation/media/uapi/rc/lirc_ioctl.rst | 9 |
3 files changed, 49 insertions, 9 deletions
diff --git a/Documentation/media/uapi/rc/lirc-get-send-mode.rst b/Documentation/media/uapi/rc/lirc-get-send-mode.rst new file mode 100644 index 000000000000..f58f0953851c --- /dev/null +++ b/Documentation/media/uapi/rc/lirc-get-send-mode.rst @@ -0,0 +1,48 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _lirc_get_send_mode: + +************************ +ioctl LIRC_GET_SEND_MODE +************************ + +Name +==== + +LIRC_GET_SEND_MODE - Get supported transmit mode. + +Synopsis +======== + +.. cpp:function:: int ioctl( int fd, int request, __u32 *tx_modes ) + +Arguments +========= + +``fd`` + File descriptor returned by open(). + +``request`` + LIRC_GET_SEND_MODE + +``tx_modes`` + Bitmask with the supported transmit modes. + + +Description +=========== + +Get supported transmit mode. + +.. _lirc-mode-pulse: + +Currently, only ``LIRC_MODE_PULSE`` is supported by lircd on TX. On +puse mode, a sequence of pulse/space integer values are written to the +lirc device using ``write()``. + +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. diff --git a/Documentation/media/uapi/rc/lirc_device_interface.rst b/Documentation/media/uapi/rc/lirc_device_interface.rst index fe13f7d65d30..f6ebf09cca60 100644 --- a/Documentation/media/uapi/rc/lirc_device_interface.rst +++ b/Documentation/media/uapi/rc/lirc_device_interface.rst @@ -13,4 +13,5 @@ LIRC Device Interface lirc_read lirc_write lirc-get-features + lirc-get-send-mode lirc_ioctl diff --git a/Documentation/media/uapi/rc/lirc_ioctl.rst b/Documentation/media/uapi/rc/lirc_ioctl.rst index 345e927e9d5d..8e9809a03b8f 100644 --- a/Documentation/media/uapi/rc/lirc_ioctl.rst +++ b/Documentation/media/uapi/rc/lirc_ioctl.rst @@ -49,15 +49,6 @@ device can rely on working with the default settings initially. I/O control requests ==================== - -.. _LIRC_GET_SEND_MODE: -.. _lirc-mode-pulse: - -``LIRC_GET_SEND_MODE`` - - Get supported transmit mode. Only ``LIRC_MODE_PULSE`` is supported by - lircd. - .. _LIRC_GET_REC_MODE: .. _lirc-mode-mode2: .. _lirc-mode-lirccode: |