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