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