tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
rfkill: Fix several typos in documentation
Signed-off-by: Peter Meerwald-Stadler <pmeerw@pmeerw.net>
Signed-off-by: Johannes Berg <johannes@sipsolutions.net>
authored by
Peter Meerwald
and committed by
Johannes Berg
cba340fa
e529f4d6
+8
-10
+8
-10
Documentation/rfkill.txt
+8
-10
Documentation/rfkill.txt
···
9
9
Introduction
10
10
============
11
11
12
-
The rfkill subsystem provides a generic interface to disabling any radio
12
+
The rfkill subsystem provides a generic interface for disabling any radio
13
13
transmitter in the system. When a transmitter is blocked, it shall not
14
14
radiate any power.
15
15
···
45
45
* the rfkill drivers.
46
46
47
47
The rfkill core provides API for kernel drivers to register their radio
48
-
transmitter with the kernel, methods for turning it on and off and, letting
48
+
transmitter with the kernel, methods for turning it on and off, and letting
49
49
the system know about hardware-disabled states that may be implemented on
50
50
the device.
51
51
···
54
54
section below.
55
55
56
56
When the device is hard-blocked (either by a call to rfkill_set_hw_state()
57
-
or from query_hw_block) set_block() will be invoked for additional software
57
+
or from query_hw_block), set_block() will be invoked for additional software
58
58
block, but drivers can ignore the method call since they can use the return
59
59
value of the function rfkill_set_hw_state() to sync the software state
60
60
instead of keeping track of calls to set_block(). In fact, drivers should
···
65
65
Kernel API
66
66
==========
67
67
68
-
69
68
Drivers for radio transmitters normally implement an rfkill driver.
70
69
71
70
Platform drivers might implement input devices if the rfkill button is just
···
74
75
75
76
For some platforms, it is possible that the hardware state changes during
76
77
suspend/hibernation, in which case it will be necessary to update the rfkill
77
-
core with the current state is at resume time.
78
+
core with the current state at resume time.
78
79
79
80
To create an rfkill driver, driver's Kconfig needs to have::
80
81
81
82
depends on RFKILL || !RFKILL
82
83
83
84
to ensure the driver cannot be built-in when rfkill is modular. The !RFKILL
84
-
case allows the driver to be built when rfkill is not configured, which
85
+
case allows the driver to be built when rfkill is not configured, in which
85
86
case all rfkill API can still be used but will be provided by static inlines
86
87
which compile to almost nothing.
87
88
···
90
91
assign the poll_hw_block() callback (then the rfkill core will poll the
91
92
device). Don't do this unless you cannot get the event in any other way.
92
93
93
-
RFKill provides per-switch LED triggers, which can be used to drive LEDs
94
+
rfkill provides per-switch LED triggers, which can be used to drive LEDs
94
95
according to the switch state (LED_FULL when blocked, LED_OFF otherwise).
95
96
96
97
···
113
114
hotplugged devices.
114
115
115
116
After an application opens /dev/rfkill, it can read the current state of all
116
-
devices. Changes can be either obtained by either polling the descriptor for
117
+
devices. Changes can be obtained by either polling the descriptor for
117
118
hotplug or state change events or by listening for uevents emitted by the
118
119
rfkill core framework.
119
120
···
126
127
RFKILL_STATE
127
128
RFKILL_TYPE
128
129
129
-
The contents of these variables corresponds to the "name", "state" and
130
+
The content of these variables corresponds to the "name", "state" and
130
131
"type" sysfs files explained above.
131
-
132
132
133
133
For further details consult Documentation/ABI/stable/sysfs-class-rfkill.