1 /*
2    em28xx-camera.c - driver for Empia EM25xx/27xx/28xx USB video capture devices
3 
4    Copyright (C) 2009 Mauro Carvalho Chehab <mchehab@infradead.org>
5    Copyright (C) 2013 Frank Schäfer <fschaefer.oss@googlemail.com>
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21 
22 #include <linux/i2c.h>
23 #include <media/soc_camera.h>
24 #include <media/mt9v011.h>
25 #include <media/v4l2-clk.h>
26 #include <media/v4l2-common.h>
27 
28 #include "em28xx.h"
29 
30 
31 /* Possible i2c addresses of Micron sensors */
32 static unsigned short micron_sensor_addrs[] = {
33 	0xb8 >> 1,   /* MT9V111, MT9V403 */
34 	0xba >> 1,   /* MT9M001/011/111/112, MT9V011/012/112, MT9D011 */
35 	0x90 >> 1,   /* MT9V012/112, MT9D011 (alternative address) */
36 	I2C_CLIENT_END
37 };
38 
39 /* Possible i2c addresses of Omnivision sensors */
40 static unsigned short omnivision_sensor_addrs[] = {
41 	0x42 >> 1,   /* OV7725, OV7670/60/48 */
42 	0x60 >> 1,   /* OV2640, OV9650/53/55 */
43 	I2C_CLIENT_END
44 };
45 
46 
47 static struct soc_camera_link camlink = {
48 	.bus_id = 0,
49 	.flags = 0,
50 	.module_name = "em28xx",
51 	.unbalanced_power = true,
52 };
53 
54 
55 /* FIXME: Should be replaced by a proper mt9m111 driver */
56 static int em28xx_initialize_mt9m111(struct em28xx *dev)
57 {
58 	int i;
59 	unsigned char regs[][3] = {
60 		{ 0x0d, 0x00, 0x01, },  /* reset and use defaults */
61 		{ 0x0d, 0x00, 0x00, },
62 		{ 0x0a, 0x00, 0x21, },
63 		{ 0x21, 0x04, 0x00, },  /* full readout speed, no row/col skipping */
64 	};
65 
66 	for (i = 0; i < ARRAY_SIZE(regs); i++)
67 		i2c_master_send(&dev->i2c_client[dev->def_i2c_bus],
68 				&regs[i][0], 3);
69 
70 	return 0;
71 }
72 
73 
74 /* FIXME: Should be replaced by a proper mt9m001 driver */
75 static int em28xx_initialize_mt9m001(struct em28xx *dev)
76 {
77 	int i;
78 	unsigned char regs[][3] = {
79 		{ 0x0d, 0x00, 0x01, },
80 		{ 0x0d, 0x00, 0x00, },
81 		{ 0x04, 0x05, 0x00, },	/* hres = 1280 */
82 		{ 0x03, 0x04, 0x00, },  /* vres = 1024 */
83 		{ 0x20, 0x11, 0x00, },
84 		{ 0x06, 0x00, 0x10, },
85 		{ 0x2b, 0x00, 0x24, },
86 		{ 0x2e, 0x00, 0x24, },
87 		{ 0x35, 0x00, 0x24, },
88 		{ 0x2d, 0x00, 0x20, },
89 		{ 0x2c, 0x00, 0x20, },
90 		{ 0x09, 0x0a, 0xd4, },
91 		{ 0x35, 0x00, 0x57, },
92 	};
93 
94 	for (i = 0; i < ARRAY_SIZE(regs); i++)
95 		i2c_master_send(&dev->i2c_client[dev->def_i2c_bus],
96 				&regs[i][0], 3);
97 
98 	return 0;
99 }
100 
101 
102 /*
103  * Probes Micron sensors with 8 bit address and 16 bit register width
104  */
105 static int em28xx_probe_sensor_micron(struct em28xx *dev)
106 {
107 	int ret, i;
108 	char *name;
109 	u8 reg;
110 	__be16 id_be;
111 	u16 id;
112 
113 	struct i2c_client client = dev->i2c_client[dev->def_i2c_bus];
114 
115 	dev->em28xx_sensor = EM28XX_NOSENSOR;
116 	for (i = 0; micron_sensor_addrs[i] != I2C_CLIENT_END; i++) {
117 		client.addr = micron_sensor_addrs[i];
118 		/* NOTE: i2c_smbus_read_word_data() doesn't work with BE data */
119 		/* Read chip ID from register 0x00 */
120 		reg = 0x00;
121 		ret = i2c_master_send(&client, &reg, 1);
122 		if (ret < 0) {
123 			if (ret != -ENXIO)
124 				em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
125 					      client.addr << 1, ret);
126 			continue;
127 		}
128 		ret = i2c_master_recv(&client, (u8 *)&id_be, 2);
129 		if (ret < 0) {
130 			em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
131 				      client.addr << 1, ret);
132 			continue;
133 		}
134 		id = be16_to_cpu(id_be);
135 		/* Read chip ID from register 0xff */
136 		reg = 0xff;
137 		ret = i2c_master_send(&client, &reg, 1);
138 		if (ret < 0) {
139 			em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
140 				      client.addr << 1, ret);
141 			continue;
142 		}
143 		ret = i2c_master_recv(&client, (u8 *)&id_be, 2);
144 		if (ret < 0) {
145 			em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
146 				      client.addr << 1, ret);
147 			continue;
148 		}
149 		/* Validate chip ID to be sure we have a Micron device */
150 		if (id != be16_to_cpu(id_be))
151 			continue;
152 		/* Check chip ID */
153 		id = be16_to_cpu(id_be);
154 		switch (id) {
155 		case 0x1222:
156 			name = "MT9V012"; /* MI370 */ /* 640x480 */
157 			break;
158 		case 0x1229:
159 			name = "MT9V112"; /* 640x480 */
160 			break;
161 		case 0x1433:
162 			name = "MT9M011"; /* 1280x1024 */
163 			break;
164 		case 0x143a:    /* found in the ECS G200 */
165 			name = "MT9M111"; /* MI1310 */ /* 1280x1024 */
166 			dev->em28xx_sensor = EM28XX_MT9M111;
167 			break;
168 		case 0x148c:
169 			name = "MT9M112"; /* MI1320 */ /* 1280x1024 */
170 			break;
171 		case 0x1511:
172 			name = "MT9D011"; /* MI2010 */ /* 1600x1200 */
173 			break;
174 		case 0x8232:
175 		case 0x8243:	/* rev B */
176 			name = "MT9V011"; /* MI360 */ /* 640x480 */
177 			dev->em28xx_sensor = EM28XX_MT9V011;
178 			break;
179 		case 0x8431:
180 			name = "MT9M001"; /* 1280x1024 */
181 			dev->em28xx_sensor = EM28XX_MT9M001;
182 			break;
183 		default:
184 			em28xx_info("unknown Micron sensor detected: 0x%04x\n",
185 				    id);
186 			return 0;
187 		}
188 
189 		if (dev->em28xx_sensor == EM28XX_NOSENSOR)
190 			em28xx_info("unsupported sensor detected: %s\n", name);
191 		else
192 			em28xx_info("sensor %s detected\n", name);
193 
194 		dev->i2c_client[dev->def_i2c_bus].addr = client.addr;
195 		return 0;
196 	}
197 
198 	return -ENODEV;
199 }
200 
201 /*
202  * Probes Omnivision sensors with 8 bit address and register width
203  */
204 static int em28xx_probe_sensor_omnivision(struct em28xx *dev)
205 {
206 	int ret, i;
207 	char *name;
208 	u8 reg;
209 	u16 id;
210 	struct i2c_client client = dev->i2c_client[dev->def_i2c_bus];
211 
212 	dev->em28xx_sensor = EM28XX_NOSENSOR;
213 	/* NOTE: these devices have the register auto incrementation disabled
214 	 * by default, so we have to use single byte reads !              */
215 	for (i = 0; omnivision_sensor_addrs[i] != I2C_CLIENT_END; i++) {
216 		client.addr = omnivision_sensor_addrs[i];
217 		/* Read manufacturer ID from registers 0x1c-0x1d (BE) */
218 		reg = 0x1c;
219 		ret = i2c_smbus_read_byte_data(&client, reg);
220 		if (ret < 0) {
221 			if (ret != -ENXIO)
222 				em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
223 					      client.addr << 1, ret);
224 			continue;
225 		}
226 		id = ret << 8;
227 		reg = 0x1d;
228 		ret = i2c_smbus_read_byte_data(&client, reg);
229 		if (ret < 0) {
230 			em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
231 				      client.addr << 1, ret);
232 			continue;
233 		}
234 		id += ret;
235 		/* Check manufacturer ID */
236 		if (id != 0x7fa2)
237 			continue;
238 		/* Read product ID from registers 0x0a-0x0b (BE) */
239 		reg = 0x0a;
240 		ret = i2c_smbus_read_byte_data(&client, reg);
241 		if (ret < 0) {
242 			em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
243 				      client.addr << 1, ret);
244 			continue;
245 		}
246 		id = ret << 8;
247 		reg = 0x0b;
248 		ret = i2c_smbus_read_byte_data(&client, reg);
249 		if (ret < 0) {
250 			em28xx_errdev("couldn't read from i2c device 0x%02x: error %i\n",
251 				      client.addr << 1, ret);
252 			continue;
253 		}
254 		id += ret;
255 		/* Check product ID */
256 		switch (id) {
257 		case 0x2642:
258 			name = "OV2640";
259 			dev->em28xx_sensor = EM28XX_OV2640;
260 			break;
261 		case 0x7648:
262 			name = "OV7648";
263 			break;
264 		case 0x7660:
265 			name = "OV7660";
266 			break;
267 		case 0x7673:
268 			name = "OV7670";
269 			break;
270 		case 0x7720:
271 			name = "OV7720";
272 			break;
273 		case 0x7721:
274 			name = "OV7725";
275 			break;
276 		case 0x9648: /* Rev 2 */
277 		case 0x9649: /* Rev 3 */
278 			name = "OV9640";
279 			break;
280 		case 0x9650:
281 		case 0x9652: /* OV9653 */
282 			name = "OV9650";
283 			break;
284 		case 0x9656: /* Rev 4 */
285 		case 0x9657: /* Rev 5 */
286 			name = "OV9655";
287 			break;
288 		default:
289 			em28xx_info("unknown OmniVision sensor detected: 0x%04x\n",
290 				    id);
291 			return 0;
292 		}
293 
294 		if (dev->em28xx_sensor == EM28XX_NOSENSOR)
295 			em28xx_info("unsupported sensor detected: %s\n", name);
296 		else
297 			em28xx_info("sensor %s detected\n", name);
298 
299 		dev->i2c_client[dev->def_i2c_bus].addr = client.addr;
300 		return 0;
301 	}
302 
303 	return -ENODEV;
304 }
305 
306 int em28xx_detect_sensor(struct em28xx *dev)
307 {
308 	int ret;
309 
310 	ret = em28xx_probe_sensor_micron(dev);
311 
312 	if (dev->em28xx_sensor == EM28XX_NOSENSOR && ret < 0)
313 		ret = em28xx_probe_sensor_omnivision(dev);
314 
315 	/*
316 	 * NOTE: the Windows driver also probes i2c addresses
317 	 *       0x22 (Samsung ?) and 0x66 (Kodak ?)
318 	 */
319 
320 	if (dev->em28xx_sensor == EM28XX_NOSENSOR && ret < 0) {
321 		em28xx_info("No sensor detected\n");
322 		return -ENODEV;
323 	}
324 
325 	return 0;
326 }
327 
328 int em28xx_init_camera(struct em28xx *dev)
329 {
330 	char clk_name[V4L2_SUBDEV_NAME_SIZE];
331 	struct i2c_client *client = &dev->i2c_client[dev->def_i2c_bus];
332 	struct i2c_adapter *adap = &dev->i2c_adap[dev->def_i2c_bus];
333 	int ret = 0;
334 
335 	v4l2_clk_name_i2c(clk_name, sizeof(clk_name),
336 			  i2c_adapter_id(adap), client->addr);
337 	dev->clk = v4l2_clk_register_fixed(clk_name, "mclk", -EINVAL);
338 	if (IS_ERR(dev->clk))
339 		return PTR_ERR(dev->clk);
340 
341 	switch (dev->em28xx_sensor) {
342 	case EM28XX_MT9V011:
343 	{
344 		struct mt9v011_platform_data pdata;
345 		struct i2c_board_info mt9v011_info = {
346 			.type = "mt9v011",
347 			.addr = client->addr,
348 			.platform_data = &pdata,
349 		};
350 
351 		dev->sensor_xres = 640;
352 		dev->sensor_yres = 480;
353 
354 		/*
355 		 * FIXME: mt9v011 uses I2S speed as xtal clk - at least with
356 		 * the Silvercrest cam I have here for testing - for higher
357 		 * resolutions, a high clock cause horizontal artifacts, so we
358 		 * need to use a lower xclk frequency.
359 		 * Yet, it would be possible to adjust xclk depending on the
360 		 * desired resolution, since this affects directly the
361 		 * frame rate.
362 		 */
363 		dev->board.xclk = EM28XX_XCLK_FREQUENCY_4_3MHZ;
364 		em28xx_write_reg(dev, EM28XX_R0F_XCLK, dev->board.xclk);
365 		dev->sensor_xtal = 4300000;
366 		pdata.xtal = dev->sensor_xtal;
367 		if (NULL ==
368 		    v4l2_i2c_new_subdev_board(&dev->v4l2_dev, adap,
369 					      &mt9v011_info, NULL)) {
370 			ret = -ENODEV;
371 			break;
372 		}
373 		/* probably means GRGB 16 bit bayer */
374 		dev->vinmode = 0x0d;
375 		dev->vinctl = 0x00;
376 
377 		break;
378 	}
379 	case EM28XX_MT9M001:
380 		dev->sensor_xres = 1280;
381 		dev->sensor_yres = 1024;
382 
383 		em28xx_initialize_mt9m001(dev);
384 
385 		/* probably means BGGR 16 bit bayer */
386 		dev->vinmode = 0x0c;
387 		dev->vinctl = 0x00;
388 
389 		break;
390 	case EM28XX_MT9M111:
391 		dev->sensor_xres = 640;
392 		dev->sensor_yres = 512;
393 
394 		dev->board.xclk = EM28XX_XCLK_FREQUENCY_48MHZ;
395 		em28xx_write_reg(dev, EM28XX_R0F_XCLK, dev->board.xclk);
396 		em28xx_initialize_mt9m111(dev);
397 
398 		dev->vinmode = 0x0a;
399 		dev->vinctl = 0x00;
400 
401 		break;
402 	case EM28XX_OV2640:
403 	{
404 		struct v4l2_subdev *subdev;
405 		struct i2c_board_info ov2640_info = {
406 			.type = "ov2640",
407 			.flags = I2C_CLIENT_SCCB,
408 			.addr = client->addr,
409 			.platform_data = &camlink,
410 		};
411 		struct v4l2_mbus_framefmt fmt;
412 
413 		/*
414 		 * FIXME: sensor supports resolutions up to 1600x1200, but
415 		 * resolution setting/switching needs to be modified to
416 		 * - switch sensor output resolution (including further
417 		 *   configuration changes)
418 		 * - adjust bridge xclk
419 		 * - disable 16 bit (12 bit) output formats on high resolutions
420 		 */
421 		dev->sensor_xres = 640;
422 		dev->sensor_yres = 480;
423 
424 		subdev =
425 		     v4l2_i2c_new_subdev_board(&dev->v4l2_dev, adap,
426 					       &ov2640_info, NULL);
427 		if (NULL == subdev) {
428 			ret = -ENODEV;
429 			break;
430 		}
431 
432 		fmt.code = V4L2_MBUS_FMT_YUYV8_2X8;
433 		fmt.width = 640;
434 		fmt.height = 480;
435 		v4l2_subdev_call(subdev, video, s_mbus_fmt, &fmt);
436 
437 		/* NOTE: for UXGA=1600x1200 switch to 12MHz */
438 		dev->board.xclk = EM28XX_XCLK_FREQUENCY_24MHZ;
439 		em28xx_write_reg(dev, EM28XX_R0F_XCLK, dev->board.xclk);
440 		dev->vinmode = 0x08;
441 		dev->vinctl = 0x00;
442 
443 		break;
444 	}
445 	case EM28XX_NOSENSOR:
446 	default:
447 		ret = -EINVAL;
448 	}
449 
450 	if (ret < 0) {
451 		v4l2_clk_unregister_fixed(dev->clk);
452 		dev->clk = NULL;
453 	}
454 
455 	return ret;
456 }
457 EXPORT_SYMBOL_GPL(em28xx_init_camera);
458