blob: 738dcffe35e9a3bea57c203b557ec92349701362 [file] [log] [blame]
Alex Elder28e3ced2015-05-27 11:17:51 -05001What: /sys/bus/greybus/device/endo-0xXXXX
Greg Kroah-Hartman7baa1842015-04-07 20:27:53 +02002Date: October 2015
3KernelVersion: 4.XX
4Contact: Greg Kroah-Hartman <greg@kroah.com>
5Description:
6 The "root" endo for the Greybus device tree. XXX is
7 replaced with the numeric value of the endo layout
8 scheme as documented in the ARA Module Developer Kit.
9
Alex Elder28e3ced2015-05-27 11:17:51 -050010What: /sys/bus/greybus/device/endo-0xXXXX/Endo/id
Alex Elderb4dbf1e2015-05-27 11:17:50 -050011Date: October 2015
12KernelVersion: 4.XX
13Contact: Greg Kroah-Hartman <greg@kroah.com>
14Description:
15 The Endo ID, which is a 2-byte hexadecimal value
16 defined by the the Endo layout scheme, documented in
17 the ARA Module Developer Kit.
18
Alex Elder28e3ced2015-05-27 11:17:51 -050019What: /sys/bus/greybus/device/endo-0xXXXX/Endo/ap_intf_id
Alex Elderb4dbf1e2015-05-27 11:17:50 -050020Date: October 2015
21KernelVersion: 4.XX
22Contact: Greg Kroah-Hartman <greg@kroah.com>
23Description:
24 The AP interface ID, a small non-zero integer which
25 defines the position of the AP module on the Endo.
26 The interface positions are defined in the ARA
27 Module Developer Kit.
28
Alex Elder28e3ced2015-05-27 11:17:51 -050029What: /sys/bus/greybus/device/endo-0xXXXX/SVC/serial_number
Greg Kroah-Hartman7baa1842015-04-07 20:27:53 +020030Date: October 2015
31KernelVersion: 4.XX
32Contact: Greg Kroah-Hartman <greg@kroah.com>
33Description:
34 The serial number of the SVC device
35
Alex Elder28e3ced2015-05-27 11:17:51 -050036What: /sys/bus/greybus/device/endo-0xXXXX/SVC/version
Greg Kroah-Hartman7baa1842015-04-07 20:27:53 +020037Date: October 2015
38KernelVersion: 4.XX
39Contact: Greg Kroah-Hartman <greg@kroah.com>
40Description:
41 The version number of the firmware in the SVC device.
42
Alex Elder28e3ced2015-05-27 11:17:51 -050043What: /sys/bus/greybus/device/endo-0xXXXX/.../epm
Greg Kroah-Hartmanb0235b22015-04-07 20:28:13 +020044Date: October 2015
45KernelVersion: 4.XX
46Contact: Greg Kroah-Hartman <greg@kroah.com>
47Description:
48 The EPM (Electropermanent Magnet) control file for
49 the specific module slot the file is present in.
50 Writing 1 to it turns it on, writing 0 to it turns it
51 off. Reading the value returns if it is on or off.
52
Alex Elder28e3ced2015-05-27 11:17:51 -050053What: /sys/bus/greybus/device/endo-0xXXXX/.../power_control
Greg Kroah-Hartmanb0235b22015-04-07 20:28:13 +020054Date: October 2015
55KernelVersion: 4.XX
56Contact: Greg Kroah-Hartman <greg@kroah.com>
57Description:
58 The power control file for the specific module slot that
59 the file is present in. Writing 1 to it turns power on
60 to the module, writing 0 to it turns power off to the
61 module. Reading the value returns if it is on or off.
62
Alex Elder28e3ced2015-05-27 11:17:51 -050063What: /sys/bus/greybus/device/endo-0xXXXX/.../present
Greg Kroah-Hartmanb0235b22015-04-07 20:28:13 +020064Date: October 2015
65KernelVersion: 4.XX
66Contact: Greg Kroah-Hartman <greg@kroah.com>
67Description:
68 The "is a module present in the slot" file for the
69 specific module slot that the file is present in.
70 This is read-only, 1 means a module is present, 0 means
71 no module is present.
72
Greg Kroah-Hartmanfc2a8fb2014-12-11 17:10:58 -050073What: /sys/bus/greybus/device/.../product
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +020074Date: October 2015
75KernelVersion: 4.XX
Greg Kroah-Hartmanfc2a8fb2014-12-11 17:10:58 -050076Contact: Greg Kroah-Hartman <greg@kroah.com>
77Description:
78 Product ID of a Greybus interface block.
79
80What: /sys/bus/greybus/device/.../product_string
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +020081Date: October 2015
82KernelVersion: 4.XX
Greg Kroah-Hartmanfc2a8fb2014-12-11 17:10:58 -050083Contact: Greg Kroah-Hartman <greg@kroah.com>
84Description:
85 Product ID string of a Greybus interface block.
86
87What: /sys/bus/greybus/device/.../unique_id
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +020088Date: October 2015
89KernelVersion: 4.XX
Greg Kroah-Hartmanfc2a8fb2014-12-11 17:10:58 -050090Contact: Greg Kroah-Hartman <greg@kroah.com>
91Description:
92 Unique ID of a Greybus interface block.
93
94What: /sys/bus/greybus/device/.../vendor
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +020095Date: October 2015
96KernelVersion: 4.XX
Greg Kroah-Hartmanfc2a8fb2014-12-11 17:10:58 -050097Contact: Greg Kroah-Hartman <greg@kroah.com>
98Description:
99 Vendor ID of a Greybus interface block.
100
101What: /sys/bus/greybus/device/.../vendor_string
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +0200102Date: October 2015
103KernelVersion: 4.XX
Greg Kroah-Hartmanfc2a8fb2014-12-11 17:10:58 -0500104Contact: Greg Kroah-Hartman <greg@kroah.com>
105Description:
106 Vendor ID string of a Greybus interface block.
107
Greg Kroah-Hartmana500a8a2014-12-11 17:11:00 -0500108What: /sys/bus/greybus/device/.../state
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +0200109Date: October 2015
110KernelVersion: 4.XX
Greg Kroah-Hartmana500a8a2014-12-11 17:11:00 -0500111Contact: Greg Kroah-Hartman <greg@kroah.com>
112Description:
113 The current state of a Greybus connection.
114
115 It will be one of the following values:
116 0 - invalid
117 1 - disabled
118 2 - enabled
119 3 - error
120 4 - destroying
121
122What: /sys/bus/greybus/device/.../protocol_id
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +0200123Date: October 2015
124KernelVersion: 4.XX
Greg Kroah-Hartmana500a8a2014-12-11 17:11:00 -0500125Contact: Greg Kroah-Hartman <greg@kroah.com>
126Description:
Alex Elder28e3ced2015-05-27 11:17:51 -0500127 The protocol ID of a Greybus connection.
Greg Kroah-Hartman640f13e2014-12-11 17:11:01 -0500128
129What: /sys/bus/greybus/device/.../device_id
Greg Kroah-Hartmanf0b67872015-04-07 20:27:36 +0200130Date: October 2015
131KernelVersion: 4.XX
Greg Kroah-Hartman640f13e2014-12-11 17:11:01 -0500132Contact: Greg Kroah-Hartman <greg@kroah.com>
133Description:
Alex Elder28e3ced2015-05-27 11:17:51 -0500134 The device ID of a Greybus bundle.
Greg Kroah-Hartman75052a52015-04-13 19:48:37 +0200135
136What: /sys/bus/greybus/device/.../state
137Date: October 2015
138KernelVersion: 4.XX
139Contact: Greg Kroah-Hartman <greg@kroah.com>
140Description:
141 A bundle has a state that is managed by the userspace
142 Endo process. This file allows that Endo to signal
143 other Android HALs that the state of the bundle has
144 changed to a specific value. When written to, any
145 process watching the file will be woken up, and the new
146 value can be read. It's a "poor-man's IPC", yes, but
147 simplifies the Android userspace code immensely.