tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Documentation: add information for new sysfs soc bus functionality
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>
authored by
Lee Jones
and committed by
Greg Kroah-Hartman
da5a70f3
74d1d82c
+58
+58
Documentation/ABI/testing/sysfs-devices-soc
+58
Documentation/ABI/testing/sysfs-devices-soc
···
1
+
What: /sys/devices/socX
2
+
Date: January 2012
3
+
contact: Lee Jones <lee.jones@linaro.org>
4
+
Description:
5
+
The /sys/devices/ directory contains a sub-directory for each
6
+
System-on-Chip (SoC) device on a running platform. Information
7
+
regarding each SoC can be obtained by reading sysfs files. This
8
+
functionality is only available if implemented by the platform.
9
+
10
+
The directory created for each SoC will also house information
11
+
about devices which are commonly contained in /sys/devices/platform.
12
+
It has been agreed that if an SoC device exists, its supported
13
+
devices would be better suited to appear as children of that SoC.
14
+
15
+
What: /sys/devices/socX/machine
16
+
Date: January 2012
17
+
contact: Lee Jones <lee.jones@linaro.org>
18
+
Description:
19
+
Read-only attribute common to all SoCs. Contains the SoC machine
20
+
name (e.g. Ux500).
21
+
22
+
What: /sys/devices/socX/family
23
+
Date: January 2012
24
+
contact: Lee Jones <lee.jones@linaro.org>
25
+
Description:
26
+
Read-only attribute common to all SoCs. Contains SoC family name
27
+
(e.g. DB8500).
28
+
29
+
What: /sys/devices/socX/soc_id
30
+
Date: January 2012
31
+
contact: Lee Jones <lee.jones@linaro.org>
32
+
Description:
33
+
Read-only attribute supported by most SoCs. In the case of
34
+
ST-Ericsson's chips this contains the SoC serial number.
35
+
36
+
What: /sys/devices/socX/revision
37
+
Date: January 2012
38
+
contact: Lee Jones <lee.jones@linaro.org>
39
+
Description:
40
+
Read-only attribute supported by most SoCs. Contains the SoC's
41
+
manufacturing revision number.
42
+
43
+
What: /sys/devices/socX/process
44
+
Date: January 2012
45
+
contact: Lee Jones <lee.jones@linaro.org>
46
+
Description:
47
+
Read-only attribute supported ST-Ericsson's silicon. Contains the
48
+
the process by which the silicon chip was manufactured.
49
+
50
+
What: /sys/bus/soc
51
+
Date: January 2012
52
+
contact: Lee Jones <lee.jones@linaro.org>
53
+
Description:
54
+
The /sys/bus/soc/ directory contains the usual sub-folders
55
+
expected under most buses. /sys/bus/soc/devices is of particular
56
+
interest, as it contains a symlink for each SoC device found on
57
+
the system. Each symlink points back into the aforementioned
58
+
/sys/devices/socX devices.