2 * Driver for the s5k4aa sensor
4 * Copyright (C) 2008 Erik Andrén
5 * Copyright (C) 2007 Ilyes Gouta. Based on the m5603x Linux Driver Project.
6 * Copyright (C) 2005 m5603x Linux Driver Project <m5602@x3ng.com.br>
8 * Portions of code to USB interface and ALi driver software,
9 * Copyright (c) 2006 Willem Duinker
10 * v4l2 interface modeled after the V4L2 driver
11 * for SN9C10x PC Camera Controllers
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License as
15 * published by the Free Software Foundation, version 2.
19 #ifndef M5602_S5K4AA_H_
20 #define M5602_S5K4AA_H_
22 #include <linux/dmi.h>
24 #include "m5602_sensor.h"
26 /*****************************************************************************/
28 #define S5K4AA_PAGE_MAP 0xec
30 #define S5K4AA_PAGE_MAP_0 0x00
31 #define S5K4AA_PAGE_MAP_1 0x01
32 #define S5K4AA_PAGE_MAP_2 0x02
34 /* Sensor register definitions for page 0x02 */
35 #define S5K4AA_READ_MODE 0x03
36 #define S5K4AA_ROWSTART_HI 0x04
37 #define S5K4AA_ROWSTART_LO 0x05
38 #define S5K4AA_COLSTART_HI 0x06
39 #define S5K4AA_COLSTART_LO 0x07
40 #define S5K4AA_WINDOW_HEIGHT_HI 0x08
41 #define S5K4AA_WINDOW_HEIGHT_LO 0x09
42 #define S5K4AA_WINDOW_WIDTH_HI 0x0a
43 #define S5K4AA_WINDOW_WIDTH_LO 0x0b
44 #define S5K4AA_GLOBAL_GAIN__ 0x0f
45 /* sync lost, if too low, reduces frame rate if too high */
46 #define S5K4AA_H_BLANK_HI__ 0x1d
47 #define S5K4AA_H_BLANK_LO__ 0x1e
48 #define S5K4AA_EXPOSURE_HI 0x17
49 #define S5K4AA_EXPOSURE_LO 0x18
50 #define S5K4AA_GAIN_1 0x1f /* (digital?) gain : 5 bits */
51 #define S5K4AA_GAIN_2 0x20 /* (analogue?) gain : 7 bits */
53 #define S5K4AA_RM_ROW_SKIP_4X 0x08
54 #define S5K4AA_RM_ROW_SKIP_2X 0x04
55 #define S5K4AA_RM_COL_SKIP_4X 0x02
56 #define S5K4AA_RM_COL_SKIP_2X 0x01
57 #define S5K4AA_RM_H_FLIP 0x40
58 #define S5K4AA_RM_V_FLIP 0x80
60 /*****************************************************************************/
62 /* Kernel module parameters */
63 extern int force_sensor;
64 extern int dump_sensor;
66 int s5k4aa_probe(struct sd *sd);
67 int s5k4aa_init(struct sd *sd);
68 int s5k4aa_power_down(struct sd *sd);
70 int s5k4aa_read_sensor(struct sd *sd, const u8 address,
71 u8 *i2c_data, const u8 len);
72 int s5k4aa_write_sensor(struct sd *sd, const u8 address,
73 u8 *i2c_data, const u8 len);
75 int s5k4aa_get_exposure(struct gspca_dev *gspca_dev, __s32 *val);
76 int s5k4aa_set_exposure(struct gspca_dev *gspca_dev, __s32 val);
77 int s5k4aa_get_vflip(struct gspca_dev *gspca_dev, __s32 *val);
78 int s5k4aa_set_vflip(struct gspca_dev *gspca_dev, __s32 val);
79 int s5k4aa_get_hflip(struct gspca_dev *gspca_dev, __s32 *val);
80 int s5k4aa_set_hflip(struct gspca_dev *gspca_dev, __s32 val);
81 int s5k4aa_get_gain(struct gspca_dev *gspca_dev, __s32 *val);
82 int s5k4aa_set_gain(struct gspca_dev *gspca_dev, __s32 val);
84 static struct m5602_sensor s5k4aa = {
86 .probe = s5k4aa_probe,
88 .power_down = s5k4aa_power_down,
89 .read_sensor = s5k4aa_read_sensor,
90 .write_sensor = s5k4aa_write_sensor,
97 .type = V4L2_CTRL_TYPE_BOOLEAN,
98 .name = "vertical flip",
104 .set = s5k4aa_set_vflip,
105 .get = s5k4aa_get_vflip
109 .id = V4L2_CID_HFLIP,
110 .type = V4L2_CTRL_TYPE_BOOLEAN,
111 .name = "horizontal flip",
117 .set = s5k4aa_set_hflip,
118 .get = s5k4aa_get_hflip
123 .type = V4L2_CTRL_TYPE_INTEGER,
128 .default_value = 0xa0,
129 .flags = V4L2_CTRL_FLAG_SLIDER
131 .set = s5k4aa_set_gain,
132 .get = s5k4aa_get_gain
135 .id = V4L2_CID_EXPOSURE,
136 .type = V4L2_CTRL_TYPE_INTEGER,
141 .default_value = 0x100,
142 .flags = V4L2_CTRL_FLAG_SLIDER
144 .set = s5k4aa_set_exposure,
145 .get = s5k4aa_get_exposure
152 M5602_DEFAULT_FRAME_WIDTH,
153 M5602_DEFAULT_FRAME_HEIGHT,
157 M5602_DEFAULT_FRAME_WIDTH * M5602_DEFAULT_FRAME_HEIGHT,
158 .bytesperline = M5602_DEFAULT_FRAME_WIDTH,
159 .colorspace = V4L2_COLORSPACE_SRGB,
165 static const unsigned char preinit_s5k4aa[][4] =
167 {BRIDGE, M5602_XB_MCU_CLK_DIV, 0x02, 0x00},
168 {BRIDGE, M5602_XB_MCU_CLK_CTRL, 0xb0, 0x00},
169 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x00, 0x00},
170 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xb0, 0x00},
171 {BRIDGE, M5602_XB_ADC_CTRL, 0xc0, 0x00},
172 {BRIDGE, M5602_XB_SENSOR_TYPE, 0x0d, 0x00},
173 {BRIDGE, M5602_XB_SENSOR_CTRL, 0x00, 0x00},
175 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
176 {BRIDGE, M5602_XB_GPIO_DAT, 0x08, 0x00},
177 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0xb0, 0x00},
178 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0x80, 0x00},
179 {BRIDGE, M5602_XB_GPIO_EN_H, 0x3f, 0x00},
180 {BRIDGE, M5602_XB_GPIO_DIR_H, 0x3f, 0x00},
181 {BRIDGE, M5602_XB_GPIO_DAT_H, 0x00, 0x00},
182 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
183 {BRIDGE, M5602_XB_GPIO_DAT, 0x00, 0x00},
184 {BRIDGE, M5602_XB_GPIO_EN_L, 0xff, 0x00},
185 {BRIDGE, M5602_XB_GPIO_DIR_L, 0xff, 0x00},
186 {BRIDGE, M5602_XB_GPIO_DAT_L, 0x00, 0x00},
187 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x00, 0x00},
188 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xb0, 0x00},
189 {BRIDGE, M5602_XB_ADC_CTRL, 0xc0, 0x00},
190 {BRIDGE, M5602_XB_SENSOR_TYPE, 0x08, 0x00},
192 {BRIDGE, M5602_XB_MCU_CLK_DIV, 0x02, 0x00},
193 {BRIDGE, M5602_XB_MCU_CLK_CTRL, 0xb0, 0x00},
194 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
195 {BRIDGE, M5602_XB_GPIO_DAT, 0x14, 0x00},
196 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x00, 0x00},
197 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xf0, 0x00},
198 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
199 {BRIDGE, M5602_XB_GPIO_DAT, 0x1c, 0x00},
200 {BRIDGE, M5602_XB_GPIO_EN_H, 0x06, 0x00},
201 {BRIDGE, M5602_XB_GPIO_DIR_H, 0x06, 0x00},
202 {BRIDGE, M5602_XB_GPIO_DAT_H, 0x00, 0x00},
203 {BRIDGE, M5602_XB_GPIO_EN_L, 0x00, 0x00},
204 {BRIDGE, M5602_XB_I2C_CLK_DIV, 0x20, 0x00},
206 {SENSOR, S5K4AA_PAGE_MAP, 0x00, 0x00}
209 static const unsigned char init_s5k4aa[][4] =
211 {BRIDGE, M5602_XB_MCU_CLK_DIV, 0x02, 0x00},
212 {BRIDGE, M5602_XB_MCU_CLK_CTRL, 0xb0, 0x00},
213 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x00, 0x00},
214 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xb0, 0x00},
215 {BRIDGE, M5602_XB_ADC_CTRL, 0xc0, 0x00},
216 {BRIDGE, M5602_XB_SENSOR_TYPE, 0x0d, 0x00},
217 {BRIDGE, M5602_XB_SENSOR_CTRL, 0x00, 0x00},
219 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
220 {BRIDGE, M5602_XB_GPIO_DAT, 0x08, 0x00},
221 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0xb0, 0x00},
222 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0x80, 0x00},
223 {BRIDGE, M5602_XB_GPIO_EN_H, 0x3f, 0x00},
224 {BRIDGE, M5602_XB_GPIO_DIR_H, 0x3f, 0x00},
225 {BRIDGE, M5602_XB_GPIO_DAT_H, 0x00, 0x00},
226 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
227 {BRIDGE, M5602_XB_GPIO_DAT, 0x00, 0x00},
228 {BRIDGE, M5602_XB_GPIO_EN_L, 0xff, 0x00},
229 {BRIDGE, M5602_XB_GPIO_DIR_L, 0xff, 0x00},
230 {BRIDGE, M5602_XB_GPIO_DAT_L, 0x00, 0x00},
231 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x00, 0x00},
232 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xb0, 0x00},
233 {BRIDGE, M5602_XB_ADC_CTRL, 0xc0, 0x00},
234 {BRIDGE, M5602_XB_SENSOR_TYPE, 0x08, 0x00},
236 {BRIDGE, M5602_XB_MCU_CLK_DIV, 0x02, 0x00},
237 {BRIDGE, M5602_XB_MCU_CLK_CTRL, 0xb0, 0x00},
238 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
239 {BRIDGE, M5602_XB_GPIO_DAT, 0x14, 0x00},
240 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x00, 0x00},
241 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xf0, 0x00},
242 {BRIDGE, M5602_XB_GPIO_DIR, 0x1d, 0x00},
243 {BRIDGE, M5602_XB_GPIO_DAT, 0x1c, 0x00},
244 {BRIDGE, M5602_XB_GPIO_EN_H, 0x06, 0x00},
245 {BRIDGE, M5602_XB_GPIO_DIR_H, 0x06, 0x00},
246 {BRIDGE, M5602_XB_GPIO_DAT_H, 0x00, 0x00},
247 {BRIDGE, M5602_XB_GPIO_EN_L, 0x00, 0x00},
248 {BRIDGE, M5602_XB_I2C_CLK_DIV, 0x20, 0x00},
250 {SENSOR, S5K4AA_PAGE_MAP, 0x07, 0x00},
251 {SENSOR, 0x36, 0x01, 0x00},
252 {SENSOR, S5K4AA_PAGE_MAP, 0x00, 0x00},
253 {SENSOR, 0x7b, 0xff, 0x00},
254 {SENSOR, S5K4AA_PAGE_MAP, 0x02, 0x00},
255 {SENSOR, 0x0c, 0x05, 0x00},
256 {SENSOR, 0x02, 0x0e, 0x00},
257 {SENSOR, S5K4AA_GAIN_1, 0x0f, 0x00},
258 {SENSOR, S5K4AA_GAIN_2, 0x00, 0x00},
259 {SENSOR, S5K4AA_GLOBAL_GAIN__, 0x01, 0x00},
260 {SENSOR, 0x11, 0x00, 0x00},
261 {SENSOR, 0x12, 0x00, 0x00},
262 {SENSOR, S5K4AA_PAGE_MAP, 0x02, 0x00},
263 {SENSOR, S5K4AA_READ_MODE, 0xa0, 0x00},
264 {SENSOR, 0x37, 0x00, 0x00},
265 {SENSOR, S5K4AA_ROWSTART_HI, 0x00, 0x00},
266 {SENSOR, S5K4AA_ROWSTART_LO, 0x2a, 0x00},
267 {SENSOR, S5K4AA_COLSTART_HI, 0x00, 0x00},
268 {SENSOR, S5K4AA_COLSTART_LO, 0x0b, 0x00},
269 {SENSOR, S5K4AA_WINDOW_HEIGHT_HI, 0x03, 0x00},
270 {SENSOR, S5K4AA_WINDOW_HEIGHT_LO, 0xc4, 0x00},
271 {SENSOR, S5K4AA_WINDOW_WIDTH_HI, 0x05, 0x00},
272 {SENSOR, S5K4AA_WINDOW_WIDTH_LO, 0x08, 0x00},
273 {SENSOR, S5K4AA_H_BLANK_HI__, 0x00, 0x00},
274 {SENSOR, S5K4AA_H_BLANK_LO__, 0x48, 0x00},
275 {SENSOR, S5K4AA_EXPOSURE_HI, 0x00, 0x00},
276 {SENSOR, S5K4AA_EXPOSURE_LO, 0x43, 0x00},
277 {SENSOR, 0x11, 0x04, 0x00},
278 {SENSOR, 0x12, 0xc3, 0x00},
279 {SENSOR, S5K4AA_PAGE_MAP, 0x02, 0x00},
281 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x06, 0x00},
282 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xb0, 0x00},
283 {BRIDGE, M5602_XB_ADC_CTRL, 0xc0, 0x00},
284 {BRIDGE, M5602_XB_SENSOR_TYPE, 0x08, 0x00},
285 {BRIDGE, M5602_XB_LINE_OF_FRAME_H, 0x81, 0x00},
286 {BRIDGE, M5602_XB_PIX_OF_LINE_H, 0x82, 0x00},
287 {BRIDGE, M5602_XB_SIG_INI, 0x01, 0x00},
288 {BRIDGE, M5602_XB_VSYNC_PARA, 0x00, 0x00},
289 {BRIDGE, M5602_XB_VSYNC_PARA, 0x00, 0x00},
290 {BRIDGE, M5602_XB_VSYNC_PARA, 0x00, 0x00},
291 {BRIDGE, M5602_XB_VSYNC_PARA, 0x00, 0x00},
292 /* VSYNC_PARA, VSYNC_PARA : img height 480 = 0x01e0 */
293 {BRIDGE, M5602_XB_VSYNC_PARA, 0x01, 0x00},
294 {BRIDGE, M5602_XB_VSYNC_PARA, 0xe0, 0x00},
295 {BRIDGE, M5602_XB_VSYNC_PARA, 0x00, 0x00},
296 {BRIDGE, M5602_XB_VSYNC_PARA, 0x00, 0x00},
297 {BRIDGE, M5602_XB_SIG_INI, 0x00, 0x00},
298 {BRIDGE, M5602_XB_SIG_INI, 0x02, 0x00},
299 {BRIDGE, M5602_XB_HSYNC_PARA, 0x00, 0x00},
300 {BRIDGE, M5602_XB_HSYNC_PARA, 0x00, 0x00},
301 /* HSYNC_PARA, HSYNC_PARA : img width 640 = 0x0280 */
302 {BRIDGE, M5602_XB_HSYNC_PARA, 0x02, 0x00},
303 {BRIDGE, M5602_XB_HSYNC_PARA, 0x80, 0x00},
304 {BRIDGE, M5602_XB_SIG_INI, 0x00, 0x00},
305 {BRIDGE, M5602_XB_SEN_CLK_DIV, 0x00, 0x00},
306 {BRIDGE, M5602_XB_SEN_CLK_CTRL, 0xa0, 0x00}, /* 48 MHz */
308 {SENSOR, S5K4AA_PAGE_MAP, 0x02, 0x00},
309 {SENSOR, S5K4AA_READ_MODE, S5K4AA_RM_H_FLIP | S5K4AA_RM_ROW_SKIP_2X
310 | S5K4AA_RM_COL_SKIP_2X, 0x00},
311 /* 0x37 : Fix image stability when light is too bright and improves
312 * image quality in 640x480, but worsens it in 1280x1024 */
313 {SENSOR, 0x37, 0x01, 0x00},
314 /* ROWSTART_HI, ROWSTART_LO : 10 + (1024-960)/2 = 42 = 0x002a */
315 {SENSOR, S5K4AA_ROWSTART_HI, 0x00, 0x00},
316 {SENSOR, S5K4AA_ROWSTART_LO, 0x2a, 0x00},
317 {SENSOR, S5K4AA_COLSTART_HI, 0x00, 0x00},
318 {SENSOR, S5K4AA_COLSTART_LO, 0x0c, 0x00},
319 /* window_height_hi, window_height_lo : 960 = 0x03c0 */
320 {SENSOR, S5K4AA_WINDOW_HEIGHT_HI, 0x03, 0x00},
321 {SENSOR, S5K4AA_WINDOW_HEIGHT_LO, 0xc0, 0x00},
322 /* window_width_hi, window_width_lo : 1280 = 0x0500 */
323 {SENSOR, S5K4AA_WINDOW_WIDTH_HI, 0x05, 0x00},
324 {SENSOR, S5K4AA_WINDOW_WIDTH_LO, 0x00, 0x00},
325 {SENSOR, S5K4AA_H_BLANK_HI__, 0x00, 0x00},
326 {SENSOR, S5K4AA_H_BLANK_LO__, 0xa8, 0x00}, /* helps to sync... */
327 {SENSOR, S5K4AA_EXPOSURE_HI, 0x01, 0x00},
328 {SENSOR, S5K4AA_EXPOSURE_LO, 0x00, 0x00},
329 {SENSOR, 0x11, 0x04, 0x00},
330 {SENSOR, 0x12, 0xc3, 0x00},
331 {SENSOR, S5K4AA_PAGE_MAP, 0x02, 0x00},
332 {SENSOR, 0x02, 0x0e, 0x00},
333 {SENSOR_LONG, S5K4AA_GLOBAL_GAIN__, 0x0f, 0x00},
334 {SENSOR, S5K4AA_GAIN_1, 0x0b, 0x00},
335 {SENSOR, S5K4AA_GAIN_2, 0xa0, 0x00}