blob: 777bb7505f8d8382daac6e1cd8c9ec25280edd4c [file] [log] [blame]
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001#ifndef _USB_VIDEO_H_
2#define _USB_VIDEO_H_
3
Laurent Pinchart227bd5b2011-07-30 16:19:49 -03004#ifndef __KERNEL__
5#error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
6#endif /* __KERNEL__ */
7
Laurent Pinchartc0efd232008-06-30 15:04:50 -03008#include <linux/kernel.h>
Laurent Pinchartc0efd232008-06-30 15:04:50 -03009#include <linux/poll.h>
Laurent Pinchart4ffc2d82010-01-21 05:39:52 -030010#include <linux/usb.h>
Laurent Pinchartde05f632009-06-26 12:15:38 -030011#include <linux/usb/video.h>
Laurent Pinchart5f708812010-11-21 17:15:44 -030012#include <linux/uvcvideo.h>
Laurent Pinchart227bd5b2011-07-30 16:19:49 -030013#include <linux/videodev2.h>
Laurent Pinchart5a254d72010-01-21 05:39:47 -030014#include <media/media-device.h>
15#include <media/v4l2-device.h>
Hans de Goedeb4012002012-04-08 12:59:51 -030016#include <media/v4l2-event.h>
17#include <media/v4l2-fh.h>
Laurent Pinchart6998b6f2011-10-24 11:53:59 -030018#include <media/videobuf2-core.h>
Laurent Pinchartc0efd232008-06-30 15:04:50 -030019
20/* --------------------------------------------------------------------------
21 * UVC constants
22 */
23
Laurent Pinchartc0efd232008-06-30 15:04:50 -030024#define UVC_TERM_INPUT 0x0000
25#define UVC_TERM_OUTPUT 0x8000
Laurent Pinchart6241d8c2009-11-25 12:00:22 -030026#define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030027
28#define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
29#define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
30#define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
31#define UVC_ENTITY_IS_ITERM(entity) \
Laurent Pinchart8e113592009-07-01 20:24:47 -030032 (UVC_ENTITY_IS_TERM(entity) && \
33 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030034#define UVC_ENTITY_IS_OTERM(entity) \
Laurent Pinchart8e113592009-07-01 20:24:47 -030035 (UVC_ENTITY_IS_TERM(entity) && \
36 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030037
Laurent Pinchartc0efd232008-06-30 15:04:50 -030038
39/* ------------------------------------------------------------------------
40 * GUIDs
41 */
42#define UVC_GUID_UVC_CAMERA \
43 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
44 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
45#define UVC_GUID_UVC_OUTPUT \
46 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
47 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
48#define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
49 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
50 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
51#define UVC_GUID_UVC_PROCESSING \
52 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
53 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
54#define UVC_GUID_UVC_SELECTOR \
55 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
56 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
57
Laurent Pinchartc0efd232008-06-30 15:04:50 -030058#define UVC_GUID_FORMAT_MJPEG \
59 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
60 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
61#define UVC_GUID_FORMAT_YUY2 \
62 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
63 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Daniel Ritz68f194e2009-12-12 14:57:17 -030064#define UVC_GUID_FORMAT_YUY2_ISIGHT \
65 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
66 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -030067#define UVC_GUID_FORMAT_NV12 \
68 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
69 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
70#define UVC_GUID_FORMAT_YV12 \
71 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
72 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
73#define UVC_GUID_FORMAT_I420 \
74 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
75 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
76#define UVC_GUID_FORMAT_UYVY \
77 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
78 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
79#define UVC_GUID_FORMAT_Y800 \
80 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
81 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchart614212062010-04-12 10:41:22 -030082#define UVC_GUID_FORMAT_Y16 \
83 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
84 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -030085#define UVC_GUID_FORMAT_BY8 \
86 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
87 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchart50791072011-03-06 08:32:04 -030088#define UVC_GUID_FORMAT_RGBP \
89 { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
90 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Hans de Goede7225a1d2011-05-11 09:56:20 -030091#define UVC_GUID_FORMAT_M420 \
92 { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
93 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -030094
Stephan Lachowsky25ad8a82011-01-28 16:38:58 -030095#define UVC_GUID_FORMAT_H264 \
96 { 'H', '2', '6', '4', 0x00, 0x00, 0x10, 0x00, \
97 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
98
Laurent Pinchartc0efd232008-06-30 15:04:50 -030099/* ------------------------------------------------------------------------
100 * Driver specific constants.
101 */
102
Mauro Carvalho Chehabfd3e5822011-06-25 13:50:37 -0300103#define DRIVER_VERSION "1.1.1"
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300104
105/* Number of isochronous URBs. */
106#define UVC_URBS 5
Laurent Pinchartefdc8a92009-01-18 17:46:30 -0300107/* Maximum number of packets per URB. */
108#define UVC_MAX_PACKETS 32
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300109/* Maximum number of video buffers. */
110#define UVC_MAX_VIDEO_BUFFERS 32
Ming Leia31a4052008-09-16 03:32:20 -0300111/* Maximum status buffer size in bytes of interrupt URB. */
112#define UVC_MAX_STATUS_SIZE 16
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300113
114#define UVC_CTRL_CONTROL_TIMEOUT 300
Laurent Pinchart56d15cd2010-01-19 08:59:21 -0300115#define UVC_CTRL_STREAMING_TIMEOUT 5000
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300116
Martin Rubli8fb91b32010-09-08 04:15:23 -0300117/* Maximum allowed number of control mappings per device */
118#define UVC_MAX_CONTROL_MAPPINGS 1024
Haogang Chen806e23e2011-11-29 18:32:25 -0300119#define UVC_MAX_CONTROL_MENU_ENTRIES 32
Martin Rubli8fb91b32010-09-08 04:15:23 -0300120
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300121/* Devices quirks */
122#define UVC_QUIRK_STATUS_INTERVAL 0x00000001
123#define UVC_QUIRK_PROBE_MINMAX 0x00000002
124#define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
125#define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
126#define UVC_QUIRK_STREAM_NO_FID 0x00000010
127#define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
Laurent Pinchart50144ae2009-02-16 17:41:52 -0300128#define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
Laurent Pinchartbab6f662009-07-19 18:39:56 -0300129#define UVC_QUIRK_PROBE_DEF 0x00000100
Laurent Pinchart86d8b6a2010-09-16 12:37:26 -0300130#define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300131
132/* Format flags */
133#define UVC_FMT_FLAG_COMPRESSED 0x00000001
134#define UVC_FMT_FLAG_STREAM 0x00000002
135
136/* ------------------------------------------------------------------------
137 * Structures.
138 */
139
140struct uvc_device;
141
142/* TODO: Put the most frequently accessed fields at the beginning of
143 * structures to maximize cache efficiency.
144 */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300145struct uvc_control_info {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300146 struct list_head mappings;
147
148 __u8 entity[16];
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300149 __u8 index; /* Bit index in bmControls */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300150 __u8 selector;
151
152 __u16 size;
153 __u32 flags;
154};
155
156struct uvc_control_mapping {
157 struct list_head list;
Hans de Goedeb4012002012-04-08 12:59:51 -0300158 struct list_head ev_subs;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300159
160 struct uvc_control_info *ctrl;
161
162 __u32 id;
163 __u8 name[32];
164 __u8 entity[16];
165 __u8 selector;
166
167 __u8 size;
168 __u8 offset;
169 enum v4l2_ctrl_type v4l2_type;
170 __u32 data_type;
171
172 struct uvc_menu_info *menu_info;
173 __u32 menu_count;
Laurent Pinchart97683522008-12-16 06:46:32 -0300174
Hans de Goede55afeb82012-04-08 12:59:52 -0300175 __u32 master_id;
176 __s32 master_manual;
177 __u32 slave_ids[2];
178
Laurent Pinchart97683522008-12-16 06:46:32 -0300179 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
180 const __u8 *data);
181 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
182 __u8 *data);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300183};
184
185struct uvc_control {
186 struct uvc_entity *entity;
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300187 struct uvc_control_info info;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300188
189 __u8 index; /* Used to match the uvc_control entry with a
190 uvc_control_info. */
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300191 __u8 dirty:1,
192 loaded:1,
193 modified:1,
194 cached:1,
195 initialized:1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300196
Laurent Pinchartb30ece52010-06-18 11:31:24 -0300197 __u8 *uvc_data;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300198};
199
200struct uvc_format_desc {
201 char *name;
202 __u8 guid[16];
203 __u32 fcc;
204};
205
206/* The term 'entity' refers to both UVC units and UVC terminals.
207 *
208 * The type field is either the terminal type (wTerminalType in the terminal
209 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
210 * As the bDescriptorSubtype field is one byte long, the type value will
211 * always have a null MSB for units. All terminal types defined by the UVC
212 * specification have a non-null MSB, so it is safe to use the MSB to
213 * differentiate between units and terminals as long as the descriptor parsing
214 * code makes sure terminal types have a non-null MSB.
215 *
216 * For terminals, the type's most significant bit stores the terminal
217 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
218 * always be accessed with the UVC_ENTITY_* macros and never directly.
219 */
220
221struct uvc_entity {
222 struct list_head list; /* Entity as part of a UVC device. */
223 struct list_head chain; /* Entity as part of a video device
224 * chain. */
225 __u8 id;
226 __u16 type;
227 char name[64];
228
Laurent Pinchart4ffc2d82010-01-21 05:39:52 -0300229 /* Media controller-related fields. */
Laurent Pinchart8a65a942010-01-21 08:56:19 -0300230 struct video_device *vdev;
Laurent Pinchart4ffc2d82010-01-21 05:39:52 -0300231 struct v4l2_subdev subdev;
232 unsigned int num_pads;
233 unsigned int num_links;
234 struct media_pad *pads;
235
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300236 union {
237 struct {
238 __u16 wObjectiveFocalLengthMin;
239 __u16 wObjectiveFocalLengthMax;
240 __u16 wOcularFocalLength;
241 __u8 bControlSize;
242 __u8 *bmControls;
243 } camera;
244
245 struct {
246 __u8 bControlSize;
247 __u8 *bmControls;
248 __u8 bTransportModeSize;
249 __u8 *bmTransportModes;
250 } media;
251
252 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300253 } output;
254
255 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300256 __u16 wMaxMultiplier;
257 __u8 bControlSize;
258 __u8 *bmControls;
259 __u8 bmVideoStandards;
260 } processing;
261
262 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300263 } selector;
264
265 struct {
266 __u8 guidExtensionCode[16];
267 __u8 bNumControls;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300268 __u8 bControlSize;
269 __u8 *bmControls;
270 __u8 *bmControlsType;
271 } extension;
272 };
273
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300274 __u8 bNrInPins;
275 __u8 *baSourceID;
276
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300277 unsigned int ncontrols;
278 struct uvc_control *controls;
279};
280
281struct uvc_frame {
282 __u8 bFrameIndex;
283 __u8 bmCapabilities;
284 __u16 wWidth;
285 __u16 wHeight;
286 __u32 dwMinBitRate;
287 __u32 dwMaxBitRate;
288 __u32 dwMaxVideoFrameBufferSize;
289 __u8 bFrameIntervalType;
290 __u32 dwDefaultFrameInterval;
291 __u32 *dwFrameInterval;
292};
293
294struct uvc_format {
295 __u8 type;
296 __u8 index;
297 __u8 bpp;
298 __u8 colorspace;
299 __u32 fcc;
300 __u32 flags;
301
302 char name[32];
303
304 unsigned int nframes;
305 struct uvc_frame *frame;
306};
307
308struct uvc_streaming_header {
309 __u8 bNumFormats;
310 __u8 bEndpointAddress;
311 __u8 bTerminalLink;
312 __u8 bControlSize;
313 __u8 *bmaControls;
314 /* The following fields are used by input headers only. */
315 __u8 bmInfo;
316 __u8 bStillCaptureMethod;
317 __u8 bTriggerSupport;
318 __u8 bTriggerUsage;
319};
320
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300321enum uvc_buffer_state {
Laurent Pinchart2c2d2642009-01-03 19:12:40 -0300322 UVC_BUF_STATE_IDLE = 0,
323 UVC_BUF_STATE_QUEUED = 1,
324 UVC_BUF_STATE_ACTIVE = 2,
Laurent Pinchartd7c0d432009-12-16 21:20:45 -0300325 UVC_BUF_STATE_READY = 3,
326 UVC_BUF_STATE_DONE = 4,
327 UVC_BUF_STATE_ERROR = 5,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300328};
329
330struct uvc_buffer {
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300331 struct vb2_buffer buf;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300332 struct list_head queue;
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300333
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300334 enum uvc_buffer_state state;
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300335 unsigned int error;
Laurent Pinchart3d95e932011-10-24 11:49:19 -0300336
337 void *mem;
338 unsigned int length;
339 unsigned int bytesused;
Laurent Pinchart66847ef2011-09-24 10:46:55 -0300340
341 u32 pts;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300342};
343
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300344#define UVC_QUEUE_DISCONNECTED (1 << 0)
345#define UVC_QUEUE_DROP_CORRUPTED (1 << 1)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300346
347struct uvc_video_queue {
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300348 struct vb2_queue queue;
349 struct mutex mutex; /* Protects queue */
Laurent Pinchartff924202008-12-28 22:32:29 -0300350
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300351 unsigned int flags;
Laurent Pinchartff924202008-12-28 22:32:29 -0300352 unsigned int buf_used;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300353
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300354 spinlock_t irqlock; /* Protects irqqueue */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300355 struct list_head irqqueue;
356};
357
Laurent Pinchart8e113592009-07-01 20:24:47 -0300358struct uvc_video_chain {
359 struct uvc_device *dev;
360 struct list_head list;
361
Laurent Pinchart6241d8c2009-11-25 12:00:22 -0300362 struct list_head entities; /* All entities */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300363 struct uvc_entity *processing; /* Processing unit */
364 struct uvc_entity *selector; /* Selector unit */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300365
Laurent Pinchart27a61c12010-10-02 09:04:53 -0300366 struct mutex ctrl_mutex; /* Protects ctrl.info */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300367};
368
Alexey Fisher7bc5edb2011-11-03 11:40:08 -0300369struct uvc_stats_frame {
370 unsigned int size; /* Number of bytes captured */
371 unsigned int first_data; /* Index of the first non-empty packet */
372
373 unsigned int nb_packets; /* Number of packets */
374 unsigned int nb_empty; /* Number of empty packets */
375 unsigned int nb_invalid; /* Number of packets with an invalid header */
376 unsigned int nb_errors; /* Number of packets with the error bit set */
Laurent Pinchart25738cb2011-11-03 12:30:17 -0300377
378 unsigned int nb_pts; /* Number of packets with a PTS timestamp */
379 unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */
380 unsigned int last_pts_diff; /* Index of the last PTS difference */
381 bool has_initial_pts; /* Whether the first non-empty packet has a PTS */
382 bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */
383 u32 pts; /* PTS of the last packet */
384
385 unsigned int nb_scr; /* Number of packets with a SCR timestamp */
386 unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */
387 u16 scr_sof; /* SCR.SOF of the last packet */
388 u32 scr_stc; /* SCR.STC of the last packet */
Alexey Fisher7bc5edb2011-11-03 11:40:08 -0300389};
390
391struct uvc_stats_stream {
392 struct timespec start_ts; /* Stream start timestamp */
393 struct timespec stop_ts; /* Stream stop timestamp */
394
395 unsigned int nb_frames; /* Number of frames */
396
397 unsigned int nb_packets; /* Number of packets */
398 unsigned int nb_empty; /* Number of empty packets */
399 unsigned int nb_invalid; /* Number of packets with an invalid header */
400 unsigned int nb_errors; /* Number of packets with the error bit set */
Laurent Pinchart25738cb2011-11-03 12:30:17 -0300401
402 unsigned int nb_pts_constant; /* Number of frames with constant PTS */
403 unsigned int nb_pts_early; /* Number of frames with early PTS */
404 unsigned int nb_pts_initial; /* Number of frames with initial PTS */
405
406 unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */
407 unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */
408 unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */
409 unsigned int scr_sof; /* STC.SOF of the last packet */
410 unsigned int min_sof; /* Minimum STC.SOF value */
411 unsigned int max_sof; /* Maximum STC.SOF value */
Alexey Fisher7bc5edb2011-11-03 11:40:08 -0300412};
413
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300414struct uvc_streaming {
415 struct list_head list;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300416 struct uvc_device *dev;
417 struct video_device *vdev;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300418 struct uvc_video_chain *chain;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300419 atomic_t active;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300420
421 struct usb_interface *intf;
422 int intfnum;
423 __u16 maxpsize;
424
425 struct uvc_streaming_header header;
426 enum v4l2_buf_type type;
427
428 unsigned int nformats;
429 struct uvc_format *format;
430
431 struct uvc_streaming_control ctrl;
432 struct uvc_format *cur_format;
433 struct uvc_frame *cur_frame;
Laurent Pinchart69477562010-11-21 13:36:34 -0300434 /* Protect access to ctrl, cur_format, cur_frame and hardware video
435 * probe control.
436 */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300437 struct mutex mutex;
438
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300439 /* Buffers queue. */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300440 unsigned int frozen : 1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300441 struct uvc_video_queue queue;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300442 void (*decode) (struct urb *urb, struct uvc_streaming *video,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300443 struct uvc_buffer *buf);
444
445 /* Context data used by the bulk completion handler. */
446 struct {
447 __u8 header[256];
448 unsigned int header_size;
449 int skip_payload;
450 __u32 payload_size;
451 __u32 max_payload_size;
452 } bulk;
453
454 struct urb *urb[UVC_URBS];
455 char *urb_buffer[UVC_URBS];
Laurent Pincharte01117c2008-07-04 00:36:21 -0300456 dma_addr_t urb_dma[UVC_URBS];
457 unsigned int urb_size;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300458
Laurent Pinchart650b95f2010-10-02 11:06:05 -0300459 __u32 sequence;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300460 __u8 last_fid;
Alexey Fisheredbaa392011-11-03 09:39:37 -0300461
462 /* debugfs */
463 struct dentry *debugfs_dir;
Alexey Fisher7bc5edb2011-11-03 11:40:08 -0300464 struct {
465 struct uvc_stats_frame frame;
466 struct uvc_stats_stream stream;
467 } stats;
Laurent Pinchart66847ef2011-09-24 10:46:55 -0300468
469 /* Timestamps support. */
470 struct uvc_clock {
471 struct uvc_clock_sample {
472 u32 dev_stc;
473 u16 dev_sof;
474 struct timespec host_ts;
475 u16 host_sof;
476 } *samples;
477
478 unsigned int head;
479 unsigned int count;
480 unsigned int size;
481
482 u16 last_sof;
483 u16 sof_offset;
484
485 spinlock_t lock;
486 } clock;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300487};
488
489enum uvc_device_state {
490 UVC_DEV_DISCONNECTED = 1,
491};
492
493struct uvc_device {
494 struct usb_device *udev;
495 struct usb_interface *intf;
Laurent Pinchart44f00792008-11-08 19:14:50 -0300496 unsigned long warnings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300497 __u32 quirks;
498 int intfnum;
499 char name[32];
500
501 enum uvc_device_state state;
Laurent Pinchart04a37e02009-05-19 10:08:03 -0300502 atomic_t users;
Martin Rubli8fb91b32010-09-08 04:15:23 -0300503 atomic_t nmappings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300504
505 /* Video control interface */
Laurent Pinchart5a254d72010-01-21 05:39:47 -0300506#ifdef CONFIG_MEDIA_CONTROLLER
507 struct media_device mdev;
508#endif
509 struct v4l2_device vdev;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300510 __u16 uvc_version;
511 __u32 clock_frequency;
512
513 struct list_head entities;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300514 struct list_head chains;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300515
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300516 /* Video Streaming interfaces */
517 struct list_head streams;
Laurent Pinchart716fdee2009-09-29 21:07:19 -0300518 atomic_t nstreams;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300519
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300520 /* Status Interrupt Endpoint */
521 struct usb_host_endpoint *int_ep;
522 struct urb *int_urb;
Ming Leia31a4052008-09-16 03:32:20 -0300523 __u8 *status;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300524 struct input_dev *input;
Laurent Pinchartf1801522009-01-22 12:45:10 -0300525 char input_phys[64];
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300526};
527
528enum uvc_handle_state {
529 UVC_HANDLE_PASSIVE = 0,
530 UVC_HANDLE_ACTIVE = 1,
531};
532
533struct uvc_fh {
Hans de Goedeb4012002012-04-08 12:59:51 -0300534 struct v4l2_fh vfh;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300535 struct uvc_video_chain *chain;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300536 struct uvc_streaming *stream;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300537 enum uvc_handle_state state;
538};
539
540struct uvc_driver {
541 struct usb_driver driver;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300542};
543
544/* ------------------------------------------------------------------------
545 * Debugging, printing and logging
546 */
547
548#define UVC_TRACE_PROBE (1 << 0)
549#define UVC_TRACE_DESCR (1 << 1)
550#define UVC_TRACE_CONTROL (1 << 2)
551#define UVC_TRACE_FORMAT (1 << 3)
552#define UVC_TRACE_CAPTURE (1 << 4)
553#define UVC_TRACE_CALLS (1 << 5)
554#define UVC_TRACE_IOCTL (1 << 6)
555#define UVC_TRACE_FRAME (1 << 7)
556#define UVC_TRACE_SUSPEND (1 << 8)
557#define UVC_TRACE_STATUS (1 << 9)
Laurent Pinchart663a4192009-08-06 11:41:17 -0300558#define UVC_TRACE_VIDEO (1 << 10)
Alexey Fisher7bc5edb2011-11-03 11:40:08 -0300559#define UVC_TRACE_STATS (1 << 11)
Laurent Pinchart66847ef2011-09-24 10:46:55 -0300560#define UVC_TRACE_CLOCK (1 << 12)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300561
Laurent Pinchart44f00792008-11-08 19:14:50 -0300562#define UVC_WARN_MINMAX 0
563#define UVC_WARN_PROBE_DEF 1
Laurent Pinchartc4d99f82010-09-30 09:04:03 -0300564#define UVC_WARN_XU_GET_RES 2
Laurent Pinchart44f00792008-11-08 19:14:50 -0300565
Laurent Pinchart310fe522009-12-09 22:57:48 -0300566extern unsigned int uvc_clock_param;
Laurent Pinchart0fbd8ee2008-12-06 16:25:14 -0300567extern unsigned int uvc_no_drop_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300568extern unsigned int uvc_trace_param;
Laurent Pinchartb232a012009-10-09 20:55:23 -0300569extern unsigned int uvc_timeout_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300570
571#define uvc_trace(flag, msg...) \
572 do { \
573 if (uvc_trace_param & flag) \
574 printk(KERN_DEBUG "uvcvideo: " msg); \
575 } while (0)
576
Laurent Pinchart44f00792008-11-08 19:14:50 -0300577#define uvc_warn_once(dev, warn, msg...) \
578 do { \
579 if (!test_and_set_bit(warn, &dev->warnings)) \
580 printk(KERN_INFO "uvcvideo: " msg); \
581 } while (0)
582
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300583#define uvc_printk(level, msg...) \
584 printk(level "uvcvideo: " msg)
585
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300586/* --------------------------------------------------------------------------
587 * Internal functions.
588 */
589
590/* Core driver */
591extern struct uvc_driver uvc_driver;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300592
Laurent Pinchart4ffc2d82010-01-21 05:39:52 -0300593extern struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
594
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300595/* Video buffers queue management. */
Laurent Pinchartff924202008-12-28 22:32:29 -0300596extern void uvc_queue_init(struct uvc_video_queue *queue,
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300597 enum v4l2_buf_type type, int drop_corrupted);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300598extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300599 struct v4l2_requestbuffers *rb);
600extern void uvc_free_buffers(struct uvc_video_queue *queue);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300601extern int uvc_query_buffer(struct uvc_video_queue *queue,
602 struct v4l2_buffer *v4l2_buf);
603extern int uvc_queue_buffer(struct uvc_video_queue *queue,
604 struct v4l2_buffer *v4l2_buf);
605extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
606 struct v4l2_buffer *v4l2_buf, int nonblocking);
607extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
608extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
609extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
610 struct uvc_buffer *buf);
Laurent Pinchart4aa27592010-11-21 15:18:08 -0300611extern int uvc_queue_mmap(struct uvc_video_queue *queue,
612 struct vm_area_struct *vma);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300613extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
614 struct file *file, poll_table *wait);
Bob Liu72969442011-04-29 07:11:35 -0300615#ifndef CONFIG_MMU
616extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
617 unsigned long pgoff);
618#endif
Laurent Pinchart23ff6042009-06-04 09:26:39 -0300619extern int uvc_queue_allocated(struct uvc_video_queue *queue);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300620static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
621{
Laurent Pinchart6998b6f2011-10-24 11:53:59 -0300622 return vb2_is_streaming(&queue->queue);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300623}
624
625/* V4L2 interface */
Hans Verkuilbec43662008-12-30 06:58:20 -0300626extern const struct v4l2_file_operations uvc_fops;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300627
Laurent Pinchart4ffc2d82010-01-21 05:39:52 -0300628/* Media controller */
629extern int uvc_mc_register_entities(struct uvc_video_chain *chain);
630extern void uvc_mc_cleanup_entity(struct uvc_entity *entity);
631
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300632/* Video */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300633extern int uvc_video_init(struct uvc_streaming *stream);
634extern int uvc_video_suspend(struct uvc_streaming *stream);
Ming Leid59a7b12011-07-16 00:51:00 -0300635extern int uvc_video_resume(struct uvc_streaming *stream, int reset);
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300636extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
637extern int uvc_probe_video(struct uvc_streaming *stream,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300638 struct uvc_streaming_control *probe);
639extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
640 __u8 intfnum, __u8 cs, void *data, __u16 size);
Laurent Pinchart66847ef2011-09-24 10:46:55 -0300641void uvc_video_clock_update(struct uvc_streaming *stream,
642 struct v4l2_buffer *v4l2_buf,
643 struct uvc_buffer *buf);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300644
645/* Status */
646extern int uvc_status_init(struct uvc_device *dev);
647extern void uvc_status_cleanup(struct uvc_device *dev);
Laurent Pinchart04a37e02009-05-19 10:08:03 -0300648extern int uvc_status_start(struct uvc_device *dev);
649extern void uvc_status_stop(struct uvc_device *dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300650extern int uvc_status_suspend(struct uvc_device *dev);
651extern int uvc_status_resume(struct uvc_device *dev);
652
653/* Controls */
Hans de Goedeb4012002012-04-08 12:59:51 -0300654extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
655
Laurent Pinchart8e113592009-07-01 20:24:47 -0300656extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300657 struct v4l2_queryctrl *v4l2_ctrl);
Laurent Pinchart23d9f3e2010-11-21 07:58:54 -0300658extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
659 struct v4l2_querymenu *query_menu);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300660
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300661extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
662 const struct uvc_control_mapping *mapping);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300663extern int uvc_ctrl_init_device(struct uvc_device *dev);
664extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
665extern int uvc_ctrl_resume_device(struct uvc_device *dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300666
Laurent Pinchart8e113592009-07-01 20:24:47 -0300667extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
Hans de Goedeb4012002012-04-08 12:59:51 -0300668extern int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
669 const struct v4l2_ext_control *xctrls,
670 unsigned int xctrls_count);
671static inline int uvc_ctrl_commit(struct uvc_fh *handle,
672 const struct v4l2_ext_control *xctrls,
673 unsigned int xctrls_count)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300674{
Hans de Goedeb4012002012-04-08 12:59:51 -0300675 return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300676}
Hans de Goedeb4012002012-04-08 12:59:51 -0300677static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300678{
Hans de Goedeb4012002012-04-08 12:59:51 -0300679 return __uvc_ctrl_commit(handle, 1, NULL, 0);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300680}
681
Laurent Pinchart8e113592009-07-01 20:24:47 -0300682extern int uvc_ctrl_get(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300683 struct v4l2_ext_control *xctrl);
Laurent Pinchart8e113592009-07-01 20:24:47 -0300684extern int uvc_ctrl_set(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300685 struct v4l2_ext_control *xctrl);
686
Laurent Pinchart8e113592009-07-01 20:24:47 -0300687extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
Martin Rublife78d182010-10-02 19:10:16 -0300688 struct uvc_xu_control_query *xqry);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300689
690/* Utility functions */
691extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
692 unsigned int n_terms, unsigned int threshold);
693extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
694 uint32_t denominator);
695extern struct usb_host_endpoint *uvc_find_endpoint(
696 struct usb_host_interface *alts, __u8 epaddr);
697
698/* Quirks support */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300699void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300700 struct uvc_buffer *buf);
701
Alexey Fisher7bc5edb2011-11-03 11:40:08 -0300702/* debugfs and statistics */
Alexey Fisheredbaa392011-11-03 09:39:37 -0300703int uvc_debugfs_init(void);
704void uvc_debugfs_cleanup(void);
705int uvc_debugfs_init_stream(struct uvc_streaming *stream);
706void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
707
Alexey Fisher7bc5edb2011-11-03 11:40:08 -0300708size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,
709 size_t size);
710
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300711#endif