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