1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
.. -*- coding: utf-8; mode: rst -*-
.. _lirc_ioctl:
************
LIRC ioctl()
************
Name
====
LIRC ioctl - Sends a I/O control command to a LIRC device
Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp )
Arguments
=========
``fd``
File descriptor returned by ``open()``.
``request``
The type of I/O control that will be used. See table :ref:`lirc-request`
for details.
``argp``
Arguments for the I/O control. They're specific to each request.
The LIRC device's ioctl definition is bound by the ioctl function
definition of struct file_operations, leaving us with an unsigned int
for the ioctl command and an unsigned long for the arg. For the purposes
of ioctl portability across 32-bit and 64-bit, these values are capped
to their 32-bit sizes.
The ioctls can be used to change specific hardware settings.
In general each driver should have a default set of settings. The driver
implementation is expected to re-apply the default settings when the
device is closed by user-space, so that every application opening the
device can rely on working with the default settings initially.
.. _lirc-request:
.. _LIRC_SET_SEND_MODE:
.. _LIRC_SET_REC_MODE:
``LIRC_SET_{SEND,REC}_MODE``
Set send/receive mode. Largely obsolete for send, as only
``LIRC_MODE_PULSE`` is supported.
.. _LIRC_SET_TRANSMITTER_MASK:
``LIRC_SET_TRANSMITTER_MASK``
This enables the given set of transmitters. The first transmitter is
encoded by the least significant bit, etc. When an invalid bit mask
is given, i.e. a bit is set, even though the device does not have so
many transitters, then this ioctl returns the number of available
transitters and does nothing otherwise.
.. _LIRC_SET_REC_TIMEOUT:
``LIRC_SET_REC_TIMEOUT``
Sets the integer value for IR inactivity timeout (cf.
``LIRC_GET_MIN_TIMEOUT`` and ``LIRC_GET_MAX_TIMEOUT).`` A value of 0
(if supported by the hardware) disables all hardware timeouts and
data should be reported as soon as possible. If the exact value
cannot be set, then the next possible value _greater_ than the
given value should be set.
.. _LIRC_SET_REC_TIMEOUT_REPORTS:
``LIRC_SET_REC_TIMEOUT_REPORTS``
Enable (1) or disable (0) timeout reports in ``LIRC_MODE_MODE2.`` By
default, timeout reports should be turned off.
.. _LIRC_SET_MEASURE_CARRIER_MODE:
.. _lirc-mode2-frequency:
``LIRC_SET_MEASURE_CARRIER_MODE``
Enable (1)/disable (0) measure mode. If enabled, from the next key
press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
default this should be turned off.
.. _LIRC_SET_WIDEBAND_RECEIVER:
``LIRC_SET_WIDEBAND_RECEIVER``
Some receivers are equipped with special wide band receiver which is
intended to be used to learn output of existing remote. Calling that
ioctl with (1) will enable it, and with (0) disable it. This might
be useful of receivers that have otherwise narrow band receiver that
prevents them to be used with some remotes. Wide band receiver might
also be more precise On the other hand its disadvantage it usually
reduced range of reception.
.. note:: Wide band receiver might be
implictly enabled if you enable carrier reports. In that case it
will be disabled as soon as you disable carrier reports. Trying to
disable wide band receiver while carrier reports are active will do
nothing.
.. _lirc_dev_errors:
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.
|