Documentation: add information for new sysfs soc bus functionality
authorLee Jones <lee.jones@linaro.org>
Mon, 6 Feb 2012 19:22:23 +0000 (11:22 -0800)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 10 Feb 2012 19:42:25 +0000 (11:42 -0800)
This change applies the required documentation for each new
attribute recenty added by the new System-On-Chip (SoC)
information export bus driver.

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/ABI/testing/sysfs-devices-soc [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-devices-soc b/Documentation/ABI/testing/sysfs-devices-soc
new file mode 100644 (file)
index 0000000..6d9cc25
--- /dev/null
@@ -0,0 +1,58 @@
+What:          /sys/devices/socX
+Date:          January 2012
+contact:       Lee Jones <lee.jones@linaro.org>
+Description:
+               The /sys/devices/ directory contains a sub-directory for each
+               System-on-Chip (SoC) device on a running platform. Information
+               regarding each SoC can be obtained by reading sysfs files. This
+               functionality is only available if implemented by the platform.
+
+               The directory created for each SoC will also house information
+               about devices which are commonly contained in /sys/devices/platform.
+               It has been agreed that if an SoC device exists, its supported
+               devices would be better suited to appear as children of that SoC.
+
+What:          /sys/devices/socX/machine
+Date:          January 2012
+contact:       Lee Jones <lee.jones@linaro.org>
+Description:
+               Read-only attribute common to all SoCs. Contains the SoC machine
+               name (e.g. Ux500).
+
+What:          /sys/devices/socX/family
+Date:          January 2012
+contact:       Lee Jones <lee.jones@linaro.org>
+Description:
+               Read-only attribute common to all SoCs. Contains SoC family name
+               (e.g. DB8500).
+
+What:          /sys/devices/socX/soc_id
+Date:          January 2012
+contact:       Lee Jones <lee.jones@linaro.org>
+Description:
+               Read-only attribute supported by most SoCs. In the case of
+               ST-Ericsson's chips this contains the SoC serial number.
+
+What:          /sys/devices/socX/revision
+Date:          January 2012
+contact:       Lee Jones <lee.jones@linaro.org>
+Description:
+               Read-only attribute supported by most SoCs. Contains the SoC's
+               manufacturing revision number.
+
+What:          /sys/devices/socX/process
+Date:          January 2012
+contact:       Lee Jones <lee.jones@linaro.org>
+Description:
+               Read-only attribute supported ST-Ericsson's silicon. Contains the
+               the process by which the silicon chip was manufactured.
+
+What:          /sys/bus/soc
+Date:          January 2012
+contact:       Lee Jones <lee.jones@linaro.org>
+Description:
+               The /sys/bus/soc/ directory contains the usual sub-folders
+               expected under most buses. /sys/bus/soc/devices is of particular
+               interest, as it contains a symlink for each SoC device found on
+               the system. Each symlink points back into the aforementioned
+               /sys/devices/socX devices.