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