These changes are the raw update to linux-4.4.6-rt14. Kernel sources
[kvmfornfv.git] / kernel / drivers / staging / most / Documentation / ABI / sysfs-class-most.txt
1 What:           /sys/class/most/mostcore/aims
2 Date:           June 2015
3 KernelVersion:  4.3
4 Contact:        Christian Gromm <christian.gromm@microchip.com>
5 Description:
6                 List of AIMs that have been loaded.
7 Users:
8
9 What:           /sys/class/most/mostcore/aims/<aim>/add_link
10 Date:           June 2015
11 KernelVersion:  4.3
12 Contact:        Christian Gromm <christian.gromm@microchip.com>
13 Description:
14                 This is used to establish a connection of a channel and the
15                 current AIM.
16 Users:
17
18 What:           /sys/class/most/mostcore/aims/<aim>/remove_link
19 Date:           June 2015
20 KernelVersion:  4.3
21 Contact:        Christian Gromm <christian.gromm@microchip.com>
22 Description:
23                 This is used to remove a connected channel from the
24                 current AIM.
25 Users:
26
27 What:           /sys/class/most/mostcore/devices
28 Date:           June 2015
29 KernelVersion:  4.3
30 Contact:        Christian Gromm <christian.gromm@microchip.com>
31 Description:
32                 List of attached MOST interfaces.
33 Users:
34
35 What:           /sys/class/most/mostcore/devices/<mdev>/description
36 Date:           June 2015
37 KernelVersion:  4.3
38 Contact:        Christian Gromm <christian.gromm@microchip.com>
39 Description:
40                 Provides information about the interface type and the physical
41                 location of the device. Hardware attached via USB, for instance,
42                 might return <usb_device 1-1.1:1.0>
43 Users:
44
45 What:           /sys/class/most/mostcore/devices/<mdev>/interface
46 Date:           June 2015
47 KernelVersion:  4.3
48 Contact:        Christian Gromm <christian.gromm@microchip.com>
49 Description:
50                 Indicates the type of peripheral interface the current device
51                 uses.
52 Users:
53
54 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/
55 Date:           June 2015
56 KernelVersion:  4.3
57 Contact:        Christian Gromm <christian.gromm@microchip.com>
58 Description:
59                 For every channel of the device a directory is created, whose
60                 name is dictated by the HDM. This enables an application to
61                 collect information about the channel's capabilities and
62                 configure it.
63 Users:
64
65 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/available_datatypes
66 Date:           June 2015
67 KernelVersion:  4.3
68 Contact:        Christian Gromm <christian.gromm@microchip.com>
69 Description:
70                 Indicates the data types the current channel can transport.
71 Users:
72
73 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/available_directions
74 Date:           June 2015
75 KernelVersion:  4.3
76 Contact:        Christian Gromm <christian.gromm@microchip.com>
77 Description:
78                 Indicates the directions the current channel is capable of.
79 Users:
80
81 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/number_of_packet_buffers
82 Date:           June 2015
83 KernelVersion:  4.3
84 Contact:        Christian Gromm <christian.gromm@microchip.com>
85 Description:
86                 Indicates the number of packet buffers the current channel can
87                 handle.
88 Users:
89
90 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/number_of_stream_buffers
91 Date:           June 2015
92 KernelVersion:  4.3
93 Contact:        Christian Gromm <christian.gromm@microchip.com>
94 Description:
95                 Indicates the number of streaming buffers the current channel can
96                 handle.
97 Users:
98
99 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/size_of_packet_buffer
100 Date:           June 2015
101 KernelVersion:  4.3
102 Contact:        Christian Gromm <christian.gromm@microchip.com>
103 Description:
104                 Indicates the size of a packet buffer the current channel can
105                 handle.
106 Users:
107
108 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/size_of_stream_buffer
109 Date:           June 2015
110 KernelVersion:  4.3
111 Contact:        Christian Gromm <christian.gromm@microchip.com>
112 Description:
113                 Indicates the size of a streaming buffer the current channel can
114                 handle.
115 Users:
116
117 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_number_of_buffers
118 Date:           June 2015
119 KernelVersion:  4.3
120 Contact:        Christian Gromm <christian.gromm@microchip.com>
121 Description:
122                 This is to configure the number of buffers of the current channel.
123 Users:
124
125 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_buffer_size
126 Date:           June 2015
127 KernelVersion:  4.3
128 Contact:        Christian Gromm <christian.gromm@microchip.com>
129 Description:
130                 This is to configure the size of a buffer of the current channel.
131 Users:
132
133 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_direction
134 Date:           June 2015
135 KernelVersion:  4.3
136 Contact:        Christian Gromm <christian.gromm@microchip.com>
137 Description:
138                 This is to configure the direction of the current channel.
139                 The following strings will be accepted:
140                         'dir_tx',
141                         'dir_rx'
142 Users:
143
144 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_datatype
145 Date:           June 2015
146 KernelVersion:  4.3
147 Contact:        Christian Gromm <christian.gromm@microchip.com>
148 Description:
149                 This is to configure the data type of the current channel.
150                 The following strings will be accepted:
151                         'control',
152                         'async',
153                         'sync',
154                         'isoc_avp'
155 Users:
156
157 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_subbuffer_size
158 Date:           June 2015
159 KernelVersion:  4.3
160 Contact:        Christian Gromm <christian.gromm@microchip.com>
161 Description:
162                 This is to configure the subbuffer size of the current channel.
163 Users:
164
165 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/set_packets_per_xact
166 Date:           June 2015
167 KernelVersion:  4.3
168 Contact:        Christian Gromm <christian.gromm@microchip.com>
169 Description:
170                 This is to configure the number of packets per transaction of
171                 the current channel. This is only needed network interface
172                 controller is attached via USB.
173 Users:
174
175 What:           /sys/class/most/mostcore/devices/<mdev>/<channel>/channel_starving
176 Date:           June 2015
177 KernelVersion:  4.3
178 Contact:        Christian Gromm <christian.gromm@microchip.com>
179 Description:
180                 Indicates whether current channel ran out of buffers.
181 Users: