diff options
-rw-r--r-- | Documentation/rfkill.txt | 7 | ||||
-rw-r--r-- | include/linux/rfkill.h | 6 |
2 files changed, 10 insertions, 3 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 | |||
8 | =============================================================================== | 8 | =============================================================================== |
9 | 1: Implementation details | 9 | 1: Implementation details |
10 | 10 | ||
11 | The rfkill switch subsystem exists to add a generic interface to circuitry that | ||
12 | can enable or disable the RF output of a radio *transmitter* of any type. | ||
13 | |||
14 | When a rfkill switch is in the RFKILL_STATE_ON, the radio transmitter is | ||
15 | *enabled*. When the rfkill switch is in the RFKILL_STATE_OFF, the radio | ||
16 | transmitter is *disabled*. | ||
17 | |||
11 | The rfkill switch subsystem offers support for keys often found on laptops | 18 | The rfkill switch subsystem offers support for keys often found on laptops |
12 | to enable wireless devices like WiFi and Bluetooth. | 19 | to enable wireless devices like WiFi and Bluetooth. |
13 | 20 | ||
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 { | |||
44 | }; | 44 | }; |
45 | 45 | ||
46 | enum rfkill_state { | 46 | enum rfkill_state { |
47 | RFKILL_STATE_OFF = 0, | 47 | RFKILL_STATE_OFF = 0, /* Radio output blocked */ |
48 | RFKILL_STATE_ON = 1, | 48 | RFKILL_STATE_ON = 1, /* Radio output active */ |
49 | }; | 49 | }; |
50 | 50 | ||
51 | /** | 51 | /** |
@@ -53,7 +53,7 @@ enum rfkill_state { | |||
53 | * @name: Name of the switch. | 53 | * @name: Name of the switch. |
54 | * @type: Radio type which the button controls, the value stored | 54 | * @type: Radio type which the button controls, the value stored |
55 | * here should be a value from enum rfkill_type. | 55 | * here should be a value from enum rfkill_type. |
56 | * @state: State of the switch (on/off). | 56 | * @state: State of the switch, "ON" means radio can operate. |
57 | * @user_claim_unsupported: Whether the hardware supports exclusive | 57 | * @user_claim_unsupported: Whether the hardware supports exclusive |
58 | * RF-kill control by userspace. Set this before registering. | 58 | * RF-kill control by userspace. Set this before registering. |
59 | * @user_claim: Set when the switch is controlled exlusively by userspace. | 59 | * @user_claim: Set when the switch is controlled exlusively by userspace. |