blob: 7cf224bae2e527eb2d14a3baf53f6d31168d241c [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 Pinchart5f708812010-11-21 17:15:44 -03007#ifndef __KERNEL__
8/*
9 * This header provides binary compatibility with applications using the private
10 * uvcvideo API. This API is deprecated and will be removed in 2.6.42.
11 * Applications should be recompiled against the public linux/uvcvideo.h header.
12 */
13#warn "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
14
Laurent Pinchartc0efd232008-06-30 15:04:50 -030015/*
16 * Dynamic controls
17 */
18
19/* Data types for UVC control data */
20#define UVC_CTRL_DATA_TYPE_RAW 0
21#define UVC_CTRL_DATA_TYPE_SIGNED 1
22#define UVC_CTRL_DATA_TYPE_UNSIGNED 2
23#define UVC_CTRL_DATA_TYPE_BOOLEAN 3
24#define UVC_CTRL_DATA_TYPE_ENUM 4
25#define UVC_CTRL_DATA_TYPE_BITMASK 5
26
27/* Control flags */
28#define UVC_CONTROL_SET_CUR (1 << 0)
29#define UVC_CONTROL_GET_CUR (1 << 1)
30#define UVC_CONTROL_GET_MIN (1 << 2)
31#define UVC_CONTROL_GET_MAX (1 << 3)
32#define UVC_CONTROL_GET_RES (1 << 4)
33#define UVC_CONTROL_GET_DEF (1 << 5)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030034#define UVC_CONTROL_RESTORE (1 << 6)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030035#define UVC_CONTROL_AUTO_UPDATE (1 << 7)
36
37#define UVC_CONTROL_GET_RANGE (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
38 UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
39 UVC_CONTROL_GET_DEF)
40
Laurent Pinchart561474c2010-02-18 16:38:52 -030041struct uvc_menu_info {
42 __u32 value;
43 __u8 name[32];
44};
45
Laurent Pinchartc0efd232008-06-30 15:04:50 -030046struct uvc_xu_control_mapping {
47 __u32 id;
48 __u8 name[32];
49 __u8 entity[16];
50 __u8 selector;
51
52 __u8 size;
53 __u8 offset;
Martin Rublife78d182010-10-02 19:10:16 -030054 __u32 v4l2_type;
Laurent Pinchartc0efd232008-06-30 15:04:50 -030055 __u32 data_type;
Laurent Pinchart561474c2010-02-18 16:38:52 -030056
57 struct uvc_menu_info __user *menu_info;
58 __u32 menu_count;
59
60 __u32 reserved[4];
Laurent Pinchartc0efd232008-06-30 15:04:50 -030061};
62
Laurent Pinchart5f708812010-11-21 17:15:44 -030063#endif
64
65struct uvc_xu_control_info {
66 __u8 entity[16];
67 __u8 index;
68 __u8 selector;
69 __u16 size;
70 __u32 flags;
71};
72
73struct uvc_xu_control_mapping_old {
74 __u8 reserved[64];
75};
76
Laurent Pinchartc0efd232008-06-30 15:04:50 -030077struct uvc_xu_control {
78 __u8 unit;
79 __u8 selector;
80 __u16 size;
81 __u8 __user *data;
82};
83
Laurent Pinchart5f708812010-11-21 17:15:44 -030084#ifndef __KERNEL__
Laurent Pinchartc0efd232008-06-30 15:04:50 -030085#define UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
Laurent Pinchart561474c2010-02-18 16:38:52 -030086#define UVCIOC_CTRL_MAP_OLD _IOWR('U', 2, struct uvc_xu_control_mapping_old)
Laurent Pinchartc0efd232008-06-30 15:04:50 -030087#define UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
88#define UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
89#define UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
Laurent Pinchart5f708812010-11-21 17:15:44 -030090#else
91#define __UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
92#define __UVCIOC_CTRL_MAP_OLD _IOWR('U', 2, struct uvc_xu_control_mapping_old)
93#define __UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
94#define __UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
95#define __UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
96#endif
Laurent Pinchartc0efd232008-06-30 15:04:50 -030097
98#ifdef __KERNEL__
99
100#include <linux/poll.h>
Laurent Pinchartde05f632009-06-26 12:15:38 -0300101#include <linux/usb/video.h>
Laurent Pinchart5f708812010-11-21 17:15:44 -0300102#include <linux/uvcvideo.h>
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300103
104/* --------------------------------------------------------------------------
105 * UVC constants
106 */
107
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300108#define UVC_TERM_INPUT 0x0000
109#define UVC_TERM_OUTPUT 0x8000
Laurent Pinchart6241d8c2009-11-25 12:00:22 -0300110#define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300111
112#define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
113#define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
114#define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
115#define UVC_ENTITY_IS_ITERM(entity) \
Laurent Pinchart8e113592009-07-01 20:24:47 -0300116 (UVC_ENTITY_IS_TERM(entity) && \
117 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300118#define UVC_ENTITY_IS_OTERM(entity) \
Laurent Pinchart8e113592009-07-01 20:24:47 -0300119 (UVC_ENTITY_IS_TERM(entity) && \
120 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300121
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300122
123/* ------------------------------------------------------------------------
124 * GUIDs
125 */
126#define UVC_GUID_UVC_CAMERA \
127 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
128 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
129#define UVC_GUID_UVC_OUTPUT \
130 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
131 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
132#define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
133 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
134 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
135#define UVC_GUID_UVC_PROCESSING \
136 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
137 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
138#define UVC_GUID_UVC_SELECTOR \
139 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
140 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
141
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300142#define UVC_GUID_FORMAT_MJPEG \
143 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
144 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
145#define UVC_GUID_FORMAT_YUY2 \
146 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
147 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Daniel Ritz68f194e2009-12-12 14:57:17 -0300148#define UVC_GUID_FORMAT_YUY2_ISIGHT \
149 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
150 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300151#define UVC_GUID_FORMAT_NV12 \
152 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
153 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
154#define UVC_GUID_FORMAT_YV12 \
155 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
156 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
157#define UVC_GUID_FORMAT_I420 \
158 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
159 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
160#define UVC_GUID_FORMAT_UYVY \
161 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
162 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
163#define UVC_GUID_FORMAT_Y800 \
164 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
165 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchart614212062010-04-12 10:41:22 -0300166#define UVC_GUID_FORMAT_Y16 \
167 { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
168 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300169#define UVC_GUID_FORMAT_BY8 \
170 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
171 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchart50791072011-03-06 08:32:04 -0300172#define UVC_GUID_FORMAT_RGBP \
173 { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
174 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Hans de Goede7225a1d2011-05-11 09:56:20 -0300175#define UVC_GUID_FORMAT_M420 \
176 { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
177 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300178
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300179/* ------------------------------------------------------------------------
180 * Driver specific constants.
181 */
182
Laurent Pinchart5f708812010-11-21 17:15:44 -0300183#define DRIVER_VERSION_NUMBER KERNEL_VERSION(1, 1, 0)
184#define DRIVER_VERSION "v1.1.0"
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300185
186/* Number of isochronous URBs. */
187#define UVC_URBS 5
Laurent Pinchartefdc8a92009-01-18 17:46:30 -0300188/* Maximum number of packets per URB. */
189#define UVC_MAX_PACKETS 32
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300190/* Maximum number of video buffers. */
191#define UVC_MAX_VIDEO_BUFFERS 32
Ming Leia31a4052008-09-16 03:32:20 -0300192/* Maximum status buffer size in bytes of interrupt URB. */
193#define UVC_MAX_STATUS_SIZE 16
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300194
195#define UVC_CTRL_CONTROL_TIMEOUT 300
Laurent Pinchart56d15cd2010-01-19 08:59:21 -0300196#define UVC_CTRL_STREAMING_TIMEOUT 5000
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300197
Martin Rubli8fb91b32010-09-08 04:15:23 -0300198/* Maximum allowed number of control mappings per device */
199#define UVC_MAX_CONTROL_MAPPINGS 1024
200
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300201/* Devices quirks */
202#define UVC_QUIRK_STATUS_INTERVAL 0x00000001
203#define UVC_QUIRK_PROBE_MINMAX 0x00000002
204#define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
205#define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
206#define UVC_QUIRK_STREAM_NO_FID 0x00000010
207#define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
Laurent Pinchart50144ae2009-02-16 17:41:52 -0300208#define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
Laurent Pinchartbab6f662009-07-19 18:39:56 -0300209#define UVC_QUIRK_PROBE_DEF 0x00000100
Laurent Pinchart86d8b6a2010-09-16 12:37:26 -0300210#define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300211
212/* Format flags */
213#define UVC_FMT_FLAG_COMPRESSED 0x00000001
214#define UVC_FMT_FLAG_STREAM 0x00000002
215
216/* ------------------------------------------------------------------------
217 * Structures.
218 */
219
220struct uvc_device;
221
222/* TODO: Put the most frequently accessed fields at the beginning of
223 * structures to maximize cache efficiency.
224 */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300225struct uvc_control_info {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300226 struct list_head mappings;
227
228 __u8 entity[16];
Laurent Pinchartba2fa992010-09-20 05:53:21 -0300229 __u8 index; /* Bit index in bmControls */
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300230 __u8 selector;
231
232 __u16 size;
233 __u32 flags;
234};
235
236struct uvc_control_mapping {
237 struct list_head list;
238
239 struct uvc_control_info *ctrl;
240
241 __u32 id;
242 __u8 name[32];
243 __u8 entity[16];
244 __u8 selector;
245
246 __u8 size;
247 __u8 offset;
248 enum v4l2_ctrl_type v4l2_type;
249 __u32 data_type;
250
251 struct uvc_menu_info *menu_info;
252 __u32 menu_count;
Laurent Pinchart97683522008-12-16 06:46:32 -0300253
254 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
255 const __u8 *data);
256 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
257 __u8 *data);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300258};
259
260struct uvc_control {
261 struct uvc_entity *entity;
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300262 struct uvc_control_info info;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300263
264 __u8 index; /* Used to match the uvc_control entry with a
265 uvc_control_info. */
Laurent Pinchart071c8bb2010-09-29 16:00:08 -0300266 __u8 dirty:1,
267 loaded:1,
268 modified:1,
269 cached:1,
270 initialized:1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300271
Laurent Pinchartb30ece52010-06-18 11:31:24 -0300272 __u8 *uvc_data;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300273};
274
275struct uvc_format_desc {
276 char *name;
277 __u8 guid[16];
278 __u32 fcc;
279};
280
281/* The term 'entity' refers to both UVC units and UVC terminals.
282 *
283 * The type field is either the terminal type (wTerminalType in the terminal
284 * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
285 * As the bDescriptorSubtype field is one byte long, the type value will
286 * always have a null MSB for units. All terminal types defined by the UVC
287 * specification have a non-null MSB, so it is safe to use the MSB to
288 * differentiate between units and terminals as long as the descriptor parsing
289 * code makes sure terminal types have a non-null MSB.
290 *
291 * For terminals, the type's most significant bit stores the terminal
292 * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
293 * always be accessed with the UVC_ENTITY_* macros and never directly.
294 */
295
296struct uvc_entity {
297 struct list_head list; /* Entity as part of a UVC device. */
298 struct list_head chain; /* Entity as part of a video device
299 * chain. */
300 __u8 id;
301 __u16 type;
302 char name[64];
303
304 union {
305 struct {
306 __u16 wObjectiveFocalLengthMin;
307 __u16 wObjectiveFocalLengthMax;
308 __u16 wOcularFocalLength;
309 __u8 bControlSize;
310 __u8 *bmControls;
311 } camera;
312
313 struct {
314 __u8 bControlSize;
315 __u8 *bmControls;
316 __u8 bTransportModeSize;
317 __u8 *bmTransportModes;
318 } media;
319
320 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300321 } output;
322
323 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300324 __u16 wMaxMultiplier;
325 __u8 bControlSize;
326 __u8 *bmControls;
327 __u8 bmVideoStandards;
328 } processing;
329
330 struct {
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300331 } selector;
332
333 struct {
334 __u8 guidExtensionCode[16];
335 __u8 bNumControls;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300336 __u8 bControlSize;
337 __u8 *bmControls;
338 __u8 *bmControlsType;
339 } extension;
340 };
341
Laurent Pinchart8ca5a632009-11-25 12:00:30 -0300342 __u8 bNrInPins;
343 __u8 *baSourceID;
344
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300345 unsigned int ncontrols;
346 struct uvc_control *controls;
347};
348
349struct uvc_frame {
350 __u8 bFrameIndex;
351 __u8 bmCapabilities;
352 __u16 wWidth;
353 __u16 wHeight;
354 __u32 dwMinBitRate;
355 __u32 dwMaxBitRate;
356 __u32 dwMaxVideoFrameBufferSize;
357 __u8 bFrameIntervalType;
358 __u32 dwDefaultFrameInterval;
359 __u32 *dwFrameInterval;
360};
361
362struct uvc_format {
363 __u8 type;
364 __u8 index;
365 __u8 bpp;
366 __u8 colorspace;
367 __u32 fcc;
368 __u32 flags;
369
370 char name[32];
371
372 unsigned int nframes;
373 struct uvc_frame *frame;
374};
375
376struct uvc_streaming_header {
377 __u8 bNumFormats;
378 __u8 bEndpointAddress;
379 __u8 bTerminalLink;
380 __u8 bControlSize;
381 __u8 *bmaControls;
382 /* The following fields are used by input headers only. */
383 __u8 bmInfo;
384 __u8 bStillCaptureMethod;
385 __u8 bTriggerSupport;
386 __u8 bTriggerUsage;
387};
388
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300389enum uvc_buffer_state {
Laurent Pinchart2c2d2642009-01-03 19:12:40 -0300390 UVC_BUF_STATE_IDLE = 0,
391 UVC_BUF_STATE_QUEUED = 1,
392 UVC_BUF_STATE_ACTIVE = 2,
Laurent Pinchartd7c0d432009-12-16 21:20:45 -0300393 UVC_BUF_STATE_READY = 3,
394 UVC_BUF_STATE_DONE = 4,
395 UVC_BUF_STATE_ERROR = 5,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300396};
397
398struct uvc_buffer {
399 unsigned long vma_use_count;
400 struct list_head stream;
401
402 /* Touched by interrupt handler. */
403 struct v4l2_buffer buf;
404 struct list_head queue;
405 wait_queue_head_t wait;
406 enum uvc_buffer_state state;
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300407 unsigned int error;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300408};
409
410#define UVC_QUEUE_STREAMING (1 << 0)
411#define UVC_QUEUE_DISCONNECTED (1 << 1)
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300412#define UVC_QUEUE_DROP_CORRUPTED (1 << 2)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300413
414struct uvc_video_queue {
Laurent Pinchartff924202008-12-28 22:32:29 -0300415 enum v4l2_buf_type type;
416
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300417 void *mem;
418 unsigned int flags;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300419
420 unsigned int count;
421 unsigned int buf_size;
Laurent Pinchartff924202008-12-28 22:32:29 -0300422 unsigned int buf_used;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300423 struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
424 struct mutex mutex; /* protects buffers and mainqueue */
425 spinlock_t irqlock; /* protects irqqueue */
426
427 struct list_head mainqueue;
428 struct list_head irqqueue;
429};
430
Laurent Pinchart8e113592009-07-01 20:24:47 -0300431struct uvc_video_chain {
432 struct uvc_device *dev;
433 struct list_head list;
434
Laurent Pinchart6241d8c2009-11-25 12:00:22 -0300435 struct list_head entities; /* All entities */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300436 struct uvc_entity *processing; /* Processing unit */
437 struct uvc_entity *selector; /* Selector unit */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300438
Laurent Pinchart27a61c12010-10-02 09:04:53 -0300439 struct mutex ctrl_mutex; /* Protects ctrl.info */
Laurent Pinchart8e113592009-07-01 20:24:47 -0300440};
441
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300442struct uvc_streaming {
443 struct list_head list;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300444 struct uvc_device *dev;
445 struct video_device *vdev;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300446 struct uvc_video_chain *chain;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300447 atomic_t active;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300448
449 struct usb_interface *intf;
450 int intfnum;
451 __u16 maxpsize;
452
453 struct uvc_streaming_header header;
454 enum v4l2_buf_type type;
455
456 unsigned int nformats;
457 struct uvc_format *format;
458
459 struct uvc_streaming_control ctrl;
460 struct uvc_format *cur_format;
461 struct uvc_frame *cur_frame;
Laurent Pinchart69477562010-11-21 13:36:34 -0300462 /* Protect access to ctrl, cur_format, cur_frame and hardware video
463 * probe control.
464 */
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300465 struct mutex mutex;
466
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300467 unsigned int frozen : 1;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300468 struct uvc_video_queue queue;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300469 void (*decode) (struct urb *urb, struct uvc_streaming *video,
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300470 struct uvc_buffer *buf);
471
472 /* Context data used by the bulk completion handler. */
473 struct {
474 __u8 header[256];
475 unsigned int header_size;
476 int skip_payload;
477 __u32 payload_size;
478 __u32 max_payload_size;
479 } bulk;
480
481 struct urb *urb[UVC_URBS];
482 char *urb_buffer[UVC_URBS];
Laurent Pincharte01117c2008-07-04 00:36:21 -0300483 dma_addr_t urb_dma[UVC_URBS];
484 unsigned int urb_size;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300485
Laurent Pinchart650b95f2010-10-02 11:06:05 -0300486 __u32 sequence;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300487 __u8 last_fid;
488};
489
490enum uvc_device_state {
491 UVC_DEV_DISCONNECTED = 1,
492};
493
494struct uvc_device {
495 struct usb_device *udev;
496 struct usb_interface *intf;
Laurent Pinchart44f00792008-11-08 19:14:50 -0300497 unsigned long warnings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300498 __u32 quirks;
499 int intfnum;
500 char name[32];
501
502 enum uvc_device_state state;
Laurent Pinchart04a37e02009-05-19 10:08:03 -0300503 atomic_t users;
Martin Rubli8fb91b32010-09-08 04:15:23 -0300504 atomic_t nmappings;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300505
506 /* Video control interface */
507 __u16 uvc_version;
508 __u32 clock_frequency;
509
510 struct list_head entities;
Laurent Pinchart8e113592009-07-01 20:24:47 -0300511 struct list_head chains;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300512
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300513 /* Video Streaming interfaces */
514 struct list_head streams;
Laurent Pinchart716fdee2009-09-29 21:07:19 -0300515 atomic_t nstreams;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300516
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300517 /* Status Interrupt Endpoint */
518 struct usb_host_endpoint *int_ep;
519 struct urb *int_urb;
Ming Leia31a4052008-09-16 03:32:20 -0300520 __u8 *status;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300521 struct input_dev *input;
Laurent Pinchartf1801522009-01-22 12:45:10 -0300522 char input_phys[64];
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300523};
524
525enum uvc_handle_state {
526 UVC_HANDLE_PASSIVE = 0,
527 UVC_HANDLE_ACTIVE = 1,
528};
529
530struct uvc_fh {
Laurent Pinchart8e113592009-07-01 20:24:47 -0300531 struct uvc_video_chain *chain;
Laurent Pinchart35f02a62009-06-28 08:37:50 -0300532 struct uvc_streaming *stream;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300533 enum uvc_handle_state state;
534};
535
536struct uvc_driver {
537 struct usb_driver driver;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300538};
539
540/* ------------------------------------------------------------------------
541 * Debugging, printing and logging
542 */
543
544#define UVC_TRACE_PROBE (1 << 0)
545#define UVC_TRACE_DESCR (1 << 1)
546#define UVC_TRACE_CONTROL (1 << 2)
547#define UVC_TRACE_FORMAT (1 << 3)
548#define UVC_TRACE_CAPTURE (1 << 4)
549#define UVC_TRACE_CALLS (1 << 5)
550#define UVC_TRACE_IOCTL (1 << 6)
551#define UVC_TRACE_FRAME (1 << 7)
552#define UVC_TRACE_SUSPEND (1 << 8)
553#define UVC_TRACE_STATUS (1 << 9)
Laurent Pinchart663a4192009-08-06 11:41:17 -0300554#define UVC_TRACE_VIDEO (1 << 10)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300555
Laurent Pinchart44f00792008-11-08 19:14:50 -0300556#define UVC_WARN_MINMAX 0
557#define UVC_WARN_PROBE_DEF 1
558
Laurent Pinchart310fe522009-12-09 22:57:48 -0300559extern unsigned int uvc_clock_param;
Laurent Pinchart0fbd8ee2008-12-06 16:25:14 -0300560extern unsigned int uvc_no_drop_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300561extern unsigned int uvc_trace_param;
Laurent Pinchartb232a012009-10-09 20:55:23 -0300562extern unsigned int uvc_timeout_param;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300563
564#define uvc_trace(flag, msg...) \
565 do { \
566 if (uvc_trace_param & flag) \
567 printk(KERN_DEBUG "uvcvideo: " msg); \
568 } while (0)
569
Laurent Pinchart44f00792008-11-08 19:14:50 -0300570#define uvc_warn_once(dev, warn, msg...) \
571 do { \
572 if (!test_and_set_bit(warn, &dev->warnings)) \
573 printk(KERN_INFO "uvcvideo: " msg); \
574 } while (0)
575
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300576#define uvc_printk(level, msg...) \
577 printk(level "uvcvideo: " msg)
578
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300579/* --------------------------------------------------------------------------
580 * Internal functions.
581 */
582
583/* Core driver */
584extern struct uvc_driver uvc_driver;
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300585
586/* Video buffers queue management. */
Laurent Pinchartff924202008-12-28 22:32:29 -0300587extern void uvc_queue_init(struct uvc_video_queue *queue,
Laurent Pinchart9bde9f22010-06-17 06:52:37 -0300588 enum v4l2_buf_type type, int drop_corrupted);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300589extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
590 unsigned int nbuffers, unsigned int buflength);
591extern int uvc_free_buffers(struct uvc_video_queue *queue);
592extern int uvc_query_buffer(struct uvc_video_queue *queue,
593 struct v4l2_buffer *v4l2_buf);
594extern int uvc_queue_buffer(struct uvc_video_queue *queue,
595 struct v4l2_buffer *v4l2_buf);
596extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
597 struct v4l2_buffer *v4l2_buf, int nonblocking);
598extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
599extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
600extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
601 struct uvc_buffer *buf);
Laurent Pinchart4aa27592010-11-21 15:18:08 -0300602extern int uvc_queue_mmap(struct uvc_video_queue *queue,
603 struct vm_area_struct *vma);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300604extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
605 struct file *file, poll_table *wait);
Bob Liu72969442011-04-29 07:11:35 -0300606#ifndef CONFIG_MMU
607extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
608 unsigned long pgoff);
609#endif
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