1 What: /config/usb-gadget/gadget/functions/uvc.name
4 Description: UVC function directory
6 =================== =============================
7 streaming_maxburst 0..15 (ss only)
8 streaming_maxpacket 1..1023 (fs), 1..3072 (hs/ss)
9 streaming_interval 1..16
10 function_name string [32]
11 =================== =============================
13 What: /config/usb-gadget/gadget/functions/uvc.name/control
16 Description: Control descriptors
18 All attributes read only:
20 ================ =============================
21 bInterfaceNumber USB interface number for this
23 ================ =============================
25 What: /config/usb-gadget/gadget/functions/uvc.name/control/class
28 Description: Class descriptors
30 What: /config/usb-gadget/gadget/functions/uvc.name/control/class/ss
33 Description: Super speed control class descriptors
35 What: /config/usb-gadget/gadget/functions/uvc.name/control/class/fs
38 Description: Full speed control class descriptors
40 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal
43 Description: Terminal descriptors
45 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output
48 Description: Output terminal descriptors
50 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output/default
53 Description: Default output terminal descriptors
55 All attributes read only except bSourceID:
57 ============== =============================================
58 iTerminal index of string descriptor
59 bSourceID id of the terminal to which this terminal
61 bAssocTerminal id of the input terminal to which this output
62 terminal is associated
63 wTerminalType terminal type
64 bTerminalID a non-zero id of this terminal
65 ============== =============================================
67 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
70 Description: Camera terminal descriptors
72 What: /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera/default
75 Description: Default camera terminal descriptors
77 All attributes read only:
79 ======================== ====================================
80 bmControls bitmap specifying which controls are
81 supported for the video stream
82 wOcularFocalLength the value of Locular
83 wObjectiveFocalLengthMax the value of Lmin
84 wObjectiveFocalLengthMin the value of Lmax
85 iTerminal index of string descriptor
86 bAssocTerminal id of the output terminal to which
87 this terminal is connected
88 wTerminalType terminal type
89 bTerminalID a non-zero id of this terminal
90 ======================== ====================================
92 What: /config/usb-gadget/gadget/functions/uvc.name/control/processing
95 Description: Processing unit descriptors
97 What: /config/usb-gadget/gadget/functions/uvc.name/control/processing/default
100 Description: Default processing unit descriptors
102 All attributes read only:
104 =============== ========================================
105 iProcessing index of string descriptor
106 bmControls bitmap specifying which controls are
107 supported for the video stream
108 wMaxMultiplier maximum digital magnification x100
109 bSourceID id of the terminal to which this unit is
111 bUnitID a non-zero id of this unit
112 =============== ========================================
114 What: /config/usb-gadget/gadget/functions/uvc.name/control/header
117 Description: Control header descriptors
119 What: /config/usb-gadget/gadget/functions/uvc.name/control/header/name
122 Description: Specific control header descriptors
126 What: /config/usb-gadget/gadget/functions/uvc.name/streaming
129 Description: Streaming descriptors
131 All attributes read only:
133 ================ =============================
134 bInterfaceNumber USB interface number for this
136 ================ =============================
138 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class
141 Description: Streaming class descriptors
143 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class/ss
146 Description: Super speed streaming class descriptors
148 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class/hs
151 Description: High speed streaming class descriptors
153 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/class/fs
156 Description: Full speed streaming class descriptors
158 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching
161 Description: Color matching descriptors
163 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching/default
166 Description: Default color matching descriptors
168 All attributes read only:
170 ======================== ======================================
171 bMatrixCoefficients matrix used to compute luma and
172 chroma values from the color primaries
173 bTransferCharacteristics optoelectronic transfer
174 characteristic of the source picture,
175 also called the gamma function
176 bColorPrimaries color primaries and the reference
178 ======================== ======================================
180 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
183 Description: MJPEG format descriptors
185 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name
188 Description: Specific MJPEG format descriptors
190 All attributes read only,
191 except bmaControls and bDefaultFrameIndex:
193 =================== =====================================
194 bFormatIndex unique id for this format descriptor;
195 only defined after parent header is
196 linked into the streaming class;
198 bmaControls this format's data for bmaControls in
200 bmInterfaceFlags specifies interlace information,
202 bAspectRatioY the X dimension of the picture aspect
204 bAspectRatioX the Y dimension of the picture aspect
206 bmFlags characteristics of this format,
208 bDefaultFrameIndex optimum frame index for this stream
209 =================== =====================================
211 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
214 Description: Specific MJPEG frame descriptors
216 ========================= =====================================
217 bFrameIndex unique id for this framedescriptor;
218 only defined after parent format is
219 linked into the streaming header;
221 dwFrameInterval indicates how frame interval can be
222 programmed; a number of values
223 separated by newline can be specified
224 dwDefaultFrameInterval the frame interval the device would
225 like to use as default
226 dwMaxVideoFrameBufferSize the maximum number of bytes the
227 compressor will produce for a video
229 dwMaxBitRate the maximum bit rate at the shortest
230 frame interval in bps
231 dwMinBitRate the minimum bit rate at the longest
232 frame interval in bps
233 wHeight height of decoded bitmap frame in px
234 wWidth width of decoded bitmam frame in px
235 bmCapabilities still image support, fixed frame-rate
237 ========================= =====================================
239 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
242 Description: Uncompressed format descriptors
244 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name
247 Description: Specific uncompressed format descriptors
249 ================== =======================================
250 bFormatIndex unique id for this format descriptor;
251 only defined after parent header is
252 linked into the streaming class;
254 bmaControls this format's data for bmaControls in
256 bmInterfaceFlags specifies interlace information,
258 bAspectRatioY the X dimension of the picture aspect
260 bAspectRatioX the Y dimension of the picture aspect
262 bDefaultFrameIndex optimum frame index for this stream
263 bBitsPerPixel number of bits per pixel used to
264 specify color in the decoded video
266 guidFormat globally unique id used to identify
267 stream-encoding format
268 ================== =======================================
270 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
273 Description: Specific uncompressed frame descriptors
275 ========================= =====================================
276 bFrameIndex unique id for this framedescriptor;
277 only defined after parent format is
278 linked into the streaming header;
280 dwFrameInterval indicates how frame interval can be
281 programmed; a number of values
282 separated by newline can be specified
283 dwDefaultFrameInterval the frame interval the device would
284 like to use as default
285 dwMaxVideoFrameBufferSize the maximum number of bytes the
286 compressor will produce for a video
288 dwMaxBitRate the maximum bit rate at the shortest
289 frame interval in bps
290 dwMinBitRate the minimum bit rate at the longest
291 frame interval in bps
292 wHeight height of decoded bitmap frame in px
293 wWidth width of decoded bitmam frame in px
294 bmCapabilities still image support, fixed frame-rate
296 ========================= =====================================
298 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header
301 Description: Streaming header descriptors
303 What: /config/usb-gadget/gadget/functions/uvc.name/streaming/header/name
306 Description: Specific streaming header descriptors
308 All attributes read only:
310 ==================== =====================================
311 bTriggerUsage how the host software will respond to
312 a hardware trigger interrupt event
313 bTriggerSupport flag specifying if hardware
314 triggering is supported
315 bStillCaptureMethod method of still image capture
317 bTerminalLink id of the output terminal to which
318 the video endpoint of this interface
320 bmInfo capabilities of this video streaming
322 ==================== =====================================
324 What: /sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name
327 Description: UVC configfs function instance name