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 */
153 static int hdcs_reg_write_seq(struct sd
*sd
, u8 reg
, u8
*vals
, u8 len
)
155 u8 regs
[I2C_MAX_BYTES
* 2];
158 if (unlikely((len
<= 0) || (len
>= I2C_MAX_BYTES
) ||
162 for (i
= 0; i
< len
; i
++) {
164 regs
[2 * i
+ 1] = vals
[i
];
165 /* All addresses are shifted left one bit as bit 0 toggles r/w */
169 return stv06xx_write_sensor_bytes(sd
, regs
, len
);
172 static int hdcs_set_state(struct sd
*sd
, enum hdcs_power_state state
)
174 struct hdcs
*hdcs
= sd
->sensor_priv
;
178 if (hdcs
->state
== state
)
181 /* we need to go idle before running or sleeping */
182 if (hdcs
->state
!= HDCS_STATE_IDLE
) {
183 ret
= stv06xx_write_sensor(sd
, HDCS_REG_CONTROL(sd
), 0);
188 hdcs
->state
= HDCS_STATE_IDLE
;
190 if (state
== HDCS_STATE_IDLE
)
194 case HDCS_STATE_SLEEP
:
195 val
= HDCS_SLEEP_MODE
;
199 val
= HDCS_RUN_ENABLE
;
206 ret
= stv06xx_write_sensor(sd
, HDCS_REG_CONTROL(sd
), val
);
208 /* Update the state if the write succeeded */
215 static int hdcs_reset(struct sd
*sd
)
217 struct hdcs
*hdcs
= sd
->sensor_priv
;
220 err
= stv06xx_write_sensor(sd
, HDCS_REG_CONTROL(sd
), 1);
224 err
= stv06xx_write_sensor(sd
, HDCS_REG_CONTROL(sd
), 0);
226 hdcs
->state
= HDCS_STATE_IDLE
;
231 static int hdcs_get_exposure(struct gspca_dev
*gspca_dev
, __s32
*val
)
233 struct sd
*sd
= (struct sd
*) gspca_dev
;
234 struct hdcs
*hdcs
= sd
->sensor_priv
;
236 /* Column time period */
238 /* Column processing period */
240 /* Row processing period */
247 err
= stv06xx_read_sensor(sd
, HDCS_ROWEXPL
, &data
[0]);
251 err
= stv06xx_read_sensor(sd
, HDCS_ROWEXPH
, &data
[1]);
255 rowexp
= (data
[1] << 8) | data
[0];
257 ct
= hdcs
->exp
.cto
+ hdcs
->psmp
+ (HDCS_ADC_START_SIG_DUR
+ 2);
258 cp
= hdcs
->exp
.cto
+ (hdcs
->w
* ct
/ 2);
259 rp
= hdcs
->exp
.rs
+ cp
;
261 cycles
= rp
* rowexp
;
262 *val
= cycles
/ HDCS_CLK_FREQ_MHZ
;
263 PDEBUG(D_V4L2
, "Read exposure %d", *val
);
267 static int hdcs_set_exposure(struct gspca_dev
*gspca_dev
, __s32 val
)
269 struct sd
*sd
= (struct sd
*) gspca_dev
;
270 struct hdcs
*hdcs
= sd
->sensor_priv
;
273 /* Column time period */
275 /* Column processing period */
277 /* Row processing period */
279 /* Minimum number of column timing periods
280 within the column processing period */
285 cycles
= val
* HDCS_CLK_FREQ_MHZ
;
287 ct
= hdcs
->exp
.cto
+ hdcs
->psmp
+ (HDCS_ADC_START_SIG_DUR
+ 2);
288 cp
= hdcs
->exp
.cto
+ (hdcs
->w
* ct
/ 2);
290 /* the cycles one row takes */
291 rp
= hdcs
->exp
.rs
+ cp
;
293 rowexp
= cycles
/ rp
;
295 /* the remaining cycles */
296 cycles
-= rowexp
* rp
;
298 /* calculate sub-row exposure */
300 /* see HDCS-1020 datasheet 3.5.6.4, p. 63 */
301 srowexp
= hdcs
->w
- (cycles
+ hdcs
->exp
.er
+ 13) / ct
;
303 mnct
= (hdcs
->exp
.er
+ 12 + ct
- 1) / ct
;
304 max_srowexp
= hdcs
->w
- mnct
;
306 /* see HDCS-1000 datasheet 3.4.5.5, p. 61 */
307 srowexp
= cp
- hdcs
->exp
.er
- 6 - cycles
;
309 mnct
= (hdcs
->exp
.er
+ 5 + ct
- 1) / ct
;
310 max_srowexp
= cp
- mnct
* ct
- 1;
315 else if (srowexp
> max_srowexp
)
316 srowexp
= max_srowexp
;
319 exp
[0] = HDCS20_CONTROL
;
320 exp
[1] = 0x00; /* Stop streaming */
321 exp
[2] = HDCS_ROWEXPL
;
322 exp
[3] = rowexp
& 0xff;
323 exp
[4] = HDCS_ROWEXPH
;
324 exp
[5] = rowexp
>> 8;
325 exp
[6] = HDCS20_SROWEXP
;
326 exp
[7] = (srowexp
>> 2) & 0xff;
327 exp
[8] = HDCS20_ERROR
;
328 exp
[9] = 0x10; /* Clear exposure error flag*/
329 exp
[10] = HDCS20_CONTROL
;
330 exp
[11] = 0x04; /* Restart streaming */
331 err
= stv06xx_write_sensor_bytes(sd
, exp
, 6);
333 exp
[0] = HDCS00_CONTROL
;
334 exp
[1] = 0x00; /* Stop streaming */
335 exp
[2] = HDCS_ROWEXPL
;
336 exp
[3] = rowexp
& 0xff;
337 exp
[4] = HDCS_ROWEXPH
;
338 exp
[5] = rowexp
>> 8;
339 exp
[6] = HDCS00_SROWEXPL
;
340 exp
[7] = srowexp
& 0xff;
341 exp
[8] = HDCS00_SROWEXPH
;
342 exp
[9] = srowexp
>> 8;
343 exp
[10] = HDCS_STATUS
;
344 exp
[11] = 0x10; /* Clear exposure error flag*/
345 exp
[12] = HDCS00_CONTROL
;
346 exp
[13] = 0x04; /* Restart streaming */
347 err
= stv06xx_write_sensor_bytes(sd
, exp
, 7);
351 PDEBUG(D_V4L2
, "Writing exposure %d, rowexp %d, srowexp %d",
352 val
, rowexp
, srowexp
);
356 static int hdcs_set_gains(struct sd
*sd
, u8 r
, u8 g
, u8 b
)
360 /* the voltage gain Av = (1 + 19 * val / 127) * (1 + bit7) */
373 return hdcs_reg_write_seq(sd
, HDCS_ERECPGA
, gains
, 4);
376 static int hdcs_get_gain(struct gspca_dev
*gspca_dev
, __s32
*val
)
378 struct sd
*sd
= (struct sd
*) gspca_dev
;
382 err
= stv06xx_read_sensor(sd
, HDCS_ERECPGA
, &data
);
384 /* Bit 7 doubles the gain */
386 *val
= (data
& 0x7f) * 2;
390 PDEBUG(D_V4L2
, "Read gain %d", *val
);
394 static int hdcs_set_gain(struct gspca_dev
*gspca_dev
, __s32 val
)
396 PDEBUG(D_V4L2
, "Writing gain %d", val
);
397 return hdcs_set_gains((struct sd
*) gspca_dev
,
398 val
& 0xff, val
& 0xff, val
& 0xff);
401 static int hdcs_set_size(struct sd
*sd
,
402 unsigned int width
, unsigned int height
)
404 struct hdcs
*hdcs
= sd
->sensor_priv
;
409 /* must be multiple of 4 */
410 width
= (width
+ 3) & ~0x3;
411 height
= (height
+ 3) & ~0x3;
413 if (width
> hdcs
->array
.width
)
414 width
= hdcs
->array
.width
;
417 /* the borders are also invalid */
418 if (height
+ 2 * hdcs
->array
.border
+ HDCS_1020_BOTTOM_Y_SKIP
419 > hdcs
->array
.height
)
420 height
= hdcs
->array
.height
- 2 * hdcs
->array
.border
-
421 HDCS_1020_BOTTOM_Y_SKIP
;
423 y
= (hdcs
->array
.height
- HDCS_1020_BOTTOM_Y_SKIP
- height
) / 2
426 if (height
> hdcs
->array
.height
)
427 height
= hdcs
->array
.height
;
429 y
= hdcs
->array
.top
+ (hdcs
->array
.height
- height
) / 2;
432 x
= hdcs
->array
.left
+ (hdcs
->array
.width
- width
) / 2;
436 win
[2] = (y
+ height
) / 4 - 1;
437 win
[3] = (x
+ width
) / 4 - 1;
439 err
= hdcs_reg_write_seq(sd
, HDCS_FWROW
, win
, 4);
443 /* Update the current width and height */
449 static int hdcs_probe_1x00(struct sd
*sd
)
455 ret
= stv06xx_read_sensor(sd
, HDCS_IDENT
, &sensor
);
456 if (ret
< 0 || sensor
!= 0x08)
459 info("HDCS-1000/1100 sensor detected");
461 sd
->gspca_dev
.cam
.cam_mode
= hdcs1x00_mode
;
462 sd
->gspca_dev
.cam
.nmodes
= ARRAY_SIZE(hdcs1x00_mode
);
463 sd
->desc
.ctrls
= hdcs1x00_ctrl
;
464 sd
->desc
.nctrls
= ARRAY_SIZE(hdcs1x00_ctrl
);
466 hdcs
= kmalloc(sizeof(struct hdcs
), GFP_KERNEL
);
470 hdcs
->array
.left
= 8;
472 hdcs
->array
.width
= HDCS_1X00_DEF_WIDTH
;
473 hdcs
->array
.height
= HDCS_1X00_DEF_HEIGHT
;
474 hdcs
->array
.border
= 4;
482 * Frame rate on HDCS-1000 with STV600 depends on PSMP:
483 * 4 = doesn't work at all
491 * Frame rate on HDCS-1000 with STV602 depends on PSMP:
492 * 15 = doesn't work at all
493 * 18 = doesn't work at all
501 hdcs
->psmp
= (sd
->bridge
== BRIDGE_STV602
) ? 20 : 5;
503 sd
->sensor_priv
= hdcs
;
508 static int hdcs_probe_1020(struct sd
*sd
)
514 ret
= stv06xx_read_sensor(sd
, HDCS_IDENT
, &sensor
);
515 if (ret
< 0 || sensor
!= 0x10)
518 info("HDCS-1020 sensor detected");
520 sd
->gspca_dev
.cam
.cam_mode
= hdcs1020_mode
;
521 sd
->gspca_dev
.cam
.nmodes
= ARRAY_SIZE(hdcs1020_mode
);
522 sd
->desc
.ctrls
= hdcs1020_ctrl
;
523 sd
->desc
.nctrls
= ARRAY_SIZE(hdcs1020_ctrl
);
525 hdcs
= kmalloc(sizeof(struct hdcs
), GFP_KERNEL
);
530 * From Andrey's test image: looks like HDCS-1020 upper-left
531 * visible pixel is at 24,8 (y maybe even smaller?) and lower-right
532 * visible pixel at 375,299 (x maybe even larger?)
534 hdcs
->array
.left
= 24;
536 hdcs
->array
.width
= HDCS_1020_DEF_WIDTH
;
537 hdcs
->array
.height
= 304;
538 hdcs
->array
.border
= 4;
547 sd
->sensor_priv
= hdcs
;
552 static int hdcs_start(struct sd
*sd
)
554 PDEBUG(D_STREAM
, "Starting stream");
556 return hdcs_set_state(sd
, HDCS_STATE_RUN
);
559 static int hdcs_stop(struct sd
*sd
)
561 PDEBUG(D_STREAM
, "Halting stream");
563 return hdcs_set_state(sd
, HDCS_STATE_SLEEP
);
566 static void hdcs_disconnect(struct sd
*sd
)
568 PDEBUG(D_PROBE
, "Disconnecting the sensor");
569 kfree(sd
->sensor_priv
);
572 static int hdcs_init(struct sd
*sd
)
574 struct hdcs
*hdcs
= sd
->sensor_priv
;
577 /* Set the STV0602AA in STV0600 emulation mode */
578 if (sd
->bridge
== BRIDGE_STV602
)
579 stv06xx_write_bridge(sd
, STV_STV0600_EMULATION
, 1);
581 /* Execute the bridge init */
582 for (i
= 0; i
< ARRAY_SIZE(stv_bridge_init
) && !err
; i
++) {
583 err
= stv06xx_write_bridge(sd
, stv_bridge_init
[i
][0],
584 stv_bridge_init
[i
][1]);
589 /* sensor soft reset */
592 /* Execute the sensor init */
593 for (i
= 0; i
< ARRAY_SIZE(stv_sensor_init
) && !err
; i
++) {
594 err
= stv06xx_write_sensor(sd
, stv_sensor_init
[i
][0],
595 stv_sensor_init
[i
][1]);
600 /* Enable continous frame capture, bit 2: stop when frame complete */
601 err
= stv06xx_write_sensor(sd
, HDCS_REG_CONFIG(sd
), BIT(3));
605 /* Set PGA sample duration
606 (was 0x7E for the STV602, but caused slow framerate with HDCS-1020) */
608 err
= stv06xx_write_sensor(sd
, HDCS_TCTRL
,
609 (HDCS_ADC_START_SIG_DUR
<< 6) | hdcs
->psmp
);
611 err
= stv06xx_write_sensor(sd
, HDCS_TCTRL
,
612 (HDCS_ADC_START_SIG_DUR
<< 5) | hdcs
->psmp
);
616 err
= hdcs_set_gains(sd
, HDCS_DEFAULT_GAIN
, HDCS_DEFAULT_GAIN
,
621 err
= hdcs_set_size(sd
, hdcs
->array
.width
, hdcs
->array
.height
);
625 err
= hdcs_set_exposure(&sd
->gspca_dev
, HDCS_DEFAULT_EXPOSURE
);
629 static int hdcs_dump(struct sd
*sd
)
633 info("Dumping sensor registers:");
635 for (reg
= HDCS_IDENT
; reg
<= HDCS_ROWEXPH
; reg
++) {
636 stv06xx_read_sensor(sd
, reg
, &val
);
637 info("reg 0x%02x = 0x%02x", reg
, val
);