diff options
| author | Henrique de Moraes Holschuh <hmh@hmh.eng.br> | 2008-06-23 17:22:56 -0300 |
|---|---|---|
| committer | John W. Linville <linville@tuxdriver.com> | 2008-06-26 14:21:19 -0400 |
| commit | f3146aff7f283c8699e0c97df6307a705786eeba (patch) | |
| tree | 40320f74bf2408f814960d6e2772e6100eed6e7c /Documentation/rfkill.txt | |
| parent | 1839cea91e5629756dd4f87c5d70d8a18b89c0b4 (diff) | |
| download | linux-rpi3-f3146aff7f283c8699e0c97df6307a705786eeba.tar.gz linux-rpi3-f3146aff7f283c8699e0c97df6307a705786eeba.tar.bz2 linux-rpi3-f3146aff7f283c8699e0c97df6307a705786eeba.zip | |
rfkill: clarify meaning of rfkill states
rfkill really should have been named rfswitch. As it is, one can get
confused whether RFKILL_STATE_ON means the KILL switch is on (and
therefore, the radio is being *blocked* from operating), or whether it
means the RADIO rf output is on.
Clearly state that RFKILL_STATE_ON means the radio is *unblocked* from
operating (i.e. there is no rf killing going on).
Signed-off-by: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
Acked-by: Ivo van Doorn <IvDoorn@gmail.com>
Cc: Dmitry Torokhov <dtor@mail.ru>
Signed-off-by: John W. Linville <linville@tuxdriver.com>
Diffstat (limited to 'Documentation/rfkill.txt')
| -rw-r--r-- | Documentation/rfkill.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/rfkill.txt b/Documentation/rfkill.txt index a83ff23cd68c..ec75d6d34785 100644 --- a/Documentation/rfkill.txt +++ b/Documentation/rfkill.txt @@ -8,6 +8,13 @@ rfkill - RF switch subsystem support =============================================================================== 1: Implementation details +The rfkill switch subsystem exists to add a generic interface to circuitry that +can enable or disable the RF output of a radio *transmitter* of any type. + +When a rfkill switch is in the RFKILL_STATE_ON, the radio transmitter is +*enabled*. When the rfkill switch is in the RFKILL_STATE_OFF, the radio +transmitter is *disabled*. + The rfkill switch subsystem offers support for keys often found on laptops to enable wireless devices like WiFi and Bluetooth. |