1 /*
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  *
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.
11  *
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.
16  *
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
20  *
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
28  */
29 
30 #ifndef STV06XX_H_
31 #define STV06XX_H_
32 
33 #include <linux/slab.h>
34 #include "gspca.h"
35 
36 #define MODULE_NAME "STV06xx"
37 
38 #define STV_ISOC_ENDPOINT_ADDR		0x81
39 
40 #define STV_R                           0x0509
41 
42 #define STV_REG23			0x0423
43 
44 /* Control registers of the STV0600 ASIC */
45 #define STV_I2C_PARTNER			0x1420
46 #define STV_I2C_VAL_REG_VAL_PAIRS_MIN1	0x1421
47 #define STV_I2C_READ_WRITE_TOGGLE	0x1422
48 #define STV_I2C_FLUSH			0x1423
49 #define STV_I2C_SUCC_READ_REG_VALS	0x1424
50 
51 #define STV_ISO_ENABLE			0x1440
52 #define STV_SCAN_RATE			0x1443
53 #define STV_LED_CTRL			0x1445
54 #define STV_STV0600_EMULATION		0x1446
55 #define STV_REG00			0x1500
56 #define STV_REG01			0x1501
57 #define STV_REG02			0x1502
58 #define STV_REG03			0x1503
59 #define STV_REG04			0x1504
60 
61 #define STV_ISO_SIZE_L			0x15c1
62 #define STV_ISO_SIZE_H			0x15c2
63 
64 /* Refers to the CIF 352x288 and QCIF 176x144 */
65 /* 1: 288 lines, 2: 144 lines */
66 #define STV_Y_CTRL		        0x15c3
67 
68 #define STV_RESET                       0x1620
69 
70 /* 0xa: 352 columns, 0x6: 176 columns */
71 #define STV_X_CTRL			0x1680
72 
73 #define STV06XX_URB_MSG_TIMEOUT		5000
74 
75 #define I2C_MAX_BYTES			16
76 #define I2C_MAX_WORDS			8
77 
78 #define I2C_BUFFER_LENGTH		0x23
79 #define I2C_READ_CMD			3
80 #define I2C_WRITE_CMD			1
81 
82 #define LED_ON				1
83 #define LED_OFF				0
84 
85 /* STV06xx device descriptor */
86 struct sd {
87 	struct gspca_dev gspca_dev;
88 
89 	/* A pointer to the currently connected sensor */
90 	const struct stv06xx_sensor *sensor;
91 
92 	/* Sensor private data */
93 	void *sensor_priv;
94 
95 	/* The first 4 lines produced by the stv6422 are no good, this keeps
96 	   track of how many bytes we still need to skip during a frame */
97 	int to_skip;
98 
99 	/* Bridge / Camera type */
100 	u8 bridge;
101 	#define BRIDGE_STV600 0
102 	#define BRIDGE_STV602 1
103 	#define BRIDGE_STV610 2
104 	#define BRIDGE_ST6422 3 /* With integrated sensor */
105 };
106 
107 int stv06xx_write_bridge(struct sd *sd, u16 address, u16 i2c_data);
108 int stv06xx_read_bridge(struct sd *sd, u16 address, u8 *i2c_data);
109 
110 int stv06xx_write_sensor_bytes(struct sd *sd, const u8 *data, u8 len);
111 int stv06xx_write_sensor_words(struct sd *sd, const u16 *data, u8 len);
112 
113 int stv06xx_read_sensor(struct sd *sd, const u8 address, u16 *value);
114 int stv06xx_write_sensor(struct sd *sd, u8 address, u16 value);
115 
116 #endif
117