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 /include/linux/rfkill.h | |
| parent | Merge master.kernel.org:/pub/scm/linux/kernel/git/davem/wireless-2.6 (diff) | |
| download | wireguard-linux-f3146aff7f283c8699e0c97df6307a705786eeba.tar.xz wireguard-linux-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 'include/linux/rfkill.h')
| -rw-r--r-- | include/linux/rfkill.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/linux/rfkill.h b/include/linux/rfkill.h index e3ab21d7fc7f..ca89ae1b0219 100644 --- a/include/linux/rfkill.h +++ b/include/linux/rfkill.h @@ -44,8 +44,8 @@ enum rfkill_type { }; enum rfkill_state { - RFKILL_STATE_OFF = 0, - RFKILL_STATE_ON = 1, + RFKILL_STATE_OFF = 0, /* Radio output blocked */ + RFKILL_STATE_ON = 1, /* Radio output active */ }; /** @@ -53,7 +53,7 @@ enum rfkill_state { * @name: Name of the switch. * @type: Radio type which the button controls, the value stored * here should be a value from enum rfkill_type. - * @state: State of the switch (on/off). + * @state: State of the switch, "ON" means radio can operate. * @user_claim_unsupported: Whether the hardware supports exclusive * RF-kill control by userspace. Set this before registering. * @user_claim: Set when the switch is controlled exlusively by userspace. |