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 #include "m5602_s5k4aa.h"
23 struct dmi_system_id s5k4aa_vflip_dmi_table[] = {
25 .ident = "Fujitsu-Siemens Amilo Xa 2528",
27 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
28 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Xa 2528")
31 .ident = "Fujitsu-Siemens Amilo Xi 2550",
33 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
34 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Xi 2550")
39 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
40 DMI_MATCH(DMI_PRODUCT_NAME, "GX700"),
41 DMI_MATCH(DMI_BIOS_DATE, "07/26/2007")
44 .ident = "MSI GX700/GX705/EX700",
46 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
47 DMI_MATCH(DMI_PRODUCT_NAME, "GX700/GX705/EX700")
53 static struct v4l2_pix_format s5k4aa_modes[] = {
62 .colorspace = V4L2_COLORSPACE_SRGB,
67 const static struct ctrl s5k4aa_ctrls[] = {
71 .type = V4L2_CTRL_TYPE_BOOLEAN,
72 .name = "vertical flip",
78 .set = s5k4aa_set_vflip,
79 .get = s5k4aa_get_vflip
84 .type = V4L2_CTRL_TYPE_BOOLEAN,
85 .name = "horizontal flip",
91 .set = s5k4aa_set_hflip,
92 .get = s5k4aa_get_hflip
97 .type = V4L2_CTRL_TYPE_INTEGER,
102 .default_value = 0xa0,
103 .flags = V4L2_CTRL_FLAG_SLIDER
105 .set = s5k4aa_set_gain,
106 .get = s5k4aa_get_gain
109 .id = V4L2_CID_EXPOSURE,
110 .type = V4L2_CTRL_TYPE_INTEGER,
115 .default_value = 0x100,
116 .flags = V4L2_CTRL_FLAG_SLIDER
118 .set = s5k4aa_set_exposure,
119 .get = s5k4aa_get_exposure
123 static void s5k4aa_dump_registers(struct sd *sd);
125 int s5k4aa_probe(struct sd *sd)
127 u8 prod_id[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
128 const u8 expected_prod_id[6] = {0x00, 0x10, 0x00, 0x4b, 0x33, 0x75};
132 if (force_sensor == S5K4AA_SENSOR) {
133 info("Forcing a %s sensor", s5k4aa.name);
136 /* If we want to force another sensor, don't try to probe this
141 info("Probing for a s5k4aa sensor");
143 /* Preinit the sensor */
144 for (i = 0; i < ARRAY_SIZE(preinit_s5k4aa) && !err; i++) {
145 u8 data[2] = {0x00, 0x00};
147 switch (preinit_s5k4aa[i][0]) {
149 err = m5602_write_bridge(sd,
150 preinit_s5k4aa[i][1],
151 preinit_s5k4aa[i][2]);
155 data[0] = preinit_s5k4aa[i][2];
156 err = m5602_write_sensor(sd,
157 preinit_s5k4aa[i][1],
162 data[0] = preinit_s5k4aa[i][2];
163 data[1] = preinit_s5k4aa[i][3];
164 err = m5602_write_sensor(sd,
165 preinit_s5k4aa[i][1],
169 info("Invalid stream command, exiting init");
174 /* Test some registers, but we don't know their exact meaning yet */
175 if (m5602_read_sensor(sd, 0x00, prod_id, 2))
177 if (m5602_read_sensor(sd, 0x02, prod_id+2, 2))
179 if (m5602_read_sensor(sd, 0x04, prod_id+4, 2))
182 if (memcmp(prod_id, expected_prod_id, sizeof(prod_id)))
185 info("Detected a s5k4aa sensor");
188 sd->gspca_dev.cam.cam_mode = s5k4aa_modes;
189 sd->gspca_dev.cam.nmodes = ARRAY_SIZE(s5k4aa_modes);
190 sd->desc->ctrls = s5k4aa_ctrls;
191 sd->desc->nctrls = ARRAY_SIZE(s5k4aa_ctrls);
195 int s5k4aa_start(struct sd *sd)
199 struct cam *cam = &sd->gspca_dev.cam;
201 switch (cam->cam_mode[sd->gspca_dev.curr_mode].width)
204 PDEBUG(D_V4L2, "Configuring camera for VGA mode");
206 for (i = 0; i < ARRAY_SIZE(VGA_s5k4aa); i++) {
207 switch (VGA_s5k4aa[i][0]) {
209 err = m5602_write_bridge(sd,
215 data[0] = VGA_s5k4aa[i][2];
216 err = m5602_write_sensor(sd,
222 data[0] = VGA_s5k4aa[i][2];
223 data[1] = VGA_s5k4aa[i][3];
224 err = m5602_write_sensor(sd,
230 err("Invalid stream command, exiting init");
238 int s5k4aa_init(struct sd *sd)
242 for (i = 0; i < ARRAY_SIZE(init_s5k4aa) && !err; i++) {
243 u8 data[2] = {0x00, 0x00};
245 switch (init_s5k4aa[i][0]) {
247 err = m5602_write_bridge(sd,
253 data[0] = init_s5k4aa[i][2];
254 err = m5602_write_sensor(sd,
255 init_s5k4aa[i][1], data, 1);
259 data[0] = init_s5k4aa[i][2];
260 data[1] = init_s5k4aa[i][3];
261 err = m5602_write_sensor(sd,
262 init_s5k4aa[i][1], data, 2);
265 info("Invalid stream command, exiting init");
271 s5k4aa_dump_registers(sd);
273 if (!err && dmi_check_system(s5k4aa_vflip_dmi_table)) {
275 info("vertical flip quirk active");
276 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
277 m5602_read_sensor(sd, S5K4AA_READ_MODE, &data, 1);
278 data |= S5K4AA_RM_V_FLIP;
279 data &= ~S5K4AA_RM_H_FLIP;
280 m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
282 /* Decrement COLSTART to preserve color order (BGGR) */
283 m5602_read_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
285 m5602_write_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
287 /* Increment ROWSTART to preserve color order (BGGR) */
288 m5602_read_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
290 m5602_write_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
293 return (err < 0) ? err : 0;
296 int s5k4aa_power_down(struct sd *sd)
301 int s5k4aa_get_exposure(struct gspca_dev *gspca_dev, __s32 *val)
303 struct sd *sd = (struct sd *) gspca_dev;
304 u8 data = S5K4AA_PAGE_MAP_2;
307 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
311 err = m5602_read_sensor(sd, S5K4AA_EXPOSURE_HI, &data, 1);
316 err = m5602_read_sensor(sd, S5K4AA_EXPOSURE_LO, &data, 1);
318 PDEBUG(D_V4L2, "Read exposure %d", *val);
323 int s5k4aa_set_exposure(struct gspca_dev *gspca_dev, __s32 val)
325 struct sd *sd = (struct sd *) gspca_dev;
326 u8 data = S5K4AA_PAGE_MAP_2;
329 PDEBUG(D_V4L2, "Set exposure to %d", val);
330 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
333 data = (val >> 8) & 0xff;
334 err = m5602_write_sensor(sd, S5K4AA_EXPOSURE_HI, &data, 1);
338 err = m5602_write_sensor(sd, S5K4AA_EXPOSURE_LO, &data, 1);
343 int s5k4aa_get_vflip(struct gspca_dev *gspca_dev, __s32 *val)
345 struct sd *sd = (struct sd *) gspca_dev;
346 u8 data = S5K4AA_PAGE_MAP_2;
349 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
353 err = m5602_read_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
354 *val = (data & S5K4AA_RM_V_FLIP) >> 7;
355 PDEBUG(D_V4L2, "Read vertical flip %d", *val);
360 int s5k4aa_set_vflip(struct gspca_dev *gspca_dev, __s32 val)
362 struct sd *sd = (struct sd *) gspca_dev;
363 u8 data = S5K4AA_PAGE_MAP_2;
366 PDEBUG(D_V4L2, "Set vertical flip to %d", val);
367 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
370 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
373 data = ((data & ~S5K4AA_RM_V_FLIP)
374 | ((val & 0x01) << 7));
375 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
380 err = m5602_read_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
385 err = m5602_write_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
387 err = m5602_read_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
392 err = m5602_write_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
398 int s5k4aa_get_hflip(struct gspca_dev *gspca_dev, __s32 *val)
400 struct sd *sd = (struct sd *) gspca_dev;
401 u8 data = S5K4AA_PAGE_MAP_2;
404 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
408 err = m5602_read_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
409 *val = (data & S5K4AA_RM_H_FLIP) >> 6;
410 PDEBUG(D_V4L2, "Read horizontal flip %d", *val);
415 int s5k4aa_set_hflip(struct gspca_dev *gspca_dev, __s32 val)
417 struct sd *sd = (struct sd *) gspca_dev;
418 u8 data = S5K4AA_PAGE_MAP_2;
421 PDEBUG(D_V4L2, "Set horizontal flip to %d",
423 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
426 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
430 data = ((data & ~S5K4AA_RM_H_FLIP) | ((val & 0x01) << 6));
431 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
436 err = m5602_read_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
440 err = m5602_write_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
444 err = m5602_read_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
448 err = m5602_write_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
454 int s5k4aa_get_gain(struct gspca_dev *gspca_dev, __s32 *val)
456 struct sd *sd = (struct sd *) gspca_dev;
457 u8 data = S5K4AA_PAGE_MAP_2;
460 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
464 err = m5602_read_sensor(sd, S5K4AA_GAIN_2, &data, 1);
466 PDEBUG(D_V4L2, "Read gain %d", *val);
471 int s5k4aa_set_gain(struct gspca_dev *gspca_dev, __s32 val)
473 struct sd *sd = (struct sd *) gspca_dev;
474 u8 data = S5K4AA_PAGE_MAP_2;
477 PDEBUG(D_V4L2, "Set gain to %d", val);
478 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
483 err = m5602_write_sensor(sd, S5K4AA_GAIN_2, &data, 1);
488 static void s5k4aa_dump_registers(struct sd *sd)
492 m5602_read_sensor(sd, S5K4AA_PAGE_MAP, &old_page, 1);
493 for (page = 0; page < 16; page++) {
494 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &page, 1);
495 info("Dumping the s5k4aa register state for page 0x%x", page);
496 for (address = 0; address <= 0xff; address++) {
498 m5602_read_sensor(sd, address, &value, 1);
499 info("register 0x%x contains 0x%x",
503 info("s5k4aa register state dump complete");
505 for (page = 0; page < 16; page++) {
506 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &page, 1);
507 info("Probing for which registers that are "
508 "read/write for page 0x%x", page);
509 for (address = 0; address <= 0xff; address++) {
510 u8 old_value, ctrl_value, test_value = 0xff;
512 m5602_read_sensor(sd, address, &old_value, 1);
513 m5602_write_sensor(sd, address, &test_value, 1);
514 m5602_read_sensor(sd, address, &ctrl_value, 1);
516 if (ctrl_value == test_value)
517 info("register 0x%x is writeable", address);
519 info("register 0x%x is read only", address);
521 /* Restore original value */
522 m5602_write_sensor(sd, address, &old_value, 1);
525 info("Read/write register probing complete");
526 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &old_page, 1);