Skip to content

L
linux
Commit 5f536f4a authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files
Options

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 937e6805
Hide whitespace changes
Inline Side-by-side
Showing with 73 additions and 75 deletions
Documentation/userspace-api/media/rc/lirc-get-features.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_features:
......@@ -14,8 +15,9 @@ LIRC_GET_FEATURES - Get the underlying hardware device's features
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_GET_FEATURES, __u32 *features)
:name: LIRC_GET_FEATURES
.. c:macro:: LIRC_GET_FEATURES
``int ioctl(int fd, LIRC_GET_FEATURES, __u32 *features)``
Arguments
=========
......@@ -26,11 +28,9 @@ Arguments
``features``
Bitmask with the LIRC features.
Description
===========
Get the underlying hardware device's features. If a driver does not
announce support of certain features, calling of the corresponding ioctls
is undefined.
......@@ -184,7 +184,6 @@ LIRC features
Unused. Kept just to avoid breaking uAPI.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_rec_mode:
.. _lirc_set_rec_mode:
......@@ -15,11 +16,13 @@ LIRC_GET_REC_MODE/LIRC_SET_REC_MODE - Get/set current receive mode.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 *mode)
:name: LIRC_GET_REC_MODE
.. c:macro:: LIRC_GET_REC_MODE
.. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 *mode)
:name: LIRC_SET_REC_MODE
``int ioctl(int fd, LIRC_GET_REC_MODE, __u32 *mode)``
.. c:macro:: LIRC_SET_REC_MODE
``int ioctl(int fd, LIRC_SET_REC_MODE, __u32 *mode)``
Arguments
=========
......@@ -47,7 +50,6 @@ Return Value
:header-rows: 0
:stub-columns: 0
- .. row 1
- ``ENODEV``
......
Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_rec_resolution:
......@@ -14,8 +15,9 @@ LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microsecond
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)
:name: LIRC_GET_REC_RESOLUTION
.. c:macro:: LIRC_GET_REC_RESOLUTION
``int ioctl(int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)``
Arguments
=========
......@@ -26,7 +28,6 @@ Arguments
``microseconds``
Resolution, in microseconds.
Description
===========
......@@ -38,7 +39,6 @@ This ioctl returns the integer value with such resolution, with can be
used by userspace applications like lircd to automatically adjust the
tolerance value.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-get-send-mode.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_send_mode:
.. _lirc_set_send_mode:
......@@ -15,11 +16,13 @@ LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set current transmit mode.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *mode )
:name: LIRC_GET_SEND_MODE
.. c:macro:: LIRC_GET_SEND_MODE
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *mode )
:name: LIRC_SET_SEND_MODE
``int ioctl(int fd, LIRC_GET_SEND_MODE, __u32 *mode)``
.. c:macro:: LIRC_SET_SEND_MODE
``int ioctl(int fd, LIRC_SET_SEND_MODE, __u32 *mode)``
Arguments
=========
......@@ -30,7 +33,6 @@ Arguments
``mode``
The mode used for transmitting.
Description
===========
......@@ -44,14 +46,12 @@ modes the driver supports.
Return Value
============
.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- ``ENODEV``
......
Documentation/userspace-api/media/rc/lirc-get-timeout.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_get_min_timeout:
.. _lirc_get_max_timeout:
......@@ -16,11 +17,13 @@ range for IR receive.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)
:name: LIRC_GET_MIN_TIMEOUT
.. c:macro:: LIRC_GET_MIN_TIMEOUT
.. c:function:: int ioctl( int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)
:name: LIRC_GET_MAX_TIMEOUT
``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)``
.. c:macro:: LIRC_GET_MAX_TIMEOUT
``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)``
Arguments
=========
......@@ -31,7 +34,6 @@ Arguments
``timeout``
Timeout, in microseconds.
Description
===========
......@@ -47,7 +49,6 @@ that can be set.
both ioctls will return the same value even though the timeout
cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-read.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc-read:
......@@ -11,7 +12,6 @@ Name
lirc-read - Read from a LIRC device
Synopsis
========
......@@ -19,10 +19,7 @@ Synopsis
#include <unistd.h>
.. c:function:: ssize_t read( int fd, void *buf, size_t count )
:name: lirc-read
Arguments
=========
......@@ -39,9 +36,9 @@ Arguments
Description
===========
:ref:`read() <lirc-read>` attempts to read up to ``count`` bytes from file
:c:func:`read()` attempts to read up to ``count`` bytes from file
descriptor ``fd`` into the buffer starting at ``buf``. If ``count`` is zero,
:ref:`read() <lirc-read>` returns zero and has no other results. If ``count``
:c:func:`read()` returns zero and has no other results. If ``count``
is greater than ``SSIZE_MAX``, the result is unspecified.
The exact format of the data depends on what :ref:`lirc_modes` a driver
......@@ -59,7 +56,6 @@ by hardware decoders. The :c:type:`rc_proto` member is set to the
used for transmission, and ``scancode`` to the decoded scancode,
and the ``keycode`` set to the keycode or ``KEY_RESERVED``.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_measure_carrier_mode:
......@@ -14,8 +15,9 @@ LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable )
:name: LIRC_SET_MEASURE_CARRIER_MODE
.. c:macro:: LIRC_SET_MEASURE_CARRIER_MODE
``int ioctl(int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable)``
Arguments
=========
......@@ -27,7 +29,6 @@ Arguments
enable = 1 means enable measure mode, enable = 0 means disable measure
mode.
Description
===========
......@@ -37,7 +38,6 @@ Enable or disable 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.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_carrier_range:
......@@ -15,8 +16,9 @@ IR receive.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency )
:name: LIRC_SET_REC_CARRIER_RANGE
.. c:macro:: LIRC_SET_REC_CARRIER_RANGE
``int ioctl(int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency)``
Arguments
=========
......
Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_carrier:
......@@ -11,12 +12,12 @@ Name
LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER, __u32 *frequency )
:name: LIRC_SET_REC_CARRIER
.. c:macro:: LIRC_SET_REC_CARRIER
``int ioctl(int fd, LIRC_SET_REC_CARRIER, __u32 *frequency)``
Arguments
=========
......@@ -37,7 +38,6 @@ Set receive carrier used to modulate IR PWM pulses and spaces.
If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl
sets the upper bound frequency that will be recognized by the device.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_timeout_reports:
......@@ -14,8 +15,9 @@ LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable )
:name: LIRC_SET_REC_TIMEOUT_REPORTS
.. c:macro:: LIRC_SET_REC_TIMEOUT_REPORTS
``int ioctl(int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable)``
Arguments
=========
......@@ -27,7 +29,6 @@ Arguments
enable = 1 means enable timeout report, enable = 0 means disable timeout
reports.
Description
===========
......@@ -40,7 +41,6 @@ should be turned off.
This ioctl is only valid for :ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_rec_timeout:
.. _lirc_get_rec_timeout:
......@@ -15,11 +16,13 @@ LIRC_GET_REC_TIMEOUT/LIRC_SET_REC_TIMEOUT - Get/set the integer value for IR ina
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout )
:name: LIRC_GET_REC_TIMEOUT
.. c:macro:: LIRC_GET_REC_TIMEOUT
.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout )
:name: LIRC_SET_REC_TIMEOUT
``int ioctl(int fd, LIRC_GET_REC_TIMEOUT, __u32 *timeout)``
.. c:macro:: LIRC_SET_REC_TIMEOUT
``int ioctl(int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout)``
Arguments
=========
......@@ -30,7 +33,6 @@ Arguments
``timeout``
Timeout, in microseconds.
Description
===========
......@@ -45,7 +47,6 @@ given value should be set.
The range of supported timeout is given by :ref:`LIRC_GET_MIN_TIMEOUT`.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_send_carrier:
......@@ -11,12 +12,12 @@ Name
LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency )
:name: LIRC_SET_SEND_CARRIER
.. c:macro:: LIRC_SET_SEND_CARRIER
``int ioctl(int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency)``
Arguments
=========
......@@ -32,7 +33,6 @@ Description
Set send carrier used to modulate IR PWM pulses and spaces.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_send_duty_cycle:
......@@ -15,8 +16,9 @@ IR transmit.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)
:name: LIRC_SET_SEND_DUTY_CYCLE
.. c:macro:: LIRC_SET_SEND_DUTY_CYCLE
``int ioctl(int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)``
Arguments
=========
......@@ -28,7 +30,6 @@ Arguments
Duty cicle, describing the pulse width in percent (from 1 to 99) of
the total cycle. Values 0 and 100 are reserved.
Description
===========
......@@ -38,7 +39,6 @@ Currently, no special meaning is defined for 0 or 100, but this
could be used to switch off carrier generation in the future, so
these values should be reserved.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_transmitter_mask:
......@@ -14,8 +15,9 @@ LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask )
:name: LIRC_SET_TRANSMITTER_MASK
.. c:macro:: LIRC_SET_TRANSMITTER_MASK
``int ioctl(int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask)``
Arguments
=========
......@@ -26,7 +28,6 @@ Arguments
``mask``
Mask with channels to enable tx. Channel 0 is the least significant bit.
Description
===========
......@@ -42,7 +43,6 @@ 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.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc_set_wideband_receiver:
......@@ -14,8 +15,9 @@ LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
Synopsis
========
.. c:function:: int ioctl( int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable )
:name: LIRC_SET_WIDEBAND_RECEIVER
.. c:macro:: LIRC_SET_WIDEBAND_RECEIVER
``int ioctl(int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable)``
Arguments
=========
......@@ -27,7 +29,6 @@ Arguments
enable = 1 means enable wideband receiver, enable = 0 means disable
wideband receiver.
Description
===========
......@@ -47,7 +48,6 @@ reduced range of reception.
carrier reports. Trying to disable wide band receiver while carrier
reports are active will do nothing.
Return Value
============
......
Documentation/userspace-api/media/rc/lirc-write.rst
View file @ 5f536f4a
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
.. c:namespace:: RC
.. _lirc-write:
......@@ -11,7 +12,6 @@ Name
lirc-write - Write to a LIRC device
Synopsis
========
......@@ -19,9 +19,7 @@ Synopsis
#include <unistd.h>
.. c:function:: ssize_t write( int fd, void *buf, size_t count )
:name: lirc-write
Arguments
=========
......@@ -38,7 +36,7 @@ Arguments
Description
===========
:ref:`write() <lirc-write>` writes up to ``count`` bytes to the device
:c:func:`write()` writes up to ``count`` bytes to the device
referenced by the file descriptor ``fd`` from the buffer starting at
``buf``.
......@@ -64,7 +62,6 @@ for the protocol or the scancode is not valid for the specified protocol,
``EINVAL`` is returned. The write function blocks until the scancode
is transmitted by the hardware.
Return Value
============
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7