projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| 6d9f4d79 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | ||
| 3 | .. _lirc_get_rec_resolution: | |
| 4 | ||
| 5 | ***************************** | |
| 6 | ioctl LIRC_GET_REC_RESOLUTION | |
| 7 | ***************************** | |
| 8 | ||
| 9 | Name | |
| 10 | ==== | |
| 11 | ||
| 12 | LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microseconds. | |
| 13 | ||
| 14 | Synopsis | |
| 15 | ======== | |
| 16 | ||
| 15c19014 MCC |
17 | .. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds) |
| 18 | :name: LIRC_GET_REC_RESOLUTION | |
| 6d9f4d79 MCC |
19 | |
| 20 | Arguments | |
| 21 | ========= | |
| 22 | ||
| 23 | ``fd`` | |
| 24 | File descriptor returned by open(). | |
| 25 | ||
| 6d9f4d79 MCC |
26 | ``microseconds`` |
| 27 | Resolution, in microseconds. | |
| 28 | ||
| 29 | ||
| 30 | Description | |
| 31 | =========== | |
| 32 | ||
| 33 | Some receivers have maximum resolution which is defined by internal | |
| 34 | sample rate or data format limitations. E.g. it's common that | |
| 35 | signals can only be reported in 50 microsecond steps. | |
| 36 | ||
| 37 | This ioctl returns the integer value with such resolution, with can be | |
| 38 | used by userspace applications like lircd to automatically adjust the | |
| 39 | tolerance value. | |
| 40 | ||
| 41 | ||
| 42 | Return Value | |
| 43 | ============ | |
| 44 | ||
| 45 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 46 | appropriately. The generic error codes are described at the | |
| 47 | :ref:`Generic Error Codes <gen-errors>` chapter. |