Commit | Line | Data |
---|---|---|
19d337df JB |
1 | rfkill - RF kill switch support |
2 | =============================== | |
dac24ab3 | 3 | |
19d337df JB |
4 | 1. Introduction |
5 | 2. Implementation details | |
ce0879e3 JB |
6 | 3. Kernel API |
7 | 4. Userspace support | |
dac24ab3 | 8 | |
dc288520 | 9 | |
19d337df | 10 | 1. Introduction |
dac24ab3 | 11 | |
19d337df JB |
12 | The rfkill subsystem provides a generic interface to disabling any radio |
13 | transmitter in the system. When a transmitter is blocked, it shall not | |
14 | radiate any power. | |
f3146aff | 15 | |
19d337df JB |
16 | The subsystem also provides the ability to react on button presses and |
17 | disable all transmitters of a certain type (or all). This is intended for | |
18 | situations where transmitters need to be turned off, for example on | |
19 | aircraft. | |
f7983f73 | 20 | |
ce0879e3 JB |
21 | The rfkill subsystem has a concept of "hard" and "soft" block, which |
22 | differ little in their meaning (block == transmitters off) but rather in | |
23 | whether they can be changed or not: | |
c98be0c9 | 24 | - hard block: read-only radio block that cannot be overridden by software |
ce0879e3 JB |
25 | - soft block: writable radio block (need not be readable) that is set by |
26 | the system software. | |
f3146aff | 27 | |
0efbb786 AC |
28 | The rfkill subsystem has two parameters, rfkill.default_state and |
29 | rfkill.master_switch_mode, which are documented in kernel-parameters.txt. | |
30 | ||
dac24ab3 | 31 | |
19d337df | 32 | 2. Implementation details |
dc288520 | 33 | |
ce0879e3 JB |
34 | The rfkill subsystem is composed of three main components: |
35 | * the rfkill core, | |
36 | * the deprecated rfkill-input module (an input layer handler, being | |
37 | replaced by userspace policy code) and | |
38 | * the rfkill drivers. | |
bed7aac9 | 39 | |
ce0879e3 JB |
40 | The rfkill core provides API for kernel drivers to register their radio |
41 | transmitter with the kernel, methods for turning it on and off and, letting | |
42 | the system know about hardware-disabled states that may be implemented on | |
43 | the device. | |
bed7aac9 | 44 | |
ce0879e3 JB |
45 | The rfkill core code also notifies userspace of state changes, and provides |
46 | ways for userspace to query the current states. See the "Userspace support" | |
47 | section below. | |
bed7aac9 | 48 | |
19d337df | 49 | When the device is hard-blocked (either by a call to rfkill_set_hw_state() |
ce0879e3 JB |
50 | or from query_hw_block) set_block() will be invoked for additional software |
51 | block, but drivers can ignore the method call since they can use the return | |
52 | value of the function rfkill_set_hw_state() to sync the software state | |
53 | instead of keeping track of calls to set_block(). In fact, drivers should | |
54 | use the return value of rfkill_set_hw_state() unless the hardware actually | |
55 | keeps track of soft and hard block separately. | |
f7983f73 | 56 | |
f7983f73 | 57 | |
ce0879e3 | 58 | 3. Kernel API |
f7983f73 | 59 | |
f7983f73 | 60 | |
ce0879e3 | 61 | Drivers for radio transmitters normally implement an rfkill driver. |
f7983f73 | 62 | |
19d337df JB |
63 | Platform drivers might implement input devices if the rfkill button is just |
64 | that, a button. If that button influences the hardware then you need to | |
ce0879e3 | 65 | implement an rfkill driver instead. This also applies if the platform provides |
19d337df | 66 | a way to turn on/off the transmitter(s). |
f7983f73 | 67 | |
ce0879e3 JB |
68 | For some platforms, it is possible that the hardware state changes during |
69 | suspend/hibernation, in which case it will be necessary to update the rfkill | |
70 | core with the current state is at resume time. | |
f7983f73 | 71 | |
ce0879e3 | 72 | To create an rfkill driver, driver's Kconfig needs to have |
f7983f73 | 73 | |
ce0879e3 | 74 | depends on RFKILL || !RFKILL |
dc288520 | 75 | |
ce0879e3 | 76 | to ensure the driver cannot be built-in when rfkill is modular. The !RFKILL |
c79a8d85 | 77 | case allows the driver to be built when rfkill is not configured, which |
ce0879e3 JB |
78 | case all rfkill API can still be used but will be provided by static inlines |
79 | which compile to almost nothing. | |
dc288520 | 80 | |
19d337df JB |
81 | Calling rfkill_set_hw_state() when a state change happens is required from |
82 | rfkill drivers that control devices that can be hard-blocked unless they also | |
83 | assign the poll_hw_block() callback (then the rfkill core will poll the | |
84 | device). Don't do this unless you cannot get the event in any other way. | |
dac24ab3 | 85 | |
5005657c | 86 | |
5005657c | 87 | |
19d337df | 88 | 5. Userspace support |
dac24ab3 | 89 | |
ce0879e3 JB |
90 | The recommended userspace interface to use is /dev/rfkill, which is a misc |
91 | character device that allows userspace to obtain and set the state of rfkill | |
92 | devices and sets of devices. It also notifies userspace about device addition | |
93 | and removal. The API is a simple read/write API that is defined in | |
94 | linux/rfkill.h, with one ioctl that allows turning off the deprecated input | |
95 | handler in the kernel for the transition period. | |
96 | ||
97 | Except for the one ioctl, communication with the kernel is done via read() | |
98 | and write() of instances of 'struct rfkill_event'. In this structure, the | |
99 | soft and hard block are properly separated (unlike sysfs, see below) and | |
100 | userspace is able to get a consistent snapshot of all rfkill devices in the | |
101 | system. Also, it is possible to switch all rfkill drivers (or all drivers of | |
102 | a specified type) into a state which also updates the default state for | |
103 | hotplugged devices. | |
104 | ||
69c86373 | 105 | After an application opens /dev/rfkill, it can read the current state of all |
106 | devices. Changes can be either obtained by either polling the descriptor for | |
107 | hotplug or state change events or by listening for uevents emitted by the | |
108 | rfkill core framework. | |
109 | ||
110 | Additionally, each rfkill device is registered in sysfs and emits uevents. | |
111 | ||
112 | rfkill devices issue uevents (with an action of "change"), with the following | |
113 | environment variables set: | |
19d337df JB |
114 | |
115 | RFKILL_NAME | |
116 | RFKILL_STATE | |
117 | RFKILL_TYPE | |
118 | ||
119 | The contents of these variables corresponds to the "name", "state" and | |
120 | "type" sysfs files explained above. | |
69c86373 | 121 | |
122 | ||
395cf969 | 123 | For further details consult Documentation/ABI/stable/sysfs-class-rfkill. |