2 * Driver for the s5k83a 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_s5k83a.h"
21 static void s5k83a_dump_registers(struct sd *sd);
23 int s5k83a_probe(struct sd *sd)
25 u8 prod_id = 0, ver_id = 0;
29 if (force_sensor == S5K83A_SENSOR) {
30 info("Forcing a %s sensor", s5k83a.name);
33 /* If we want to force another sensor, don't try to probe this
38 info("Probing for a s5k83a sensor");
40 /* Preinit the sensor */
41 for (i = 0; i < ARRAY_SIZE(preinit_s5k83a) && !err; i++) {
42 u8 data[2] = {preinit_s5k83a[i][2], preinit_s5k83a[i][3]};
43 if (preinit_s5k83a[i][0] == SENSOR)
44 err = m5602_write_sensor(sd, preinit_s5k83a[i][1],
47 err = m5602_write_bridge(sd, preinit_s5k83a[i][1],
51 /* We don't know what register (if any) that contain the product id
52 * Just pick the first addresses that seem to produce the same results
53 * on multiple machines */
54 if (s5k83a_read_sensor(sd, 0x00, &prod_id, 1))
57 if (s5k83a_read_sensor(sd, 0x01, &ver_id, 1))
60 if ((prod_id == 0xff) || (ver_id == 0xff))
63 info("Detected a s5k83a sensor");
66 sd->gspca_dev.cam.cam_mode = s5k83a.modes;
67 sd->gspca_dev.cam.nmodes = s5k83a.nmodes;
68 sd->desc->ctrls = s5k83a.ctrls;
69 sd->desc->nctrls = s5k83a.nctrls;
73 int s5k83a_read_sensor(struct sd *sd, const u8 address,
74 u8 *i2c_data, const u8 len)
79 err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
80 } while ((*i2c_data & I2C_BUSY) && !err);
84 err = m5602_write_bridge(sd, M5602_XB_I2C_DEV_ADDR,
85 sd->sensor->i2c_slave_id);
89 err = m5602_write_bridge(sd, M5602_XB_I2C_REG_ADDR, address);
93 err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x18 + len);
96 err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
97 } while ((*i2c_data & I2C_BUSY) && !err);
99 for (i = 0; i < len && !len; i++) {
100 err = m5602_read_bridge(sd, M5602_XB_I2C_DATA, &(i2c_data[i]));
102 PDEBUG(D_CONF, "Reading sensor register "
103 "0x%x containing 0x%x ", address, *i2c_data);
110 int s5k83a_write_sensor(struct sd *sd, const u8 address,
111 u8 *i2c_data, const u8 len)
115 struct usb_device *udev = sd->gspca_dev.dev;
116 __u8 *buf = sd->gspca_dev.usb_buf;
118 /* No sensor with a data width larger than 16 bits has yet been seen */
122 memcpy(buf, sensor_urb_skeleton,
123 sizeof(sensor_urb_skeleton));
125 buf[11] = sd->sensor->i2c_slave_id;
128 /* Special case larger sensor writes */
131 /* Copy a four byte write sequence for each byte to be written to */
132 for (i = 0; i < len; i++) {
133 memcpy(p, sensor_urb_skeleton + 16, 4);
136 PDEBUG(D_CONF, "Writing sensor register 0x%x with 0x%x",
137 address, i2c_data[i]);
140 /* Copy the tailer */
141 memcpy(p, sensor_urb_skeleton + 20, 4);
143 /* Set the total length */
146 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
149 20 + len * 4, M5602_URB_MSG_TIMEOUT);
151 return (err < 0) ? err : 0;
154 int s5k83a_init(struct sd *sd)
158 for (i = 0; i < ARRAY_SIZE(init_s5k83a) && !err; i++) {
159 u8 data[2] = {0x00, 0x00};
161 switch (init_s5k83a[i][0]) {
163 err = m5602_write_bridge(sd,
169 data[0] = init_s5k83a[i][2];
170 err = m5602_write_sensor(sd,
171 init_s5k83a[i][1], data, 1);
175 data[0] = init_s5k83a[i][2];
176 data[1] = init_s5k83a[i][3];
177 err = m5602_write_sensor(sd,
178 init_s5k83a[i][1], data, 2);
181 info("Invalid stream command, exiting init");
187 s5k83a_dump_registers(sd);
189 return (err < 0) ? err : 0;
192 int s5k83a_power_down(struct sd *sd)
197 void s5k83a_dump_registers(struct sd *sd)
201 s5k83a_read_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);
203 for (page = 0; page < 16; page++) {
204 m5602_write_sensor(sd, S5K83A_PAGE_MAP, &page, 1);
205 info("Dumping the s5k83a register state for page 0x%x", page);
206 for (address = 0; address <= 0xff; address++) {
208 s5k83a_read_sensor(sd, address, &val, 1);
209 info("register 0x%x contains 0x%x",
213 info("s5k83a register state dump complete");
215 for (page = 0; page < 16; page++) {
216 m5602_write_sensor(sd, S5K83A_PAGE_MAP, &page, 1);
217 info("Probing for which registers that are read/write "
218 "for page 0x%x", page);
219 for (address = 0; address <= 0xff; address++) {
220 u8 old_val, ctrl_val, test_val = 0xff;
222 s5k83a_read_sensor(sd, address, &old_val, 1);
223 m5602_write_sensor(sd, address, &test_val, 1);
224 s5k83a_read_sensor(sd, address, &ctrl_val, 1);
226 if (ctrl_val == test_val)
227 info("register 0x%x is writeable", address);
229 info("register 0x%x is read only", address);
231 /* Restore original val */
232 m5602_write_sensor(sd, address, &old_val, 1);
235 info("Read/write register probing complete");
236 m5602_write_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);
239 int s5k83a_get_brightness(struct gspca_dev *gspca_dev, __s32 *val)
243 struct sd *sd = (struct sd *) gspca_dev;
245 err = s5k83a_read_sensor(sd, S5K83A_BRIGHTNESS, data, 2);
249 data[1] = data[1] << 1;
256 int s5k83a_set_brightness(struct gspca_dev *gspca_dev, __s32 val)
260 struct sd *sd = (struct sd *) gspca_dev;
264 err = m5602_write_sensor(sd, 0x14, data, 2);
270 err = m5602_write_sensor(sd, 0x0d, data, 2);
274 /* FIXME: This is not sane, we need to figure out the composition
275 of these registers */
276 data[0] = val >> 3; /* brightness, high 5 bits */
277 data[1] = val >> 1; /* brightness, high 7 bits */
278 err = m5602_write_sensor(sd, S5K83A_BRIGHTNESS, data, 2);
284 int s5k83a_get_whiteness(struct gspca_dev *gspca_dev, __s32 *val)
288 struct sd *sd = (struct sd *) gspca_dev;
290 err = s5k83a_read_sensor(sd, S5K83A_WHITENESS, &data, 1);
300 int s5k83a_set_whiteness(struct gspca_dev *gspca_dev, __s32 val)
304 struct sd *sd = (struct sd *) gspca_dev;
307 err = m5602_write_sensor(sd, S5K83A_WHITENESS, data, 1);
312 int s5k83a_get_gain(struct gspca_dev *gspca_dev, __s32 *val)
316 struct sd *sd = (struct sd *) gspca_dev;
318 err = s5k83a_read_sensor(sd, S5K83A_GAIN, data, 2);
322 data[1] = data[1] & 0x3f;
323 if (data[1] > S5K83A_MAXIMUM_GAIN)
324 data[1] = S5K83A_MAXIMUM_GAIN;
332 int s5k83a_set_gain(struct gspca_dev *gspca_dev, __s32 val)
336 struct sd *sd = (struct sd *) gspca_dev;
340 err = m5602_write_sensor(sd, S5K83A_GAIN, data, 2);
344 int s5k83a_get_vflip(struct gspca_dev *gspca_dev, __s32 *val)
348 struct sd *sd = (struct sd *) gspca_dev;
351 err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
355 err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
356 *val = (data[0] | 0x40) ? 1 : 0;
362 int s5k83a_set_vflip(struct gspca_dev *gspca_dev, __s32 val)
366 struct sd *sd = (struct sd *) gspca_dev;
369 err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
373 err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
377 /* set or zero six bit, seven is hflip */
378 data[0] = (val) ? (data[0] & 0x80) | 0x40 | S5K83A_FLIP_MASK
379 : (data[0] & 0x80) | S5K83A_FLIP_MASK;
380 err = m5602_write_sensor(sd, S5K83A_FLIP, data, 1);
384 data[0] = (val) ? 0x0b : 0x0a;
385 err = m5602_write_sensor(sd, S5K83A_VFLIP_TUNE, data, 1);
391 int s5k83a_get_hflip(struct gspca_dev *gspca_dev, __s32 *val)
395 struct sd *sd = (struct sd *) gspca_dev;
398 err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
402 err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
403 *val = (data[0] | 0x80) ? 1 : 0;
409 int s5k83a_set_hflip(struct gspca_dev *gspca_dev, __s32 val)
413 struct sd *sd = (struct sd *) gspca_dev;
416 err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
420 err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
424 /* set or zero seven bit, six is vflip */
425 data[0] = (val) ? (data[0] & 0x40) | 0x80 | S5K83A_FLIP_MASK
426 : (data[0] & 0x40) | S5K83A_FLIP_MASK;
427 err = m5602_write_sensor(sd, S5K83A_FLIP, data, 1);
431 data[0] = (val) ? 0x0a : 0x0b;
432 err = m5602_write_sensor(sd, S5K83A_HFLIP_TUNE, data, 1);