Commit 15c19014 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 99547836
...@@ -14,7 +14,8 @@ LIRC_GET_FEATURES - Get the underlying hardware device's features ...@@ -14,7 +14,8 @@ LIRC_GET_FEATURES - Get the underlying hardware device's features
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_GET_FEATURES
``features`` ``features``
Bitmask with the LIRC features. Bitmask with the LIRC features.
......
...@@ -14,7 +14,8 @@ LIRC_GET_LENGTH - Retrieves the code length in bits. ...@@ -14,7 +14,8 @@ LIRC_GET_LENGTH - Retrieves the code length in bits.
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_GET_LENGTH
``length`` ``length``
length, in bits length, in bits
......
...@@ -10,12 +10,16 @@ ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_MODE ...@@ -10,12 +10,16 @@ ioctls LIRC_GET_REC_MODE and LIRC_SET_REC_MODE
Name 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 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 Arguments
========= =========
...@@ -23,9 +27,6 @@ Arguments ...@@ -23,9 +27,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_GET_REC_MODE or LIRC_GET_REC_MODE
``rx_modes`` ``rx_modes``
Bitmask with the supported transmit modes. Bitmask with the supported transmit modes.
......
...@@ -14,7 +14,8 @@ LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microsecond ...@@ -14,7 +14,8 @@ LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microsecond
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_GET_REC_RESOLUTION
``microseconds`` ``microseconds``
Resolution, in microseconds. Resolution, in microseconds.
......
...@@ -15,7 +15,11 @@ LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set supported transmit mode. ...@@ -15,7 +15,11 @@ LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set supported transmit mode.
Synopsis 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 Arguments
========= =========
...@@ -23,9 +27,6 @@ Arguments ...@@ -23,9 +27,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_GET_SEND_MODE
``tx_modes`` ``tx_modes``
Bitmask with the supported transmit modes. Bitmask with the supported transmit modes.
......
...@@ -16,7 +16,11 @@ range for IR receive. ...@@ -16,7 +16,11 @@ range for IR receive.
Synopsis 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 Arguments
========= =========
...@@ -24,9 +28,6 @@ Arguments ...@@ -24,9 +28,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_GET_MIN_TIMEOUT or LIRC_GET_MAX_TIMEOUT
``timeout`` ``timeout``
Timeout, in microseconds. Timeout, in microseconds.
......
...@@ -21,6 +21,7 @@ Synopsis ...@@ -21,6 +21,7 @@ Synopsis
.. c:function:: ssize_t read( int fd, void *buf, size_t count ) .. c:function:: ssize_t read( int fd, void *buf, size_t count )
:name lirc-read
Arguments Arguments
...@@ -30,8 +31,10 @@ Arguments ...@@ -30,8 +31,10 @@ Arguments
File descriptor returned by ``open()``. File descriptor returned by ``open()``.
``buf`` ``buf``
``count`` Buffer to be filled
``count``
Max number of bytes to read
Description Description
=========== ===========
......
...@@ -14,7 +14,8 @@ LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode ...@@ -14,7 +14,8 @@ LIRC_SET_MEASURE_CARRIER_MODE - enable or disable measure mode
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_MEASURE_CARRIER_MODE
``enable`` ``enable``
enable = 1 means enable measure mode, enable = 0 means disable measure enable = 1 means enable measure mode, enable = 0 means disable measure
mode. mode.
......
...@@ -15,7 +15,8 @@ IR receive. ...@@ -15,7 +15,8 @@ IR receive.
Synopsis 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 Arguments
========= =========
...@@ -23,9 +24,6 @@ Arguments ...@@ -23,9 +24,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_REC_CARRIER_RANGE
``frequency`` ``frequency``
Frequency of the carrier that modulates PWM data, in Hz. 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. ...@@ -15,7 +15,8 @@ LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive.
Synopsis 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 Arguments
========= =========
...@@ -23,9 +24,6 @@ Arguments ...@@ -23,9 +24,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_REC_CARRIER
``frequency`` ``frequency``
Frequency of the carrier that modulates PWM data, in Hz. 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 ...@@ -14,7 +14,8 @@ LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_REC_TIMEOUT_REPORTS
``enable`` ``enable``
enable = 1 means enable timeout report, enable = 0 means disable timeout enable = 1 means enable timeout report, enable = 0 means disable timeout
reports. reports.
......
...@@ -14,7 +14,8 @@ LIRC_SET_REC_TIMEOUT - sets the integer value for IR inactivity timeout. ...@@ -14,7 +14,8 @@ LIRC_SET_REC_TIMEOUT - sets the integer value for IR inactivity timeout.
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_REC_TIMEOUT
``timeout`` ``timeout``
Timeout, in microseconds. Timeout, in microseconds.
......
...@@ -15,7 +15,8 @@ LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX. ...@@ -15,7 +15,8 @@ LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
Synopsis 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 Arguments
========= =========
...@@ -23,9 +24,6 @@ Arguments ...@@ -23,9 +24,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_SEND_CARRIER
``frequency`` ``frequency``
Frequency of the carrier to be modulated, in Hz. Frequency of the carrier to be modulated, in Hz.
......
...@@ -15,7 +15,8 @@ IR transmit. ...@@ -15,7 +15,8 @@ IR transmit.
Synopsis 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 Arguments
========= =========
...@@ -23,9 +24,6 @@ Arguments ...@@ -23,9 +24,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_SEND_DUTY_CYCLE
``duty_cycle`` ``duty_cycle``
Duty cicle, describing the pulse width in percent (from 1 to 99) of Duty cicle, describing the pulse width in percent (from 1 to 99) of
the total cycle. Values 0 and 100 are reserved. 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 ...@@ -14,7 +14,8 @@ LIRC_SET_TRANSMITTER_MASK - Enables send codes on a given set of transmitters
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_TRANSMITTER_MASK
``mask`` ``mask``
Mask with channels to enable tx. Channel 0 is the least significant bit. 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. ...@@ -14,7 +14,8 @@ LIRC_SET_WIDEBAND_RECEIVER - enable wide band receiver.
Synopsis 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 Arguments
========= =========
...@@ -22,9 +23,6 @@ Arguments ...@@ -22,9 +23,6 @@ Arguments
``fd`` ``fd``
File descriptor returned by open(). File descriptor returned by open().
``request``
LIRC_SET_WIDEBAND_RECEIVER
``enable`` ``enable``
enable = 1 means enable wideband receiver, enable = 0 means disable enable = 1 means enable wideband receiver, enable = 0 means disable
wideband receiver. wideband receiver.
......
...@@ -21,7 +21,7 @@ Synopsis ...@@ -21,7 +21,7 @@ Synopsis
.. c:function:: ssize_t write( int fd, void *buf, size_t count ) .. c:function:: ssize_t write( int fd, void *buf, size_t count )
:name: lirc-write
Arguments Arguments
========= =========
...@@ -30,8 +30,10 @@ Arguments ...@@ -30,8 +30,10 @@ Arguments
File descriptor returned by ``open()``. File descriptor returned by ``open()``.
``buf`` ``buf``
``count`` Buffer with data to be written
``count``
Number of bytes at the buffer
Description Description
=========== ===========
......
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