forked from ~ljy/RK356X_SDK_RELEASE
blame | history | patch | commit | commitdiff
hc
2024-10-22 8ac6c7a54ed1b98d142dce24b11c6de6a1e239a5 
 kernel/Documentation/ABI/testing/configfs-usb-gadget-uvc
....@@ -3,9 +3,12 @@
33 KernelVersion:	4.0
44 Description:	UVC function directory
55 
6
-		streaming_maxburst	- 0..15 (ss only)
7
-		streaming_maxpacket	- 1..1023 (fs), 1..3072 (hs/ss)
8
-		streaming_interval	- 1..16
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
+		===================	=============================
912 
1013 What:		/config/usb-gadget/gadget/functions/uvc.name/control
1114 Date:		Dec 2014
....@@ -13,8 +16,11 @@
1316 Description:	Control descriptors
1417 
1518 		All attributes read only:
16
-		bInterfaceNumber	- USB interface number for this
17
-					  streaming interface
19
+
20
+		================	=============================
21
+		bInterfaceNumber	USB interface number for this
22
+					streaming interface
23
+		================	=============================
1824 
1925 What:		/config/usb-gadget/gadget/functions/uvc.name/control/class
2026 Date:		Dec 2014
....@@ -46,14 +52,17 @@
4652 KernelVersion:	4.0
4753 Description:	Default output terminal descriptors
4854 
49
-		All attributes read only:
50
-		iTerminal	- index of string descriptor
51
-		bSourceID 	- id of the terminal to which this terminal
55
+		All attributes read only except bSourceID:
56
+
57
+		==============	=============================================
58
+		iTerminal	index of string descriptor
59
+		bSourceID	id of the terminal to which this terminal
5260 				is connected
53
-		bAssocTerminal	- id of the input terminal to which this output
61
+		bAssocTerminal	id of the input terminal to which this output
5462 				terminal is associated
55
-		wTerminalType	- terminal type
56
-		bTerminalID	- a non-zero id of this terminal
63
+		wTerminalType	terminal type
64
+		bTerminalID	a non-zero id of this terminal
65
+		==============	=============================================
5766 
5867 What:		/config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
5968 Date:		Dec 2014
....@@ -66,16 +75,19 @@
6675 Description:	Default camera terminal descriptors
6776 
6877 		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
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
+		========================  ====================================
7991 
8092 What:		/config/usb-gadget/gadget/functions/uvc.name/control/processing
8193 Date:		Dec 2014
....@@ -88,13 +100,16 @@
88100 Description:	Default processing unit descriptors
89101 
90102 		All attributes read only:
91
-		iProcessing	- index of string descriptor
92
-		bmControls	- bitmap specifying which controls are
103
+
104
+		===============	========================================
105
+		iProcessing	index of string descriptor
106
+		bmControls	bitmap specifying which controls are
93107 				supported for the video stream
94
-		wMaxMultiplier	- maximum digital magnification x100
95
-		bSourceID	- id of the terminal to which this unit is
108
+		wMaxMultiplier	maximum digital magnification x100
109
+		bSourceID	id of the terminal to which this unit is
96110 				connected
97
-		bUnitID		- a non-zero id of this unit
111
+		bUnitID		a non-zero id of this unit
112
+		===============	========================================
98113 
99114 What:		/config/usb-gadget/gadget/functions/uvc.name/control/header
100115 Date:		Dec 2014
....@@ -114,8 +129,11 @@
114129 Description:	Streaming descriptors
115130 
116131 		All attributes read only:
117
-		bInterfaceNumber	- USB interface number for this
118
-					  streaming interface
132
+
133
+		================	=============================
134
+		bInterfaceNumber	USB interface number for this
135
+					streaming interface
136
+		================	=============================
119137 
120138 What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/class
121139 Date:		Dec 2014
....@@ -148,13 +166,16 @@
148166 Description:	Default color matching descriptors
149167 
150168 		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
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 picutre,
175
+					  also called the gamma function
176
+		bColorPrimaries		  color primaries and the reference
177
+					  white
178
+		========================  ======================================
158179 
159180 What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
160181 Date:		Dec 2014
....@@ -168,47 +189,52 @@
168189 
169190 		All attributes read only,
170191 		except bmaControls and bDefaultFrameIndex:
171
-		bFormatIndex		- unique id for this format descriptor;
192
+
193
+		===================	=====================================
194
+		bFormatIndex		unique id for this format descriptor;
172195 					only defined after parent header is
173196 					linked into the streaming class;
174197 					read-only
175
-		bmaControls		- this format's data for bmaControls in
198
+		bmaControls		this format's data for bmaControls in
176199 					the streaming header
177
-		bmInterfaceFlags	- specifies interlace information,
200
+		bmInterfaceFlags	specifies interlace information,
178201 					read-only
179
-		bAspectRatioY		- the X dimension of the picture aspect
202
+		bAspectRatioY		the X dimension of the picture aspect
180203 					ratio, read-only
181
-		bAspectRatioX		- the Y dimension of the picture aspect
204
+		bAspectRatioX		the Y dimension of the picture aspect
182205 					ratio, read-only
183
-		bmFlags			- characteristics of this format,
206
+		bmFlags			characteristics of this format,
184207 					read-only
185
-		bDefaultFrameIndex	- optimum frame index for this stream
208
+		bDefaultFrameIndex	optimum frame index for this stream
209
+		===================	=====================================
186210 
187211 What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
188212 Date:		Dec 2014
189213 KernelVersion:	4.0
190214 Description:	Specific MJPEG frame descriptors
191215 
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
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
+		=========================  =====================================
212238 
213239 What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
214240 Date:		Dec 2014
....@@ -220,50 +246,54 @@
220246 KernelVersion:	4.0
221247 Description:	Specific uncompressed format descriptors
222248 
223
-		bFormatIndex		- unique id for this format descriptor;
249
+		==================	=======================================
250
+		bFormatIndex		unique id for this format descriptor;
224251 					only defined after parent header is
225252 					linked into the streaming class;
226253 					read-only
227
-		bmaControls		- this format's data for bmaControls in
254
+		bmaControls		this format's data for bmaControls in
228255 					the streaming header
229
-		bmInterfaceFlags	- specifies interlace information,
256
+		bmInterfaceFlags	specifies interlace information,
230257 					read-only
231
-		bAspectRatioY		- the X dimension of the picture aspect
258
+		bAspectRatioY		the X dimension of the picture aspect
232259 					ratio, read-only
233
-		bAspectRatioX		- the Y dimension of the picture aspect
260
+		bAspectRatioX		the Y dimension of the picture aspect
234261 					ratio, read-only
235
-		bDefaultFrameIndex	- optimum frame index for this stream
236
-		bBitsPerPixel		- number of bits per pixel used to
262
+		bDefaultFrameIndex	optimum frame index for this stream
263
+		bBitsPerPixel		number of bits per pixel used to
237264 					specify color in the decoded video
238265 					frame
239
-		guidFormat		- globally unique id used to identify
266
+		guidFormat		globally unique id used to identify
240267 					stream-encoding format
268
+		==================	=======================================
241269 
242270 What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
243271 Date:		Dec 2014
244272 KernelVersion:	4.0
245273 Description:	Specific uncompressed frame descriptors
246274 
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
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
+		=========================  =====================================
267297 
268298 What:		/config/usb-gadget/gadget/functions/uvc.name/streaming/header
269299 Date:		Dec 2014
....@@ -276,17 +306,20 @@
276306 Description:	Specific streaming header descriptors
277307 
278308 		All attributes read only:
279
-		bTriggerUsage		- how the host software will respond to
309
+
310
+		====================	=====================================
311
+		bTriggerUsage		how the host software will respond to
280312 					a hardware trigger interrupt event
281
-		bTriggerSupport		- flag specifying if hardware
313
+		bTriggerSupport		flag specifying if hardware
282314 					triggering is supported
283
-		bStillCaptureMethod	- method of still image caputre
315
+		bStillCaptureMethod	method of still image caputre
284316 					supported
285
-		bTerminalLink		- id of the output terminal to which
317
+		bTerminalLink		id of the output terminal to which
286318 					the video endpoint of this interface
287319 					is connected
288
-		bmInfo			- capabilities of this video streaming
320
+		bmInfo			capabilities of this video streaming
289321 					interface
322
+		====================	=====================================
290323 
291324 What:		/sys/class/udc/udc.name/device/gadget/video4linux/video.name/function_name
292325 Date:		May 2018