diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-12 06:49:06 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-12 09:42:49 -0300 |
commit | 5413b648d057103d58cf531e8e109b259b0abea0 (patch) | |
tree | 3c300b6e63982a6c0d057b5d5c4867d606198fd5 /Documentation/media | |
parent | 76e23479f9b772f1419df691c30e2f5e4ac92cb0 (diff) | |
download | linux-5413b648d057103d58cf531e8e109b259b0abea0.tar.bz2 |
[media] doc-rst: document LIRC_GET_LENGTH ioctl
Put documentation for this ioctl on its own page.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media')
-rw-r--r-- | Documentation/media/uapi/rc/lirc-get-length.rst | 45 | ||||
-rw-r--r-- | Documentation/media/uapi/rc/lirc_device_interface.rst | 1 | ||||
-rw-r--r-- | Documentation/media/uapi/rc/lirc_ioctl.rst | 11 |
3 files changed, 46 insertions, 11 deletions
diff --git a/Documentation/media/uapi/rc/lirc-get-length.rst b/Documentation/media/uapi/rc/lirc-get-length.rst new file mode 100644 index 000000000000..d11c3d3f2c06 --- /dev/null +++ b/Documentation/media/uapi/rc/lirc-get-length.rst @@ -0,0 +1,45 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _lirc_get_length: + +********************* +ioctl LIRC_GET_LENGTH +********************* + +Name +==== + +LIRC_GET_LENGTH - Retrieves the code length in bits. + +Synopsis +======== + +.. cpp:function:: int ioctl( int fd, int request, __u32 *length ) + +Arguments +========= + +``fd`` + File descriptor returned by open(). + +``request`` + LIRC_GET_LENGTH + +``length`` + length, in bits + + +Description +=========== + +Retrieves the code length in bits (only for ``LIRC-MODE-LIRCCODE``). +Reads on the device must be done in blocks matching the bit count. +The bit could should be rounded up so that it matches full bytes. + + +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 197173f9ece5..f8a619e233c0 100644 --- a/Documentation/media/uapi/rc/lirc_device_interface.rst +++ b/Documentation/media/uapi/rc/lirc_device_interface.rst @@ -18,4 +18,5 @@ LIRC Device Interface lirc-get-rec-resolution lirc-set-send-duty-cycle lirc-get-timeout + lirc-get-length lirc_ioctl diff --git a/Documentation/media/uapi/rc/lirc_ioctl.rst b/Documentation/media/uapi/rc/lirc_ioctl.rst index 0a16659e9dad..93531c37fd27 100644 --- a/Documentation/media/uapi/rc/lirc_ioctl.rst +++ b/Documentation/media/uapi/rc/lirc_ioctl.rst @@ -46,17 +46,6 @@ device can rely on working with the default settings initially. .. _lirc-request: -I/O control requests -==================== - -.. _LIRC_GET_LENGTH: - -``LIRC_GET_LENGTH`` - - Retrieves the code length in bits (only for ``LIRC_MODE_LIRCCODE).`` - Reads on the device must be done in blocks matching the bit count. - The bit could should be rounded up so that it matches full bytes. - .. _LIRC_SET_SEND_MODE: .. _LIRC_SET_REC_MODE: |