V4L/DVB (12135): Add a driver for mt9v011 sensor

Adds driver for mt9v011 based on its datasheet, available at:
	http://download.micron.com/pdf/datasheets/imaging/MT9V011.pdf

The driver was tested with a webcam that will be added on a next patch.

Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

5 files changed, 402 insertions, 0 deletions

diff --git a/drivers/media/video/Kconfig b/drivers/media/video/Kconfig
index 061e147f6f26..84b6fc15519d 100644
--- a/drivers/media/video/Kconfig
+++ b/drivers/media/video/Kconfig
@@ -312,6 +312,14 @@ config VIDEO_OV7670
           OV7670 VGA camera.  It currently only works with the M88ALP01
           controller.
 
+config VIDEO_MT9V011
+        tristate "Micron mt9v011 sensor support"
+        depends on I2C && VIDEO_V4L2
+        ---help---
+          This is a Video4Linux2 sensor-level driver for the Micron
+          mt0v011 1.3 Mpixel camera.  It currently only works with the
+          em28xx driver.
+
 config VIDEO_TCM825X
         tristate "TCM825x camera sensor support"
         depends on I2C && VIDEO_V4L2
diff --git a/drivers/media/video/Makefile b/drivers/media/video/Makefile
index 7fb3add1b387..9f2e3214a482 100644
--- a/drivers/media/video/Makefile
+++ b/drivers/media/video/Makefile
@@ -69,6 +69,7 @@ obj-$(CONFIG_VIDEO_UPD64083) += upd64083.o
 obj-$(CONFIG_VIDEO_OV7670)      += ov7670.o
 obj-$(CONFIG_VIDEO_TCM825X) += tcm825x.o
 obj-$(CONFIG_VIDEO_TVEEPROM) += tveeprom.o
+obj-$(CONFIG_VIDEO_MT9V011) += mt9v011.o
 
 obj-$(CONFIG_SOC_CAMERA_MT9M001)        += mt9m001.o
 obj-$(CONFIG_SOC_CAMERA_MT9M111)        += mt9m111.o
diff --git a/drivers/media/video/mt9v011.c b/drivers/media/video/mt9v011.c
new file mode 100644
index 000000000000..4389197cedd7
--- /dev/null
+++ b/drivers/media/video/mt9v011.c
@@ -0,0 +1,355 @@
+/*
+ * mt9v011 -Micron 1/4-Inch VGA Digital Image Sensor
+ *
+ * Copyright (c) 2009 Mauro Carvalho Chehab (mchehab@redhat.com)
+ * This code is placed under the terms of the GNU General Public License v2
+ */
+
+#include <linux/i2c.h>
+#include <linux/videodev2.h>
+#include <linux/delay.h>
+#include <media/v4l2-device.h>
+#include "mt9v011.h"
+#include <media/v4l2-i2c-drv.h>
+#include <media/v4l2-chip-ident.h>
+
+MODULE_DESCRIPTION("Micron mt9v011 sensor driver");
+MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@redhat.com>");
+MODULE_LICENSE("GPL");
+
+
+static int debug;
+module_param(debug, int, 0);
+MODULE_PARM_DESC(debug, "Debug level (0-2)");
+
+/* supported controls */
+static struct v4l2_queryctrl mt9v011_qctrl[] = {
+        {
+                .id = V4L2_CID_GAIN,
+                .type = V4L2_CTRL_TYPE_INTEGER,
+                .name = "Gain",
+                .minimum = 0,
+                .maximum = (1 << 10) - 1,
+                .step = 1,
+                .default_value = 0x0020,
+                .flags = 0,
+        }, {
+                .id = V4L2_CID_RED_BALANCE,
+                .type = V4L2_CTRL_TYPE_INTEGER,
+                .name = "Red Balance",
+                .minimum = -1 << 9,
+                .maximum = (1 << 9) - 1,
+                .step = 1,
+                .default_value = 0,
+                .flags = 0,
+        }, {
+                .id = V4L2_CID_BLUE_BALANCE,
+                .type = V4L2_CTRL_TYPE_INTEGER,
+                .name = "Blue Balance",
+                .minimum = -1 << 9,
+                .maximum = (1 << 9) - 1,
+                .step = 1,
+                .default_value = 0,
+                .flags = 0,
+        },
+};
+
+struct mt9v011 {
+        struct v4l2_subdev sd;
+
+        u16 global_gain, red_bal, blue_bal;
+};
+
+static inline struct mt9v011 *to_mt9v011(struct v4l2_subdev *sd)
+{
+        return container_of(sd, struct mt9v011, sd);
+}
+
+static int mt9v011_read(struct v4l2_subdev *sd, unsigned char addr)
+{
+        struct i2c_client *c = v4l2_get_subdevdata(sd);
+        __be16 buffer;
+        int rc, val;
+
+        if (1 != (rc = i2c_master_send(c, &addr, 1)))
+                v4l2_dbg(0, debug, sd,
+                         "i2c i/o error: rc == %d (should be 1)\n", rc);
+
+        msleep(10);
+
+        if (2 != (rc = i2c_master_recv(c, (char *)&buffer, 2)))
+                v4l2_dbg(0, debug, sd,
+                         "i2c i/o error: rc == %d (should be 1)\n", rc);
+
+        val = be16_to_cpu(buffer);
+
+        v4l2_dbg(2, debug, sd, "mt9v011: read 0x%02x = 0x%04x\n", addr, val);
+
+        return val;
+}
+
+static void mt9v011_write(struct v4l2_subdev *sd, unsigned char addr,
+                                 u16 value)
+{
+        struct i2c_client *c = v4l2_get_subdevdata(sd);
+        unsigned char buffer[3];
+        int rc;
+
+        buffer[0] = addr;
+        buffer[1] = value >> 8;
+        buffer[2] = value & 0xff;
+
+        v4l2_dbg(2, debug, sd,
+                 "mt9v011: writing 0x%02x 0x%04x\n", buffer[0], value);
+        if (3 != (rc = i2c_master_send(c, buffer, 3)))
+                v4l2_dbg(0, debug, sd,
+                         "i2c i/o error: rc == %d (should be 3)\n", rc);
+}
+
+
+struct i2c_reg_value {
+        unsigned char reg;
+        u16           value;
+};
+
+/*
+ * Values used at the original driver
+ * Some values are marked as Reserved at the datasheet
+ */
+static const struct i2c_reg_value mt9v011_init_default[] = {
+                                        /* guessed meaning - as mt9m111 */
+                { R0D_MT9V011_RESET, 0x0001 },
+                { R0D_MT9V011_RESET, 0x0000 },
+                { R01_MT9V011_ROWSTART, 0x0008 },
+                { R02_MT9V011_COLSTART, 0x0014 },
+                { R03_MT9V011_HEIGHT, 0x01e0 },
+                { R04_MT9V011_WIDTH, 0x0280 },
+                { R05_MT9V011_HBLANK, 0x0001 },
+                { R05_MT9V011_HBLANK, 0x0001 },
+                { R0A_MT9V011_CLK_SPEED, 0x0000 },
+                { R05_MT9V011_HBLANK, 0x000a },
+                { 0x30, 0x0005 },
+                { 0x34, 0x0100 },
+                { 0x3d, 0x068f },
+                { 0x40, 0x01e0 },
+                { 0x52, 0x0100 },
+                { 0x58, 0x0038 },       /* Datasheet default 0x0078 */
+                { 0x59, 0x0723 },       /* Datasheet default 0x0703 */
+                { 0x62, 0x041a },       /* Datasheet default 0x0418 */
+                { R09_MT9V011_SHUTTER_WIDTH, 0x0418 },
+                { R20_MT9V011_READ_MODE, 0x1100 },
+};
+
+static void set_balance(struct v4l2_subdev *sd)
+{
+        struct mt9v011 *core = to_mt9v011(sd);
+        u16 green1_gain, green2_gain, blue_gain, red_gain;
+
+        green1_gain = core->global_gain;
+        green2_gain = core->global_gain;
+
+        blue_gain = core->global_gain +
+                    core->global_gain * core->blue_bal / (1 << 9);
+
+        red_gain = core->global_gain +
+                   core->global_gain * core->blue_bal / (1 << 9);
+
+        mt9v011_write(sd, R2B_MT9V011_GREEN_1_GAIN, green1_gain);
+        mt9v011_write(sd, R2E_MT9V011_GREEN_2_GAIN,  green1_gain);
+        mt9v011_write(sd, R2C_MT9V011_BLUE_GAIN, blue_gain);
+        mt9v011_write(sd, R2D_MT9V011_RED_GAIN, red_gain);
+}
+
+static int mt9v011_reset(struct v4l2_subdev *sd, u32 val)
+{
+        u16 version;
+        int i;
+
+        version = mt9v011_read(sd, R00_MT9V011_CHIP_VERSION);
+
+        if (version != MT9V011_VERSION) {
+                v4l2_info(sd, "*** unknown micron chip detected (0x%04x.\n",
+                          version);
+                return -EINVAL;
+
+        }
+
+        for (i = 0; i < ARRAY_SIZE(mt9v011_init_default); i++)
+                mt9v011_write(sd, mt9v011_init_default[i].reg,
+                               mt9v011_init_default[i].value);
+
+        set_balance(sd);
+
+        return 0;
+};
+
+static int mt9v011_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
+{
+        struct mt9v011 *core = to_mt9v011(sd);
+
+        v4l2_dbg(1, debug, sd, "g_ctrl called\n");
+
+        switch (ctrl->id) {
+        case V4L2_CID_GAIN:
+                ctrl->value = core->global_gain;
+                return 0;
+        case V4L2_CID_RED_BALANCE:
+                ctrl->value = core->red_bal;
+                return 0;
+        case V4L2_CID_BLUE_BALANCE:
+                ctrl->value = core->blue_bal;
+                return 0;
+        }
+        return -EINVAL;
+}
+
+static int mt9v011_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
+{
+        struct mt9v011 *core = to_mt9v011(sd);
+        u8 i, n;
+        n = ARRAY_SIZE(mt9v011_qctrl);
+
+        for (i = 0; i < n; i++) {
+                if (ctrl->id != mt9v011_qctrl[i].id)
+                        continue;
+                if (ctrl->value < mt9v011_qctrl[i].minimum ||
+                    ctrl->value > mt9v011_qctrl[i].maximum)
+                        return -ERANGE;
+                v4l2_dbg(1, debug, sd, "s_ctrl: id=%d, value=%d\n",
+                                        ctrl->id, ctrl->value);
+                break;
+        }
+
+        switch (ctrl->id) {
+        case V4L2_CID_GAIN:
+                core->global_gain = ctrl->value;
+                break;
+        case V4L2_CID_RED_BALANCE:
+                core->red_bal = ctrl->value;
+                break;
+        case V4L2_CID_BLUE_BALANCE:
+                core->blue_bal = ctrl->value;
+                break;
+        default:
+                return -EINVAL;
+        }
+
+        set_balance(sd);
+
+        return 0;
+}
+
+#ifdef CONFIG_VIDEO_ADV_DEBUG
+static int mt9v011_g_register(struct v4l2_subdev *sd,
+                              struct v4l2_dbg_register *reg)
+{
+        struct i2c_client *client = v4l2_get_subdevdata(sd);
+
+        if (!v4l2_chip_match_i2c_client(client, &reg->match))
+                return -EINVAL;
+        if (!capable(CAP_SYS_ADMIN))
+                return -EPERM;
+
+        reg->val = mt9v011_read(sd, reg->reg & 0xff);
+        reg->size = 2;
+
+        return 0;
+}
+
+static int mt9v011_s_register(struct v4l2_subdev *sd,
+                              struct v4l2_dbg_register *reg)
+{
+        struct i2c_client *client = v4l2_get_subdevdata(sd);
+
+        if (!v4l2_chip_match_i2c_client(client, &reg->match))
+                return -EINVAL;
+        if (!capable(CAP_SYS_ADMIN))
+                return -EPERM;
+
+        mt9v011_write(sd, reg->reg & 0xff, reg->val & 0xffff);
+
+        return 0;
+}
+#endif
+
+static int mt9v011_g_chip_ident(struct v4l2_subdev *sd,
+                                struct v4l2_dbg_chip_ident *chip)
+{
+        struct i2c_client *client = v4l2_get_subdevdata(sd);
+
+        return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_MT9V011,
+                                          MT9V011_VERSION);
+}
+
+static const struct v4l2_subdev_core_ops mt9v011_core_ops = {
+        .g_ctrl = mt9v011_g_ctrl,
+        .s_ctrl = mt9v011_s_ctrl,
+        .reset = mt9v011_reset,
+        .g_chip_ident = mt9v011_g_chip_ident,
+#ifdef CONFIG_VIDEO_ADV_DEBUG
+        .g_register = mt9v011_g_register,
+        .s_register = mt9v011_s_register,
+#endif
+};
+
+static const struct v4l2_subdev_ops mt9v011_ops = {
+        .core = &mt9v011_core_ops,
+};
+
+
+/****************************************************************************
+                        I2C Client & Driver
+ ****************************************************************************/
+
+static int mt9v011_probe(struct i2c_client *c,
+                         const struct i2c_device_id *id)
+{
+        struct mt9v011 *core;
+        struct v4l2_subdev *sd;
+
+        /* Check if the adapter supports the needed features */
+        if (!i2c_check_functionality(c->adapter,
+             I2C_FUNC_SMBUS_READ_BYTE | I2C_FUNC_SMBUS_WRITE_BYTE_DATA))
+                return -EIO;
+
+        core = kzalloc(sizeof(struct mt9v011), GFP_KERNEL);
+        if (!core)
+                return -ENOMEM;
+
+        core->global_gain = 0x0024;
+
+        sd = &core->sd;
+        v4l2_i2c_subdev_init(sd, c, &mt9v011_ops);
+        v4l_info(c, "chip found @ 0x%02x (%s)\n",
+                 c->addr << 1, c->adapter->name);
+
+        return 0;
+}
+
+static int mt9v011_remove(struct i2c_client *c)
+{
+        struct v4l2_subdev *sd = i2c_get_clientdata(c);
+
+        v4l2_dbg(1, debug, sd,
+                "mt9v011.c: removing mt9v011 adapter on address 0x%x\n",
+                c->addr << 1);
+
+        v4l2_device_unregister_subdev(sd);
+        kfree(to_mt9v011(sd));
+        return 0;
+}
+
+/* ----------------------------------------------------------------------- */
+
+static const struct i2c_device_id mt9v011_id[] = {
+        { "mt9v011", 0 },
+        { }
+};
+MODULE_DEVICE_TABLE(i2c, mt9v011_id);
+
+static struct v4l2_i2c_driver_data v4l2_i2c_data = {
+        .name = "mt9v011",
+        .probe = mt9v011_probe,
+        .remove = mt9v011_remove,
+        .id_table = mt9v011_id,
+};
diff --git a/drivers/media/video/mt9v011.h b/drivers/media/video/mt9v011.h
new file mode 100644
index 000000000000..9e443ee30558
--- /dev/null
+++ b/drivers/media/video/mt9v011.h
@@ -0,0 +1,35 @@
+/*
+ * mt9v011 -Micron 1/4-Inch VGA Digital Image Sensor
+ *
+ * Copyright (c) 2009 Mauro Carvalho Chehab (mchehab@redhat.com)
+ * This code is placed under the terms of the GNU General Public License v2
+ */
+
+#ifndef MT9V011_H_
+#define MT9V011_H_
+
+#define R00_MT9V011_CHIP_VERSION        0x00
+#define R01_MT9V011_ROWSTART            0x01
+#define R02_MT9V011_COLSTART            0x02
+#define R03_MT9V011_HEIGHT              0x03
+#define R04_MT9V011_WIDTH               0x04
+#define R05_MT9V011_HBLANK              0x05
+#define R06_MT9V011_VBLANK              0x06
+#define R07_MT9V011_OUT_CTRL            0x07
+#define R09_MT9V011_SHUTTER_WIDTH       0x09
+#define R0A_MT9V011_CLK_SPEED           0x0a
+#define R0B_MT9V011_RESTART             0x0b
+#define R0C_MT9V011_SHUTTER_DELAY       0x0c
+#define R0D_MT9V011_RESET               0x0d
+#define R1E_MT9V011_DIGITAL_ZOOM        0x1e
+#define R20_MT9V011_READ_MODE           0x20
+#define R2B_MT9V011_GREEN_1_GAIN        0x2b
+#define R2C_MT9V011_BLUE_GAIN           0x2c
+#define R2D_MT9V011_RED_GAIN            0x2d
+#define R2E_MT9V011_GREEN_2_GAIN        0x2e
+#define R35_MT9V011_GLOBAL_GAIN         0x35
+#define RF1_MT9V011_CHIP_ENABLE         0xf1
+
+#define MT9V011_VERSION                 0x8243
+
+#endif
diff --git a/include/media/v4l2-chip-ident.h b/include/media/v4l2-chip-ident.h
index 4d7e2272c42f..11a4a2d3e364 100644
--- a/include/media/v4l2-chip-ident.h
+++ b/include/media/v4l2-chip-ident.h
@@ -155,6 +155,9 @@ enum {
         /* module cafe_ccic, just ident 8801 */
         V4L2_IDENT_CAFE = 8801,
 
+        /* module mt9v011, just ident 8243 */
+        V4L2_IDENT_MT9V011 = 8243,
+
         /* module tw9910: just ident 9910 */
         V4L2_IDENT_TW9910 = 9910,