greybus: interface: add interface-type attribute
[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/product_id
101 Date:           October 2015
102 KernelVersion:  4.XX
103 Contact:        Greg Kroah-Hartman <greg@kroah.com>
104 Description:
105                 Product ID of a Greybus interface.
106
107 What:           /sys/bus/greybus/devices/N-M.I/serial_number
108 Date:           October 2015
109 KernelVersion:  4.XX
110 Contact:        Greg Kroah-Hartman <greg@kroah.com>
111 Description:
112                 Serial Number of the Greybus interface, represented by a 64 bit
113                 hexadecimal number.
114
115 What:           /sys/bus/greybus/devices/N-M.I/vendor_id
116 Date:           October 2015
117 KernelVersion:  4.XX
118 Contact:        Greg Kroah-Hartman <greg@kroah.com>
119 Description:
120                 Vendor ID of a Greybus interface.
121
122 What:           /sys/bus/greybus/devices/N-M.I/voltage_now
123 Date:           March 2016
124 KernelVersion:  4.XX
125 Contact:        Greg Kroah-Hartman <greg@kroah.com>
126 Description:
127                 Voltage measurement of the interface in microvolts (uV)
128
129 What:           /sys/bus/greybus/devices/N-M.I.ctrl
130 Date:           October 2015
131 KernelVersion:  4.XX
132 Contact:        Greg Kroah-Hartman <greg@kroah.com>
133 Description:
134                 Abstract control device for interface I that represents the
135                 current mode of an enumerated Greybus interface.
136
137 What:           /sys/bus/greybus/devices/N-M.I.ctrl/product_string
138 Date:           October 2015
139 KernelVersion:  4.XX
140 Contact:        Greg Kroah-Hartman <greg@kroah.com>
141 Description:
142                 Product ID string of a Greybus interface.
143
144 What:           /sys/bus/greybus/devices/N-M.I.ctrl/vendor_string
145 Date:           October 2015
146 KernelVersion:  4.XX
147 Contact:        Greg Kroah-Hartman <greg@kroah.com>
148 Description:
149                 Vendor ID string of a Greybus interface.
150
151 What:           /sys/bus/greybus/devices/N-M.I.B
152 Date:           October 2015
153 KernelVersion:  4.XX
154 Contact:        Greg Kroah-Hartman <greg@kroah.com>
155 Description:
156                 A bundle B on the Interface I, B is replaced by a 1-byte
157                 number representing the bundle.
158
159 What:           /sys/bus/greybus/devices/N-M.I.B/bundle_class
160 Date:           October 2015
161 KernelVersion:  4.XX
162 Contact:        Greg Kroah-Hartman <greg@kroah.com>
163 Description:
164                 The greybus class of the bundle B.
165
166 What:           /sys/bus/greybus/devices/N-M.I.B/bundle_id
167 Date:           October 2015
168 KernelVersion:  4.XX
169 Contact:        Greg Kroah-Hartman <greg@kroah.com>
170 Description:
171                 The interface-unique id of the bundle B.
172
173 What:           /sys/bus/greybus/devices/N-M.I.B/gpbX
174 Date:           April 2016
175 KernelVersion:  4.XX
176 Contact:        Greg Kroah-Hartman <greg@kroah.com>
177 Description:
178                 The General Purpose Bridged PHY device of the bundle B,
179                 where X is a dynamically assigned 0-based id.
180
181 What:           /sys/bus/greybus/devices/N-M.I.B/state
182 Date:           October 2015
183 KernelVersion:  4.XX
184 Contact:        Greg Kroah-Hartman <greg@kroah.com>
185 Description:
186                 A bundle has a state that is managed by the userspace
187                 Endo process.  This file allows that Endo to signal
188                 other Android HALs that the state of the bundle has
189                 changed to a specific value.  When written to, any
190                 process watching the file will be woken up, and the new
191                 value can be read. It's a "poor-man's IPC", yes, but
192                 simplifies the Android userspace code immensely.
193
194 What:           /sys/bus/greybus/devices/N-svc
195 Date:           October 2015
196 KernelVersion:  4.XX
197 Contact:        Greg Kroah-Hartman <greg@kroah.com>
198 Description:
199                 The singleton SVC device of bus N.
200
201 What:           /sys/bus/greybus/devices/N-svc/ap_intf_id
202 Date:           October 2015
203 KernelVersion:  4.XX
204 Contact:        Greg Kroah-Hartman <greg@kroah.com>
205 Description:
206                 The AP interface ID, a 1-byte non-zero integer which
207                 defines the position of the AP module on the frame.
208                 The interface positions are defined in the ARA
209                 Module Developer Kit.
210
211 What:           /sys/bus/greybus/devices/N-svc/endo_id
212 Date:           October 2015
213 KernelVersion:  4.XX
214 Contact:        Greg Kroah-Hartman <greg@kroah.com>
215 Description:
216                 The Endo ID, which is a 2-byte hexadecimal value
217                 defined by the Endo layout scheme, documented in
218                 the ARA Module Developer Kit.
219
220 What:           /sys/bus/greybus/devices/N-svc/intf_eject
221 Date:           October 2015
222 KernelVersion:  4.XX
223 Contact:        Greg Kroah-Hartman <greg@kroah.com>
224 Description:
225                 Write the number of the interface that you wish to
226                 forcibly eject from the system.
227
228 What:           /sys/bus/greybus/devices/N-svc/version
229 Date:           October 2015
230 KernelVersion:  4.XX
231 Contact:        Greg Kroah-Hartman <greg@kroah.com>
232 Description:
233                 The version number of the firmware in the SVC device.
234
235 What:           /sys/bus/greybus/devices/N-svc/watchdog
236 Date:           October 2016
237 KernelVersion:  4.XX
238 Contact:        Greg Kroah-Hartman <greg@kroah.com>
239 Description:
240                 If the SVC watchdog is enabled or not.  Writing 0 to this
241                 file will disable the watchdog, writing 1 will enable it.