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