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