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		function_name		string [32]
11		===================	=============================
12
13What:		/config/usb-gadget/gadget/functions/uvc.name/control
14Date:		Dec 2014
15KernelVersion:	4.0
16Description:	Control descriptors
17
18		All attributes read only:
19
20		================	=============================
21		bInterfaceNumber	USB interface number for this
22					streaming interface
23		================	=============================
24
25What:		/config/usb-gadget/gadget/functions/uvc.name/control/class
26Date:		Dec 2014
27KernelVersion:	4.0
28Description:	Class descriptors
29
30What:		/config/usb-gadget/gadget/functions/uvc.name/control/class/ss
31Date:		Dec 2014
32KernelVersion:	4.0
33Description:	Super speed control class descriptors
34
35What:		/config/usb-gadget/gadget/functions/uvc.name/control/class/fs
36Date:		Dec 2014
37KernelVersion:	4.0
38Description:	Full speed control class descriptors
39
40What:		/config/usb-gadget/gadget/functions/uvc.name/control/terminal
41Date:		Dec 2014
42KernelVersion:	4.0
43Description:	Terminal descriptors
44
45What:		/config/usb-gadget/gadget/functions/uvc.name/control/terminal/output
46Date:		Dec 2014
47KernelVersion:	4.0
48Description:	Output terminal descriptors
49
50What:		/config/usb-gadget/gadget/functions/uvc.name/control/terminal/output/default
51Date:		Dec 2014
52KernelVersion:	4.0
53Description:	Default output terminal descriptors
54
55		All attributes read only:
56
57		==============	=============================================
58		iTerminal	index of string descriptor
59		bSourceID	id of the terminal to which this terminal
60				is connected
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		==============	=============================================
66
67What:		/config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
68Date:		Dec 2014
69KernelVersion:	4.0
70Description:	Camera terminal descriptors
71
72What:		/config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera/default
73Date:		Dec 2014
74KernelVersion:	4.0
75Description:	Default camera terminal descriptors
76
77		All attributes read only:
78
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		========================  ====================================
91
92What:		/config/usb-gadget/gadget/functions/uvc.name/control/processing
93Date:		Dec 2014
94KernelVersion:	4.0
95Description:	Processing unit descriptors
96
97What:		/config/usb-gadget/gadget/functions/uvc.name/control/processing/default
98Date:		Dec 2014
99KernelVersion:	4.0
100Description:	Default processing unit descriptors
101
102		All attributes read only:
103
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
110				connected
111		bUnitID		a non-zero id of this unit
112		===============	========================================
113
114What:		/config/usb-gadget/gadget/functions/uvc.name/control/header
115Date:		Dec 2014
116KernelVersion:	4.0
117Description:	Control header descriptors
118
119What:		/config/usb-gadget/gadget/functions/uvc.name/control/header/name
120Date:		Dec 2014
121KernelVersion:	4.0
122Description:	Specific control header descriptors
123
124dwClockFrequency
125bcdUVC
126What:		/config/usb-gadget/gadget/functions/uvc.name/streaming
127Date:		Dec 2014
128KernelVersion:	4.0
129Description:	Streaming descriptors
130
131		All attributes read only:
132
133		================	=============================
134		bInterfaceNumber	USB interface number for this
135					streaming interface
136		================	=============================
137
138What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/class
139Date:		Dec 2014
140KernelVersion:	4.0
141Description:	Streaming class descriptors
142
143What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/class/ss
144Date:		Dec 2014
145KernelVersion:	4.0
146Description:	Super speed streaming class descriptors
147
148What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/class/hs
149Date:		Dec 2014
150KernelVersion:	4.0
151Description:	High speed streaming class descriptors
152
153What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/class/fs
154Date:		Dec 2014
155KernelVersion:	4.0
156Description:	Full speed streaming class descriptors
157
158What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching
159Date:		Dec 2014
160KernelVersion:	4.0
161Description:	Color matching descriptors
162
163What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching/default
164Date:		Dec 2014
165KernelVersion:	4.0
166Description:	Default color matching descriptors
167
168		All attributes read only:
169
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
177					  white
178		========================  ======================================
179
180What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
181Date:		Dec 2014
182KernelVersion:	4.0
183Description:	MJPEG format descriptors
184
185What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name
186Date:		Dec 2014
187KernelVersion:	4.0
188Description:	Specific MJPEG format descriptors
189
190		All attributes read only,
191		except bmaControls and bDefaultFrameIndex:
192
193		===================	=====================================
194		bFormatIndex		unique id for this format descriptor;
195					only defined after parent header is
196					linked into the streaming class;
197					read-only
198		bmaControls		this format's data for bmaControls in
199					the streaming header
200		bmInterfaceFlags	specifies interlace information,
201					read-only
202		bAspectRatioY		the X dimension of the picture aspect
203					ratio, read-only
204		bAspectRatioX		the Y dimension of the picture aspect
205					ratio, read-only
206		bmFlags			characteristics of this format,
207					read-only
208		bDefaultFrameIndex	optimum frame index for this stream
209		===================	=====================================
210
211What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
212Date:		Dec 2014
213KernelVersion:	4.0
214Description:	Specific MJPEG frame descriptors
215
216		=========================  =====================================
217		bFrameIndex		   unique id for this framedescriptor;
218					   only defined after parent format is
219					   linked into the streaming header;
220					   read-only
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
228					   frame or still image
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
236					   support
237		=========================  =====================================
238
239What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
240Date:		Dec 2014
241KernelVersion:	4.0
242Description:	Uncompressed format descriptors
243
244What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name
245Date:		Dec 2014
246KernelVersion:	4.0
247Description:	Specific uncompressed format descriptors
248
249		==================	=======================================
250		bFormatIndex		unique id for this format descriptor;
251					only defined after parent header is
252					linked into the streaming class;
253					read-only
254		bmaControls		this format's data for bmaControls in
255					the streaming header
256		bmInterfaceFlags	specifies interlace information,
257					read-only
258		bAspectRatioY		the X dimension of the picture aspect
259					ratio, read-only
260		bAspectRatioX		the Y dimension of the picture aspect
261					ratio, read-only
262		bDefaultFrameIndex	optimum frame index for this stream
263		bBitsPerPixel		number of bits per pixel used to
264					specify color in the decoded video
265					frame
266		guidFormat		globally unique id used to identify
267					stream-encoding format
268		==================	=======================================
269
270What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
271Date:		Dec 2014
272KernelVersion:	4.0
273Description:	Specific uncompressed frame descriptors
274
275		=========================  =====================================
276		bFrameIndex		   unique id for this framedescriptor;
277					   only defined after parent format is
278					   linked into the streaming header;
279					   read-only
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
287					   frame or still image
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
295					   support
296		=========================  =====================================
297
298What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/header
299Date:		Dec 2014
300KernelVersion:	4.0
301Description:	Streaming header descriptors
302
303What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/header/name
304Date:		Dec 2014
305KernelVersion:	4.0
306Description:	Specific streaming header descriptors
307
308		All attributes read only:
309
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
316					supported
317		bTerminalLink		id of the output terminal to which
318					the video endpoint of this interface
319					is connected
320		bmInfo			capabilities of this video streaming
321					interface
322		====================	=====================================
323
324What:		/sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name
325Date:		May 2018
326KernelVersion:	4.19
327Description:	UVC configfs function instance name
328