greybus: Documentation: move the interface power attributes
[cascardo/linux.git] / drivers / staging / greybus / Documentation / sysfs-bus-greybus
1 What:           /sys/bus/greybus/device/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/device/N-I
10 Date:           October 2015
11 KernelVersion:  4.XX
12 Contact:        Greg Kroah-Hartman <greg@kroah.com>
13 Description:
14                 An Interface I on the bus N, where I is the 1-byte interface
15                 ID.
16
17 What:           /sys/bus/greybus/device/N-I/ddbl1_manufacturer_id
18 Date:           October 2015
19 KernelVersion:  4.XX
20 Contact:        Greg Kroah-Hartman <greg@kroah.com>
21 Description:
22                 Unipro Device Descriptor Block Level 1 manufacturer ID for the
23                 greybus Interface.
24
25 What:           /sys/bus/greybus/device/N-I/ddbl1_product_id
26 Date:           October 2015
27 KernelVersion:  4.XX
28 Contact:        Greg Kroah-Hartman <greg@kroah.com>
29 Description:
30                 Unipro Device Descriptor Block Level 1 product ID for the
31                 greybus Interface.
32
33 What:           /sys/bus/greybus/device/N-I/interface_id
34 Date:           October 2015
35 KernelVersion:  4.XX
36 Contact:        Greg Kroah-Hartman <greg@kroah.com>
37 Description:
38                 The ID of a Greybus interface.
39
40 What:           /sys/bus/greybus/device/N-I/serial_number
41 Date:           October 2015
42 KernelVersion:  4.XX
43 Contact:        Greg Kroah-Hartman <greg@kroah.com>
44 Description:
45                 Serial Number of the Greybus interface, represented by a 64 bit
46                 hexadecimal number.
47
48 What:           /sys/bus/greybus/device/N-I/product_id
49 Date:           October 2015
50 KernelVersion:  4.XX
51 Contact:        Greg Kroah-Hartman <greg@kroah.com>
52 Description:
53                 Product ID of a Greybus interface.
54
55 What:           /sys/bus/greybus/device/N-I/product_string
56 Date:           October 2015
57 KernelVersion:  4.XX
58 Contact:        Greg Kroah-Hartman <greg@kroah.com>
59 Description:
60                 Product ID string of a Greybus interface.
61
62 What:           /sys/bus/greybus/device/N-I/vendor_id
63 Date:           October 2015
64 KernelVersion:  4.XX
65 Contact:        Greg Kroah-Hartman <greg@kroah.com>
66 Description:
67                 Vendor ID of a Greybus interface.
68
69 What:           /sys/bus/greybus/device/N-I/vendor_string
70 Date:           October 2015
71 KernelVersion:  4.XX
72 Contact:        Greg Kroah-Hartman <greg@kroah.com>
73 Description:
74                 Vendor ID string of a Greybus interface block.
75
76 What:           /sys/bus/greybus/device/N-I/version
77 Date:           October 2015
78 KernelVersion:  4.XX
79 Contact:        Greg Kroah-Hartman <greg@kroah.com>
80 Description:
81                 Interface version represented as <16 bit major number>.<16 bit
82                 minor number>.
83
84 What:           /sys/bus/greybus/device/N-I/voltage_now
85 Date:           March 2016
86 KernelVersion:  4.XX
87 Contact:        Greg Kroah-Hartman <greg@kroah.com>
88 Description:
89                 Voltage measurement of the interface in microvolts (uV)
90
91 What:           /sys/bus/greybus/device/N-I/current_now
92 Date:           March 2016
93 KernelVersion:  4.XX
94 Contact:        Greg Kroah-Hartman <greg@kroah.com>
95 Description:
96                 Current measurement of the interface in microamps (uA)
97
98 What:           /sys/bus/greybus/device/N-I/power_now
99 Date:           March 2016
100 KernelVersion:  4.XX
101 Contact:        Greg Kroah-Hartman <greg@kroah.com>
102 Description:
103                 Power measurement of the interface in microwatts (uW)
104
105 What:           /sys/bus/greybus/device/N-I.B
106 Date:           October 2015
107 KernelVersion:  4.XX
108 Contact:        Greg Kroah-Hartman <greg@kroah.com>
109 Description:
110                 A bundle B on the Interface I, B is replaced by a 1-byte
111                 number representing the bundle.
112
113 What:           /sys/bus/greybus/device/N-I.B/bundle_class
114 Date:           October 2015
115 KernelVersion:  4.XX
116 Contact:        Greg Kroah-Hartman <greg@kroah.com>
117 Description:
118                 The greybus class of the bundle B.
119
120 What:           /sys/bus/greybus/device/N-I.B/bundle_id
121 Date:           October 2015
122 KernelVersion:  4.XX
123 Contact:        Greg Kroah-Hartman <greg@kroah.com>
124 Description:
125                 The interface-unique id of the bundle B.
126
127 What:           /sys/bus/greybus/device/N-I.B/state
128 Date:           October 2015
129 KernelVersion:  4.XX
130 Contact:        Greg Kroah-Hartman <greg@kroah.com>
131 Description:
132                 A bundle has a state that is managed by the userspace
133                 Endo process.  This file allows that Endo to signal
134                 other Android HALs that the state of the bundle has
135                 changed to a specific value.  When written to, any
136                 process watching the file will be woken up, and the new
137                 value can be read. It's a "poor-man's IPC", yes, but
138                 simplifies the Android userspace code immensely.
139
140 What:           /sys/bus/greybus/device/N-svc
141 Date:           October 2015
142 KernelVersion:  4.XX
143 Contact:        Greg Kroah-Hartman <greg@kroah.com>
144 Description:
145                 The singleton SVC device of bus N.
146
147 What:           /sys/bus/greybus/device/N-svc/ap_intf_id
148 Date:           October 2015
149 KernelVersion:  4.XX
150 Contact:        Greg Kroah-Hartman <greg@kroah.com>
151 Description:
152                 The AP interface ID, a 1-byte non-zero integer which
153                 defines the position of the AP module on the frame.
154                 The interface positions are defined in the ARA
155                 Module Developer Kit.
156
157 What:           /sys/bus/greybus/device/N-svc/endo_id
158 Date:           October 2015
159 KernelVersion:  4.XX
160 Contact:        Greg Kroah-Hartman <greg@kroah.com>
161 Description:
162                 The Endo ID, which is a 2-byte hexadecimal value
163                 defined by the Endo layout scheme, documented in
164                 the ARA Module Developer Kit.
165
166 What:           /sys/bus/greybus/device/N-svc/intf_eject
167 Date:           October 2015
168 KernelVersion:  4.XX
169 Contact:        Greg Kroah-Hartman <greg@kroah.com>
170 Description:
171                 Write the number of the interface that you wish to
172                 forcibly eject from the system.
173
174 What:           /sys/bus/greybus/device/N-svc/version
175 Date:           October 2015
176 KernelVersion:  4.XX
177 Contact:        Greg Kroah-Hartman <greg@kroah.com>
178 Description:
179                 The version number of the firmware in the SVC device.
180
181 What:           /sys/bus/greybus/device/N-svc/watchdog
182 Date:           October 2016
183 KernelVersion:  4.XX
184 Contact:        Greg Kroah-Hartman <greg@kroah.com>
185 Description:
186                 If the SVC watchdog is enabled or not.  Writing 0 to this
187                 file will disable the watchdog, writing 1 will enable it.