mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git
synced 2026-04-23 05:56:14 -04:00
docs: ABI: testing: make the files compatible with ReST output
Some files over there won't parse well by Sphinx. Fix them. Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for IIO Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com> Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
committed by
Greg Kroah-Hartman
parent
98913408c5
commit
3443333284
@@ -21,15 +21,22 @@ KernelVersion: 2.6.36
|
||||
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
|
||||
Description:
|
||||
Reading this file returns a list of available protocols,
|
||||
something like:
|
||||
something like::
|
||||
|
||||
"rc5 [rc6] nec jvc [sony]"
|
||||
|
||||
Enabled protocols are shown in [] brackets.
|
||||
|
||||
Writing "+proto" will add a protocol to the list of enabled
|
||||
protocols.
|
||||
|
||||
Writing "-proto" will remove a protocol from the list of enabled
|
||||
protocols.
|
||||
|
||||
Writing "proto" will enable only "proto".
|
||||
|
||||
Writing "none" will disable all protocols.
|
||||
|
||||
Write fails with EINVAL if an invalid protocol combination or
|
||||
unknown protocol name is used.
|
||||
|
||||
@@ -39,11 +46,13 @@ KernelVersion: 3.15
|
||||
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
|
||||
Description:
|
||||
Sets the scancode filter expected value.
|
||||
|
||||
Use in combination with /sys/class/rc/rcN/filter_mask to set the
|
||||
expected value of the bits set in the filter mask.
|
||||
If the hardware supports it then scancodes which do not match
|
||||
the filter will be ignored. Otherwise the write will fail with
|
||||
an error.
|
||||
|
||||
This value may be reset to 0 if the current protocol is altered.
|
||||
|
||||
What: /sys/class/rc/rcN/filter_mask
|
||||
@@ -56,9 +65,11 @@ Description:
|
||||
of the scancode which should be compared against the expected
|
||||
value. A value of 0 disables the filter to allow all valid
|
||||
scancodes to be processed.
|
||||
|
||||
If the hardware supports it then scancodes which do not match
|
||||
the filter will be ignored. Otherwise the write will fail with
|
||||
an error.
|
||||
|
||||
This value may be reset to 0 if the current protocol is altered.
|
||||
|
||||
What: /sys/class/rc/rcN/wakeup_protocols
|
||||
@@ -67,15 +78,22 @@ KernelVersion: 4.11
|
||||
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
|
||||
Description:
|
||||
Reading this file returns a list of available protocols to use
|
||||
for the wakeup filter, something like:
|
||||
for the wakeup filter, something like::
|
||||
|
||||
"rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce"
|
||||
|
||||
Note that protocol variants are listed, so "nec", "sony",
|
||||
"rc-5", "rc-6" have their different bit length encodings
|
||||
listed if available.
|
||||
|
||||
The enabled wakeup protocol is shown in [] brackets.
|
||||
|
||||
Only one protocol can be selected at a time.
|
||||
|
||||
Writing "proto" will use "proto" for wakeup events.
|
||||
|
||||
Writing "none" will disable wakeup.
|
||||
|
||||
Write fails with EINVAL if an invalid protocol combination or
|
||||
unknown protocol name is used, or if wakeup is not supported by
|
||||
the hardware.
|
||||
@@ -86,13 +104,17 @@ KernelVersion: 3.15
|
||||
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
|
||||
Description:
|
||||
Sets the scancode wakeup filter expected value.
|
||||
|
||||
Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
|
||||
set the expected value of the bits set in the wakeup filter mask
|
||||
to trigger a system wake event.
|
||||
|
||||
If the hardware supports it and wakeup_filter_mask is not 0 then
|
||||
scancodes which match the filter will wake the system from e.g.
|
||||
suspend to RAM or power off.
|
||||
|
||||
Otherwise the write will fail with an error.
|
||||
|
||||
This value may be reset to 0 if the wakeup protocol is altered.
|
||||
|
||||
What: /sys/class/rc/rcN/wakeup_filter_mask
|
||||
@@ -101,11 +123,15 @@ KernelVersion: 3.15
|
||||
Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
|
||||
Description:
|
||||
Sets the scancode wakeup filter mask of bits to compare.
|
||||
|
||||
Use in combination with /sys/class/rc/rcN/wakeup_filter to set
|
||||
the bits of the scancode which should be compared against the
|
||||
expected value to trigger a system wake event.
|
||||
|
||||
If the hardware supports it and wakeup_filter_mask is not 0 then
|
||||
scancodes which match the filter will wake the system from e.g.
|
||||
suspend to RAM or power off.
|
||||
|
||||
Otherwise the write will fail with an error.
|
||||
|
||||
This value may be reset to 0 if the wakeup protocol is altered.
|
||||
|
||||
Reference in New Issue
Block a user