projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| f27637f9 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | ||
| 3 | .. _lirc_set_wideband_receiver: | |
| 4 | ||
| 5 | ******************************** | |
| 6 | ioctl LIRC_SET_WIDEBAND_RECEIVER | |
| 7 | ******************************** | |
| 8 | ||
| 9 | Name | |
| 10 | ==== | |
| 11 | ||
| 12 | LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver. | |
| 13 | ||
| 14 | Synopsis | |
| 15 | ======== | |
| 16 | ||
| 17 | .. cpp:function:: int ioctl( int fd, int request, __u32 *enable ) | |
| 18 | ||
| 19 | Arguments | |
| 20 | ========= | |
| 21 | ||
| 22 | ``fd`` | |
| 23 | File descriptor returned by open(). | |
| 24 | ||
| 25 | ``request`` | |
| 26 | LIRC_SET_WIDEBAND_RECEIVER | |
| 27 | ||
| 28 | ``enable`` | |
| 29 | enable = 1 means enable wideband receiver, enable = 0 means disable | |
| 30 | wideband receiver. | |
| 31 | ||
| 32 | ||
| 33 | Description | |
| 34 | =========== | |
| 35 | ||
| 36 | Some receivers are equipped with special wide band receiver which is | |
| 37 | intended to be used to learn output of existing remote. This ioctl | |
| 38 | allows enabling or disabling it. | |
| 39 | ||
| 40 | This might be useful of receivers that have otherwise narrow band receiver | |
| 41 | that prevents them to be used with some remotes. Wide band receiver might | |
| 42 | also be more precise. On the other hand its disadvantage it usually | |
| 43 | reduced range of reception. | |
| 44 | ||
| 45 | .. note:: Wide band receiver might be implictly enabled if you enable | |
| 46 | carrier reports. In that case it will be disabled as soon as you disable | |
| 47 | carrier reports. Trying to disable wide band receiver while carrier | |
| 48 | reports are active will do nothing. | |
| 49 | ||
| 50 | ||
| 51 | Return Value | |
| 52 | ============ | |
| 53 | ||
| 54 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 55 | appropriately. The generic error codes are described at the | |
| 56 | :ref:`Generic Error Codes <gen-errors>` chapter. |