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"
21 static int s5k4aa_get_exposure(struct gspca_dev *gspca_dev, __s32 *val);
22 static int s5k4aa_set_exposure(struct gspca_dev *gspca_dev, __s32 val);
23 static int s5k4aa_get_vflip(struct gspca_dev *gspca_dev, __s32 *val);
24 static int s5k4aa_set_vflip(struct gspca_dev *gspca_dev, __s32 val);
25 static int s5k4aa_get_hflip(struct gspca_dev *gspca_dev, __s32 *val);
26 static int s5k4aa_set_hflip(struct gspca_dev *gspca_dev, __s32 val);
27 static int s5k4aa_get_gain(struct gspca_dev *gspca_dev, __s32 *val);
28 static int s5k4aa_set_gain(struct gspca_dev *gspca_dev, __s32 val);
29 static int s5k4aa_get_noise(struct gspca_dev *gspca_dev, __s32 *val);
30 static int s5k4aa_set_noise(struct gspca_dev *gspca_dev, __s32 val);
31 static int s5k4aa_get_brightness(struct gspca_dev *gspca_dev, __s32 *val);
32 static int s5k4aa_set_brightness(struct gspca_dev *gspca_dev, __s32 val);
36 struct dmi_system_id s5k4aa_vflip_dmi_table[] = {
38 .ident = "Fujitsu-Siemens Amilo Xa 2528",
40 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
41 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Xa 2528")
44 .ident = "Fujitsu-Siemens Amilo Xi 2550",
46 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
47 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Xi 2550")
52 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
53 DMI_MATCH(DMI_PRODUCT_NAME, "GX700"),
54 DMI_MATCH(DMI_BIOS_DATE, "07/26/2007")
57 .ident = "MSI GX700/GX705/EX700",
59 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
60 DMI_MATCH(DMI_PRODUCT_NAME, "GX700/GX705/EX700")
65 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
66 DMI_MATCH(DMI_PRODUCT_NAME, "MS-1717X")
72 static struct v4l2_pix_format s5k4aa_modes[] = {
81 .colorspace = V4L2_COLORSPACE_SRGB,
92 .colorspace = V4L2_COLORSPACE_SRGB,
97 static const struct ctrl s5k4aa_ctrls[] = {
101 .id = V4L2_CID_VFLIP,
102 .type = V4L2_CTRL_TYPE_BOOLEAN,
103 .name = "vertical flip",
109 .set = s5k4aa_set_vflip,
110 .get = s5k4aa_get_vflip
115 .id = V4L2_CID_HFLIP,
116 .type = V4L2_CTRL_TYPE_BOOLEAN,
117 .name = "horizontal flip",
123 .set = s5k4aa_set_hflip,
124 .get = s5k4aa_get_hflip
130 .type = V4L2_CTRL_TYPE_INTEGER,
135 .default_value = S5K4AA_DEFAULT_GAIN,
136 .flags = V4L2_CTRL_FLAG_SLIDER
138 .set = s5k4aa_set_gain,
139 .get = s5k4aa_get_gain
141 #define EXPOSURE_IDX 3
144 .id = V4L2_CID_EXPOSURE,
145 .type = V4L2_CTRL_TYPE_INTEGER,
150 .default_value = 0x100,
151 .flags = V4L2_CTRL_FLAG_SLIDER
153 .set = s5k4aa_set_exposure,
154 .get = s5k4aa_get_exposure
156 #define NOISE_SUPP_IDX 4
159 .id = V4L2_CID_PRIVATE_BASE,
160 .type = V4L2_CTRL_TYPE_BOOLEAN,
161 .name = "Noise suppression (smoothing)",
167 .set = s5k4aa_set_noise,
168 .get = s5k4aa_get_noise
170 #define BRIGHTNESS_IDX 5
173 .id = V4L2_CID_BRIGHTNESS,
174 .type = V4L2_CTRL_TYPE_INTEGER,
175 .name = "Brightness",
179 .default_value = S5K4AA_DEFAULT_BRIGHTNESS,
181 .set = s5k4aa_set_brightness,
182 .get = s5k4aa_get_brightness
187 static void s5k4aa_dump_registers(struct sd *sd);
189 int s5k4aa_probe(struct sd *sd)
191 u8 prod_id[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
192 const u8 expected_prod_id[6] = {0x00, 0x10, 0x00, 0x4b, 0x33, 0x75};
194 s32 *sensor_settings;
197 if (force_sensor == S5K4AA_SENSOR) {
198 info("Forcing a %s sensor", s5k4aa.name);
201 /* If we want to force another sensor, don't try to probe this
206 info("Probing for a s5k4aa sensor");
208 /* Preinit the sensor */
209 for (i = 0; i < ARRAY_SIZE(preinit_s5k4aa) && !err; i++) {
210 u8 data[2] = {0x00, 0x00};
212 switch (preinit_s5k4aa[i][0]) {
214 err = m5602_write_bridge(sd,
215 preinit_s5k4aa[i][1],
216 preinit_s5k4aa[i][2]);
220 data[0] = preinit_s5k4aa[i][2];
221 err = m5602_write_sensor(sd,
222 preinit_s5k4aa[i][1],
227 data[0] = preinit_s5k4aa[i][2];
228 data[1] = preinit_s5k4aa[i][3];
229 err = m5602_write_sensor(sd,
230 preinit_s5k4aa[i][1],
234 info("Invalid stream command, exiting init");
239 /* Test some registers, but we don't know their exact meaning yet */
240 if (m5602_read_sensor(sd, 0x00, prod_id, 2))
242 if (m5602_read_sensor(sd, 0x02, prod_id+2, 2))
244 if (m5602_read_sensor(sd, 0x04, prod_id+4, 2))
247 if (memcmp(prod_id, expected_prod_id, sizeof(prod_id)))
250 info("Detected a s5k4aa sensor");
253 sensor_settings = kmalloc(
254 ARRAY_SIZE(s5k4aa_ctrls) * sizeof(s32), GFP_KERNEL);
255 if (!sensor_settings)
258 sd->gspca_dev.cam.cam_mode = s5k4aa_modes;
259 sd->gspca_dev.cam.nmodes = ARRAY_SIZE(s5k4aa_modes);
260 sd->desc->ctrls = s5k4aa_ctrls;
261 sd->desc->nctrls = ARRAY_SIZE(s5k4aa_ctrls);
263 for (i = 0; i < ARRAY_SIZE(s5k4aa_ctrls); i++)
264 sensor_settings[i] = s5k4aa_ctrls[i].qctrl.default_value;
265 sd->sensor_priv = sensor_settings;
270 int s5k4aa_start(struct sd *sd)
274 struct cam *cam = &sd->gspca_dev.cam;
275 s32 *sensor_settings = sd->sensor_priv;
277 switch (cam->cam_mode[sd->gspca_dev.curr_mode].width) {
279 PDEBUG(D_V4L2, "Configuring camera for SXGA mode");
281 for (i = 0; i < ARRAY_SIZE(SXGA_s5k4aa); i++) {
282 switch (SXGA_s5k4aa[i][0]) {
284 err = m5602_write_bridge(sd,
290 data[0] = SXGA_s5k4aa[i][2];
291 err = m5602_write_sensor(sd,
297 data[0] = SXGA_s5k4aa[i][2];
298 data[1] = SXGA_s5k4aa[i][3];
299 err = m5602_write_sensor(sd,
305 err("Invalid stream command, exiting init");
309 err = s5k4aa_set_noise(&sd->gspca_dev, 0);
315 PDEBUG(D_V4L2, "Configuring camera for VGA mode");
317 for (i = 0; i < ARRAY_SIZE(VGA_s5k4aa); i++) {
318 switch (VGA_s5k4aa[i][0]) {
320 err = m5602_write_bridge(sd,
326 data[0] = VGA_s5k4aa[i][2];
327 err = m5602_write_sensor(sd,
333 data[0] = VGA_s5k4aa[i][2];
334 data[1] = VGA_s5k4aa[i][3];
335 err = m5602_write_sensor(sd,
341 err("Invalid stream command, exiting init");
345 err = s5k4aa_set_noise(&sd->gspca_dev, 1);
353 err = s5k4aa_set_exposure(&sd->gspca_dev,
354 sensor_settings[EXPOSURE_IDX]);
358 err = s5k4aa_set_gain(&sd->gspca_dev, sensor_settings[GAIN_IDX]);
362 err = s5k4aa_set_brightness(&sd->gspca_dev,
363 sensor_settings[BRIGHTNESS_IDX]);
367 err = s5k4aa_set_noise(&sd->gspca_dev, sensor_settings[NOISE_SUPP_IDX]);
371 err = s5k4aa_set_vflip(&sd->gspca_dev, sensor_settings[VFLIP_IDX]);
375 return s5k4aa_set_hflip(&sd->gspca_dev, sensor_settings[HFLIP_IDX]);
378 int s5k4aa_init(struct sd *sd)
382 for (i = 0; i < ARRAY_SIZE(init_s5k4aa) && !err; i++) {
383 u8 data[2] = {0x00, 0x00};
385 switch (init_s5k4aa[i][0]) {
387 err = m5602_write_bridge(sd,
393 data[0] = init_s5k4aa[i][2];
394 err = m5602_write_sensor(sd,
395 init_s5k4aa[i][1], data, 1);
399 data[0] = init_s5k4aa[i][2];
400 data[1] = init_s5k4aa[i][3];
401 err = m5602_write_sensor(sd,
402 init_s5k4aa[i][1], data, 2);
405 info("Invalid stream command, exiting init");
411 s5k4aa_dump_registers(sd);
416 static int s5k4aa_get_exposure(struct gspca_dev *gspca_dev, __s32 *val)
418 struct sd *sd = (struct sd *) gspca_dev;
419 s32 *sensor_settings = sd->sensor_priv;
421 *val = sensor_settings[EXPOSURE_IDX];
422 PDEBUG(D_V4L2, "Read exposure %d", *val);
427 static int s5k4aa_set_exposure(struct gspca_dev *gspca_dev, __s32 val)
429 struct sd *sd = (struct sd *) gspca_dev;
430 s32 *sensor_settings = sd->sensor_priv;
431 u8 data = S5K4AA_PAGE_MAP_2;
434 sensor_settings[EXPOSURE_IDX] = val;
435 PDEBUG(D_V4L2, "Set exposure to %d", val);
436 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
439 data = (val >> 8) & 0xff;
440 err = m5602_write_sensor(sd, S5K4AA_EXPOSURE_HI, &data, 1);
444 err = m5602_write_sensor(sd, S5K4AA_EXPOSURE_LO, &data, 1);
449 static int s5k4aa_get_vflip(struct gspca_dev *gspca_dev, __s32 *val)
451 struct sd *sd = (struct sd *) gspca_dev;
452 s32 *sensor_settings = sd->sensor_priv;
454 *val = sensor_settings[VFLIP_IDX];
455 PDEBUG(D_V4L2, "Read vertical flip %d", *val);
460 static int s5k4aa_set_vflip(struct gspca_dev *gspca_dev, __s32 val)
462 struct sd *sd = (struct sd *) gspca_dev;
463 s32 *sensor_settings = sd->sensor_priv;
464 u8 data = S5K4AA_PAGE_MAP_2;
467 sensor_settings[VFLIP_IDX] = val;
469 PDEBUG(D_V4L2, "Set vertical flip to %d", val);
470 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
473 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
477 err = m5602_read_sensor(sd, S5K4AA_READ_MODE, &data, 1);
481 if (dmi_check_system(s5k4aa_vflip_dmi_table))
484 data = ((data & ~S5K4AA_RM_V_FLIP) | ((val & 0x01) << 7));
485 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
489 err = m5602_read_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
492 data = (data & 0xfe) | !val;
493 err = m5602_write_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
497 static int s5k4aa_get_hflip(struct gspca_dev *gspca_dev, __s32 *val)
499 struct sd *sd = (struct sd *) gspca_dev;
500 s32 *sensor_settings = sd->sensor_priv;
502 *val = sensor_settings[HFLIP_IDX];
503 PDEBUG(D_V4L2, "Read horizontal flip %d", *val);
508 static int s5k4aa_set_hflip(struct gspca_dev *gspca_dev, __s32 val)
510 struct sd *sd = (struct sd *) gspca_dev;
511 s32 *sensor_settings = sd->sensor_priv;
512 u8 data = S5K4AA_PAGE_MAP_2;
515 sensor_settings[HFLIP_IDX] = val;
517 PDEBUG(D_V4L2, "Set horizontal flip to %d", val);
518 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
521 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
525 err = m5602_read_sensor(sd, S5K4AA_READ_MODE, &data, 1);
529 if (dmi_check_system(s5k4aa_vflip_dmi_table))
532 data = ((data & ~S5K4AA_RM_H_FLIP) | ((val & 0x01) << 6));
533 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
537 err = m5602_read_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
540 data = (data & 0xfe) | !val;
541 err = m5602_write_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
545 static int s5k4aa_get_gain(struct gspca_dev *gspca_dev, __s32 *val)
547 struct sd *sd = (struct sd *) gspca_dev;
548 s32 *sensor_settings = sd->sensor_priv;
550 *val = sensor_settings[GAIN_IDX];
551 PDEBUG(D_V4L2, "Read gain %d", *val);
555 static int s5k4aa_set_gain(struct gspca_dev *gspca_dev, __s32 val)
557 struct sd *sd = (struct sd *) gspca_dev;
558 s32 *sensor_settings = sd->sensor_priv;
559 u8 data = S5K4AA_PAGE_MAP_2;
562 sensor_settings[GAIN_IDX] = val;
564 PDEBUG(D_V4L2, "Set gain to %d", val);
565 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
570 err = m5602_write_sensor(sd, S5K4AA_GAIN, &data, 1);
575 static int s5k4aa_get_brightness(struct gspca_dev *gspca_dev, __s32 *val)
577 struct sd *sd = (struct sd *) gspca_dev;
578 s32 *sensor_settings = sd->sensor_priv;
580 *val = sensor_settings[BRIGHTNESS_IDX];
581 PDEBUG(D_V4L2, "Read brightness %d", *val);
585 static int s5k4aa_set_brightness(struct gspca_dev *gspca_dev, __s32 val)
587 struct sd *sd = (struct sd *) gspca_dev;
588 s32 *sensor_settings = sd->sensor_priv;
589 u8 data = S5K4AA_PAGE_MAP_2;
592 sensor_settings[BRIGHTNESS_IDX] = val;
594 PDEBUG(D_V4L2, "Set brightness to %d", val);
595 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
600 return m5602_write_sensor(sd, S5K4AA_BRIGHTNESS, &data, 1);
603 static int s5k4aa_get_noise(struct gspca_dev *gspca_dev, __s32 *val)
605 struct sd *sd = (struct sd *) gspca_dev;
606 s32 *sensor_settings = sd->sensor_priv;
608 *val = sensor_settings[NOISE_SUPP_IDX];
609 PDEBUG(D_V4L2, "Read noise %d", *val);
613 static int s5k4aa_set_noise(struct gspca_dev *gspca_dev, __s32 val)
615 struct sd *sd = (struct sd *) gspca_dev;
616 s32 *sensor_settings = sd->sensor_priv;
617 u8 data = S5K4AA_PAGE_MAP_2;
620 sensor_settings[NOISE_SUPP_IDX] = val;
622 PDEBUG(D_V4L2, "Set noise to %d", val);
623 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
628 return m5602_write_sensor(sd, S5K4AA_NOISE_SUPP, &data, 1);
631 void s5k4aa_disconnect(struct sd *sd)
634 kfree(sd->sensor_priv);
637 static void s5k4aa_dump_registers(struct sd *sd)
641 m5602_read_sensor(sd, S5K4AA_PAGE_MAP, &old_page, 1);
642 for (page = 0; page < 16; page++) {
643 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &page, 1);
644 info("Dumping the s5k4aa register state for page 0x%x", page);
645 for (address = 0; address <= 0xff; address++) {
647 m5602_read_sensor(sd, address, &value, 1);
648 info("register 0x%x contains 0x%x",
652 info("s5k4aa register state dump complete");
654 for (page = 0; page < 16; page++) {
655 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &page, 1);
656 info("Probing for which registers that are "
657 "read/write for page 0x%x", page);
658 for (address = 0; address <= 0xff; address++) {
659 u8 old_value, ctrl_value, test_value = 0xff;
661 m5602_read_sensor(sd, address, &old_value, 1);
662 m5602_write_sensor(sd, address, &test_value, 1);
663 m5602_read_sensor(sd, address, &ctrl_value, 1);
665 if (ctrl_value == test_value)
666 info("register 0x%x is writeable", address);
668 info("register 0x%x is read only", address);
670 /* Restore original value */
671 m5602_write_sensor(sd, address, &old_value, 1);
674 info("Read/write register probing complete");
675 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &old_page, 1);