kernel/drivers/media/i2c/soc_camera/mt9t031.c

   1 /*
   2  * Driver for MT9T031 CMOS Image Sensor from Micron
   3  *
   4  * Copyright (C) 2008, Guennadi Liakhovetski, DENX Software Engineering <lg@denx.de>
   5  *
   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.
   9  */
  10
  11 #include <linux/device.h>
  12 #include <linux/i2c.h>
  13 #include <linux/log2.h>
  14 #include <linux/pm.h>
  15 #include <linux/slab.h>
  16 #include <linux/v4l2-mediabus.h>
  17 #include <linux/videodev2.h>
  18 #include <linux/module.h>
  19
  20 #include <media/soc_camera.h>
  21 #include <media/v4l2-clk.h>
  22 #include <media/v4l2-subdev.h>
  23 #include <media/v4l2-ctrls.h>
  24
  25 /*
  26  * ATTENTION: this driver still cannot be used outside of the soc-camera
  27  * framework because of its PM implementation, using the video_device node.
  28  * If hardware becomes available for testing, alternative PM approaches shall
  29  * be considered and tested.
  30  */
  31
  32 /*
  33  * mt9t031 i2c address 0x5d
  34  * The platform has to define struct i2c_board_info objects and link to them
  35  * from struct soc_camera_host_desc
  36  */
  37
  38 /* mt9t031 selected register addresses */
  39 #define MT9T031_CHIP_VERSION            0x00
  40 #define MT9T031_ROW_START               0x01
  41 #define MT9T031_COLUMN_START            0x02
  42 #define MT9T031_WINDOW_HEIGHT           0x03
  43 #define MT9T031_WINDOW_WIDTH            0x04
  44 #define MT9T031_HORIZONTAL_BLANKING     0x05
  45 #define MT9T031_VERTICAL_BLANKING       0x06
  46 #define MT9T031_OUTPUT_CONTROL          0x07
  47 #define MT9T031_SHUTTER_WIDTH_UPPER     0x08
  48 #define MT9T031_SHUTTER_WIDTH           0x09
  49 #define MT9T031_PIXEL_CLOCK_CONTROL     0x0a
  50 #define MT9T031_FRAME_RESTART           0x0b
  51 #define MT9T031_SHUTTER_DELAY           0x0c
  52 #define MT9T031_RESET                   0x0d
  53 #define MT9T031_READ_MODE_1             0x1e
  54 #define MT9T031_READ_MODE_2             0x20
  55 #define MT9T031_READ_MODE_3             0x21
  56 #define MT9T031_ROW_ADDRESS_MODE        0x22
  57 #define MT9T031_COLUMN_ADDRESS_MODE     0x23
  58 #define MT9T031_GLOBAL_GAIN             0x35
  59 #define MT9T031_CHIP_ENABLE             0xF8
  60
  61 #define MT9T031_MAX_HEIGHT              1536
  62 #define MT9T031_MAX_WIDTH               2048
  63 #define MT9T031_MIN_HEIGHT              2
  64 #define MT9T031_MIN_WIDTH               18
  65 #define MT9T031_HORIZONTAL_BLANK        142
  66 #define MT9T031_VERTICAL_BLANK          25
  67 #define MT9T031_COLUMN_SKIP             32
  68 #define MT9T031_ROW_SKIP                20
  69
  70 struct mt9t031 {
  71         struct v4l2_subdev subdev;
  72         struct v4l2_ctrl_handler hdl;
  73         struct {
  74                 /* exposure/auto-exposure cluster */
  75                 struct v4l2_ctrl *autoexposure;
  76                 struct v4l2_ctrl *exposure;
  77         };
  78         struct v4l2_rect rect;  /* Sensor window */
  79         struct v4l2_clk *clk;
  80         u16 xskip;
  81         u16 yskip;
  82         unsigned int total_h;
  83         unsigned short y_skip_top;      /* Lines to skip at the top */
  84 };
  85
  86 static struct mt9t031 *to_mt9t031(const struct i2c_client *client)
  87 {
  88         return container_of(i2c_get_clientdata(client), struct mt9t031, subdev);
  89 }
  90
  91 static int reg_read(struct i2c_client *client, const u8 reg)
  92 {
  93         return i2c_smbus_read_word_swapped(client, reg);
  94 }
  95
  96 static int reg_write(struct i2c_client *client, const u8 reg,
  97                      const u16 data)
  98 {
  99         return i2c_smbus_write_word_swapped(client, reg, data);
 100 }
 101
 102 static int reg_set(struct i2c_client *client, const u8 reg,
 103                    const u16 data)
 104 {
 105         int ret;
 106
 107         ret = reg_read(client, reg);
 108         if (ret < 0)
 109                 return ret;
 110         return reg_write(client, reg, ret | data);
 111 }
 112
 113 static int reg_clear(struct i2c_client *client, const u8 reg,
 114                      const u16 data)
 115 {
 116         int ret;
 117
 118         ret = reg_read(client, reg);
 119         if (ret < 0)
 120                 return ret;
 121         return reg_write(client, reg, ret & ~data);
 122 }
 123
 124 static int set_shutter(struct i2c_client *client, const u32 data)
 125 {
 126         int ret;
 127
 128         ret = reg_write(client, MT9T031_SHUTTER_WIDTH_UPPER, data >> 16);
 129
 130         if (ret >= 0)
 131                 ret = reg_write(client, MT9T031_SHUTTER_WIDTH, data & 0xffff);
 132
 133         return ret;
 134 }
 135
 136 static int get_shutter(struct i2c_client *client, u32 *data)
 137 {
 138         int ret;
 139
 140         ret = reg_read(client, MT9T031_SHUTTER_WIDTH_UPPER);
 141         *data = ret << 16;
 142
 143         if (ret >= 0)
 144                 ret = reg_read(client, MT9T031_SHUTTER_WIDTH);
 145         *data |= ret & 0xffff;
 146
 147         return ret < 0 ? ret : 0;
 148 }
 149
 150 static int mt9t031_idle(struct i2c_client *client)
 151 {
 152         int ret;
 153
 154         /* Disable chip output, synchronous option update */
 155         ret = reg_write(client, MT9T031_RESET, 1);
 156         if (ret >= 0)
 157                 ret = reg_write(client, MT9T031_RESET, 0);
 158         if (ret >= 0)
 159                 ret = reg_clear(client, MT9T031_OUTPUT_CONTROL, 2);
 160
 161         return ret >= 0 ? 0 : -EIO;
 162 }
 163
 164 static int mt9t031_s_stream(struct v4l2_subdev *sd, int enable)
 165 {
 166         struct i2c_client *client = v4l2_get_subdevdata(sd);
 167         int ret;
 168
 169         if (enable)
 170                 /* Switch to master "normal" mode */
 171                 ret = reg_set(client, MT9T031_OUTPUT_CONTROL, 2);
 172         else
 173                 /* Stop sensor readout */
 174                 ret = reg_clear(client, MT9T031_OUTPUT_CONTROL, 2);
 175
 176         if (ret < 0)
 177                 return -EIO;
 178
 179         return 0;
 180 }
 181
 182 /* target must be _even_ */
 183 static u16 mt9t031_skip(s32 *source, s32 target, s32 max)
 184 {
 185         unsigned int skip;
 186
 187         if (*source < target + target / 2) {
 188                 *source = target;
 189                 return 1;
 190         }
 191
 192         skip = min(max, *source + target / 2) / target;
 193         if (skip > 8)
 194                 skip = 8;
 195         *source = target * skip;
 196
 197         return skip;
 198 }
 199
 200 /* rect is the sensor rectangle, the caller guarantees parameter validity */
 201 static int mt9t031_set_params(struct i2c_client *client,
 202                               struct v4l2_rect *rect, u16 xskip, u16 yskip)
 203 {
 204         struct mt9t031 *mt9t031 = to_mt9t031(client);
 205         int ret;
 206         u16 xbin, ybin;
 207         const u16 hblank = MT9T031_HORIZONTAL_BLANK,
 208                 vblank = MT9T031_VERTICAL_BLANK;
 209
 210         xbin = min(xskip, (u16)3);
 211         ybin = min(yskip, (u16)3);
 212
 213         /*
 214          * Could just do roundup(rect->left, [xy]bin * 2); but this is cheaper.
 215          * There is always a valid suitably aligned value. The worst case is
 216          * xbin = 3, width = 2048. Then we will start at 36, the last read out
 217          * pixel will be 2083, which is < 2085 - first black pixel.
 218          *
 219          * MT9T031 datasheet imposes window left border alignment, depending on
 220          * the selected xskip. Failing to conform to this requirement produces
 221          * dark horizontal stripes in the image. However, even obeying to this
 222          * requirement doesn't eliminate the stripes in all configurations. They
 223          * appear "locally reproducibly," but can differ between tests under
 224          * different lighting conditions.
 225          */
 226         switch (xbin) {
 227         case 1:
 228                 rect->left &= ~1;
 229                 break;
 230         case 2:
 231                 rect->left &= ~3;
 232                 break;
 233         case 3:
 234                 rect->left = rect->left > roundup(MT9T031_COLUMN_SKIP, 6) ?
 235                         (rect->left / 6) * 6 : roundup(MT9T031_COLUMN_SKIP, 6);
 236         }
 237
 238         rect->top &= ~1;
 239
 240         dev_dbg(&client->dev, "skip %u:%u, rect %ux%u@%u:%u\n",
 241                 xskip, yskip, rect->width, rect->height, rect->left, rect->top);
 242
 243         /* Disable register update, reconfigure atomically */
 244         ret = reg_set(client, MT9T031_OUTPUT_CONTROL, 1);
 245         if (ret < 0)
 246                 return ret;
 247
 248         /* Blanking and start values - default... */
 249         ret = reg_write(client, MT9T031_HORIZONTAL_BLANKING, hblank);
 250         if (ret >= 0)
 251                 ret = reg_write(client, MT9T031_VERTICAL_BLANKING, vblank);
 252
 253         if (yskip != mt9t031->yskip || xskip != mt9t031->xskip) {
 254                 /* Binning, skipping */
 255                 if (ret >= 0)
 256                         ret = reg_write(client, MT9T031_COLUMN_ADDRESS_MODE,
 257                                         ((xbin - 1) << 4) | (xskip - 1));
 258                 if (ret >= 0)
 259                         ret = reg_write(client, MT9T031_ROW_ADDRESS_MODE,
 260                                         ((ybin - 1) << 4) | (yskip - 1));
 261         }
 262         dev_dbg(&client->dev, "new physical left %u, top %u\n",
 263                 rect->left, rect->top);
 264
 265         /*
 266          * The caller provides a supported format, as guaranteed by
 267          * .set_fmt(FORMAT_TRY), soc_camera_s_crop() and soc_camera_cropcap()
 268          */
 269         if (ret >= 0)
 270                 ret = reg_write(client, MT9T031_COLUMN_START, rect->left);
 271         if (ret >= 0)
 272                 ret = reg_write(client, MT9T031_ROW_START, rect->top);
 273         if (ret >= 0)
 274                 ret = reg_write(client, MT9T031_WINDOW_WIDTH, rect->width - 1);
 275         if (ret >= 0)
 276                 ret = reg_write(client, MT9T031_WINDOW_HEIGHT,
 277                                 rect->height + mt9t031->y_skip_top - 1);
 278         if (ret >= 0 && v4l2_ctrl_g_ctrl(mt9t031->autoexposure) == V4L2_EXPOSURE_AUTO) {
 279                 mt9t031->total_h = rect->height + mt9t031->y_skip_top + vblank;
 280
 281                 ret = set_shutter(client, mt9t031->total_h);
 282         }
 283
 284         /* Re-enable register update, commit all changes */
 285         if (ret >= 0)
 286                 ret = reg_clear(client, MT9T031_OUTPUT_CONTROL, 1);
 287
 288         if (ret >= 0) {
 289                 mt9t031->rect = *rect;
 290                 mt9t031->xskip = xskip;
 291                 mt9t031->yskip = yskip;
 292         }
 293
 294         return ret < 0 ? ret : 0;
 295 }
 296
 297 static int mt9t031_s_crop(struct v4l2_subdev *sd, const struct v4l2_crop *a)
 298 {
 299         struct v4l2_rect rect = a->c;
 300         struct i2c_client *client = v4l2_get_subdevdata(sd);
 301         struct mt9t031 *mt9t031 = to_mt9t031(client);
 302
 303         rect.width = ALIGN(rect.width, 2);
 304         rect.height = ALIGN(rect.height, 2);
 305
 306         soc_camera_limit_side(&rect.left, &rect.width,
 307                      MT9T031_COLUMN_SKIP, MT9T031_MIN_WIDTH, MT9T031_MAX_WIDTH);
 308
 309         soc_camera_limit_side(&rect.top, &rect.height,
 310                      MT9T031_ROW_SKIP, MT9T031_MIN_HEIGHT, MT9T031_MAX_HEIGHT);
 311
 312         return mt9t031_set_params(client, &rect, mt9t031->xskip, mt9t031->yskip);
 313 }
 314
 315 static int mt9t031_g_crop(struct v4l2_subdev *sd, struct v4l2_crop *a)
 316 {
 317         struct i2c_client *client = v4l2_get_subdevdata(sd);
 318         struct mt9t031 *mt9t031 = to_mt9t031(client);
 319
 320         a->c    = mt9t031->rect;
 321         a->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
 322
 323         return 0;
 324 }
 325
 326 static int mt9t031_cropcap(struct v4l2_subdev *sd, struct v4l2_cropcap *a)
 327 {
 328         a->bounds.left                  = MT9T031_COLUMN_SKIP;
 329         a->bounds.top                   = MT9T031_ROW_SKIP;
 330         a->bounds.width                 = MT9T031_MAX_WIDTH;
 331         a->bounds.height                = MT9T031_MAX_HEIGHT;
 332         a->defrect                      = a->bounds;
 333         a->type                         = V4L2_BUF_TYPE_VIDEO_CAPTURE;
 334         a->pixelaspect.numerator        = 1;
 335         a->pixelaspect.denominator      = 1;
 336
 337         return 0;
 338 }
 339
 340 static int mt9t031_get_fmt(struct v4l2_subdev *sd,
 341                 struct v4l2_subdev_pad_config *cfg,
 342                 struct v4l2_subdev_format *format)
 343 {
 344         struct v4l2_mbus_framefmt *mf = &format->format;
 345         struct i2c_client *client = v4l2_get_subdevdata(sd);
 346         struct mt9t031 *mt9t031 = to_mt9t031(client);
 347
 348         if (format->pad)
 349                 return -EINVAL;
 350
 351         mf->width       = mt9t031->rect.width / mt9t031->xskip;
 352         mf->height      = mt9t031->rect.height / mt9t031->yskip;
 353         mf->code        = MEDIA_BUS_FMT_SBGGR10_1X10;
 354         mf->colorspace  = V4L2_COLORSPACE_SRGB;
 355         mf->field       = V4L2_FIELD_NONE;
 356
 357         return 0;
 358 }
 359
 360 /*
 361  * If a user window larger than sensor window is requested, we'll increase the
 362  * sensor window.
 363  */
 364 static int mt9t031_set_fmt(struct v4l2_subdev *sd,
 365                 struct v4l2_subdev_pad_config *cfg,
 366                 struct v4l2_subdev_format *format)
 367 {
 368         struct v4l2_mbus_framefmt *mf = &format->format;
 369         struct i2c_client *client = v4l2_get_subdevdata(sd);
 370         struct mt9t031 *mt9t031 = to_mt9t031(client);
 371         u16 xskip, yskip;
 372         struct v4l2_rect rect = mt9t031->rect;
 373
 374         if (format->pad)
 375                 return -EINVAL;
 376
 377         mf->code        = MEDIA_BUS_FMT_SBGGR10_1X10;
 378         mf->colorspace  = V4L2_COLORSPACE_SRGB;
 379         v4l_bound_align_image(
 380                         &mf->width, MT9T031_MIN_WIDTH, MT9T031_MAX_WIDTH, 1,
 381                         &mf->height, MT9T031_MIN_HEIGHT, MT9T031_MAX_HEIGHT, 1, 0);
 382
 383         if (format->which == V4L2_SUBDEV_FORMAT_TRY) {
 384                 cfg->try_fmt = *mf;
 385                 return 0;
 386         }
 387
 388         /*
 389          * Width and height are within limits.
 390          * S_FMT: use binning and skipping for scaling
 391          */
 392         xskip = mt9t031_skip(&rect.width, mf->width, MT9T031_MAX_WIDTH);
 393         yskip = mt9t031_skip(&rect.height, mf->height, MT9T031_MAX_HEIGHT);
 394
 395         mf->code        = MEDIA_BUS_FMT_SBGGR10_1X10;
 396         mf->colorspace  = V4L2_COLORSPACE_SRGB;
 397
 398         /* mt9t031_set_params() doesn't change width and height */
 399         return mt9t031_set_params(client, &rect, xskip, yskip);
 400 }
 401
 402 #ifdef CONFIG_VIDEO_ADV_DEBUG
 403 static int mt9t031_g_register(struct v4l2_subdev *sd,
 404                               struct v4l2_dbg_register *reg)
 405 {
 406         struct i2c_client *client = v4l2_get_subdevdata(sd);
 407
 408         if (reg->reg > 0xff)
 409                 return -EINVAL;
 410
 411         reg->size = 1;
 412         reg->val = reg_read(client, reg->reg);
 413
 414         if (reg->val > 0xffff)
 415                 return -EIO;
 416
 417         return 0;
 418 }
 419
 420 static int mt9t031_s_register(struct v4l2_subdev *sd,
 421                               const struct v4l2_dbg_register *reg)
 422 {
 423         struct i2c_client *client = v4l2_get_subdevdata(sd);
 424
 425         if (reg->reg > 0xff)
 426                 return -EINVAL;
 427
 428         if (reg_write(client, reg->reg, reg->val) < 0)
 429                 return -EIO;
 430
 431         return 0;
 432 }
 433 #endif
 434
 435 static int mt9t031_g_volatile_ctrl(struct v4l2_ctrl *ctrl)
 436 {
 437         struct mt9t031 *mt9t031 = container_of(ctrl->handler,
 438                                                struct mt9t031, hdl);
 439         const u32 shutter_max = MT9T031_MAX_HEIGHT + MT9T031_VERTICAL_BLANK;
 440         s32 min, max;
 441
 442         switch (ctrl->id) {
 443         case V4L2_CID_EXPOSURE_AUTO:
 444                 min = mt9t031->exposure->minimum;
 445                 max = mt9t031->exposure->maximum;
 446                 mt9t031->exposure->val =
 447                         (shutter_max / 2 + (mt9t031->total_h - 1) * (max - min))
 448                                 / shutter_max + min;
 449                 break;
 450         }
 451         return 0;
 452 }
 453
 454 static int mt9t031_s_ctrl(struct v4l2_ctrl *ctrl)
 455 {
 456         struct mt9t031 *mt9t031 = container_of(ctrl->handler,
 457                                                struct mt9t031, hdl);
 458         struct v4l2_subdev *sd = &mt9t031->subdev;
 459         struct i2c_client *client = v4l2_get_subdevdata(sd);
 460         struct v4l2_ctrl *exp = mt9t031->exposure;
 461         int data;
 462
 463         switch (ctrl->id) {
 464         case V4L2_CID_VFLIP:
 465                 if (ctrl->val)
 466                         data = reg_set(client, MT9T031_READ_MODE_2, 0x8000);
 467                 else
 468                         data = reg_clear(client, MT9T031_READ_MODE_2, 0x8000);
 469                 if (data < 0)
 470                         return -EIO;
 471                 return 0;
 472         case V4L2_CID_HFLIP:
 473                 if (ctrl->val)
 474                         data = reg_set(client, MT9T031_READ_MODE_2, 0x4000);
 475                 else
 476                         data = reg_clear(client, MT9T031_READ_MODE_2, 0x4000);
 477                 if (data < 0)
 478                         return -EIO;
 479                 return 0;
 480         case V4L2_CID_GAIN:
 481                 /* See Datasheet Table 7, Gain settings. */
 482                 if (ctrl->val <= ctrl->default_value) {
 483                         /* Pack it into 0..1 step 0.125, register values 0..8 */
 484                         unsigned long range = ctrl->default_value - ctrl->minimum;
 485                         data = ((ctrl->val - (s32)ctrl->minimum) * 8 + range / 2) / range;
 486
 487                         dev_dbg(&client->dev, "Setting gain %d\n", data);
 488                         data = reg_write(client, MT9T031_GLOBAL_GAIN, data);
 489                         if (data < 0)
 490                                 return -EIO;
 491                 } else {
 492                         /* Pack it into 1.125..128 variable step, register values 9..0x7860 */
 493                         /* We assume qctrl->maximum - qctrl->default_value - 1 > 0 */
 494                         unsigned long range = ctrl->maximum - ctrl->default_value - 1;
 495                         /* calculated gain: map 65..127 to 9..1024 step 0.125 */
 496                         unsigned long gain = ((ctrl->val - (s32)ctrl->default_value - 1) *
 497                                                1015 + range / 2) / range + 9;
 498
 499                         if (gain <= 32)         /* calculated gain 9..32 -> 9..32 */
 500                                 data = gain;
 501                         else if (gain <= 64)    /* calculated gain 33..64 -> 0x51..0x60 */
 502                                 data = ((gain - 32) * 16 + 16) / 32 + 80;
 503                         else
 504                                 /* calculated gain 65..1024 -> (1..120) << 8 + 0x60 */
 505                                 data = (((gain - 64 + 7) * 32) & 0xff00) | 0x60;
 506
 507                         dev_dbg(&client->dev, "Set gain from 0x%x to 0x%x\n",
 508                                 reg_read(client, MT9T031_GLOBAL_GAIN), data);
 509                         data = reg_write(client, MT9T031_GLOBAL_GAIN, data);
 510                         if (data < 0)
 511                                 return -EIO;
 512                 }
 513                 return 0;
 514
 515         case V4L2_CID_EXPOSURE_AUTO:
 516                 if (ctrl->val == V4L2_EXPOSURE_MANUAL) {
 517                         unsigned int range = exp->maximum - exp->minimum;
 518                         unsigned int shutter = ((exp->val - (s32)exp->minimum) * 1048 +
 519                                                  range / 2) / range + 1;
 520                         u32 old;
 521
 522                         get_shutter(client, &old);
 523                         dev_dbg(&client->dev, "Set shutter from %u to %u\n",
 524                                 old, shutter);
 525                         if (set_shutter(client, shutter) < 0)
 526                                 return -EIO;
 527                 } else {
 528                         const u16 vblank = MT9T031_VERTICAL_BLANK;
 529                         mt9t031->total_h = mt9t031->rect.height +
 530                                 mt9t031->y_skip_top + vblank;
 531
 532                         if (set_shutter(client, mt9t031->total_h) < 0)
 533                                 return -EIO;
 534                 }
 535                 return 0;
 536         default:
 537                 return -EINVAL;
 538         }
 539         return 0;
 540 }
 541
 542 /*
 543  * Power Management:
 544  * This function does nothing for now but must be present for pm to work
 545  */
 546 static int mt9t031_runtime_suspend(struct device *dev)
 547 {
 548         return 0;
 549 }
 550
 551 /*
 552  * Power Management:
 553  * COLUMN_ADDRESS_MODE and ROW_ADDRESS_MODE are not rewritten if unchanged
 554  * they are however changed at reset if the platform hook is present
 555  * thus we rewrite them with the values stored by the driver
 556  */
 557 static int mt9t031_runtime_resume(struct device *dev)
 558 {
 559         struct video_device *vdev = to_video_device(dev);
 560         struct v4l2_subdev *sd = soc_camera_vdev_to_subdev(vdev);
 561         struct i2c_client *client = v4l2_get_subdevdata(sd);
 562         struct mt9t031 *mt9t031 = to_mt9t031(client);
 563
 564         int ret;
 565         u16 xbin, ybin;
 566
 567         xbin = min(mt9t031->xskip, (u16)3);
 568         ybin = min(mt9t031->yskip, (u16)3);
 569
 570         ret = reg_write(client, MT9T031_COLUMN_ADDRESS_MODE,
 571                 ((xbin - 1) << 4) | (mt9t031->xskip - 1));
 572         if (ret < 0)
 573                 return ret;
 574
 575         ret = reg_write(client, MT9T031_ROW_ADDRESS_MODE,
 576                 ((ybin - 1) << 4) | (mt9t031->yskip - 1));
 577         if (ret < 0)
 578                 return ret;
 579
 580         return 0;
 581 }
 582
 583 static const struct dev_pm_ops mt9t031_dev_pm_ops = {
 584         .runtime_suspend        = mt9t031_runtime_suspend,
 585         .runtime_resume         = mt9t031_runtime_resume,
 586 };
 587
 588 static struct device_type mt9t031_dev_type = {
 589         .name   = "MT9T031",
 590         .pm     = &mt9t031_dev_pm_ops,
 591 };
 592
 593 static int mt9t031_s_power(struct v4l2_subdev *sd, int on)
 594 {
 595         struct i2c_client *client = v4l2_get_subdevdata(sd);
 596         struct soc_camera_subdev_desc *ssdd = soc_camera_i2c_to_desc(client);
 597         struct video_device *vdev = soc_camera_i2c_to_vdev(client);
 598         struct mt9t031 *mt9t031 = to_mt9t031(client);
 599         int ret;
 600
 601         if (on) {
 602                 ret = soc_camera_power_on(&client->dev, ssdd, mt9t031->clk);
 603                 if (ret < 0)
 604                         return ret;
 605                 if (vdev)
 606                         /* Not needed during probing, when vdev isn't available yet */
 607                         vdev->dev.type = &mt9t031_dev_type;
 608         } else {
 609                 if (vdev)
 610                         vdev->dev.type = NULL;
 611                 soc_camera_power_off(&client->dev, ssdd, mt9t031->clk);
 612         }
 613
 614         return 0;
 615 }
 616
 617 /*
 618  * Interface active, can use i2c. If it fails, it can indeed mean, that
 619  * this wasn't our capture interface, so, we wait for the right one
 620  */
 621 static int mt9t031_video_probe(struct i2c_client *client)
 622 {
 623         struct mt9t031 *mt9t031 = to_mt9t031(client);
 624         s32 data;
 625         int ret;
 626
 627         ret = mt9t031_s_power(&mt9t031->subdev, 1);
 628         if (ret < 0)
 629                 return ret;
 630
 631         ret = mt9t031_idle(client);
 632         if (ret < 0) {
 633                 dev_err(&client->dev, "Failed to initialise the camera\n");
 634                 goto done;
 635         }
 636
 637         /* Read out the chip version register */
 638         data = reg_read(client, MT9T031_CHIP_VERSION);
 639
 640         switch (data) {
 641         case 0x1621:
 642                 break;
 643         default:
 644                 dev_err(&client->dev,
 645                         "No MT9T031 chip detected, register read %x\n", data);
 646                 ret = -ENODEV;
 647                 goto done;
 648         }
 649
 650         dev_info(&client->dev, "Detected a MT9T031 chip ID %x\n", data);
 651
 652         ret = v4l2_ctrl_handler_setup(&mt9t031->hdl);
 653
 654 done:
 655         mt9t031_s_power(&mt9t031->subdev, 0);
 656
 657         return ret;
 658 }
 659
 660 static int mt9t031_g_skip_top_lines(struct v4l2_subdev *sd, u32 *lines)
 661 {
 662         struct i2c_client *client = v4l2_get_subdevdata(sd);
 663         struct mt9t031 *mt9t031 = to_mt9t031(client);
 664
 665         *lines = mt9t031->y_skip_top;
 666
 667         return 0;
 668 }
 669
 670 static const struct v4l2_ctrl_ops mt9t031_ctrl_ops = {
 671         .g_volatile_ctrl = mt9t031_g_volatile_ctrl,
 672         .s_ctrl = mt9t031_s_ctrl,
 673 };
 674
 675 static struct v4l2_subdev_core_ops mt9t031_subdev_core_ops = {
 676         .s_power        = mt9t031_s_power,
 677 #ifdef CONFIG_VIDEO_ADV_DEBUG
 678         .g_register     = mt9t031_g_register,
 679         .s_register     = mt9t031_s_register,
 680 #endif
 681 };
 682
 683 static int mt9t031_enum_mbus_code(struct v4l2_subdev *sd,
 684                 struct v4l2_subdev_pad_config *cfg,
 685                 struct v4l2_subdev_mbus_code_enum *code)
 686 {
 687         if (code->pad || code->index)
 688                 return -EINVAL;
 689
 690         code->code = MEDIA_BUS_FMT_SBGGR10_1X10;
 691         return 0;
 692 }
 693
 694 static int mt9t031_g_mbus_config(struct v4l2_subdev *sd,
 695                                 struct v4l2_mbus_config *cfg)
 696 {
 697         struct i2c_client *client = v4l2_get_subdevdata(sd);
 698         struct soc_camera_subdev_desc *ssdd = soc_camera_i2c_to_desc(client);
 699
 700         cfg->flags = V4L2_MBUS_MASTER | V4L2_MBUS_PCLK_SAMPLE_RISING |
 701                 V4L2_MBUS_PCLK_SAMPLE_FALLING | V4L2_MBUS_HSYNC_ACTIVE_HIGH |
 702                 V4L2_MBUS_VSYNC_ACTIVE_HIGH | V4L2_MBUS_DATA_ACTIVE_HIGH;
 703         cfg->type = V4L2_MBUS_PARALLEL;
 704         cfg->flags = soc_camera_apply_board_flags(ssdd, cfg);
 705
 706         return 0;
 707 }
 708
 709 static int mt9t031_s_mbus_config(struct v4l2_subdev *sd,
 710                                 const struct v4l2_mbus_config *cfg)
 711 {
 712         struct i2c_client *client = v4l2_get_subdevdata(sd);
 713         struct soc_camera_subdev_desc *ssdd = soc_camera_i2c_to_desc(client);
 714
 715         if (soc_camera_apply_board_flags(ssdd, cfg) &
 716             V4L2_MBUS_PCLK_SAMPLE_FALLING)
 717                 return reg_clear(client, MT9T031_PIXEL_CLOCK_CONTROL, 0x8000);
 718         else
 719                 return reg_set(client, MT9T031_PIXEL_CLOCK_CONTROL, 0x8000);
 720 }
 721
 722 static struct v4l2_subdev_video_ops mt9t031_subdev_video_ops = {
 723         .s_stream       = mt9t031_s_stream,
 724         .s_crop         = mt9t031_s_crop,
 725         .g_crop         = mt9t031_g_crop,
 726         .cropcap        = mt9t031_cropcap,
 727         .g_mbus_config  = mt9t031_g_mbus_config,
 728         .s_mbus_config  = mt9t031_s_mbus_config,
 729 };
 730
 731 static struct v4l2_subdev_sensor_ops mt9t031_subdev_sensor_ops = {
 732         .g_skip_top_lines       = mt9t031_g_skip_top_lines,
 733 };
 734
 735 static const struct v4l2_subdev_pad_ops mt9t031_subdev_pad_ops = {
 736         .enum_mbus_code = mt9t031_enum_mbus_code,
 737         .get_fmt        = mt9t031_get_fmt,
 738         .set_fmt        = mt9t031_set_fmt,
 739 };
 740
 741 static struct v4l2_subdev_ops mt9t031_subdev_ops = {
 742         .core   = &mt9t031_subdev_core_ops,
 743         .video  = &mt9t031_subdev_video_ops,
 744         .sensor = &mt9t031_subdev_sensor_ops,
 745         .pad    = &mt9t031_subdev_pad_ops,
 746 };
 747
 748 static int mt9t031_probe(struct i2c_client *client,
 749                          const struct i2c_device_id *did)
 750 {
 751         struct mt9t031 *mt9t031;
 752         struct soc_camera_subdev_desc *ssdd = soc_camera_i2c_to_desc(client);
 753         struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
 754         int ret;
 755
 756         if (!ssdd) {
 757                 dev_err(&client->dev, "MT9T031 driver needs platform data\n");
 758                 return -EINVAL;
 759         }
 760
 761         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA)) {
 762                 dev_warn(&adapter->dev,
 763                          "I2C-Adapter doesn't support I2C_FUNC_SMBUS_WORD\n");
 764                 return -EIO;
 765         }
 766
 767         mt9t031 = devm_kzalloc(&client->dev, sizeof(struct mt9t031), GFP_KERNEL);
 768         if (!mt9t031)
 769                 return -ENOMEM;
 770
 771         v4l2_i2c_subdev_init(&mt9t031->subdev, client, &mt9t031_subdev_ops);
 772         v4l2_ctrl_handler_init(&mt9t031->hdl, 5);
 773         v4l2_ctrl_new_std(&mt9t031->hdl, &mt9t031_ctrl_ops,
 774                         V4L2_CID_VFLIP, 0, 1, 1, 0);
 775         v4l2_ctrl_new_std(&mt9t031->hdl, &mt9t031_ctrl_ops,
 776                         V4L2_CID_HFLIP, 0, 1, 1, 0);
 777         v4l2_ctrl_new_std(&mt9t031->hdl, &mt9t031_ctrl_ops,
 778                         V4L2_CID_GAIN, 0, 127, 1, 64);
 779
 780         /*
 781          * Simulated autoexposure. If enabled, we calculate shutter width
 782          * ourselves in the driver based on vertical blanking and frame width
 783          */
 784         mt9t031->autoexposure = v4l2_ctrl_new_std_menu(&mt9t031->hdl,
 785                         &mt9t031_ctrl_ops, V4L2_CID_EXPOSURE_AUTO, 1, 0,
 786                         V4L2_EXPOSURE_AUTO);
 787         mt9t031->exposure = v4l2_ctrl_new_std(&mt9t031->hdl, &mt9t031_ctrl_ops,
 788                         V4L2_CID_EXPOSURE, 1, 255, 1, 255);
 789
 790         mt9t031->subdev.ctrl_handler = &mt9t031->hdl;
 791         if (mt9t031->hdl.error)
 792                 return mt9t031->hdl.error;
 793
 794         v4l2_ctrl_auto_cluster(2, &mt9t031->autoexposure,
 795                                 V4L2_EXPOSURE_MANUAL, true);
 796
 797         mt9t031->y_skip_top     = 0;
 798         mt9t031->rect.left      = MT9T031_COLUMN_SKIP;
 799         mt9t031->rect.top       = MT9T031_ROW_SKIP;
 800         mt9t031->rect.width     = MT9T031_MAX_WIDTH;
 801         mt9t031->rect.height    = MT9T031_MAX_HEIGHT;
 802
 803         mt9t031->xskip = 1;
 804         mt9t031->yskip = 1;
 805
 806         mt9t031->clk = v4l2_clk_get(&client->dev, "mclk");
 807         if (IS_ERR(mt9t031->clk)) {
 808                 ret = PTR_ERR(mt9t031->clk);
 809                 goto eclkget;
 810         }
 811
 812         ret = mt9t031_video_probe(client);
 813         if (ret) {
 814                 v4l2_clk_put(mt9t031->clk);
 815 eclkget:
 816                 v4l2_ctrl_handler_free(&mt9t031->hdl);
 817         }
 818
 819         return ret;
 820 }
 821
 822 static int mt9t031_remove(struct i2c_client *client)
 823 {
 824         struct mt9t031 *mt9t031 = to_mt9t031(client);
 825
 826         v4l2_clk_put(mt9t031->clk);
 827         v4l2_device_unregister_subdev(&mt9t031->subdev);
 828         v4l2_ctrl_handler_free(&mt9t031->hdl);
 829
 830         return 0;
 831 }
 832
 833 static const struct i2c_device_id mt9t031_id[] = {
 834         { "mt9t031", 0 },
 835         { }
 836 };
 837 MODULE_DEVICE_TABLE(i2c, mt9t031_id);
 838
 839 static struct i2c_driver mt9t031_i2c_driver = {
 840         .driver = {
 841                 .name = "mt9t031",
 842         },
 843         .probe          = mt9t031_probe,
 844         .remove         = mt9t031_remove,
 845         .id_table       = mt9t031_id,
 846 };
 847
 848 module_i2c_driver(mt9t031_i2c_driver);
 849
 850 MODULE_DESCRIPTION("Micron MT9T031 Camera driver");
 851 MODULE_AUTHOR("Guennadi Liakhovetski <lg@denx.de>");
 852 MODULE_LICENSE("GPL v2");