Merge tag 'ntb-5.11' of git://github.com/jonmason/ntb
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-bus-most
1 What:           /sys/bus/most/devices/<dev>/description
2 Date:           March 2017
3 KernelVersion:  4.15
4 Contact:        Christian Gromm <christian.gromm@microchip.com>
5 Description:
6                 Provides information about the physical location of the
7                 device. Hardware attached via USB, for instance,
8                 might return <1-1.1:1.0>
9 Users:
10
11 What:           /sys/bus/most/devices/<dev>/interface
12 Date:           March 2017
13 KernelVersion:  4.15
14 Contact:        Christian Gromm <christian.gromm@microchip.com>
15 Description:
16                 Indicates the type of peripheral interface the device uses.
17 Users:
18
19 What:           /sys/bus/most/devices/<dev>/dci
20 Date:           June 2016
21 KernelVersion:  4.15
22 Contact:        Christian Gromm <christian.gromm@microchip.com>
23 Description:
24                 If the network interface controller is attached via USB, a dci
25                 directory is created that allows applications to read and
26                 write the controller's DCI registers.
27 Users:
28
29 What:           /sys/bus/most/devices/<dev>/dci/arb_address
30 Date:           June 2016
31 KernelVersion:  4.15
32 Contact:        Christian Gromm <christian.gromm@microchip.com>
33 Description:
34                 This is used to set an arbitrary DCI register address an
35                 application wants to read from or write to.
36 Users:
37
38 What:           /sys/bus/most/devices/<dev>/dci/arb_value
39 Date:           June 2016
40 KernelVersion:  4.15
41 Contact:        Christian Gromm <christian.gromm@microchip.com>
42 Description:
43                 This is used to read and write the DCI register whose address
44                 is stored in arb_address.
45 Users:
46
47 What:           /sys/bus/most/devices/<dev>/dci/mep_eui48_hi
48 Date:           June 2016
49 KernelVersion:  4.15
50 Contact:        Christian Gromm <christian.gromm@microchip.com>
51 Description:
52                 This is used to check and configure the MAC address.
53 Users:
54
55 What:           /sys/bus/most/devices/<dev>/dci/mep_eui48_lo
56 Date:           June 2016
57 KernelVersion:  4.15
58 Contact:        Christian Gromm <christian.gromm@microchip.com>
59 Description:
60                 This is used to check and configure the MAC address.
61 Users:
62
63 What:           /sys/bus/most/devices/<dev>/dci/mep_eui48_mi
64 Date:           June 2016
65 KernelVersion:  4.15
66 Contact:        Christian Gromm <christian.gromm@microchip.com>
67 Description:
68                 This is used to check and configure the MAC address.
69 Users:
70
71 What:           /sys/bus/most/devices/<dev>/dci/mep_filter
72 Date:           June 2016
73 KernelVersion:  4.15
74 Contact:        Christian Gromm <christian.gromm@microchip.com>
75 Description:
76                 This is used to check and configure the MEP filter address.
77 Users:
78
79 What:           /sys/bus/most/devices/<dev>/dci/mep_hash0
80 Date:           June 2016
81 KernelVersion:  4.15
82 Contact:        Christian Gromm <christian.gromm@microchip.com>
83 Description:
84                 This is used to check and configure the MEP hash table.
85 Users:
86
87 What:           /sys/bus/most/devices/<dev>/dci/mep_hash1
88 Date:           June 2016
89 KernelVersion:  4.15
90 Contact:        Christian Gromm <christian.gromm@microchip.com>
91 Description:
92                 This is used to check and configure the MEP hash table.
93 Users:
94
95 What:           /sys/bus/most/devices/<dev>/dci/mep_hash2
96 Date:           June 2016
97 KernelVersion:  4.15
98 Contact:        Christian Gromm <christian.gromm@microchip.com>
99 Description:
100                 This is used to check and configure the MEP hash table.
101 Users:
102
103 What:           /sys/bus/most/devices/<dev>/dci/mep_hash3
104 Date:           June 2016
105 KernelVersion:  4.15
106 Contact:        Christian Gromm <christian.gromm@microchip.com>
107 Description:
108                 This is used to check and configure the MEP hash table.
109 Users:
110
111 What:           /sys/bus/most/devices/<dev>/dci/ni_state
112 Date:           June 2016
113 KernelVersion:  4.15
114 Contact:        Christian Gromm <christian.gromm@microchip.com>
115 Description:
116                 Indicates the current network interface state.
117 Users:
118
119 What:           /sys/bus/most/devices/<dev>/dci/node_address
120 Date:           June 2016
121 KernelVersion:  4.15
122 Contact:        Christian Gromm <christian.gromm@microchip.com>
123 Description:
124                 Indicates the current node address.
125 Users:
126
127 What:           /sys/bus/most/devices/<dev>/dci/node_position
128 Date:           June 2016
129 KernelVersion:  4.15
130 Contact:        Christian Gromm <christian.gromm@microchip.com>
131 Description:
132                 Indicates the current node position.
133 Users:
134
135 What:           /sys/bus/most/devices/<dev>/dci/packet_bandwidth
136 Date:           June 2016
137 KernelVersion:  4.15
138 Contact:        Christian Gromm <christian.gromm@microchip.com>
139 Description:
140                 Indicates the configured packet bandwidth.
141 Users:
142
143 What:           /sys/bus/most/devices/<dev>/dci/sync_ep
144 Date:           June 2016
145 KernelVersion:  4.15
146 Contact:        Christian Gromm <christian.gromm@microchip.com>
147 Description:
148                 Triggers the controller's synchronization process for a certain
149                 endpoint.
150 Users:
151
152 What:           /sys/bus/most/devices/<dev>/<channel>/
153 Date:           March 2017
154 KernelVersion:  4.15
155 Contact:        Christian Gromm <christian.gromm@microchip.com>
156 Description:
157                 For every channel of the device a directory is created, whose
158                 name is dictated by the HDM. This enables an application to
159                 collect information about the channel's capabilities and
160                 configure it.
161 Users:
162
163 What:           /sys/bus/most/devices/<dev>/<channel>/available_datatypes
164 Date:           March 2017
165 KernelVersion:  4.15
166 Contact:        Christian Gromm <christian.gromm@microchip.com>
167 Description:
168                 Indicates the data types the channel can transport.
169 Users:
170
171 What:           /sys/bus/most/devices/<dev>/<channel>/available_directions
172 Date:           March 2017
173 KernelVersion:  4.15
174 Contact:        Christian Gromm <christian.gromm@microchip.com>
175 Description:
176                 Indicates the directions the channel is capable of.
177 Users:
178
179 What:           /sys/bus/most/devices/<dev>/<channel>/number_of_packet_buffers
180 Date:           March 2017
181 KernelVersion:  4.15
182 Contact:        Christian Gromm <christian.gromm@microchip.com>
183 Description:
184                 Indicates the number of packet buffers the channel can
185                 handle.
186 Users:
187
188 What:           /sys/bus/most/devices/<dev>/<channel>/number_of_stream_buffers
189 Date:           March 2017
190 KernelVersion:  4.15
191 Contact:        Christian Gromm <christian.gromm@microchip.com>
192 Description:
193                 Indicates the number of streaming buffers the channel can
194                 handle.
195 Users:
196
197 What:           /sys/bus/most/devices/<dev>/<channel>/size_of_packet_buffer
198 Date:           March 2017
199 KernelVersion:  4.15
200 Contact:        Christian Gromm <christian.gromm@microchip.com>
201 Description:
202                 Indicates the size of a packet buffer the channel can
203                 handle.
204 Users:
205
206 What:           /sys/bus/most/devices/<dev>/<channel>/size_of_stream_buffer
207 Date:           March 2017
208 KernelVersion:  4.15
209 Contact:        Christian Gromm <christian.gromm@microchip.com>
210 Description:
211                 Indicates the size of a streaming buffer the channel can
212                 handle.
213 Users:
214
215 What:           /sys/bus/most/devices/<dev>/<channel>/set_number_of_buffers
216 Date:           March 2017
217 KernelVersion:  4.15
218 Contact:        Christian Gromm <christian.gromm@microchip.com>
219 Description:
220                 This is to read back the configured number of buffers of
221                 the channel.
222 Users:
223
224 What:           /sys/bus/most/devices/<dev>/<channel>/set_buffer_size
225 Date:           March 2017
226 KernelVersion:  4.15
227 Contact:        Christian Gromm <christian.gromm@microchip.com>
228 Description:
229                 This is to read back the configured buffer size of the channel.
230 Users:
231
232 What:           /sys/bus/most/devices/<dev>/<channel>/set_direction
233 Date:           March 2017
234 KernelVersion:  4.15
235 Contact:        Christian Gromm <christian.gromm@microchip.com>
236 Description:
237                 This is to read back the configured direction of the channel.
238                 The following strings will be accepted::
239
240                         'tx',
241                         'rx'
242 Users:
243
244 What:           /sys/bus/most/devices/<dev>/<channel>/set_datatype
245 Date:           March 2017
246 KernelVersion:  4.15
247 Contact:        Christian Gromm <christian.gromm@microchip.com>
248 Description:
249                 This is to read back the configured data type of the channel.
250                 The following strings will be accepted::
251
252                         'control',
253                         'async',
254                         'sync',
255                         'isoc_avp'
256 Users:
257
258 What:           /sys/bus/most/devices/<dev>/<channel>/set_subbuffer_size
259 Date:           March 2017
260 KernelVersion:  4.15
261 Contact:        Christian Gromm <christian.gromm@microchip.com>
262 Description:
263                 This is to read back the configured subbuffer size of
264                 the channel.
265 Users:
266
267 What:           /sys/bus/most/devices/<dev>/<channel>/set_packets_per_xact
268 Date:           March 2017
269 KernelVersion:  4.15
270 Contact:        Christian Gromm <christian.gromm@microchip.com>
271 Description:
272                 This is to read back the configured number of packets per
273                 transaction of the channel. This is only applicable when
274                 connected via USB.
275 Users:
276
277 What:           /sys/bus/most/devices/<dev>/<channel>/channel_starving
278 Date:           March 2017
279 KernelVersion:  4.15
280 Contact:        Christian Gromm <christian.gromm@microchip.com>
281 Description:
282                 Indicates whether channel ran out of buffers.
283 Users:
284
285 What:           /sys/bus/most/drivers/most_core/components
286 Date:           March 2017
287 KernelVersion:  4.15
288 Contact:        Christian Gromm <christian.gromm@microchip.com>
289 Description:
290                 This is used to retrieve a list of registered components.
291 Users:
292
293 What:           /sys/bus/most/drivers/most_core/links
294 Date:           March 2017
295 KernelVersion:  4.15
296 Contact:        Christian Gromm <christian.gromm@microchip.com>
297 Description:
298                 This is used to retrieve a list of established links.
299 Users: