[media] docs-rst: Convert LIRC uAPI to use C function references
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Родитель
9954783662
Коммит
15c190146c
|
@ -14,7 +14,8 @@ LIRC_GET_FEATURES - Get the underlying hardware device's features
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *features)
|
||||
.. c:function:: int ioctl( int fd, LIRC_GET_FEATURES, __u32 *features)
|
||||
:name: LIRC_GET_FEATURES
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_FEATURES
|
||||
|
||||
``features``
|
||||
Bitmask with the LIRC features.
|
||||
|
||||
|
|
|
@ -14,7 +14,8 @@ LIRC_GET_LENGTH - Retrieves the code length in bits.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *length )
|
||||
.. c:function:: int ioctl( int fd, LIRC_GET_LENGTH, __u32 *length )
|
||||
:name: LIRC_GET_LENGTH
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_LENGTH
|
||||
|
||||
``length``
|
||||
length, in bits
|
||||
|
||||
|
|
|
@ -10,12 +10,16 @@ ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_MODE
|
|||
Name
|
||||
====
|
||||
|
||||
LIRC_GET_REC_MODE/LIRC_GET_REC_MODE - Get/set supported receive modes.
|
||||
LIRC_GET_REC_MODE/LIRC_SET_REC_MODE - Get/set supported receive modes.
|
||||
|
||||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 rx_modes)
|
||||
.. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 rx_modes)
|
||||
:name: LIRC_GET_REC_MODE
|
||||
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 rx_modes)
|
||||
:name: LIRC_SET_REC_MODE
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -23,9 +27,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_REC_MODE or LIRC_GET_REC_MODE
|
||||
|
||||
``rx_modes``
|
||||
Bitmask with the supported transmit modes.
|
||||
|
||||
|
|
|
@ -14,7 +14,8 @@ LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microsecond
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *microseconds)
|
||||
.. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)
|
||||
:name: LIRC_GET_REC_RESOLUTION
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_REC_RESOLUTION
|
||||
|
||||
``microseconds``
|
||||
Resolution, in microseconds.
|
||||
|
||||
|
|
|
@ -15,7 +15,11 @@ LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set supported transmit mode.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *tx_modes )
|
||||
.. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *tx_modes )
|
||||
:name: LIRC_GET_SEND_MODE
|
||||
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *tx_modes )
|
||||
:name: LIRC_SET_SEND_MODE
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -23,9 +27,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_SEND_MODE
|
||||
|
||||
``tx_modes``
|
||||
Bitmask with the supported transmit modes.
|
||||
|
||||
|
|
|
@ -16,7 +16,11 @@ range for IR receive.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *timeout)
|
||||
.. c:function:: int ioctl( int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)
|
||||
:name: LIRC_GET_MIN_TIMEOUT
|
||||
|
||||
.. c:function:: int ioctl( int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)
|
||||
:name: LIRC_GET_MAX_TIMEOUT
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -24,9 +28,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_GET_MIN_TIMEOUT or LIRC_GET_MAX_TIMEOUT
|
||||
|
||||
``timeout``
|
||||
Timeout, in microseconds.
|
||||
|
||||
|
|
|
@ -21,6 +21,7 @@ Synopsis
|
|||
|
||||
|
||||
.. c:function:: ssize_t read( int fd, void *buf, size_t count )
|
||||
:name lirc-read
|
||||
|
||||
|
||||
Arguments
|
||||
|
@ -30,8 +31,10 @@ Arguments
|
|||
File descriptor returned by ``open()``.
|
||||
|
||||
``buf``
|
||||
``count``
|
||||
Buffer to be filled
|
||||
|
||||
``count``
|
||||
Max number of bytes to read
|
||||
|
||||
Description
|
||||
===========
|
||||
|
|
|
@ -14,7 +14,8 @@ LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *enable )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable )
|
||||
:name: LIRC_SET_MEASURE_CARRIER_MODE
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_MEASURE_CARRIER_MODE
|
||||
|
||||
``enable``
|
||||
enable = 1 means enable measure mode, enable = 0 means disable measure
|
||||
mode.
|
||||
|
|
|
@ -15,7 +15,8 @@ IR receive.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *frequency )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency )
|
||||
:name: LIRC_SET_REC_CARRIER_RANGE
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -23,9 +24,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_REC_CARRIER_RANGE
|
||||
|
||||
``frequency``
|
||||
Frequency of the carrier that modulates PWM data, in Hz.
|
||||
|
||||
|
|
|
@ -15,7 +15,8 @@ LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *frequency )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER, __u32 *frequency )
|
||||
:name: LIRC_SET_REC_CARRIER
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -23,9 +24,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_REC_CARRIER
|
||||
|
||||
``frequency``
|
||||
Frequency of the carrier that modulates PWM data, in Hz.
|
||||
|
||||
|
|
|
@ -14,7 +14,8 @@ LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *enable )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable )
|
||||
:name: LIRC_SET_REC_TIMEOUT_REPORTS
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_REC_TIMEOUT_REPORTS
|
||||
|
||||
``enable``
|
||||
enable = 1 means enable timeout report, enable = 0 means disable timeout
|
||||
reports.
|
||||
|
|
|
@ -14,7 +14,8 @@ LIRC_SET_REC_TIMEOUT - sets the integer value for IR inactivity timeout.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *timeout )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout )
|
||||
:name: LIRC_SET_REC_TIMEOUT
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_REC_TIMEOUT
|
||||
|
||||
``timeout``
|
||||
Timeout, in microseconds.
|
||||
|
||||
|
|
|
@ -15,7 +15,8 @@ LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *frequency )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency )
|
||||
:name: LIRC_SET_SEND_CARRIER
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -23,9 +24,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_SEND_CARRIER
|
||||
|
||||
``frequency``
|
||||
Frequency of the carrier to be modulated, in Hz.
|
||||
|
||||
|
|
|
@ -15,7 +15,8 @@ IR transmit.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *duty_cycle)
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle)
|
||||
:name: LIRC_SET_SEND_DUTY_CYCLE
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -23,9 +24,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_SEND_DUTY_CYCLE
|
||||
|
||||
``duty_cycle``
|
||||
Duty cicle, describing the pulse width in percent (from 1 to 99) of
|
||||
the total cycle. Values 0 and 100 are reserved.
|
||||
|
|
|
@ -14,7 +14,8 @@ LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *mask )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask )
|
||||
:name: LIRC_SET_TRANSMITTER_MASK
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_TRANSMITTER_MASK
|
||||
|
||||
``mask``
|
||||
Mask with channels to enable tx. Channel 0 is the least significant bit.
|
||||
|
||||
|
|
|
@ -14,7 +14,8 @@ LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
|
|||
Synopsis
|
||||
========
|
||||
|
||||
.. c:function:: int ioctl( int fd, int request, __u32 *enable )
|
||||
.. c:function:: int ioctl( int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable )
|
||||
:name: LIRC_SET_WIDEBAND_RECEIVER
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -22,9 +23,6 @@ Arguments
|
|||
``fd``
|
||||
File descriptor returned by open().
|
||||
|
||||
``request``
|
||||
LIRC_SET_WIDEBAND_RECEIVER
|
||||
|
||||
``enable``
|
||||
enable = 1 means enable wideband receiver, enable = 0 means disable
|
||||
wideband receiver.
|
||||
|
|
|
@ -21,7 +21,7 @@ Synopsis
|
|||
|
||||
|
||||
.. c:function:: ssize_t write( int fd, void *buf, size_t count )
|
||||
|
||||
:name: lirc-write
|
||||
|
||||
Arguments
|
||||
=========
|
||||
|
@ -30,8 +30,10 @@ Arguments
|
|||
File descriptor returned by ``open()``.
|
||||
|
||||
``buf``
|
||||
``count``
|
||||
Buffer with data to be written
|
||||
|
||||
``count``
|
||||
Number of bytes at the buffer
|
||||
|
||||
Description
|
||||
===========
|
||||
|
|
Загрузка…
Ссылка в новой задаче