1 What: /config/usb-gadget/gadget/func 1 What: /config/usb-gadget/gadget/functions/uvc.name
2 Date: Dec 2014 2 Date: Dec 2014
3 KernelVersion: 4.0 3 KernelVersion: 4.0
4 Description: UVC function directory 4 Description: UVC function directory
5 5
6 =================== ====== !! 6 streaming_maxburst - 0..15 (ss only)
7 streaming_maxburst 0..15 !! 7 streaming_maxpacket - 1..1023 (fs), 1..3072 (hs/ss)
8 streaming_maxpacket 1..102 !! 8 streaming_interval - 1..16
9 streaming_interval 1..16 <<
10 function_name string <<
11 =================== ====== <<
12 9
13 What: /config/usb-gadget/gadget/func 10 What: /config/usb-gadget/gadget/functions/uvc.name/control
14 Date: Dec 2014 11 Date: Dec 2014
15 KernelVersion: 4.0 12 KernelVersion: 4.0
16 Description: Control descriptors 13 Description: Control descriptors
17 14
18 All attributes read only excep <<
19 <<
20 =================== ====== <<
21 bInterfaceNumber USB in <<
22 stream <<
23 enable_interrupt_ep flag t <<
24 endpoi <<
25 =================== ====== <<
26 <<
27 What: /config/usb-gadget/gadget/func 15 What: /config/usb-gadget/gadget/functions/uvc.name/control/class
28 Date: Dec 2014 16 Date: Dec 2014
29 KernelVersion: 4.0 17 KernelVersion: 4.0
30 Description: Class descriptors 18 Description: Class descriptors
31 19
32 What: /config/usb-gadget/gadget/func 20 What: /config/usb-gadget/gadget/functions/uvc.name/control/class/ss
33 Date: Dec 2014 21 Date: Dec 2014
34 KernelVersion: 4.0 22 KernelVersion: 4.0
35 Description: Super speed control class desc 23 Description: Super speed control class descriptors
36 24
37 What: /config/usb-gadget/gadget/func 25 What: /config/usb-gadget/gadget/functions/uvc.name/control/class/fs
38 Date: Dec 2014 26 Date: Dec 2014
39 KernelVersion: 4.0 27 KernelVersion: 4.0
40 Description: Full speed control class descr 28 Description: Full speed control class descriptors
41 29
42 What: /config/usb-gadget/gadget/func 30 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal
43 Date: Dec 2014 31 Date: Dec 2014
44 KernelVersion: 4.0 32 KernelVersion: 4.0
45 Description: Terminal descriptors 33 Description: Terminal descriptors
46 34
47 What: /config/usb-gadget/gadget/func 35 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output
48 Date: Dec 2014 36 Date: Dec 2014
49 KernelVersion: 4.0 37 KernelVersion: 4.0
50 Description: Output terminal descriptors 38 Description: Output terminal descriptors
51 39
52 What: /config/usb-gadget/gadget/func 40 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output/default
53 Date: Dec 2014 41 Date: Dec 2014
54 KernelVersion: 4.0 42 KernelVersion: 4.0
55 Description: Default output terminal descri 43 Description: Default output terminal descriptors
56 44
57 All attributes read only excep !! 45 All attributes read only:
58 !! 46 iTerminal - index of string descriptor
59 ============== ============== !! 47 bSourceID - id of the terminal to which this terminal
60 iTerminal index of strin <<
61 bSourceID id of the term <<
62 is connected 48 is connected
63 bAssocTerminal id of the inpu !! 49 bAssocTerminal - id of the input terminal to which this output
64 terminal is as 50 terminal is associated
65 wTerminalType terminal type !! 51 wTerminalType - terminal type
66 bTerminalID a non-zero id !! 52 bTerminalID - a non-zero id of this terminal
67 ============== ============== <<
68 53
69 What: /config/usb-gadget/gadget/func 54 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
70 Date: Dec 2014 55 Date: Dec 2014
71 KernelVersion: 4.0 56 KernelVersion: 4.0
72 Description: Camera terminal descriptors 57 Description: Camera terminal descriptors
73 58
74 What: /config/usb-gadget/gadget/func 59 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera/default
75 Date: Dec 2014 60 Date: Dec 2014
76 KernelVersion: 4.0 61 KernelVersion: 4.0
77 Description: Default camera terminal descri 62 Description: Default camera terminal descriptors
78 63
79 All attributes read only excep !! 64 All attributes read only:
80 !! 65 bmControls - bitmap specifying which controls are
81 ======================== ==== !! 66 supported for the video stream
82 bmControls bitm !! 67 wOcularFocalLength - the value of Locular
83 supp !! 68 wObjectiveFocalLengthMax- the value of Lmin
84 wOcularFocalLength the !! 69 wObjectiveFocalLengthMin- the value of Lmax
85 wObjectiveFocalLengthMax the !! 70 iTerminal - index of string descriptor
86 wObjectiveFocalLengthMin the !! 71 bAssocTerminal - id of the output terminal to which
87 iTerminal inde !! 72 this terminal is connected
88 bAssocTerminal id o !! 73 wTerminalType - terminal type
89 this !! 74 bTerminalID - a non-zero id of this terminal
90 wTerminalType term <<
91 bTerminalID a no <<
92 ======================== ==== <<
93 75
94 What: /config/usb-gadget/gadget/func 76 What: /config/usb-gadget/gadget/functions/uvc.name/control/processing
95 Date: Dec 2014 77 Date: Dec 2014
96 KernelVersion: 4.0 78 KernelVersion: 4.0
97 Description: Processing unit descriptors 79 Description: Processing unit descriptors
98 80
99 What: /config/usb-gadget/gadget/func 81 What: /config/usb-gadget/gadget/functions/uvc.name/control/processing/default
100 Date: Dec 2014 82 Date: Dec 2014
101 KernelVersion: 4.0 83 KernelVersion: 4.0
102 Description: Default processing unit descri 84 Description: Default processing unit descriptors
103 85
104 All attributes read only excep !! 86 All attributes read only:
105 !! 87 iProcessing - index of string descriptor
106 =============== ============== !! 88 bmControls - bitmap specifying which controls are
107 iProcessing index of strin <<
108 bmControls bitmap specify <<
109 supported for 89 supported for the video stream
110 wMaxMultiplier maximum digita !! 90 wMaxMultiplier - maximum digital magnification x100
111 bSourceID id of the term !! 91 bSourceID - id of the terminal to which this unit is
112 connected 92 connected
113 bUnitID a non-zero id !! 93 bUnitID - a non-zero id of this unit
114 =============== ============== <<
115 <<
116 What: /config/usb-gadget/gadget/func <<
117 Date: Nov 2022 <<
118 KernelVersion: 6.1 <<
119 Description: Extension unit descriptors <<
120 <<
121 What: /config/usb-gadget/gadget/func <<
122 Date: Nov 2022 <<
123 KernelVersion: 6.1 <<
124 Description: Extension Unit (XU) Descriptor <<
125 <<
126 bLength, bUnitID and iExtensio <<
127 read-write. <<
128 <<
129 ================= ====== <<
130 bLength size o <<
131 bUnitID non-ze <<
132 guidExtensionCode Vendor <<
133 bNumControls number <<
134 bNrInPins number <<
135 baSourceID list o <<
136 to whi <<
137 bControlSize size o <<
138 bmControls list o <<
139 specif <<
140 iExtension index <<
141 this e <<
142 ================= ====== <<
143 94
144 What: /config/usb-gadget/gadget/func 95 What: /config/usb-gadget/gadget/functions/uvc.name/control/header
145 Date: Dec 2014 96 Date: Dec 2014
146 KernelVersion: 4.0 97 KernelVersion: 4.0
147 Description: Control header descriptors 98 Description: Control header descriptors
148 99
149 What: /config/usb-gadget/gadget/func 100 What: /config/usb-gadget/gadget/functions/uvc.name/control/header/name
150 Date: Dec 2014 101 Date: Dec 2014
151 KernelVersion: 4.0 102 KernelVersion: 4.0
152 Description: Specific control header descri 103 Description: Specific control header descriptors
153 104
154 dwClockFrequency 105 dwClockFrequency
155 bcdUVC 106 bcdUVC
156 What: /config/usb-gadget/gadget/func 107 What: /config/usb-gadget/gadget/functions/uvc.name/streaming
157 Date: Dec 2014 108 Date: Dec 2014
158 KernelVersion: 4.0 109 KernelVersion: 4.0
159 Description: Streaming descriptors 110 Description: Streaming descriptors
160 111
161 All attributes read only: <<
162 <<
163 ================ ====== <<
164 bInterfaceNumber USB in <<
165 stream <<
166 ================ ====== <<
167 <<
168 What: /config/usb-gadget/gadget/func 112 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class
169 Date: Dec 2014 113 Date: Dec 2014
170 KernelVersion: 4.0 114 KernelVersion: 4.0
171 Description: Streaming class descriptors 115 Description: Streaming class descriptors
172 116
173 What: /config/usb-gadget/gadget/func 117 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class/ss
174 Date: Dec 2014 118 Date: Dec 2014
175 KernelVersion: 4.0 119 KernelVersion: 4.0
176 Description: Super speed streaming class de 120 Description: Super speed streaming class descriptors
177 121
178 What: /config/usb-gadget/gadget/func 122 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class/hs
179 Date: Dec 2014 123 Date: Dec 2014
180 KernelVersion: 4.0 124 KernelVersion: 4.0
181 Description: High speed streaming class des 125 Description: High speed streaming class descriptors
182 126
183 What: /config/usb-gadget/gadget/func 127 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class/fs
184 Date: Dec 2014 128 Date: Dec 2014
185 KernelVersion: 4.0 129 KernelVersion: 4.0
186 Description: Full speed streaming class des 130 Description: Full speed streaming class descriptors
187 131
188 What: /config/usb-gadget/gadget/func 132 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching
189 Date: Dec 2014 133 Date: Dec 2014
190 KernelVersion: 4.0 134 KernelVersion: 4.0
191 Description: Color matching descriptors 135 Description: Color matching descriptors
192 136
193 What: /config/usb-gadget/gadget/func 137 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching/default
194 Date: Dec 2014 138 Date: Dec 2014
195 KernelVersion: 4.0 139 KernelVersion: 4.0
196 Description: Default color matching descrip 140 Description: Default color matching descriptors
197 141
198 All attributes read/write: !! 142 All attributes read only:
199 !! 143 bMatrixCoefficients - matrix used to compute luma and
200 ======================== ==== !! 144 chroma values from the color primaries
201 bMatrixCoefficients matr !! 145 bTransferCharacteristics- optoelectronic transfer
202 chro !! 146 characteristic of the source picutre,
203 bTransferCharacteristics opto !! 147 also called the gamma function
204 char !! 148 bColorPrimaries - color primaries and the reference
205 also !! 149 white
206 bColorPrimaries colo <<
207 whit <<
208 ======================== ==== <<
209 <<
210 What: /config/usb-gadget/gadget/func <<
211 Date: Dec 2022 <<
212 KernelVersion: 6.3 <<
213 Description: Additional color matching desc <<
214 <<
215 All attributes read/write: <<
216 <<
217 ======================== ==== <<
218 bMatrixCoefficients matr <<
219 chro <<
220 bTransferCharacteristics opto <<
221 char <<
222 also <<
223 bColorPrimaries colo <<
224 whit <<
225 ======================== ==== <<
226 150
227 What: /config/usb-gadget/gadget/func 151 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
228 Date: Dec 2014 152 Date: Dec 2014
229 KernelVersion: 4.0 153 KernelVersion: 4.0
230 Description: MJPEG format descriptors 154 Description: MJPEG format descriptors
231 155
232 What: /config/usb-gadget/gadget/func 156 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name
233 Date: Dec 2014 157 Date: Dec 2014
234 KernelVersion: 4.0 158 KernelVersion: 4.0
235 Description: Specific MJPEG format descript 159 Description: Specific MJPEG format descriptors
236 160
237 All attributes read only, 161 All attributes read only,
238 except bmaControls and bDefaul 162 except bmaControls and bDefaultFrameIndex:
239 !! 163 bmaControls - this format's data for bmaControls in
240 =================== ====== <<
241 bFormatIndex unique <<
242 only d <<
243 linked <<
244 read-o <<
245 bmaControls this f <<
246 the st 164 the streaming header
247 bmInterlaceFlags specif !! 165 bmInterfaceFlags - specifies interlace information,
248 read-o 166 read-only
249 bAspectRatioY the X !! 167 bAspectRatioY - the X dimension of the picture aspect
250 ratio, 168 ratio, read-only
251 bAspectRatioX the Y !! 169 bAspectRatioX - the Y dimension of the picture aspect
252 ratio, 170 ratio, read-only
253 bmFlags charac !! 171 bmFlags - characteristics of this format,
254 read-o 172 read-only
255 bDefaultFrameIndex optimu !! 173 bDefaultFrameIndex - optimum frame index for this stream
256 =================== ====== <<
257 174
258 What: /config/usb-gadget/gadget/func 175 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
259 Date: Dec 2014 176 Date: Dec 2014
260 KernelVersion: 4.0 177 KernelVersion: 4.0
261 Description: Specific MJPEG frame descripto 178 Description: Specific MJPEG frame descriptors
262 179
263 ========================= === !! 180 dwFrameInterval - indicates how frame interval can be
264 bFrameIndex uni !! 181 programmed; a number of values
265 onl !! 182 separated by newline can be specified
266 lin !! 183 dwDefaultFrameInterval - the frame interval the device would
267 rea !! 184 like to use as default
268 dwFrameInterval ind !! 185 dwMaxVideoFrameBufferSize- the maximum number of bytes the
269 pro !! 186 compressor will produce for a video
270 sep !! 187 frame or still image
271 dwDefaultFrameInterval the !! 188 dwMaxBitRate - the maximum bit rate at the shortest
272 lik !! 189 frame interval in bps
273 dwMaxVideoFrameBufferSize the !! 190 dwMinBitRate - the minimum bit rate at the longest
274 com !! 191 frame interval in bps
275 fra !! 192 wHeight - height of decoded bitmap frame in px
276 dwMaxBitRate the !! 193 wWidth - width of decoded bitmam frame in px
277 fra !! 194 bmCapabilities - still image support, fixed frame-rate
278 dwMinBitRate the !! 195 support
279 fra <<
280 wHeight hei <<
281 wWidth wid <<
282 bmCapabilities sti <<
283 sup <<
284 ========================= === <<
285 196
286 What: /config/usb-gadget/gadget/func 197 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
287 Date: Dec 2014 198 Date: Dec 2014
288 KernelVersion: 4.0 199 KernelVersion: 4.0
289 Description: Uncompressed format descriptor 200 Description: Uncompressed format descriptors
290 201
291 What: /config/usb-gadget/gadget/func 202 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name
292 Date: Dec 2014 203 Date: Dec 2014
293 KernelVersion: 4.0 204 KernelVersion: 4.0
294 Description: Specific uncompressed format d 205 Description: Specific uncompressed format descriptors
295 206
296 ================== ====== !! 207 bmaControls - this format's data for bmaControls in
297 bFormatIndex unique <<
298 only d <<
299 linked <<
300 read-o <<
301 bmaControls this f <<
302 the st 208 the streaming header
303 bmInterlaceFlags specif !! 209 bmInterfaceFlags - specifies interlace information,
304 read-o 210 read-only
305 bAspectRatioY the X !! 211 bAspectRatioY - the X dimension of the picture aspect
306 ratio, 212 ratio, read-only
307 bAspectRatioX the Y !! 213 bAspectRatioX - the Y dimension of the picture aspect
308 ratio, 214 ratio, read-only
309 bDefaultFrameIndex optimu !! 215 bDefaultFrameIndex - optimum frame index for this stream
310 bBitsPerPixel number !! 216 bBitsPerPixel - number of bits per pixel used to
311 specif 217 specify color in the decoded video
312 frame 218 frame
313 guidFormat global !! 219 guidFormat - globally unique id used to identify
314 stream 220 stream-encoding format
315 ================== ====== <<
316 221
317 What: /config/usb-gadget/gadget/func 222 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
318 Date: Dec 2014 223 Date: Dec 2014
319 KernelVersion: 4.0 224 KernelVersion: 4.0
320 Description: Specific uncompressed frame de 225 Description: Specific uncompressed frame descriptors
321 226
322 ========================= === !! 227 dwFrameInterval - indicates how frame interval can be
323 bFrameIndex uni !! 228 programmed; a number of values
324 onl !! 229 separated by newline can be specified
325 lin !! 230 dwDefaultFrameInterval - the frame interval the device would
326 rea !! 231 like to use as default
327 dwFrameInterval ind !! 232 dwMaxVideoFrameBufferSize- the maximum number of bytes the
328 pro !! 233 compressor will produce for a video
329 sep !! 234 frame or still image
330 dwDefaultFrameInterval the !! 235 dwMaxBitRate - the maximum bit rate at the shortest
331 lik !! 236 frame interval in bps
332 dwMaxVideoFrameBufferSize the !! 237 dwMinBitRate - the minimum bit rate at the longest
333 com !! 238 frame interval in bps
334 fra !! 239 wHeight - height of decoded bitmap frame in px
335 dwMaxBitRate the !! 240 wWidth - width of decoded bitmam frame in px
336 fra !! 241 bmCapabilities - still image support, fixed frame-rate
337 dwMinBitRate the !! 242 support
338 fra <<
339 wHeight hei <<
340 wWidth wid <<
341 bmCapabilities sti <<
342 sup <<
343 ========================= === <<
344 243
345 What: /config/usb-gadget/gadget/func 244 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header
346 Date: Dec 2014 245 Date: Dec 2014
347 KernelVersion: 4.0 246 KernelVersion: 4.0
348 Description: Streaming header descriptors 247 Description: Streaming header descriptors
349 248
350 What: /config/usb-gadget/gadget/func 249 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header/name
351 Date: Dec 2014 250 Date: Dec 2014
352 KernelVersion: 4.0 251 KernelVersion: 4.0
353 Description: Specific streaming header desc 252 Description: Specific streaming header descriptors
354 253
355 All attributes read only: 254 All attributes read only:
356 !! 255 bTriggerUsage - how the host software will respond to
357 ==================== ====== <<
358 bTriggerUsage how th <<
359 a hard 256 a hardware trigger interrupt event
360 bTriggerSupport flag s !! 257 bTriggerSupport - flag specifying if hardware
361 trigge 258 triggering is supported
362 bStillCaptureMethod method !! 259 bStillCaptureMethod - method of still image caputre
363 suppor 260 supported
364 bTerminalLink id of !! 261 bTerminalLink - id of the output terminal to which
365 the vi 262 the video endpoint of this interface
366 is con 263 is connected
367 bmInfo capabi !! 264 bmInfo - capabilities of this video streaming
368 interf 265 interface
369 ==================== ====== <<
370 <<
371 What: /sys/class/udc/udc.name/device <<
372 Date: May 2018 <<
373 KernelVersion: 4.19 <<
374 Description: UVC configfs function instance <<
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.