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