2 * Copyright (c) 2001 Jean-Fredric Clere, Nikolas Zimmermann, Georg Acher
3 * Mark Cave-Ayland, Carlo E Prelz, Dick Streefland
4 * Copyright (c) 2002, 2003 Tuukka Toivonen
5 * Copyright (c) 2008 Erik Andrén
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * P/N 861037: Sensor HDCS1000 ASIC STV0600
22 * P/N 861050-0010: Sensor HDCS1000 ASIC STV0600
23 * P/N 861050-0020: Sensor Photobit PB100 ASIC STV0600-1 - QuickCam Express
24 * P/N 861055: Sensor ST VV6410 ASIC STV0610 - LEGO cam
25 * P/N 861075-0040: Sensor HDCS1000 ASIC
26 * P/N 961179-0700: Sensor ST VV6410 ASIC STV0602 - Dexxa WebCam USB
27 * P/N 861040-0000: Sensor ST VV6410 ASIC STV0610 - QuickCam Web
31 * The spec file for the PB-0100 suggests the following for best quality
32 * images after the sensor has been reset :
34 * PB_ADCGAINL = R60 = 0x03 (3 dec) : sets low reference of ADC
35 to produce good black level
36 * PB_PREADCTRL = R32 = 0x1400 (5120 dec) : Enables global gain changes
38 * PB_ADCMINGAIN = R52 = 0x10 (16 dec) : Sets the minimum gain for
40 * PB_ADCGLOBALGAIN = R53 = 0x10 (16 dec) : Sets the global gain
41 * PB_EXPGAIN = R14 = 0x11 (17 dec) : Sets the auto-exposure value
42 * PB_UPDATEINT = R23 = 0x02 (2 dec) : Sets the speed on
44 * PB_CFILLIN = R5 = 0x0E (14 dec) : Sets the frame rate
47 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
49 #include "stv06xx_pb0100.h"
52 struct { /* one big happy control cluster... */
53 struct v4l2_ctrl *autogain;
54 struct v4l2_ctrl *gain;
55 struct v4l2_ctrl *exposure;
56 struct v4l2_ctrl *red;
57 struct v4l2_ctrl *blue;
58 struct v4l2_ctrl *natural;
60 struct v4l2_ctrl *target;
63 static struct v4l2_pix_format pb0100_mode[] = {
64 /* low res / subsample modes disabled as they are only half res horizontal,
65 halving the vertical resolution does not seem to work */
71 .sizeimage = 320 * 240,
73 .colorspace = V4L2_COLORSPACE_SRGB,
74 .priv = PB0100_CROP_TO_VGA
81 .sizeimage = 352 * 288,
83 .colorspace = V4L2_COLORSPACE_SRGB,
88 static int pb0100_s_ctrl(struct v4l2_ctrl *ctrl)
90 struct gspca_dev *gspca_dev =
91 container_of(ctrl->handler, struct gspca_dev, ctrl_handler);
92 struct sd *sd = (struct sd *)gspca_dev;
93 struct pb0100_ctrls *ctrls = sd->sensor_priv;
97 case V4L2_CID_AUTOGAIN:
98 err = pb0100_set_autogain(gspca_dev, ctrl->val);
103 err = pb0100_set_gain(gspca_dev, ctrls->gain->val);
106 err = pb0100_set_exposure(gspca_dev, ctrls->exposure->val);
108 case V4L2_CTRL_CLASS_USER + 0x1001:
109 err = pb0100_set_autogain_target(gspca_dev, ctrl->val);
115 static const struct v4l2_ctrl_ops pb0100_ctrl_ops = {
116 .s_ctrl = pb0100_s_ctrl,
119 static int pb0100_init_controls(struct sd *sd)
121 struct v4l2_ctrl_handler *hdl = &sd->gspca_dev.ctrl_handler;
122 struct pb0100_ctrls *ctrls;
123 static const struct v4l2_ctrl_config autogain_target = {
124 .ops = &pb0100_ctrl_ops,
125 .id = V4L2_CTRL_CLASS_USER + 0x1000,
126 .type = V4L2_CTRL_TYPE_INTEGER,
127 .name = "Automatic Gain Target",
132 static const struct v4l2_ctrl_config natural_light = {
133 .ops = &pb0100_ctrl_ops,
134 .id = V4L2_CTRL_CLASS_USER + 0x1001,
135 .type = V4L2_CTRL_TYPE_BOOLEAN,
136 .name = "Natural Light Source",
142 ctrls = kzalloc(sizeof(*ctrls), GFP_KERNEL);
146 v4l2_ctrl_handler_init(hdl, 6);
147 ctrls->autogain = v4l2_ctrl_new_std(hdl, &pb0100_ctrl_ops,
148 V4L2_CID_AUTOGAIN, 0, 1, 1, 1);
149 ctrls->exposure = v4l2_ctrl_new_std(hdl, &pb0100_ctrl_ops,
150 V4L2_CID_EXPOSURE, 0, 511, 1, 12);
151 ctrls->gain = v4l2_ctrl_new_std(hdl, &pb0100_ctrl_ops,
152 V4L2_CID_GAIN, 0, 255, 1, 128);
153 ctrls->red = v4l2_ctrl_new_std(hdl, &pb0100_ctrl_ops,
154 V4L2_CID_RED_BALANCE, -255, 255, 1, 0);
155 ctrls->blue = v4l2_ctrl_new_std(hdl, &pb0100_ctrl_ops,
156 V4L2_CID_BLUE_BALANCE, -255, 255, 1, 0);
157 ctrls->natural = v4l2_ctrl_new_custom(hdl, &natural_light, NULL);
158 ctrls->target = v4l2_ctrl_new_custom(hdl, &autogain_target, NULL);
163 sd->sensor_priv = ctrls;
164 v4l2_ctrl_auto_cluster(5, &ctrls->autogain, 0, false);
168 static int pb0100_probe(struct sd *sd)
173 err = stv06xx_read_sensor(sd, PB_IDENT, &sensor);
177 if ((sensor >> 8) != 0x64)
180 pr_info("Photobit pb0100 sensor detected\n");
182 sd->gspca_dev.cam.cam_mode = pb0100_mode;
183 sd->gspca_dev.cam.nmodes = ARRAY_SIZE(pb0100_mode);
188 static int pb0100_start(struct sd *sd)
190 int err, packet_size, max_packet_size;
191 struct usb_host_interface *alt;
192 struct usb_interface *intf;
193 struct gspca_dev *gspca_dev = (struct gspca_dev *)sd;
194 struct cam *cam = &sd->gspca_dev.cam;
195 u32 mode = cam->cam_mode[sd->gspca_dev.curr_mode].priv;
197 intf = usb_ifnum_to_if(sd->gspca_dev.dev, sd->gspca_dev.iface);
198 alt = usb_altnum_to_altsetting(intf, sd->gspca_dev.alt);
202 if (alt->desc.bNumEndpoints < 1)
205 packet_size = le16_to_cpu(alt->endpoint[0].desc.wMaxPacketSize);
207 /* If we don't have enough bandwidth use a lower framerate */
208 max_packet_size = sd->sensor->max_packet_size[sd->gspca_dev.curr_mode];
209 if (packet_size < max_packet_size)
210 stv06xx_write_sensor(sd, PB_ROWSPEED, BIT(4)|BIT(3)|BIT(1));
212 stv06xx_write_sensor(sd, PB_ROWSPEED, BIT(5)|BIT(3)|BIT(1));
214 /* Setup sensor window */
215 if (mode & PB0100_CROP_TO_VGA) {
216 stv06xx_write_sensor(sd, PB_RSTART, 30);
217 stv06xx_write_sensor(sd, PB_CSTART, 20);
218 stv06xx_write_sensor(sd, PB_RWSIZE, 240 - 1);
219 stv06xx_write_sensor(sd, PB_CWSIZE, 320 - 1);
221 stv06xx_write_sensor(sd, PB_RSTART, 8);
222 stv06xx_write_sensor(sd, PB_CSTART, 4);
223 stv06xx_write_sensor(sd, PB_RWSIZE, 288 - 1);
224 stv06xx_write_sensor(sd, PB_CWSIZE, 352 - 1);
227 if (mode & PB0100_SUBSAMPLE) {
228 stv06xx_write_bridge(sd, STV_Y_CTRL, 0x02); /* Wrong, FIXME */
229 stv06xx_write_bridge(sd, STV_X_CTRL, 0x06);
231 stv06xx_write_bridge(sd, STV_SCAN_RATE, 0x10);
233 stv06xx_write_bridge(sd, STV_Y_CTRL, 0x01);
234 stv06xx_write_bridge(sd, STV_X_CTRL, 0x0a);
235 /* larger -> slower */
236 stv06xx_write_bridge(sd, STV_SCAN_RATE, 0x20);
239 err = stv06xx_write_sensor(sd, PB_CONTROL, BIT(5)|BIT(3)|BIT(1));
240 PDEBUG(D_STREAM, "Started stream, status: %d", err);
242 return (err < 0) ? err : 0;
245 static int pb0100_stop(struct sd *sd)
247 struct gspca_dev *gspca_dev = (struct gspca_dev *)sd;
250 err = stv06xx_write_sensor(sd, PB_ABORTFRAME, 1);
255 /* Set bit 1 to zero */
256 err = stv06xx_write_sensor(sd, PB_CONTROL, BIT(5)|BIT(3));
258 PDEBUG(D_STREAM, "Halting stream");
260 return (err < 0) ? err : 0;
263 /* FIXME: Sort the init commands out and put them into tables,
264 this is only for getting the camera to work */
265 /* FIXME: No error handling for now,
266 add this once the init has been converted to proper tables */
267 static int pb0100_init(struct sd *sd)
269 stv06xx_write_bridge(sd, STV_REG00, 1);
270 stv06xx_write_bridge(sd, STV_SCAN_RATE, 0);
273 stv06xx_write_sensor(sd, PB_RESET, 1);
274 stv06xx_write_sensor(sd, PB_RESET, 0);
277 stv06xx_write_sensor(sd, PB_CONTROL, BIT(5)|BIT(3));
280 stv06xx_write_sensor(sd, PB_PREADCTRL, BIT(12)|BIT(10)|BIT(6));
281 stv06xx_write_sensor(sd, PB_ADCGLOBALGAIN, 12);
283 /* Set up auto-exposure */
284 /* ADC VREF_HI new setting for a transition
285 from the Expose1 to the Expose2 setting */
286 stv06xx_write_sensor(sd, PB_R28, 12);
287 /* gain max for autoexposure */
288 stv06xx_write_sensor(sd, PB_ADCMAXGAIN, 180);
289 /* gain min for autoexposure */
290 stv06xx_write_sensor(sd, PB_ADCMINGAIN, 12);
291 /* Maximum frame integration time (programmed into R8)
292 allowed for auto-exposure routine */
293 stv06xx_write_sensor(sd, PB_R54, 3);
294 /* Minimum frame integration time (programmed into R8)
295 allowed for auto-exposure routine */
296 stv06xx_write_sensor(sd, PB_R55, 0);
297 stv06xx_write_sensor(sd, PB_UPDATEINT, 1);
298 /* R15 Expose0 (maximum that auto-exposure may use) */
299 stv06xx_write_sensor(sd, PB_R15, 800);
300 /* R17 Expose2 (minimum that auto-exposure may use) */
301 stv06xx_write_sensor(sd, PB_R17, 10);
303 stv06xx_write_sensor(sd, PB_EXPGAIN, 0);
306 stv06xx_write_sensor(sd, PB_VOFFSET, 0);
308 stv06xx_write_sensor(sd, PB_ADCGAINH, 11);
309 /* Set black level (important!) */
310 stv06xx_write_sensor(sd, PB_ADCGAINL, 0);
313 stv06xx_write_bridge(sd, STV_REG00, 0x11);
314 stv06xx_write_bridge(sd, STV_REG03, 0x45);
315 stv06xx_write_bridge(sd, STV_REG04, 0x07);
317 /* Scan/timing for the sensor */
318 stv06xx_write_sensor(sd, PB_ROWSPEED, BIT(4)|BIT(3)|BIT(1));
319 stv06xx_write_sensor(sd, PB_CFILLIN, 14);
320 stv06xx_write_sensor(sd, PB_VBL, 0);
321 stv06xx_write_sensor(sd, PB_FINTTIME, 0);
322 stv06xx_write_sensor(sd, PB_RINTTIME, 123);
324 stv06xx_write_bridge(sd, STV_REG01, 0xc2);
325 stv06xx_write_bridge(sd, STV_REG02, 0xb0);
329 static int pb0100_dump(struct sd *sd)
334 static int pb0100_set_gain(struct gspca_dev *gspca_dev, __s32 val)
337 struct sd *sd = (struct sd *) gspca_dev;
338 struct pb0100_ctrls *ctrls = sd->sensor_priv;
340 err = stv06xx_write_sensor(sd, PB_G1GAIN, val);
342 err = stv06xx_write_sensor(sd, PB_G2GAIN, val);
343 PDEBUG(D_CONF, "Set green gain to %d, status: %d", val, err);
346 err = pb0100_set_red_balance(gspca_dev, ctrls->red->val);
348 err = pb0100_set_blue_balance(gspca_dev, ctrls->blue->val);
353 static int pb0100_set_red_balance(struct gspca_dev *gspca_dev, __s32 val)
356 struct sd *sd = (struct sd *) gspca_dev;
357 struct pb0100_ctrls *ctrls = sd->sensor_priv;
359 val += ctrls->gain->val;
365 err = stv06xx_write_sensor(sd, PB_RGAIN, val);
366 PDEBUG(D_CONF, "Set red gain to %d, status: %d", val, err);
371 static int pb0100_set_blue_balance(struct gspca_dev *gspca_dev, __s32 val)
374 struct sd *sd = (struct sd *) gspca_dev;
375 struct pb0100_ctrls *ctrls = sd->sensor_priv;
377 val += ctrls->gain->val;
383 err = stv06xx_write_sensor(sd, PB_BGAIN, val);
384 PDEBUG(D_CONF, "Set blue gain to %d, status: %d", val, err);
389 static int pb0100_set_exposure(struct gspca_dev *gspca_dev, __s32 val)
391 struct sd *sd = (struct sd *) gspca_dev;
394 err = stv06xx_write_sensor(sd, PB_RINTTIME, val);
395 PDEBUG(D_CONF, "Set exposure to %d, status: %d", val, err);
400 static int pb0100_set_autogain(struct gspca_dev *gspca_dev, __s32 val)
403 struct sd *sd = (struct sd *) gspca_dev;
404 struct pb0100_ctrls *ctrls = sd->sensor_priv;
407 if (ctrls->natural->val)
408 val = BIT(6)|BIT(4)|BIT(0);
414 err = stv06xx_write_sensor(sd, PB_EXPGAIN, val);
415 PDEBUG(D_CONF, "Set autogain to %d (natural: %d), status: %d",
416 val, ctrls->natural->val, err);
421 static int pb0100_set_autogain_target(struct gspca_dev *gspca_dev, __s32 val)
423 int err, totalpixels, brightpixels, darkpixels;
424 struct sd *sd = (struct sd *) gspca_dev;
426 /* Number of pixels counted by the sensor when subsampling the pixels.
427 * Slightly larger than the real value to avoid oscillation */
428 totalpixels = gspca_dev->pixfmt.width * gspca_dev->pixfmt.height;
429 totalpixels = totalpixels/(8*8) + totalpixels/(64*64);
431 brightpixels = (totalpixels * val) >> 8;
432 darkpixels = totalpixels - brightpixels;
433 err = stv06xx_write_sensor(sd, PB_R21, brightpixels);
435 err = stv06xx_write_sensor(sd, PB_R22, darkpixels);
437 PDEBUG(D_CONF, "Set autogain target to %d, status: %d", val, err);