blob: 18d76679d952333364e9d9c713bf8ab59ff28494 [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}
179
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300180/* ------------------------------------------------------------------------
181 * Driver specific constants.
182 */
183
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300184#define DRIVER_VERSION_NUMBER KERNEL_VERSION(1, 0, 0)
185#define DRIVER_VERSION "v1.0.0"
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300186
187/* Number of isochronous URBs. */
188#define UVC_URBS 5
Laurent Pinchartefdc8a92009-01-18 17:46:30 -0300189/* Maximum number of packets per URB. */
190#define UVC_MAX_PACKETS 32
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300191/* Maximum number of video buffers. */
192#define UVC_MAX_VIDEO_BUFFERS 32
Ming Leia31a4052008-09-16 03:32:20 -0300193/* Maximum status buffer size in bytes of interrupt URB. */
194#define UVC_MAX_STATUS_SIZE 16
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300195
196#define UVC_CTRL_CONTROL_TIMEOUT 300
Laurent Pinchart56d15cd2010-01-19 08:59:21 -0300197#define UVC_CTRL_STREAMING_TIMEOUT 5000
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300198
Martin Rubli8fb91b32010-09-08 04:15:23 -0300199/* Maximum allowed number of control mappings per device */
200#define UVC_MAX_CONTROL_MAPPINGS 1024
201
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300202/* Devices quirks */
203#define UVC_QUIRK_STATUS_INTERVAL 0x00000001
204#define UVC_QUIRK_PROBE_MINMAX 0x00000002
205#define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
206#define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
207#define UVC_QUIRK_STREAM_NO_FID 0x00000010
208#define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
Laurent Pinchart50144ae2009-02-16 17:41:52 -0300209#define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
Laurent Pinchartbab6f662009-07-19 18:39:56 -0300210#define UVC_QUIRK_PROBE_DEF 0x00000100
Laurent Pinchart86d8b6a2010-09-16 12:37:26 -0300211#define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300212
213/* Format flags */
214#define UVC_FMT_FLAG_COMPRESSED 0x00000001
215#define UVC_FMT_FLAG_STREAM 0x00000002
216
217/* ------------------------------------------------------------------------
218 * Structures.
219 */
220
221struct uvc_device;
222
223/* TODO: Put the most frequently accessed fields at the beginning of
224 * structures to maximize cache efficiency.
225 */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300226struct uvc_control_info {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300227 struct list_head mappings;
228
229 __u8 entity[16];
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300230 __u8 index; /* Bit index in bmControls */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300231 __u8 selector;
232
233 __u16 size;
234 __u32 flags;
235};
236
237struct uvc_control_mapping {
238 struct list_head list;
239
240 struct uvc_control_info *ctrl;
241
242 __u32 id;
243 __u8 name[32];
244 __u8 entity[16];
245 __u8 selector;
246
247 __u8 size;
248 __u8 offset;
249 enum v4l2_ctrl_type v4l2_type;
250 __u32 data_type;
251
252 struct uvc_menu_info *menu_info;
253 __u32 menu_count;
Laurent Pinchart97683522008-12-16 06:46:32 -0300254
255 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
256 const __u8 *data);
257 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
258 __u8 *data);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300259};
260
261struct uvc_control {
262 struct uvc_entity *entity;
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300263 struct uvc_control_info info;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300264
265 __u8 index; /* Used to match the uvc_control entry with a
266 uvc_control_info. */
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300267 __u8 dirty:1,
268 loaded:1,
269 modified:1,
270 cached:1,
271 initialized:1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300272
Laurent Pinchartb30ece52010-06-18 11:31:24 -0300273 __u8 *uvc_data;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300274};
275
276struct uvc_format_desc {
277 char *name;
278 __u8 guid[16];
279 __u32 fcc;
280};
281
282/* The term 'entity' refers to both UVC units and UVC terminals.
283 *
284 * The type field is either the terminal type (wTerminalType in the terminal
285 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
286 * As the bDescriptorSubtype field is one byte long, the type value will
287 * always have a null MSB for units. All terminal types defined by the UVC
288 * specification have a non-null MSB, so it is safe to use the MSB to
289 * differentiate between units and terminals as long as the descriptor parsing
290 * code makes sure terminal types have a non-null MSB.
291 *
292 * For terminals, the type's most significant bit stores the terminal
293 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
294 * always be accessed with the UVC_ENTITY_* macros and never directly.
295 */
296
297struct uvc_entity {
298 struct list_head list; /* Entity as part of a UVC device. */
299 struct list_head chain; /* Entity as part of a video device
300 * chain. */
301 __u8 id;
302 __u16 type;
303 char name[64];
304
305 union {
306 struct {
307 __u16 wObjectiveFocalLengthMin;
308 __u16 wObjectiveFocalLengthMax;
309 __u16 wOcularFocalLength;
310 __u8 bControlSize;
311 __u8 *bmControls;
312 } camera;
313
314 struct {
315 __u8 bControlSize;
316 __u8 *bmControls;
317 __u8 bTransportModeSize;
318 __u8 *bmTransportModes;
319 } media;
320
321 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300322 } output;
323
324 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300325 __u16 wMaxMultiplier;
326 __u8 bControlSize;
327 __u8 *bmControls;
328 __u8 bmVideoStandards;
329 } processing;
330
331 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300332 } selector;
333
334 struct {
335 __u8 guidExtensionCode[16];
336 __u8 bNumControls;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300337 __u8 bControlSize;
338 __u8 *bmControls;
339 __u8 *bmControlsType;
340 } extension;
341 };
342
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300343 __u8 bNrInPins;
344 __u8 *baSourceID;
345
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300346 unsigned int ncontrols;
347 struct uvc_control *controls;
348};
349
350struct uvc_frame {
351 __u8 bFrameIndex;
352 __u8 bmCapabilities;
353 __u16 wWidth;
354 __u16 wHeight;
355 __u32 dwMinBitRate;
356 __u32 dwMaxBitRate;
357 __u32 dwMaxVideoFrameBufferSize;
358 __u8 bFrameIntervalType;
359 __u32 dwDefaultFrameInterval;
360 __u32 *dwFrameInterval;
361};
362
363struct uvc_format {
364 __u8 type;
365 __u8 index;
366 __u8 bpp;
367 __u8 colorspace;
368 __u32 fcc;
369 __u32 flags;
370
371 char name[32];
372
373 unsigned int nframes;
374 struct uvc_frame *frame;
375};
376
377struct uvc_streaming_header {
378 __u8 bNumFormats;
379 __u8 bEndpointAddress;
380 __u8 bTerminalLink;
381 __u8 bControlSize;
382 __u8 *bmaControls;
383 /* The following fields are used by input headers only. */
384 __u8 bmInfo;
385 __u8 bStillCaptureMethod;
386 __u8 bTriggerSupport;
387 __u8 bTriggerUsage;
388};
389
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300390enum uvc_buffer_state {
Laurent Pinchart2c2d2642009-01-03 19:12:40 -0300391 UVC_BUF_STATE_IDLE = 0,
392 UVC_BUF_STATE_QUEUED = 1,
393 UVC_BUF_STATE_ACTIVE = 2,
Laurent Pinchartd7c0d432009-12-16 21:20:45 -0300394 UVC_BUF_STATE_READY = 3,
395 UVC_BUF_STATE_DONE = 4,
396 UVC_BUF_STATE_ERROR = 5,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300397};
398
399struct uvc_buffer {
400 unsigned long vma_use_count;
401 struct list_head stream;
402
403 /* Touched by interrupt handler. */
404 struct v4l2_buffer buf;
405 struct list_head queue;
406 wait_queue_head_t wait;
407 enum uvc_buffer_state state;
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300408 unsigned int error;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300409};
410
411#define UVC_QUEUE_STREAMING (1 << 0)
412#define UVC_QUEUE_DISCONNECTED (1 << 1)
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300413#define UVC_QUEUE_DROP_CORRUPTED (1 << 2)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300414
415struct uvc_video_queue {
Laurent Pinchartff924202008-12-28 22:32:29 -0300416 enum v4l2_buf_type type;
417
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300418 void *mem;
419 unsigned int flags;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300420
421 unsigned int count;
422 unsigned int buf_size;
Laurent Pinchartff924202008-12-28 22:32:29 -0300423 unsigned int buf_used;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300424 struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
425 struct mutex mutex; /* protects buffers and mainqueue */
426 spinlock_t irqlock; /* protects irqqueue */
427
428 struct list_head mainqueue;
429 struct list_head irqqueue;
430};
431
Laurent Pinchart8e113592009-07-01 20:24:47 -0300432struct uvc_video_chain {
433 struct uvc_device *dev;
434 struct list_head list;
435
Laurent Pinchart6241d8c2009-11-25 12:00:22 -0300436 struct list_head entities; /* All entities */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300437 struct uvc_entity *processing; /* Processing unit */
438 struct uvc_entity *selector; /* Selector unit */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300439
Laurent Pinchart27a61c12010-10-02 09:04:53 -0300440 struct mutex ctrl_mutex; /* Protects ctrl.info */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300441};
442
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300443struct uvc_streaming {
444 struct list_head list;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300445 struct uvc_device *dev;
446 struct video_device *vdev;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300447 struct uvc_video_chain *chain;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300448 atomic_t active;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300449
450 struct usb_interface *intf;
451 int intfnum;
452 __u16 maxpsize;
453
454 struct uvc_streaming_header header;
455 enum v4l2_buf_type type;
456
457 unsigned int nformats;
458 struct uvc_format *format;
459
460 struct uvc_streaming_control ctrl;
461 struct uvc_format *cur_format;
462 struct uvc_frame *cur_frame;
Laurent Pinchart69477562010-11-21 13:36:34 -0300463 /* Protect access to ctrl, cur_format, cur_frame and hardware video
464 * probe control.
465 */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300466 struct mutex mutex;
467
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300468 unsigned int frozen : 1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300469 struct uvc_video_queue queue;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300470 void (*decode) (struct urb *urb, struct uvc_streaming *video,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300471 struct uvc_buffer *buf);
472
473 /* Context data used by the bulk completion handler. */
474 struct {
475 __u8 header[256];
476 unsigned int header_size;
477 int skip_payload;
478 __u32 payload_size;
479 __u32 max_payload_size;
480 } bulk;
481
482 struct urb *urb[UVC_URBS];
483 char *urb_buffer[UVC_URBS];
Laurent Pincharte01117c2008-07-04 00:36:21 -0300484 dma_addr_t urb_dma[UVC_URBS];
485 unsigned int urb_size;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300486
Laurent Pinchart650b95f2010-10-02 11:06:05 -0300487 __u32 sequence;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300488 __u8 last_fid;
489};
490
491enum uvc_device_state {
492 UVC_DEV_DISCONNECTED = 1,
493};
494
495struct uvc_device {
496 struct usb_device *udev;
497 struct usb_interface *intf;
Laurent Pinchart44f00792008-11-08 19:14:50 -0300498 unsigned long warnings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300499 __u32 quirks;
500 int intfnum;
501 char name[32];
502
503 enum uvc_device_state state;
Laurent Pinchart04a37e02009-05-19 10:08:03 -0300504 atomic_t users;
Martin Rubli8fb91b32010-09-08 04:15:23 -0300505 atomic_t nmappings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300506
507 /* Video control interface */
508 __u16 uvc_version;
509 __u32 clock_frequency;
510
511 struct list_head entities;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300512 struct list_head chains;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300513
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300514 /* Video Streaming interfaces */
515 struct list_head streams;
Laurent Pinchart716fdee2009-09-29 21:07:19 -0300516 atomic_t nstreams;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300517
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300518 /* Status Interrupt Endpoint */
519 struct usb_host_endpoint *int_ep;
520 struct urb *int_urb;
Ming Leia31a4052008-09-16 03:32:20 -0300521 __u8 *status;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300522 struct input_dev *input;
Laurent Pinchartf1801522009-01-22 12:45:10 -0300523 char input_phys[64];
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300524};
525
526enum uvc_handle_state {
527 UVC_HANDLE_PASSIVE = 0,
528 UVC_HANDLE_ACTIVE = 1,
529};
530
531struct uvc_fh {
Laurent Pinchart8e113592009-07-01 20:24:47 -0300532 struct uvc_video_chain *chain;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300533 struct uvc_streaming *stream;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300534 enum uvc_handle_state state;
535};
536
537struct uvc_driver {
538 struct usb_driver driver;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300539};
540
541/* ------------------------------------------------------------------------
542 * Debugging, printing and logging
543 */
544
545#define UVC_TRACE_PROBE (1 << 0)
546#define UVC_TRACE_DESCR (1 << 1)
547#define UVC_TRACE_CONTROL (1 << 2)
548#define UVC_TRACE_FORMAT (1 << 3)
549#define UVC_TRACE_CAPTURE (1 << 4)
550#define UVC_TRACE_CALLS (1 << 5)
551#define UVC_TRACE_IOCTL (1 << 6)
552#define UVC_TRACE_FRAME (1 << 7)
553#define UVC_TRACE_SUSPEND (1 << 8)
554#define UVC_TRACE_STATUS (1 << 9)
Laurent Pinchart663a4192009-08-06 11:41:17 -0300555#define UVC_TRACE_VIDEO (1 << 10)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300556
Laurent Pinchart44f00792008-11-08 19:14:50 -0300557#define UVC_WARN_MINMAX 0
558#define UVC_WARN_PROBE_DEF 1
559
Laurent Pinchart310fe522009-12-09 22:57:48 -0300560extern unsigned int uvc_clock_param;
Laurent Pinchart0fbd8ee2008-12-06 16:25:14 -0300561extern unsigned int uvc_no_drop_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300562extern unsigned int uvc_trace_param;
Laurent Pinchartb232a012009-10-09 20:55:23 -0300563extern unsigned int uvc_timeout_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300564
565#define uvc_trace(flag, msg...) \
566 do { \
567 if (uvc_trace_param & flag) \
568 printk(KERN_DEBUG "uvcvideo: " msg); \
569 } while (0)
570
Laurent Pinchart44f00792008-11-08 19:14:50 -0300571#define uvc_warn_once(dev, warn, msg...) \
572 do { \
573 if (!test_and_set_bit(warn, &dev->warnings)) \
574 printk(KERN_INFO "uvcvideo: " msg); \
575 } while (0)
576
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300577#define uvc_printk(level, msg...) \
578 printk(level "uvcvideo: " msg)
579
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300580/* --------------------------------------------------------------------------
581 * Internal functions.
582 */
583
584/* Core driver */
585extern struct uvc_driver uvc_driver;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300586
587/* Video buffers queue management. */
Laurent Pinchartff924202008-12-28 22:32:29 -0300588extern void uvc_queue_init(struct uvc_video_queue *queue,
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300589 enum v4l2_buf_type type, int drop_corrupted);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300590extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
591 unsigned int nbuffers, unsigned int buflength);
592extern int uvc_free_buffers(struct uvc_video_queue *queue);
593extern int uvc_query_buffer(struct uvc_video_queue *queue,
594 struct v4l2_buffer *v4l2_buf);
595extern int uvc_queue_buffer(struct uvc_video_queue *queue,
596 struct v4l2_buffer *v4l2_buf);
597extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
598 struct v4l2_buffer *v4l2_buf, int nonblocking);
599extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
600extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
601extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
602 struct uvc_buffer *buf);
Laurent Pinchart4aa27592010-11-21 15:18:08 -0300603extern int uvc_queue_mmap(struct uvc_video_queue *queue,
604 struct vm_area_struct *vma);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300605extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
606 struct file *file, poll_table *wait);
Laurent Pinchart23ff6042009-06-04 09:26:39 -0300607extern int uvc_queue_allocated(struct uvc_video_queue *queue);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300608static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
609{
610 return queue->flags & UVC_QUEUE_STREAMING;
611}
612
613/* V4L2 interface */
Hans Verkuilbec43662008-12-30 06:58:20 -0300614extern const struct v4l2_file_operations uvc_fops;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300615
616/* Video */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300617extern int uvc_video_init(struct uvc_streaming *stream);
618extern int uvc_video_suspend(struct uvc_streaming *stream);
619extern int uvc_video_resume(struct uvc_streaming *stream);
620extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
621extern int uvc_probe_video(struct uvc_streaming *stream,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300622 struct uvc_streaming_control *probe);
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300623extern int uvc_commit_video(struct uvc_streaming *stream,
Laurent Pinchart44f00792008-11-08 19:14:50 -0300624 struct uvc_streaming_control *ctrl);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300625extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
626 __u8 intfnum, __u8 cs, void *data, __u16 size);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300627
628/* Status */
629extern int uvc_status_init(struct uvc_device *dev);
630extern void uvc_status_cleanup(struct uvc_device *dev);
Laurent Pinchart04a37e02009-05-19 10:08:03 -0300631extern int uvc_status_start(struct uvc_device *dev);
632extern void uvc_status_stop(struct uvc_device *dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300633extern int uvc_status_suspend(struct uvc_device *dev);
634extern int uvc_status_resume(struct uvc_device *dev);
635
636/* Controls */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300637extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300638 struct v4l2_queryctrl *v4l2_ctrl);
Laurent Pinchart23d9f3e2010-11-21 07:58:54 -0300639extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
640 struct v4l2_querymenu *query_menu);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300641
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300642extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
643 const struct uvc_control_mapping *mapping);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300644extern int uvc_ctrl_init_device(struct uvc_device *dev);
645extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
646extern int uvc_ctrl_resume_device(struct uvc_device *dev);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300647
Laurent Pinchart8e113592009-07-01 20:24:47 -0300648extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
649extern int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback);
650static inline int uvc_ctrl_commit(struct uvc_video_chain *chain)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300651{
Laurent Pinchart8e113592009-07-01 20:24:47 -0300652 return __uvc_ctrl_commit(chain, 0);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300653}
Laurent Pinchart8e113592009-07-01 20:24:47 -0300654static inline int uvc_ctrl_rollback(struct uvc_video_chain *chain)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300655{
Laurent Pinchart8e113592009-07-01 20:24:47 -0300656 return __uvc_ctrl_commit(chain, 1);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300657}
658
Laurent Pinchart8e113592009-07-01 20:24:47 -0300659extern int uvc_ctrl_get(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300660 struct v4l2_ext_control *xctrl);
Laurent Pinchart8e113592009-07-01 20:24:47 -0300661extern int uvc_ctrl_set(struct uvc_video_chain *chain,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300662 struct v4l2_ext_control *xctrl);
663
Laurent Pinchart8e113592009-07-01 20:24:47 -0300664extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
Martin Rublife78d182010-10-02 19:10:16 -0300665 struct uvc_xu_control_query *xqry);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300666
667/* Utility functions */
668extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
669 unsigned int n_terms, unsigned int threshold);
670extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
671 uint32_t denominator);
672extern struct usb_host_endpoint *uvc_find_endpoint(
673 struct usb_host_interface *alts, __u8 epaddr);
674
675/* Quirks support */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300676void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300677 struct uvc_buffer *buf);
678
679#endif /* __KERNEL__ */
680
681#endif
Hans Verkuilf87086e2008-07-18 00:50:58 -0300682