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>
16 #include <media/v4l2-subdev.h>
17 #include <media/v4l2-chip-ident.h>
18 #include <media/soc_camera.h>
20 /* mt9m001 i2c address 0x5d
21 * The platform has to define ctruct i2c_board_info objects and link to them
22 * from struct soc_camera_link */
24 /* mt9m001 selected register addresses */
25 #define MT9M001_CHIP_VERSION 0x00
26 #define MT9M001_ROW_START 0x01
27 #define MT9M001_COLUMN_START 0x02
28 #define MT9M001_WINDOW_HEIGHT 0x03
29 #define MT9M001_WINDOW_WIDTH 0x04
30 #define MT9M001_HORIZONTAL_BLANKING 0x05
31 #define MT9M001_VERTICAL_BLANKING 0x06
32 #define MT9M001_OUTPUT_CONTROL 0x07
33 #define MT9M001_SHUTTER_WIDTH 0x09
34 #define MT9M001_FRAME_RESTART 0x0b
35 #define MT9M001_SHUTTER_DELAY 0x0c
36 #define MT9M001_RESET 0x0d
37 #define MT9M001_READ_OPTIONS1 0x1e
38 #define MT9M001_READ_OPTIONS2 0x20
39 #define MT9M001_GLOBAL_GAIN 0x35
40 #define MT9M001_CHIP_ENABLE 0xF1
42 static const struct soc_camera_data_format mt9m001_colour_formats[] = {
43 /* Order important: first natively supported,
44 * second supported with a GPIO extender */
46 .name = "Bayer (sRGB) 10 bit",
48 .fourcc = V4L2_PIX_FMT_SBGGR16,
49 .colorspace = V4L2_COLORSPACE_SRGB,
51 .name = "Bayer (sRGB) 8 bit",
53 .fourcc = V4L2_PIX_FMT_SBGGR8,
54 .colorspace = V4L2_COLORSPACE_SRGB,
58 static const struct soc_camera_data_format mt9m001_monochrome_formats[] = {
59 /* Order important - see above */
61 .name = "Monochrome 10 bit",
63 .fourcc = V4L2_PIX_FMT_Y16,
65 .name = "Monochrome 8 bit",
67 .fourcc = V4L2_PIX_FMT_GREY,
72 struct v4l2_subdev subdev;
73 int model; /* V4L2_IDENT_MT9M001* codes from v4l2-chip-ident.h */
74 unsigned char autoexposure;
77 static struct mt9m001 *to_mt9m001(const struct i2c_client *client)
79 return container_of(i2c_get_clientdata(client), struct mt9m001, subdev);
82 static int reg_read(struct i2c_client *client, const u8 reg)
84 s32 data = i2c_smbus_read_word_data(client, reg);
85 return data < 0 ? data : swab16(data);
88 static int reg_write(struct i2c_client *client, const u8 reg,
91 return i2c_smbus_write_word_data(client, reg, swab16(data));
94 static int reg_set(struct i2c_client *client, const u8 reg,
99 ret = reg_read(client, reg);
102 return reg_write(client, reg, ret | data);
105 static int reg_clear(struct i2c_client *client, const u8 reg,
110 ret = reg_read(client, reg);
113 return reg_write(client, reg, ret & ~data);
116 static int mt9m001_init(struct soc_camera_device *icd)
118 struct i2c_client *client = to_i2c_client(to_soc_camera_control(icd));
121 dev_dbg(&icd->dev, "%s\n", __func__);
124 * We don't know, whether platform provides reset,
125 * issue a soft reset too
127 ret = reg_write(client, MT9M001_RESET, 1);
129 ret = reg_write(client, MT9M001_RESET, 0);
131 /* Disable chip, synchronous option update */
133 ret = reg_write(client, MT9M001_OUTPUT_CONTROL, 0);
138 static int mt9m001_release(struct soc_camera_device *icd)
140 struct i2c_client *client = to_i2c_client(to_soc_camera_control(icd));
142 /* Disable the chip */
143 reg_write(client, MT9M001_OUTPUT_CONTROL, 0);
148 static int mt9m001_s_stream(struct v4l2_subdev *sd, int enable)
150 struct i2c_client *client = sd->priv;
152 /* Switch to master "normal" mode or stop sensor readout */
153 if (reg_write(client, MT9M001_OUTPUT_CONTROL, enable ? 2 : 0) < 0)
158 static int mt9m001_set_bus_param(struct soc_camera_device *icd,
161 struct soc_camera_link *icl = to_soc_camera_link(icd);
162 unsigned long width_flag = flags & SOCAM_DATAWIDTH_MASK;
164 /* Only one width bit may be set */
165 if (!is_power_of_2(width_flag))
168 if (icl->set_bus_param)
169 return icl->set_bus_param(icl, width_flag);
172 * Without board specific bus width settings we only support the
173 * sensors native bus width
175 if (width_flag == SOCAM_DATAWIDTH_10)
181 static unsigned long mt9m001_query_bus_param(struct soc_camera_device *icd)
183 struct soc_camera_link *icl = to_soc_camera_link(icd);
184 /* MT9M001 has all capture_format parameters fixed */
185 unsigned long flags = SOCAM_PCLK_SAMPLE_FALLING |
186 SOCAM_HSYNC_ACTIVE_HIGH | SOCAM_VSYNC_ACTIVE_HIGH |
187 SOCAM_DATA_ACTIVE_HIGH | SOCAM_MASTER;
189 if (icl->query_bus_param)
190 flags |= icl->query_bus_param(icl) & SOCAM_DATAWIDTH_MASK;
192 flags |= SOCAM_DATAWIDTH_10;
194 return soc_camera_apply_sensor_flags(icl, flags);
197 static int mt9m001_s_crop(struct v4l2_subdev *sd, struct v4l2_crop *a)
199 struct v4l2_rect *rect = &a->c;
200 struct i2c_client *client = sd->priv;
201 struct mt9m001 *mt9m001 = to_mt9m001(client);
202 struct soc_camera_device *icd = client->dev.platform_data;
204 const u16 hblank = 9, vblank = 25;
206 /* Blanking and start values - default... */
207 ret = reg_write(client, MT9M001_HORIZONTAL_BLANKING, hblank);
209 ret = reg_write(client, MT9M001_VERTICAL_BLANKING, vblank);
211 /* The caller provides a supported format, as verified per
212 * call to icd->try_fmt() */
214 ret = reg_write(client, MT9M001_COLUMN_START, rect->left);
216 ret = reg_write(client, MT9M001_ROW_START, rect->top);
218 ret = reg_write(client, MT9M001_WINDOW_WIDTH, rect->width - 1);
220 ret = reg_write(client, MT9M001_WINDOW_HEIGHT,
221 rect->height + icd->y_skip_top - 1);
222 if (!ret && mt9m001->autoexposure) {
223 ret = reg_write(client, MT9M001_SHUTTER_WIDTH,
224 rect->height + icd->y_skip_top + vblank);
226 const struct v4l2_queryctrl *qctrl =
227 soc_camera_find_qctrl(icd->ops,
229 icd->exposure = (524 + (rect->height + icd->y_skip_top +
231 (qctrl->maximum - qctrl->minimum)) /
232 1048 + qctrl->minimum;
239 static int mt9m001_s_fmt(struct v4l2_subdev *sd, struct v4l2_format *f)
241 struct i2c_client *client = sd->priv;
242 struct soc_camera_device *icd = client->dev.platform_data;
243 struct v4l2_crop a = {
245 .left = icd->rect_current.left,
246 .top = icd->rect_current.top,
247 .width = f->fmt.pix.width,
248 .height = f->fmt.pix.height,
252 /* No support for scaling so far, just crop. TODO: use skipping */
253 return mt9m001_s_crop(sd, &a);
256 static int mt9m001_try_fmt(struct v4l2_subdev *sd, struct v4l2_format *f)
258 struct i2c_client *client = sd->priv;
259 struct soc_camera_device *icd = client->dev.platform_data;
260 struct v4l2_pix_format *pix = &f->fmt.pix;
262 v4l_bound_align_image(&pix->width, 48, 1280, 1,
263 &pix->height, 32 + icd->y_skip_top,
264 1024 + icd->y_skip_top, 0, 0);
269 static int mt9m001_g_chip_ident(struct v4l2_subdev *sd,
270 struct v4l2_dbg_chip_ident *id)
272 struct i2c_client *client = sd->priv;
273 struct mt9m001 *mt9m001 = to_mt9m001(client);
275 if (id->match.type != V4L2_CHIP_MATCH_I2C_ADDR)
278 if (id->match.addr != client->addr)
281 id->ident = mt9m001->model;
287 #ifdef CONFIG_VIDEO_ADV_DEBUG
288 static int mt9m001_g_register(struct v4l2_subdev *sd,
289 struct v4l2_dbg_register *reg)
291 struct i2c_client *client = sd->priv;
293 if (reg->match.type != V4L2_CHIP_MATCH_I2C_ADDR || reg->reg > 0xff)
296 if (reg->match.addr != client->addr)
300 reg->val = reg_read(client, reg->reg);
302 if (reg->val > 0xffff)
308 static int mt9m001_s_register(struct v4l2_subdev *sd,
309 struct v4l2_dbg_register *reg)
311 struct i2c_client *client = sd->priv;
313 if (reg->match.type != V4L2_CHIP_MATCH_I2C_ADDR || reg->reg > 0xff)
316 if (reg->match.addr != client->addr)
319 if (reg_write(client, reg->reg, reg->val) < 0)
326 static const struct v4l2_queryctrl mt9m001_controls[] = {
328 .id = V4L2_CID_VFLIP,
329 .type = V4L2_CTRL_TYPE_BOOLEAN,
330 .name = "Flip Vertically",
337 .type = V4L2_CTRL_TYPE_INTEGER,
343 .flags = V4L2_CTRL_FLAG_SLIDER,
345 .id = V4L2_CID_EXPOSURE,
346 .type = V4L2_CTRL_TYPE_INTEGER,
351 .default_value = 255,
352 .flags = V4L2_CTRL_FLAG_SLIDER,
354 .id = V4L2_CID_EXPOSURE_AUTO,
355 .type = V4L2_CTRL_TYPE_BOOLEAN,
356 .name = "Automatic Exposure",
364 static struct soc_camera_ops mt9m001_ops = {
365 .init = mt9m001_init,
366 .release = mt9m001_release,
367 .set_bus_param = mt9m001_set_bus_param,
368 .query_bus_param = mt9m001_query_bus_param,
369 .controls = mt9m001_controls,
370 .num_controls = ARRAY_SIZE(mt9m001_controls),
373 static int mt9m001_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
375 struct i2c_client *client = sd->priv;
376 struct mt9m001 *mt9m001 = to_mt9m001(client);
381 data = reg_read(client, MT9M001_READ_OPTIONS2);
384 ctrl->value = !!(data & 0x8000);
386 case V4L2_CID_EXPOSURE_AUTO:
387 ctrl->value = mt9m001->autoexposure;
393 static int mt9m001_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
395 struct i2c_client *client = sd->priv;
396 struct mt9m001 *mt9m001 = to_mt9m001(client);
397 struct soc_camera_device *icd = client->dev.platform_data;
398 const struct v4l2_queryctrl *qctrl;
401 qctrl = soc_camera_find_qctrl(&mt9m001_ops, ctrl->id);
409 data = reg_set(client, MT9M001_READ_OPTIONS2, 0x8000);
411 data = reg_clear(client, MT9M001_READ_OPTIONS2, 0x8000);
416 if (ctrl->value > qctrl->maximum || ctrl->value < qctrl->minimum)
418 /* See Datasheet Table 7, Gain settings. */
419 if (ctrl->value <= qctrl->default_value) {
420 /* Pack it into 0..1 step 0.125, register values 0..8 */
421 unsigned long range = qctrl->default_value - qctrl->minimum;
422 data = ((ctrl->value - qctrl->minimum) * 8 + range / 2) / range;
424 dev_dbg(&icd->dev, "Setting gain %d\n", data);
425 data = reg_write(client, MT9M001_GLOBAL_GAIN, data);
429 /* Pack it into 1.125..15 variable step, register values 9..67 */
430 /* We assume qctrl->maximum - qctrl->default_value - 1 > 0 */
431 unsigned long range = qctrl->maximum - qctrl->default_value - 1;
432 unsigned long gain = ((ctrl->value - qctrl->default_value - 1) *
433 111 + range / 2) / range + 9;
438 data = ((gain - 32) * 16 + 16) / 32 + 80;
440 data = ((gain - 64) * 7 + 28) / 56 + 96;
442 dev_dbg(&icd->dev, "Setting gain from %d to %d\n",
443 reg_read(client, MT9M001_GLOBAL_GAIN), data);
444 data = reg_write(client, MT9M001_GLOBAL_GAIN, data);
450 icd->gain = ctrl->value;
452 case V4L2_CID_EXPOSURE:
453 /* mt9m001 has maximum == default */
454 if (ctrl->value > qctrl->maximum || ctrl->value < qctrl->minimum)
457 unsigned long range = qctrl->maximum - qctrl->minimum;
458 unsigned long shutter = ((ctrl->value - qctrl->minimum) * 1048 +
459 range / 2) / range + 1;
461 dev_dbg(&icd->dev, "Setting shutter width from %d to %lu\n",
462 reg_read(client, MT9M001_SHUTTER_WIDTH), shutter);
463 if (reg_write(client, MT9M001_SHUTTER_WIDTH, shutter) < 0)
465 icd->exposure = ctrl->value;
466 mt9m001->autoexposure = 0;
469 case V4L2_CID_EXPOSURE_AUTO:
471 const u16 vblank = 25;
472 if (reg_write(client, MT9M001_SHUTTER_WIDTH,
473 icd->rect_current.height +
474 icd->y_skip_top + vblank) < 0)
476 qctrl = soc_camera_find_qctrl(icd->ops, V4L2_CID_EXPOSURE);
477 icd->exposure = (524 + (icd->rect_current.height +
478 icd->y_skip_top + vblank - 1) *
479 (qctrl->maximum - qctrl->minimum)) /
480 1048 + qctrl->minimum;
481 mt9m001->autoexposure = 1;
483 mt9m001->autoexposure = 0;
489 /* Interface active, can use i2c. If it fails, it can indeed mean, that
490 * this wasn't our capture interface, so, we wait for the right one */
491 static int mt9m001_video_probe(struct soc_camera_device *icd,
492 struct i2c_client *client)
494 struct mt9m001 *mt9m001 = to_mt9m001(client);
495 struct soc_camera_link *icl = to_soc_camera_link(icd);
499 /* We must have a parent by now. And it cannot be a wrong one.
500 * So this entire test is completely redundant. */
501 if (!icd->dev.parent ||
502 to_soc_camera_host(icd->dev.parent)->nr != icd->iface)
505 /* Enable the chip */
506 data = reg_write(client, MT9M001_CHIP_ENABLE, 1);
507 dev_dbg(&icd->dev, "write: %d\n", data);
509 /* Read out the chip version register */
510 data = reg_read(client, MT9M001_CHIP_VERSION);
512 /* must be 0x8411 or 0x8421 for colour sensor and 8431 for bw */
516 mt9m001->model = V4L2_IDENT_MT9M001C12ST;
517 icd->formats = mt9m001_colour_formats;
520 mt9m001->model = V4L2_IDENT_MT9M001C12STM;
521 icd->formats = mt9m001_monochrome_formats;
525 "No MT9M001 chip detected, register read %x\n", data);
529 icd->num_formats = 0;
532 * This is a 10bit sensor, so by default we only allow 10bit.
533 * The platform may support different bus widths due to
534 * different routing of the data lines.
536 if (icl->query_bus_param)
537 flags = icl->query_bus_param(icl);
539 flags = SOCAM_DATAWIDTH_10;
541 if (flags & SOCAM_DATAWIDTH_10)
546 if (flags & SOCAM_DATAWIDTH_8)
549 dev_info(&icd->dev, "Detected a MT9M001 chip ID %x (%s)\n", data,
550 data == 0x8431 ? "C12STM" : "C12ST");
555 static void mt9m001_video_remove(struct soc_camera_device *icd)
557 struct i2c_client *client = to_i2c_client(to_soc_camera_control(icd));
558 struct soc_camera_link *icl = to_soc_camera_link(icd);
560 dev_dbg(&icd->dev, "Video %x removed: %p, %p\n", client->addr,
561 icd->dev.parent, icd->vdev);
566 static struct v4l2_subdev_core_ops mt9m001_subdev_core_ops = {
567 .g_ctrl = mt9m001_g_ctrl,
568 .s_ctrl = mt9m001_s_ctrl,
569 .g_chip_ident = mt9m001_g_chip_ident,
570 #ifdef CONFIG_VIDEO_ADV_DEBUG
571 .g_register = mt9m001_g_register,
572 .s_register = mt9m001_s_register,
576 static struct v4l2_subdev_video_ops mt9m001_subdev_video_ops = {
577 .s_stream = mt9m001_s_stream,
578 .s_fmt = mt9m001_s_fmt,
579 .try_fmt = mt9m001_try_fmt,
580 .s_crop = mt9m001_s_crop,
583 static struct v4l2_subdev_ops mt9m001_subdev_ops = {
584 .core = &mt9m001_subdev_core_ops,
585 .video = &mt9m001_subdev_video_ops,
588 static int mt9m001_probe(struct i2c_client *client,
589 const struct i2c_device_id *did)
591 struct mt9m001 *mt9m001;
592 struct soc_camera_device *icd = client->dev.platform_data;
593 struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
594 struct soc_camera_link *icl;
598 dev_err(&client->dev, "MT9M001: missing soc-camera data!\n");
602 icl = to_soc_camera_link(icd);
604 dev_err(&client->dev, "MT9M001 driver needs platform data\n");
608 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA)) {
609 dev_warn(&adapter->dev,
610 "I2C-Adapter doesn't support I2C_FUNC_SMBUS_WORD\n");
614 mt9m001 = kzalloc(sizeof(struct mt9m001), GFP_KERNEL);
618 v4l2_i2c_subdev_init(&mt9m001->subdev, client, &mt9m001_subdev_ops);
620 /* Second stage probe - when a capture adapter is there */
621 icd->ops = &mt9m001_ops;
622 icd->rect_max.left = 20;
623 icd->rect_max.top = 12;
624 icd->rect_max.width = 1280;
625 icd->rect_max.height = 1024;
626 icd->rect_current.left = 20;
627 icd->rect_current.top = 12;
629 icd->height_min = 32;
631 /* Simulated autoexposure. If enabled, we calculate shutter width
632 * ourselves in the driver based on vertical blanking and frame width */
633 mt9m001->autoexposure = 1;
635 ret = mt9m001_video_probe(icd, client);
638 i2c_set_clientdata(client, NULL);
645 static int mt9m001_remove(struct i2c_client *client)
647 struct mt9m001 *mt9m001 = to_mt9m001(client);
648 struct soc_camera_device *icd = client->dev.platform_data;
651 mt9m001_video_remove(icd);
652 i2c_set_clientdata(client, NULL);
653 client->driver = NULL;
659 static const struct i2c_device_id mt9m001_id[] = {
663 MODULE_DEVICE_TABLE(i2c, mt9m001_id);
665 static struct i2c_driver mt9m001_i2c_driver = {
669 .probe = mt9m001_probe,
670 .remove = mt9m001_remove,
671 .id_table = mt9m001_id,
674 static int __init mt9m001_mod_init(void)
676 return i2c_add_driver(&mt9m001_i2c_driver);
679 static void __exit mt9m001_mod_exit(void)
681 i2c_del_driver(&mt9m001_i2c_driver);
684 module_init(mt9m001_mod_init);
685 module_exit(mt9m001_mod_exit);
687 MODULE_DESCRIPTION("Micron MT9M001 Camera driver");
688 MODULE_AUTHOR("Guennadi Liakhovetski <kernel@pengutronix.de>");
689 MODULE_LICENSE("GPL");