xref: /linux/Documentation/ABI/testing/configfs-most (revision 762f99f4f3cb41a775b5157dd761217beba65873)
1deaf3b71SChristian GrommWhat: 		/sys/kernel/config/most_<component>
2deaf3b71SChristian GrommDate: 		March 8, 2019
3deaf3b71SChristian GrommKernelVersion:  5.2
4deaf3b71SChristian GrommDescription: 	Interface is used to configure and connect device channels
5deaf3b71SChristian Gromm		to component drivers.
6deaf3b71SChristian Gromm
7deaf3b71SChristian Gromm		Attributes are visible only when configfs is mounted. To mount
8deaf3b71SChristian Gromm		configfs in /sys/kernel/config directory use:
9deaf3b71SChristian Gromm		# mount -t configfs none /sys/kernel/config/
10deaf3b71SChristian Gromm
11deaf3b71SChristian Gromm
12deaf3b71SChristian GrommWhat: 		/sys/kernel/config/most_cdev/<link>
13deaf3b71SChristian GrommDate: 		March 8, 2019
14deaf3b71SChristian GrommKernelVersion:  5.2
15deaf3b71SChristian GrommDescription:
16deaf3b71SChristian Gromm		The attributes:
17deaf3b71SChristian Gromm
1854a19b4dSMauro Carvalho Chehab		buffer_size
1954a19b4dSMauro Carvalho Chehab				configure the buffer size for this channel
20deaf3b71SChristian Gromm
2154a19b4dSMauro Carvalho Chehab		subbuffer_size
2254a19b4dSMauro Carvalho Chehab				configure the sub-buffer size for this channel
23*3e42d1deSCarlos Bilbao				(needed for synchronous and isochronous data)
24deaf3b71SChristian Gromm
25deaf3b71SChristian Gromm
2654a19b4dSMauro Carvalho Chehab		num_buffers
2754a19b4dSMauro Carvalho Chehab				configure number of buffers used for this
28deaf3b71SChristian Gromm				channel
29deaf3b71SChristian Gromm
3054a19b4dSMauro Carvalho Chehab		datatype
3154a19b4dSMauro Carvalho Chehab				configure type of data that will travel over
32deaf3b71SChristian Gromm				this channel
33deaf3b71SChristian Gromm
3454a19b4dSMauro Carvalho Chehab		direction
3554a19b4dSMauro Carvalho Chehab				configure whether this link will be an input
36deaf3b71SChristian Gromm				or output
37deaf3b71SChristian Gromm
3854a19b4dSMauro Carvalho Chehab		dbr_size
3954a19b4dSMauro Carvalho Chehab				configure DBR data buffer size (this is used
40259c20b3SGeorge G. Davis				for MediaLB communication only)
41deaf3b71SChristian Gromm
42deaf3b71SChristian Gromm		packets_per_xact
43deaf3b71SChristian Gromm				configure the number of packets that will be
44deaf3b71SChristian Gromm				collected from the network before being
45deaf3b71SChristian Gromm				transmitted via USB (this is used for USB
46259c20b3SGeorge G. Davis				communication only)
47deaf3b71SChristian Gromm
4854a19b4dSMauro Carvalho Chehab		device
4954a19b4dSMauro Carvalho Chehab				name of the device the link is to be attached to
50deaf3b71SChristian Gromm
5154a19b4dSMauro Carvalho Chehab		channel
5254a19b4dSMauro Carvalho Chehab				name of the channel the link is to be attached to
53deaf3b71SChristian Gromm
5454a19b4dSMauro Carvalho Chehab		comp_params
5554a19b4dSMauro Carvalho Chehab				pass parameters needed by some components
56deaf3b71SChristian Gromm
5754a19b4dSMauro Carvalho Chehab		create_link
5854a19b4dSMauro Carvalho Chehab				write '1' to this attribute to trigger the
59deaf3b71SChristian Gromm				creation of the link. In case of speculative
60deaf3b71SChristian Gromm				configuration, the creation is post-poned until
61deaf3b71SChristian Gromm				a physical device is being attached to the bus.
62deaf3b71SChristian Gromm
6354a19b4dSMauro Carvalho Chehab		destroy_link
6454a19b4dSMauro Carvalho Chehab				write '1' to this attribute to destroy an
65deaf3b71SChristian Gromm				active link
66deaf3b71SChristian Gromm
67deaf3b71SChristian GrommWhat: 		/sys/kernel/config/most_video/<link>
68deaf3b71SChristian GrommDate: 		March 8, 2019
69deaf3b71SChristian GrommKernelVersion:  5.2
70deaf3b71SChristian GrommDescription:
71deaf3b71SChristian Gromm		The attributes:
72deaf3b71SChristian Gromm
7354a19b4dSMauro Carvalho Chehab		buffer_size
7454a19b4dSMauro Carvalho Chehab				configure the buffer size for this channel
75deaf3b71SChristian Gromm
7654a19b4dSMauro Carvalho Chehab		subbuffer_size
7754a19b4dSMauro Carvalho Chehab				configure the sub-buffer size for this channel
78*3e42d1deSCarlos Bilbao				(needed for synchronous and isochronous data)
79deaf3b71SChristian Gromm
80deaf3b71SChristian Gromm
8154a19b4dSMauro Carvalho Chehab		num_buffers
8254a19b4dSMauro Carvalho Chehab				configure number of buffers used for this
83deaf3b71SChristian Gromm				channel
84deaf3b71SChristian Gromm
8554a19b4dSMauro Carvalho Chehab		datatype
8654a19b4dSMauro Carvalho Chehab				configure type of data that will travel over
87deaf3b71SChristian Gromm				this channel
88deaf3b71SChristian Gromm
8954a19b4dSMauro Carvalho Chehab		direction
9054a19b4dSMauro Carvalho Chehab				configure whether this link will be an input
91deaf3b71SChristian Gromm				or output
92deaf3b71SChristian Gromm
9354a19b4dSMauro Carvalho Chehab		dbr_size
9454a19b4dSMauro Carvalho Chehab				configure DBR data buffer size (this is used
95259c20b3SGeorge G. Davis				for MediaLB communication only)
96deaf3b71SChristian Gromm
97deaf3b71SChristian Gromm		packets_per_xact
98deaf3b71SChristian Gromm				configure the number of packets that will be
99deaf3b71SChristian Gromm				collected from the network before being
100deaf3b71SChristian Gromm				transmitted via USB (this is used for USB
101259c20b3SGeorge G. Davis				communication only)
102deaf3b71SChristian Gromm
10354a19b4dSMauro Carvalho Chehab		device
10454a19b4dSMauro Carvalho Chehab				name of the device the link is to be attached to
105deaf3b71SChristian Gromm
10654a19b4dSMauro Carvalho Chehab		channel
10754a19b4dSMauro Carvalho Chehab				name of the channel the link is to be attached to
108deaf3b71SChristian Gromm
10954a19b4dSMauro Carvalho Chehab		comp_params
11054a19b4dSMauro Carvalho Chehab				pass parameters needed by some components
111deaf3b71SChristian Gromm
11254a19b4dSMauro Carvalho Chehab		create_link
11354a19b4dSMauro Carvalho Chehab				write '1' to this attribute to trigger the
114deaf3b71SChristian Gromm				creation of the link. In case of speculative
115deaf3b71SChristian Gromm				configuration, the creation is post-poned until
116deaf3b71SChristian Gromm				a physical device is being attached to the bus.
117deaf3b71SChristian Gromm
11854a19b4dSMauro Carvalho Chehab		destroy_link
11954a19b4dSMauro Carvalho Chehab				write '1' to this attribute to destroy an
120deaf3b71SChristian Gromm				active link
121deaf3b71SChristian Gromm
122deaf3b71SChristian GrommWhat: 		/sys/kernel/config/most_net/<link>
123deaf3b71SChristian GrommDate: 		March 8, 2019
124deaf3b71SChristian GrommKernelVersion:  5.2
125deaf3b71SChristian GrommDescription:
126deaf3b71SChristian Gromm		The attributes:
127deaf3b71SChristian Gromm
12854a19b4dSMauro Carvalho Chehab		buffer_size
12954a19b4dSMauro Carvalho Chehab				configure the buffer size for this channel
130deaf3b71SChristian Gromm
13154a19b4dSMauro Carvalho Chehab		subbuffer_size
13254a19b4dSMauro Carvalho Chehab				configure the sub-buffer size for this channel
133*3e42d1deSCarlos Bilbao				(needed for synchronous and isochronous data)
134deaf3b71SChristian Gromm
135deaf3b71SChristian Gromm
13654a19b4dSMauro Carvalho Chehab		num_buffers
13754a19b4dSMauro Carvalho Chehab				configure number of buffers used for this
138deaf3b71SChristian Gromm				channel
139deaf3b71SChristian Gromm
14054a19b4dSMauro Carvalho Chehab		datatype
14154a19b4dSMauro Carvalho Chehab				configure type of data that will travel over
142deaf3b71SChristian Gromm				this channel
143deaf3b71SChristian Gromm
14454a19b4dSMauro Carvalho Chehab		direction
14554a19b4dSMauro Carvalho Chehab				configure whether this link will be an input
146deaf3b71SChristian Gromm				or output
147deaf3b71SChristian Gromm
14854a19b4dSMauro Carvalho Chehab		dbr_size
14954a19b4dSMauro Carvalho Chehab				configure DBR data buffer size (this is used
150259c20b3SGeorge G. Davis				for MediaLB communication only)
151deaf3b71SChristian Gromm
152deaf3b71SChristian Gromm		packets_per_xact
153deaf3b71SChristian Gromm				configure the number of packets that will be
154deaf3b71SChristian Gromm				collected from the network before being
155deaf3b71SChristian Gromm				transmitted via USB (this is used for USB
156259c20b3SGeorge G. Davis				communication only)
157deaf3b71SChristian Gromm
15854a19b4dSMauro Carvalho Chehab		device
15954a19b4dSMauro Carvalho Chehab				name of the device the link is to be attached to
160deaf3b71SChristian Gromm
16154a19b4dSMauro Carvalho Chehab		channel
16254a19b4dSMauro Carvalho Chehab				name of the channel the link is to be attached to
163deaf3b71SChristian Gromm
16454a19b4dSMauro Carvalho Chehab		comp_params
16554a19b4dSMauro Carvalho Chehab				pass parameters needed by some components
166deaf3b71SChristian Gromm
16754a19b4dSMauro Carvalho Chehab		create_link
16854a19b4dSMauro Carvalho Chehab				write '1' to this attribute to trigger the
169deaf3b71SChristian Gromm				creation of the link. In case of speculative
170deaf3b71SChristian Gromm				configuration, the creation is post-poned until
171deaf3b71SChristian Gromm				a physical device is being attached to the bus.
172deaf3b71SChristian Gromm
17354a19b4dSMauro Carvalho Chehab		destroy_link
17454a19b4dSMauro Carvalho Chehab				write '1' to this attribute to destroy an
175deaf3b71SChristian Gromm				active link
176deaf3b71SChristian Gromm
177deaf3b71SChristian GrommWhat: 		/sys/kernel/config/most_sound/<card>
178deaf3b71SChristian GrommDate: 		March 8, 2019
179deaf3b71SChristian GrommKernelVersion:  5.2
180deaf3b71SChristian GrommDescription:
181deaf3b71SChristian Gromm		The attributes:
182deaf3b71SChristian Gromm
18354a19b4dSMauro Carvalho Chehab		create_card
18454a19b4dSMauro Carvalho Chehab				write '1' to this attribute to trigger the
185deaf3b71SChristian Gromm                                registration of the sound card with the ALSA
186deaf3b71SChristian Gromm				subsystem.
187deaf3b71SChristian Gromm
188deaf3b71SChristian GrommWhat: 		/sys/kernel/config/most_sound/<card>/<link>
189deaf3b71SChristian GrommDate: 		March 8, 2019
190deaf3b71SChristian GrommKernelVersion:  5.2
191deaf3b71SChristian GrommDescription:
192deaf3b71SChristian Gromm		The attributes:
193deaf3b71SChristian Gromm
19454a19b4dSMauro Carvalho Chehab		buffer_size
19554a19b4dSMauro Carvalho Chehab				configure the buffer size for this channel
196deaf3b71SChristian Gromm
19754a19b4dSMauro Carvalho Chehab		subbuffer_size
19854a19b4dSMauro Carvalho Chehab				configure the sub-buffer size for this channel
199*3e42d1deSCarlos Bilbao				(needed for synchronous and isochronous data)
200deaf3b71SChristian Gromm
201deaf3b71SChristian Gromm
20254a19b4dSMauro Carvalho Chehab		num_buffers
20354a19b4dSMauro Carvalho Chehab				configure number of buffers used for this
204deaf3b71SChristian Gromm				channel
205deaf3b71SChristian Gromm
20654a19b4dSMauro Carvalho Chehab		datatype
20754a19b4dSMauro Carvalho Chehab				configure type of data that will travel over
208deaf3b71SChristian Gromm				this channel
209deaf3b71SChristian Gromm
21054a19b4dSMauro Carvalho Chehab		direction
21154a19b4dSMauro Carvalho Chehab				configure whether this link will be an input
212deaf3b71SChristian Gromm				or output
213deaf3b71SChristian Gromm
21454a19b4dSMauro Carvalho Chehab		dbr_size
21554a19b4dSMauro Carvalho Chehab				configure DBR data buffer size (this is used
216259c20b3SGeorge G. Davis				for MediaLB communication only)
217deaf3b71SChristian Gromm
218deaf3b71SChristian Gromm		packets_per_xact
219deaf3b71SChristian Gromm				configure the number of packets that will be
220deaf3b71SChristian Gromm				collected from the network before being
221deaf3b71SChristian Gromm				transmitted via USB (this is used for USB
222259c20b3SGeorge G. Davis				communication only)
223deaf3b71SChristian Gromm
22454a19b4dSMauro Carvalho Chehab		device
22554a19b4dSMauro Carvalho Chehab				name of the device the link is to be attached to
226deaf3b71SChristian Gromm
22754a19b4dSMauro Carvalho Chehab		channel
22854a19b4dSMauro Carvalho Chehab				name of the channel the link is to be attached to
229deaf3b71SChristian Gromm
23054a19b4dSMauro Carvalho Chehab		comp_params
23154a19b4dSMauro Carvalho Chehab				pass parameters needed by some components
232deaf3b71SChristian Gromm
23354a19b4dSMauro Carvalho Chehab		create_link
23454a19b4dSMauro Carvalho Chehab				write '1' to this attribute to trigger the
235deaf3b71SChristian Gromm				creation of the link. In case of speculative
236deaf3b71SChristian Gromm				configuration, the creation is post-poned until
237deaf3b71SChristian Gromm				a physical device is being attached to the bus.
238deaf3b71SChristian Gromm
23954a19b4dSMauro Carvalho Chehab		destroy_link
24054a19b4dSMauro Carvalho Chehab				write '1' to this attribute to destroy an
241deaf3b71SChristian Gromm				active link
242