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