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