From 98a7b04eed055fd320ec7081e06ac39a61afa3e8 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 12 Jul 2016 07:49:00 -0300 Subject: [PATCH] [media] doc-rst: document LIRC_SET_REC_TIMEOUT Add a separate page for this ioctl and adds the cross-references. Signed-off-by: Mauro Carvalho Chehab --- .../media/uapi/rc/lirc-set-rec-timeout.rst | 52 +++++++++++++++++++ .../media/uapi/rc/lirc_device_interface.rst | 1 + Documentation/media/uapi/rc/lirc_ioctl.rst | 11 ---- 3 files changed, 53 insertions(+), 11 deletions(-) create mode 100644 Documentation/media/uapi/rc/lirc-set-rec-timeout.rst diff --git a/Documentation/media/uapi/rc/lirc-set-rec-timeout.rst b/Documentation/media/uapi/rc/lirc-set-rec-timeout.rst new file mode 100644 index 000000000000..ffc88f9fcd52 --- /dev/null +++ b/Documentation/media/uapi/rc/lirc-set-rec-timeout.rst @@ -0,0 +1,52 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _lirc_set_rec_timeout: + +************************** +ioctl LIRC_SET_REC_TIMEOUT +************************** + +Name +==== + +LIRC_SET_REC_TIMEOUT - sets the integer value for IR inactivity timeout. + +Synopsis +======== + +.. cpp:function:: int ioctl( int fd, int request, __u32 *timeout ) + +Arguments +========= + +``fd`` + File descriptor returned by open(). + +``request`` + LIRC_SET_REC_TIMEOUT + +``timeout`` + Timeout, in microseconds. + + +Description +=========== + +Sets the integer value for IR inactivity timeout. + +If supported by the hardware, setting it to 0 disables all hardware timeouts +and data should be reported as soon as possible. If the exact value +cannot be set, then the next possible value _greater_ than the +given value should be set. + +.. note:: + + The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`. + + +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 96765eccaa69..df576d90c73a 100644 --- a/Documentation/media/uapi/rc/lirc_device_interface.rst +++ b/Documentation/media/uapi/rc/lirc_device_interface.rst @@ -18,6 +18,7 @@ LIRC Device Interface lirc-get-rec-resolution lirc-set-send-duty-cycle lirc-get-timeout + lirc-set-rec-timeout lirc-get-length lirc-set-rec-carrier lirc-set-rec-carrier-range diff --git a/Documentation/media/uapi/rc/lirc_ioctl.rst b/Documentation/media/uapi/rc/lirc_ioctl.rst index 86bd70dba290..26544a5fc946 100644 --- a/Documentation/media/uapi/rc/lirc_ioctl.rst +++ b/Documentation/media/uapi/rc/lirc_ioctl.rst @@ -54,17 +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_REC_TIMEOUT: - -``LIRC_SET_REC_TIMEOUT`` - - Sets the integer value for IR inactivity timeout (cf. - ``LIRC_GET_MIN_TIMEOUT`` and ``LIRC_GET_MAX_TIMEOUT).`` A value of 0 - (if supported by the hardware) disables all hardware timeouts and - data should be reported as soon as possible. If the exact value - cannot be set, then the next possible value _greater_ than the - given value should be set. - .. _LIRC_SET_REC_TIMEOUT_REPORTS: ``LIRC_SET_REC_TIMEOUT_REPORTS`` -- 2.39.5