mt9m111.c

Go to the documentation of this file.

/*
 * Driver for MT9M111/MT9M112/MT9M131 CMOS Image Sensor from Micron/Aptina
 *
 * Copyright (C) 2008, Robert Jarzmik <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#include <linux/videodev2.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/log2.h>
#include <linux/gpio.h>
#include <linux/delay.h>
#include <linux/v4l2-mediabus.h>
#include <linux/module.h>

#include <media/soc_camera.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-chip-ident.h>

/*
 * MT9M111, MT9M112 and MT9M131:
 * i2c address is 0x48 or 0x5d (depending on SADDR pin)
 * The platform has to define i2c_board_info and call i2c_register_board_info()
 */

/*
 * Sensor core register addresses (0x000..0x0ff)
 */
#define MT9M111_CHIP_VERSION        0x000
#define MT9M111_ROW_START       0x001
#define MT9M111_COLUMN_START        0x002
#define MT9M111_WINDOW_HEIGHT       0x003
#define MT9M111_WINDOW_WIDTH        0x004
#define MT9M111_HORIZONTAL_BLANKING_B   0x005
#define MT9M111_VERTICAL_BLANKING_B 0x006
#define MT9M111_HORIZONTAL_BLANKING_A   0x007
#define MT9M111_VERTICAL_BLANKING_A 0x008
#define MT9M111_SHUTTER_WIDTH       0x009
#define MT9M111_ROW_SPEED       0x00a
#define MT9M111_EXTRA_DELAY     0x00b
#define MT9M111_SHUTTER_DELAY       0x00c
#define MT9M111_RESET           0x00d
#define MT9M111_READ_MODE_B     0x020
#define MT9M111_READ_MODE_A     0x021
#define MT9M111_FLASH_CONTROL       0x023
#define MT9M111_GREEN1_GAIN     0x02b
#define MT9M111_BLUE_GAIN       0x02c
#define MT9M111_RED_GAIN        0x02d
#define MT9M111_GREEN2_GAIN     0x02e
#define MT9M111_GLOBAL_GAIN     0x02f
#define MT9M111_CONTEXT_CONTROL     0x0c8
#define MT9M111_PAGE_MAP        0x0f0
#define MT9M111_BYTE_WISE_ADDR      0x0f1

#define MT9M111_RESET_SYNC_CHANGES  (1 << 15)
#define MT9M111_RESET_RESTART_BAD_FRAME (1 << 9)
#define MT9M111_RESET_SHOW_BAD_FRAMES   (1 << 8)
#define MT9M111_RESET_RESET_SOC     (1 << 5)
#define MT9M111_RESET_OUTPUT_DISABLE    (1 << 4)
#define MT9M111_RESET_CHIP_ENABLE   (1 << 3)
#define MT9M111_RESET_ANALOG_STANDBY    (1 << 2)
#define MT9M111_RESET_RESTART_FRAME (1 << 1)
#define MT9M111_RESET_RESET_MODE    (1 << 0)

#define MT9M111_RM_FULL_POWER_RD    (0 << 10)
#define MT9M111_RM_LOW_POWER_RD     (1 << 10)
#define MT9M111_RM_COL_SKIP_4X      (1 << 5)
#define MT9M111_RM_ROW_SKIP_4X      (1 << 4)
#define MT9M111_RM_COL_SKIP_2X      (1 << 3)
#define MT9M111_RM_ROW_SKIP_2X      (1 << 2)
#define MT9M111_RMB_MIRROR_COLS     (1 << 1)
#define MT9M111_RMB_MIRROR_ROWS     (1 << 0)
#define MT9M111_CTXT_CTRL_RESTART   (1 << 15)
#define MT9M111_CTXT_CTRL_DEFECTCOR_B   (1 << 12)
#define MT9M111_CTXT_CTRL_RESIZE_B  (1 << 10)
#define MT9M111_CTXT_CTRL_CTRL2_B   (1 << 9)
#define MT9M111_CTXT_CTRL_GAMMA_B   (1 << 8)
#define MT9M111_CTXT_CTRL_XENON_EN  (1 << 7)
#define MT9M111_CTXT_CTRL_READ_MODE_B   (1 << 3)
#define MT9M111_CTXT_CTRL_LED_FLASH_EN  (1 << 2)
#define MT9M111_CTXT_CTRL_VBLANK_SEL_B  (1 << 1)
#define MT9M111_CTXT_CTRL_HBLANK_SEL_B  (1 << 0)

/*
 * Colorpipe register addresses (0x100..0x1ff)
 */
#define MT9M111_OPER_MODE_CTRL      0x106
#define MT9M111_OUTPUT_FORMAT_CTRL  0x108
#define MT9M111_REDUCER_XZOOM_B     0x1a0
#define MT9M111_REDUCER_XSIZE_B     0x1a1
#define MT9M111_REDUCER_YZOOM_B     0x1a3
#define MT9M111_REDUCER_YSIZE_B     0x1a4
#define MT9M111_REDUCER_XZOOM_A     0x1a6
#define MT9M111_REDUCER_XSIZE_A     0x1a7
#define MT9M111_REDUCER_YZOOM_A     0x1a9
#define MT9M111_REDUCER_YSIZE_A     0x1aa

#define MT9M111_OUTPUT_FORMAT_CTRL2_A   0x13a
#define MT9M111_OUTPUT_FORMAT_CTRL2_B   0x19b

#define MT9M111_OPMODE_AUTOEXPO_EN  (1 << 14)
#define MT9M111_OPMODE_AUTOWHITEBAL_EN  (1 << 1)
#define MT9M111_OUTFMT_FLIP_BAYER_COL   (1 << 9)
#define MT9M111_OUTFMT_FLIP_BAYER_ROW   (1 << 8)
#define MT9M111_OUTFMT_PROCESSED_BAYER  (1 << 14)
#define MT9M111_OUTFMT_BYPASS_IFP   (1 << 10)
#define MT9M111_OUTFMT_INV_PIX_CLOCK    (1 << 9)
#define MT9M111_OUTFMT_RGB      (1 << 8)
#define MT9M111_OUTFMT_RGB565       (0 << 6)
#define MT9M111_OUTFMT_RGB555       (1 << 6)
#define MT9M111_OUTFMT_RGB444x      (2 << 6)
#define MT9M111_OUTFMT_RGBx444      (3 << 6)
#define MT9M111_OUTFMT_TST_RAMP_OFF (0 << 4)
#define MT9M111_OUTFMT_TST_RAMP_COL (1 << 4)
#define MT9M111_OUTFMT_TST_RAMP_ROW (2 << 4)
#define MT9M111_OUTFMT_TST_RAMP_FRAME   (3 << 4)
#define MT9M111_OUTFMT_SHIFT_3_UP   (1 << 3)
#define MT9M111_OUTFMT_AVG_CHROMA   (1 << 2)
#define MT9M111_OUTFMT_SWAP_YCbCr_C_Y_RGB_EVEN  (1 << 1)
#define MT9M111_OUTFMT_SWAP_YCbCr_Cb_Cr_RGB_R_B (1 << 0)

/*
 * Camera control register addresses (0x200..0x2ff not implemented)
 */

#define reg_read(reg) mt9m111_reg_read(client, MT9M111_##reg)
#define reg_write(reg, val) mt9m111_reg_write(client, MT9M111_##reg, (val))
#define reg_set(reg, val) mt9m111_reg_set(client, MT9M111_##reg, (val))
#define reg_clear(reg, val) mt9m111_reg_clear(client, MT9M111_##reg, (val))
#define reg_mask(reg, val, mask) mt9m111_reg_mask(client, MT9M111_##reg, \
        (val), (mask))

#define MT9M111_MIN_DARK_ROWS   8
#define MT9M111_MIN_DARK_COLS   26
#define MT9M111_MAX_HEIGHT  1024
#define MT9M111_MAX_WIDTH   1280

struct mt9m111_context {
    u16 read_mode;
    u16 blanking_h;
    u16 blanking_v;
    u16 reducer_xzoom;
    u16 reducer_yzoom;
    u16 reducer_xsize;
    u16 reducer_ysize;
    u16 output_fmt_ctrl2;
    u16 control;
};

static struct mt9m111_context context_a = {
    .read_mode      = MT9M111_READ_MODE_A,
    .blanking_h     = MT9M111_HORIZONTAL_BLANKING_A,
    .blanking_v     = MT9M111_VERTICAL_BLANKING_A,
    .reducer_xzoom      = MT9M111_REDUCER_XZOOM_A,
    .reducer_yzoom      = MT9M111_REDUCER_YZOOM_A,
    .reducer_xsize      = MT9M111_REDUCER_XSIZE_A,
    .reducer_ysize      = MT9M111_REDUCER_YSIZE_A,
    .output_fmt_ctrl2   = MT9M111_OUTPUT_FORMAT_CTRL2_A,
    .control        = MT9M111_CTXT_CTRL_RESTART,
};

static struct mt9m111_context context_b = {
    .read_mode      = MT9M111_READ_MODE_B,
    .blanking_h     = MT9M111_HORIZONTAL_BLANKING_B,
    .blanking_v     = MT9M111_VERTICAL_BLANKING_B,
    .reducer_xzoom      = MT9M111_REDUCER_XZOOM_B,
    .reducer_yzoom      = MT9M111_REDUCER_YZOOM_B,
    .reducer_xsize      = MT9M111_REDUCER_XSIZE_B,
    .reducer_ysize      = MT9M111_REDUCER_YSIZE_B,
    .output_fmt_ctrl2   = MT9M111_OUTPUT_FORMAT_CTRL2_B,
    .control        = MT9M111_CTXT_CTRL_RESTART |
        MT9M111_CTXT_CTRL_DEFECTCOR_B | MT9M111_CTXT_CTRL_RESIZE_B |
        MT9M111_CTXT_CTRL_CTRL2_B | MT9M111_CTXT_CTRL_GAMMA_B |
        MT9M111_CTXT_CTRL_READ_MODE_B | MT9M111_CTXT_CTRL_VBLANK_SEL_B |
        MT9M111_CTXT_CTRL_HBLANK_SEL_B,
};

/* MT9M111 has only one fixed colorspace per pixelcode */
struct mt9m111_datafmt {
    enum v4l2_mbus_pixelcode    code;
    enum v4l2_colorspace        colorspace;
};

static const struct mt9m111_datafmt mt9m111_colour_fmts[] = {
    {V4L2_MBUS_FMT_YUYV8_2X8, V4L2_COLORSPACE_JPEG},
    {V4L2_MBUS_FMT_YVYU8_2X8, V4L2_COLORSPACE_JPEG},
    {V4L2_MBUS_FMT_UYVY8_2X8, V4L2_COLORSPACE_JPEG},
    {V4L2_MBUS_FMT_VYUY8_2X8, V4L2_COLORSPACE_JPEG},
    {V4L2_MBUS_FMT_RGB555_2X8_PADHI_LE, V4L2_COLORSPACE_SRGB},
    {V4L2_MBUS_FMT_RGB555_2X8_PADHI_BE, V4L2_COLORSPACE_SRGB},
    {V4L2_MBUS_FMT_RGB565_2X8_LE, V4L2_COLORSPACE_SRGB},
    {V4L2_MBUS_FMT_RGB565_2X8_BE, V4L2_COLORSPACE_SRGB},
    {V4L2_MBUS_FMT_BGR565_2X8_LE, V4L2_COLORSPACE_SRGB},
    {V4L2_MBUS_FMT_BGR565_2X8_BE, V4L2_COLORSPACE_SRGB},
    {V4L2_MBUS_FMT_SBGGR8_1X8, V4L2_COLORSPACE_SRGB},
    {V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE, V4L2_COLORSPACE_SRGB},
};

struct mt9m111 {
    struct v4l2_subdev subdev;
    struct v4l2_ctrl_handler hdl;
    struct v4l2_ctrl *gain;
    int model;  /* V4L2_IDENT_MT9M111 or V4L2_IDENT_MT9M112 code
             * from v4l2-chip-ident.h */
    struct mt9m111_context *ctx;
    struct v4l2_rect rect;  /* cropping rectangle */
    int width;      /* output */
    int height;     /* sizes */
    struct mutex power_lock; /* lock to protect power_count */
    int power_count;
    const struct mt9m111_datafmt *fmt;
    int lastpage;   /* PageMap cache value */
};

/* Find a data format by a pixel code */
static const struct mt9m111_datafmt *mt9m111_find_datafmt(struct mt9m111 *mt9m111,
                        enum v4l2_mbus_pixelcode code)
{
    int i;
    for (i = 0; i < ARRAY_SIZE(mt9m111_colour_fmts); i++)
        if (mt9m111_colour_fmts[i].code == code)
            return mt9m111_colour_fmts + i;

    return mt9m111->fmt;
}

static struct mt9m111 *to_mt9m111(const struct i2c_client *client)
{
    return container_of(i2c_get_clientdata(client), struct mt9m111, subdev);
}

static int reg_page_map_set(struct i2c_client *client, const u16 reg)
{
    int ret;
    u16 page;
    struct mt9m111 *mt9m111 = to_mt9m111(client);

    page = (reg >> 8);
    if (page == mt9m111->lastpage)
        return 0;
    if (page > 2)
        return -EINVAL;

    ret = i2c_smbus_write_word_swapped(client, MT9M111_PAGE_MAP, page);
    if (!ret)
        mt9m111->lastpage = page;
    return ret;
}

static int mt9m111_reg_read(struct i2c_client *client, const u16 reg)
{
    int ret;

    ret = reg_page_map_set(client, reg);
    if (!ret)
        ret = i2c_smbus_read_word_swapped(client, reg & 0xff);

    dev_dbg(&client->dev, "read  reg.%03x -> %04x\n", reg, ret);
    return ret;
}

static int mt9m111_reg_write(struct i2c_client *client, const u16 reg,
                 const u16 data)
{
    int ret;

    ret = reg_page_map_set(client, reg);
    if (!ret)
        ret = i2c_smbus_write_word_swapped(client, reg & 0xff, data);
    dev_dbg(&client->dev, "write reg.%03x = %04x -> %d\n", reg, data, ret);
    return ret;
}

static int mt9m111_reg_set(struct i2c_client *client, const u16 reg,
               const u16 data)
{
    int ret;

    ret = mt9m111_reg_read(client, reg);
    if (ret >= 0)
        ret = mt9m111_reg_write(client, reg, ret | data);
    return ret;
}

static int mt9m111_reg_clear(struct i2c_client *client, const u16 reg,
                 const u16 data)
{
    int ret;

    ret = mt9m111_reg_read(client, reg);
    if (ret >= 0)
        ret = mt9m111_reg_write(client, reg, ret & ~data);
    return ret;
}

static int mt9m111_reg_mask(struct i2c_client *client, const u16 reg,
                const u16 data, const u16 mask)
{
    int ret;

    ret = mt9m111_reg_read(client, reg);
    if (ret >= 0)
        ret = mt9m111_reg_write(client, reg, (ret & ~mask) | data);
    return ret;
}

static int mt9m111_set_context(struct mt9m111 *mt9m111,
                   struct mt9m111_context *ctx)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    return reg_write(CONTEXT_CONTROL, ctx->control);
}

static int mt9m111_setup_rect_ctx(struct mt9m111 *mt9m111,
            struct mt9m111_context *ctx, struct v4l2_rect *rect,
            unsigned int width, unsigned int height)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    int ret = mt9m111_reg_write(client, ctx->reducer_xzoom, rect->width);
    if (!ret)
        ret = mt9m111_reg_write(client, ctx->reducer_yzoom, rect->height);
    if (!ret)
        ret = mt9m111_reg_write(client, ctx->reducer_xsize, width);
    if (!ret)
        ret = mt9m111_reg_write(client, ctx->reducer_ysize, height);
    return ret;
}

static int mt9m111_setup_geometry(struct mt9m111 *mt9m111, struct v4l2_rect *rect,
            int width, int height, enum v4l2_mbus_pixelcode code)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    int ret;

    ret = reg_write(COLUMN_START, rect->left);
    if (!ret)
        ret = reg_write(ROW_START, rect->top);

    if (!ret)
        ret = reg_write(WINDOW_WIDTH, rect->width);
    if (!ret)
        ret = reg_write(WINDOW_HEIGHT, rect->height);

    if (code != V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE) {
        /* IFP in use, down-scaling possible */
        if (!ret)
            ret = mt9m111_setup_rect_ctx(mt9m111, &context_b,
                             rect, width, height);
        if (!ret)
            ret = mt9m111_setup_rect_ctx(mt9m111, &context_a,
                             rect, width, height);
    }

    dev_dbg(&client->dev, "%s(%x): %ux%u@%u:%u -> %ux%u = %d\n",
        __func__, code, rect->width, rect->height, rect->left, rect->top,
        width, height, ret);

    return ret;
}

static int mt9m111_enable(struct mt9m111 *mt9m111)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    return reg_write(RESET, MT9M111_RESET_CHIP_ENABLE);
}

static int mt9m111_reset(struct mt9m111 *mt9m111)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    int ret;

    ret = reg_set(RESET, MT9M111_RESET_RESET_MODE);
    if (!ret)
        ret = reg_set(RESET, MT9M111_RESET_RESET_SOC);
    if (!ret)
        ret = reg_clear(RESET, MT9M111_RESET_RESET_MODE
                | MT9M111_RESET_RESET_SOC);

    return ret;
}

static int mt9m111_s_crop(struct v4l2_subdev *sd, const struct v4l2_crop *a)
{
    struct v4l2_rect rect = a->c;
    struct mt9m111 *mt9m111 = container_of(sd, struct mt9m111, subdev);
    int width, height;
    int ret;

    if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
        return -EINVAL;

    if (mt9m111->fmt->code == V4L2_MBUS_FMT_SBGGR8_1X8 ||
        mt9m111->fmt->code == V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE) {
        /* Bayer format - even size lengths */
        rect.width  = ALIGN(rect.width, 2);
        rect.height = ALIGN(rect.height, 2);
        /* Let the user play with the starting pixel */
    }

    /* FIXME: the datasheet doesn't specify minimum sizes */
    soc_camera_limit_side(&rect.left, &rect.width,
             MT9M111_MIN_DARK_COLS, 2, MT9M111_MAX_WIDTH);

    soc_camera_limit_side(&rect.top, &rect.height,
             MT9M111_MIN_DARK_ROWS, 2, MT9M111_MAX_HEIGHT);

    width = min(mt9m111->width, rect.width);
    height = min(mt9m111->height, rect.height);

    ret = mt9m111_setup_geometry(mt9m111, &rect, width, height, mt9m111->fmt->code);
    if (!ret) {
        mt9m111->rect = rect;
        mt9m111->width = width;
        mt9m111->height = height;
    }

    return ret;
}

static int mt9m111_g_crop(struct v4l2_subdev *sd, struct v4l2_crop *a)
{
    struct mt9m111 *mt9m111 = container_of(sd, struct mt9m111, subdev);

    a->c    = mt9m111->rect;
    a->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;

    return 0;
}

static int mt9m111_cropcap(struct v4l2_subdev *sd, struct v4l2_cropcap *a)
{
    if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
        return -EINVAL;

    a->bounds.left          = MT9M111_MIN_DARK_COLS;
    a->bounds.top           = MT9M111_MIN_DARK_ROWS;
    a->bounds.width         = MT9M111_MAX_WIDTH;
    a->bounds.height        = MT9M111_MAX_HEIGHT;
    a->defrect          = a->bounds;
    a->pixelaspect.numerator    = 1;
    a->pixelaspect.denominator  = 1;

    return 0;
}

static int mt9m111_g_fmt(struct v4l2_subdev *sd,
             struct v4l2_mbus_framefmt *mf)
{
    struct mt9m111 *mt9m111 = container_of(sd, struct mt9m111, subdev);

    mf->width   = mt9m111->width;
    mf->height  = mt9m111->height;
    mf->code    = mt9m111->fmt->code;
    mf->colorspace  = mt9m111->fmt->colorspace;
    mf->field   = V4L2_FIELD_NONE;

    return 0;
}

static int mt9m111_set_pixfmt(struct mt9m111 *mt9m111,
                  enum v4l2_mbus_pixelcode code)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    u16 data_outfmt2, mask_outfmt2 = MT9M111_OUTFMT_PROCESSED_BAYER |
        MT9M111_OUTFMT_BYPASS_IFP | MT9M111_OUTFMT_RGB |
        MT9M111_OUTFMT_RGB565 | MT9M111_OUTFMT_RGB555 |
        MT9M111_OUTFMT_RGB444x | MT9M111_OUTFMT_RGBx444 |
        MT9M111_OUTFMT_SWAP_YCbCr_C_Y_RGB_EVEN |
        MT9M111_OUTFMT_SWAP_YCbCr_Cb_Cr_RGB_R_B;
    int ret;

    switch (code) {
    case V4L2_MBUS_FMT_SBGGR8_1X8:
        data_outfmt2 = MT9M111_OUTFMT_PROCESSED_BAYER |
            MT9M111_OUTFMT_RGB;
        break;
    case V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE:
        data_outfmt2 = MT9M111_OUTFMT_BYPASS_IFP | MT9M111_OUTFMT_RGB;
        break;
    case V4L2_MBUS_FMT_RGB555_2X8_PADHI_LE:
        data_outfmt2 = MT9M111_OUTFMT_RGB | MT9M111_OUTFMT_RGB555 |
            MT9M111_OUTFMT_SWAP_YCbCr_C_Y_RGB_EVEN;
        break;
    case V4L2_MBUS_FMT_RGB555_2X8_PADHI_BE:
        data_outfmt2 = MT9M111_OUTFMT_RGB | MT9M111_OUTFMT_RGB555;
        break;
    case V4L2_MBUS_FMT_RGB565_2X8_LE:
        data_outfmt2 = MT9M111_OUTFMT_RGB | MT9M111_OUTFMT_RGB565 |
            MT9M111_OUTFMT_SWAP_YCbCr_C_Y_RGB_EVEN;
        break;
    case V4L2_MBUS_FMT_RGB565_2X8_BE:
        data_outfmt2 = MT9M111_OUTFMT_RGB | MT9M111_OUTFMT_RGB565;
        break;
    case V4L2_MBUS_FMT_BGR565_2X8_BE:
        data_outfmt2 = MT9M111_OUTFMT_RGB | MT9M111_OUTFMT_RGB565 |
            MT9M111_OUTFMT_SWAP_YCbCr_Cb_Cr_RGB_R_B;
        break;
    case V4L2_MBUS_FMT_BGR565_2X8_LE:
        data_outfmt2 = MT9M111_OUTFMT_RGB | MT9M111_OUTFMT_RGB565 |
            MT9M111_OUTFMT_SWAP_YCbCr_C_Y_RGB_EVEN |
            MT9M111_OUTFMT_SWAP_YCbCr_Cb_Cr_RGB_R_B;
        break;
    case V4L2_MBUS_FMT_UYVY8_2X8:
        data_outfmt2 = 0;
        break;
    case V4L2_MBUS_FMT_VYUY8_2X8:
        data_outfmt2 = MT9M111_OUTFMT_SWAP_YCbCr_Cb_Cr_RGB_R_B;
        break;
    case V4L2_MBUS_FMT_YUYV8_2X8:
        data_outfmt2 = MT9M111_OUTFMT_SWAP_YCbCr_C_Y_RGB_EVEN;
        break;
    case V4L2_MBUS_FMT_YVYU8_2X8:
        data_outfmt2 = MT9M111_OUTFMT_SWAP_YCbCr_C_Y_RGB_EVEN |
            MT9M111_OUTFMT_SWAP_YCbCr_Cb_Cr_RGB_R_B;
        break;
    default:
        dev_err(&client->dev, "Pixel format not handled: %x\n", code);
        return -EINVAL;
    }

    ret = mt9m111_reg_mask(client, context_a.output_fmt_ctrl2,
                   data_outfmt2, mask_outfmt2);
    if (!ret)
        ret = mt9m111_reg_mask(client, context_b.output_fmt_ctrl2,
                       data_outfmt2, mask_outfmt2);

    return ret;
}

static int mt9m111_try_fmt(struct v4l2_subdev *sd,
               struct v4l2_mbus_framefmt *mf)
{
    struct i2c_client *client = v4l2_get_subdevdata(sd);
    struct mt9m111 *mt9m111 = container_of(sd, struct mt9m111, subdev);
    const struct mt9m111_datafmt *fmt;
    struct v4l2_rect *rect = &mt9m111->rect;
    bool bayer;

    fmt = mt9m111_find_datafmt(mt9m111, mf->code);

    bayer = fmt->code == V4L2_MBUS_FMT_SBGGR8_1X8 ||
        fmt->code == V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE;

    /*
     * With Bayer format enforce even side lengths, but let the user play
     * with the starting pixel
     */
    if (bayer) {
        rect->width = ALIGN(rect->width, 2);
        rect->height = ALIGN(rect->height, 2);
    }

    if (fmt->code == V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE) {
        /* IFP bypass mode, no scaling */
        mf->width = rect->width;
        mf->height = rect->height;
    } else {
        /* No upscaling */
        if (mf->width > rect->width)
            mf->width = rect->width;
        if (mf->height > rect->height)
            mf->height = rect->height;
    }

    dev_dbg(&client->dev, "%s(): %ux%u, code=%x\n", __func__,
        mf->width, mf->height, fmt->code);

    mf->code = fmt->code;
    mf->colorspace = fmt->colorspace;

    return 0;
}

static int mt9m111_s_fmt(struct v4l2_subdev *sd,
             struct v4l2_mbus_framefmt *mf)
{
    const struct mt9m111_datafmt *fmt;
    struct mt9m111 *mt9m111 = container_of(sd, struct mt9m111, subdev);
    struct v4l2_rect *rect = &mt9m111->rect;
    int ret;

    mt9m111_try_fmt(sd, mf);
    fmt = mt9m111_find_datafmt(mt9m111, mf->code);
    /* try_fmt() guarantees fmt != NULL && fmt->code == mf->code */

    ret = mt9m111_setup_geometry(mt9m111, rect, mf->width, mf->height, mf->code);
    if (!ret)
        ret = mt9m111_set_pixfmt(mt9m111, mf->code);
    if (!ret) {
        mt9m111->width  = mf->width;
        mt9m111->height = mf->height;
        mt9m111->fmt    = fmt;
    }

    return ret;
}

static int mt9m111_g_chip_ident(struct v4l2_subdev *sd,
                struct v4l2_dbg_chip_ident *id)
{
    struct i2c_client *client = v4l2_get_subdevdata(sd);
    struct mt9m111 *mt9m111 = container_of(sd, struct mt9m111, subdev);

    if (id->match.type != V4L2_CHIP_MATCH_I2C_ADDR)
        return -EINVAL;

    if (id->match.addr != client->addr)
        return -ENODEV;

    id->ident   = mt9m111->model;
    id->revision    = 0;

    return 0;
}

#ifdef CONFIG_VIDEO_ADV_DEBUG
static int mt9m111_g_register(struct v4l2_subdev *sd,
                  struct v4l2_dbg_register *reg)
{
    struct i2c_client *client = v4l2_get_subdevdata(sd);
    int val;

    if (reg->match.type != V4L2_CHIP_MATCH_I2C_ADDR || reg->reg > 0x2ff)
        return -EINVAL;
    if (reg->match.addr != client->addr)
        return -ENODEV;

    val = mt9m111_reg_read(client, reg->reg);
    reg->size = 2;
    reg->val = (u64)val;

    if (reg->val > 0xffff)
        return -EIO;

    return 0;
}

static int mt9m111_s_register(struct v4l2_subdev *sd,
                  struct v4l2_dbg_register *reg)
{
    struct i2c_client *client = v4l2_get_subdevdata(sd);

    if (reg->match.type != V4L2_CHIP_MATCH_I2C_ADDR || reg->reg > 0x2ff)
        return -EINVAL;

    if (reg->match.addr != client->addr)
        return -ENODEV;

    if (mt9m111_reg_write(client, reg->reg, reg->val) < 0)
        return -EIO;

    return 0;
}
#endif

static int mt9m111_set_flip(struct mt9m111 *mt9m111, int flip, int mask)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    int ret;

    if (flip)
        ret = mt9m111_reg_set(client, mt9m111->ctx->read_mode, mask);
    else
        ret = mt9m111_reg_clear(client, mt9m111->ctx->read_mode, mask);

    return ret;
}

static int mt9m111_get_global_gain(struct mt9m111 *mt9m111)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    int data;

    data = reg_read(GLOBAL_GAIN);
    if (data >= 0)
        return (data & 0x2f) * (1 << ((data >> 10) & 1)) *
            (1 << ((data >> 9) & 1));
    return data;
}

static int mt9m111_set_global_gain(struct mt9m111 *mt9m111, int gain)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    u16 val;

    if (gain > 63 * 2 * 2)
        return -EINVAL;

    if ((gain >= 64 * 2) && (gain < 63 * 2 * 2))
        val = (1 << 10) | (1 << 9) | (gain / 4);
    else if ((gain >= 64) && (gain < 64 * 2))
        val = (1 << 9) | (gain / 2);
    else
        val = gain;

    return reg_write(GLOBAL_GAIN, val);
}

static int mt9m111_set_autoexposure(struct mt9m111 *mt9m111, int on)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);

    if (on)
        return reg_set(OPER_MODE_CTRL, MT9M111_OPMODE_AUTOEXPO_EN);
    return reg_clear(OPER_MODE_CTRL, MT9M111_OPMODE_AUTOEXPO_EN);
}

static int mt9m111_set_autowhitebalance(struct mt9m111 *mt9m111, int on)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);

    if (on)
        return reg_set(OPER_MODE_CTRL, MT9M111_OPMODE_AUTOWHITEBAL_EN);
    return reg_clear(OPER_MODE_CTRL, MT9M111_OPMODE_AUTOWHITEBAL_EN);
}

static int mt9m111_s_ctrl(struct v4l2_ctrl *ctrl)
{
    struct mt9m111 *mt9m111 = container_of(ctrl->handler,
                           struct mt9m111, hdl);

    switch (ctrl->id) {
    case V4L2_CID_VFLIP:
        return mt9m111_set_flip(mt9m111, ctrl->val,
                    MT9M111_RMB_MIRROR_ROWS);
    case V4L2_CID_HFLIP:
        return mt9m111_set_flip(mt9m111, ctrl->val,
                    MT9M111_RMB_MIRROR_COLS);
    case V4L2_CID_GAIN:
        return mt9m111_set_global_gain(mt9m111, ctrl->val);
    case V4L2_CID_EXPOSURE_AUTO:
        return mt9m111_set_autoexposure(mt9m111, ctrl->val);
    case V4L2_CID_AUTO_WHITE_BALANCE:
        return mt9m111_set_autowhitebalance(mt9m111, ctrl->val);
    }

    return -EINVAL;
}

static int mt9m111_suspend(struct mt9m111 *mt9m111)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    int ret;

    v4l2_ctrl_s_ctrl(mt9m111->gain, mt9m111_get_global_gain(mt9m111));

    ret = reg_set(RESET, MT9M111_RESET_RESET_MODE);
    if (!ret)
        ret = reg_set(RESET, MT9M111_RESET_RESET_SOC |
                  MT9M111_RESET_OUTPUT_DISABLE |
                  MT9M111_RESET_ANALOG_STANDBY);
    if (!ret)
        ret = reg_clear(RESET, MT9M111_RESET_CHIP_ENABLE);

    return ret;
}

static void mt9m111_restore_state(struct mt9m111 *mt9m111)
{
    mt9m111_set_context(mt9m111, mt9m111->ctx);
    mt9m111_set_pixfmt(mt9m111, mt9m111->fmt->code);
    mt9m111_setup_geometry(mt9m111, &mt9m111->rect,
            mt9m111->width, mt9m111->height, mt9m111->fmt->code);
    v4l2_ctrl_handler_setup(&mt9m111->hdl);
}

static int mt9m111_resume(struct mt9m111 *mt9m111)
{
    int ret = mt9m111_enable(mt9m111);
    if (!ret)
        ret = mt9m111_reset(mt9m111);
    if (!ret)
        mt9m111_restore_state(mt9m111);

    return ret;
}

static int mt9m111_init(struct mt9m111 *mt9m111)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    int ret;

    /* Default HIGHPOWER context */
    mt9m111->ctx = &context_b;
    ret = mt9m111_enable(mt9m111);
    if (!ret)
        ret = mt9m111_reset(mt9m111);
    if (!ret)
        ret = mt9m111_set_context(mt9m111, mt9m111->ctx);
    if (ret)
        dev_err(&client->dev, "mt9m111 init failed: %d\n", ret);
    return ret;
}

static int mt9m111_power_on(struct mt9m111 *mt9m111)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    struct soc_camera_link *icl = soc_camera_i2c_to_link(client);
    int ret;

    ret = soc_camera_power_on(&client->dev, icl);
    if (ret < 0)
        return ret;

    ret = mt9m111_resume(mt9m111);
    if (ret < 0) {
        dev_err(&client->dev, "Failed to resume the sensor: %d\n", ret);
        soc_camera_power_off(&client->dev, icl);
    }

    return ret;
}

static void mt9m111_power_off(struct mt9m111 *mt9m111)
{
    struct i2c_client *client = v4l2_get_subdevdata(&mt9m111->subdev);
    struct soc_camera_link *icl = soc_camera_i2c_to_link(client);

    mt9m111_suspend(mt9m111);
    soc_camera_power_off(&client->dev, icl);
}

static int mt9m111_s_power(struct v4l2_subdev *sd, int on)
{
    struct mt9m111 *mt9m111 = container_of(sd, struct mt9m111, subdev);
    int ret = 0;

    mutex_lock(&mt9m111->power_lock);

    /*
     * If the power count is modified from 0 to != 0 or from != 0 to 0,
     * update the power state.
     */
    if (mt9m111->power_count == !on) {
        if (on)
            ret = mt9m111_power_on(mt9m111);
        else
            mt9m111_power_off(mt9m111);
    }

    if (!ret) {
        /* Update the power count. */
        mt9m111->power_count += on ? 1 : -1;
        WARN_ON(mt9m111->power_count < 0);
    }

    mutex_unlock(&mt9m111->power_lock);
    return ret;
}

static const struct v4l2_ctrl_ops mt9m111_ctrl_ops = {
    .s_ctrl = mt9m111_s_ctrl,
};

static struct v4l2_subdev_core_ops mt9m111_subdev_core_ops = {
    .g_chip_ident   = mt9m111_g_chip_ident,
    .s_power    = mt9m111_s_power,
#ifdef CONFIG_VIDEO_ADV_DEBUG
    .g_register = mt9m111_g_register,
    .s_register = mt9m111_s_register,
#endif
};

static int mt9m111_enum_fmt(struct v4l2_subdev *sd, unsigned int index,
                enum v4l2_mbus_pixelcode *code)
{
    if (index >= ARRAY_SIZE(mt9m111_colour_fmts))
        return -EINVAL;

    *code = mt9m111_colour_fmts[index].code;
    return 0;
}

static int mt9m111_g_mbus_config(struct v4l2_subdev *sd,
                struct v4l2_mbus_config *cfg)
{
    struct i2c_client *client = v4l2_get_subdevdata(sd);
    struct soc_camera_link *icl = soc_camera_i2c_to_link(client);

    cfg->flags = V4L2_MBUS_MASTER | V4L2_MBUS_PCLK_SAMPLE_RISING |
        V4L2_MBUS_HSYNC_ACTIVE_HIGH | V4L2_MBUS_VSYNC_ACTIVE_HIGH |
        V4L2_MBUS_DATA_ACTIVE_HIGH;
    cfg->type = V4L2_MBUS_PARALLEL;
    cfg->flags = soc_camera_apply_board_flags(icl, cfg);

    return 0;
}

static struct v4l2_subdev_video_ops mt9m111_subdev_video_ops = {
    .s_mbus_fmt = mt9m111_s_fmt,
    .g_mbus_fmt = mt9m111_g_fmt,
    .try_mbus_fmt   = mt9m111_try_fmt,
    .s_crop     = mt9m111_s_crop,
    .g_crop     = mt9m111_g_crop,
    .cropcap    = mt9m111_cropcap,
    .enum_mbus_fmt  = mt9m111_enum_fmt,
    .g_mbus_config  = mt9m111_g_mbus_config,
};

static struct v4l2_subdev_ops mt9m111_subdev_ops = {
    .core   = &mt9m111_subdev_core_ops,
    .video  = &mt9m111_subdev_video_ops,
};

/*
 * Interface active, can use i2c. If it fails, it can indeed mean, that
 * this wasn't our capture interface, so, we wait for the right one
 */
static int mt9m111_video_probe(struct i2c_client *client)
{
    struct mt9m111 *mt9m111 = to_mt9m111(client);
    s32 data;
    int ret;

    ret = mt9m111_s_power(&mt9m111->subdev, 1);
    if (ret < 0)
        return ret;

    data = reg_read(CHIP_VERSION);

    switch (data) {
    case 0x143a: /* MT9M111 or MT9M131 */
        mt9m111->model = V4L2_IDENT_MT9M111;
        dev_info(&client->dev,
            "Detected a MT9M111/MT9M131 chip ID %x\n", data);
        break;
    case 0x148c: /* MT9M112 */
        mt9m111->model = V4L2_IDENT_MT9M112;
        dev_info(&client->dev, "Detected a MT9M112 chip ID %x\n", data);
        break;
    default:
        dev_err(&client->dev,
            "No MT9M111/MT9M112/MT9M131 chip detected register read %x\n",
            data);
        ret = -ENODEV;
        goto done;
    }

    ret = mt9m111_init(mt9m111);
    if (ret)
        goto done;

    ret = v4l2_ctrl_handler_setup(&mt9m111->hdl);

done:
    mt9m111_s_power(&mt9m111->subdev, 0);
    return ret;
}

static int mt9m111_probe(struct i2c_client *client,
             const struct i2c_device_id *did)
{
    struct mt9m111 *mt9m111;
    struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
    struct soc_camera_link *icl = soc_camera_i2c_to_link(client);
    int ret;

    if (!icl) {
        dev_err(&client->dev, "mt9m111: driver needs platform data\n");
        return -EINVAL;
    }

    if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA)) {
        dev_warn(&adapter->dev,
             "I2C-Adapter doesn't support I2C_FUNC_SMBUS_WORD\n");
        return -EIO;
    }

    mt9m111 = kzalloc(sizeof(struct mt9m111), GFP_KERNEL);
    if (!mt9m111)
        return -ENOMEM;

    v4l2_i2c_subdev_init(&mt9m111->subdev, client, &mt9m111_subdev_ops);
    v4l2_ctrl_handler_init(&mt9m111->hdl, 5);
    v4l2_ctrl_new_std(&mt9m111->hdl, &mt9m111_ctrl_ops,
            V4L2_CID_VFLIP, 0, 1, 1, 0);
    v4l2_ctrl_new_std(&mt9m111->hdl, &mt9m111_ctrl_ops,
            V4L2_CID_HFLIP, 0, 1, 1, 0);
    v4l2_ctrl_new_std(&mt9m111->hdl, &mt9m111_ctrl_ops,
            V4L2_CID_AUTO_WHITE_BALANCE, 0, 1, 1, 1);
    mt9m111->gain = v4l2_ctrl_new_std(&mt9m111->hdl, &mt9m111_ctrl_ops,
            V4L2_CID_GAIN, 0, 63 * 2 * 2, 1, 32);
    v4l2_ctrl_new_std_menu(&mt9m111->hdl,
            &mt9m111_ctrl_ops, V4L2_CID_EXPOSURE_AUTO, 1, 0,
            V4L2_EXPOSURE_AUTO);
    mt9m111->subdev.ctrl_handler = &mt9m111->hdl;
    if (mt9m111->hdl.error) {
        int err = mt9m111->hdl.error;

        kfree(mt9m111);
        return err;
    }

    /* Second stage probe - when a capture adapter is there */
    mt9m111->rect.left  = MT9M111_MIN_DARK_COLS;
    mt9m111->rect.top   = MT9M111_MIN_DARK_ROWS;
    mt9m111->rect.width = MT9M111_MAX_WIDTH;
    mt9m111->rect.height    = MT9M111_MAX_HEIGHT;
    mt9m111->fmt        = &mt9m111_colour_fmts[0];
    mt9m111->lastpage   = -1;
    mutex_init(&mt9m111->power_lock);

    ret = mt9m111_video_probe(client);
    if (ret) {
        v4l2_ctrl_handler_free(&mt9m111->hdl);
        kfree(mt9m111);
    }

    return ret;
}

static int mt9m111_remove(struct i2c_client *client)
{
    struct mt9m111 *mt9m111 = to_mt9m111(client);

    v4l2_device_unregister_subdev(&mt9m111->subdev);
    v4l2_ctrl_handler_free(&mt9m111->hdl);
    kfree(mt9m111);

    return 0;
}

static const struct i2c_device_id mt9m111_id[] = {
    { "mt9m111", 0 },
    { }
};
MODULE_DEVICE_TABLE(i2c, mt9m111_id);

static struct i2c_driver mt9m111_i2c_driver = {
    .driver = {
        .name = "mt9m111",
    },
    .probe      = mt9m111_probe,
    .remove     = mt9m111_remove,
    .id_table   = mt9m111_id,
};

module_i2c_driver(mt9m111_i2c_driver);

MODULE_DESCRIPTION("Micron/Aptina MT9M111/MT9M112/MT9M131 Camera driver");
MODULE_AUTHOR("Robert Jarzmik");
MODULE_LICENSE("GPL");