1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1. 1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: RC 2 .. c:namespace:: RC
3 3
4 .. _lirc_get_features: 4 .. _lirc_get_features:
5 5
6 *********************** 6 ***********************
7 ioctl LIRC_GET_FEATURES 7 ioctl LIRC_GET_FEATURES
8 *********************** 8 ***********************
9 9
10 Name 10 Name
11 ==== 11 ====
12 12
13 LIRC_GET_FEATURES - Get the underlying hardwar 13 LIRC_GET_FEATURES - Get the underlying hardware device's features
14 14
15 Synopsis 15 Synopsis
16 ======== 16 ========
17 17
18 .. c:macro:: LIRC_GET_FEATURES 18 .. c:macro:: LIRC_GET_FEATURES
19 19
20 ``int ioctl(int fd, LIRC_GET_FEATURES, __u32 * 20 ``int ioctl(int fd, LIRC_GET_FEATURES, __u32 *features)``
21 21
22 Arguments 22 Arguments
23 ========= 23 =========
24 24
25 ``fd`` 25 ``fd``
26 File descriptor returned by open(). 26 File descriptor returned by open().
27 27
28 ``features`` 28 ``features``
29 Bitmask with the LIRC features. 29 Bitmask with the LIRC features.
30 30
31 Description 31 Description
32 =========== 32 ===========
33 33
34 Get the underlying hardware device's features. 34 Get the underlying hardware device's features. If a driver does not
35 announce support of certain features, calling 35 announce support of certain features, calling of the corresponding ioctls
36 is undefined. 36 is undefined.
37 37
38 LIRC features 38 LIRC features
39 ============= 39 =============
40 40
41 .. _LIRC-CAN-REC-RAW: 41 .. _LIRC-CAN-REC-RAW:
42 42
43 ``LIRC_CAN_REC_RAW`` 43 ``LIRC_CAN_REC_RAW``
44 44
45 Unused. Kept just to avoid breaking uAPI. 45 Unused. Kept just to avoid breaking uAPI.
46 46
47 .. _LIRC-CAN-REC-PULSE: 47 .. _LIRC-CAN-REC-PULSE:
48 48
49 ``LIRC_CAN_REC_PULSE`` 49 ``LIRC_CAN_REC_PULSE``
50 50
51 Unused. Kept just to avoid breaking uAPI. 51 Unused. Kept just to avoid breaking uAPI.
52 :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` c 52 :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` can only be used for transmitting.
53 53
54 .. _LIRC-CAN-REC-MODE2: 54 .. _LIRC-CAN-REC-MODE2:
55 55
56 ``LIRC_CAN_REC_MODE2`` 56 ``LIRC_CAN_REC_MODE2``
57 57
58 This is raw IR driver for receiving. This 58 This is raw IR driver for receiving. This means that
59 :ref:`LIRC_MODE_MODE2 <lirc-mode-MODE2>` i 59 :ref:`LIRC_MODE_MODE2 <lirc-mode-MODE2>` is used. This also implies
60 that :ref:`LIRC_MODE_SCANCODE <lirc-mode-S 60 that :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>` is also supported,
61 as long as the kernel is recent enough. Us 61 as long as the kernel is recent enough. Use the
62 :ref:`lirc_set_rec_mode` to switch modes. 62 :ref:`lirc_set_rec_mode` to switch modes.
63 63
64 .. _LIRC-CAN-REC-LIRCCODE: 64 .. _LIRC-CAN-REC-LIRCCODE:
65 65
66 ``LIRC_CAN_REC_LIRCCODE`` 66 ``LIRC_CAN_REC_LIRCCODE``
67 67
68 Unused. Kept just to avoid breaking uAPI. 68 Unused. Kept just to avoid breaking uAPI.
69 69
70 .. _LIRC-CAN-REC-SCANCODE: 70 .. _LIRC-CAN-REC-SCANCODE:
71 71
72 ``LIRC_CAN_REC_SCANCODE`` 72 ``LIRC_CAN_REC_SCANCODE``
73 73
74 This is a scancode driver for receiving. T 74 This is a scancode driver for receiving. This means that
75 :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCO 75 :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>` is used.
76 76
77 .. _LIRC-CAN-SET-SEND-CARRIER: 77 .. _LIRC-CAN-SET-SEND-CARRIER:
78 78
79 ``LIRC_CAN_SET_SEND_CARRIER`` 79 ``LIRC_CAN_SET_SEND_CARRIER``
80 80
81 The driver supports changing the modulatio 81 The driver supports changing the modulation frequency via
82 :ref:`ioctl LIRC_SET_SEND_CARRIER <LIRC_SE 82 :ref:`ioctl LIRC_SET_SEND_CARRIER <LIRC_SET_SEND_CARRIER>`.
83 83
84 .. _LIRC-CAN-SET-SEND-DUTY-CYCLE: 84 .. _LIRC-CAN-SET-SEND-DUTY-CYCLE:
85 85
86 ``LIRC_CAN_SET_SEND_DUTY_CYCLE`` 86 ``LIRC_CAN_SET_SEND_DUTY_CYCLE``
87 87
88 The driver supports changing the duty cycl 88 The driver supports changing the duty cycle using
89 :ref:`ioctl LIRC_SET_SEND_DUTY_CYCLE <LIRC 89 :ref:`ioctl LIRC_SET_SEND_DUTY_CYCLE <LIRC_SET_SEND_DUTY_CYCLE>`.
90 90
91 .. _LIRC-CAN-SET-TRANSMITTER-MASK: 91 .. _LIRC-CAN-SET-TRANSMITTER-MASK:
92 92
93 ``LIRC_CAN_SET_TRANSMITTER_MASK`` 93 ``LIRC_CAN_SET_TRANSMITTER_MASK``
94 94
95 The driver supports changing the active tr 95 The driver supports changing the active transmitter(s) using
96 :ref:`ioctl LIRC_SET_TRANSMITTER_MASK <LIR 96 :ref:`ioctl LIRC_SET_TRANSMITTER_MASK <LIRC_SET_TRANSMITTER_MASK>`.
97 97
98 .. _LIRC-CAN-SET-REC-CARRIER: 98 .. _LIRC-CAN-SET-REC-CARRIER:
99 99
100 ``LIRC_CAN_SET_REC_CARRIER`` 100 ``LIRC_CAN_SET_REC_CARRIER``
101 101
102 The driver supports setting the receive ca 102 The driver supports setting the receive carrier frequency using
103 :ref:`ioctl LIRC_SET_REC_CARRIER <LIRC_SET 103 :ref:`ioctl LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>`.
104 104
>> 105 .. _LIRC-CAN-SET-REC-DUTY-CYCLE-RANGE:
>> 106
>> 107 ``LIRC_CAN_SET_REC_DUTY_CYCLE_RANGE``
>> 108
>> 109 Unused. Kept just to avoid breaking uAPI.
>> 110
105 .. _LIRC-CAN-SET-REC-CARRIER-RANGE: 111 .. _LIRC-CAN-SET-REC-CARRIER-RANGE:
106 112
107 ``LIRC_CAN_SET_REC_CARRIER_RANGE`` 113 ``LIRC_CAN_SET_REC_CARRIER_RANGE``
108 114
109 The driver supports 115 The driver supports
110 :ref:`ioctl LIRC_SET_REC_CARRIER_RANGE <LI 116 :ref:`ioctl LIRC_SET_REC_CARRIER_RANGE <LIRC_SET_REC_CARRIER_RANGE>`.
111 117
112 .. _LIRC-CAN-GET-REC-RESOLUTION: 118 .. _LIRC-CAN-GET-REC-RESOLUTION:
113 119
114 ``LIRC_CAN_GET_REC_RESOLUTION`` 120 ``LIRC_CAN_GET_REC_RESOLUTION``
115 121
116 The driver supports 122 The driver supports
117 :ref:`ioctl LIRC_GET_REC_RESOLUTION <LIRC_ 123 :ref:`ioctl LIRC_GET_REC_RESOLUTION <LIRC_GET_REC_RESOLUTION>`.
118 124
119 .. _LIRC-CAN-SET-REC-TIMEOUT: 125 .. _LIRC-CAN-SET-REC-TIMEOUT:
120 126
121 ``LIRC_CAN_SET_REC_TIMEOUT`` 127 ``LIRC_CAN_SET_REC_TIMEOUT``
122 128
123 The driver supports 129 The driver supports
124 :ref:`ioctl LIRC_SET_REC_TIMEOUT <LIRC_SET 130 :ref:`ioctl LIRC_SET_REC_TIMEOUT <LIRC_SET_REC_TIMEOUT>`.
125 131
>> 132 .. _LIRC-CAN-SET-REC-FILTER:
>> 133
>> 134 ``LIRC_CAN_SET_REC_FILTER``
>> 135
>> 136 Unused. Kept just to avoid breaking uAPI.
>> 137
126 .. _LIRC-CAN-MEASURE-CARRIER: 138 .. _LIRC-CAN-MEASURE-CARRIER:
127 139
128 ``LIRC_CAN_MEASURE_CARRIER`` 140 ``LIRC_CAN_MEASURE_CARRIER``
129 141
130 The driver supports measuring of the modul 142 The driver supports measuring of the modulation frequency using
131 :ref:`ioctl LIRC_SET_MEASURE_CARRIER_MODE 143 :ref:`ioctl LIRC_SET_MEASURE_CARRIER_MODE <LIRC_SET_MEASURE_CARRIER_MODE>`.
132 144
133 .. _LIRC-CAN-USE-WIDEBAND-RECEIVER: 145 .. _LIRC-CAN-USE-WIDEBAND-RECEIVER:
134 146
135 ``LIRC_CAN_USE_WIDEBAND_RECEIVER`` 147 ``LIRC_CAN_USE_WIDEBAND_RECEIVER``
136 148
137 The driver supports learning mode using 149 The driver supports learning mode using
138 :ref:`ioctl LIRC_SET_WIDEBAND_RECEIVER <LI 150 :ref:`ioctl LIRC_SET_WIDEBAND_RECEIVER <LIRC_SET_WIDEBAND_RECEIVER>`.
>> 151
>> 152 .. _LIRC-CAN-NOTIFY-DECODE:
>> 153
>> 154 ``LIRC_CAN_NOTIFY_DECODE``
>> 155
>> 156 Unused. Kept just to avoid breaking uAPI.
139 157
140 .. _LIRC-CAN-SEND-RAW: 158 .. _LIRC-CAN-SEND-RAW:
141 159
142 ``LIRC_CAN_SEND_RAW`` 160 ``LIRC_CAN_SEND_RAW``
143 161
144 Unused. Kept just to avoid breaking uAPI. 162 Unused. Kept just to avoid breaking uAPI.
145 163
146 .. _LIRC-CAN-SEND-PULSE: 164 .. _LIRC-CAN-SEND-PULSE:
147 165
148 ``LIRC_CAN_SEND_PULSE`` 166 ``LIRC_CAN_SEND_PULSE``
149 167
150 The driver supports sending (also called a 168 The driver supports sending (also called as IR blasting or IR TX) using
151 :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>`. 169 :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>`. This implies that
152 :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCO 170 :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>` is also supported for
153 transmit, as long as the kernel is recent 171 transmit, as long as the kernel is recent enough. Use the
154 :ref:`lirc_set_send_mode` to switch modes. 172 :ref:`lirc_set_send_mode` to switch modes.
155 173
156 .. _LIRC-CAN-SEND-MODE2: 174 .. _LIRC-CAN-SEND-MODE2:
157 175
158 ``LIRC_CAN_SEND_MODE2`` 176 ``LIRC_CAN_SEND_MODE2``
159 177
160 Unused. Kept just to avoid breaking uAPI. 178 Unused. Kept just to avoid breaking uAPI.
161 :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>` c 179 :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>` can only be used for receiving.
162 180
163 .. _LIRC-CAN-SEND-LIRCCODE: 181 .. _LIRC-CAN-SEND-LIRCCODE:
164 182
165 ``LIRC_CAN_SEND_LIRCCODE`` 183 ``LIRC_CAN_SEND_LIRCCODE``
166 184
167 Unused. Kept just to avoid breaking uAPI. 185 Unused. Kept just to avoid breaking uAPI.
168 186
169 Return Value 187 Return Value
170 ============ 188 ============
171 189
172 On success 0 is returned, on error -1 and the 190 On success 0 is returned, on error -1 and the ``errno`` variable is set
173 appropriately. The generic error codes are des 191 appropriately. The generic error codes are described at the
174 :ref:`Generic Error Codes <gen-errors>` chapte 192 :ref:`Generic Error Codes <gen-errors>` chapter.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.