GNU Linux-libre 4.4.294-gnu1
[releases.git] / Documentation / ABI / testing / configfs-usb-gadget-uvc
1 What:           /config/usb-gadget/gadget/functions/uvc.name
2 Date:           Dec 2014
3 KernelVersion:  3.20
4 Description:    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
10 What:           /config/usb-gadget/gadget/functions/uvc.name/control
11 Date:           Dec 2014
12 KernelVersion:  3.20
13 Description:    Control descriptors
14
15 What:           /config/usb-gadget/gadget/functions/uvc.name/control/class
16 Date:           Dec 2014
17 KernelVersion:  3.20
18 Description:    Class descriptors
19
20 What:           /config/usb-gadget/gadget/functions/uvc.name/control/class/ss
21 Date:           Dec 2014
22 KernelVersion:  3.20
23 Description:    Super speed control class descriptors
24
25 What:           /config/usb-gadget/gadget/functions/uvc.name/control/class/fs
26 Date:           Dec 2014
27 KernelVersion:  3.20
28 Description:    Full speed control class descriptors
29
30 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal
31 Date:           Dec 2014
32 KernelVersion:  3.20
33 Description:    Terminal descriptors
34
35 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output
36 Date:           Dec 2014
37 KernelVersion:  3.20
38 Description:    Output terminal descriptors
39
40 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/output/default
41 Date:           Dec 2014
42 KernelVersion:  3.20
43 Description:    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
54 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera
55 Date:           Dec 2014
56 KernelVersion:  3.20
57 Description:    Camera terminal descriptors
58
59 What:           /config/usb-gadget/gadget/functions/uvc.name/control/terminal/camera/default
60 Date:           Dec 2014
61 KernelVersion:  3.20
62 Description:    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
76 What:           /config/usb-gadget/gadget/functions/uvc.name/control/processing
77 Date:           Dec 2014
78 KernelVersion:  3.20
79 Description:    Processing unit descriptors
80
81 What:           /config/usb-gadget/gadget/functions/uvc.name/control/processing/default
82 Date:           Dec 2014
83 KernelVersion:  3.20
84 Description:    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
95 What:           /config/usb-gadget/gadget/functions/uvc.name/control/header
96 Date:           Dec 2014
97 KernelVersion:  3.20
98 Description:    Control header descriptors
99
100 What:           /config/usb-gadget/gadget/functions/uvc.name/control/header/name
101 Date:           Dec 2014
102 KernelVersion:  3.20
103 Description:    Specific control header descriptors
104
105 dwClockFrequency
106 bcdUVC
107 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming
108 Date:           Dec 2014
109 KernelVersion:  3.20
110 Description:    Streaming descriptors
111
112 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class
113 Date:           Dec 2014
114 KernelVersion:  3.20
115 Description:    Streaming class descriptors
116
117 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class/ss
118 Date:           Dec 2014
119 KernelVersion:  3.20
120 Description:    Super speed streaming class descriptors
121
122 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class/hs
123 Date:           Dec 2014
124 KernelVersion:  3.20
125 Description:    High speed streaming class descriptors
126
127 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/class/fs
128 Date:           Dec 2014
129 KernelVersion:  3.20
130 Description:    Full speed streaming class descriptors
131
132 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching
133 Date:           Dec 2014
134 KernelVersion:  3.20
135 Description:    Color matching descriptors
136
137 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/color_matching/default
138 Date:           Dec 2014
139 KernelVersion:  3.20
140 Description:    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
151 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg
152 Date:           Dec 2014
153 KernelVersion:  3.20
154 Description:    MJPEG format descriptors
155
156 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name
157 Date:           Dec 2014
158 KernelVersion:  3.20
159 Description:    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
175 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/mjpeg/name/name
176 Date:           Dec 2014
177 KernelVersion:  3.20
178 Description:    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
197 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed
198 Date:           Dec 2014
199 KernelVersion:  3.20
200 Description:    Uncompressed format descriptors
201
202 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name
203 Date:           Dec 2014
204 KernelVersion:  3.20
205 Description:    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
222 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/uncompressed/name/name
223 Date:           Dec 2014
224 KernelVersion:  3.20
225 Description:    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
244 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/header
245 Date:           Dec 2014
246 KernelVersion:  3.20
247 Description:    Streaming header descriptors
248
249 What:           /config/usb-gadget/gadget/functions/uvc.name/streaming/header/name
250 Date:           Dec 2014
251 KernelVersion:  3.20
252 Description:    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