ACPI: Add new sysfs interface to export device description
authorLance Ortiz <lance.ortiz@hp.com>
Tue, 2 Oct 2012 18:43:23 +0000 (12:43 -0600)
committerLen Brown <len.brown@intel.com>
Sat, 6 Oct 2012 19:52:16 +0000 (15:52 -0400)
commitd1efe3c324ead77d3f6cd85093b50f6bd2e17aba
tree7c85ab68cc0d906c0479e816d955481723e945b1
parent369d913b242cae2205471b11b6e33ac368ed33ec
ACPI: Add new sysfs interface to export device description

Add support to export the device description obtained from the ACPI _STR
method, if one exists for a device, to user-space via a sysfs interface.
This new interface provides a standard and platform neutral way for users
to obtain the description text stored in the ACPI _STR method.  If no
_STR method exists for the device, no sysfs 'description' file will be
created.  The 'description' file will be located in the /sys/devices/
directory using the device's path.

/sys/device/<bus>/<bridge path>/<device path>.../firmware_node/description

Example:

/sys/devices/pci0000:00/0000:00.07.0/0000:0e:00.0/firmware_node/description

It can also be located using the ACPI device path, for example:

/sys/devices/LNXSYSTM:00/device:00/ACPI0004:00/PNP0A08:00/device:13/device:15/description
/sys/devices/LNXSYSTM:00/device:00/ACPI0004:00/ACPI0004:01/ACPI0007:02/description

Execute the 'cat' command on the 'description' file to obtain the
description string for that device.

This patch also includes documentation describing how the new sysfs
interface works

Changes from v1-v2 based on comments by Len Brown and Fengguang Wu
* Removed output "No Description" and leaving a NULL attribute if the
_STR method failed to evaluate.

* In acpi_device_remove_files() removed the redundent check of
dev->pnp.str_obj before calling free.  This check triggered a message
from smatch.

Signed-off-by: Lance Ortiz <lance.ortiz@hp.com>
Signed-off-by: Len Brown <len.brown@intel.com>
Documentation/ABI/testing/sysfs-devices-firmware_node [new file with mode: 0644]
drivers/acpi/scan.c
include/acpi/acpi_bus.h