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
6 * Copyright (c) 2008 Chia-I Wu
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * P/N 861037: Sensor HDCS1000 ASIC STV0600
23 * P/N 861050-0010: Sensor HDCS1000 ASIC STV0600
24 * P/N 861050-0020: Sensor Photobit PB100 ASIC STV0600-1 - QuickCam Express
25 * P/N 861055: Sensor ST VV6410 ASIC STV0610 - LEGO cam
26 * P/N 861075-0040: Sensor HDCS1000 ASIC
27 * P/N 961179-0700: Sensor ST VV6410 ASIC STV0602 - Dexxa WebCam USB
28 * P/N 861040-0000: Sensor ST VV6410 ASIC STV0610 - QuickCam Web
31 #include "stv06xx_hdcs.h"
33 static const struct ctrl hdcs1x00_ctrl[] = {
36 .id = V4L2_CID_EXPOSURE,
37 .type = V4L2_CTRL_TYPE_INTEGER,
42 .default_value = HDCS_DEFAULT_EXPOSURE,
43 .flags = V4L2_CTRL_FLAG_SLIDER
45 .set = hdcs_set_exposure,
46 .get = hdcs_get_exposure
50 .type = V4L2_CTRL_TYPE_INTEGER,
55 .default_value = HDCS_DEFAULT_GAIN,
56 .flags = V4L2_CTRL_FLAG_SLIDER
63 static struct v4l2_pix_format hdcs1x00_mode[] = {
70 HDCS_1X00_DEF_WIDTH * HDCS_1X00_DEF_HEIGHT,
71 .bytesperline = HDCS_1X00_DEF_WIDTH,
72 .colorspace = V4L2_COLORSPACE_SRGB,
77 static const struct ctrl hdcs1020_ctrl[] = {
80 .id = V4L2_CID_EXPOSURE,
81 .type = V4L2_CTRL_TYPE_INTEGER,
86 .default_value = HDCS_DEFAULT_EXPOSURE,
87 .flags = V4L2_CTRL_FLAG_SLIDER
89 .set = hdcs_set_exposure,
90 .get = hdcs_get_exposure
94 .type = V4L2_CTRL_TYPE_INTEGER,
99 .default_value = HDCS_DEFAULT_GAIN,
100 .flags = V4L2_CTRL_FLAG_SLIDER
102 .set = hdcs_set_gain,
107 static struct v4l2_pix_format hdcs1020_mode[] = {
110 HDCS_1020_DEF_HEIGHT,
114 HDCS_1020_DEF_WIDTH * HDCS_1020_DEF_HEIGHT,
115 .bytesperline = HDCS_1020_DEF_WIDTH,
116 .colorspace = V4L2_COLORSPACE_SRGB,
121 enum hdcs_power_state {
129 enum hdcs_power_state state;
132 /* visible area of the sensor array */
140 /* Column timing overhead */
142 /* Column processing overhead */
144 /* Row sample period constant */
146 /* Exposure reset duration */
151 u8 exp_cache, gain_cache;
154 static int hdcs_reg_write_seq(struct sd *sd, u8 reg, u8 *vals, u8 len)
156 u8 regs[I2C_MAX_BYTES * 2];
159 if (unlikely((len <= 0) || (len >= I2C_MAX_BYTES) ||
163 for (i = 0; i < len; i++) {
165 regs[2 * i + 1] = vals[i];
166 /* All addresses are shifted left one bit
167 * as bit 0 toggles r/w */
171 return stv06xx_write_sensor_bytes(sd, regs, len);
174 static int hdcs_set_state(struct sd *sd, enum hdcs_power_state state)
176 struct hdcs *hdcs = sd->sensor_priv;
180 if (hdcs->state == state)
183 /* we need to go idle before running or sleeping */
184 if (hdcs->state != HDCS_STATE_IDLE) {
185 ret = stv06xx_write_sensor(sd, HDCS_REG_CONTROL(sd), 0);
190 hdcs->state = HDCS_STATE_IDLE;
192 if (state == HDCS_STATE_IDLE)
196 case HDCS_STATE_SLEEP:
197 val = HDCS_SLEEP_MODE;
201 val = HDCS_RUN_ENABLE;
208 ret = stv06xx_write_sensor(sd, HDCS_REG_CONTROL(sd), val);
210 /* Update the state if the write succeeded */
217 static int hdcs_reset(struct sd *sd)
219 struct hdcs *hdcs = sd->sensor_priv;
222 err = stv06xx_write_sensor(sd, HDCS_REG_CONTROL(sd), 1);
226 err = stv06xx_write_sensor(sd, HDCS_REG_CONTROL(sd), 0);
228 hdcs->state = HDCS_STATE_IDLE;
233 static int hdcs_get_exposure(struct gspca_dev *gspca_dev, __s32 *val)
235 struct sd *sd = (struct sd *) gspca_dev;
236 struct hdcs *hdcs = sd->sensor_priv;
238 *val = hdcs->exp_cache;
243 static int hdcs_set_exposure(struct gspca_dev *gspca_dev, __s32 val)
245 struct sd *sd = (struct sd *) gspca_dev;
246 struct hdcs *hdcs = sd->sensor_priv;
249 /* Column time period */
251 /* Column processing period */
253 /* Row processing period */
255 /* Minimum number of column timing periods
256 within the column processing period */
262 hdcs->exp_cache = val;
264 cycles = val * HDCS_CLK_FREQ_MHZ * 257;
266 ct = hdcs->exp.cto + hdcs->psmp + (HDCS_ADC_START_SIG_DUR + 2);
267 cp = hdcs->exp.cto + (hdcs->w * ct / 2);
269 /* the cycles one row takes */
270 rp = hdcs->exp.rs + cp;
272 rowexp = cycles / rp;
274 /* the remaining cycles */
275 cycles -= rowexp * rp;
277 /* calculate sub-row exposure */
279 /* see HDCS-1020 datasheet 3.5.6.4, p. 63 */
280 srowexp = hdcs->w - (cycles + hdcs->exp.er + 13) / ct;
282 mnct = (hdcs->exp.er + 12 + ct - 1) / ct;
283 max_srowexp = hdcs->w - mnct;
285 /* see HDCS-1000 datasheet 3.4.5.5, p. 61 */
286 srowexp = cp - hdcs->exp.er - 6 - cycles;
288 mnct = (hdcs->exp.er + 5 + ct - 1) / ct;
289 max_srowexp = cp - mnct * ct - 1;
294 else if (srowexp > max_srowexp)
295 srowexp = max_srowexp;
298 exp[0] = HDCS20_CONTROL;
299 exp[1] = 0x00; /* Stop streaming */
300 exp[2] = HDCS_ROWEXPL;
301 exp[3] = rowexp & 0xff;
302 exp[4] = HDCS_ROWEXPH;
303 exp[5] = rowexp >> 8;
304 exp[6] = HDCS20_SROWEXP;
305 exp[7] = (srowexp >> 2) & 0xff;
306 exp[8] = HDCS20_ERROR;
307 exp[9] = 0x10; /* Clear exposure error flag*/
308 exp[10] = HDCS20_CONTROL;
309 exp[11] = 0x04; /* Restart streaming */
310 err = stv06xx_write_sensor_bytes(sd, exp, 6);
312 exp[0] = HDCS00_CONTROL;
313 exp[1] = 0x00; /* Stop streaming */
314 exp[2] = HDCS_ROWEXPL;
315 exp[3] = rowexp & 0xff;
316 exp[4] = HDCS_ROWEXPH;
317 exp[5] = rowexp >> 8;
318 exp[6] = HDCS00_SROWEXPL;
319 exp[7] = srowexp & 0xff;
320 exp[8] = HDCS00_SROWEXPH;
321 exp[9] = srowexp >> 8;
322 exp[10] = HDCS_STATUS;
323 exp[11] = 0x10; /* Clear exposure error flag*/
324 exp[12] = HDCS00_CONTROL;
325 exp[13] = 0x04; /* Restart streaming */
326 err = stv06xx_write_sensor_bytes(sd, exp, 7);
330 PDEBUG(D_V4L2, "Writing exposure %d, rowexp %d, srowexp %d",
331 val, rowexp, srowexp);
335 static int hdcs_set_gains(struct sd *sd, u8 g)
337 struct hdcs *hdcs = sd->sensor_priv;
341 hdcs->gain_cache = g;
343 /* the voltage gain Av = (1 + 19 * val / 127) * (1 + bit7) */
352 err = hdcs_reg_write_seq(sd, HDCS_ERECPGA, gains, 4);
356 static int hdcs_get_gain(struct gspca_dev *gspca_dev, __s32 *val)
358 struct sd *sd = (struct sd *) gspca_dev;
359 struct hdcs *hdcs = sd->sensor_priv;
361 *val = hdcs->gain_cache;
366 static int hdcs_set_gain(struct gspca_dev *gspca_dev, __s32 val)
368 PDEBUG(D_V4L2, "Writing gain %d", val);
369 return hdcs_set_gains((struct sd *) gspca_dev,
373 static int hdcs_set_size(struct sd *sd,
374 unsigned int width, unsigned int height)
376 struct hdcs *hdcs = sd->sensor_priv;
381 /* must be multiple of 4 */
382 width = (width + 3) & ~0x3;
383 height = (height + 3) & ~0x3;
385 if (width > hdcs->array.width)
386 width = hdcs->array.width;
389 /* the borders are also invalid */
390 if (height + 2 * hdcs->array.border + HDCS_1020_BOTTOM_Y_SKIP
391 > hdcs->array.height)
392 height = hdcs->array.height - 2 * hdcs->array.border -
393 HDCS_1020_BOTTOM_Y_SKIP;
395 y = (hdcs->array.height - HDCS_1020_BOTTOM_Y_SKIP - height) / 2
398 if (height > hdcs->array.height)
399 height = hdcs->array.height;
401 y = hdcs->array.top + (hdcs->array.height - height) / 2;
404 x = hdcs->array.left + (hdcs->array.width - width) / 2;
408 win[2] = (y + height) / 4 - 1;
409 win[3] = (x + width) / 4 - 1;
411 err = hdcs_reg_write_seq(sd, HDCS_FWROW, win, 4);
415 /* Update the current width and height */
421 static int hdcs_probe_1x00(struct sd *sd)
427 ret = stv06xx_read_sensor(sd, HDCS_IDENT, &sensor);
428 if (ret < 0 || sensor != 0x08)
431 info("HDCS-1000/1100 sensor detected");
433 sd->gspca_dev.cam.cam_mode = hdcs1x00_mode;
434 sd->gspca_dev.cam.nmodes = ARRAY_SIZE(hdcs1x00_mode);
435 sd->desc.ctrls = hdcs1x00_ctrl;
436 sd->desc.nctrls = ARRAY_SIZE(hdcs1x00_ctrl);
438 hdcs = kmalloc(sizeof(struct hdcs), GFP_KERNEL);
442 hdcs->array.left = 8;
444 hdcs->array.width = HDCS_1X00_DEF_WIDTH;
445 hdcs->array.height = HDCS_1X00_DEF_HEIGHT;
446 hdcs->array.border = 4;
454 * Frame rate on HDCS-1000 with STV600 depends on PSMP:
455 * 4 = doesn't work at all
463 * Frame rate on HDCS-1000 with STV602 depends on PSMP:
464 * 15 = doesn't work at all
465 * 18 = doesn't work at all
473 hdcs->psmp = (sd->bridge == BRIDGE_STV602) ? 20 : 5;
475 sd->sensor_priv = hdcs;
480 static int hdcs_probe_1020(struct sd *sd)
486 ret = stv06xx_read_sensor(sd, HDCS_IDENT, &sensor);
487 if (ret < 0 || sensor != 0x10)
490 info("HDCS-1020 sensor detected");
492 sd->gspca_dev.cam.cam_mode = hdcs1020_mode;
493 sd->gspca_dev.cam.nmodes = ARRAY_SIZE(hdcs1020_mode);
494 sd->desc.ctrls = hdcs1020_ctrl;
495 sd->desc.nctrls = ARRAY_SIZE(hdcs1020_ctrl);
497 hdcs = kmalloc(sizeof(struct hdcs), GFP_KERNEL);
502 * From Andrey's test image: looks like HDCS-1020 upper-left
503 * visible pixel is at 24,8 (y maybe even smaller?) and lower-right
504 * visible pixel at 375,299 (x maybe even larger?)
506 hdcs->array.left = 24;
508 hdcs->array.width = HDCS_1020_DEF_WIDTH;
509 hdcs->array.height = 304;
510 hdcs->array.border = 4;
519 sd->sensor_priv = hdcs;
524 static int hdcs_start(struct sd *sd)
526 PDEBUG(D_STREAM, "Starting stream");
528 return hdcs_set_state(sd, HDCS_STATE_RUN);
531 static int hdcs_stop(struct sd *sd)
533 PDEBUG(D_STREAM, "Halting stream");
535 return hdcs_set_state(sd, HDCS_STATE_SLEEP);
538 static void hdcs_disconnect(struct sd *sd)
540 PDEBUG(D_PROBE, "Disconnecting the sensor");
541 kfree(sd->sensor_priv);
544 static int hdcs_init(struct sd *sd)
546 struct hdcs *hdcs = sd->sensor_priv;
549 /* Set the STV0602AA in STV0600 emulation mode */
550 if (sd->bridge == BRIDGE_STV602)
551 stv06xx_write_bridge(sd, STV_STV0600_EMULATION, 1);
553 /* Execute the bridge init */
554 for (i = 0; i < ARRAY_SIZE(stv_bridge_init) && !err; i++) {
555 err = stv06xx_write_bridge(sd, stv_bridge_init[i][0],
556 stv_bridge_init[i][1]);
561 /* sensor soft reset */
564 /* Execute the sensor init */
565 for (i = 0; i < ARRAY_SIZE(stv_sensor_init) && !err; i++) {
566 err = stv06xx_write_sensor(sd, stv_sensor_init[i][0],
567 stv_sensor_init[i][1]);
572 /* Enable continous frame capture, bit 2: stop when frame complete */
573 err = stv06xx_write_sensor(sd, HDCS_REG_CONFIG(sd), BIT(3));
577 /* Set PGA sample duration
578 (was 0x7E for the STV602, but caused slow framerate with HDCS-1020) */
580 err = stv06xx_write_sensor(sd, HDCS_TCTRL,
581 (HDCS_ADC_START_SIG_DUR << 6) | hdcs->psmp);
583 err = stv06xx_write_sensor(sd, HDCS_TCTRL,
584 (HDCS_ADC_START_SIG_DUR << 5) | hdcs->psmp);
588 err = hdcs_set_gains(sd, HDCS_DEFAULT_GAIN);
592 err = hdcs_set_size(sd, hdcs->array.width, hdcs->array.height);
596 err = hdcs_set_exposure(&sd->gspca_dev, HDCS_DEFAULT_EXPOSURE);
600 static int hdcs_dump(struct sd *sd)
604 info("Dumping sensor registers:");
606 for (reg = HDCS_IDENT; reg <= HDCS_ROWEXPH; reg++) {
607 stv06xx_read_sensor(sd, reg, &val);
608 info("reg 0x%02x = 0x%02x", reg, val);