Commit 89ca78a060a101b21cec46f34ad2ade3fafed0d0

Authored by Lv Zheng
Committed by Rafael J. Wysocki
1 parent 994b942fb4

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>

Showing 3 changed files with 60 additions and 1 deletions Side-by-side Diff

Documentation/ABI/testing/sysfs-bus-acpi
  1 +What: /sys/bus/acpi/devices/.../path
  2 +Date: December 2006
  3 +Contact: Rafael J. Wysocki <rjw@rjwysocki.net>
  4 +Description:
  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 +
  12 +What: /sys/bus/acpi/devices/.../modalias
  13 +Date: July 2007
  14 +Contact: Rafael J. Wysocki <rjw@rjwysocki.net>
  15 +Description:
  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 +
  20 +What: /sys/bus/acpi/devices/.../hid
  21 +Date: April 2005
  22 +Contact: Rafael J. Wysocki <rjw@rjwysocki.net>
  23 +Description:
  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 +
  29 +What: /sys/bus/acpi/devices/.../description
  30 +Date: October 2012
  31 +Contact: Rafael J. Wysocki <rjw@rjwysocki.net>
  32 +Description:
  33 + This attribute contains the output of the device object's
  34 + _STR control method, if present.
  35 +
  36 +What: /sys/bus/acpi/devices/.../adr
  37 +Date: October 2012
  38 +Contact: Rafael J. Wysocki <rjw@rjwysocki.net>
  39 +Description:
  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 +
  45 +What: /sys/bus/acpi/devices/.../uid
  46 +Date: October 2012
  47 +Contact: Rafael J. Wysocki <rjw@rjwysocki.net>
  48 +Description:
  49 + This attribute contains the output of the device object's
  50 + _UID control method, if present.
  51 +
  52 +What: /sys/bus/acpi/devices/.../eject
  53 +Date: December 2006
  54 +Contact: Rafael J. Wysocki <rjw@rjwysocki.net>
  55 +Description:
  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.
Documentation/ABI/testing/sysfs-devices-sun
1   -Whatt: /sys/devices/.../sun
  1 +What: /sys/devices/.../sun
2 2 Date: October 2012
3 3 Contact: Yasuaki Ishimatsu <isimatu.yasuaki@jp.fujitsu.com>
4 4 Description:
... ... @@ -243,6 +243,7 @@
243 243 F: include/linux/acpi.h
244 244 F: include/acpi/
245 245 F: Documentation/acpi
  246 +F: Documentation/ABI/testing/sysfs-bus-acpi
246 247  
247 248 ACPI FAN DRIVER
248 249 M: Zhang Rui <rui.zhang@intel.com>