?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Implement RGB gain/balance
[microdia.git] / microdia.h
blob5f5f15f4d4f4342b8861e0fb6d06a2b01a75c877
1 /**
2 * @file microdia.h
3 * @author Nicolas VIVIEN
4 * @date 2008-02-01
5 * @version v0.0.0
6 *
7 * @brief Driver for Microdia USB video camera
8 *
9 * @note Copyright (C) Nicolas VIVIEN
10 *
11 * @par Licences
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 */
27
28 #include <linux/kernel.h>
29 #include <linux/version.h>
30 #include <linux/usb.h>
31 #include <media/v4l2-common.h>
32
33 #ifndef MICRODIA_H
34 #define MICRODIA_H
35
36
37 #define DRIVER_NAME "microdia" /**< Name of this driver */
38 #define DRIVER_VERSION "v0.0.0" /**< Version of this driver */
39 #define DRIVER_VERSION_NUM 0x000000 /**< Version numerical of this driver */
40 #define DRIVER_DESC "Microdia USB Video Camera" /**< Short description of this driver */
41 #define DRIVER_AUTHOR "Nicolas VIVIEN" /**< Author of this driver */
42 #define PREFIX DRIVER_NAME ": " /**< Prefix use for the MICRODIA "printk" */
43
44 #define USB_0C45_VID 0x0c45 /**< Vendor ID of MICRODIA */
45 #define USB_045E_VID 0x045e /**< Vendor ID of MICROSOFT */
46 #define USB_04F2_VID 0x04f2 /**< Vendor ID of CHICONY */
47 #define USB_145F_VID 0x145f /**< Vendor ID of TRUST */
48
49 // SN9C201:
50 #define USB_6240_PID 0x6240 /**< SN9C201 + MI1300 */
51 #define USB_6242_PID 0x6242 /**< SN9C201 + MI1310 */
52 #define USB_6243_PID 0x6243 /**< SN9C201 + S5K4AAFX */
53 #define USB_6248_PID 0x6248 /**< SN9C201 + OV9655 */
54 #define USB_624B_PID 0x624b /**< SN9C201 + CX1332 */
55 #define USB_624C_PID 0x624c /**< SN9C201 + MI1320 */
56 #define USB_624E_PID 0x624e /**< SN9C201 + SOI968 */
57 #define USB_624F_PID 0x624f /**< SN9C201 + OV9650 */
58 #define USB_6253_PID 0x6253 /**< SN9C201 + OV9650 */
59 #define USB_6260_PID 0x6260 /**< SN9C201 + OV7670ISP */
60 #define USB_6262_PID 0x6262 /**< SN9C201 + OM6802 */
61 #define USB_6270_PID 0x6270 /**< SN9C201 + MI0360/MT9V111 */
62 #define USB_627A_PID 0x627a /**< SN9C201 + S5K53BEB */
63 #define USB_627B_PID 0x627b /**< SN9C201 + OV7660 */
64 #define USB_627C_PID 0x627c /**< SN9C201 + HV7131R */
65 #define USB_627F_PID 0x627f /**< EEPROM */
66 // SN9C202:
67 #define USB_6280_PID 0x6280 /**< SN9C202 + MI1300 */
68 #define USB_6282_PID 0x6282 /**< SN9C202 + MI1310 */
69 #define USB_6283_PID 0x6283 /**< SN9C202 + S5K4AAFX */
70 #define USB_6288_PID 0x6288 /**< SN9C202 + OV9655 */
71 #define USB_628A_PID 0x628a /**< SN9C202 + ICM107 */
72 #define USB_628B_PID 0x628b /**< SN9C202 + CX1332 */
73 #define USB_628C_PID 0x628c /**< SN9C202 + MI1320 */
74 #define USB_628E_PID 0x628e /**< SN9C202 + SOI968 */
75 #define USB_628F_PID 0x628f /**< SN9C202 + OV9650 */
76 #define USB_62A0_PID 0x62a0 /**< SN9C202 + OV7670ISP */
77 #define USB_62A2_PID 0x62a2 /**< SN9C202 + OM6802 */
78 #define USB_62B0_PID 0x62b0 /**< SN9C202 + MI0360/MT9V111 */
79 #define USB_62B3_PID 0x62b3 /**< SN9C202 + OV9655 */
80 #define USB_62BA_PID 0x62ba /**< SN9C202 + S5K53BEB */
81 #define USB_62BB_PID 0x62bb /**< SN9C202 + OV7660 */
82 #define USB_62BC_PID 0x62bc /**< SN9C202 + HV7131R */
83 #define USB_62BE_PID 0x62be /**< SN9C202 + OV7663 */
84 // SN9C325:
85 #define USB_6128_PID 0x6128 /**< SN9C325 + OM6802 */
86 #define USB_612A_PID 0x612a /**< SN9C325 + OV7648 + POx1030xC + SOI768 + PO2030N + OV7660 + OV7670 + HV7131R */
87 // *** "Clone"-devices ***:
88 // Microsoft LifeCam VX-6000:
89 #define USB_00F4_PID 0x00f4 /**< => 628f (SN9C202 + OV9650) */
90 // Trust WB-3600R:
91 #define USB_013D_PID 0x013d /**< => 627b (SN9C201 + OV7660) */
92 // Chicony Panda 7, Trust WB-3450P:
93 #define USB_A128_PID 0xa128 /**< => 62be (SN9C202 + OV7663) */
94
95 #define CAMERA_MODEL(vid, pid) ((vid << 16) | pid)
96 #define CAMERA_VID(model) ((model >> 16) & 0xFFFF)
97 #define CAMERA_PID(model) (model & 0xFFFF)
98
99 /**
100 * @def VID_HARDWARE_MICRODIA
101 *
102 * This value must be inserted into the kernel headers linux/videodev.h
103 * It's useful only for the support of V4L v1
104 */
105 #define VID_HARDWARE_MICRODIA 88
106
107
108
109
110 /**
111 * @def MAX_ISO_BUFS
112 * Number maximal of ISOC buffers
113 *
114 * @def ISO_FRAMES_PER_DESC
115 * Number frames per ISOC descriptor
116 */
117 #define MAX_ISO_BUFS 200
118 #define ISO_FRAMES_PER_DESC 10
119
120 /**
121 * @def hb_multiplier(wMaxPacketSize)
122 * USB endpoint high bandwidth multiplier
123 *
124 * @def max_packet_sz(wMaxPacketSize)
125 * USB endpoint maximum packet size
126 *
127 * These values are both encoded within the wMaxPacketSize field of the usb_endpoint_descriptor structure.
128 * The 11(10:0) lowest bits hold the MaxPacketSize(according to the usb specs a value over 1024 is undefined),
129 * and the bits 12:11 will give the high bandwidth multiplier(this should be a value of 0-2).
130 */
131
132 #define hb_multiplier(wMaxPacketSize) (((wMaxPacketSize >> 11) & 0x03) + 1)
133 #define max_packet_sz(wMaxPacketSize) ((wMaxPacketSize) & 0x07ff)
134
135 /**
136 * @def MICRODIA_FRAME_SIZE
137 * Maximum size after decompression
138 */
139 #define MICRODIA_FRAME_SIZE (1280 * 1024 * 3)
140
141 /**
142 * @def MICRODIA_FRAME_SIZE_DIVISOR_DEFAULT
143 * Most models have a Frame size of image_size + image_size/2
144 *
145 * @def MICRODIA_FRAME_SIZE_DIVISOR_6260
146 * The 6260 has a Frame size of image_size + image_size
147 */
148 #define MICRODIA_FRAME_SIZE_DIVISOR_DEFAULT 2
149 #define MICRODIA_FRAME_SIZE_DIVISOR_6260 1
150
151 /**
152 * @def DRIVER_SUPPORT
153 *
154 * List of supported devices
155 */
156 #define DRIVER_SUPPORT "Microdia USB Camera"
157
158 /**
159 * @def CONFIG_MICRODIA_DEBUG
160 * Enable / Disable the debug mode.
161 *
162 * @def UDIA_INFO(str, args...)
163 * Print information message.
164 * @a Use this function like the function printf.
165 *
166 * @def UDIA_ERROR(str, args...)
167 * Print error message.
168 * @a Use this function like the function printf.
169 *
170 * @def UDIA_WARNING(str, args...)
171 * Print warning message.
172 * @a Use this function like the function printf.
173 *
174 * @def UDIA_DEBUG(str, args...)
175 * Print debug message.
176 * @a Use this function like the function printf.
177 */
178 #ifndef CONFIG_MICRODIA_DEBUG
179 #define CONFIG_MICRODIA_DEBUG 0
180 #endif
181
182 #if CONFIG_MICRODIA_DEBUG
183
184 #define UDIA_INFO(str, args...) printk(KERN_INFO PREFIX str, ##args)
185 #define UDIA_ERROR(str, args...) printk(KERN_ERR PREFIX str, ##args)
186 #define UDIA_WARNING(str, args...) printk(KERN_WARNING PREFIX str, ##args)
187 #define UDIA_DEBUG(str, args...) printk(KERN_DEBUG PREFIX str, ##args)
188
189 #else
190
191 #define UDIA_INFO(str, args...) printk(KERN_INFO PREFIX str, ##args)
192 #define UDIA_ERROR(str, args...) printk(KERN_ERR PREFIX str, ##args)
193 #define UDIA_WARNING(str, args...) printk(KERN_WARNING PREFIX str, ##args)
194 #define UDIA_DEBUG(str, args...) do { } while(0)
195
196 #endif
197
198
199 /**
200 * @def CONFIG_MICRODIA_DEBUG_STREAM
201 * Enable / Disable the debug mode about the stream.
202 *
203 * @def UDIA_STREAM(str, args...)
204 * Print stream debug message.
205 * @a Use this function like the function printf.
206 */
207 #ifndef CONFIG_MICRODIA_DEBUG_STREAM
208 #define CONFIG_MICRODIA_DEBUG_STREAM 0
209 #endif
210
211 #if CONFIG_MICRODIA_DEBUG_STREAM
212
213 #define UDIA_STREAM(str, args...) printk(KERN_DEBUG PREFIX str, ##args)
214
215 #else
216
217 #define UDIA_STREAM(str, args...) do { } while(0)
218
219 #endif
220
221 /**
222 * @enum T_MICRODIA_VIDEOMODE Video feature supported by camera
223 */
224 typedef enum {
225 MICRODIA_VGA, /**< For VGA video camera */
226 MICRODIA_SXGA, /**< For SXGA video camera 1.3M */
227 MICRODIA_UXGA /**< For UXGA video camera 2M */
228 } T_MICRODIA_VIDEOMODE;
229
230
231 /**
232 * @enum T_MICRODIA_RESOLUTION Video resolution
233 */
234 typedef enum {
235 MICRODIA_80x60,
236 /*MICRODIA_128x96,*/
237 MICRODIA_160x120,
238 /*MICRODIA_213x160, */
239 MICRODIA_320x240,
240 MICRODIA_640x480,
241 MICRODIA_800x600,
242 MICRODIA_1024x768,
243 MICRODIA_1280x1024,
244 MICRODIA_NBR_SIZES
245 } T_MICRODIA_RESOLUTION;
246
247 enum microdia_buffer_state {
248 MICRODIA_BUF_STATE_IDLE = 0,
249 MICRODIA_BUF_STATE_QUEUED = 1,
250 MICRODIA_BUF_STATE_ACTIVE = 2,
251 MICRODIA_BUF_STATE_DONE = 3,
252 MICRODIA_BUF_STATE_ERROR = 4,
253 };
254
255 enum microdia_mode {
256 MICRODIA_MODE_IDLE = 0,
257 MICRODIA_MODE_READ = 1,
258 MICRODIA_MODE_STREAM = 2,
259 };
260
261 struct microdia_buffer {
262 unsigned long vma_use_count;
263 struct list_head stream;
264
265 /* Touched by interrupt handler. */
266 struct v4l2_buffer buf;
267 struct list_head queue;
268 wait_queue_head_t wait;
269 enum microdia_buffer_state state;
270 };
271
272 struct microdia_video_queue {
273 void *mem;
274 void *scratch;
275 unsigned int streaming : 1,
276 frozen : 1,
277 drop_incomplete : 1;
278 __u32 sequence;
279
280 unsigned int count;
281 unsigned int min_buffers;
282 unsigned int max_buffers;
283 unsigned int buf_size;
284 unsigned int frame_size; /*current frame size */
285 struct microdia_buffer *buffer;
286 struct microdia_buffer *read_buffer;
287 struct mutex mutex; /* protects buffers and mainqueue */
288 spinlock_t irqlock; /* protects irqqueue */
289
290 struct list_head mainqueue;
291 struct list_head irqqueue;
292 };
293
294
295 /**
296 * @struct microdia_iso_buf
297 */
298 struct microdia_iso_buf {
299 void *data;
300 struct urb *urb;
301 };
302
303 /**
304 * @struct microdia_coord
305 */
306 struct microdia_coord {
307 int x; /**< X-coordonate */
308 int y; /**< Y-coordonate */
309 };
310
311 /**
312 * @struct microdia_video
313 */
314 struct microdia_video {
315 struct v4l2_pix_format format;
316 int fps; /**< FPS setting */
317 int brightness; /**< Brightness setting */
318 int contrast; /**< Contrast setting */
319 int whiteness; /**< Whiteness setting */
320 int colour; /**< Colour setting */
321 int hue; /**< Hue setting */
322 int hflip; /**< Horizontal flip */
323 int vflip; /**< Vertical flip */
324 int exposure; /**< Exposure */
325 int sharpness; /**< Sharpness */
326 __u8 rgb_gain[4]; /**< RGB Gain (RGGB) */
327 int auto_exposure; /**< Automatic exposure */
328 int auto_whitebalance; /**< Automatic whitebalance */
329 int reg; /**< register adress */
330 int val; /**< register value */
331 int i2creg; /**< I2C register adress */
332 int i2cval; /**< I2C register value */
333 int i2cslave; /**< I2C slave adress */
334 };
335
336 /**
337 * @struct usb_microdia
338 */
339 struct usb_microdia {
340 struct video_device *vdev; /**< Pointer on a V4L2 video device */
341 struct usb_device *udev; /**< Pointer on a USB device */
342 struct usb_interface *interface; /**< Pointer on a USB interface */
343
344 int release; /**< Release of the device (bcdDevice) */
345 __u32 webcam_model; /**< Model of video camera device */
346 __u8 webcam_type; /**< Type of camera : VGA, SXGA (1.3M), UXGA (2M) */
347
348 int frame_size_divisor; /**> Used to calculate frame_size */
349
350 __u8 sensor_slave_address; /**< I2C/SCCB slave address of the image sensor */
351 __u8 sensor_flags; /**< I2C/SCCB flags of the image sensor */
352
353 unsigned char *int_in_buffer; /**< Interrupt IN buffer */
354 size_t int_in_size; /**< Interrupt IN buffer size */
355 __u8 int_in_endpointAddr; /**< Interrupt IN endpoint address */
356
357 size_t isoc_in_size; /**< Isochrone IN size */
358 __u8 isoc_in_endpointAddr; /**< Isochrone IN endpoint address */
359
360 struct microdia_video vsettings; /**< Video settings (brightness, whiteness...) */
361
362 struct kref vopen; /**< Video status (Opened or Closed) */
363 struct file *owner; /**< file handler of stream owner */
364 enum microdia_mode mode;/**< camera mode */
365
366 int vframes_overflow; /**< Buffer overflow frames */
367 int vframes_incomplete; /**< Incomplete frames */
368 int vframes_dropped; /**< Dropped frames */
369
370 struct mutex mutex; /**< Mutex */
371
372 struct microdia_iso_buf isobuf[MAX_ISO_BUFS];
373
374 int resolution;
375 struct microdia_coord view;
376 struct microdia_coord image;
377
378 struct microdia_video_queue queue;
379
380 __u8 supported_fmts;
381
382 int (* initialize) (struct usb_microdia *dev);
383 int (* start_stream) (struct usb_microdia *dev);
384 int (* stop_stream) (struct usb_microdia *dev);
385 int (* set_contrast) (struct usb_microdia *dev);
386 int (* set_brightness) (struct usb_microdia *dev);
387 int (* set_gamma) (struct usb_microdia *dev);
388 int (* set_exposure) (struct usb_microdia *dev);
389 int (* flip_detect) (struct usb_microdia *dev);
390 int (* set_hvflip) (struct usb_microdia *dev);
391 int (* set_sharpness) (struct usb_microdia *dev);
392 int (*set_rgb_gain) (struct usb_microdia *dev);
393 int (* set_auto_exposure) (struct usb_microdia *dev);
394 int (* set_auto_whitebalance) (struct usb_microdia *dev);
395 };
396
397 struct microdia_camera {
398
399 __u32 model; /**< Model of video camera device */
400 __u8 type; /**< Type of camera : VGA, SXGA, UXGA */
401 __u8 supported_fmts;
402 __u8 sensor_slave_address;
403 __u8 sensor_flags;
404
405 int (*initialize) (struct usb_microdia *dev);
406 int (*start_stream) (struct usb_microdia *dev);
407 int (*stop_stream) (struct usb_microdia *dev);
408 int (*set_contrast) (struct usb_microdia *dev);
409 int (*set_brightness) (struct usb_microdia *dev);
410 int (*set_gamma) (struct usb_microdia *dev);
411 int (*set_exposure) (struct usb_microdia *dev);
412 int (*flip_detect) (struct usb_microdia *dev);
413 int (*set_hvflip) (struct usb_microdia *dev);
414 int (*set_sharpness) (struct usb_microdia *dev);
415 int (*set_rgb_gain) (struct usb_microdia *dev);
416 int (*set_auto_exposure) (struct usb_microdia *dev);
417 int (*set_auto_whitebalance) (struct usb_microdia *dev);
418 };
419
420 /**
421 * @def MICRODIA_PERCENT
422 * Calculate a value from a percent
423 */
424 #define MICRODIA_PERCENT(x,y) ( ((int)x * (int)y) / 100)
425
426
427 /**
428 * @def to_microdia_dev(d)
429 * Cast a member of a structure out to the containing structure
430 */
431 #define to_microdia_dev(d) container_of(d, struct usb_microdia, kref)
432
433
434 extern const struct microdia_coord microdia_image_sizes[MICRODIA_NBR_SIZES];
435 extern struct mutex open_lock;
436
437 int usb_microdia_control_write(struct usb_microdia *, __u16, __u8 *, __u16);
438 int usb_microdia_control_write_multi(struct usb_microdia *, __u16*, __u8 *,
439 __u16, __u16);
440 int usb_microdia_control_read(struct usb_microdia *, __u16, __u8 *, __u16);
441 int usb_microdia_set_feature(struct usb_microdia *, int);
442
443 int usb_microdia_set_configuration(struct usb_microdia *);
444 int usb_microdia_isoc_init(struct usb_microdia *);
445 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19)
446 void usb_microdia_isoc_handler(struct urb *, struct pt_regs *);
447 #else
448 void usb_microdia_isoc_handler(struct urb *);
449 #endif
450 void usb_microdia_isoc_cleanup(struct usb_microdia *);
451 void usb_microdia_delete(struct kref *);
452
453
454 int dev_microdia_initialize_device(struct usb_microdia *);
455 int dev_microdia_start_stream(struct usb_microdia *);
456 int dev_microdia_stop_stream(struct usb_microdia *);
457 int dev_microdia_check_device(struct usb_microdia *, int);
458 int dev_microdia_camera_on(struct usb_microdia *);
459 int dev_microdia_camera_off(struct usb_microdia *);
460 int dev_microdia_camera_asleep(struct usb_microdia *);
461 int dev_microdia_init_camera(struct usb_microdia *);
462 int dev_microdia_reconf_camera(struct usb_microdia *);
463 int dev_microdia_camera_settings(struct usb_microdia *);
464 int dev_microdia_camera_set_contrast(struct usb_microdia *);
465 int dev_microdia_camera_set_brightness(struct usb_microdia *);
466 int dev_microdia_camera_set_gamma(struct usb_microdia *);
467 int dev_microdia_camera_set_exposure(struct usb_microdia *);
468 int dev_microdia_camera_set_hvflip(struct usb_microdia *);
469 int dev_microdia_camera_set_sharpness(struct usb_microdia *dev);
470 int dev_microdia_camera_set_rgb_gain(struct usb_microdia *dev);
471 int dev_microdia_camera_set_auto_exposure(struct usb_microdia *dev);
472 int dev_microdia_camera_set_auto_whitebalance(struct usb_microdia *dev);
473 //int dev_microdia_set_camera_quality(struct usb_microdia *);
474 int dev_microdia_set_camera_fps(struct usb_microdia *);
475
476 struct v4l2_pix_format *v4l2_enum_supported_formats(struct usb_microdia *,
477 __u8);
478 int v4l_microdia_select_video_mode(struct usb_microdia *, int);
479 int v4l_microdia_register_video_device(struct usb_microdia *);
480 int v4l_microdia_unregister_video_device(struct usb_microdia *);
481
482 int microdia_create_sysfs_files(struct video_device *);
483 void microdia_remove_sysfs_files(struct video_device *);
484
485 void microdia_queue_init(struct microdia_video_queue *);
486 int microdia_alloc_buffers(struct microdia_video_queue *,
487 unsigned int, unsigned int);
488 int microdia_free_buffers(struct microdia_video_queue *);
489 int microdia_queue_enable(struct microdia_video_queue *, int);
490 void microdia_queue_cancel(struct microdia_video_queue *);
491 unsigned int microdia_queue_poll(struct microdia_video_queue *,
492 struct file *, poll_table *);
493 int microdia_query_buffer(struct microdia_video_queue *, struct v4l2_buffer *);
494 int microdia_queue_buffer(struct microdia_video_queue *, struct v4l2_buffer *);
495 int microdia_dequeue_buffer(struct microdia_video_queue *,
496 struct v4l2_buffer *, int);
497 struct microdia_buffer *microdia_queue_next_buffer(
498 struct microdia_video_queue *, struct microdia_buffer *);
499
500 int microdia_decompress(struct usb_microdia *, struct v4l2_buffer *);
501 #endif
Microdia : webcam kernel driver, for USB webcams with vendor id 0c45