uvcvideo.h
Go to the documentation of this file.
1 #ifndef _USB_VIDEO_H_
2 #define _USB_VIDEO_H_
3 
4 #include <linux/kernel.h>
5 
6 #include "uvc_compat.h"
7 
8 /*
9  * Dynamic controls
10  */
11 /* Data types for UVC control data */
12 enum uvc_control_data_type {
13  UVC_CTRL_DATA_TYPE_RAW = 0,
14  UVC_CTRL_DATA_TYPE_SIGNED,
15  UVC_CTRL_DATA_TYPE_UNSIGNED,
16  UVC_CTRL_DATA_TYPE_BOOLEAN,
17  UVC_CTRL_DATA_TYPE_ENUM,
18  UVC_CTRL_DATA_TYPE_BITMASK,
19 };
20 
21 #define UVC_CONTROL_SET_CUR (1 << 0)
22 #define UVC_CONTROL_GET_CUR (1 << 1)
23 #define UVC_CONTROL_GET_MIN (1 << 2)
24 #define UVC_CONTROL_GET_MAX (1 << 3)
25 #define UVC_CONTROL_GET_RES (1 << 4)
26 #define UVC_CONTROL_GET_DEF (1 << 5)
27 /* Control should be saved at suspend and restored at resume. */
28 #define UVC_CONTROL_RESTORE (1 << 6)
29 /* Control can be updated by the camera. */
30 #define UVC_CONTROL_AUTO_UPDATE (1 << 7)
31 
32 #define UVC_CONTROL_GET_RANGE (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
33  UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
34  UVC_CONTROL_GET_DEF)
35 
36 struct uvc_xu_control_info {
37  __u8 entity[16];
38  __u8 index;
39  __u8 selector;
40  __u16 size;
41  __u32 flags;
42 };
43 
44 struct uvc_xu_control_mapping {
45  __u32 id;
46  __u8 name[32];
47  __u8 entity[16];
48  __u8 selector;
49 
50  __u8 size;
51  __u8 offset;
52  enum v4l2_ctrl_type v4l2_type;
53  enum uvc_control_data_type data_type;
54 };
55 
56 struct uvc_xu_control {
57  __u8 unit;
58  __u8 selector;
59  __u16 size;
60  __u8 __user *data;
61 };
62 
63 #define UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
64 #define UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
65 #define UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
66 #define UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
67 
68 #ifdef __KERNEL__
69 
70 #include <linux/poll.h>
71 
72 /* --------------------------------------------------------------------------
73  * UVC constants
74  */
75 
76 #define SC_UNDEFINED 0x00
77 #define SC_VIDEOCONTROL 0x01
78 #define SC_VIDEOSTREAMING 0x02
79 #define SC_VIDEO_INTERFACE_COLLECTION 0x03
80 
81 #define PC_PROTOCOL_UNDEFINED 0x00
82 
83 #define CS_UNDEFINED 0x20
84 #define CS_DEVICE 0x21
85 #define CS_CONFIGURATION 0x22
86 #define CS_STRING 0x23
87 #define CS_INTERFACE 0x24
88 #define CS_ENDPOINT 0x25
89 
90 /* VideoControl class specific interface descriptor */
91 #define VC_DESCRIPTOR_UNDEFINED 0x00
92 #define VC_HEADER 0x01
93 #define VC_INPUT_TERMINAL 0x02
94 #define VC_OUTPUT_TERMINAL 0x03
95 #define VC_SELECTOR_UNIT 0x04
96 #define VC_PROCESSING_UNIT 0x05
97 #define VC_EXTENSION_UNIT 0x06
98 
99 /* VideoStreaming class specific interface descriptor */
100 #define VS_UNDEFINED 0x00
101 #define VS_INPUT_HEADER 0x01
102 #define VS_OUTPUT_HEADER 0x02
103 #define VS_STILL_IMAGE_FRAME 0x03
104 #define VS_FORMAT_UNCOMPRESSED 0x04
105 #define VS_FRAME_UNCOMPRESSED 0x05
106 #define VS_FORMAT_MJPEG 0x06
107 #define VS_FRAME_MJPEG 0x07
108 #define VS_FORMAT_MPEG2TS 0x0a
109 #define VS_FORMAT_DV 0x0c
110 #define VS_COLORFORMAT 0x0d
111 #define VS_FORMAT_FRAME_BASED 0x10
112 #define VS_FRAME_FRAME_BASED 0x11
113 #define VS_FORMAT_STREAM_BASED 0x12
114 
115 /* Endpoint type */
116 #define EP_UNDEFINED 0x00
117 #define EP_GENERAL 0x01
118 #define EP_ENDPOINT 0x02
119 #define EP_INTERRUPT 0x03
120 
121 /* Request codes */
122 #define RC_UNDEFINED 0x00
123 #define SET_CUR 0x01
124 #define GET_CUR 0x81
125 #define GET_MIN 0x82
126 #define GET_MAX 0x83
127 #define GET_RES 0x84
128 #define GET_LEN 0x85
129 #define GET_INFO 0x86
130 #define GET_DEF 0x87
131 
132 /* VideoControl interface controls */
133 #define VC_CONTROL_UNDEFINED 0x00
134 #define VC_VIDEO_POWER_MODE_CONTROL 0x01
135 #define VC_REQUEST_ERROR_CODE_CONTROL 0x02
136 
137 /* Terminal controls */
138 #define TE_CONTROL_UNDEFINED 0x00
139 
140 /* Selector Unit controls */
141 #define SU_CONTROL_UNDEFINED 0x00
142 #define SU_INPUT_SELECT_CONTROL 0x01
143 
144 /* Camera Terminal controls */
145 #define CT_CONTROL_UNDEFINED 0x00
146 #define CT_SCANNING_MODE_CONTROL 0x01
147 #define CT_AE_MODE_CONTROL 0x02
148 #define CT_AE_PRIORITY_CONTROL 0x03
149 #define CT_EXPOSURE_TIME_ABSOLUTE_CONTROL 0x04
150 #define CT_EXPOSURE_TIME_RELATIVE_CONTROL 0x05
151 #define CT_FOCUS_ABSOLUTE_CONTROL 0x06
152 #define CT_FOCUS_RELATIVE_CONTROL 0x07
153 #define CT_FOCUS_AUTO_CONTROL 0x08
154 #define CT_IRIS_ABSOLUTE_CONTROL 0x09
155 #define CT_IRIS_RELATIVE_CONTROL 0x0a
156 #define CT_ZOOM_ABSOLUTE_CONTROL 0x0b
157 #define CT_ZOOM_RELATIVE_CONTROL 0x0c
158 #define CT_PANTILT_ABSOLUTE_CONTROL 0x0d
159 #define CT_PANTILT_RELATIVE_CONTROL 0x0e
160 #define CT_ROLL_ABSOLUTE_CONTROL 0x0f
161 #define CT_ROLL_RELATIVE_CONTROL 0x10
162 #define CT_PRIVACY_CONTROL 0x11
163 
164 /* Processing Unit controls */
165 #define PU_CONTROL_UNDEFINED 0x00
166 #define PU_BACKLIGHT_COMPENSATION_CONTROL 0x01
167 #define PU_BRIGHTNESS_CONTROL 0x02
168 #define PU_CONTRAST_CONTROL 0x03
169 #define PU_GAIN_CONTROL 0x04
170 #define PU_POWER_LINE_FREQUENCY_CONTROL 0x05
171 #define PU_HUE_CONTROL 0x06
172 #define PU_SATURATION_CONTROL 0x07
173 #define PU_SHARPNESS_CONTROL 0x08
174 #define PU_GAMMA_CONTROL 0x09
175 #define PU_WHITE_BALANCE_TEMPERATURE_CONTROL 0x0a
176 #define PU_WHITE_BALANCE_TEMPERATURE_AUTO_CONTROL 0x0b
177 #define PU_WHITE_BALANCE_COMPONENT_CONTROL 0x0c
178 #define PU_WHITE_BALANCE_COMPONENT_AUTO_CONTROL 0x0d
179 #define PU_DIGITAL_MULTIPLIER_CONTROL 0x0e
180 #define PU_DIGITAL_MULTIPLIER_LIMIT_CONTROL 0x0f
181 #define PU_HUE_AUTO_CONTROL 0x10
182 #define PU_ANALOG_VIDEO_STANDARD_CONTROL 0x11
183 #define PU_ANALOG_LOCK_STATUS_CONTROL 0x12
184 
185 #define LXU_MOTOR_PANTILT_RELATIVE_CONTROL 0x01
186 #define LXU_MOTOR_PANTILT_RESET_CONTROL 0x02
187 #define LXU_MOTOR_FOCUS_MOTOR_CONTROL 0x03
188 
189 /* VideoStreaming interface controls */
190 #define VS_CONTROL_UNDEFINED 0x00
191 #define VS_PROBE_CONTROL 0x01
192 #define VS_COMMIT_CONTROL 0x02
193 #define VS_STILL_PROBE_CONTROL 0x03
194 #define VS_STILL_COMMIT_CONTROL 0x04
195 #define VS_STILL_IMAGE_TRIGGER_CONTROL 0x05
196 #define VS_STREAM_ERROR_CODE_CONTROL 0x06
197 #define VS_GENERATE_KEY_FRAME_CONTROL 0x07
198 #define VS_UPDATE_FRAME_SEGMENT_CONTROL 0x08
199 #define VS_SYNC_DELAY_CONTROL 0x09
200 
201 #define TT_VENDOR_SPECIFIC 0x0100
202 #define TT_STREAMING 0x0101
203 
204 /* Input Terminal types */
205 #define ITT_VENDOR_SPECIFIC 0x0200
206 #define ITT_CAMERA 0x0201
207 #define ITT_MEDIA_TRANSPORT_INPUT 0x0202
208 
209 /* Output Terminal types */
210 #define OTT_VENDOR_SPECIFIC 0x0300
211 #define OTT_DISPLAY 0x0301
212 #define OTT_MEDIA_TRANSPORT_OUTPUT 0x0302
213 
214 /* External Terminal types */
215 #define EXTERNAL_VENDOR_SPECIFIC 0x0400
216 #define COMPOSITE_CONNECTOR 0x0401
217 #define SVIDEO_CONNECTOR 0x0402
218 #define COMPONENT_CONNECTOR 0x0403
219 
220 #define UVC_TERM_INPUT 0x0000
221 #define UVC_TERM_OUTPUT 0x8000
222 
223 #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
224 #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
225 #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
226 #define UVC_ENTITY_IS_ITERM(entity) \
227  (((entity)->type & 0x8000) == UVC_TERM_INPUT)
228 #define UVC_ENTITY_IS_OTERM(entity) \
229  (((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
230 
231 #define UVC_STATUS_TYPE_CONTROL 1
232 #define UVC_STATUS_TYPE_STREAMING 2
233 
234 /* ------------------------------------------------------------------------
235  * GUIDs
236  */
237 #define UVC_GUID_UVC_CAMERA \
238  {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
239  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
240 #define UVC_GUID_UVC_OUTPUT \
241  {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
242  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
243 #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
244  {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
245  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
246 #define UVC_GUID_UVC_PROCESSING \
247  {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
248  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
249 #define UVC_GUID_UVC_SELECTOR \
250  {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
251  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
252 
253 #define UVC_GUID_LOGITECH_DEV_INFO \
254  {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
255  0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x1e}
256 #define UVC_GUID_LOGITECH_USER_HW \
257  {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
258  0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x1f}
259 #define UVC_GUID_LOGITECH_VIDEO \
260  {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
261  0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x50}
262 #define UVC_GUID_LOGITECH_MOTOR \
263  {0x82, 0x06, 0x61, 0x63, 0x70, 0x50, 0xab, 0x49, \
264  0xb8, 0xcc, 0xb3, 0x85, 0x5e, 0x8d, 0x22, 0x56}
265 
266 #define UVC_GUID_FORMAT_MJPEG \
267  { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
268  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
269 #define UVC_GUID_FORMAT_YUY2 \
270  { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
271  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
272 #define UVC_GUID_FORMAT_NV12 \
273  { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
274  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
275 #define UVC_GUID_FORMAT_YV12 \
276  { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
277  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
278 #define UVC_GUID_FORMAT_I420 \
279  { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
280  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
281 #define UVC_GUID_FORMAT_UYVY \
282  { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
283  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
284 #define UVC_GUID_FORMAT_Y800 \
285  { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
286  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
287 #define UVC_GUID_FORMAT_BY8 \
288  { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
289  0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
290 
291 
292 /* ------------------------------------------------------------------------
293  * Driver specific constants.
294  */
295 
296 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
297 
298 /* Number of isochronous URBs. */
299 #define UVC_URBS 5
300 /* Maximum number of packets per isochronous URB. */
301 #define UVC_MAX_ISO_PACKETS 40
302 /* Maximum frame size in bytes, for sanity checking. */
303 #define UVC_MAX_FRAME_SIZE (16*1024*1024)
304 /* Maximum number of video buffers. */
305 #define UVC_MAX_VIDEO_BUFFERS 32
306 
307 #define UVC_CTRL_CONTROL_TIMEOUT 300
308 #define UVC_CTRL_STREAMING_TIMEOUT 1000
309 
310 /* Devices quirks */
311 #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
312 #define UVC_QUIRK_PROBE_MINMAX 0x00000002
313 #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
314 #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
315 #define UVC_QUIRK_STREAM_NO_FID 0x00000010
316 
317 /* Format flags */
318 #define UVC_FMT_FLAG_COMPRESSED 0x00000001
319 #define UVC_FMT_FLAG_STREAM 0x00000002
320 
321 /* ------------------------------------------------------------------------
322  * Structures.
323  */
324 
325 struct uvc_device;
326 
327 /* TODO: Put the most frequently accessed fields at the beginning of
328  * structures to maximize cache efficiency.
329  */
330 struct uvc_streaming_control {
331  __u16 bmHint;
332  __u8 bFormatIndex;
333  __u8 bFrameIndex;
334  __u32 dwFrameInterval;
335  __u16 wKeyFrameRate;
336  __u16 wPFrameRate;
337  __u16 wCompQuality;
338  __u16 wCompWindowSize;
339  __u16 wDelay;
340  __u32 dwMaxVideoFrameSize;
341  __u32 dwMaxPayloadTransferSize;
342  __u32 dwClockFrequency;
343  __u8 bmFramingInfo;
344  __u8 bPreferedVersion;
345  __u8 bMinVersion;
346  __u8 bMaxVersion;
347 };
348 
349 struct uvc_menu_info {
350  __u32 value;
351  __u8 name[32];
352 };
353 
354 struct uvc_control_info {
355  struct list_head list;
356  struct list_head mappings;
357 
358  __u8 entity[16];
359  __u8 index;
360  __u8 selector;
361 
362  __u16 size;
363  __u32 flags;
364 };
365 
366 struct uvc_control_mapping {
367  struct list_head list;
368 
369  struct uvc_control_info *ctrl;
370 
371  __u32 id;
372  __u8 name[32];
373  __u8 entity[16];
374  __u8 selector;
375 
376  __u8 size;
377  __u8 offset;
378  enum v4l2_ctrl_type v4l2_type;
379  enum uvc_control_data_type data_type;
380 
381  struct uvc_menu_info *menu_info;
382  __u32 menu_count;
383 };
384 
385 struct uvc_control {
386  struct uvc_entity *entity;
387  struct uvc_control_info *info;
388 
389  __u8 index; /* Used to match the uvc_control entry with a
390  uvc_control_info. */
391  __u8 dirty : 1,
392  loaded : 1,
393  modified : 1;
394 
395  __u8 *data;
396 };
397 
398 struct uvc_format_desc {
399  char *name;
400  __u8 guid[16];
401  __u32 fcc;
402 };
403 
404 /* The term 'entity' refers to both UVC units and UVC terminals.
405  *
406  * The type field is either the terminal type (wTerminalType in the terminal
407  * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
408  * As the bDescriptorSubtype field is one byte long, the type value will
409  * always have a null MSB for units. All terminal types defined by the UVC
410  * specification have a non-null MSB, so it is safe to use the MSB to
411  * differentiate between units and terminals as long as the descriptor parsing
412  * code makes sure terminal types have a non-null MSB.
413  *
414  * For terminals, the type's most significant bit stores the terminal
415  * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
416  * always be accessed with the UVC_ENTITY_* macros and never directly.
417  */
418 
419 struct uvc_entity {
420  struct list_head list; /* Entity as part of a UVC device. */
421  struct list_head chain; /* Entity as part of a video device
422  * chain. */
423  __u8 id;
424  __u16 type;
425  char name[64];
426 
427  union {
428  struct {
429  __u16 wObjectiveFocalLengthMin;
430  __u16 wObjectiveFocalLengthMax;
431  __u16 wOcularFocalLength;
432  __u8 bControlSize;
433  __u8 *bmControls;
434  } camera;
435 
436  struct {
437  __u8 bControlSize;
438  __u8 *bmControls;
439  __u8 bTransportModeSize;
440  __u8 *bmTransportModes;
441  } media;
442 
443  struct {
444  __u8 bSourceID;
445  } output;
446 
447  struct {
448  __u8 bSourceID;
449  __u16 wMaxMultiplier;
450  __u8 bControlSize;
451  __u8 *bmControls;
452  __u8 bmVideoStandards;
453  } processing;
454 
455  struct {
456  __u8 bNrInPins;
457  __u8 *baSourceID;
458  } selector;
459 
460  struct {
461  __u8 guidExtensionCode[16];
462  __u8 bNumControls;
463  __u8 bNrInPins;
464  __u8 *baSourceID;
465  __u8 bControlSize;
466  __u8 *bmControls;
467  __u8 *bmControlsType;
468  } extension;
469  };
470 
471  unsigned int ncontrols;
472  struct uvc_control *controls;
473 };
474 
475 struct uvc_frame {
476  __u8 bFrameIndex;
477  __u8 bmCapabilities;
478  __u16 wWidth;
479  __u16 wHeight;
480  __u32 dwMinBitRate;
481  __u32 dwMaxBitRate;
482  __u32 dwMaxVideoFrameBufferSize;
483  __u8 bFrameIntervalType;
484  __u32 dwDefaultFrameInterval;
485  __u32 *dwFrameInterval;
486 };
487 
488 struct uvc_format {
489  __u8 type;
490  __u8 index;
491  __u8 bpp;
492  __u8 colorspace;
493  __u32 fcc;
494  __u32 flags;
495 
496  char name[32];
497 
498  unsigned int nframes;
499  struct uvc_frame *frame;
500 };
501 
502 struct uvc_streaming_header {
503  __u8 bNumFormats;
504  __u8 bEndpointAddress;
505  __u8 bTerminalLink;
506  __u8 bControlSize;
507  __u8 *bmaControls;
508  /* The following fields are used by input headers only. */
509  __u8 bmInfo;
510  __u8 bStillCaptureMethod;
511  __u8 bTriggerSupport;
512  __u8 bTriggerUsage;
513 };
514 
515 struct uvc_streaming {
516  struct list_head list;
517 
518  struct usb_interface *intf;
519  int intfnum;
520  __u16 maxpsize;
521 
522  struct uvc_streaming_header header;
523 
524  unsigned int nformats;
525  struct uvc_format *format;
526 
527  struct uvc_streaming_control ctrl;
528  struct uvc_format *cur_format;
529  struct uvc_frame *cur_frame;
530 
531  struct mutex mutex;
532 };
533 
534 enum uvc_buffer_state {
535  UVC_BUF_STATE_IDLE = 0,
536  UVC_BUF_STATE_QUEUED = 1,
537  UVC_BUF_STATE_ACTIVE = 2,
538  UVC_BUF_STATE_DONE = 3,
539  UVC_BUF_STATE_ERROR = 4,
540 };
541 
542 struct uvc_buffer {
543  unsigned long vma_use_count;
544  struct list_head stream;
545 
546  /* Touched by interrupt handler. */
547  struct v4l2_buffer buf;
548  struct list_head queue;
549  wait_queue_head_t wait;
550  enum uvc_buffer_state state;
551 };
552 
553 struct uvc_video_queue {
554  void *mem;
555  unsigned int streaming : 1,
556  frozen : 1,
557  drop_incomplete : 1;
558  __u32 sequence;
559 
560  unsigned int count;
561  unsigned int buf_size;
562  struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
563  struct mutex mutex; /* protects buffers and mainqueue */
564  spinlock_t irqlock; /* protects irqqueue */
565 
566  struct list_head mainqueue;
567  struct list_head irqqueue;
568 };
569 
570 struct uvc_video_device {
571  struct uvc_device *dev;
572  struct video_device *vdev;
573  atomic_t active;
574 
575  struct list_head iterms;
576  struct uvc_entity *oterm;
577  struct uvc_entity *processing;
578  struct uvc_entity *selector;
579  struct list_head extensions;
580  struct mutex ctrl_mutex;
581 
582  struct uvc_video_queue queue;
583 
584  /* Video streaming object, must always be non-NULL. */
585  struct uvc_streaming *streaming;
586 
587  void (*decode) (struct urb *urb, struct uvc_video_device *video,
588  struct uvc_buffer *buf);
589 
590  /* Context data used by the bulk completion handler. */
591  struct {
592  __u8 header[256];
593  unsigned int header_size;
594  int skip_payload;
595  __u32 payload_size;
596  __u32 max_payload_size;
597  } bulk;
598 
599  struct urb *urb[UVC_URBS];
600  char *urb_buffer[UVC_URBS];
601 
602  __u8 last_fid;
603 };
604 
605 enum uvc_device_state {
606  UVC_DEV_DISCONNECTED = 1,
607 };
608 
609 struct uvc_device {
610  struct usb_device *udev;
611  struct usb_interface *intf;
612  __u32 quirks;
613  int intfnum;
614  char name[32];
615 
616  enum uvc_device_state state;
617  struct kref kref;
618  struct list_head list;
619 
620  /* Video control interface */
621  __u16 uvc_version;
622  __u32 clock_frequency;
623 
624  struct list_head entities;
625 
626  struct uvc_video_device video;
627 
628  /* Status Interrupt Endpoint */
629  struct usb_host_endpoint *int_ep;
630  struct urb *int_urb;
631  __u8 status[16];
632  struct input_dev *input;
633 
634  /* Video Streaming interfaces */
635  struct list_head streaming;
636 };
637 
638 enum uvc_handle_state {
639  UVC_HANDLE_PASSIVE = 0,
640  UVC_HANDLE_ACTIVE = 1,
641 };
642 
643 struct uvc_fh {
644  struct uvc_video_device *device;
645  enum uvc_handle_state state;
646 };
647 
648 struct uvc_driver {
649  struct usb_driver driver;
650 
651  struct mutex open_mutex; /* protects from open/disconnect race */
652 
653  struct list_head devices; /* struct uvc_device list */
654  struct list_head controls; /* struct uvc_control_info list */
655  struct mutex ctrl_mutex; /* protects controls and devices
656  lists */
657 };
658 
659 /* ------------------------------------------------------------------------
660  * Debugging, printing and logging
661  */
662 
663 #define UVC_TRACE_PROBE (1 << 0)
664 #define UVC_TRACE_DESCR (1 << 1)
665 #define UVC_TRACE_CONTROL (1 << 2)
666 #define UVC_TRACE_FORMAT (1 << 3)
667 #define UVC_TRACE_CAPTURE (1 << 4)
668 #define UVC_TRACE_CALLS (1 << 5)
669 #define UVC_TRACE_IOCTL (1 << 6)
670 #define UVC_TRACE_FRAME (1 << 7)
671 #define UVC_TRACE_SUSPEND (1 << 8)
672 #define UVC_TRACE_STATUS (1 << 9)
673 
674 extern unsigned int uvc_trace_param;
675 
676 #define uvc_trace(flag, msg...) \
677  do { \
678  if (uvc_trace_param & flag) \
679  printk(KERN_DEBUG "uvcvideo: " msg); \
680  } while (0)
681 
682 #define uvc_printk(level, msg...) \
683  printk(level "uvcvideo: " msg)
684 
685 #define UVC_GUID_FORMAT "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-" \
686  "%02x%02x%02x%02x%02x%02x"
687 #define UVC_GUID_ARGS(guid) \
688  (guid)[3], (guid)[2], (guid)[1], (guid)[0], \
689  (guid)[5], (guid)[4], \
690  (guid)[7], (guid)[6], \
691  (guid)[8], (guid)[9], \
692  (guid)[10], (guid)[11], (guid)[12], \
693  (guid)[13], (guid)[14], (guid)[15]
694 
695 /* --------------------------------------------------------------------------
696  * Internal functions.
697  */
698 
699 /* Core driver */
700 extern struct uvc_driver uvc_driver;
701 extern void uvc_delete(struct kref *kref);
702 
703 /* Video buffers queue management. */
704 extern void uvc_queue_init(struct uvc_video_queue *queue);
705 extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
706  unsigned int nbuffers, unsigned int buflength);
707 extern int uvc_free_buffers(struct uvc_video_queue *queue);
708 extern int uvc_query_buffer(struct uvc_video_queue *queue,
709  struct v4l2_buffer *v4l2_buf);
710 extern int uvc_queue_buffer(struct uvc_video_queue *queue,
711  struct v4l2_buffer *v4l2_buf);
712 extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
713  struct v4l2_buffer *v4l2_buf, int nonblocking);
714 extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
715 extern void uvc_queue_cancel(struct uvc_video_queue *queue);
716 extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
717  struct uvc_buffer *buf);
718 extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
719  struct file *file, poll_table *wait);
720 
721 /* V4L2 interface */
722 extern struct file_operations uvc_fops;
723 
724 /* Video */
725 extern int uvc_video_init(struct uvc_video_device *video);
726 extern int uvc_video_suspend(struct uvc_video_device *video);
727 extern int uvc_video_resume(struct uvc_video_device *video);
728 extern int uvc_video_enable(struct uvc_video_device *video, int enable);
729 extern int uvc_probe_video(struct uvc_video_device *video,
730  struct uvc_streaming_control *probe);
731 extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
732  __u8 intfnum, __u8 cs, void *data, __u16 size);
733 extern int uvc_set_video_ctrl(struct uvc_video_device *video,
734  struct uvc_streaming_control *ctrl, int probe);
735 
736 /* Status */
737 extern int uvc_status_init(struct uvc_device *dev);
738 extern void uvc_status_cleanup(struct uvc_device *dev);
739 extern int uvc_status_suspend(struct uvc_device *dev);
740 extern int uvc_status_resume(struct uvc_device *dev);
741 
742 /* Controls */
743 extern struct uvc_control *uvc_find_control(struct uvc_video_device *video,
744  __u32 v4l2_id, struct uvc_control_mapping **mapping);
745 extern int uvc_query_v4l2_ctrl(struct uvc_video_device *video,
746  struct v4l2_queryctrl *v4l2_ctrl);
747 
748 extern int uvc_ctrl_add_info(struct uvc_control_info *info);
749 extern int uvc_ctrl_add_mapping(struct uvc_control_mapping *mapping);
750 extern int uvc_ctrl_init_device(struct uvc_device *dev);
751 extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
752 extern int uvc_ctrl_resume_device(struct uvc_device *dev);
753 extern void uvc_ctrl_init(void);
754 
755 extern int uvc_ctrl_begin(struct uvc_video_device *video);
756 extern int __uvc_ctrl_commit(struct uvc_video_device *video, int rollback);
757 static inline int uvc_ctrl_commit(struct uvc_video_device *video)
758 {
759  return __uvc_ctrl_commit(video, 0);
760 }
761 static inline int uvc_ctrl_rollback(struct uvc_video_device *video)
762 {
763  return __uvc_ctrl_commit(video, 1);
764 }
765 
766 extern int uvc_ctrl_get(struct uvc_video_device *video,
767  struct v4l2_ext_control *xctrl);
768 extern int uvc_ctrl_set(struct uvc_video_device *video,
769  struct v4l2_ext_control *xctrl);
770 
771 extern int uvc_xu_ctrl_query(struct uvc_video_device *video,
772  struct uvc_xu_control *ctrl, int set);
773 
774 /* Utility functions */
775 extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
776  unsigned int n_terms, unsigned int threshold);
777 extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
778  uint32_t denominator);
779 extern struct usb_host_endpoint *uvc_find_endpoint(
780  struct usb_host_interface *alts, __u8 epaddr);
781 
782 /* Quirks support */
783 void uvc_video_decode_isight(struct urb *urb, struct uvc_video_device *video,
784  struct uvc_buffer *buf);
785 
786 #endif /* __KERNEL__ */
787 
788 #endif
789 
uvc_xu_control::data
__u8 __user * data
Definition: uvcvideo.h:60
uvc_control_data_type
uvc_control_data_type
Definition: uvcvideo.h:12
uvc_xu_control_info::size
__u16 size
Definition: uvcvideo.h:40
info
static struct jpginfo info
Definition: utils.c:164
uvc_xu_control_mapping::offset
__u8 offset
Definition: uvcvideo.h:51
uvc_compat.h
uvc_xu_control_info
Definition: uvcvideo.h:36
uvc_xu_control_mapping::selector
__u8 selector
Definition: uvcvideo.h:48
uvc_xu_control_mapping::id
__u32 id
Definition: uvcvideo.h:45
uvc_xu_control_mapping::size
__u8 size
Definition: uvcvideo.h:50
__user
#define __user
Definition: uvc_compat.h:8
wait
void wait(int seconds)
uvc_xu_control_mapping
Definition: uvcvideo.h:44
uvc_xu_control_info::entity
__u8 entity[16]
Definition: uvcvideo.h:37
uvc_xu_control::size
__u16 size
Definition: uvcvideo.h:59
uvc_xu_control_info::flags
__u32 flags
Definition: uvcvideo.h:41
uvc_xu_control::selector
__u8 selector
Definition: uvcvideo.h:58
uvc_xu_control
Definition: uvcvideo.h:56
uvc_xu_control_info::selector
__u8 selector
Definition: uvcvideo.h:39
uvc_xu_control::unit
__u8 unit
Definition: uvcvideo.h:57
uvc_xu_control_info::index
__u8 index
Definition: uvcvideo.h:38

tuw_uvc
Author(s): Markus Bader
autogenerated on Mon Jun 10 2019 15:39:24