lirc.4: Remove ioctls and feature bits which were never implemented

The lirc header file included ioctls and feature bits which were
never implemented by any driver. They were removed in kernel
commit d55f09abe24b4dfadab246b6f217da547361cdb6

Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Reported-by: Alec Leamas <leamas.alec@gmail.com>
Signed-off-by: Sean Young <sean@mess.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Sean Young 2018-04-23 11:26:38 +01:00 committed by Michael Kerrisk
parent 50a8a7f404
commit 7734ee11e1
1 changed files with 2 additions and 90 deletions

View File

@ -78,9 +78,7 @@ The package reflects a timeout; see the
.B LIRC_SET_REC_TIMEOUT_REPORTS
ioctl.
.\"
.SS Reading input with the
.B LIRC_MODE_LIRCCODE
drivers
.SS Reading input with the LIRC_MODE_LIRCCODE drivers
.PP
In the \fBLIRC_MODE_LIRCCODE\fR
mode, the data returned by
@ -204,17 +202,11 @@ Currently serves no purpose since only
.BR LIRC_MODE_PULSE
is supported.
.TP
.BR LIRC_GET_SEND_CARRIER " (\fIvoid\fP)"
Get the modulation frequency (Hz).
.TP
.BR LIRC_SET_SEND_CARRIER " (\fIint\fP)"
Set the modulation frequency.
The argument is the frequency (Hz).
.TP
.BR LIRC_GET_SEND_CARRIER " (\fIvoid\fP)"
Get the modulation frequency used when decoding (Hz).
.TP
.BR SET_SEND_DUTY_CYCLE " (\fIint\fP)"
.BR LIRC_SET_SEND_DUTY_CYCLE " (\fIint\fP)"
Set the carrier duty cycle.
.I val
is a number in the range [0,100] which
@ -284,36 +276,6 @@ By default this should be turned off.
.BR LIRC_GET_REC_RESOLUTION " (\fIvoid\fP)"
Return the driver resolution (microseconds).
.TP
.BR LIRC_GET_MIN_FILTER_PULSE " (\fIvoid\fP)", " " \
LIRC_GET_MAX_FILTER_PULSE " (\fIvoid\fP)"
Some devices are able to filter out spikes in the incoming signal
using given filter rules.
These ioctls return the hardware capabilities that describe the bounds
of the possible filters.
Filter settings depend on the IR protocols that are expected.
.BR lircd (8)
derives the settings from all protocols definitions found in its
.BR lircd.conf (5)
config file.
.TP
.BR LIRC_GET_MIN_FILTER_SPACE " (\fIvoid\fP)", " " \
LIRC_GET_MAX_FILTER_SPACE " (\fIvoid\fP)"
See
.BR LIRC_GET_MIN_FILTER_PULSE .
.TP
.BR LIRC_SET_REC_FILTER " (\fIint\fP)"
Pulses/spaces shorter than this (microseconds) are filtered out by
hardware.
.TP
.BR LIRC_SET_REC_FILTER_PULSE " (\fIint\fP)", " " \
LIRC_SET_REC_FILTER_SPACE " (\fIint\fP)"
Pulses/spaces shorter than this (microseconds) are filtered out by
hardware.
If filters cannot be set independently for pulse/space, the
corresponding ioctls must return an error and
.BR LIRC_SET_REC_FILTER
should be used instead.
.TP
.BR LIRC_SET_TRANSMITTER_MASK
Enable the set of transmitters specified in
.IR val ,
@ -343,32 +305,6 @@ carrier reports.
In that case, it will be disabled as soon as you disable carrier reports.
Trying to disable a wide band receiver while carrier reports are active
will do nothing.
.TP
.BR LIRC_SETUP_START " (\fIvoid\fP), " LIRC_SETUP_END " (\fIvoid\fP)"
Setting of several driver parameters can be optimized by bracketing
the actual ioctl calls
.BR LIRC_SETUP_START
and
.BR LIRC_SETUP_END .
When a driver receives a
.BR LIRC_SETUP_START
ioctl, it can choose to not commit further setting changes to the
hardware until a
.BR LIRC_SETUP_END
is received.
But this is open to the driver implementation and every driver
must also handle parameter changes which are not encapsulated by
.BR LIRC_SETUP_START
and
.BR LIRC_SETUP_END .
Drivers can also choose to ignore these ioctls.
.TP
.BR LIRC_NOTIFY_DECODE " (\fIvoid\fP)"
This ioctl is called by
.BR lircd (8)
whenever a successful decoding of an incoming IR signal is possible.
This can be used by supporting hardware to give visual user
feedback, for example by flashing an LED.
.\"
.SH FEATURES
.PP
@ -378,14 +314,6 @@ The
ioctl returns a bit mask describing features of the driver.
The following bits may be returned in the mask:
.TP
.BR LIRC_CAN_REC_RAW
The driver is capable of receiving using
.BR LIRC_MODE_RAW .
.TP
.BR LIRC_CAN_REC_PULSE
The driver is capable of receiving using
.BR LIRC_MODE_PULSE .
.TP
.BR LIRC_CAN_REC_MODE2
The driver is capable of receiving using
.BR LIRC_MODE_MODE2 .
@ -426,10 +354,6 @@ The driver supports
The driver supports
.BR LIRC_SET_REC_TIMEOUT .
.TP
.BR LIRC_CAN_SET_REC_FILTER
The driver supports
.BR LIRC_SET_REC_FILTER .
.TP
.BR LIRC_CAN_MEASURE_CARRIER
The driver supports measuring of the modulation frequency using
.BR LIRC_SET_MEASURE_CARRIER_MODE .
@ -438,22 +362,10 @@ The driver supports measuring of the modulation frequency using
The driver supports learning mode using
.BR LIRC_SET_WIDEBAND_RECEIVER .
.TP
.BR LIRC_CAN_NOTIFY_DECODE
The driver supports
.BR LIRC_NOTIFY_DECODE .
.TP
.BR LIRC_CAN_SEND_RAW
The driver supports sending using
.BR LIRC_MODE_RAW .
.TP
.BR LIRC_CAN_SEND_PULSE
The driver supports sending using
.BR LIRC_MODE_PULSE .
.TP
.BR LIRC_CAN_SEND_MODE2
The driver supports sending using
.BR LIRC_MODE_MODE2 .
.TP
.BR LIRC_CAN_SEND_LIRCCODE
The driver supports sending.
(This is uncommon, since