ACPI: Add sysfs ABI documentation

Add initial ABI documentation for ACPI devices' sysfs interfaces.
Contacts information fields are filled with current ACPI maintainer and the
relevant authors are carbon copied.

[rjw: Use my e-mail address that's likely to be valid longer.]
Signed-off-by: Lv Zheng <lv.zheng@intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

diff --git a/Documentation/ABI/testing/sysfs-bus-acpi b/Documentation/ABI/testing/sysfs-bus-acpi
new file mode 100644 (file)
index 0000000..7fa9cbc
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-acpi
@@ -0,0 +1,58 @@
+What:          /sys/bus/acpi/devices/.../path
+Date:          December 2006
+Contact:       Rafael J. Wysocki <rjw@rjwysocki.net>
+Description:
+               This attribute indicates the full path of ACPI namespace
+               object associated with the device object.  For example,
+               \_SB_.PCI0.
+               This file is not present for device objects representing
+               fixed ACPI hardware features (like power and sleep
+               buttons).
+
+What:          /sys/bus/acpi/devices/.../modalias
+Date:          July 2007
+Contact:       Rafael J. Wysocki <rjw@rjwysocki.net>
+Description:
+               This attribute indicates the PNP IDs of the device object.
+               That is acpi:HHHHHHHH:[CCCCCCC:].  Where each HHHHHHHH or
+               CCCCCCCC contains device object's PNPID (_HID or _CID).
+
+What:          /sys/bus/acpi/devices/.../hid
+Date:          April 2005
+Contact:       Rafael J. Wysocki <rjw@rjwysocki.net>
+Description:
+               This attribute indicates the hardware ID (_HID) of the
+               device object.  For example, PNP0103.
+               This file is present for device objects having the _HID
+               control method.
+
+What:          /sys/bus/acpi/devices/.../description
+Date:          October 2012
+Contact:       Rafael J. Wysocki <rjw@rjwysocki.net>
+Description:
+               This attribute contains the output of the device object's
+               _STR control method, if present.
+
+What:          /sys/bus/acpi/devices/.../adr
+Date:          October 2012
+Contact:       Rafael J. Wysocki <rjw@rjwysocki.net>
+Description:
+               This attribute contains the output of the device object's
+               _ADR control method, which is present for ACPI device
+               objects representing devices having standard enumeration
+               algorithms, such as PCI.
+
+What:          /sys/bus/acpi/devices/.../uid
+Date:          October 2012
+Contact:       Rafael J. Wysocki <rjw@rjwysocki.net>
+Description:
+               This attribute contains the output of the device object's
+               _UID control method, if present.
+
+What:          /sys/bus/acpi/devices/.../eject
+Date:          December 2006
+Contact:       Rafael J. Wysocki <rjw@rjwysocki.net>
+Description:
+               Writing 1 to this attribute will trigger hot removal of
+               this device object.  This file exists for every device
+               object that has _EJ0 method.

diff --git a/Documentation/ABI/testing/sysfs-devices-sun b/Documentation/ABI/testing/sysfs-devices-sun
index 86be9848a77e2251bcd2e2cb7b904145147cbff3..625ce4b6375825a1e5908a9323b655c177799e17 100644 (file)
--- a/Documentation/ABI/testing/sysfs-devices-sun
+++ b/Documentation/ABI/testing/sysfs-devices-sun
@@ -1,4 +1,4 @@
-Whatt:         /sys/devices/.../sun
+What:          /sys/devices/.../sun
 Date:          October 2012
 Contact:       Yasuaki Ishimatsu <isimatu.yasuaki@jp.fujitsu.com>
 Description:

diff --git a/MAINTAINERS b/MAINTAINERS
index aa0fafdb61bbe34c3ab175a154f1d5fd7c6ffe57..95911afa818fc9dfe8833cc49b47663e7c714d4e 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -243,6 +243,7 @@ F:  drivers/pnp/pnpacpi/
 F:     include/linux/acpi.h
 F:     include/acpi/
 F:     Documentation/acpi
+F:     Documentation/ABI/testing/sysfs-bus-acpi
 
 ACPI FAN DRIVER
 M:     Zhang Rui <rui.zhang@intel.com>