diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-12 13:56:28 +0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-12 15:42:56 +0300 |
| commit | 572c194b8851dd459f9c17582ec535ec477b6fe8 (patch) | |
| tree | 64f4e069b56645ba839d070593bb5667abe134f4 /Documentation/media/uapi/rc | |
| parent | 98a7b04eed055fd320ec7081e06ac39a61afa3e8 (diff) | |
| download | linux-572c194b8851dd459f9c17582ec535ec477b6fe8.tar.xz | |
[media] doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTS
Add a separate page for this ioctl and improve its documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/rc')
| -rw-r--r-- | Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst | 49 | ||||
| -rw-r--r-- | Documentation/media/uapi/rc/lirc_device_interface.rst | 1 | ||||
| -rw-r--r-- | Documentation/media/uapi/rc/lirc_ioctl.rst | 8 |
3 files changed, 50 insertions, 8 deletions
diff --git a/Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst b/Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst new file mode 100644 index 000000000000..0c7f85d0ce3b --- /dev/null +++ b/Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst @@ -0,0 +1,49 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _lirc_set_rec_timeout_reports: + +********************************** +ioctl LIRC_SET_REC_TIMEOUT_REPORTS +********************************** + +Name +==== + +LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive + +Synopsis +======== + +.. cpp:function:: int ioctl( int fd, int request, __u32 *enable ) + +Arguments +========= + +``fd`` + File descriptor returned by open(). + +``request`` + LIRC_SET_REC_TIMEOUT_REPORTS + +``enable`` + enable = 1 means enable timeout report, enable = 0 means disable timeout + reports. + + +Description +=========== + +Enable or disable timeout reports for IR receive. By default, timeout reports +should be turned off. + +.. note:: + + This ioctl is only valid for :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`. + + +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 df576d90c73a..9e57779ca2a6 100644 --- a/Documentation/media/uapi/rc/lirc_device_interface.rst +++ b/Documentation/media/uapi/rc/lirc_device_interface.rst @@ -24,4 +24,5 @@ LIRC Device Interface lirc-set-rec-carrier-range lirc-set-send-carrier lirc-set-transmitter-mask + lirc-set-rec-timeout-reports lirc_ioctl diff --git a/Documentation/media/uapi/rc/lirc_ioctl.rst b/Documentation/media/uapi/rc/lirc_ioctl.rst index 26544a5fc946..d99fa0eeef4c 100644 --- a/Documentation/media/uapi/rc/lirc_ioctl.rst +++ b/Documentation/media/uapi/rc/lirc_ioctl.rst @@ -54,14 +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_REPORTS: - -``LIRC_SET_REC_TIMEOUT_REPORTS`` - - Enable (1) or disable (0) timeout reports in ``LIRC_MODE_MODE2.`` By - default, timeout reports should be turned off. - - .. _LIRC_SET_MEASURE_CARRIER_MODE: .. _lirc-mode2-frequency: |