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 <[email protected]>
Acked-by: Ivo van Doorn <[email protected]>
Cc: Dmitry Torokhov <[email protected]>
Signed-off-by: John W. Linville <[email protected]>
This commit is contained in:
Henrique de Moraes Holschuh 2008-06-23 17:22:56 -03:00 • committed by John W. Linville
commit f3146aff7f
2 changed files with 10 additions and 3 deletions

View file

@ -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.