Merge branch 'for-4.19' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/wq
[sfrench/cifs-2.6.git] / Documentation / ABI / stable / sysfs-class-rfkill
1 rfkill - radio frequency (RF) connector kill switch support
2
3 For details to this subsystem look at Documentation/rfkill.txt.
4
5 For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in
6 Documentation/ABI/removed/sysfs-class-rfkill.
7
8 What:           /sys/class/rfkill
9 Date:           09-Jul-2007
10 KernelVersion:  v2.6.22
11 Contact:        linux-wireless@vger.kernel.org,
12 Description:    The rfkill class subsystem folder.
13                 Each registered rfkill driver is represented by an rfkillX
14                 subfolder (X being an integer >= 0).
15
16
17 What:           /sys/class/rfkill/rfkill[0-9]+/name
18 Date:           09-Jul-2007
19 KernelVersion   v2.6.22
20 Contact:        linux-wireless@vger.kernel.org
21 Description:    Name assigned by driver to this key (interface or driver name).
22 Values:         arbitrary string.
23
24
25 What:           /sys/class/rfkill/rfkill[0-9]+/type
26 Date:           09-Jul-2007
27 KernelVersion   v2.6.22
28 Contact:        linux-wireless@vger.kernel.org
29 Description:    Driver type string ("wlan", "bluetooth", etc).
30 Values:         See include/linux/rfkill.h.
31
32
33 What:           /sys/class/rfkill/rfkill[0-9]+/persistent
34 Date:           09-Jul-2007
35 KernelVersion   v2.6.22
36 Contact:        linux-wireless@vger.kernel.org
37 Description:    Whether the soft blocked state is initialised from non-volatile
38                 storage at startup.
39 Values:         A numeric value.
40                 0: false
41                 1: true
42
43
44 What:           /sys/class/rfkill/rfkill[0-9]+/state
45 Date:           09-Jul-2007
46 KernelVersion   v2.6.22
47 Contact:        linux-wireless@vger.kernel.org
48 Description:    Current state of the transmitter.
49                 This file was scheduled to be removed in 2014, but due to its
50                 large number of users it will be sticking around for a bit
51                 longer. Despite it being marked as stable, the newer "hard" and
52                 "soft" interfaces should be preferred, since it is not possible
53                 to express the 'soft and hard block' state of the rfkill driver
54                 through this interface. There will likely be another attempt to
55                 remove it in the future.
56 Values:         A numeric value.
57                 0: RFKILL_STATE_SOFT_BLOCKED
58                         transmitter is turned off by software
59                 1: RFKILL_STATE_UNBLOCKED
60                         transmitter is (potentially) active
61                 2: RFKILL_STATE_HARD_BLOCKED
62                         transmitter is forced off by something outside of
63                         the driver's control.
64
65
66 What:           /sys/class/rfkill/rfkill[0-9]+/hard
67 Date:           12-March-2010
68 KernelVersion   v2.6.34
69 Contact:        linux-wireless@vger.kernel.org
70 Description:    Current hardblock state. This file is read only.
71 Values:         A numeric value.
72                 0: inactive
73                         The transmitter is (potentially) active.
74                 1: active
75                         The transmitter is forced off by something outside of
76                         the driver's control.
77
78
79 What:           /sys/class/rfkill/rfkill[0-9]+/soft
80 Date:           12-March-2010
81 KernelVersion   v2.6.34
82 Contact:        linux-wireless@vger.kernel.org
83 Description:    Current softblock state. This file is read and write.
84 Values:         A numeric value.
85                 0: inactive
86                         The transmitter is (potentially) active.
87                 1: active
88                         The transmitter is turned off by software.