linux/Documentation/media/uapi/rc/lirc-get-length.rst
Mauro Carvalho Chehab 5413b648d0 [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>
2016-07-12 09:42:49 -03:00

46 lines
849 B
ReStructuredText

.. -*- 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.