diff options
author | Peter Meerwald <pmeerw@pmeerw.net> | 2018-06-04 17:02:03 -0400 |
---|---|---|
committer | Johannes Berg <johannes@sipsolutions.net> | 2018-06-15 07:36:08 -0400 |
commit | cba340fa89bc9834cf8ac648c060f45ee955beb4 (patch) | |
tree | 6b80fb76605c3055fbc4690d32bd6ea9f5d49079 /Documentation/rfkill.txt | |
parent | e529f4d651595fa6c007d3ddeaccf22babbf083c (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.txt | 18 |
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 | |||
9 | Introduction | 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 | transmitter in the system. When a transmitter is blocked, it shall not | 13 | transmitter in the system. When a transmitter is blocked, it shall not |
14 | radiate any power. | 14 | radiate 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 | ||
47 | The rfkill core provides API for kernel drivers to register their radio | 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 | the system know about hardware-disabled states that may be implemented on | 49 | the system know about hardware-disabled states that may be implemented on |
50 | the device. | 50 | the device. |
51 | 51 | ||
@@ -54,7 +54,7 @@ ways for userspace to query the current states. See the "Userspace support" | |||
54 | section below. | 54 | section below. |
55 | 55 | ||
56 | When the device is hard-blocked (either by a call to rfkill_set_hw_state() | 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 | block, but drivers can ignore the method call since they can use the return | 58 | block, but drivers can ignore the method call since they can use the return |
59 | value of the function rfkill_set_hw_state() to sync the software state | 59 | value of the function rfkill_set_hw_state() to sync the software state |
60 | instead of keeping track of calls to set_block(). In fact, drivers should | 60 | instead of keeping track of calls to set_block(). In fact, drivers should |
@@ -65,7 +65,6 @@ keeps track of soft and hard block separately. | |||
65 | Kernel API | 65 | Kernel API |
66 | ========== | 66 | ========== |
67 | 67 | ||
68 | |||
69 | Drivers for radio transmitters normally implement an rfkill driver. | 68 | Drivers for radio transmitters normally implement an rfkill driver. |
70 | 69 | ||
71 | Platform drivers might implement input devices if the rfkill button is just | 70 | Platform 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 | ||
76 | For some platforms, it is possible that the hardware state changes during | 75 | For some platforms, it is possible that the hardware state changes during |
77 | suspend/hibernation, in which case it will be necessary to update the rfkill | 76 | suspend/hibernation, in which case it will be necessary to update the rfkill |
78 | core with the current state is at resume time. | 77 | core with the current state at resume time. |
79 | 78 | ||
80 | To create an rfkill driver, driver's Kconfig needs to have:: | 79 | To create an rfkill driver, driver's Kconfig needs to have:: |
81 | 80 | ||
82 | depends on RFKILL || !RFKILL | 81 | depends on RFKILL || !RFKILL |
83 | 82 | ||
84 | to ensure the driver cannot be built-in when rfkill is modular. The !RFKILL | 83 | to ensure the driver cannot be built-in when rfkill is modular. The !RFKILL |
85 | case allows the driver to be built when rfkill is not configured, which | 84 | case allows the driver to be built when rfkill is not configured, in which |
86 | case all rfkill API can still be used but will be provided by static inlines | 85 | case all rfkill API can still be used but will be provided by static inlines |
87 | which compile to almost nothing. | 86 | which compile to almost nothing. |
88 | 87 | ||
@@ -91,7 +90,7 @@ rfkill drivers that control devices that can be hard-blocked unless they also | |||
91 | assign the poll_hw_block() callback (then the rfkill core will poll the | 90 | assign the poll_hw_block() callback (then the rfkill core will poll the |
92 | device). Don't do this unless you cannot get the event in any other way. | 91 | device). Don't do this unless you cannot get the event in any other way. |
93 | 92 | ||
94 | RFKill provides per-switch LED triggers, which can be used to drive LEDs | 93 | rfkill provides per-switch LED triggers, which can be used to drive LEDs |
95 | according to the switch state (LED_FULL when blocked, LED_OFF otherwise). | 94 | according 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 | |||
114 | hotplugged devices. | 113 | hotplugged devices. |
115 | 114 | ||
116 | After an application opens /dev/rfkill, it can read the current state of all | 115 | After an application opens /dev/rfkill, it can read the current state of all |
117 | devices. Changes can be either obtained by either polling the descriptor for | 116 | devices. Changes can be obtained by either polling the descriptor for |
118 | hotplug or state change events or by listening for uevents emitted by the | 117 | hotplug or state change events or by listening for uevents emitted by the |
119 | rfkill core framework. | 118 | rfkill 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 | ||
130 | The contents of these variables corresponds to the "name", "state" and | 129 | The 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 | |||
134 | For further details consult Documentation/ABI/stable/sysfs-class-rfkill. | 132 | For further details consult Documentation/ABI/stable/sysfs-class-rfkill. |