8605d705b61780c4b65ebc70e6115de7b7762382
[cascardo/linux.git] / drivers / staging / greybus / Documentation / sysfs-bus-greybus
1 What:           /sys/bus/greybus/devices/greybusN
2 Date:           October 2015
3 KernelVersion:  4.XX
4 Contact:        Greg Kroah-Hartman <greg@kroah.com>
5 Description:
6                 The "root" greybus device for the Greybus device tree, or bus,
7                 where N is a dynamically assigned 1-based id.
8
9 What:           /sys/bus/greybus/devices/greybusN/bus_id
10 Date:           April 2016
11 KernelVersion:  4.XX
12 Contact:        Greg Kroah-Hartman <greg@kroah.com>
13 Description:
14                 The ID of the "root" greybus device, or bus.
15
16 What:           /sys/bus/greybus/devices/N-M
17 Date:           March 2016
18 KernelVersion:  4.XX
19 Contact:        Greg Kroah-Hartman <greg@kroah.com>
20 Description:
21                 A Module M on the bus N, where M is the 1-byte interface
22                 ID of the module's primary interface.
23
24 What:           /sys/bus/greybus/devices/N-M/eject
25 Date:           March 2016
26 KernelVersion:  4.XX
27 Contact:        Greg Kroah-Hartman <greg@kroah.com>
28 Description:
29                 Writing a non-zero argument to this attibute disables the
30                 module's interfaces before physically ejecting it.
31
32 What:           /sys/bus/greybus/devices/N-M/module_id
33 Date:           March 2016
34 KernelVersion:  4.XX
35 Contact:        Greg Kroah-Hartman <greg@kroah.com>
36 Description:
37                 The ID of a Greybus module, corresponding to the ID of its
38                 primary interface.
39
40 What:           /sys/bus/greybus/devices/N-M/num_interfaces
41 Date:           March 2016
42 KernelVersion:  4.XX
43 Contact:        Greg Kroah-Hartman <greg@kroah.com>
44 Description:
45                 The number of interfaces of a module.
46
47 What:           /sys/bus/greybus/devices/N-M.I
48 Date:           October 2015
49 KernelVersion:  4.XX
50 Contact:        Greg Kroah-Hartman <greg@kroah.com>
51 Description:
52                 An Interface I on the bus N and module N-M, where I is the
53                 1-byte interface ID.
54
55 What:           /sys/bus/greybus/devices/N-M.I/current_now
56 Date:           March 2016
57 KernelVersion:  4.XX
58 Contact:        Greg Kroah-Hartman <greg@kroah.com>
59 Description:
60                 Current measurement of the interface in microamps (uA)
61
62 What:           /sys/bus/greybus/devices/N-M.I/ddbl1_manufacturer_id
63 Date:           October 2015
64 KernelVersion:  4.XX
65 Contact:        Greg Kroah-Hartman <greg@kroah.com>
66 Description:
67                 Unipro Device Descriptor Block Level 1 manufacturer ID for the
68                 greybus Interface.
69
70 What:           /sys/bus/greybus/devices/N-M.I/ddbl1_product_id
71 Date:           October 2015
72 KernelVersion:  4.XX
73 Contact:        Greg Kroah-Hartman <greg@kroah.com>
74 Description:
75                 Unipro Device Descriptor Block Level 1 product ID for the
76                 greybus Interface.
77
78 What:           /sys/bus/greybus/devices/N-M.I/interface_id
79 Date:           October 2015
80 KernelVersion:  4.XX
81 Contact:        Greg Kroah-Hartman <greg@kroah.com>
82 Description:
83                 The ID of a Greybus interface.
84
85 What:           /sys/bus/greybus/devices/N-M.I/power_now
86 Date:           March 2016
87 KernelVersion:  4.XX
88 Contact:        Greg Kroah-Hartman <greg@kroah.com>
89 Description:
90                 Power measurement of the interface in microwatts (uW)
91
92 What:           /sys/bus/greybus/devices/N-M.I/product_id
93 Date:           October 2015
94 KernelVersion:  4.XX
95 Contact:        Greg Kroah-Hartman <greg@kroah.com>
96 Description:
97                 Product ID of a Greybus interface.
98
99 What:           /sys/bus/greybus/devices/N-M.I/serial_number
100 Date:           October 2015
101 KernelVersion:  4.XX
102 Contact:        Greg Kroah-Hartman <greg@kroah.com>
103 Description:
104                 Serial Number of the Greybus interface, represented by a 64 bit
105                 hexadecimal number.
106
107 What:           /sys/bus/greybus/devices/N-M.I/vendor_id
108 Date:           October 2015
109 KernelVersion:  4.XX
110 Contact:        Greg Kroah-Hartman <greg@kroah.com>
111 Description:
112                 Vendor ID of a Greybus interface.
113
114 What:           /sys/bus/greybus/devices/N-M.I/voltage_now
115 Date:           March 2016
116 KernelVersion:  4.XX
117 Contact:        Greg Kroah-Hartman <greg@kroah.com>
118 Description:
119                 Voltage measurement of the interface in microvolts (uV)
120
121 What:           /sys/bus/greybus/devices/N-M.I.ctrl
122 Date:           October 2015
123 KernelVersion:  4.XX
124 Contact:        Greg Kroah-Hartman <greg@kroah.com>
125 Description:
126                 Abstract control device for interface I that represents the
127                 current mode of an enumerated Greybus interface.
128
129 What:           /sys/bus/greybus/devices/N-M.I.ctrl/product_string
130 Date:           October 2015
131 KernelVersion:  4.XX
132 Contact:        Greg Kroah-Hartman <greg@kroah.com>
133 Description:
134                 Product ID string of a Greybus interface.
135
136 What:           /sys/bus/greybus/devices/N-M.I.ctrl/vendor_string
137 Date:           October 2015
138 KernelVersion:  4.XX
139 Contact:        Greg Kroah-Hartman <greg@kroah.com>
140 Description:
141                 Vendor ID string of a Greybus interface.
142
143 What:           /sys/bus/greybus/devices/N-M.I.B
144 Date:           October 2015
145 KernelVersion:  4.XX
146 Contact:        Greg Kroah-Hartman <greg@kroah.com>
147 Description:
148                 A bundle B on the Interface I, B is replaced by a 1-byte
149                 number representing the bundle.
150
151 What:           /sys/bus/greybus/devices/N-M.I.B/bundle_class
152 Date:           October 2015
153 KernelVersion:  4.XX
154 Contact:        Greg Kroah-Hartman <greg@kroah.com>
155 Description:
156                 The greybus class of the bundle B.
157
158 What:           /sys/bus/greybus/devices/N-M.I.B/bundle_id
159 Date:           October 2015
160 KernelVersion:  4.XX
161 Contact:        Greg Kroah-Hartman <greg@kroah.com>
162 Description:
163                 The interface-unique id of the bundle B.
164
165 What:           /sys/bus/greybus/devices/N-M.I.B/gpbX
166 Date:           April 2016
167 KernelVersion:  4.XX
168 Contact:        Greg Kroah-Hartman <greg@kroah.com>
169 Description:
170                 The General Purpose Bridged PHY device of the bundle B,
171                 where X is a dynamically assigned 0-based id.
172
173 What:           /sys/bus/greybus/devices/N-M.I.B/state
174 Date:           October 2015
175 KernelVersion:  4.XX
176 Contact:        Greg Kroah-Hartman <greg@kroah.com>
177 Description:
178                 A bundle has a state that is managed by the userspace
179                 Endo process.  This file allows that Endo to signal
180                 other Android HALs that the state of the bundle has
181                 changed to a specific value.  When written to, any
182                 process watching the file will be woken up, and the new
183                 value can be read. It's a "poor-man's IPC", yes, but
184                 simplifies the Android userspace code immensely.
185
186 What:           /sys/bus/greybus/devices/N-svc
187 Date:           October 2015
188 KernelVersion:  4.XX
189 Contact:        Greg Kroah-Hartman <greg@kroah.com>
190 Description:
191                 The singleton SVC device of bus N.
192
193 What:           /sys/bus/greybus/devices/N-svc/ap_intf_id
194 Date:           October 2015
195 KernelVersion:  4.XX
196 Contact:        Greg Kroah-Hartman <greg@kroah.com>
197 Description:
198                 The AP interface ID, a 1-byte non-zero integer which
199                 defines the position of the AP module on the frame.
200                 The interface positions are defined in the ARA
201                 Module Developer Kit.
202
203 What:           /sys/bus/greybus/devices/N-svc/endo_id
204 Date:           October 2015
205 KernelVersion:  4.XX
206 Contact:        Greg Kroah-Hartman <greg@kroah.com>
207 Description:
208                 The Endo ID, which is a 2-byte hexadecimal value
209                 defined by the Endo layout scheme, documented in
210                 the ARA Module Developer Kit.
211
212 What:           /sys/bus/greybus/devices/N-svc/intf_eject
213 Date:           October 2015
214 KernelVersion:  4.XX
215 Contact:        Greg Kroah-Hartman <greg@kroah.com>
216 Description:
217                 Write the number of the interface that you wish to
218                 forcibly eject from the system.
219
220 What:           /sys/bus/greybus/devices/N-svc/version
221 Date:           October 2015
222 KernelVersion:  4.XX
223 Contact:        Greg Kroah-Hartman <greg@kroah.com>
224 Description:
225                 The version number of the firmware in the SVC device.
226
227 What:           /sys/bus/greybus/devices/N-svc/watchdog
228 Date:           October 2016
229 KernelVersion:  4.XX
230 Contact:        Greg Kroah-Hartman <greg@kroah.com>
231 Description:
232                 If the SVC watchdog is enabled or not.  Writing 0 to this
233                 file will disable the watchdog, writing 1 will enable it.