xref: /linux/Documentation/ABI/testing/sysfs-bus-acpi (revision bd628c1bed7902ec1f24ba0fe70758949146abbe)
1What:		/sys/bus/acpi/devices/.../path
2Date:		December 2006
3Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
4Description:
5		This attribute indicates the full path of ACPI namespace
6		object associated with the device object.  For example,
7		\_SB_.PCI0.
8		This file is not present for device objects representing
9		fixed ACPI hardware features (like power and sleep
10		buttons).
11
12What:		/sys/bus/acpi/devices/.../modalias
13Date:		July 2007
14Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
15Description:
16		This attribute indicates the PNP IDs of the device object.
17		That is acpi:HHHHHHHH:[CCCCCCC:].  Where each HHHHHHHH or
18		CCCCCCCC contains device object's PNPID (_HID or _CID).
19
20What:		/sys/bus/acpi/devices/.../hid
21Date:		April 2005
22Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
23Description:
24		This attribute indicates the hardware ID (_HID) of the
25		device object.  For example, PNP0103.
26		This file is present for device objects having the _HID
27		control method.
28
29What:		/sys/bus/acpi/devices/.../description
30Date:		October 2012
31Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
32Description:
33		This attribute contains the output of the device object's
34		_STR control method, if present.
35
36What:		/sys/bus/acpi/devices/.../adr
37Date:		October 2012
38Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
39Description:
40		This attribute contains the output of the device object's
41		_ADR control method, which is present for ACPI device
42		objects representing devices having standard enumeration
43		algorithms, such as PCI.
44
45What:		/sys/bus/acpi/devices/.../uid
46Date:		October 2012
47Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
48Description:
49		This attribute contains the output of the device object's
50		_UID control method, if present.
51
52What:		/sys/bus/acpi/devices/.../eject
53Date:		December 2006
54Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
55Description:
56		Writing 1 to this attribute will trigger hot removal of
57		this device object.  This file exists for every device
58		object that has _EJ0 method.
59
60What:		/sys/bus/acpi/devices/.../status
61Date:		Jan, 2014
62Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
63Description:
64		(RO) Returns the ACPI device status: enabled, disabled or
65		functioning or present, if the method _STA is present.
66
67		The return value is a decimal integer representing the device's
68		status bitmap:
69
70		Bit [0] –  Set if the device is present.
71		Bit [1] –  Set if the device is enabled and decoding its
72		           resources.
73		Bit [2] –  Set if the device should be shown in the UI.
74		Bit [3] –  Set if the device is functioning properly (cleared if
75		           device failed its diagnostics).
76		Bit [4] –  Set if the battery is present.
77		Bits [31:5] –  Reserved (must be cleared)
78
79		If bit [0] is clear, then bit 1 must also be clear (a device
80		that is not present cannot be enabled).
81
82		Bit 0 can be clear (not present) with bit [3] set (device is
83		functional).  This case is used to indicate a valid device for
84		which no device driver should be loaded.
85
86		More special cases are covered in the ACPI specification.
87
88What:		/sys/bus/acpi/devices/.../hrv
89Date:		Apr, 2016
90Contact:	Rafael J. Wysocki <rjw@rjwysocki.net>
91Description:
92		(RO) Allows users to read the hardware version of non-PCI
93		hardware, if the _HRV control method is present.  It is mostly
94		useful for non-PCI devices because lspci can list the hardware
95		version for PCI devices.
96