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")
50 .ident = "Fujitsu-Siemens Amilo Pa 2548",
52 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
53 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Pa 2548")
58 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
59 DMI_MATCH(DMI_PRODUCT_NAME, "GX700"),
60 DMI_MATCH(DMI_BIOS_DATE, "07/26/2007")
63 .ident = "MSI GX700/GX705/EX700",
65 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
66 DMI_MATCH(DMI_PRODUCT_NAME, "GX700/GX705/EX700")
71 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star International"),
72 DMI_MATCH(DMI_PRODUCT_NAME, "MS-1717X")
75 .ident = "Lenovo Y300",
77 DMI_MATCH(DMI_SYS_VENDOR, "L3000 Y300"),
78 DMI_MATCH(DMI_PRODUCT_NAME, "Y300")
84 static struct v4l2_pix_format s5k4aa_modes[] = {
93 .colorspace = V4L2_COLORSPACE_SRGB,
103 .bytesperline = 1280,
104 .colorspace = V4L2_COLORSPACE_SRGB,
109 static const struct ctrl s5k4aa_ctrls[] = {
113 .id = V4L2_CID_VFLIP,
114 .type = V4L2_CTRL_TYPE_BOOLEAN,
115 .name = "vertical flip",
121 .set = s5k4aa_set_vflip,
122 .get = s5k4aa_get_vflip
127 .id = V4L2_CID_HFLIP,
128 .type = V4L2_CTRL_TYPE_BOOLEAN,
129 .name = "horizontal flip",
135 .set = s5k4aa_set_hflip,
136 .get = s5k4aa_get_hflip
142 .type = V4L2_CTRL_TYPE_INTEGER,
147 .default_value = S5K4AA_DEFAULT_GAIN,
148 .flags = V4L2_CTRL_FLAG_SLIDER
150 .set = s5k4aa_set_gain,
151 .get = s5k4aa_get_gain
153 #define EXPOSURE_IDX 3
156 .id = V4L2_CID_EXPOSURE,
157 .type = V4L2_CTRL_TYPE_INTEGER,
162 .default_value = 0x100,
163 .flags = V4L2_CTRL_FLAG_SLIDER
165 .set = s5k4aa_set_exposure,
166 .get = s5k4aa_get_exposure
168 #define NOISE_SUPP_IDX 4
171 .id = V4L2_CID_PRIVATE_BASE,
172 .type = V4L2_CTRL_TYPE_BOOLEAN,
173 .name = "Noise suppression (smoothing)",
179 .set = s5k4aa_set_noise,
180 .get = s5k4aa_get_noise
182 #define BRIGHTNESS_IDX 5
185 .id = V4L2_CID_BRIGHTNESS,
186 .type = V4L2_CTRL_TYPE_INTEGER,
187 .name = "Brightness",
191 .default_value = S5K4AA_DEFAULT_BRIGHTNESS,
193 .set = s5k4aa_set_brightness,
194 .get = s5k4aa_get_brightness
199 static void s5k4aa_dump_registers(struct sd *sd);
201 int s5k4aa_probe(struct sd *sd)
203 u8 prod_id[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
204 const u8 expected_prod_id[6] = {0x00, 0x10, 0x00, 0x4b, 0x33, 0x75};
206 s32 *sensor_settings;
209 if (force_sensor == S5K4AA_SENSOR) {
210 info("Forcing a %s sensor", s5k4aa.name);
213 /* If we want to force another sensor, don't try to probe this
218 info("Probing for a s5k4aa sensor");
220 /* Preinit the sensor */
221 for (i = 0; i < ARRAY_SIZE(preinit_s5k4aa) && !err; i++) {
222 u8 data[2] = {0x00, 0x00};
224 switch (preinit_s5k4aa[i][0]) {
226 err = m5602_write_bridge(sd,
227 preinit_s5k4aa[i][1],
228 preinit_s5k4aa[i][2]);
232 data[0] = preinit_s5k4aa[i][2];
233 err = m5602_write_sensor(sd,
234 preinit_s5k4aa[i][1],
239 data[0] = preinit_s5k4aa[i][2];
240 data[1] = preinit_s5k4aa[i][3];
241 err = m5602_write_sensor(sd,
242 preinit_s5k4aa[i][1],
246 info("Invalid stream command, exiting init");
251 /* Test some registers, but we don't know their exact meaning yet */
252 if (m5602_read_sensor(sd, 0x00, prod_id, 2))
254 if (m5602_read_sensor(sd, 0x02, prod_id+2, 2))
256 if (m5602_read_sensor(sd, 0x04, prod_id+4, 2))
259 if (memcmp(prod_id, expected_prod_id, sizeof(prod_id)))
262 info("Detected a s5k4aa sensor");
265 sensor_settings = kmalloc(
266 ARRAY_SIZE(s5k4aa_ctrls) * sizeof(s32), GFP_KERNEL);
267 if (!sensor_settings)
270 sd->gspca_dev.cam.cam_mode = s5k4aa_modes;
271 sd->gspca_dev.cam.nmodes = ARRAY_SIZE(s5k4aa_modes);
272 sd->desc->ctrls = s5k4aa_ctrls;
273 sd->desc->nctrls = ARRAY_SIZE(s5k4aa_ctrls);
275 for (i = 0; i < ARRAY_SIZE(s5k4aa_ctrls); i++)
276 sensor_settings[i] = s5k4aa_ctrls[i].qctrl.default_value;
277 sd->sensor_priv = sensor_settings;
282 int s5k4aa_start(struct sd *sd)
286 struct cam *cam = &sd->gspca_dev.cam;
287 s32 *sensor_settings = sd->sensor_priv;
289 switch (cam->cam_mode[sd->gspca_dev.curr_mode].width) {
291 PDEBUG(D_V4L2, "Configuring camera for SXGA mode");
293 for (i = 0; i < ARRAY_SIZE(SXGA_s5k4aa); i++) {
294 switch (SXGA_s5k4aa[i][0]) {
296 err = m5602_write_bridge(sd,
302 data[0] = SXGA_s5k4aa[i][2];
303 err = m5602_write_sensor(sd,
309 data[0] = SXGA_s5k4aa[i][2];
310 data[1] = SXGA_s5k4aa[i][3];
311 err = m5602_write_sensor(sd,
317 err("Invalid stream command, exiting init");
321 err = s5k4aa_set_noise(&sd->gspca_dev, 0);
327 PDEBUG(D_V4L2, "Configuring camera for VGA mode");
329 for (i = 0; i < ARRAY_SIZE(VGA_s5k4aa); i++) {
330 switch (VGA_s5k4aa[i][0]) {
332 err = m5602_write_bridge(sd,
338 data[0] = VGA_s5k4aa[i][2];
339 err = m5602_write_sensor(sd,
345 data[0] = VGA_s5k4aa[i][2];
346 data[1] = VGA_s5k4aa[i][3];
347 err = m5602_write_sensor(sd,
353 err("Invalid stream command, exiting init");
357 err = s5k4aa_set_noise(&sd->gspca_dev, 1);
365 err = s5k4aa_set_exposure(&sd->gspca_dev,
366 sensor_settings[EXPOSURE_IDX]);
370 err = s5k4aa_set_gain(&sd->gspca_dev, sensor_settings[GAIN_IDX]);
374 err = s5k4aa_set_brightness(&sd->gspca_dev,
375 sensor_settings[BRIGHTNESS_IDX]);
379 err = s5k4aa_set_noise(&sd->gspca_dev, sensor_settings[NOISE_SUPP_IDX]);
383 err = s5k4aa_set_vflip(&sd->gspca_dev, sensor_settings[VFLIP_IDX]);
387 return s5k4aa_set_hflip(&sd->gspca_dev, sensor_settings[HFLIP_IDX]);
390 int s5k4aa_init(struct sd *sd)
394 for (i = 0; i < ARRAY_SIZE(init_s5k4aa) && !err; i++) {
395 u8 data[2] = {0x00, 0x00};
397 switch (init_s5k4aa[i][0]) {
399 err = m5602_write_bridge(sd,
405 data[0] = init_s5k4aa[i][2];
406 err = m5602_write_sensor(sd,
407 init_s5k4aa[i][1], data, 1);
411 data[0] = init_s5k4aa[i][2];
412 data[1] = init_s5k4aa[i][3];
413 err = m5602_write_sensor(sd,
414 init_s5k4aa[i][1], data, 2);
417 info("Invalid stream command, exiting init");
423 s5k4aa_dump_registers(sd);
428 static int s5k4aa_get_exposure(struct gspca_dev *gspca_dev, __s32 *val)
430 struct sd *sd = (struct sd *) gspca_dev;
431 s32 *sensor_settings = sd->sensor_priv;
433 *val = sensor_settings[EXPOSURE_IDX];
434 PDEBUG(D_V4L2, "Read exposure %d", *val);
439 static int s5k4aa_set_exposure(struct gspca_dev *gspca_dev, __s32 val)
441 struct sd *sd = (struct sd *) gspca_dev;
442 s32 *sensor_settings = sd->sensor_priv;
443 u8 data = S5K4AA_PAGE_MAP_2;
446 sensor_settings[EXPOSURE_IDX] = val;
447 PDEBUG(D_V4L2, "Set exposure to %d", val);
448 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
451 data = (val >> 8) & 0xff;
452 err = m5602_write_sensor(sd, S5K4AA_EXPOSURE_HI, &data, 1);
456 err = m5602_write_sensor(sd, S5K4AA_EXPOSURE_LO, &data, 1);
461 static int s5k4aa_get_vflip(struct gspca_dev *gspca_dev, __s32 *val)
463 struct sd *sd = (struct sd *) gspca_dev;
464 s32 *sensor_settings = sd->sensor_priv;
466 *val = sensor_settings[VFLIP_IDX];
467 PDEBUG(D_V4L2, "Read vertical flip %d", *val);
472 static int s5k4aa_set_vflip(struct gspca_dev *gspca_dev, __s32 val)
474 struct sd *sd = (struct sd *) gspca_dev;
475 s32 *sensor_settings = sd->sensor_priv;
476 u8 data = S5K4AA_PAGE_MAP_2;
479 sensor_settings[VFLIP_IDX] = val;
481 PDEBUG(D_V4L2, "Set vertical flip to %d", val);
482 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
486 err = m5602_read_sensor(sd, S5K4AA_READ_MODE, &data, 1);
490 if (dmi_check_system(s5k4aa_vflip_dmi_table))
493 data = ((data & ~S5K4AA_RM_V_FLIP) | ((val & 0x01) << 7));
494 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
498 err = m5602_read_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
501 data = (data & 0xfe) | !val;
502 err = m5602_write_sensor(sd, S5K4AA_ROWSTART_LO, &data, 1);
506 static int s5k4aa_get_hflip(struct gspca_dev *gspca_dev, __s32 *val)
508 struct sd *sd = (struct sd *) gspca_dev;
509 s32 *sensor_settings = sd->sensor_priv;
511 *val = sensor_settings[HFLIP_IDX];
512 PDEBUG(D_V4L2, "Read horizontal flip %d", *val);
517 static int s5k4aa_set_hflip(struct gspca_dev *gspca_dev, __s32 val)
519 struct sd *sd = (struct sd *) gspca_dev;
520 s32 *sensor_settings = sd->sensor_priv;
521 u8 data = S5K4AA_PAGE_MAP_2;
524 sensor_settings[HFLIP_IDX] = val;
526 PDEBUG(D_V4L2, "Set horizontal flip to %d", val);
527 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
531 err = m5602_read_sensor(sd, S5K4AA_READ_MODE, &data, 1);
535 if (dmi_check_system(s5k4aa_vflip_dmi_table))
538 data = ((data & ~S5K4AA_RM_H_FLIP) | ((val & 0x01) << 6));
539 err = m5602_write_sensor(sd, S5K4AA_READ_MODE, &data, 1);
543 err = m5602_read_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
546 data = (data & 0xfe) | !val;
547 err = m5602_write_sensor(sd, S5K4AA_COLSTART_LO, &data, 1);
551 static int s5k4aa_get_gain(struct gspca_dev *gspca_dev, __s32 *val)
553 struct sd *sd = (struct sd *) gspca_dev;
554 s32 *sensor_settings = sd->sensor_priv;
556 *val = sensor_settings[GAIN_IDX];
557 PDEBUG(D_V4L2, "Read gain %d", *val);
561 static int s5k4aa_set_gain(struct gspca_dev *gspca_dev, __s32 val)
563 struct sd *sd = (struct sd *) gspca_dev;
564 s32 *sensor_settings = sd->sensor_priv;
565 u8 data = S5K4AA_PAGE_MAP_2;
568 sensor_settings[GAIN_IDX] = val;
570 PDEBUG(D_V4L2, "Set gain to %d", val);
571 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
576 err = m5602_write_sensor(sd, S5K4AA_GAIN, &data, 1);
581 static int s5k4aa_get_brightness(struct gspca_dev *gspca_dev, __s32 *val)
583 struct sd *sd = (struct sd *) gspca_dev;
584 s32 *sensor_settings = sd->sensor_priv;
586 *val = sensor_settings[BRIGHTNESS_IDX];
587 PDEBUG(D_V4L2, "Read brightness %d", *val);
591 static int s5k4aa_set_brightness(struct gspca_dev *gspca_dev, __s32 val)
593 struct sd *sd = (struct sd *) gspca_dev;
594 s32 *sensor_settings = sd->sensor_priv;
595 u8 data = S5K4AA_PAGE_MAP_2;
598 sensor_settings[BRIGHTNESS_IDX] = val;
600 PDEBUG(D_V4L2, "Set brightness to %d", val);
601 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
606 return m5602_write_sensor(sd, S5K4AA_BRIGHTNESS, &data, 1);
609 static int s5k4aa_get_noise(struct gspca_dev *gspca_dev, __s32 *val)
611 struct sd *sd = (struct sd *) gspca_dev;
612 s32 *sensor_settings = sd->sensor_priv;
614 *val = sensor_settings[NOISE_SUPP_IDX];
615 PDEBUG(D_V4L2, "Read noise %d", *val);
619 static int s5k4aa_set_noise(struct gspca_dev *gspca_dev, __s32 val)
621 struct sd *sd = (struct sd *) gspca_dev;
622 s32 *sensor_settings = sd->sensor_priv;
623 u8 data = S5K4AA_PAGE_MAP_2;
626 sensor_settings[NOISE_SUPP_IDX] = val;
628 PDEBUG(D_V4L2, "Set noise to %d", val);
629 err = m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &data, 1);
634 return m5602_write_sensor(sd, S5K4AA_NOISE_SUPP, &data, 1);
637 void s5k4aa_disconnect(struct sd *sd)
640 kfree(sd->sensor_priv);
643 static void s5k4aa_dump_registers(struct sd *sd)
647 m5602_read_sensor(sd, S5K4AA_PAGE_MAP, &old_page, 1);
648 for (page = 0; page < 16; page++) {
649 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &page, 1);
650 info("Dumping the s5k4aa register state for page 0x%x", page);
651 for (address = 0; address <= 0xff; address++) {
653 m5602_read_sensor(sd, address, &value, 1);
654 info("register 0x%x contains 0x%x",
658 info("s5k4aa register state dump complete");
660 for (page = 0; page < 16; page++) {
661 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &page, 1);
662 info("Probing for which registers that are "
663 "read/write for page 0x%x", page);
664 for (address = 0; address <= 0xff; address++) {
665 u8 old_value, ctrl_value, test_value = 0xff;
667 m5602_read_sensor(sd, address, &old_value, 1);
668 m5602_write_sensor(sd, address, &test_value, 1);
669 m5602_read_sensor(sd, address, &ctrl_value, 1);
671 if (ctrl_value == test_value)
672 info("register 0x%x is writeable", address);
674 info("register 0x%x is read only", address);
676 /* Restore original value */
677 m5602_write_sensor(sd, address, &old_value, 1);
680 info("Read/write register probing complete");
681 m5602_write_sensor(sd, S5K4AA_PAGE_MAP, &old_page, 1);