xref: /linux/Documentation/ABI/stable/sysfs-class-rfkill (revision be709d48329a500621d2a05835283150ae137b45)
1rfkill - radio frequency (RF) connector kill switch support
2
3For details to this subsystem look at Documentation/rfkill.txt.
4
5For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in
6Documentation/ABI/removed/sysfs-class-rfkill.
7
8What: 		/sys/class/rfkill
9Date:		09-Jul-2007
10KernelVersion:	v2.6.22
11Contact:	linux-wireless@vger.kernel.org,
12Description: 	The rfkill class subsystem folder.
13		Each registered rfkill driver is represented by an rfkillX
14		subfolder (X being an integer >= 0).
15
16
17What:		/sys/class/rfkill/rfkill[0-9]+/name
18Date:		09-Jul-2007
19KernelVersion	v2.6.22
20Contact:	linux-wireless@vger.kernel.org
21Description: 	Name assigned by driver to this key (interface or driver name).
22Values: 	arbitrary string.
23
24
25What: 		/sys/class/rfkill/rfkill[0-9]+/type
26Date:		09-Jul-2007
27KernelVersion	v2.6.22
28Contact:	linux-wireless@vger.kernel.org
29Description: 	Driver type string ("wlan", "bluetooth", etc).
30Values: 	See include/linux/rfkill.h.
31
32
33What:		/sys/class/rfkill/rfkill[0-9]+/persistent
34Date:		09-Jul-2007
35KernelVersion	v2.6.22
36Contact:	linux-wireless@vger.kernel.org
37Description: 	Whether the soft blocked state is initialised from non-volatile
38		storage at startup.
39Values: 	A numeric value.
40		0: false
41		1: true
42
43
44What:		/sys/class/rfkill/rfkill[0-9]+/state
45Date:		09-Jul-2007
46KernelVersion	v2.6.22
47Contact:	linux-wireless@vger.kernel.org
48Description: 	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.
56Values: 	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
66What:		/sys/class/rfkill/rfkill[0-9]+/hard
67Date:		12-March-2010
68KernelVersion	v2.6.34
69Contact:	linux-wireless@vger.kernel.org
70Description: 	Current hardblock state. This file is read only.
71Values: 	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
79What:		/sys/class/rfkill/rfkill[0-9]+/soft
80Date:		12-March-2010
81KernelVersion	v2.6.34
82Contact:	linux-wireless@vger.kernel.org
83Description:	Current softblock state. This file is read and write.
84Values: 	A numeric value.
85		0: inactive
86			The transmitter is (potentially) active.
87		1: active
88			The transmitter is turned off by software.
89