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