staging: rtl8192u: remove redundant assignment to pointer crypt
[linux/fpc-iii.git] / Documentation / media / uapi / rc / lirc-get-features.rst
blob1d590df8164a9e7e8a6d3ddee33db47d95a12e86
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
10 .. _lirc_get_features:
12 ***********************
13 ioctl LIRC_GET_FEATURES
14 ***********************
16 Name
17 ====
19 LIRC_GET_FEATURES - Get the underlying hardware device's features
21 Synopsis
22 ========
24 .. c:function:: int ioctl( int fd, LIRC_GET_FEATURES, __u32 *features)
25     :name: LIRC_GET_FEATURES
27 Arguments
28 =========
30 ``fd``
31     File descriptor returned by open().
33 ``features``
34     Bitmask with the LIRC features.
37 Description
38 ===========
41 Get the underlying hardware device's features. If a driver does not
42 announce support of certain features, calling of the corresponding ioctls
43 is undefined.
45 LIRC features
46 =============
48 .. _LIRC-CAN-REC-RAW:
50 ``LIRC_CAN_REC_RAW``
52     Unused. Kept just to avoid breaking uAPI.
54 .. _LIRC-CAN-REC-PULSE:
56 ``LIRC_CAN_REC_PULSE``
58     Unused. Kept just to avoid breaking uAPI.
59     :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>` can only be used for transmitting.
61 .. _LIRC-CAN-REC-MODE2:
63 ``LIRC_CAN_REC_MODE2``
65     This is raw IR driver for receiving. This means that
66     :ref:`LIRC_MODE_MODE2 <lirc-mode-MODE2>` is used. This also implies
67     that :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>` is also supported,
68     as long as the kernel is recent enough. Use the
69     :ref:`lirc_set_rec_mode` to switch modes.
71 .. _LIRC-CAN-REC-LIRCCODE:
73 ``LIRC_CAN_REC_LIRCCODE``
75     Unused. Kept just to avoid breaking uAPI.
77 .. _LIRC-CAN-REC-SCANCODE:
79 ``LIRC_CAN_REC_SCANCODE``
81     This is a scancode driver for receiving. This means that
82     :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>` is used.
84 .. _LIRC-CAN-SET-SEND-CARRIER:
86 ``LIRC_CAN_SET_SEND_CARRIER``
88     The driver supports changing the modulation frequency via
89     :ref:`ioctl LIRC_SET_SEND_CARRIER <LIRC_SET_SEND_CARRIER>`.
91 .. _LIRC-CAN-SET-SEND-DUTY-CYCLE:
93 ``LIRC_CAN_SET_SEND_DUTY_CYCLE``
95     The driver supports changing the duty cycle using
96     :ref:`ioctl LIRC_SET_SEND_DUTY_CYCLE <LIRC_SET_SEND_DUTY_CYCLE>`.
98 .. _LIRC-CAN-SET-TRANSMITTER-MASK:
100 ``LIRC_CAN_SET_TRANSMITTER_MASK``
102     The driver supports changing the active transmitter(s) using
103     :ref:`ioctl LIRC_SET_TRANSMITTER_MASK <LIRC_SET_TRANSMITTER_MASK>`.
105 .. _LIRC-CAN-SET-REC-CARRIER:
107 ``LIRC_CAN_SET_REC_CARRIER``
109     The driver supports setting the receive carrier frequency using
110     :ref:`ioctl LIRC_SET_REC_CARRIER <LIRC_SET_REC_CARRIER>`.
112 .. _LIRC-CAN-SET-REC-DUTY-CYCLE-RANGE:
114 ``LIRC_CAN_SET_REC_DUTY_CYCLE_RANGE``
116     Unused. Kept just to avoid breaking uAPI.
118 .. _LIRC-CAN-SET-REC-CARRIER-RANGE:
120 ``LIRC_CAN_SET_REC_CARRIER_RANGE``
122     The driver supports
123     :ref:`ioctl LIRC_SET_REC_CARRIER_RANGE <LIRC_SET_REC_CARRIER_RANGE>`.
125 .. _LIRC-CAN-GET-REC-RESOLUTION:
127 ``LIRC_CAN_GET_REC_RESOLUTION``
129     The driver supports
130     :ref:`ioctl LIRC_GET_REC_RESOLUTION <LIRC_GET_REC_RESOLUTION>`.
132 .. _LIRC-CAN-SET-REC-TIMEOUT:
134 ``LIRC_CAN_SET_REC_TIMEOUT``
136     The driver supports
137     :ref:`ioctl LIRC_SET_REC_TIMEOUT <LIRC_SET_REC_TIMEOUT>`.
139 .. _LIRC-CAN-SET-REC-FILTER:
141 ``LIRC_CAN_SET_REC_FILTER``
143     Unused. Kept just to avoid breaking uAPI.
145 .. _LIRC-CAN-MEASURE-CARRIER:
147 ``LIRC_CAN_MEASURE_CARRIER``
149     The driver supports measuring of the modulation frequency using
150     :ref:`ioctl LIRC_SET_MEASURE_CARRIER_MODE <LIRC_SET_MEASURE_CARRIER_MODE>`.
152 .. _LIRC-CAN-USE-WIDEBAND-RECEIVER:
154 ``LIRC_CAN_USE_WIDEBAND_RECEIVER``
156     The driver supports learning mode using
157     :ref:`ioctl LIRC_SET_WIDEBAND_RECEIVER <LIRC_SET_WIDEBAND_RECEIVER>`.
159 .. _LIRC-CAN-NOTIFY-DECODE:
161 ``LIRC_CAN_NOTIFY_DECODE``
163     Unused. Kept just to avoid breaking uAPI.
165 .. _LIRC-CAN-SEND-RAW:
167 ``LIRC_CAN_SEND_RAW``
169     Unused. Kept just to avoid breaking uAPI.
171 .. _LIRC-CAN-SEND-PULSE:
173 ``LIRC_CAN_SEND_PULSE``
175     The driver supports sending (also called as IR blasting or IR TX) using
176     :ref:`LIRC_MODE_PULSE <lirc-mode-pulse>`. This implies that
177     :ref:`LIRC_MODE_SCANCODE <lirc-mode-SCANCODE>` is also supported for
178     transmit, as long as the kernel is recent enough. Use the
179     :ref:`lirc_set_send_mode` to switch modes.
181 .. _LIRC-CAN-SEND-MODE2:
183 ``LIRC_CAN_SEND_MODE2``
185     Unused. Kept just to avoid breaking uAPI.
186     :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>` can only be used for receiving.
188 .. _LIRC-CAN-SEND-LIRCCODE:
190 ``LIRC_CAN_SEND_LIRCCODE``
192     Unused. Kept just to avoid breaking uAPI.
195 Return Value
196 ============
198 On success 0 is returned, on error -1 and the ``errno`` variable is set
199 appropriately. The generic error codes are described at the
200 :ref:`Generic Error Codes <gen-errors>` chapter.