2 * Driver for MT9M001 CMOS Image Sensor from Micron
4 * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #include <linux/videodev2.h>
12 #include <linux/slab.h>
13 #include <linux/i2c.h>
14 #include <linux/log2.h>
15 #include <linux/gpio.h>
17 #include <media/v4l2-common.h>
18 #include <media/v4l2-chip-ident.h>
19 #include <media/soc_camera.h>
21 /* mt9m001 i2c address 0x5d
22 * The platform has to define i2c_board_info
23 * and call i2c_register_board_info() */
25 /* mt9m001 selected register addresses */
26 #define MT9M001_CHIP_VERSION 0x00
27 #define MT9M001_ROW_START 0x01
28 #define MT9M001_COLUMN_START 0x02
29 #define MT9M001_WINDOW_HEIGHT 0x03
30 #define MT9M001_WINDOW_WIDTH 0x04
31 #define MT9M001_HORIZONTAL_BLANKING 0x05
32 #define MT9M001_VERTICAL_BLANKING 0x06
33 #define MT9M001_OUTPUT_CONTROL 0x07
34 #define MT9M001_SHUTTER_WIDTH 0x09
35 #define MT9M001_FRAME_RESTART 0x0b
36 #define MT9M001_SHUTTER_DELAY 0x0c
37 #define MT9M001_RESET 0x0d
38 #define MT9M001_READ_OPTIONS1 0x1e
39 #define MT9M001_READ_OPTIONS2 0x20
40 #define MT9M001_GLOBAL_GAIN 0x35
41 #define MT9M001_CHIP_ENABLE 0xF1
43 static const struct soc_camera_data_format mt9m001_colour_formats[] = {
44 /* Order important: first natively supported,
45 * second supported with a GPIO extender */
47 .name = "Bayer (sRGB) 10 bit",
49 .fourcc = V4L2_PIX_FMT_SBGGR16,
50 .colorspace = V4L2_COLORSPACE_SRGB,
52 .name = "Bayer (sRGB) 8 bit",
54 .fourcc = V4L2_PIX_FMT_SBGGR8,
55 .colorspace = V4L2_COLORSPACE_SRGB,
59 static const struct soc_camera_data_format mt9m001_monochrome_formats[] = {
60 /* Order important - see above */
62 .name = "Monochrome 10 bit",
64 .fourcc = V4L2_PIX_FMT_Y16,
66 .name = "Monochrome 8 bit",
68 .fourcc = V4L2_PIX_FMT_GREY,
73 struct i2c_client *client;
74 struct soc_camera_device icd;
75 int model; /* V4L2_IDENT_MT9M001* codes from v4l2-chip-ident.h */
77 unsigned char autoexposure;
78 unsigned char datawidth;
81 static int reg_read(struct soc_camera_device *icd, const u8 reg)
83 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
84 struct i2c_client *client = mt9m001->client;
85 s32 data = i2c_smbus_read_word_data(client, reg);
86 return data < 0 ? data : swab16(data);
89 static int reg_write(struct soc_camera_device *icd, const u8 reg,
92 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
93 return i2c_smbus_write_word_data(mt9m001->client, reg, swab16(data));
96 static int reg_set(struct soc_camera_device *icd, const u8 reg,
101 ret = reg_read(icd, reg);
104 return reg_write(icd, reg, ret | data);
107 static int reg_clear(struct soc_camera_device *icd, const u8 reg,
112 ret = reg_read(icd, reg);
115 return reg_write(icd, reg, ret & ~data);
118 static int mt9m001_init(struct soc_camera_device *icd)
120 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
121 struct soc_camera_link *icl = mt9m001->client->dev.platform_data;
124 dev_dbg(icd->vdev->parent, "%s\n", __func__);
127 ret = icl->power(&mt9m001->client->dev, 1);
129 dev_err(icd->vdev->parent,
130 "Platform failed to power-on the camera.\n");
135 /* The camera could have been already on, we reset it additionally */
137 ret = icl->reset(&mt9m001->client->dev);
142 /* Either no platform reset, or platform reset failed */
143 ret = reg_write(icd, MT9M001_RESET, 1);
145 ret = reg_write(icd, MT9M001_RESET, 0);
147 /* Disable chip, synchronous option update */
149 ret = reg_write(icd, MT9M001_OUTPUT_CONTROL, 0);
154 static int mt9m001_release(struct soc_camera_device *icd)
156 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
157 struct soc_camera_link *icl = mt9m001->client->dev.platform_data;
159 /* Disable the chip */
160 reg_write(icd, MT9M001_OUTPUT_CONTROL, 0);
163 icl->power(&mt9m001->client->dev, 0);
168 static int mt9m001_start_capture(struct soc_camera_device *icd)
170 /* Switch to master "normal" mode */
171 if (reg_write(icd, MT9M001_OUTPUT_CONTROL, 2) < 0)
176 static int mt9m001_stop_capture(struct soc_camera_device *icd)
178 /* Stop sensor readout */
179 if (reg_write(icd, MT9M001_OUTPUT_CONTROL, 0) < 0)
184 static int bus_switch_request(struct mt9m001 *mt9m001,
185 struct soc_camera_link *icl)
187 #ifdef CONFIG_MT9M001_PCA9536_SWITCH
189 unsigned int gpio = icl->gpio;
191 if (gpio_is_valid(gpio)) {
192 /* We have a data bus switch. */
193 ret = gpio_request(gpio, "mt9m001");
195 dev_err(&mt9m001->client->dev, "Cannot get GPIO %u\n",
200 ret = gpio_direction_output(gpio, 0);
202 dev_err(&mt9m001->client->dev,
203 "Cannot set GPIO %u to output\n", gpio);
209 mt9m001->switch_gpio = gpio;
211 mt9m001->switch_gpio = -EINVAL;
216 static void bus_switch_release(struct mt9m001 *mt9m001)
218 #ifdef CONFIG_MT9M001_PCA9536_SWITCH
219 if (gpio_is_valid(mt9m001->switch_gpio))
220 gpio_free(mt9m001->switch_gpio);
224 static int bus_switch_act(struct mt9m001 *mt9m001, int go8bit)
226 #ifdef CONFIG_MT9M001_PCA9536_SWITCH
227 if (!gpio_is_valid(mt9m001->switch_gpio))
230 gpio_set_value_cansleep(mt9m001->switch_gpio, go8bit);
237 static int bus_switch_possible(struct mt9m001 *mt9m001)
239 #ifdef CONFIG_MT9M001_PCA9536_SWITCH
240 return gpio_is_valid(mt9m001->switch_gpio);
246 static int mt9m001_set_bus_param(struct soc_camera_device *icd,
249 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
250 unsigned int width_flag = flags & SOCAM_DATAWIDTH_MASK;
253 /* Flags validity verified in test_bus_param */
255 if ((mt9m001->datawidth != 10 && (width_flag == SOCAM_DATAWIDTH_10)) ||
256 (mt9m001->datawidth != 9 && (width_flag == SOCAM_DATAWIDTH_9)) ||
257 (mt9m001->datawidth != 8 && (width_flag == SOCAM_DATAWIDTH_8))) {
258 /* Well, we actually only can do 10 or 8 bits... */
259 if (width_flag == SOCAM_DATAWIDTH_9)
261 ret = bus_switch_act(mt9m001,
262 width_flag == SOCAM_DATAWIDTH_8);
266 mt9m001->datawidth = width_flag == SOCAM_DATAWIDTH_8 ? 8 : 10;
272 static unsigned long mt9m001_query_bus_param(struct soc_camera_device *icd)
274 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
275 unsigned int width_flag = SOCAM_DATAWIDTH_10;
277 if (bus_switch_possible(mt9m001))
278 width_flag |= SOCAM_DATAWIDTH_8;
280 /* MT9M001 has all capture_format parameters fixed */
281 return SOCAM_PCLK_SAMPLE_RISING |
282 SOCAM_HSYNC_ACTIVE_HIGH |
283 SOCAM_VSYNC_ACTIVE_HIGH |
288 static int mt9m001_set_fmt_cap(struct soc_camera_device *icd,
289 __u32 pixfmt, struct v4l2_rect *rect)
291 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
293 const u16 hblank = 9, vblank = 25;
295 /* Blanking and start values - default... */
296 ret = reg_write(icd, MT9M001_HORIZONTAL_BLANKING, hblank);
298 ret = reg_write(icd, MT9M001_VERTICAL_BLANKING, vblank);
300 /* The caller provides a supported format, as verified per
301 * call to icd->try_fmt_cap() */
303 ret = reg_write(icd, MT9M001_COLUMN_START, rect->left);
305 ret = reg_write(icd, MT9M001_ROW_START, rect->top);
307 ret = reg_write(icd, MT9M001_WINDOW_WIDTH, rect->width - 1);
309 ret = reg_write(icd, MT9M001_WINDOW_HEIGHT,
310 rect->height + icd->y_skip_top - 1);
311 if (!ret && mt9m001->autoexposure) {
312 ret = reg_write(icd, MT9M001_SHUTTER_WIDTH,
313 rect->height + icd->y_skip_top + vblank);
315 const struct v4l2_queryctrl *qctrl =
316 soc_camera_find_qctrl(icd->ops,
318 icd->exposure = (524 + (rect->height + icd->y_skip_top +
320 (qctrl->maximum - qctrl->minimum)) /
321 1048 + qctrl->minimum;
328 static int mt9m001_try_fmt_cap(struct soc_camera_device *icd,
329 struct v4l2_format *f)
331 if (f->fmt.pix.height < 32 + icd->y_skip_top)
332 f->fmt.pix.height = 32 + icd->y_skip_top;
333 if (f->fmt.pix.height > 1024 + icd->y_skip_top)
334 f->fmt.pix.height = 1024 + icd->y_skip_top;
335 if (f->fmt.pix.width < 48)
336 f->fmt.pix.width = 48;
337 if (f->fmt.pix.width > 1280)
338 f->fmt.pix.width = 1280;
339 f->fmt.pix.width &= ~0x01; /* has to be even, unsure why was ~3 */
344 static int mt9m001_get_chip_id(struct soc_camera_device *icd,
345 struct v4l2_chip_ident *id)
347 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
349 if (id->match_type != V4L2_CHIP_MATCH_I2C_ADDR)
352 if (id->match_chip != mt9m001->client->addr)
355 id->ident = mt9m001->model;
361 #ifdef CONFIG_VIDEO_ADV_DEBUG
362 static int mt9m001_get_register(struct soc_camera_device *icd,
363 struct v4l2_register *reg)
365 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
367 if (reg->match_type != V4L2_CHIP_MATCH_I2C_ADDR || reg->reg > 0xff)
370 if (reg->match_chip != mt9m001->client->addr)
373 reg->val = reg_read(icd, reg->reg);
375 if (reg->val > 0xffff)
381 static int mt9m001_set_register(struct soc_camera_device *icd,
382 struct v4l2_register *reg)
384 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
386 if (reg->match_type != V4L2_CHIP_MATCH_I2C_ADDR || reg->reg > 0xff)
389 if (reg->match_chip != mt9m001->client->addr)
392 if (reg_write(icd, reg->reg, reg->val) < 0)
399 static const struct v4l2_queryctrl mt9m001_controls[] = {
401 .id = V4L2_CID_VFLIP,
402 .type = V4L2_CTRL_TYPE_BOOLEAN,
403 .name = "Flip Vertically",
410 .type = V4L2_CTRL_TYPE_INTEGER,
416 .flags = V4L2_CTRL_FLAG_SLIDER,
418 .id = V4L2_CID_EXPOSURE,
419 .type = V4L2_CTRL_TYPE_INTEGER,
424 .default_value = 255,
425 .flags = V4L2_CTRL_FLAG_SLIDER,
427 .id = V4L2_CID_EXPOSURE_AUTO,
428 .type = V4L2_CTRL_TYPE_BOOLEAN,
429 .name = "Automatic Exposure",
437 static int mt9m001_video_probe(struct soc_camera_device *);
438 static void mt9m001_video_remove(struct soc_camera_device *);
439 static int mt9m001_get_control(struct soc_camera_device *, struct v4l2_control *);
440 static int mt9m001_set_control(struct soc_camera_device *, struct v4l2_control *);
442 static struct soc_camera_ops mt9m001_ops = {
443 .owner = THIS_MODULE,
444 .probe = mt9m001_video_probe,
445 .remove = mt9m001_video_remove,
446 .init = mt9m001_init,
447 .release = mt9m001_release,
448 .start_capture = mt9m001_start_capture,
449 .stop_capture = mt9m001_stop_capture,
450 .set_fmt_cap = mt9m001_set_fmt_cap,
451 .try_fmt_cap = mt9m001_try_fmt_cap,
452 .set_bus_param = mt9m001_set_bus_param,
453 .query_bus_param = mt9m001_query_bus_param,
454 .controls = mt9m001_controls,
455 .num_controls = ARRAY_SIZE(mt9m001_controls),
456 .get_control = mt9m001_get_control,
457 .set_control = mt9m001_set_control,
458 .get_chip_id = mt9m001_get_chip_id,
459 #ifdef CONFIG_VIDEO_ADV_DEBUG
460 .get_register = mt9m001_get_register,
461 .set_register = mt9m001_set_register,
465 static int mt9m001_get_control(struct soc_camera_device *icd, struct v4l2_control *ctrl)
467 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
472 data = reg_read(icd, MT9M001_READ_OPTIONS2);
475 ctrl->value = !!(data & 0x8000);
477 case V4L2_CID_EXPOSURE_AUTO:
478 ctrl->value = mt9m001->autoexposure;
484 static int mt9m001_set_control(struct soc_camera_device *icd, struct v4l2_control *ctrl)
486 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
487 const struct v4l2_queryctrl *qctrl;
490 qctrl = soc_camera_find_qctrl(&mt9m001_ops, ctrl->id);
498 data = reg_set(icd, MT9M001_READ_OPTIONS2, 0x8000);
500 data = reg_clear(icd, MT9M001_READ_OPTIONS2, 0x8000);
505 if (ctrl->value > qctrl->maximum || ctrl->value < qctrl->minimum)
507 /* See Datasheet Table 7, Gain settings. */
508 if (ctrl->value <= qctrl->default_value) {
509 /* Pack it into 0..1 step 0.125, register values 0..8 */
510 unsigned long range = qctrl->default_value - qctrl->minimum;
511 data = ((ctrl->value - qctrl->minimum) * 8 + range / 2) / range;
513 dev_dbg(&icd->dev, "Setting gain %d\n", data);
514 data = reg_write(icd, MT9M001_GLOBAL_GAIN, data);
518 /* Pack it into 1.125..15 variable step, register values 9..67 */
519 /* We assume qctrl->maximum - qctrl->default_value - 1 > 0 */
520 unsigned long range = qctrl->maximum - qctrl->default_value - 1;
521 unsigned long gain = ((ctrl->value - qctrl->default_value - 1) *
522 111 + range / 2) / range + 9;
527 data = ((gain - 32) * 16 + 16) / 32 + 80;
529 data = ((gain - 64) * 7 + 28) / 56 + 96;
531 dev_dbg(&icd->dev, "Setting gain from %d to %d\n",
532 reg_read(icd, MT9M001_GLOBAL_GAIN), data);
533 data = reg_write(icd, MT9M001_GLOBAL_GAIN, data);
539 icd->gain = ctrl->value;
541 case V4L2_CID_EXPOSURE:
542 /* mt9m001 has maximum == default */
543 if (ctrl->value > qctrl->maximum || ctrl->value < qctrl->minimum)
546 unsigned long range = qctrl->maximum - qctrl->minimum;
547 unsigned long shutter = ((ctrl->value - qctrl->minimum) * 1048 +
548 range / 2) / range + 1;
550 dev_dbg(&icd->dev, "Setting shutter width from %d to %lu\n",
551 reg_read(icd, MT9M001_SHUTTER_WIDTH), shutter);
552 if (reg_write(icd, MT9M001_SHUTTER_WIDTH, shutter) < 0)
554 icd->exposure = ctrl->value;
555 mt9m001->autoexposure = 0;
558 case V4L2_CID_EXPOSURE_AUTO:
560 const u16 vblank = 25;
561 if (reg_write(icd, MT9M001_SHUTTER_WIDTH, icd->height +
562 icd->y_skip_top + vblank) < 0)
564 qctrl = soc_camera_find_qctrl(icd->ops, V4L2_CID_EXPOSURE);
565 icd->exposure = (524 + (icd->height + icd->y_skip_top + vblank - 1) *
566 (qctrl->maximum - qctrl->minimum)) /
567 1048 + qctrl->minimum;
568 mt9m001->autoexposure = 1;
570 mt9m001->autoexposure = 0;
576 /* Interface active, can use i2c. If it fails, it can indeed mean, that
577 * this wasn't our capture interface, so, we wait for the right one */
578 static int mt9m001_video_probe(struct soc_camera_device *icd)
580 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
584 /* We must have a parent by now. And it cannot be a wrong one.
585 * So this entire test is completely redundant. */
586 if (!icd->dev.parent ||
587 to_soc_camera_host(icd->dev.parent)->nr != icd->iface)
590 /* Enable the chip */
591 data = reg_write(&mt9m001->icd, MT9M001_CHIP_ENABLE, 1);
592 dev_dbg(&icd->dev, "write: %d\n", data);
594 /* Read out the chip version register */
595 data = reg_read(icd, MT9M001_CHIP_VERSION);
597 /* must be 0x8411 or 0x8421 for colour sensor and 8431 for bw */
601 mt9m001->model = V4L2_IDENT_MT9M001C12ST;
602 icd->formats = mt9m001_colour_formats;
603 if (mt9m001->client->dev.platform_data)
604 icd->num_formats = ARRAY_SIZE(mt9m001_colour_formats);
606 icd->num_formats = 1;
609 mt9m001->model = V4L2_IDENT_MT9M001C12STM;
610 icd->formats = mt9m001_monochrome_formats;
611 if (mt9m001->client->dev.platform_data)
612 icd->num_formats = ARRAY_SIZE(mt9m001_monochrome_formats);
614 icd->num_formats = 1;
619 "No MT9M001 chip detected, register read %x\n", data);
623 dev_info(&icd->dev, "Detected a MT9M001 chip ID %x (%s)\n", data,
624 data == 0x8431 ? "C12STM" : "C12ST");
626 /* Now that we know the model, we can start video */
627 ret = soc_camera_video_start(icd);
638 static void mt9m001_video_remove(struct soc_camera_device *icd)
640 struct mt9m001 *mt9m001 = container_of(icd, struct mt9m001, icd);
642 dev_dbg(&icd->dev, "Video %x removed: %p, %p\n", mt9m001->client->addr,
643 mt9m001->icd.dev.parent, mt9m001->icd.vdev);
644 soc_camera_video_stop(&mt9m001->icd);
647 static int mt9m001_probe(struct i2c_client *client,
648 const struct i2c_device_id *did)
650 struct mt9m001 *mt9m001;
651 struct soc_camera_device *icd;
652 struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
653 struct soc_camera_link *icl = client->dev.platform_data;
657 dev_err(&client->dev, "MT9M001 driver needs platform data\n");
661 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA)) {
662 dev_warn(&adapter->dev,
663 "I2C-Adapter doesn't support I2C_FUNC_SMBUS_WORD\n");
667 mt9m001 = kzalloc(sizeof(struct mt9m001), GFP_KERNEL);
671 mt9m001->client = client;
672 i2c_set_clientdata(client, mt9m001);
674 /* Second stage probe - when a capture adapter is there */
676 icd->ops = &mt9m001_ops;
677 icd->control = &client->dev;
683 icd->width_max = 1280;
684 icd->height_min = 32;
685 icd->height_max = 1024;
687 icd->iface = icl->bus_id;
688 /* Default datawidth - this is the only width this camera (normally)
689 * supports. It is only with extra logic that it can support
690 * other widths. Therefore it seems to be a sensible default. */
691 mt9m001->datawidth = 10;
692 /* Simulated autoexposure. If enabled, we calculate shutter width
693 * ourselves in the driver based on vertical blanking and frame width */
694 mt9m001->autoexposure = 1;
696 ret = bus_switch_request(mt9m001, icl);
700 ret = soc_camera_device_register(icd);
707 bus_switch_release(mt9m001);
713 static int mt9m001_remove(struct i2c_client *client)
715 struct mt9m001 *mt9m001 = i2c_get_clientdata(client);
717 soc_camera_device_unregister(&mt9m001->icd);
718 bus_switch_release(mt9m001);
724 static const struct i2c_device_id mt9m001_id[] = {
728 MODULE_DEVICE_TABLE(i2c, mt9m001_id);
730 static struct i2c_driver mt9m001_i2c_driver = {
734 .probe = mt9m001_probe,
735 .remove = mt9m001_remove,
736 .id_table = mt9m001_id,
739 static int __init mt9m001_mod_init(void)
741 return i2c_add_driver(&mt9m001_i2c_driver);
744 static void __exit mt9m001_mod_exit(void)
746 i2c_del_driver(&mt9m001_i2c_driver);
749 module_init(mt9m001_mod_init);
750 module_exit(mt9m001_mod_exit);
752 MODULE_DESCRIPTION("Micron MT9M001 Camera driver");
753 MODULE_AUTHOR("Guennadi Liakhovetski <kernel@pengutronix.de>");
754 MODULE_LICENSE("GPL");