Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
media: docs: make RC documents more compatible with Sphinx 3.1+
Sphinx 3.x broke support for the cdomain.py extension, as the
c domain code was rewritten. Due to that, the c tags need to
be re-written, in order to use the new c domain notation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
+73
-75
+4
-5
Documentation/userspace-api/media/rc/lirc-get-features.rst
+4
-5
Documentation/userspace-api/media/rc/lirc-get-features.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_get_features:
4
5
···
15
14
Synopsis
16
15
========
17
16
18
-
.. c:function:: int ioctl( int fd, LIRC_GET_FEATURES, __u32 *features)
19
-
:name: LIRC_GET_FEATURES
17
+
.. c:macro:: LIRC_GET_FEATURES
18
+
19
+
``int ioctl(int fd, LIRC_GET_FEATURES, __u32 *features)``
20
20
21
21
Arguments
22
22
=========
···
28
26
``features``
29
27
Bitmask with the LIRC features.
30
28
31
-
32
29
Description
33
30
===========
34
-
35
31
36
32
Get the underlying hardware device's features. If a driver does not
37
33
announce support of certain features, calling of the corresponding ioctls
···
183
183
``LIRC_CAN_SEND_LIRCCODE``
184
184
185
185
Unused. Kept just to avoid breaking uAPI.
186
-
187
186
188
187
Return Value
189
188
============
+7
-5
Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst
+7
-5
Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_get_rec_mode:
4
5
.. _lirc_set_rec_mode:
···
16
15
Synopsis
17
16
========
18
17
19
-
.. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 *mode)
20
-
:name: LIRC_GET_REC_MODE
18
+
.. c:macro:: LIRC_GET_REC_MODE
21
19
22
-
.. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 *mode)
23
-
:name: LIRC_SET_REC_MODE
20
+
``int ioctl(int fd, LIRC_GET_REC_MODE, __u32 *mode)``
21
+
22
+
.. c:macro:: LIRC_SET_REC_MODE
23
+
24
+
``int ioctl(int fd, LIRC_SET_REC_MODE, __u32 *mode)``
24
25
25
26
Arguments
26
27
=========
···
49
46
.. flat-table::
50
47
:header-rows: 0
51
48
:stub-columns: 0
52
-
53
49
54
50
- .. row 1
55
51
+4
-4
Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_get_rec_resolution:
4
5
···
15
14
Synopsis
16
15
========
17
16
18
-
.. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)
19
-
:name: LIRC_GET_REC_RESOLUTION
17
+
.. c:macro:: LIRC_GET_REC_RESOLUTION
18
+
19
+
``int ioctl(int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)``
20
20
21
21
Arguments
22
22
=========
···
27
25
28
26
``microseconds``
29
27
Resolution, in microseconds.
30
-
31
28
32
29
Description
33
30
===========
···
38
37
This ioctl returns the integer value with such resolution, with can be
39
38
used by userspace applications like lircd to automatically adjust the
40
39
tolerance value.
41
-
42
40
43
41
Return Value
44
42
============
+7
-7
Documentation/userspace-api/media/rc/lirc-get-send-mode.rst
+7
-7
Documentation/userspace-api/media/rc/lirc-get-send-mode.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_get_send_mode:
4
5
.. _lirc_set_send_mode:
···
16
15
Synopsis
17
16
========
18
17
19
-
.. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *mode )
20
-
:name: LIRC_GET_SEND_MODE
18
+
.. c:macro:: LIRC_GET_SEND_MODE
21
19
22
-
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *mode )
23
-
:name: LIRC_SET_SEND_MODE
20
+
``int ioctl(int fd, LIRC_GET_SEND_MODE, __u32 *mode)``
21
+
22
+
.. c:macro:: LIRC_SET_SEND_MODE
23
+
24
+
``int ioctl(int fd, LIRC_SET_SEND_MODE, __u32 *mode)``
24
25
25
26
Arguments
26
27
=========
···
32
29
33
30
``mode``
34
31
The mode used for transmitting.
35
-
36
32
37
33
Description
38
34
===========
···
46
44
Return Value
47
45
============
48
46
49
-
50
47
.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
51
48
52
49
.. flat-table::
53
50
:header-rows: 0
54
51
:stub-columns: 0
55
-
56
52
57
53
- .. row 1
58
54
+7
-6
Documentation/userspace-api/media/rc/lirc-get-timeout.rst
+7
-6
Documentation/userspace-api/media/rc/lirc-get-timeout.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_get_min_timeout:
4
5
.. _lirc_get_max_timeout:
···
17
16
Synopsis
18
17
========
19
18
20
-
.. c:function:: int ioctl( int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)
21
-
:name: LIRC_GET_MIN_TIMEOUT
19
+
.. c:macro:: LIRC_GET_MIN_TIMEOUT
22
20
23
-
.. c:function:: int ioctl( int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)
24
-
:name: LIRC_GET_MAX_TIMEOUT
21
+
``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)``
22
+
23
+
.. c:macro:: LIRC_GET_MAX_TIMEOUT
24
+
25
+
``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)``
25
26
26
27
Arguments
27
28
=========
···
33
30
34
31
``timeout``
35
32
Timeout, in microseconds.
36
-
37
33
38
34
Description
39
35
===========
···
48
46
Some devices have a fixed timeout, in that case
49
47
both ioctls will return the same value even though the timeout
50
48
cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.
51
-
52
49
53
50
Return Value
54
51
============
+3
-7
Documentation/userspace-api/media/rc/lirc-read.rst
+3
-7
Documentation/userspace-api/media/rc/lirc-read.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc-read:
4
5
···
12
11
13
12
lirc-read - Read from a LIRC device
14
13
15
-
16
14
Synopsis
17
15
========
18
16
···
19
19
20
20
#include <unistd.h>
21
21
22
-
23
22
.. c:function:: ssize_t read( int fd, void *buf, size_t count )
24
-
:name: lirc-read
25
-
26
23
27
24
Arguments
28
25
=========
···
36
39
Description
37
40
===========
38
41
39
-
:ref:`read() <lirc-read>` attempts to read up to ``count`` bytes from file
42
+
:c:func:`read()` attempts to read up to ``count`` bytes from file
40
43
descriptor ``fd`` into the buffer starting at ``buf``. If ``count`` is zero,
41
-
:ref:`read() <lirc-read>` returns zero and has no other results. If ``count``
44
+
:c:func:`read()` returns zero and has no other results. If ``count``
42
45
is greater than ``SSIZE_MAX``, the result is unspecified.
43
46
44
47
The exact format of the data depends on what :ref:`lirc_modes` a driver
···
55
58
:ref:`IR protocol <Remote_controllers_Protocols>`
56
59
used for transmission, and ``scancode`` to the decoded scancode,
57
60
and the ``keycode`` set to the keycode or ``KEY_RESERVED``.
58
-
59
61
60
62
Return Value
61
63
============
+4
-4
Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_measure_carrier_mode:
4
5
···
15
14
Synopsis
16
15
========
17
16
18
-
.. c:function:: int ioctl( int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable )
19
-
:name: LIRC_SET_MEASURE_CARRIER_MODE
17
+
.. c:macro:: LIRC_SET_MEASURE_CARRIER_MODE
18
+
19
+
``int ioctl(int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable)``
20
20
21
21
Arguments
22
22
=========
···
29
27
enable = 1 means enable measure mode, enable = 0 means disable measure
30
28
mode.
31
29
32
-
33
30
Description
34
31
===========
35
32
···
37
36
Enable or disable measure mode. If enabled, from the next key
38
37
press on, the driver will send ``LIRC_MODE2_FREQUENCY`` packets. By
39
38
default this should be turned off.
40
-
41
39
42
40
Return Value
43
41
============
+4
-2
Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst
+4
-2
Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_rec_carrier_range:
4
5
···
16
15
Synopsis
17
16
========
18
17
19
-
.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency )
20
-
:name: LIRC_SET_REC_CARRIER_RANGE
18
+
.. c:macro:: LIRC_SET_REC_CARRIER_RANGE
19
+
20
+
``int ioctl(int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency)``
21
21
22
22
Arguments
23
23
=========
+4
-4
Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_rec_carrier:
4
5
···
12
11
13
12
LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
14
13
15
-
16
14
Synopsis
17
15
========
18
16
19
-
.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER, __u32 *frequency )
20
-
:name: LIRC_SET_REC_CARRIER
17
+
.. c:macro:: LIRC_SET_REC_CARRIER
18
+
19
+
``int ioctl(int fd, LIRC_SET_REC_CARRIER, __u32 *frequency)``
21
20
22
21
Arguments
23
22
=========
···
37
36
38
37
If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl
39
38
sets the upper bound frequency that will be recognized by the device.
40
-
41
39
42
40
Return Value
43
41
============
+4
-4
Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_rec_timeout_reports:
4
5
···
15
14
Synopsis
16
15
========
17
16
18
-
.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable )
19
-
:name: LIRC_SET_REC_TIMEOUT_REPORTS
17
+
.. c:macro:: LIRC_SET_REC_TIMEOUT_REPORTS
18
+
19
+
``int ioctl(int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable)``
20
20
21
21
Arguments
22
22
=========
···
28
26
``enable``
29
27
enable = 1 means enable timeout report, enable = 0 means disable timeout
30
28
reports.
31
-
32
29
33
30
Description
34
31
===========
···
40
39
.. note::
41
40
42
41
This ioctl is only valid for :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`.
43
-
44
42
45
43
Return Value
46
44
============
+7
-6
Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst
+7
-6
Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_rec_timeout:
4
5
.. _lirc_get_rec_timeout:
···
16
15
Synopsis
17
16
========
18
17
19
-
.. c:function:: int ioctl( int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout )
20
-
:name: LIRC_GET_REC_TIMEOUT
18
+
.. c:macro:: LIRC_GET_REC_TIMEOUT
21
19
22
-
.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout )
23
-
:name: LIRC_SET_REC_TIMEOUT
20
+
``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``
21
+
22
+
.. c:macro:: LIRC_SET_REC_TIMEOUT
23
+
24
+
``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``
24
25
25
26
Arguments
26
27
=========
···
32
29
33
30
``timeout``
34
31
Timeout, in microseconds.
35
-
36
32
37
33
Description
38
34
===========
···
46
44
.. note::
47
45
48
46
The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
49
-
50
47
51
48
Return Value
52
49
============
+4
-4
Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_send_carrier:
4
5
···
12
11
13
12
LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
14
13
15
-
16
14
Synopsis
17
15
========
18
16
19
-
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency )
20
-
:name: LIRC_SET_SEND_CARRIER
17
+
.. c:macro:: LIRC_SET_SEND_CARRIER
18
+
19
+
``int ioctl(int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency)``
21
20
22
21
Arguments
23
22
=========
···
32
31
===========
33
32
34
33
Set send carrier used to modulate IR PWM pulses and spaces.
35
-
36
34
37
35
Return Value
38
36
============
+4
-4
Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_send_duty_cycle:
4
5
···
16
15
Synopsis
17
16
========
18
17
19
-
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)
20
-
:name: LIRC_SET_SEND_DUTY_CYCLE
18
+
.. c:macro:: LIRC_SET_SEND_DUTY_CYCLE
19
+
20
+
``int ioctl(int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)``
21
21
22
22
Arguments
23
23
=========
···
30
28
Duty cicle, describing the pulse width in percent (from 1 to 99) of
31
29
the total cycle. Values 0 and 100 are reserved.
32
30
33
-
34
31
Description
35
32
===========
36
33
···
38
37
Currently, no special meaning is defined for 0 or 100, but this
39
38
could be used to switch off carrier generation in the future, so
40
39
these values should be reserved.
41
-
42
40
43
41
Return Value
44
42
============
+4
-4
Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_transmitter_mask:
4
5
···
15
14
Synopsis
16
15
========
17
16
18
-
.. c:function:: int ioctl( int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask )
19
-
:name: LIRC_SET_TRANSMITTER_MASK
17
+
.. c:macro:: LIRC_SET_TRANSMITTER_MASK
18
+
19
+
``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
20
20
21
21
Arguments
22
22
=========
···
27
25
28
26
``mask``
29
27
Mask with channels to enable tx. Channel 0 is the least significant bit.
30
-
31
28
32
29
Description
33
30
===========
···
42
41
When an invalid bit mask is given, i.e. a bit is set, even though the device
43
42
does not have so many transitters, then this ioctl returns the number of
44
43
available transitters and does nothing otherwise.
45
-
46
44
47
45
Return Value
48
46
============
+4
-4
Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst
+4
-4
Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc_set_wideband_receiver:
4
5
···
15
14
Synopsis
16
15
========
17
16
18
-
.. c:function:: int ioctl( int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable )
19
-
:name: LIRC_SET_WIDEBAND_RECEIVER
17
+
.. c:macro:: LIRC_SET_WIDEBAND_RECEIVER
18
+
19
+
``int ioctl(int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable)``
20
20
21
21
Arguments
22
22
=========
···
28
26
``enable``
29
27
enable = 1 means enable wideband receiver, enable = 0 means disable
30
28
wideband receiver.
31
-
32
29
33
30
Description
34
31
===========
···
47
46
carrier reports. In that case it will be disabled as soon as you disable
48
47
carrier reports. Trying to disable wide band receiver while carrier
49
48
reports are active will do nothing.
50
-
51
49
52
50
Return Value
53
51
============
+2
-5
Documentation/userspace-api/media/rc/lirc-write.rst
+2
-5
Documentation/userspace-api/media/rc/lirc-write.rst
···
1
1
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
+
.. c:namespace:: RC
2
3
3
4
.. _lirc-write:
4
5
···
12
11
13
12
lirc-write - Write to a LIRC device
14
13
15
-
16
14
Synopsis
17
15
========
18
16
···
19
19
20
20
#include <unistd.h>
21
21
22
-
23
22
.. c:function:: ssize_t write( int fd, void *buf, size_t count )
24
-
:name: lirc-write
25
23
26
24
Arguments
27
25
=========
···
36
38
Description
37
39
===========
38
40
39
-
:ref:`write() <lirc-write>` writes up to ``count`` bytes to the device
41
+
:c:func:`write()` writes up to ``count`` bytes to the device
40
42
referenced by the file descriptor ``fd`` from the buffer starting at
41
43
``buf``.
42
44
···
61
63
for the protocol or the scancode is not valid for the specified protocol,
62
64
``EINVAL`` is returned. The write function blocks until the scancode
63
65
is transmitted by the hardware.
64
-
65
66
66
67
Return Value
67
68
============