Linux-libre 5.4-rc7-gnu
[librecmc/linux-libre.git] / drivers / staging / most / Documentation / ABI / configfs-most.txt
1 What:           /sys/kernel/config/most_<component>
2 Date:           March 8, 2019
3 KernelVersion:  5.2
4 Description:    Interface is used to configure and connect device channels
5                 to component drivers.
6
7                 Attributes are visible only when configfs is mounted. To mount
8                 configfs in /sys/kernel/config directory use:
9                 # mount -t configfs none /sys/kernel/config/
10
11
12 What:           /sys/kernel/config/most_cdev/<link>
13 Date:           March 8, 2019
14 KernelVersion:  5.2
15 Description:
16                 The attributes:
17
18                 buffer_size     configure the buffer size for this channel
19
20                 subbuffer_size  configure the sub-buffer size for this channel
21                                 (needed for synchronous and isochrnous data)
22
23
24                 num_buffers     configure number of buffers used for this
25                                 channel
26
27                 datatype        configure type of data that will travel over
28                                 this channel
29
30                 direction       configure whether this link will be an input
31                                 or output
32
33                 dbr_size        configure DBR data buffer size (this is used
34                                 for MediaLB communication only)
35
36                 packets_per_xact
37                                 configure the number of packets that will be
38                                 collected from the network before being
39                                 transmitted via USB (this is used for USB
40                                 communication only)
41
42                 device          name of the device the link is to be attached to
43
44                 channel         name of the channel the link is to be attached to
45
46                 comp_params     pass parameters needed by some components
47
48                 create_link     write '1' to this attribute to trigger the
49                                 creation of the link. In case of speculative
50                                 configuration, the creation is post-poned until
51                                 a physical device is being attached to the bus.
52
53                 destroy_link    write '1' to this attribute to destroy an
54                                 active link
55
56 What:           /sys/kernel/config/most_video/<link>
57 Date:           March 8, 2019
58 KernelVersion:  5.2
59 Description:
60                 The attributes:
61
62                 buffer_size     configure the buffer size for this channel
63
64                 subbuffer_size  configure the sub-buffer size for this channel
65                                 (needed for synchronous and isochrnous data)
66
67
68                 num_buffers     configure number of buffers used for this
69                                 channel
70
71                 datatype        configure type of data that will travel over
72                                 this channel
73
74                 direction       configure whether this link will be an input
75                                 or output
76
77                 dbr_size        configure DBR data buffer size (this is used
78                                 for MediaLB communication only)
79
80                 packets_per_xact
81                                 configure the number of packets that will be
82                                 collected from the network before being
83                                 transmitted via USB (this is used for USB
84                                 communication only)
85
86                 device          name of the device the link is to be attached to
87
88                 channel         name of the channel the link is to be attached to
89
90                 comp_params     pass parameters needed by some components
91
92                 create_link     write '1' to this attribute to trigger the
93                                 creation of the link. In case of speculative
94                                 configuration, the creation is post-poned until
95                                 a physical device is being attached to the bus.
96
97                 destroy_link    write '1' to this attribute to destroy an
98                                 active link
99
100 What:           /sys/kernel/config/most_net/<link>
101 Date:           March 8, 2019
102 KernelVersion:  5.2
103 Description:
104                 The attributes:
105
106                 buffer_size     configure the buffer size for this channel
107
108                 subbuffer_size  configure the sub-buffer size for this channel
109                                 (needed for synchronous and isochrnous data)
110
111
112                 num_buffers     configure number of buffers used for this
113                                 channel
114
115                 datatype        configure type of data that will travel over
116                                 this channel
117
118                 direction       configure whether this link will be an input
119                                 or output
120
121                 dbr_size        configure DBR data buffer size (this is used
122                                 for MediaLB communication only)
123
124                 packets_per_xact
125                                 configure the number of packets that will be
126                                 collected from the network before being
127                                 transmitted via USB (this is used for USB
128                                 communication only)
129
130                 device          name of the device the link is to be attached to
131
132                 channel         name of the channel the link is to be attached to
133
134                 comp_params     pass parameters needed by some components
135
136                 create_link     write '1' to this attribute to trigger the
137                                 creation of the link. In case of speculative
138                                 configuration, the creation is post-poned until
139                                 a physical device is being attached to the bus.
140
141                 destroy_link    write '1' to this attribute to destroy an
142                                 active link
143
144 What:           /sys/kernel/config/most_sound/<card>
145 Date:           March 8, 2019
146 KernelVersion:  5.2
147 Description:
148                 The attributes:
149
150                 create_card     write '1' to this attribute to trigger the
151                                 registration of the sound card with the ALSA
152                                 subsystem.
153
154 What:           /sys/kernel/config/most_sound/<card>/<link>
155 Date:           March 8, 2019
156 KernelVersion:  5.2
157 Description:
158                 The attributes:
159
160                 buffer_size     configure the buffer size for this channel
161
162                 subbuffer_size  configure the sub-buffer size for this channel
163                                 (needed for synchronous and isochrnous data)
164
165
166                 num_buffers     configure number of buffers used for this
167                                 channel
168
169                 datatype        configure type of data that will travel over
170                                 this channel
171
172                 direction       configure whether this link will be an input
173                                 or output
174
175                 dbr_size        configure DBR data buffer size (this is used
176                                 for MediaLB communication only)
177
178                 packets_per_xact
179                                 configure the number of packets that will be
180                                 collected from the network before being
181                                 transmitted via USB (this is used for USB
182                                 communication only)
183
184                 device          name of the device the link is to be attached to
185
186                 channel         name of the channel the link is to be attached to
187
188                 comp_params     pass parameters needed by some components
189
190                 create_link     write '1' to this attribute to trigger the
191                                 creation of the link. In case of speculative
192                                 configuration, the creation is post-poned until
193                                 a physical device is being attached to the bus.
194
195                 destroy_link    write '1' to this attribute to destroy an
196                                 active link
197
198 What:           /sys/kernel/config/rdma_cm/<hca>/ports/<port-num>/default_roce_tos
199 Date:           March 8, 2019
200 KernelVersion:  5.2
201 Description:    RDMA-CM QPs from HCA <hca> at port <port-num>
202                 will be created with this TOS as default.
203                 This can be overridden by using the rdma_set_option API.
204                 The possible RoCE TOS values are 0-255.