tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
fork atom

[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>

Mauro Carvalho Chehab 15c19014 99547836

+48 -64
+2 -4
Documentation/media/uapi/rc/lirc-get-features.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *features) 17 + .. c:function:: int ioctl( int fd, LIRC_GET_FEATURES, __u32 *features) 18 + :name: LIRC_GET_FEATURES 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_GET_FEATURES 27 25 28 26 ``features`` 29 27 Bitmask with the LIRC features.
+2 -4
Documentation/media/uapi/rc/lirc-get-length.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *length ) 17 + .. c:function:: int ioctl( int fd, LIRC_GET_LENGTH, __u32 *length ) 18 + :name: LIRC_GET_LENGTH 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_GET_LENGTH 27 25 28 26 ``length`` 29 27 length, in bits
+6 -5
Documentation/media/uapi/rc/lirc-get-rec-mode.rst
··· 10 10 Name 11 11 ==== 12 12 13 - LIRC_GET_REC_MODE/LIRC_GET_REC_MODE - Get/set supported receive modes. 13 + LIRC_GET_REC_MODE/LIRC_SET_REC_MODE - Get/set supported receive modes. 14 14 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, __u32 rx_modes) 18 + .. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 rx_modes) 19 + :name: LIRC_GET_REC_MODE 20 + 21 + .. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 rx_modes) 22 + :name: LIRC_SET_REC_MODE 19 23 20 24 Arguments 21 25 ========= 22 26 23 27 ``fd`` 24 28 File descriptor returned by open(). 25 - 26 - ``request`` 27 - LIRC_GET_REC_MODE or LIRC_GET_REC_MODE 28 29 29 30 ``rx_modes`` 30 31 Bitmask with the supported transmit modes.
+2 -4
Documentation/media/uapi/rc/lirc-get-rec-resolution.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *microseconds) 17 + .. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds) 18 + :name: LIRC_GET_REC_RESOLUTION 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_GET_REC_RESOLUTION 27 25 28 26 ``microseconds`` 29 27 Resolution, in microseconds.
+5 -4
Documentation/media/uapi/rc/lirc-get-send-mode.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, __u32 *tx_modes ) 18 + .. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *tx_modes ) 19 + :name: LIRC_GET_SEND_MODE 20 + 21 + .. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *tx_modes ) 22 + :name: LIRC_SET_SEND_MODE 19 23 20 24 Arguments 21 25 ========= 22 26 23 27 ``fd`` 24 28 File descriptor returned by open(). 25 - 26 - ``request`` 27 - LIRC_GET_SEND_MODE 28 29 29 30 ``tx_modes`` 30 31 Bitmask with the supported transmit modes.
+5 -4
Documentation/media/uapi/rc/lirc-get-timeout.rst
··· 16 16 Synopsis 17 17 ======== 18 18 19 - .. c:function:: int ioctl( int fd, int request, __u32 *timeout) 19 + .. c:function:: int ioctl( int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout) 20 + :name: LIRC_GET_MIN_TIMEOUT 21 + 22 + .. c:function:: int ioctl( int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout) 23 + :name: LIRC_GET_MAX_TIMEOUT 20 24 21 25 Arguments 22 26 ========= 23 27 24 28 ``fd`` 25 29 File descriptor returned by open(). 26 - 27 - ``request`` 28 - LIRC_GET_MIN_TIMEOUT or LIRC_GET_MAX_TIMEOUT 29 30 30 31 ``timeout`` 31 32 Timeout, in microseconds.
+4 -1
Documentation/media/uapi/rc/lirc-read.rst
··· 21 21 22 22 23 23 .. c:function:: ssize_t read( int fd, void *buf, size_t count ) 24 + :name lirc-read 24 25 25 26 26 27 Arguments ··· 31 30 File descriptor returned by ``open()``. 32 31 33 32 ``buf`` 34 - ``count`` 33 + Buffer to be filled 35 34 35 + ``count`` 36 + Max number of bytes to read 36 37 37 38 Description 38 39 ===========
+2 -4
Documentation/media/uapi/rc/lirc-set-measure-carrier-mode.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *enable ) 17 + .. c:function:: int ioctl( int fd, LIRC_SET_MEASURE_CARRIER_MODE, __u32 *enable ) 18 + :name: LIRC_SET_MEASURE_CARRIER_MODE 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_SET_MEASURE_CARRIER_MODE 27 25 28 26 ``enable`` 29 27 enable = 1 means enable measure mode, enable = 0 means disable measure
+2 -4
Documentation/media/uapi/rc/lirc-set-rec-carrier-range.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, __u32 *frequency ) 18 + .. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER_RANGE, __u32 *frequency ) 19 + :name: LIRC_SET_REC_CARRIER_RANGE 19 20 20 21 Arguments 21 22 ========= 22 23 23 24 ``fd`` 24 25 File descriptor returned by open(). 25 - 26 - ``request`` 27 - LIRC_SET_REC_CARRIER_RANGE 28 26 29 27 ``frequency`` 30 28 Frequency of the carrier that modulates PWM data, in Hz.
+2 -4
Documentation/media/uapi/rc/lirc-set-rec-carrier.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, __u32 *frequency ) 18 + .. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER, __u32 *frequency ) 19 + :name: LIRC_SET_REC_CARRIER 19 20 20 21 Arguments 21 22 ========= 22 23 23 24 ``fd`` 24 25 File descriptor returned by open(). 25 - 26 - ``request`` 27 - LIRC_SET_REC_CARRIER 28 26 29 27 ``frequency`` 30 28 Frequency of the carrier that modulates PWM data, in Hz.
+2 -4
Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *enable ) 17 + .. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable ) 18 + :name: LIRC_SET_REC_TIMEOUT_REPORTS 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_SET_REC_TIMEOUT_REPORTS 27 25 28 26 ``enable`` 29 27 enable = 1 means enable timeout report, enable = 0 means disable timeout
+2 -4
Documentation/media/uapi/rc/lirc-set-rec-timeout.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *timeout ) 17 + .. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT, __u32 *timeout ) 18 + :name: LIRC_SET_REC_TIMEOUT 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_SET_REC_TIMEOUT 27 25 28 26 ``timeout`` 29 27 Timeout, in microseconds.
+2 -4
Documentation/media/uapi/rc/lirc-set-send-carrier.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, __u32 *frequency ) 18 + .. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency ) 19 + :name: LIRC_SET_SEND_CARRIER 19 20 20 21 Arguments 21 22 ========= 22 23 23 24 ``fd`` 24 25 File descriptor returned by open(). 25 - 26 - ``request`` 27 - LIRC_SET_SEND_CARRIER 28 26 29 27 ``frequency`` 30 28 Frequency of the carrier to be modulated, in Hz.
+2 -4
Documentation/media/uapi/rc/lirc-set-send-duty-cycle.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, __u32 *duty_cycle) 18 + .. c:function:: int ioctl( int fd, LIRC_SET_SEND_DUTY_CYCLE, __u32 *duty_cycle) 19 + :name: LIRC_SET_SEND_DUTY_CYCLE 19 20 20 21 Arguments 21 22 ========= 22 23 23 24 ``fd`` 24 25 File descriptor returned by open(). 25 - 26 - ``request`` 27 - LIRC_SET_SEND_DUTY_CYCLE 28 26 29 27 ``duty_cycle`` 30 28 Duty cicle, describing the pulse width in percent (from 1 to 99) of
+2 -4
Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *mask ) 17 + .. c:function:: int ioctl( int fd, LIRC_SET_TRANSMITTER_MASK, __u32 *mask ) 18 + :name: LIRC_SET_TRANSMITTER_MASK 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_SET_TRANSMITTER_MASK 27 25 28 26 ``mask`` 29 27 Mask with channels to enable tx. Channel 0 is the least significant bit.
+2 -4
Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst
··· 14 14 Synopsis 15 15 ======== 16 16 17 - .. c:function:: int ioctl( int fd, int request, __u32 *enable ) 17 + .. c:function:: int ioctl( int fd, LIRC_SET_WIDEBAND_RECEIVER, __u32 *enable ) 18 + :name: LIRC_SET_WIDEBAND_RECEIVER 18 19 19 20 Arguments 20 21 ========= 21 22 22 23 ``fd`` 23 24 File descriptor returned by open(). 24 - 25 - ``request`` 26 - LIRC_SET_WIDEBAND_RECEIVER 27 25 28 26 ``enable`` 29 27 enable = 1 means enable wideband receiver, enable = 0 means disable
+4 -2
Documentation/media/uapi/rc/lirc-write.rst
··· 21 21 22 22 23 23 .. c:function:: ssize_t write( int fd, void *buf, size_t count ) 24 - 24 + :name: lirc-write 25 25 26 26 Arguments 27 27 ========= ··· 30 30 File descriptor returned by ``open()``. 31 31 32 32 ``buf`` 33 - ``count`` 33 + Buffer with data to be written 34 34 35 + ``count`` 36 + Number of bytes at the buffer 35 37 36 38 Description 37 39 ===========