tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
platform/x86: wmi: Add bus ABI documentation
Add documentation for the WMI bus sysfs interface so userspace
applications can use it to access additional data about WMI devices.
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Armin Wolf <W_Armin@gmx.de>
Link: https://lore.kernel.org/r/20240624173116.31314-3-W_Armin@gmx.de
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
authored by
Armin Wolf
and committed by
Ilpo Järvinen
618ba6ab
12046f8c
+82
+81
Documentation/ABI/testing/sysfs-bus-wmi
+81
Documentation/ABI/testing/sysfs-bus-wmi
···
1
+
What: /sys/bus/wmi/devices/.../driver_override
2
+
Date: February 2024
3
+
Contact: Armin Wolf <W_Armin@gmx.de>
4
+
Description:
5
+
This file allows the driver for a device to be specified which
6
+
will override standard ID table matching.
7
+
When specified, only a driver with a name matching the value
8
+
written to driver_override will have an opportunity to bind
9
+
to the device.
10
+
The override is specified by writing a string to the
11
+
driver_override file (echo wmi-event-dummy > driver_override).
12
+
The override may be cleared with an empty string (echo > \
13
+
driver_override) which returns the device to standard matching
14
+
rules binding.
15
+
Writing to driver_override does not automatically unbind the
16
+
device from its current driver or make any attempt to automatically
17
+
load the specified driver. If no driver with a matching name is
18
+
currently loaded in the kernel, the device will not bind to any
19
+
driver.
20
+
This also allows devices to opt-out of driver binding using a
21
+
driver_override name such as "none". Only a single driver may be
22
+
specified in the override, there is no support for parsing delimiters.
23
+
24
+
What: /sys/bus/wmi/devices/.../modalias
25
+
Date: November 20:15
26
+
Contact: Andy Lutomirski <luto@kernel.org>
27
+
Description:
28
+
This file contains the MODALIAS value emitted by uevent for a
29
+
given WMI device.
30
+
31
+
Format: wmi:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.
32
+
33
+
What: /sys/bus/wmi/devices/.../guid
34
+
Date: November 2015
35
+
Contact: Andy Lutomirski <luto@kernel.org>
36
+
Description:
37
+
This file contains the GUID used to match WMI devices to
38
+
compatible WMI drivers. This GUID is not necessarily unique
39
+
inside a given machine, it is solely used to identify the
40
+
interface exposed by a given WMI device.
41
+
42
+
What: /sys/bus/wmi/devices/.../object_id
43
+
Date: November 2015
44
+
Contact: Andy Lutomirski <luto@kernel.org>
45
+
Description:
46
+
This file contains the WMI object ID used internally to construct
47
+
the ACPI method names used by non-event WMI devices. It contains
48
+
two ASCII letters.
49
+
50
+
What: /sys/bus/wmi/devices/.../notify_id
51
+
Date: November 2015
52
+
Contact: Andy Lutomirski <luto@kernel.org>
53
+
Description:
54
+
This file contains the WMI notify ID used internally to map ACPI
55
+
events to WMI event devices. It contains two ASCII letters.
56
+
57
+
What: /sys/bus/wmi/devices/.../instance_count
58
+
Date: November 2015
59
+
Contact: Andy Lutomirski <luto@kernel.org>
60
+
Description:
61
+
This file contains the number of WMI object instances being
62
+
present on a given WMI device. It contains a non-negative
63
+
number.
64
+
65
+
What: /sys/bus/wmi/devices/.../expensive
66
+
Date: November 2015
67
+
Contact: Andy Lutomirski <luto@kernel.org>
68
+
Description:
69
+
This file contains a boolean flag signaling if interacting with
70
+
the given WMI device will consume significant CPU resources.
71
+
The WMI driver core will take care of enabling/disabling such
72
+
WMI devices.
73
+
74
+
What: /sys/bus/wmi/devices/.../setable
75
+
Date: May 2017
76
+
Contact: Darren Hart (VMware) <dvhart@infradead.org>
77
+
Description:
78
+
This file contains a boolean flags signaling the data block
79
+
aassociated with the given WMI device is writable. If the
80
+
given WMI device is not associated with a data block, then
81
+
this file will not exist.