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