xref: /linux/Documentation/ABI/stable/sysfs-class-rfkill (revision 24168c5e6dfbdd5b414f048f47f75d64533296ca)
1rfkill - radio frequency (RF) connector kill switch support
2
3For details to this subsystem look at Documentation/driver-api/rfkill.rst.
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
41		- 0: false
42		- 1: true
43
44
45What:		/sys/class/rfkill/rfkill[0-9]+/state
46Date:		09-Jul-2007
47KernelVersion	v2.6.22
48Contact:	linux-wireless@vger.kernel.org
49Description: 	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.
57Values: 	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
68What:		/sys/class/rfkill/rfkill[0-9]+/hard
69Date:		12-March-2010
70KernelVersion	v2.6.34
71Contact:	linux-wireless@vger.kernel.org
72Description: 	Current hardblock state. This file is read only.
73Values: 	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
82What:		/sys/class/rfkill/rfkill[0-9]+/soft
83Date:		12-March-2010
84KernelVersion	v2.6.34
85Contact:	linux-wireless@vger.kernel.org
86Description:	Current softblock state. This file is read and write.
87Values: 	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.
94