Linux 6.9-rc1
[linux-2.6-microblaze.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/driver-api/rfkill.rst.
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
41                 - 0: false
42                 - 1: true
43
44
45 What:           /sys/class/rfkill/rfkill[0-9]+/state
46 Date:           09-Jul-2007
47 KernelVersion   v2.6.22
48 Contact:        linux-wireless@vger.kernel.org
49 Description:    Current state of the transmitter.
50                 This file was scheduled to be removed in 2014, but due to its
51                 large number of users it will be sticking around for a bit
52                 longer. Despite it being marked as stable, the newer "hard" and
53                 "soft" interfaces should be preferred, since it is not possible
54                 to express the 'soft and hard block' state of the rfkill driver
55                 through this interface. There will likely be another attempt to
56                 remove it in the future.
57 Values:         A numeric value.
58
59                 0: RFKILL_STATE_SOFT_BLOCKED
60                         transmitter is turned off by software
61                 1: RFKILL_STATE_UNBLOCKED
62                         transmitter is (potentially) active
63                 2: RFKILL_STATE_HARD_BLOCKED
64                         transmitter is forced off by something outside of
65                         the driver's control.
66
67
68 What:           /sys/class/rfkill/rfkill[0-9]+/hard
69 Date:           12-March-2010
70 KernelVersion   v2.6.34
71 Contact:        linux-wireless@vger.kernel.org
72 Description:    Current hardblock state. This file is read only.
73 Values:         A numeric value.
74
75                 0: inactive
76                         The transmitter is (potentially) active.
77                 1: active
78                         The transmitter is forced off by something outside of
79                         the driver's control.
80
81
82 What:           /sys/class/rfkill/rfkill[0-9]+/soft
83 Date:           12-March-2010
84 KernelVersion   v2.6.34
85 Contact:        linux-wireless@vger.kernel.org
86 Description:    Current softblock state. This file is read and write.
87 Values:         A numeric value.
88
89                 0: inactive
90                         The transmitter is (potentially) active.
91
92                 1: active
93                         The transmitter is turned off by software.