greybus: interface: fix power_state documentation
[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/interface_type
86 Date:           June 2016
87 KernelVersion:  4.XX
88 Contact:        Greg Kroah-Hartman <greg@kroah.com>
89 Description:
90                 The type of a Greybus interface; "dummy", "unipro", "greybus",
91                 or "unknown".
92
93 What:           /sys/bus/greybus/devices/N-M.I/power_now
94 Date:           March 2016
95 KernelVersion:  4.XX
96 Contact:        Greg Kroah-Hartman <greg@kroah.com>
97 Description:
98                 Power measurement of the interface in microwatts (uW)
99
100 What:           /sys/bus/greybus/devices/N-M.I/power_state
101 Date:           March 2016
102 KernelVersion:  4.XX
103 Contact:        Greg Kroah-Hartman <greg@kroah.com>
104 Description:
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
118 What:           /sys/bus/greybus/devices/N-M.I/product_id
119 Date:           October 2015
120 KernelVersion:  4.XX
121 Contact:        Greg Kroah-Hartman <greg@kroah.com>
122 Description:
123                 Product ID of a Greybus interface.
124
125 What:           /sys/bus/greybus/devices/N-M.I/serial_number
126 Date:           October 2015
127 KernelVersion:  4.XX
128 Contact:        Greg Kroah-Hartman <greg@kroah.com>
129 Description:
130                 Serial Number of the Greybus interface, represented by a 64 bit
131                 hexadecimal number.
132
133 What:           /sys/bus/greybus/devices/N-M.I/vendor_id
134 Date:           October 2015
135 KernelVersion:  4.XX
136 Contact:        Greg Kroah-Hartman <greg@kroah.com>
137 Description:
138                 Vendor ID of a Greybus interface.
139
140 What:           /sys/bus/greybus/devices/N-M.I/voltage_now
141 Date:           March 2016
142 KernelVersion:  4.XX
143 Contact:        Greg Kroah-Hartman <greg@kroah.com>
144 Description:
145                 Voltage measurement of the interface in microvolts (uV)
146
147 What:           /sys/bus/greybus/devices/N-M.I.ctrl
148 Date:           October 2015
149 KernelVersion:  4.XX
150 Contact:        Greg Kroah-Hartman <greg@kroah.com>
151 Description:
152                 Abstract control device for interface I that represents the
153                 current mode of an enumerated Greybus interface.
154
155 What:           /sys/bus/greybus/devices/N-M.I.ctrl/product_string
156 Date:           October 2015
157 KernelVersion:  4.XX
158 Contact:        Greg Kroah-Hartman <greg@kroah.com>
159 Description:
160                 Product ID string of a Greybus interface.
161
162 What:           /sys/bus/greybus/devices/N-M.I.ctrl/vendor_string
163 Date:           October 2015
164 KernelVersion:  4.XX
165 Contact:        Greg Kroah-Hartman <greg@kroah.com>
166 Description:
167                 Vendor ID string of a Greybus interface.
168
169 What:           /sys/bus/greybus/devices/N-M.I.B
170 Date:           October 2015
171 KernelVersion:  4.XX
172 Contact:        Greg Kroah-Hartman <greg@kroah.com>
173 Description:
174                 A bundle B on the Interface I, B is replaced by a 1-byte
175                 number representing the bundle.
176
177 What:           /sys/bus/greybus/devices/N-M.I.B/bundle_class
178 Date:           October 2015
179 KernelVersion:  4.XX
180 Contact:        Greg Kroah-Hartman <greg@kroah.com>
181 Description:
182                 The greybus class of the bundle B.
183
184 What:           /sys/bus/greybus/devices/N-M.I.B/bundle_id
185 Date:           October 2015
186 KernelVersion:  4.XX
187 Contact:        Greg Kroah-Hartman <greg@kroah.com>
188 Description:
189                 The interface-unique id of the bundle B.
190
191 What:           /sys/bus/greybus/devices/N-M.I.B/gpbX
192 Date:           April 2016
193 KernelVersion:  4.XX
194 Contact:        Greg Kroah-Hartman <greg@kroah.com>
195 Description:
196                 The General Purpose Bridged PHY device of the bundle B,
197                 where X is a dynamically assigned 0-based id.
198
199 What:           /sys/bus/greybus/devices/N-M.I.B/state
200 Date:           October 2015
201 KernelVersion:  4.XX
202 Contact:        Greg Kroah-Hartman <greg@kroah.com>
203 Description:
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
212 What:           /sys/bus/greybus/devices/N-svc
213 Date:           October 2015
214 KernelVersion:  4.XX
215 Contact:        Greg Kroah-Hartman <greg@kroah.com>
216 Description:
217                 The singleton SVC device of bus N.
218
219 What:           /sys/bus/greybus/devices/N-svc/ap_intf_id
220 Date:           October 2015
221 KernelVersion:  4.XX
222 Contact:        Greg Kroah-Hartman <greg@kroah.com>
223 Description:
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 ARA
227                 Module Developer Kit.
228
229 What:           /sys/bus/greybus/devices/N-svc/endo_id
230 Date:           October 2015
231 KernelVersion:  4.XX
232 Contact:        Greg Kroah-Hartman <greg@kroah.com>
233 Description:
234                 The Endo ID, which is a 2-byte hexadecimal value
235                 defined by the Endo layout scheme, documented in
236                 the ARA Module Developer Kit.
237
238 What:           /sys/bus/greybus/devices/N-svc/intf_eject
239 Date:           October 2015
240 KernelVersion:  4.XX
241 Contact:        Greg Kroah-Hartman <greg@kroah.com>
242 Description:
243                 Write the number of the interface that you wish to
244                 forcibly eject from the system.
245
246 What:           /sys/bus/greybus/devices/N-svc/version
247 Date:           October 2015
248 KernelVersion:  4.XX
249 Contact:        Greg Kroah-Hartman <greg@kroah.com>
250 Description:
251                 The version number of the firmware in the SVC device.
252
253 What:           /sys/bus/greybus/devices/N-svc/watchdog
254 Date:           October 2016
255 KernelVersion:  4.XX
256 Contact:        Greg Kroah-Hartman <greg@kroah.com>
257 Description:
258                 If the SVC watchdog is enabled or not.  Writing 0 to this
259                 file will disable the watchdog, writing 1 will enable it.