summaryrefslogtreecommitdiffstats
path: root/Documentation/rfkill.txt
diff options
context:
space:
mode:
authorPeter Meerwald <pmeerw@pmeerw.net>2018-06-04 17:02:03 -0400
committerJohannes Berg <johannes@sipsolutions.net>2018-06-15 07:36:08 -0400
commitcba340fa89bc9834cf8ac648c060f45ee955beb4 (patch)
tree6b80fb76605c3055fbc4690d32bd6ea9f5d49079 /Documentation/rfkill.txt
parente529f4d651595fa6c007d3ddeaccf22babbf083c (diff)
rfkill: Fix several typos in documentation
Signed-off-by: Peter Meerwald-Stadler <pmeerw@pmeerw.net> Signed-off-by: Johannes Berg <johannes@sipsolutions.net>
Diffstat (limited to 'Documentation/rfkill.txt')
-rw-r--r--Documentation/rfkill.txt18
1 files changed, 8 insertions, 10 deletions
diff --git a/Documentation/rfkill.txt b/Documentation/rfkill.txt
index a289285d2412..7d3684e81df6 100644
--- a/Documentation/rfkill.txt
+++ b/Documentation/rfkill.txt
@@ -9,7 +9,7 @@ rfkill - RF kill switch support
9Introduction 9Introduction
10============ 10============
11 11
12The rfkill subsystem provides a generic interface to disabling any radio 12The rfkill subsystem provides a generic interface for disabling any radio
13transmitter in the system. When a transmitter is blocked, it shall not 13transmitter in the system. When a transmitter is blocked, it shall not
14radiate any power. 14radiate any power.
15 15
@@ -45,7 +45,7 @@ The rfkill subsystem is composed of three main components:
45 * the rfkill drivers. 45 * the rfkill drivers.
46 46
47The rfkill core provides API for kernel drivers to register their radio 47The rfkill core provides API for kernel drivers to register their radio
48transmitter with the kernel, methods for turning it on and off and, letting 48transmitter with the kernel, methods for turning it on and off, and letting
49the system know about hardware-disabled states that may be implemented on 49the system know about hardware-disabled states that may be implemented on
50the device. 50the device.
51 51
@@ -54,7 +54,7 @@ ways for userspace to query the current states. See the "Userspace support"
54section below. 54section below.
55 55
56When the device is hard-blocked (either by a call to rfkill_set_hw_state() 56When the device is hard-blocked (either by a call to rfkill_set_hw_state()
57or from query_hw_block) set_block() will be invoked for additional software 57or from query_hw_block), set_block() will be invoked for additional software
58block, but drivers can ignore the method call since they can use the return 58block, but drivers can ignore the method call since they can use the return
59value of the function rfkill_set_hw_state() to sync the software state 59value of the function rfkill_set_hw_state() to sync the software state
60instead of keeping track of calls to set_block(). In fact, drivers should 60instead of keeping track of calls to set_block(). In fact, drivers should
@@ -65,7 +65,6 @@ keeps track of soft and hard block separately.
65Kernel API 65Kernel API
66========== 66==========
67 67
68
69Drivers for radio transmitters normally implement an rfkill driver. 68Drivers for radio transmitters normally implement an rfkill driver.
70 69
71Platform drivers might implement input devices if the rfkill button is just 70Platform drivers might implement input devices if the rfkill button is just
@@ -75,14 +74,14 @@ a way to turn on/off the transmitter(s).
75 74
76For some platforms, it is possible that the hardware state changes during 75For some platforms, it is possible that the hardware state changes during
77suspend/hibernation, in which case it will be necessary to update the rfkill 76suspend/hibernation, in which case it will be necessary to update the rfkill
78core with the current state is at resume time. 77core with the current state at resume time.
79 78
80To create an rfkill driver, driver's Kconfig needs to have:: 79To create an rfkill driver, driver's Kconfig needs to have::
81 80
82 depends on RFKILL || !RFKILL 81 depends on RFKILL || !RFKILL
83 82
84to ensure the driver cannot be built-in when rfkill is modular. The !RFKILL 83to ensure the driver cannot be built-in when rfkill is modular. The !RFKILL
85case allows the driver to be built when rfkill is not configured, which 84case allows the driver to be built when rfkill is not configured, in which
86case all rfkill API can still be used but will be provided by static inlines 85case all rfkill API can still be used but will be provided by static inlines
87which compile to almost nothing. 86which compile to almost nothing.
88 87
@@ -91,7 +90,7 @@ rfkill drivers that control devices that can be hard-blocked unless they also
91assign the poll_hw_block() callback (then the rfkill core will poll the 90assign the poll_hw_block() callback (then the rfkill core will poll the
92device). Don't do this unless you cannot get the event in any other way. 91device). Don't do this unless you cannot get the event in any other way.
93 92
94RFKill provides per-switch LED triggers, which can be used to drive LEDs 93rfkill provides per-switch LED triggers, which can be used to drive LEDs
95according to the switch state (LED_FULL when blocked, LED_OFF otherwise). 94according to the switch state (LED_FULL when blocked, LED_OFF otherwise).
96 95
97 96
@@ -114,7 +113,7 @@ a specified type) into a state which also updates the default state for
114hotplugged devices. 113hotplugged devices.
115 114
116After an application opens /dev/rfkill, it can read the current state of all 115After an application opens /dev/rfkill, it can read the current state of all
117devices. Changes can be either obtained by either polling the descriptor for 116devices. Changes can be obtained by either polling the descriptor for
118hotplug or state change events or by listening for uevents emitted by the 117hotplug or state change events or by listening for uevents emitted by the
119rfkill core framework. 118rfkill core framework.
120 119
@@ -127,8 +126,7 @@ environment variables set::
127 RFKILL_STATE 126 RFKILL_STATE
128 RFKILL_TYPE 127 RFKILL_TYPE
129 128
130The contents of these variables corresponds to the "name", "state" and 129The content of these variables corresponds to the "name", "state" and
131"type" sysfs files explained above. 130"type" sysfs files explained above.
132 131
133
134For further details consult Documentation/ABI/stable/sysfs-class-rfkill. 132For further details consult Documentation/ABI/stable/sysfs-class-rfkill.