[mirror_ubuntu-jammy-kernel.git] / drivers / media / video / gspca / m5602 / m5602_s5k83a.c

/*
 * Driver for the s5k83a sensor
 *
 * Copyright (C) 2008 Erik Andren
 * Copyright (C) 2007 Ilyes Gouta. Based on the m5603x Linux Driver Project.
 * Copyright (C) 2005 m5603x Linux Driver Project <m5602@x3ng.com.br>
 *
 * Portions of code to USB interface and ALi driver software,
 * Copyright (c) 2006 Willem Duinker
 * v4l2 interface modeled after the V4L2 driver
 * for SN9C10x PC Camera Controllers
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, version 2.
 *
 */

#include "m5602_s5k83a.h"

int s5k83a_probe(struct sd *sd)
{
	u8 prod_id = 0, ver_id = 0;
	int i, err = 0;

	if (force_sensor) {
		if (force_sensor == S5K83A_SENSOR) {
			info("Forcing a %s sensor", s5k83a.name);
			goto sensor_found;
		}
		/* If we want to force another sensor, don't try to probe this
		 * one */
		return -ENODEV;
	}

	info("Probing for a s5k83a sensor");

	/* Preinit the sensor */
	for (i = 0; i < ARRAY_SIZE(preinit_s5k83a) && !err; i++) {
		u8 data[2] = {preinit_s5k83a[i][2], preinit_s5k83a[i][3]};
		if (preinit_s5k83a[i][0] == SENSOR)
			err = s5k83a_write_sensor(sd, preinit_s5k83a[i][1],
				data, 2);
		else
			err = m5602_write_bridge(sd, preinit_s5k83a[i][1],
				data[0]);
	}

	/* We don't know what register (if any) that contain the product id
	 * Just pick the first addresses that seem to produce the same results
	 * on multiple machines */
	if (s5k83a_read_sensor(sd, 0x00, &prod_id, 1))
		return -ENODEV;

	if (s5k83a_read_sensor(sd, 0x01, &ver_id, 1))
		return -ENODEV;

	if ((prod_id == 0xff) || (ver_id == 0xff))
		return -ENODEV;
	else
		info("Detected a s5k83a sensor");

sensor_found:
	sd->gspca_dev.cam.cam_mode = s5k83a.modes;
	sd->gspca_dev.cam.nmodes = s5k83a.nmodes;
	return 0;
}

int s5k83a_read_sensor(struct sd *sd, const u8 address,
			      u8 *i2c_data, const u8 len)
{
	int err, i;

	do {
		err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
	} while ((*i2c_data & I2C_BUSY) && !err);
	if (err < 0)
		goto out;

	err = m5602_write_bridge(sd, M5602_XB_I2C_DEV_ADDR,
				 sd->sensor->i2c_slave_id);
	if (err < 0)
		goto out;

	err = m5602_write_bridge(sd, M5602_XB_I2C_REG_ADDR, address);
	if (err < 0)
		goto out;

	err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x18 + len);
	if (err < 0)
		goto out;

	do {
		err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
	} while ((*i2c_data & I2C_BUSY) && !err);

	if (err < 0)
		goto out;
	for (i = 0; i < len && !len; i++) {
		err = m5602_read_bridge(sd, M5602_XB_I2C_DATA, &(i2c_data[i]));

		PDEBUG(DBG_TRACE, "Reading sensor register "
				  "0x%x containing 0x%x ", address, *i2c_data);
	}

out:
	return (err < 0) ? err : 0;
}

int s5k83a_write_sensor(struct sd *sd, const u8 address,
			       u8 *i2c_data, const u8 len)
{
	int err, i;
	u8 *p;
	struct usb_device *udev = sd->gspca_dev.dev;
	__u8 *buf = sd->gspca_dev.usb_buf;

	/* No sensor with a data width larger than 16 bits has yet been seen */
	if (len > 2 || !len)
		return -EINVAL;

	memcpy(buf, sensor_urb_skeleton,
	       sizeof(sensor_urb_skeleton));

	buf[11] = sd->sensor->i2c_slave_id;
	buf[15] = address;

	/* Special case larger sensor writes */
	p = buf + 16;

	/* Copy a four byte write sequence for each byte to be written to */
	for (i = 0; i < len; i++) {
		memcpy(p, sensor_urb_skeleton + 16, 4);
		p[3] = i2c_data[i];
		p += 4;
		PDEBUG(DBG_TRACE, "Writing sensor register 0x%x with 0x%x",
		       address, i2c_data[i]);
	}

	/* Copy the tailer */
	memcpy(p, sensor_urb_skeleton + 20, 4);

	/* Set the total length */
	p[3] = 0x10 + len;

	err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
			      0x04, 0x40, 0x19,
			      0x0000, buf,
			      20 + len * 4, M5602_URB_MSG_TIMEOUT);

	return (err < 0) ? err : 0;
}

int s5k83a_init(struct sd *sd)
{
	int i, err = 0;

	for (i = 0; i < ARRAY_SIZE(init_s5k83a) && !err; i++) {
		u8 data[2] = {0x00, 0x00};

		switch (init_s5k83a[i][0]) {
		case BRIDGE:
			err = m5602_write_bridge(sd,
					init_s5k83a[i][1],
					init_s5k83a[i][2]);
			break;

		case SENSOR:
			data[0] = init_s5k83a[i][2];
			err = s5k83a_write_sensor(sd,
				init_s5k83a[i][1], data, 1);
			break;

		case SENSOR_LONG:
			data[0] = init_s5k83a[i][2];
			data[1] = init_s5k83a[i][3];
			err = s5k83a_write_sensor(sd,
				init_s5k83a[i][1], data, 2);
			break;
		default:
			info("Invalid stream command, exiting init");
			return -EINVAL;
		}
	}

	if (dump_sensor)
		s5k83a_dump_registers(sd);

	return (err < 0) ? err : 0;
}

int s5k83a_power_down(struct sd *sd)
{
	return 0;
}

void s5k83a_dump_registers(struct sd *sd)
{
	int address;
	u8 page, old_page;
	s5k83a_read_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);

	for (page = 0; page < 16; page++) {
		s5k83a_write_sensor(sd, S5K83A_PAGE_MAP, &page, 1);
		info("Dumping the s5k83a register state for page 0x%x", page);
		for (address = 0; address <= 0xff; address++) {
			u8 val = 0;
			s5k83a_read_sensor(sd, address, &val, 1);
			info("register 0x%x contains 0x%x",
			     address, val);
		}
	}
	info("s5k83a register state dump complete");

	for (page = 0; page < 16; page++) {
		s5k83a_write_sensor(sd, S5K83A_PAGE_MAP, &page, 1);
		info("Probing for which registers that are read/write "
		      "for page 0x%x", page);
		for (address = 0; address <= 0xff; address++) {
			u8 old_val, ctrl_val, test_val = 0xff;

			s5k83a_read_sensor(sd, address, &old_val, 1);
			s5k83a_write_sensor(sd, address, &test_val, 1);
			s5k83a_read_sensor(sd, address, &ctrl_val, 1);

			if (ctrl_val == test_val)
				info("register 0x%x is writeable", address);
			else
				info("register 0x%x is read only", address);

			/* Restore original val */
			s5k83a_write_sensor(sd, address, &old_val, 1);
		}
	}
	info("Read/write register probing complete");
	s5k83a_write_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);
}

int s5k83a_get_brightness(struct gspca_dev *gspca_dev, __s32 *val)
{
	int err;
	u8 data[2];
	struct sd *sd = (struct sd *) gspca_dev;

	err = s5k83a_read_sensor(sd, S5K83A_BRIGHTNESS, data, 2);
	data[1] = data[1] << 1;
	*val = data[1];

	return (err < 0) ? err : 0;
}

int s5k83a_set_brightness(struct gspca_dev *gspca_dev, __s32 val)
{
	int err;
	u8 data[2];
	struct sd *sd = (struct sd *) gspca_dev;

	data[0] = 0x00;
	data[1] = 0x20;
	err = s5k83a_write_sensor(sd, 0x14, data, 2);
	if (err < 0)
		return err;

	data[0] = 0x01;
	data[1] = 0x00;
	err = s5k83a_write_sensor(sd, 0x0d, data, 2);
	if (err < 0)
		return err;

	/* FIXME: This is not sane, we need to figure out the composition
		  of these registers */
	data[0] = val >> 3; /* brightness, high 5 bits */
	data[1] = val >> 1; /* brightness, high 7 bits */
	err = s5k83a_write_sensor(sd, S5K83A_BRIGHTNESS, data, 2);

	return (err < 0) ? err : 0;
}

int s5k83a_get_whiteness(struct gspca_dev *gspca_dev, __s32 *val)
{
	int err;
	u8 data;
	struct sd *sd = (struct sd *) gspca_dev;

	err = s5k83a_read_sensor(sd, S5K83A_WHITENESS, &data, 1);

	*val = data;
	return (err < 0) ? err : 0;
}

int s5k83a_set_whiteness(struct gspca_dev *gspca_dev, __s32 val)
{
	int err;
	u8 data[1];
	struct sd *sd = (struct sd *) gspca_dev;

	data[0] = val;
	err = s5k83a_write_sensor(sd, S5K83A_WHITENESS, data, 1);

	return (err < 0) ? err : 0;
}

int s5k83a_get_gain(struct gspca_dev *gspca_dev, __s32 *val)
{
	int err;
	u8 data[2];
	struct sd *sd = (struct sd *) gspca_dev;

	err = s5k83a_read_sensor(sd, S5K83A_GAIN, data, 2);

	data[1] = data[1] & 0x3f;
	if (data[1] > S5K83A_MAXIMUM_GAIN)
		data[1] = S5K83A_MAXIMUM_GAIN;

	*val = data[1];

	return (err < 0) ? err : 0;
}

int s5k83a_set_gain(struct gspca_dev *gspca_dev, __s32 val)
{
	int err = 0;
	u8 data[2];
	struct sd *sd = (struct sd *) gspca_dev;

	data[0] = 0;
	data[1] = val;
	err = s5k83a_write_sensor(sd, S5K83A_GAIN, data, 2);

	return (err < 0) ? err : 0;
}
Commit	Line	Data
c109f816 EA	1	/*
	2	* Driver for the s5k83a sensor
	3	*
	4	* Copyright (C) 2008 Erik Andren
	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>
	7	*
	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
	12	*
	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.
	16	*
	17	*/
	18
	19	#include "m5602_s5k83a.h"
	20
	21	int s5k83a_probe(struct sd *sd)
	22	{
	23	u8 prod_id = 0, ver_id = 0;
	24	int i, err = 0;
	25
	26	if (force_sensor) {
	27	if (force_sensor == S5K83A_SENSOR) {
	28	info("Forcing a %s sensor", s5k83a.name);
	29	goto sensor_found;
	30	}
	31	/* If we want to force another sensor, don't try to probe this
	32	* one */
	33	return -ENODEV;
	34	}
	35
	36	info("Probing for a s5k83a sensor");
	37
	38	/* Preinit the sensor */
	39	for (i = 0; i < ARRAY_SIZE(preinit_s5k83a) && !err; i++) {
	40	u8 data[2] = {preinit_s5k83a[i][2], preinit_s5k83a[i][3]};
	41	if (preinit_s5k83a[i][0] == SENSOR)
	42	err = s5k83a_write_sensor(sd, preinit_s5k83a[i][1],
	43	data, 2);
	44	else
	45	err = m5602_write_bridge(sd, preinit_s5k83a[i][1],
	46	data[0]);
	47	}
	48
	49	/* We don't know what register (if any) that contain the product id
	50	* Just pick the first addresses that seem to produce the same results
	51	* on multiple machines */
	52	if (s5k83a_read_sensor(sd, 0x00, &prod_id, 1))
	53	return -ENODEV;
	54
	55	if (s5k83a_read_sensor(sd, 0x01, &ver_id, 1))
	56	return -ENODEV;
	57
	58	if ((prod_id == 0xff) \|\| (ver_id == 0xff))
	59	return -ENODEV;
	60	else
	61	info("Detected a s5k83a sensor");
	62
	63	sensor_found:
	64	sd->gspca_dev.cam.cam_mode = s5k83a.modes;
65	sd->gspca_dev.cam.nmodes = s5k83a.nmodes;
66	return 0;
67	}
68
69	int s5k83a_read_sensor(struct sd *sd, const u8 address,
70	u8 *i2c_data, const u8 len)
71	{
72	int err, i;
73
74	do {
75	err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
76	} while ((*i2c_data & I2C_BUSY) && !err);
77	if (err < 0)
78	goto out;
79
80	err = m5602_write_bridge(sd, M5602_XB_I2C_DEV_ADDR,
81	sd->sensor->i2c_slave_id);
82	if (err < 0)
83	goto out;
84
85	err = m5602_write_bridge(sd, M5602_XB_I2C_REG_ADDR, address);
86	if (err < 0)
87	goto out;
88
89	err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x18 + len);
90	if (err < 0)
91	goto out;
92
93	do {
94	err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
95	} while ((*i2c_data & I2C_BUSY) && !err);
96
97	if (err < 0)
98	goto out;
99	for (i = 0; i < len && !len; i++) {
100	err = m5602_read_bridge(sd, M5602_XB_I2C_DATA, &(i2c_data[i]));
101
102	PDEBUG(DBG_TRACE, "Reading sensor register "
103	"0x%x containing 0x%x ", address, *i2c_data);
104	}
105
106	out:
107	return (err < 0) ? err : 0;
108	}
109
110	int s5k83a_write_sensor(struct sd *sd, const u8 address,
111	u8 *i2c_data, const u8 len)
112	{
113	int err, i;
114	u8 *p;
115	struct usb_device *udev = sd->gspca_dev.dev;
116	__u8 *buf = sd->gspca_dev.usb_buf;
117
118	/* No sensor with a data width larger than 16 bits has yet been seen */
119	if (len > 2 \|\| !len)
120	return -EINVAL;
121
122	memcpy(buf, sensor_urb_skeleton,
123	sizeof(sensor_urb_skeleton));
124
125	buf[11] = sd->sensor->i2c_slave_id;
126	buf[15] = address;
127
128	/* Special case larger sensor writes */
129	p = buf + 16;
130
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);
134	p[3] = i2c_data[i];
135	p += 4;
136	PDEBUG(DBG_TRACE, "Writing sensor register 0x%x with 0x%x",
137	address, i2c_data[i]);
138	}
139
140	/* Copy the tailer */
141	memcpy(p, sensor_urb_skeleton + 20, 4);
142
143	/* Set the total length */
144	p[3] = 0x10 + len;
145
146	err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
147	0x04, 0x40, 0x19,
148	0x0000, buf,
149	20 + len * 4, M5602_URB_MSG_TIMEOUT);
150
151	return (err < 0) ? err : 0;
152	}
153
154	int s5k83a_init(struct sd *sd)
155	{
156	int i, err = 0;
157
158	for (i = 0; i < ARRAY_SIZE(init_s5k83a) && !err; i++) {
159	u8 data[2] = {0x00, 0x00};
160
161	switch (init_s5k83a[i][0]) {
162	case BRIDGE:
163	err = m5602_write_bridge(sd,
164	init_s5k83a[i][1],
165	init_s5k83a[i][2]);
166	break;
167
168	case SENSOR:
169	data[0] = init_s5k83a[i][2];
170	err = s5k83a_write_sensor(sd,
171	init_s5k83a[i][1], data, 1);
172	break;
173
174	case SENSOR_LONG:
175	data[0] = init_s5k83a[i][2];
176	data[1] = init_s5k83a[i][3];
177	err = s5k83a_write_sensor(sd,
178	init_s5k83a[i][1], data, 2);
179	break;
180	default:
181	info("Invalid stream command, exiting init");
182	return -EINVAL;
183	}
184	}
185
186	if (dump_sensor)
187	s5k83a_dump_registers(sd);
188
189	return (err < 0) ? err : 0;
190	}
191
192	int s5k83a_power_down(struct sd *sd)
193	{
194	return 0;
195	}
196
197	void s5k83a_dump_registers(struct sd *sd)
198	{
199	int address;
200	u8 page, old_page;
201	s5k83a_read_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);
202
203	for (page = 0; page < 16; page++) {
204	s5k83a_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++) {
207	u8 val = 0;
208	s5k83a_read_sensor(sd, address, &val, 1);
209	info("register 0x%x contains 0x%x",
210	address, val);
211	}
212	}
213	info("s5k83a register state dump complete");
214
215	for (page = 0; page < 16; page++) {
216	s5k83a_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;
221
222	s5k83a_read_sensor(sd, address, &old_val, 1);
223	s5k83a_write_sensor(sd, address, &test_val, 1);
224	s5k83a_read_sensor(sd, address, &ctrl_val, 1);
225
226	if (ctrl_val == test_val)
227	info("register 0x%x is writeable", address);
228	else
229	info("register 0x%x is read only", address);
230
231	/* Restore original val */
232	s5k83a_write_sensor(sd, address, &old_val, 1);
233	}
234	}
235	info("Read/write register probing complete");
236	s5k83a_write_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);
237	}
238
239	int s5k83a_get_brightness(struct gspca_dev gspca_dev, __s32 val)
240	{
241	int err;
242	u8 data[2];
243	struct sd sd = (struct sd ) gspca_dev;
244
245	err = s5k83a_read_sensor(sd, S5K83A_BRIGHTNESS, data, 2);
246	data[1] = data[1] << 1;
247	*val = data[1];
248
249	return (err < 0) ? err : 0;
250	}
251
252	int s5k83a_set_brightness(struct gspca_dev *gspca_dev, __s32 val)
253	{
254	int err;
255	u8 data[2];
256	struct sd sd = (struct sd ) gspca_dev;
257
258	data[0] = 0x00;
259	data[1] = 0x20;
260	err = s5k83a_write_sensor(sd, 0x14, data, 2);
261	if (err < 0)
262	return err;
263
264	data[0] = 0x01;
265	data[1] = 0x00;
266	err = s5k83a_write_sensor(sd, 0x0d, data, 2);
267	if (err < 0)
268	return err;
269
270	/* FIXME: This is not sane, we need to figure out the composition
271	of these registers */
272	data[0] = val >> 3; /* brightness, high 5 bits */
273	data[1] = val >> 1; /* brightness, high 7 bits */
274	err = s5k83a_write_sensor(sd, S5K83A_BRIGHTNESS, data, 2);
275
276	return (err < 0) ? err : 0;
277	}
278
279	int s5k83a_get_whiteness(struct gspca_dev gspca_dev, __s32 val)
280	{
281	int err;
282	u8 data;
283	struct sd sd = (struct sd ) gspca_dev;
284
285	err = s5k83a_read_sensor(sd, S5K83A_WHITENESS, &data, 1);
286
287	*val = data;
288	return (err < 0) ? err : 0;
289	}
290
291	int s5k83a_set_whiteness(struct gspca_dev *gspca_dev, __s32 val)
292	{
293	int err;
294	u8 data[1];
295	struct sd sd = (struct sd ) gspca_dev;
296
297	data[0] = val;
298	err = s5k83a_write_sensor(sd, S5K83A_WHITENESS, data, 1);
299
300	return (err < 0) ? err : 0;
301	}
302
303	int s5k83a_get_gain(struct gspca_dev gspca_dev, __s32 val)
304	{
305	int err;
306	u8 data[2];
307	struct sd sd = (struct sd ) gspca_dev;
308
309	err = s5k83a_read_sensor(sd, S5K83A_GAIN, data, 2);
310
311	data[1] = data[1] & 0x3f;
312	if (data[1] > S5K83A_MAXIMUM_GAIN)
313	data[1] = S5K83A_MAXIMUM_GAIN;
314
315	*val = data[1];
316
317	return (err < 0) ? err : 0;
318	}
319
320	int s5k83a_set_gain(struct gspca_dev *gspca_dev, __s32 val)
321	{
322	int err = 0;
323	u8 data[2];
324	struct sd sd = (struct sd ) gspca_dev;
325
326	data[0] = 0;
327	data[1] = val;
328	err = s5k83a_write_sensor(sd, S5K83A_GAIN, data, 2);
329
330	return (err < 0) ? err : 0;
331	}