1#ifndef _USB_VIDEO_H_
2#define _USB_VIDEO_H_
3
4#include <linux/kernel.h>
5#include <linux/videodev2.h>
6
7
8
9
10
11
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
20#define UVC_CONTROL_SET_CUR (1 << 0)
21#define UVC_CONTROL_GET_CUR (1 << 1)
22#define UVC_CONTROL_GET_MIN (1 << 2)
23#define UVC_CONTROL_GET_MAX (1 << 3)
24#define UVC_CONTROL_GET_RES (1 << 4)
25#define UVC_CONTROL_GET_DEF (1 << 5)
26
27#define UVC_CONTROL_RESTORE (1 << 6)
28
29#define UVC_CONTROL_AUTO_UPDATE (1 << 7)
30
31#define UVC_CONTROL_GET_RANGE (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
32 UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
33 UVC_CONTROL_GET_DEF)
34
35struct uvc_xu_control_info {
36 __u8 entity[16];
37 __u8 index;
38 __u8 selector;
39 __u16 size;
40 __u32 flags;
41};
42
43struct uvc_xu_control_mapping {
44 __u32 id;
45 __u8 name[32];
46 __u8 entity[16];
47 __u8 selector;
48
49 __u8 size;
50 __u8 offset;
51 enum v4l2_ctrl_type v4l2_type;
52 __u32 data_type;
53};
54
55struct uvc_xu_control {
56 __u8 unit;
57 __u8 selector;
58 __u16 size;
59 __u8 __user *data;
60};
61
62#define UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
63#define UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
64#define UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
65#define UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
66
67#ifdef __KERNEL__
68
69#include <linux/poll.h>
70#include <linux/usb/video.h>
71
72
73
74
75
76#define UVC_TERM_INPUT 0x0000
77#define UVC_TERM_OUTPUT 0x8000
78
79#define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
80#define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
81#define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
82#define UVC_ENTITY_IS_ITERM(entity) \
83 (UVC_ENTITY_IS_TERM(entity) && \
84 ((entity)->type & 0x8000) == UVC_TERM_INPUT)
85#define UVC_ENTITY_IS_OTERM(entity) \
86 (UVC_ENTITY_IS_TERM(entity) && \
87 ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
88
89
90
91
92
93#define UVC_GUID_UVC_CAMERA \
94 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
95 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
96#define UVC_GUID_UVC_OUTPUT \
97 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
98 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
99#define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
100 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
101 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
102#define UVC_GUID_UVC_PROCESSING \
103 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
104 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
105#define UVC_GUID_UVC_SELECTOR \
106 {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
107 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
108
109#define UVC_GUID_FORMAT_MJPEG \
110 { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
111 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
112#define UVC_GUID_FORMAT_YUY2 \
113 { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
114 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
115#define UVC_GUID_FORMAT_NV12 \
116 { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
117 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
118#define UVC_GUID_FORMAT_YV12 \
119 { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
120 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
121#define UVC_GUID_FORMAT_I420 \
122 { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
123 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
124#define UVC_GUID_FORMAT_UYVY \
125 { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
126 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
127#define UVC_GUID_FORMAT_Y800 \
128 { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
129 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
130#define UVC_GUID_FORMAT_BY8 \
131 { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
132 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
133
134
135
136
137
138
139#define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
140
141
142#define UVC_URBS 5
143
144#define UVC_MAX_PACKETS 32
145
146#define UVC_MAX_VIDEO_BUFFERS 32
147
148#define UVC_MAX_STATUS_SIZE 16
149
150#define UVC_CTRL_CONTROL_TIMEOUT 300
151#define UVC_CTRL_STREAMING_TIMEOUT 1000
152
153
154#define UVC_QUIRK_STATUS_INTERVAL 0x00000001
155#define UVC_QUIRK_PROBE_MINMAX 0x00000002
156#define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
157#define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
158#define UVC_QUIRK_STREAM_NO_FID 0x00000010
159#define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
160#define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
161#define UVC_QUIRK_PROBE_DEF 0x00000100
162
163
164#define UVC_FMT_FLAG_COMPRESSED 0x00000001
165#define UVC_FMT_FLAG_STREAM 0x00000002
166
167
168
169
170
171struct uvc_device;
172
173
174
175
176struct uvc_streaming_control {
177 __u16 bmHint;
178 __u8 bFormatIndex;
179 __u8 bFrameIndex;
180 __u32 dwFrameInterval;
181 __u16 wKeyFrameRate;
182 __u16 wPFrameRate;
183 __u16 wCompQuality;
184 __u16 wCompWindowSize;
185 __u16 wDelay;
186 __u32 dwMaxVideoFrameSize;
187 __u32 dwMaxPayloadTransferSize;
188 __u32 dwClockFrequency;
189 __u8 bmFramingInfo;
190 __u8 bPreferedVersion;
191 __u8 bMinVersion;
192 __u8 bMaxVersion;
193};
194
195struct uvc_menu_info {
196 __u32 value;
197 __u8 name[32];
198};
199
200struct uvc_control_info {
201 struct list_head list;
202 struct list_head mappings;
203
204 __u8 entity[16];
205 __u8 index;
206 __u8 selector;
207
208 __u16 size;
209 __u32 flags;
210};
211
212struct uvc_control_mapping {
213 struct list_head list;
214
215 struct uvc_control_info *ctrl;
216
217 __u32 id;
218 __u8 name[32];
219 __u8 entity[16];
220 __u8 selector;
221
222 __u8 size;
223 __u8 offset;
224 enum v4l2_ctrl_type v4l2_type;
225 __u32 data_type;
226
227 struct uvc_menu_info *menu_info;
228 __u32 menu_count;
229
230 __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
231 const __u8 *data);
232 void (*set) (struct uvc_control_mapping *mapping, __s32 value,
233 __u8 *data);
234};
235
236struct uvc_control {
237 struct uvc_entity *entity;
238 struct uvc_control_info *info;
239
240 __u8 index;
241
242 __u8 dirty : 1,
243 loaded : 1,
244 modified : 1;
245
246 __u8 *data;
247};
248
249struct uvc_format_desc {
250 char *name;
251 __u8 guid[16];
252 __u32 fcc;
253};
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270struct uvc_entity {
271 struct list_head list;
272 struct list_head chain;
273
274 __u8 id;
275 __u16 type;
276 char name[64];
277
278 union {
279 struct {
280 __u16 wObjectiveFocalLengthMin;
281 __u16 wObjectiveFocalLengthMax;
282 __u16 wOcularFocalLength;
283 __u8 bControlSize;
284 __u8 *bmControls;
285 } camera;
286
287 struct {
288 __u8 bControlSize;
289 __u8 *bmControls;
290 __u8 bTransportModeSize;
291 __u8 *bmTransportModes;
292 } media;
293
294 struct {
295 __u8 bSourceID;
296 } output;
297
298 struct {
299 __u8 bSourceID;
300 __u16 wMaxMultiplier;
301 __u8 bControlSize;
302 __u8 *bmControls;
303 __u8 bmVideoStandards;
304 } processing;
305
306 struct {
307 __u8 bNrInPins;
308 __u8 *baSourceID;
309 } selector;
310
311 struct {
312 __u8 guidExtensionCode[16];
313 __u8 bNumControls;
314 __u8 bNrInPins;
315 __u8 *baSourceID;
316 __u8 bControlSize;
317 __u8 *bmControls;
318 __u8 *bmControlsType;
319 } extension;
320 };
321
322 unsigned int ncontrols;
323 struct uvc_control *controls;
324};
325
326struct uvc_frame {
327 __u8 bFrameIndex;
328 __u8 bmCapabilities;
329 __u16 wWidth;
330 __u16 wHeight;
331 __u32 dwMinBitRate;
332 __u32 dwMaxBitRate;
333 __u32 dwMaxVideoFrameBufferSize;
334 __u8 bFrameIntervalType;
335 __u32 dwDefaultFrameInterval;
336 __u32 *dwFrameInterval;
337};
338
339struct uvc_format {
340 __u8 type;
341 __u8 index;
342 __u8 bpp;
343 __u8 colorspace;
344 __u32 fcc;
345 __u32 flags;
346
347 char name[32];
348
349 unsigned int nframes;
350 struct uvc_frame *frame;
351};
352
353struct uvc_streaming_header {
354 __u8 bNumFormats;
355 __u8 bEndpointAddress;
356 __u8 bTerminalLink;
357 __u8 bControlSize;
358 __u8 *bmaControls;
359
360 __u8 bmInfo;
361 __u8 bStillCaptureMethod;
362 __u8 bTriggerSupport;
363 __u8 bTriggerUsage;
364};
365
366enum uvc_buffer_state {
367 UVC_BUF_STATE_IDLE = 0,
368 UVC_BUF_STATE_QUEUED = 1,
369 UVC_BUF_STATE_ACTIVE = 2,
370 UVC_BUF_STATE_DONE = 3,
371 UVC_BUF_STATE_ERROR = 4,
372};
373
374struct uvc_buffer {
375 unsigned long vma_use_count;
376 struct list_head stream;
377
378
379 struct v4l2_buffer buf;
380 struct list_head queue;
381 wait_queue_head_t wait;
382 enum uvc_buffer_state state;
383};
384
385#define UVC_QUEUE_STREAMING (1 << 0)
386#define UVC_QUEUE_DISCONNECTED (1 << 1)
387#define UVC_QUEUE_DROP_INCOMPLETE (1 << 2)
388
389struct uvc_video_queue {
390 enum v4l2_buf_type type;
391
392 void *mem;
393 unsigned int flags;
394 __u32 sequence;
395
396 unsigned int count;
397 unsigned int buf_size;
398 unsigned int buf_used;
399 struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
400 struct mutex mutex;
401 spinlock_t irqlock;
402
403 struct list_head mainqueue;
404 struct list_head irqqueue;
405};
406
407struct uvc_video_chain {
408 struct uvc_device *dev;
409 struct list_head list;
410
411 struct list_head iterms;
412 struct list_head oterms;
413 struct uvc_entity *processing;
414 struct uvc_entity *selector;
415 struct list_head extensions;
416
417 struct mutex ctrl_mutex;
418};
419
420struct uvc_streaming {
421 struct list_head list;
422 struct uvc_device *dev;
423 struct video_device *vdev;
424 struct uvc_video_chain *chain;
425 atomic_t active;
426
427 struct usb_interface *intf;
428 int intfnum;
429 __u16 maxpsize;
430
431 struct uvc_streaming_header header;
432 enum v4l2_buf_type type;
433
434 unsigned int nformats;
435 struct uvc_format *format;
436
437 struct uvc_streaming_control ctrl;
438 struct uvc_format *cur_format;
439 struct uvc_frame *cur_frame;
440
441 struct mutex mutex;
442
443 unsigned int frozen : 1;
444 struct uvc_video_queue queue;
445 void (*decode) (struct urb *urb, struct uvc_streaming *video,
446 struct uvc_buffer *buf);
447
448
449 struct {
450 __u8 header[256];
451 unsigned int header_size;
452 int skip_payload;
453 __u32 payload_size;
454 __u32 max_payload_size;
455 } bulk;
456
457 struct urb *urb[UVC_URBS];
458 char *urb_buffer[UVC_URBS];
459 dma_addr_t urb_dma[UVC_URBS];
460 unsigned int urb_size;
461
462 __u8 last_fid;
463};
464
465enum uvc_device_state {
466 UVC_DEV_DISCONNECTED = 1,
467};
468
469struct uvc_device {
470 struct usb_device *udev;
471 struct usb_interface *intf;
472 unsigned long warnings;
473 __u32 quirks;
474 int intfnum;
475 char name[32];
476
477 enum uvc_device_state state;
478 struct kref kref;
479 struct list_head list;
480 atomic_t users;
481
482
483 __u16 uvc_version;
484 __u32 clock_frequency;
485
486 struct list_head entities;
487 struct list_head chains;
488
489
490 struct list_head streams;
491
492
493 struct usb_host_endpoint *int_ep;
494 struct urb *int_urb;
495 __u8 *status;
496 struct input_dev *input;
497 char input_phys[64];
498};
499
500enum uvc_handle_state {
501 UVC_HANDLE_PASSIVE = 0,
502 UVC_HANDLE_ACTIVE = 1,
503};
504
505struct uvc_fh {
506 struct uvc_video_chain *chain;
507 struct uvc_streaming *stream;
508 enum uvc_handle_state state;
509};
510
511struct uvc_driver {
512 struct usb_driver driver;
513
514 struct mutex open_mutex;
515
516 struct list_head devices;
517 struct list_head controls;
518 struct mutex ctrl_mutex;
519
520};
521
522
523
524
525
526#define UVC_TRACE_PROBE (1 << 0)
527#define UVC_TRACE_DESCR (1 << 1)
528#define UVC_TRACE_CONTROL (1 << 2)
529#define UVC_TRACE_FORMAT (1 << 3)
530#define UVC_TRACE_CAPTURE (1 << 4)
531#define UVC_TRACE_CALLS (1 << 5)
532#define UVC_TRACE_IOCTL (1 << 6)
533#define UVC_TRACE_FRAME (1 << 7)
534#define UVC_TRACE_SUSPEND (1 << 8)
535#define UVC_TRACE_STATUS (1 << 9)
536
537#define UVC_WARN_MINMAX 0
538#define UVC_WARN_PROBE_DEF 1
539
540extern unsigned int uvc_no_drop_param;
541extern unsigned int uvc_trace_param;
542
543#define uvc_trace(flag, msg...) \
544 do { \
545 if (uvc_trace_param & flag) \
546 printk(KERN_DEBUG "uvcvideo: " msg); \
547 } while (0)
548
549#define uvc_warn_once(dev, warn, msg...) \
550 do { \
551 if (!test_and_set_bit(warn, &dev->warnings)) \
552 printk(KERN_INFO "uvcvideo: " msg); \
553 } while (0)
554
555#define uvc_printk(level, msg...) \
556 printk(level "uvcvideo: " msg)
557
558#define UVC_GUID_FORMAT "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-" \
559 "%02x%02x%02x%02x%02x%02x"
560#define UVC_GUID_ARGS(guid) \
561 (guid)[3], (guid)[2], (guid)[1], (guid)[0], \
562 (guid)[5], (guid)[4], \
563 (guid)[7], (guid)[6], \
564 (guid)[8], (guid)[9], \
565 (guid)[10], (guid)[11], (guid)[12], \
566 (guid)[13], (guid)[14], (guid)[15]
567
568
569
570
571
572
573extern struct uvc_driver uvc_driver;
574extern void uvc_delete(struct kref *kref);
575
576
577extern void uvc_queue_init(struct uvc_video_queue *queue,
578 enum v4l2_buf_type type);
579extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
580 unsigned int nbuffers, unsigned int buflength);
581extern int uvc_free_buffers(struct uvc_video_queue *queue);
582extern int uvc_query_buffer(struct uvc_video_queue *queue,
583 struct v4l2_buffer *v4l2_buf);
584extern int uvc_queue_buffer(struct uvc_video_queue *queue,
585 struct v4l2_buffer *v4l2_buf);
586extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
587 struct v4l2_buffer *v4l2_buf, int nonblocking);
588extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
589extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
590extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
591 struct uvc_buffer *buf);
592extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
593 struct file *file, poll_table *wait);
594extern int uvc_queue_allocated(struct uvc_video_queue *queue);
595static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
596{
597 return queue->flags & UVC_QUEUE_STREAMING;
598}
599
600
601extern const struct v4l2_file_operations uvc_fops;
602
603
604extern int uvc_video_init(struct uvc_streaming *stream);
605extern int uvc_video_suspend(struct uvc_streaming *stream);
606extern int uvc_video_resume(struct uvc_streaming *stream);
607extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
608extern int uvc_probe_video(struct uvc_streaming *stream,
609 struct uvc_streaming_control *probe);
610extern int uvc_commit_video(struct uvc_streaming *stream,
611 struct uvc_streaming_control *ctrl);
612extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
613 __u8 intfnum, __u8 cs, void *data, __u16 size);
614
615
616extern int uvc_status_init(struct uvc_device *dev);
617extern void uvc_status_cleanup(struct uvc_device *dev);
618extern int uvc_status_start(struct uvc_device *dev);
619extern void uvc_status_stop(struct uvc_device *dev);
620extern int uvc_status_suspend(struct uvc_device *dev);
621extern int uvc_status_resume(struct uvc_device *dev);
622
623
624extern struct uvc_control *uvc_find_control(struct uvc_video_chain *chain,
625 __u32 v4l2_id, struct uvc_control_mapping **mapping);
626extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
627 struct v4l2_queryctrl *v4l2_ctrl);
628
629extern int uvc_ctrl_add_info(struct uvc_control_info *info);
630extern int uvc_ctrl_add_mapping(struct uvc_control_mapping *mapping);
631extern int uvc_ctrl_init_device(struct uvc_device *dev);
632extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
633extern int uvc_ctrl_resume_device(struct uvc_device *dev);
634extern void uvc_ctrl_init(void);
635
636extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
637extern int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback);
638static inline int uvc_ctrl_commit(struct uvc_video_chain *chain)
639{
640 return __uvc_ctrl_commit(chain, 0);
641}
642static inline int uvc_ctrl_rollback(struct uvc_video_chain *chain)
643{
644 return __uvc_ctrl_commit(chain, 1);
645}
646
647extern int uvc_ctrl_get(struct uvc_video_chain *chain,
648 struct v4l2_ext_control *xctrl);
649extern int uvc_ctrl_set(struct uvc_video_chain *chain,
650 struct v4l2_ext_control *xctrl);
651
652extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
653 struct uvc_xu_control *ctrl, int set);
654
655
656extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
657 unsigned int n_terms, unsigned int threshold);
658extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
659 uint32_t denominator);
660extern struct usb_host_endpoint *uvc_find_endpoint(
661 struct usb_host_interface *alts, __u8 epaddr);
662
663
664void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
665 struct uvc_buffer *buf);
666
667#endif
668
669#endif
670
671
