blob: cd58ea81320bfbe94ee66bd21b2981488ae17e90 [file] [log] [blame]
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001#ifndef _USB_VIDEO_H_
2#define _USB_VIDEO_H_
3
4#include <linux/kernel.h>
5#include <linux/videodev2.h>
6
Laurent Pinchartc0efd232008-06-30 15:04:50 -03007/*
8 * Dynamic controls
9 */
10
11/* Data types for UVC control data */
12#define UVC_CTRL_DATA_TYPE_RAW 0
13#define UVC_CTRL_DATA_TYPE_SIGNED 1
14#define UVC_CTRL_DATA_TYPE_UNSIGNED 2
15#define UVC_CTRL_DATA_TYPE_BOOLEAN 3
16#define UVC_CTRL_DATA_TYPE_ENUM 4
17#define UVC_CTRL_DATA_TYPE_BITMASK 5
18
19/* Control flags */
Laurent Pinchart9eb30d22010-11-21 17:08:16 -030020#define UVC_CTRL_FLAG_SET_CUR (1 << 0)
21#define UVC_CTRL_FLAG_GET_CUR (1 << 1)
22#define UVC_CTRL_FLAG_GET_MIN (1 << 2)
23#define UVC_CTRL_FLAG_GET_MAX (1 << 3)
24#define UVC_CTRL_FLAG_GET_RES (1 << 4)
25#define UVC_CTRL_FLAG_GET_DEF (1 << 5)
26/* Control should be saved at suspend and restored at resume. */
27#define UVC_CTRL_FLAG_RESTORE (1 << 6)
28/* Control can be updated by the camera. */
29#define UVC_CTRL_FLAG_AUTO_UPDATE (1 << 7)
30
31#define UVC_CTRL_FLAG_GET_RANGE \
32 (UVC_CTRL_FLAG_GET_CUR | UVC_CTRL_FLAG_GET_MIN | \
33 UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES | \
34 UVC_CTRL_FLAG_GET_DEF)
35
36/* Old control flags, don't use */
Laurent Pinchartc0efd232008-06-30 15:04:50 -030037#define UVC_CONTROL_SET_CUR (1 << 0)
38#define UVC_CONTROL_GET_CUR (1 << 1)
39#define UVC_CONTROL_GET_MIN (1 << 2)
40#define UVC_CONTROL_GET_MAX (1 << 3)
41#define UVC_CONTROL_GET_RES (1 << 4)
42#define UVC_CONTROL_GET_DEF (1 << 5)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030043#define UVC_CONTROL_RESTORE (1 << 6)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030044#define UVC_CONTROL_AUTO_UPDATE (1 << 7)
45
46#define UVC_CONTROL_GET_RANGE (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
47 UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
48 UVC_CONTROL_GET_DEF)
49
50struct uvc_xu_control_info {
51 __u8 entity[16];
52 __u8 index;
53 __u8 selector;
54 __u16 size;
55 __u32 flags;
56};
57
Laurent Pinchart561474c2010-02-18 16:38:52 -030058struct uvc_menu_info {
59 __u32 value;
60 __u8 name[32];
61};
62
63struct uvc_xu_control_mapping_old {
64 __u8 reserved[64];
65};
66
Laurent Pinchartc0efd232008-06-30 15:04:50 -030067struct uvc_xu_control_mapping {
68 __u32 id;
69 __u8 name[32];
70 __u8 entity[16];
71 __u8 selector;
72
73 __u8 size;
74 __u8 offset;
Martin Rublife78d182010-10-02 19:10:16 -030075 __u32 v4l2_type;
Laurent Pinchartc0efd232008-06-30 15:04:50 -030076 __u32 data_type;
Laurent Pinchart561474c2010-02-18 16:38:52 -030077
78 struct uvc_menu_info __user *menu_info;
79 __u32 menu_count;
80
81 __u32 reserved[4];
Laurent Pinchartc0efd232008-06-30 15:04:50 -030082};
83
84struct uvc_xu_control {
85 __u8 unit;
86 __u8 selector;
87 __u16 size;
88 __u8 __user *data;
89};
90
Martin Rublife78d182010-10-02 19:10:16 -030091struct uvc_xu_control_query {
92 __u8 unit;
93 __u8 selector;
94 __u8 query;
95 __u16 size;
96 __u8 __user *data;
97};
98
Laurent Pinchartc0efd232008-06-30 15:04:50 -030099#define UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
Laurent Pinchart561474c2010-02-18 16:38:52 -0300100#define UVCIOC_CTRL_MAP_OLD _IOWR('U', 2, struct uvc_xu_control_mapping_old)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300101#define UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
102#define UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
103#define UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
Martin Rublife78d182010-10-02 19:10:16 -0300104#define UVCIOC_CTRL_QUERY _IOWR('U', 5, struct uvc_xu_control_query)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300105
106#ifdef __KERNEL__
107
108#include <linux/poll.h>
Laurent Pinchartde05f632009-06-26 12:15:38 -0300109#include <linux/usb/video.h>
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300110
111/* --------------------------------------------------------------------------
112 * UVC constants
113 */
114
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300115#define UVC_TERM_INPUT 0x0000
116#define UVC_TERM_OUTPUT 0x8000
Laurent Pinchart6241d8c2009-11-25 12:00:22 -0300117#define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300118
119#define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
120#define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
121#define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
122#define UVC_ENTITY_IS_ITERM(entity) \
Laurent Pinchart8e113592009-07-01 20:24:47 -0300123 (UVC_ENTITY_IS_TERM(entity) && \
124 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300125#define UVC_ENTITY_IS_OTERM(entity) \
Laurent Pinchart8e113592009-07-01 20:24:47 -0300126 (UVC_ENTITY_IS_TERM(entity) && \
127 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300128
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300129
130/* ------------------------------------------------------------------------
131 * GUIDs
132 */
133#define UVC_GUID_UVC_CAMERA \
134 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
135 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
136#define UVC_GUID_UVC_OUTPUT \
137 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
138 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
139#define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
140 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
141 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
142#define UVC_GUID_UVC_PROCESSING \
143 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
144 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
145#define UVC_GUID_UVC_SELECTOR \
146 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
147 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
148
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300149#define UVC_GUID_FORMAT_MJPEG \
150 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
151 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
152#define UVC_GUID_FORMAT_YUY2 \
153 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
154 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Daniel Ritz68f194e2009-12-12 14:57:17 -0300155#define UVC_GUID_FORMAT_YUY2_ISIGHT \
156 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
157 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300158#define UVC_GUID_FORMAT_NV12 \
159 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
160 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
161#define UVC_GUID_FORMAT_YV12 \
162 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
163 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
164#define UVC_GUID_FORMAT_I420 \
165 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
166 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
167#define UVC_GUID_FORMAT_UYVY \
168 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
169 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
170#define UVC_GUID_FORMAT_Y800 \
171 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
172 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchart614212062010-04-12 10:41:22 -0300173#define UVC_GUID_FORMAT_Y16 \
174 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
175 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300176#define UVC_GUID_FORMAT_BY8 \
177 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
178 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchart50791072011-03-06 08:32:04 -0300179#define UVC_GUID_FORMAT_RGBP \
180 { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
181 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300182
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300183/* ------------------------------------------------------------------------
184 * Driver specific constants.
185 */
186
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300187#define DRIVER_VERSION_NUMBER KERNEL_VERSION(1, 0, 0)
188#define DRIVER_VERSION "v1.0.0"
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300189
190/* Number of isochronous URBs. */
191#define UVC_URBS 5
Laurent Pinchartefdc8a92009-01-18 17:46:30 -0300192/* Maximum number of packets per URB. */
193#define UVC_MAX_PACKETS 32
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300194/* Maximum number of video buffers. */
195#define UVC_MAX_VIDEO_BUFFERS 32
Ming Leia31a4052008-09-16 03:32:20 -0300196/* Maximum status buffer size in bytes of interrupt URB. */
197#define UVC_MAX_STATUS_SIZE 16
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300198
199#define UVC_CTRL_CONTROL_TIMEOUT 300
Laurent Pinchart56d15cd2010-01-19 08:59:21 -0300200#define UVC_CTRL_STREAMING_TIMEOUT 5000
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300201
Martin Rubli8fb91b32010-09-08 04:15:23 -0300202/* Maximum allowed number of control mappings per device */
203#define UVC_MAX_CONTROL_MAPPINGS 1024
204
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300205/* Devices quirks */
206#define UVC_QUIRK_STATUS_INTERVAL 0x00000001
207#define UVC_QUIRK_PROBE_MINMAX 0x00000002
208#define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
209#define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
210#define UVC_QUIRK_STREAM_NO_FID 0x00000010
211#define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
Laurent Pinchart50144ae2009-02-16 17:41:52 -0300212#define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
Laurent Pinchartbab6f662009-07-19 18:39:56 -0300213#define UVC_QUIRK_PROBE_DEF 0x00000100
Laurent Pinchart86d8b6a2010-09-16 12:37:26 -0300214#define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300215
216/* Format flags */
217#define UVC_FMT_FLAG_COMPRESSED 0x00000001
218#define UVC_FMT_FLAG_STREAM 0x00000002
219
220/* ------------------------------------------------------------------------
221 * Structures.
222 */
223
224struct uvc_device;
225
226/* TODO: Put the most frequently accessed fields at the beginning of
227 * structures to maximize cache efficiency.
228 */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300229struct uvc_control_info {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300230 struct list_head mappings;
231
232 __u8 entity[16];
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300233 __u8 index; /* Bit index in bmControls */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300234 __u8 selector;
235
236 __u16 size;
237 __u32 flags;
238};
239
240struct uvc_control_mapping {
241 struct list_head list;
242
243 struct uvc_control_info *ctrl;
244
245 __u32 id;
246 __u8 name[32];
247 __u8 entity[16];
248 __u8 selector;
249
250 __u8 size;
251 __u8 offset;
252 enum v4l2_ctrl_type v4l2_type;
253 __u32 data_type;
254
255 struct uvc_menu_info *menu_info;
256 __u32 menu_count;
Laurent Pinchart97683522008-12-16 06:46:32 -0300257
258 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
259 const __u8 *data);
260 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
261 __u8 *data);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300262};
263
264struct uvc_control {
265 struct uvc_entity *entity;
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300266 struct uvc_control_info info;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300267
268 __u8 index; /* Used to match the uvc_control entry with a
269 uvc_control_info. */
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300270 __u8 dirty:1,
271 loaded:1,
272 modified:1,
273 cached:1,
274 initialized:1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300275
Laurent Pinchartb30ece52010-06-18 11:31:24 -0300276 __u8 *uvc_data;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300277};
278
279struct uvc_format_desc {
280 char *name;
281 __u8 guid[16];
282 __u32 fcc;
283};
284
285/* The term 'entity' refers to both UVC units and UVC terminals.
286 *
287 * The type field is either the terminal type (wTerminalType in the terminal
288 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
289 * As the bDescriptorSubtype field is one byte long, the type value will
290 * always have a null MSB for units. All terminal types defined by the UVC
291 * specification have a non-null MSB, so it is safe to use the MSB to
292 * differentiate between units and terminals as long as the descriptor parsing
293 * code makes sure terminal types have a non-null MSB.
294 *
295 * For terminals, the type's most significant bit stores the terminal
296 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
297 * always be accessed with the UVC_ENTITY_* macros and never directly.
298 */
299
300struct uvc_entity {
301 struct list_head list; /* Entity as part of a UVC device. */
302 struct list_head chain; /* Entity as part of a video device
303 * chain. */
304 __u8 id;
305 __u16 type;
306 char name[64];
307
308 union {
309 struct {
310 __u16 wObjectiveFocalLengthMin;
311 __u16 wObjectiveFocalLengthMax;
312 __u16 wOcularFocalLength;
313 __u8 bControlSize;
314 __u8 *bmControls;
315 } camera;
316
317 struct {
318 __u8 bControlSize;
319 __u8 *bmControls;
320 __u8 bTransportModeSize;
321 __u8 *bmTransportModes;
322 } media;
323
324 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300325 } output;
326
327 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300328 __u16 wMaxMultiplier;
329 __u8 bControlSize;
330 __u8 *bmControls;
331 __u8 bmVideoStandards;
332 } processing;
333
334 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300335 } selector;
336
337 struct {
338 __u8 guidExtensionCode[16];
339 __u8 bNumControls;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300340 __u8 bControlSize;
341 __u8 *bmControls;
342 __u8 *bmControlsType;
343 } extension;
344 };
345
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300346 __u8 bNrInPins;
347 __u8 *baSourceID;
348
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300349 unsigned int ncontrols;
350 struct uvc_control *controls;
351};
352
353struct uvc_frame {
354 __u8 bFrameIndex;
355 __u8 bmCapabilities;
356 __u16 wWidth;
357 __u16 wHeight;
358 __u32 dwMinBitRate;
359 __u32 dwMaxBitRate;
360 __u32 dwMaxVideoFrameBufferSize;
361 __u8 bFrameIntervalType;
362 __u32 dwDefaultFrameInterval;
363 __u32 *dwFrameInterval;
364};
365
366struct uvc_format {
367 __u8 type;
368 __u8 index;
369 __u8 bpp;
370 __u8 colorspace;
371 __u32 fcc;
372 __u32 flags;
373
374 char name[32];
375
376 unsigned int nframes;
377 struct uvc_frame *frame;
378};
379
380struct uvc_streaming_header {
381 __u8 bNumFormats;
382 __u8 bEndpointAddress;
383 __u8 bTerminalLink;
384 __u8 bControlSize;
385 __u8 *bmaControls;
386 /* The following fields are used by input headers only. */
387 __u8 bmInfo;
388 __u8 bStillCaptureMethod;
389 __u8 bTriggerSupport;
390 __u8 bTriggerUsage;
391};
392
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300393enum uvc_buffer_state {
Laurent Pinchart2c2d2642009-01-03 19:12:40 -0300394 UVC_BUF_STATE_IDLE = 0,
395 UVC_BUF_STATE_QUEUED = 1,
396 UVC_BUF_STATE_ACTIVE = 2,
Laurent Pinchartd7c0d432009-12-16 21:20:45 -0300397 UVC_BUF_STATE_READY = 3,
398 UVC_BUF_STATE_DONE = 4,
399 UVC_BUF_STATE_ERROR = 5,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300400};
401
402struct uvc_buffer {
403 unsigned long vma_use_count;
404 struct list_head stream;
405
406 /* Touched by interrupt handler. */
407 struct v4l2_buffer buf;
408 struct list_head queue;
409 wait_queue_head_t wait;
410 enum uvc_buffer_state state;
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300411 unsigned int error;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300412};
413
414#define UVC_QUEUE_STREAMING (1 << 0)
415#define UVC_QUEUE_DISCONNECTED (1 << 1)
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300416#define UVC_QUEUE_DROP_CORRUPTED (1 << 2)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300417
418struct uvc_video_queue {
Laurent Pinchartff924202008-12-28 22:32:29 -0300419 enum v4l2_buf_type type;
420
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300421 void *mem;
422 unsigned int flags;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300423
424 unsigned int count;
425 unsigned int buf_size;
Laurent Pinchartff924202008-12-28 22:32:29 -0300426 unsigned int buf_used;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300427 struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
428 struct mutex mutex; /* protects buffers and mainqueue */
429 spinlock_t irqlock; /* protects irqqueue */
430
431 struct list_head mainqueue;
432 struct list_head irqqueue;
433};
434
Laurent Pinchart8e113592009-07-01 20:24:47 -0300435struct uvc_video_chain {
436 struct uvc_device *dev;
437 struct list_head list;
438
Laurent Pinchart6241d8c2009-11-25 12:00:22 -0300439 struct list_head entities; /* All entities */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300440 struct uvc_entity *processing; /* Processing unit */
441 struct uvc_entity *selector; /* Selector unit */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300442
Laurent Pinchart27a61c12010-10-02 09:04:53 -0300443 struct mutex ctrl_mutex; /* Protects ctrl.info */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300444};
445
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300446struct uvc_streaming {
447 struct list_head list;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300448 struct uvc_device *dev;
449 struct video_device *vdev;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300450 struct uvc_video_chain *chain;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300451 atomic_t active;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300452
453 struct usb_interface *intf;
454 int intfnum;
455 __u16 maxpsize;
456
457 struct uvc_streaming_header header;
458 enum v4l2_buf_type type;
459
460 unsigned int nformats;
461 struct uvc_format *format;
462
463 struct uvc_streaming_control ctrl;
464 struct uvc_format *cur_format;
465 struct uvc_frame *cur_frame;
Laurent Pinchart69477562010-11-21 13:36:34 -0300466 /* Protect access to ctrl, cur_format, cur_frame and hardware video
467 * probe control.
468 */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300469 struct mutex mutex;
470
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300471 unsigned int frozen : 1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300472 struct uvc_video_queue queue;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300473 void (*decode) (struct urb *urb, struct uvc_streaming *video,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300474 struct uvc_buffer *buf);
475
476 /* Context data used by the bulk completion handler. */
477 struct {
478 __u8 header[256];
479 unsigned int header_size;
480 int skip_payload;
481 __u32 payload_size;
482 __u32 max_payload_size;
483 } bulk;
484
485 struct urb *urb[UVC_URBS];
486 char *urb_buffer[UVC_URBS];
Laurent Pincharte01117c2008-07-04 00:36:21 -0300487 dma_addr_t urb_dma[UVC_URBS];
488 unsigned int urb_size;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300489
Laurent Pinchart650b95f2010-10-02 11:06:05 -0300490 __u32 sequence;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300491 __u8 last_fid;
492};
493
494enum uvc_device_state {
495 UVC_DEV_DISCONNECTED = 1,
496};
497
498struct uvc_device {
499 struct usb_device *udev;
500 struct usb_interface *intf;
Laurent Pinchart44f00792008-11-08 19:14:50 -0300501 unsigned long warnings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300502 __u32 quirks;
503 int intfnum;
504 char name[32];
505
506 enum uvc_device_state state;
Laurent Pinchart04a37e02009-05-19 10:08:03 -0300507 atomic_t users;
Martin Rubli8fb91b32010-09-08 04:15:23 -0300508 atomic_t nmappings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300509
510 /* Video control interface */
511 __u16 uvc_version;
512 __u32 clock_frequency;
513
514 struct list_head entities;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300515 struct list_head chains;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300516
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300517 /* Video Streaming interfaces */
518 struct list_head streams;
Laurent Pinchart716fdee2009-09-29 21:07:19 -0300519 atomic_t nstreams;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300520
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300521 /* Status Interrupt Endpoint */
522 struct usb_host_endpoint *int_ep;
523 struct urb *int_urb;
Ming Leia31a4052008-09-16 03:32:20 -0300524 __u8 *status;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300525 struct input_dev *input;
Laurent Pinchartf1801522009-01-22 12:45:10 -0300526 char input_phys[64];
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300527};
528
529enum uvc_handle_state {
530 UVC_HANDLE_PASSIVE = 0,
531 UVC_HANDLE_ACTIVE = 1,
532};
533
534struct uvc_fh {
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)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300559
Laurent Pinchart44f00792008-11-08 19:14:50 -0300560#define UVC_WARN_MINMAX 0
561#define UVC_WARN_PROBE_DEF 1
562
Laurent Pinchart310fe522009-12-09 22:57:48 -0300563extern unsigned int uvc_clock_param;
Laurent Pinchart0fbd8ee2008-12-06 16:25:14 -0300564extern unsigned int uvc_no_drop_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300565extern unsigned int uvc_trace_param;
Laurent Pinchartb232a012009-10-09 20:55:23 -0300566extern unsigned int uvc_timeout_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300567
568#define uvc_trace(flag, msg...) \
569 do { \
570 if (uvc_trace_param & flag) \
571 printk(KERN_DEBUG "uvcvideo: " msg); \
572 } while (0)
573
Laurent Pinchart44f00792008-11-08 19:14:50 -0300574#define uvc_warn_once(dev, warn, msg...) \
575 do { \
576 if (!test_and_set_bit(warn, &dev->warnings)) \
577 printk(KERN_INFO "uvcvideo: " msg); \
578 } while (0)
579
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300580#define uvc_printk(level, msg...) \
581 printk(level "uvcvideo: " msg)
582
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300583/* --------------------------------------------------------------------------
584 * Internal functions.
585 */
586
587/* Core driver */
588extern struct uvc_driver uvc_driver;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300589
590/* Video buffers queue management. */
Laurent Pinchartff924202008-12-28 22:32:29 -0300591extern void uvc_queue_init(struct uvc_video_queue *queue,
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300592 enum v4l2_buf_type type, int drop_corrupted);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300593extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
594 unsigned int nbuffers, unsigned int buflength);
595extern int uvc_free_buffers(struct uvc_video_queue *queue);
596extern int uvc_query_buffer(struct uvc_video_queue *queue,
597 struct v4l2_buffer *v4l2_buf);
598extern int uvc_queue_buffer(struct uvc_video_queue *queue,
599 struct v4l2_buffer *v4l2_buf);
600extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
601 struct v4l2_buffer *v4l2_buf, int nonblocking);
602extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
603extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
604extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
605 struct uvc_buffer *buf);
Laurent Pinchart4aa27592010-11-21 15:18:08 -0300606extern int uvc_queue_mmap(struct uvc_video_queue *queue,
607 struct vm_area_struct *vma);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300608extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
609 struct file *file, poll_table *wait);
Laurent Pinchart23ff6042009-06-04 09:26:39 -0300610extern int uvc_queue_allocated(struct uvc_video_queue *queue);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300611static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
612{
613 return queue->flags & UVC_QUEUE_STREAMING;
614}
615
616/* V4L2 interface */
Hans Verkuilbec43662008-12-30 06:58:20 -0300617extern const struct v4l2_file_operations uvc_fops;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300618
619/* Video */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300620extern int uvc_video_init(struct uvc_streaming *stream);
621extern int uvc_video_suspend(struct uvc_streaming *stream);
622extern int uvc_video_resume(struct uvc_streaming *stream);
623extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
624extern int uvc_probe_video(struct uvc_streaming *stream,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300625 struct uvc_streaming_control *probe);
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300626extern int uvc_commit_video(struct uvc_streaming *stream,
Laurent Pinchart44f00792008-11-08 19:14:50 -0300627 struct uvc_streaming_control *ctrl);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300628extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
629 __u8 intfnum, __u8 cs, void *data, __u16 size);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300630
631/* Status */
632extern int uvc_status_init(struct uvc_device *dev);
633extern void uvc_status_cleanup(struct uvc_device *dev);
Laurent Pinchart04a37e02009-05-19 10:08:03 -0300634extern int uvc_status_start(struct uvc_device *dev);
635extern void uvc_status_stop(struct uvc_device *dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300636extern int uvc_status_suspend(struct uvc_device *dev);
637extern int uvc_status_resume(struct uvc_device *dev);
638
639/* Controls */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300640extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300641 struct v4l2_queryctrl *v4l2_ctrl);
Laurent Pinchart23d9f3e2010-11-21 07:58:54 -0300642extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
643 struct v4l2_querymenu *query_menu);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300644
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300645extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
646 const struct uvc_control_mapping *mapping);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300647extern int uvc_ctrl_init_device(struct uvc_device *dev);
648extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
649extern int uvc_ctrl_resume_device(struct uvc_device *dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300650
Laurent Pinchart8e113592009-07-01 20:24:47 -0300651extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
652extern int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback);
653static inline int uvc_ctrl_commit(struct uvc_video_chain *chain)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300654{
Laurent Pinchart8e113592009-07-01 20:24:47 -0300655 return __uvc_ctrl_commit(chain, 0);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300656}
Laurent Pinchart8e113592009-07-01 20:24:47 -0300657static inline int uvc_ctrl_rollback(struct uvc_video_chain *chain)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300658{
Laurent Pinchart8e113592009-07-01 20:24:47 -0300659 return __uvc_ctrl_commit(chain, 1);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300660}
661
Laurent Pinchart8e113592009-07-01 20:24:47 -0300662extern int uvc_ctrl_get(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300663 struct v4l2_ext_control *xctrl);
Laurent Pinchart8e113592009-07-01 20:24:47 -0300664extern int uvc_ctrl_set(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300665 struct v4l2_ext_control *xctrl);
666
Laurent Pinchart8e113592009-07-01 20:24:47 -0300667extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
Martin Rublife78d182010-10-02 19:10:16 -0300668 struct uvc_xu_control_query *xqry);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300669
670/* Utility functions */
671extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
672 unsigned int n_terms, unsigned int threshold);
673extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
674 uint32_t denominator);
675extern struct usb_host_endpoint *uvc_find_endpoint(
676 struct usb_host_interface *alts, __u8 epaddr);
677
678/* Quirks support */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300679void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300680 struct uvc_buffer *buf);
681
682#endif /* __KERNEL__ */
683
684#endif
Hans Verkuilf87086e2008-07-18 00:50:58 -0300685