2 * Pixart PAC207BCA library
4 * Copyright (C) 2008 Hans de Goede <j.w.r.degoede@hhs.nl>
5 * Copyright (C) 2005 Thomas Kaiser thomas@kaiser-linux.li
6 * Copyleft (C) 2005 Michel Xhaard mxhaard@magic.fr
8 * V4L2 by Jean-Francois Moine <http://moinejf.free.fr>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #define MODULE_NAME "pac207"
30 MODULE_AUTHOR("Hans de Goede <j.w.r.degoede@hhs.nl>");
31 MODULE_DESCRIPTION("Pixart PAC207");
32 MODULE_LICENSE("GPL");
34 #define PAC207_CTRL_TIMEOUT 100 /* ms */
36 #define PAC207_BRIGHTNESS_MIN 0
37 #define PAC207_BRIGHTNESS_MAX 255
38 #define PAC207_BRIGHTNESS_DEFAULT 4 /* power on default: 4 */
40 /* An exposure value of 4 also works (3 does not) but then we need to lower
41 the compression balance setting when in 352x288 mode, otherwise the usb
42 bandwidth is not enough and packets get dropped resulting in corrupt
43 frames. The problem with this is that when the compression balance gets
44 lowered below 0x80, the pac207 starts using a different compression
45 algorithm for some lines, these lines get prefixed with a 0x2dd2 prefix
46 and currently we do not know how to decompress these lines, so for now
47 we use a minimum exposure value of 5 */
48 #define PAC207_EXPOSURE_MIN 5
49 #define PAC207_EXPOSURE_MAX 26
50 #define PAC207_EXPOSURE_DEFAULT 5 /* power on default: 3 ?? */
51 #define PAC207_EXPOSURE_KNEE 11 /* 4 = 30 fps, 11 = 8, 15 = 6 */
53 #define PAC207_GAIN_MIN 0
54 #define PAC207_GAIN_MAX 31
55 #define PAC207_GAIN_DEFAULT 9 /* power on default: 9 */
56 #define PAC207_GAIN_KNEE 20
58 #define PAC207_AUTOGAIN_DEADZONE 30
60 /* specific webcam descriptor */
62 struct gspca_dev gspca_dev; /* !! must be the first item */
73 u8 autogain_ignore_frames;
78 /* V4L2 controls supported by the driver */
79 static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val);
80 static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val);
81 static int sd_setexposure(struct gspca_dev *gspca_dev, __s32 val);
82 static int sd_getexposure(struct gspca_dev *gspca_dev, __s32 *val);
83 static int sd_setautogain(struct gspca_dev *gspca_dev, __s32 val);
84 static int sd_getautogain(struct gspca_dev *gspca_dev, __s32 *val);
85 static int sd_setgain(struct gspca_dev *gspca_dev, __s32 val);
86 static int sd_getgain(struct gspca_dev *gspca_dev, __s32 *val);
88 static struct ctrl sd_ctrls[] = {
89 #define SD_BRIGHTNESS 0
92 .id = V4L2_CID_BRIGHTNESS,
93 .type = V4L2_CTRL_TYPE_INTEGER,
95 .minimum = PAC207_BRIGHTNESS_MIN,
96 .maximum = PAC207_BRIGHTNESS_MAX,
98 .default_value = PAC207_BRIGHTNESS_DEFAULT,
101 .set = sd_setbrightness,
102 .get = sd_getbrightness,
104 #define SD_EXPOSURE 1
107 .id = V4L2_CID_EXPOSURE,
108 .type = V4L2_CTRL_TYPE_INTEGER,
110 .minimum = PAC207_EXPOSURE_MIN,
111 .maximum = PAC207_EXPOSURE_MAX,
113 .default_value = PAC207_EXPOSURE_DEFAULT,
116 .set = sd_setexposure,
117 .get = sd_getexposure,
119 #define SD_AUTOGAIN 2
122 .id = V4L2_CID_AUTOGAIN,
123 .type = V4L2_CTRL_TYPE_BOOLEAN,
128 #define AUTOGAIN_DEF 1
129 .default_value = AUTOGAIN_DEF,
132 .set = sd_setautogain,
133 .get = sd_getautogain,
139 .type = V4L2_CTRL_TYPE_INTEGER,
141 .minimum = PAC207_GAIN_MIN,
142 .maximum = PAC207_GAIN_MAX,
144 .default_value = PAC207_GAIN_DEFAULT,
152 static struct v4l2_pix_format sif_mode[] = {
153 {176, 144, V4L2_PIX_FMT_PAC207, V4L2_FIELD_NONE,
155 .sizeimage = (176 + 2) * 144,
156 /* uncompressed, add 2 bytes / line for line header */
157 .colorspace = V4L2_COLORSPACE_SRGB,
159 {352, 288, V4L2_PIX_FMT_PAC207, V4L2_FIELD_NONE,
161 /* compressed, but only when needed (not compressed
162 when the framerate is low) */
163 .sizeimage = (352 + 2) * 288,
164 .colorspace = V4L2_COLORSPACE_SRGB,
168 static const __u8 pac207_sensor_init[][8] = {
169 {0x10, 0x12, 0x0d, 0x12, 0x0c, 0x01, 0x29, 0xf0},
170 {0x00, 0x64, 0x64, 0x64, 0x04, 0x10, 0xf0, 0x30},
171 {0x00, 0x00, 0x00, 0x70, 0xa0, 0xf8, 0x00, 0x00},
172 {0x00, 0x00, 0x32, 0x00, 0x96, 0x00, 0xa2, 0x02},
173 {0x32, 0x00, 0x96, 0x00, 0xA2, 0x02, 0xaf, 0x00},
176 /* 48 reg_72 Rate Control end BalSize_4a =0x36 */
177 static const __u8 PacReg72[] = { 0x00, 0x00, 0x36, 0x00 };
179 static int pac207_write_regs(struct gspca_dev *gspca_dev, u16 index,
180 const u8 *buffer, u16 length)
182 struct usb_device *udev = gspca_dev->dev;
185 memcpy(gspca_dev->usb_buf, buffer, length);
187 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x01,
188 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
190 gspca_dev->usb_buf, length, PAC207_CTRL_TIMEOUT);
193 "Failed to write registers to index 0x%04X, error %d)",
200 static int pac207_write_reg(struct gspca_dev *gspca_dev, u16 index, u16 value)
202 struct usb_device *udev = gspca_dev->dev;
205 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x00,
206 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
207 value, index, NULL, 0, PAC207_CTRL_TIMEOUT);
209 PDEBUG(D_ERR, "Failed to write a register (index 0x%04X,"
210 " value 0x%02X, error %d)", index, value, err);
215 static int pac207_read_reg(struct gspca_dev *gspca_dev, u16 index)
217 struct usb_device *udev = gspca_dev->dev;
220 res = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), 0x00,
221 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
223 gspca_dev->usb_buf, 1, PAC207_CTRL_TIMEOUT);
226 "Failed to read a register (index 0x%04X, error %d)",
231 return gspca_dev->usb_buf[0];
234 /* this function is called at probe time */
235 static int sd_config(struct gspca_dev *gspca_dev,
236 const struct usb_device_id *id)
238 struct sd *sd = (struct sd *) gspca_dev;
242 idreg[0] = pac207_read_reg(gspca_dev, 0x0000);
243 idreg[1] = pac207_read_reg(gspca_dev, 0x0001);
244 idreg[0] = ((idreg[0] & 0x0F) << 4) | ((idreg[1] & 0xf0) >> 4);
245 idreg[1] = idreg[1] & 0x0f;
246 PDEBUG(D_PROBE, "Pixart Sensor ID 0x%02X Chips ID 0x%02X",
249 if (idreg[0] != 0x27) {
250 PDEBUG(D_PROBE, "Error invalid sensor ID!");
255 "Pixart PAC207BCA Image Processor and Control Chip detected"
256 " (vid/pid 0x%04X:0x%04X)", id->idVendor, id->idProduct);
258 cam = &gspca_dev->cam;
260 cam->cam_mode = sif_mode;
261 cam->nmodes = ARRAY_SIZE(sif_mode);
262 sd->brightness = PAC207_BRIGHTNESS_DEFAULT;
263 sd->exposure = PAC207_EXPOSURE_DEFAULT;
264 sd->gain = PAC207_GAIN_DEFAULT;
265 sd->autogain = AUTOGAIN_DEF;
270 /* this function is called at probe and resume time */
271 static int sd_init(struct gspca_dev *gspca_dev)
273 pac207_write_reg(gspca_dev, 0x41, 0x00);
274 /* Bit_0=Image Format,
276 * Bit_2=Compression test mode enable */
277 pac207_write_reg(gspca_dev, 0x0f, 0x00); /* Power Control */
278 pac207_write_reg(gspca_dev, 0x11, 0x30); /* Analog Bias */
283 /* -- start the camera -- */
284 static int sd_start(struct gspca_dev *gspca_dev)
286 struct sd *sd = (struct sd *) gspca_dev;
289 pac207_write_reg(gspca_dev, 0x0f, 0x10); /* Power control (Bit 6-0) */
290 pac207_write_regs(gspca_dev, 0x0002, pac207_sensor_init[0], 8);
291 pac207_write_regs(gspca_dev, 0x000a, pac207_sensor_init[1], 8);
292 pac207_write_regs(gspca_dev, 0x0012, pac207_sensor_init[2], 8);
293 pac207_write_regs(gspca_dev, 0x0040, pac207_sensor_init[3], 8);
294 pac207_write_regs(gspca_dev, 0x0042, pac207_sensor_init[4], 8);
295 pac207_write_regs(gspca_dev, 0x0048, PacReg72, 4);
297 /* Compression Balance */
298 if (gspca_dev->width == 176)
299 pac207_write_reg(gspca_dev, 0x4a, 0xff);
301 pac207_write_reg(gspca_dev, 0x4a, 0x88);
302 pac207_write_reg(gspca_dev, 0x4b, 0x00); /* Sram test value */
303 pac207_write_reg(gspca_dev, 0x08, sd->brightness);
305 /* PGA global gain (Bit 4-0) */
306 pac207_write_reg(gspca_dev, 0x0e, sd->gain);
307 pac207_write_reg(gspca_dev, 0x02, sd->exposure); /* PXCK = 12MHz /n */
309 mode = 0x02; /* Image Format (Bit 0), LED (1), Compr. test mode (2) */
310 if (gspca_dev->width == 176) { /* 176x144 */
312 PDEBUG(D_STREAM, "pac207_start mode 176x144");
313 } else { /* 352x288 */
314 PDEBUG(D_STREAM, "pac207_start mode 352x288");
316 pac207_write_reg(gspca_dev, 0x41, mode);
318 pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
319 pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
321 pac207_write_reg(gspca_dev, 0x40, 0x01); /* Start ISO pipe */
324 sd->autogain_ignore_frames = 0;
325 atomic_set(&sd->avg_lum, -1);
329 static void sd_stopN(struct gspca_dev *gspca_dev)
331 pac207_write_reg(gspca_dev, 0x40, 0x00); /* Stop ISO pipe */
332 pac207_write_reg(gspca_dev, 0x41, 0x00); /* Turn of LED */
333 pac207_write_reg(gspca_dev, 0x0f, 0x00); /* Power Control */
336 /* Include pac common sof detection functions */
337 #include "pac_common.h"
339 static void pac207_do_auto_gain(struct gspca_dev *gspca_dev)
341 struct sd *sd = (struct sd *) gspca_dev;
342 int avg_lum = atomic_read(&sd->avg_lum);
347 if (sd->autogain_ignore_frames > 0)
348 sd->autogain_ignore_frames--;
349 else if (gspca_auto_gain_n_exposure(gspca_dev, avg_lum,
350 100 + sd->brightness / 2, PAC207_AUTOGAIN_DEADZONE,
351 PAC207_GAIN_KNEE, PAC207_EXPOSURE_KNEE))
352 sd->autogain_ignore_frames = PAC_AUTOGAIN_IGNORE_FRAMES;
355 static void sd_pkt_scan(struct gspca_dev *gspca_dev,
356 struct gspca_frame *frame,
360 struct sd *sd = (struct sd *) gspca_dev;
363 sof = pac_find_sof(gspca_dev, data, len);
367 /* finish decoding current frame */
369 if (n > sizeof pac_sof_marker)
370 n -= sizeof pac_sof_marker;
373 frame = gspca_frame_add(gspca_dev, LAST_PACKET, frame,
376 gspca_frame_add(gspca_dev, FIRST_PACKET, frame, NULL, 0);
380 if (sd->header_read < 11) {
383 /* get average lumination from frame header (byte 5) */
384 if (sd->header_read < 5) {
385 needed = 5 - sd->header_read;
387 atomic_set(&sd->avg_lum, data[needed - 1]);
389 /* skip the rest of the header */
390 needed = 11 - sd->header_read;
392 sd->header_read += len;
397 sd->header_read = 11;
400 gspca_frame_add(gspca_dev, INTER_PACKET, frame, data, len);
403 static void setbrightness(struct gspca_dev *gspca_dev)
405 struct sd *sd = (struct sd *) gspca_dev;
407 pac207_write_reg(gspca_dev, 0x08, sd->brightness);
408 pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
409 pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
412 static void setexposure(struct gspca_dev *gspca_dev)
414 struct sd *sd = (struct sd *) gspca_dev;
416 pac207_write_reg(gspca_dev, 0x02, sd->exposure);
417 pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
418 pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
421 static void setgain(struct gspca_dev *gspca_dev)
423 struct sd *sd = (struct sd *) gspca_dev;
425 pac207_write_reg(gspca_dev, 0x0e, sd->gain);
426 pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
427 pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
430 static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val)
432 struct sd *sd = (struct sd *) gspca_dev;
434 sd->brightness = val;
435 if (gspca_dev->streaming)
436 setbrightness(gspca_dev);
440 static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val)
442 struct sd *sd = (struct sd *) gspca_dev;
444 *val = sd->brightness;
448 static int sd_setexposure(struct gspca_dev *gspca_dev, __s32 val)
450 struct sd *sd = (struct sd *) gspca_dev;
453 if (gspca_dev->streaming)
454 setexposure(gspca_dev);
458 static int sd_getexposure(struct gspca_dev *gspca_dev, __s32 *val)
460 struct sd *sd = (struct sd *) gspca_dev;
466 static int sd_setgain(struct gspca_dev *gspca_dev, __s32 val)
468 struct sd *sd = (struct sd *) gspca_dev;
471 if (gspca_dev->streaming)
476 static int sd_getgain(struct gspca_dev *gspca_dev, __s32 *val)
478 struct sd *sd = (struct sd *) gspca_dev;
484 static int sd_setautogain(struct gspca_dev *gspca_dev, __s32 val)
486 struct sd *sd = (struct sd *) gspca_dev;
489 /* when switching to autogain set defaults to make sure
490 we are on a valid point of the autogain gain /
491 exposure knee graph, and give this change time to
492 take effect before doing autogain. */
494 sd->exposure = PAC207_EXPOSURE_DEFAULT;
495 sd->gain = PAC207_GAIN_DEFAULT;
496 if (gspca_dev->streaming) {
497 sd->autogain_ignore_frames =
498 PAC_AUTOGAIN_IGNORE_FRAMES;
499 setexposure(gspca_dev);
507 static int sd_getautogain(struct gspca_dev *gspca_dev, __s32 *val)
509 struct sd *sd = (struct sd *) gspca_dev;
515 /* sub-driver description */
516 static const struct sd_desc sd_desc = {
519 .nctrls = ARRAY_SIZE(sd_ctrls),
524 .dq_callback = pac207_do_auto_gain,
525 .pkt_scan = sd_pkt_scan,
528 /* -- module initialisation -- */
529 static const __devinitdata struct usb_device_id device_table[] = {
530 {USB_DEVICE(0x041e, 0x4028)},
531 {USB_DEVICE(0x093a, 0x2460)},
532 {USB_DEVICE(0x093a, 0x2463)},
533 {USB_DEVICE(0x093a, 0x2464)},
534 {USB_DEVICE(0x093a, 0x2468)},
535 {USB_DEVICE(0x093a, 0x2470)},
536 {USB_DEVICE(0x093a, 0x2471)},
537 {USB_DEVICE(0x093a, 0x2472)},
538 {USB_DEVICE(0x093a, 0x2476)},
539 {USB_DEVICE(0x2001, 0xf115)},
542 MODULE_DEVICE_TABLE(usb, device_table);
544 /* -- device connect -- */
545 static int sd_probe(struct usb_interface *intf,
546 const struct usb_device_id *id)
548 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
552 static struct usb_driver sd_driver = {
554 .id_table = device_table,
556 .disconnect = gspca_disconnect,
558 .suspend = gspca_suspend,
559 .resume = gspca_resume,
563 /* -- module insert / remove -- */
564 static int __init sd_mod_init(void)
566 if (usb_register(&sd_driver) < 0)
568 PDEBUG(D_PROBE, "registered");
571 static void __exit sd_mod_exit(void)
573 usb_deregister(&sd_driver);
574 PDEBUG(D_PROBE, "deregistered");
577 module_init(sd_mod_init);
578 module_exit(sd_mod_exit);