Commit | Line | Data |
---|---|---|
910f4461 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _lirc_set_rec_carrier_range: | |
4 | ||
5 | ******************************** | |
6 | ioctl LIRC_SET_REC_CARRIER_RANGE | |
7 | ******************************** | |
8 | ||
9 | Name | |
10 | ==== | |
11 | ||
12 | LIRC_SET_REC_CARRIER_RANGE - Set lower bond of the carrier used to modulate | |
13 | IR receive. | |
14 | ||
15 | Synopsis | |
16 | ======== | |
17 | ||
15c19014 MCC |
18 | .. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency ) |
19 | :name: LIRC_SET_REC_CARRIER_RANGE | |
910f4461 MCC |
20 | |
21 | Arguments | |
22 | ========= | |
23 | ||
24 | ``fd`` | |
25 | File descriptor returned by open(). | |
26 | ||
910f4461 MCC |
27 | ``frequency`` |
28 | Frequency of the carrier that modulates PWM data, in Hz. | |
29 | ||
30 | Description | |
31 | =========== | |
32 | ||
33 | This ioctl sets the upper range of carrier frequency that will be recognized | |
34 | by the IR receiver. | |
35 | ||
36 | .. note:: | |
37 | ||
38 | To set a range use :ref:`LIRC_SET_REC_CARRIER_RANGE | |
39 | <LIRC_SET_REC_CARRIER_RANGE>` with the lower bound first and later call | |
40 | :ref:`LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>` with the upper bound. | |
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. |