drivers/media/i2c/ov2680.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Omnivision OV2680 CMOS Image Sensor driver
   4  *
   5  * Copyright (C) 2018 Linaro Ltd
   6  *
   7  * Based on OV5640 Sensor Driver
   8  * Copyright (C) 2011-2013 Freescale Semiconductor, Inc. All Rights Reserved.
   9  * Copyright (C) 2014-2017 Mentor Graphics Inc.
  10  *
  11  */
  12
  13 #include <asm/unaligned.h>
  14 #include <linux/clk.h>
  15 #include <linux/delay.h>
  16 #include <linux/err.h>
  17 #include <linux/i2c.h>
  18 #include <linux/init.h>
  19 #include <linux/mod_devicetable.h>
  20 #include <linux/module.h>
  21 #include <linux/gpio/consumer.h>
  22 #include <linux/regulator/consumer.h>
  23
  24 #include <media/v4l2-common.h>
  25 #include <media/v4l2-ctrls.h>
  26 #include <media/v4l2-subdev.h>
  27
  28 #define OV2680_XVCLK_VALUE      24000000
  29
  30 #define OV2680_CHIP_ID          0x2680
  31
  32 #define OV2680_REG_STREAM_CTRL          0x0100
  33 #define OV2680_REG_SOFT_RESET           0x0103
  34
  35 #define OV2680_REG_CHIP_ID_HIGH         0x300a
  36 #define OV2680_REG_CHIP_ID_LOW          0x300b
  37
  38 #define OV2680_REG_R_MANUAL             0x3503
  39 #define OV2680_REG_GAIN_PK              0x350a
  40 #define OV2680_REG_EXPOSURE_PK_HIGH     0x3500
  41 #define OV2680_REG_TIMING_HTS           0x380c
  42 #define OV2680_REG_TIMING_VTS           0x380e
  43 #define OV2680_REG_FORMAT1              0x3820
  44 #define OV2680_REG_FORMAT2              0x3821
  45
  46 #define OV2680_REG_ISP_CTRL00           0x5080
  47
  48 #define OV2680_FRAME_RATE               30
  49
  50 #define OV2680_REG_VALUE_8BIT           1
  51 #define OV2680_REG_VALUE_16BIT          2
  52 #define OV2680_REG_VALUE_24BIT          3
  53
  54 #define OV2680_WIDTH_MAX                1600
  55 #define OV2680_HEIGHT_MAX               1200
  56
  57 enum ov2680_mode_id {
  58         OV2680_MODE_QUXGA_800_600,
  59         OV2680_MODE_720P_1280_720,
  60         OV2680_MODE_UXGA_1600_1200,
  61         OV2680_MODE_MAX,
  62 };
  63
  64 struct reg_value {
  65         u16 reg_addr;
  66         u8 val;
  67 };
  68
  69 static const char * const ov2680_supply_name[] = {
  70         "DOVDD",
  71         "DVDD",
  72         "AVDD",
  73 };
  74
  75 #define OV2680_NUM_SUPPLIES ARRAY_SIZE(ov2680_supply_name)
  76
  77 struct ov2680_mode_info {
  78         const char *name;
  79         enum ov2680_mode_id id;
  80         u32 width;
  81         u32 height;
  82         const struct reg_value *reg_data;
  83         u32 reg_data_size;
  84 };
  85
  86 struct ov2680_ctrls {
  87         struct v4l2_ctrl_handler handler;
  88         struct v4l2_ctrl *exposure;
  89         struct v4l2_ctrl *gain;
  90         struct v4l2_ctrl *hflip;
  91         struct v4l2_ctrl *vflip;
  92         struct v4l2_ctrl *test_pattern;
  93 };
  94
  95 struct ov2680_dev {
  96         struct i2c_client               *i2c_client;
  97         struct v4l2_subdev              sd;
  98
  99         struct media_pad                pad;
 100         struct clk                      *xvclk;
 101         u32                             xvclk_freq;
 102         struct regulator_bulk_data      supplies[OV2680_NUM_SUPPLIES];
 103
 104         struct gpio_desc                *reset_gpio;
 105         struct mutex                    lock; /* protect members */
 106
 107         bool                            mode_pending_changes;
 108         bool                            is_enabled;
 109         bool                            is_streaming;
 110
 111         struct ov2680_ctrls             ctrls;
 112         struct v4l2_mbus_framefmt       fmt;
 113         struct v4l2_fract               frame_interval;
 114
 115         const struct ov2680_mode_info   *current_mode;
 116 };
 117
 118 static const char * const test_pattern_menu[] = {
 119         "Disabled",
 120         "Color Bars",
 121         "Random Data",
 122         "Square",
 123         "Black Image",
 124 };
 125
 126 static const int ov2680_hv_flip_bayer_order[] = {
 127         MEDIA_BUS_FMT_SBGGR10_1X10,
 128         MEDIA_BUS_FMT_SGRBG10_1X10,
 129         MEDIA_BUS_FMT_SGBRG10_1X10,
 130         MEDIA_BUS_FMT_SRGGB10_1X10,
 131 };
 132
 133 static const struct reg_value ov2680_setting_30fps_QUXGA_800_600[] = {
 134         {0x3086, 0x01}, {0x370a, 0x23}, {0x3808, 0x03}, {0x3809, 0x20},
 135         {0x380a, 0x02}, {0x380b, 0x58}, {0x380c, 0x06}, {0x380d, 0xac},
 136         {0x380e, 0x02}, {0x380f, 0x84}, {0x3811, 0x04}, {0x3813, 0x04},
 137         {0x3814, 0x31}, {0x3815, 0x31}, {0x3820, 0xc0}, {0x4008, 0x00},
 138         {0x4009, 0x03}, {0x4837, 0x1e}, {0x3501, 0x4e}, {0x3502, 0xe0},
 139         {0x3503, 0x03},
 140 };
 141
 142 static const struct reg_value ov2680_setting_30fps_720P_1280_720[] = {
 143         {0x3086, 0x00}, {0x3808, 0x05}, {0x3809, 0x00}, {0x380a, 0x02},
 144         {0x380b, 0xd0}, {0x380c, 0x06}, {0x380d, 0xa8}, {0x380e, 0x05},
 145         {0x380f, 0x0e}, {0x3811, 0x08}, {0x3813, 0x06}, {0x3814, 0x11},
 146         {0x3815, 0x11}, {0x3820, 0xc0}, {0x4008, 0x00},
 147 };
 148
 149 static const struct reg_value ov2680_setting_30fps_UXGA_1600_1200[] = {
 150         {0x3086, 0x00}, {0x3501, 0x4e}, {0x3502, 0xe0}, {0x3808, 0x06},
 151         {0x3809, 0x40}, {0x380a, 0x04}, {0x380b, 0xb0}, {0x380c, 0x06},
 152         {0x380d, 0xa8}, {0x380e, 0x05}, {0x380f, 0x0e}, {0x3811, 0x00},
 153         {0x3813, 0x00}, {0x3814, 0x11}, {0x3815, 0x11}, {0x3820, 0xc0},
 154         {0x4008, 0x00}, {0x4837, 0x18}
 155 };
 156
 157 static const struct ov2680_mode_info ov2680_mode_init_data = {
 158         "mode_quxga_800_600", OV2680_MODE_QUXGA_800_600, 800, 600,
 159         ov2680_setting_30fps_QUXGA_800_600,
 160         ARRAY_SIZE(ov2680_setting_30fps_QUXGA_800_600),
 161 };
 162
 163 static const struct ov2680_mode_info ov2680_mode_data[OV2680_MODE_MAX] = {
 164         {"mode_quxga_800_600", OV2680_MODE_QUXGA_800_600,
 165          800, 600, ov2680_setting_30fps_QUXGA_800_600,
 166          ARRAY_SIZE(ov2680_setting_30fps_QUXGA_800_600)},
 167         {"mode_720p_1280_720", OV2680_MODE_720P_1280_720,
 168          1280, 720, ov2680_setting_30fps_720P_1280_720,
 169          ARRAY_SIZE(ov2680_setting_30fps_720P_1280_720)},
 170         {"mode_uxga_1600_1200", OV2680_MODE_UXGA_1600_1200,
 171          1600, 1200, ov2680_setting_30fps_UXGA_1600_1200,
 172          ARRAY_SIZE(ov2680_setting_30fps_UXGA_1600_1200)},
 173 };
 174
 175 static struct ov2680_dev *to_ov2680_dev(struct v4l2_subdev *sd)
 176 {
 177         return container_of(sd, struct ov2680_dev, sd);
 178 }
 179
 180 static struct device *ov2680_to_dev(struct ov2680_dev *sensor)
 181 {
 182         return &sensor->i2c_client->dev;
 183 }
 184
 185 static inline struct v4l2_subdev *ctrl_to_sd(struct v4l2_ctrl *ctrl)
 186 {
 187         return &container_of(ctrl->handler, struct ov2680_dev,
 188                              ctrls.handler)->sd;
 189 }
 190
 191 static int __ov2680_write_reg(struct ov2680_dev *sensor, u16 reg,
 192                               unsigned int len, u32 val)
 193 {
 194         struct i2c_client *client = sensor->i2c_client;
 195         u8 buf[6];
 196         int ret;
 197
 198         if (len > 4)
 199                 return -EINVAL;
 200
 201         put_unaligned_be16(reg, buf);
 202         put_unaligned_be32(val << (8 * (4 - len)), buf + 2);
 203         ret = i2c_master_send(client, buf, len + 2);
 204         if (ret != len + 2) {
 205                 dev_err(&client->dev, "write error: reg=0x%4x: %d\n", reg, ret);
 206                 return -EIO;
 207         }
 208
 209         return 0;
 210 }
 211
 212 #define ov2680_write_reg(s, r, v) \
 213         __ov2680_write_reg(s, r, OV2680_REG_VALUE_8BIT, v)
 214
 215 #define ov2680_write_reg16(s, r, v) \
 216         __ov2680_write_reg(s, r, OV2680_REG_VALUE_16BIT, v)
 217
 218 #define ov2680_write_reg24(s, r, v) \
 219         __ov2680_write_reg(s, r, OV2680_REG_VALUE_24BIT, v)
 220
 221 static int __ov2680_read_reg(struct ov2680_dev *sensor, u16 reg,
 222                              unsigned int len, u32 *val)
 223 {
 224         struct i2c_client *client = sensor->i2c_client;
 225         struct i2c_msg msgs[2];
 226         u8 addr_buf[2] = { reg >> 8, reg & 0xff };
 227         u8 data_buf[4] = { 0, };
 228         int ret;
 229
 230         if (len > 4)
 231                 return -EINVAL;
 232
 233         msgs[0].addr = client->addr;
 234         msgs[0].flags = 0;
 235         msgs[0].len = ARRAY_SIZE(addr_buf);
 236         msgs[0].buf = addr_buf;
 237
 238         msgs[1].addr = client->addr;
 239         msgs[1].flags = I2C_M_RD;
 240         msgs[1].len = len;
 241         msgs[1].buf = &data_buf[4 - len];
 242
 243         ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
 244         if (ret != ARRAY_SIZE(msgs)) {
 245                 dev_err(&client->dev, "read error: reg=0x%4x: %d\n", reg, ret);
 246                 return -EIO;
 247         }
 248
 249         *val = get_unaligned_be32(data_buf);
 250
 251         return 0;
 252 }
 253
 254 #define ov2680_read_reg(s, r, v) \
 255         __ov2680_read_reg(s, r, OV2680_REG_VALUE_8BIT, v)
 256
 257 #define ov2680_read_reg16(s, r, v) \
 258         __ov2680_read_reg(s, r, OV2680_REG_VALUE_16BIT, v)
 259
 260 #define ov2680_read_reg24(s, r, v) \
 261         __ov2680_read_reg(s, r, OV2680_REG_VALUE_24BIT, v)
 262
 263 static int ov2680_mod_reg(struct ov2680_dev *sensor, u16 reg, u8 mask, u8 val)
 264 {
 265         u32 readval;
 266         int ret;
 267
 268         ret = ov2680_read_reg(sensor, reg, &readval);
 269         if (ret < 0)
 270                 return ret;
 271
 272         readval &= ~mask;
 273         val &= mask;
 274         val |= readval;
 275
 276         return ov2680_write_reg(sensor, reg, val);
 277 }
 278
 279 static int ov2680_load_regs(struct ov2680_dev *sensor,
 280                             const struct ov2680_mode_info *mode)
 281 {
 282         const struct reg_value *regs = mode->reg_data;
 283         unsigned int i;
 284         int ret = 0;
 285         u16 reg_addr;
 286         u8 val;
 287
 288         for (i = 0; i < mode->reg_data_size; ++i, ++regs) {
 289                 reg_addr = regs->reg_addr;
 290                 val = regs->val;
 291
 292                 ret = ov2680_write_reg(sensor, reg_addr, val);
 293                 if (ret)
 294                         break;
 295         }
 296
 297         return ret;
 298 }
 299
 300 static void ov2680_power_up(struct ov2680_dev *sensor)
 301 {
 302         if (!sensor->reset_gpio)
 303                 return;
 304
 305         gpiod_set_value(sensor->reset_gpio, 0);
 306         usleep_range(5000, 10000);
 307 }
 308
 309 static void ov2680_power_down(struct ov2680_dev *sensor)
 310 {
 311         if (!sensor->reset_gpio)
 312                 return;
 313
 314         gpiod_set_value(sensor->reset_gpio, 1);
 315         usleep_range(5000, 10000);
 316 }
 317
 318 static void ov2680_set_bayer_order(struct ov2680_dev *sensor)
 319 {
 320         int hv_flip = 0;
 321
 322         if (sensor->ctrls.vflip && sensor->ctrls.vflip->val)
 323                 hv_flip += 1;
 324
 325         if (sensor->ctrls.hflip && sensor->ctrls.hflip->val)
 326                 hv_flip += 2;
 327
 328         sensor->fmt.code = ov2680_hv_flip_bayer_order[hv_flip];
 329 }
 330
 331 static int ov2680_set_vflip(struct ov2680_dev *sensor, s32 val)
 332 {
 333         int ret;
 334
 335         if (sensor->is_streaming)
 336                 return -EBUSY;
 337
 338         ret = ov2680_mod_reg(sensor, OV2680_REG_FORMAT1,
 339                              BIT(2), val ? BIT(2) : 0);
 340         if (ret < 0)
 341                 return ret;
 342
 343         ov2680_set_bayer_order(sensor);
 344         return 0;
 345 }
 346
 347 static int ov2680_set_hflip(struct ov2680_dev *sensor, s32 val)
 348 {
 349         int ret;
 350
 351         if (sensor->is_streaming)
 352                 return -EBUSY;
 353
 354         ret = ov2680_mod_reg(sensor, OV2680_REG_FORMAT2,
 355                              BIT(2), val ? BIT(2) : 0);
 356         if (ret < 0)
 357                 return ret;
 358
 359         ov2680_set_bayer_order(sensor);
 360         return 0;
 361 }
 362
 363 static int ov2680_test_pattern_set(struct ov2680_dev *sensor, int value)
 364 {
 365         int ret;
 366
 367         if (!value)
 368                 return ov2680_mod_reg(sensor, OV2680_REG_ISP_CTRL00, BIT(7), 0);
 369
 370         ret = ov2680_mod_reg(sensor, OV2680_REG_ISP_CTRL00, 0x03, value - 1);
 371         if (ret < 0)
 372                 return ret;
 373
 374         ret = ov2680_mod_reg(sensor, OV2680_REG_ISP_CTRL00, BIT(7), BIT(7));
 375         if (ret < 0)
 376                 return ret;
 377
 378         return 0;
 379 }
 380
 381 static int ov2680_gain_set(struct ov2680_dev *sensor, u32 gain)
 382 {
 383         return ov2680_write_reg16(sensor, OV2680_REG_GAIN_PK, gain);
 384 }
 385
 386 static int ov2680_exposure_set(struct ov2680_dev *sensor, u32 exp)
 387 {
 388         return ov2680_write_reg24(sensor, OV2680_REG_EXPOSURE_PK_HIGH,
 389                                   exp << 4);
 390 }
 391
 392 static int ov2680_stream_enable(struct ov2680_dev *sensor)
 393 {
 394         return ov2680_write_reg(sensor, OV2680_REG_STREAM_CTRL, 1);
 395 }
 396
 397 static int ov2680_stream_disable(struct ov2680_dev *sensor)
 398 {
 399         return ov2680_write_reg(sensor, OV2680_REG_STREAM_CTRL, 0);
 400 }
 401
 402 static int ov2680_mode_set(struct ov2680_dev *sensor)
 403 {
 404         int ret;
 405
 406         ret = ov2680_load_regs(sensor, sensor->current_mode);
 407         if (ret < 0)
 408                 return ret;
 409
 410         /* Restore value of all ctrls */
 411         ret = __v4l2_ctrl_handler_setup(&sensor->ctrls.handler);
 412         if (ret < 0)
 413                 return ret;
 414
 415         sensor->mode_pending_changes = false;
 416
 417         return 0;
 418 }
 419
 420 static int ov2680_mode_restore(struct ov2680_dev *sensor)
 421 {
 422         int ret;
 423
 424         ret = ov2680_load_regs(sensor, &ov2680_mode_init_data);
 425         if (ret < 0)
 426                 return ret;
 427
 428         return ov2680_mode_set(sensor);
 429 }
 430
 431 static int ov2680_power_off(struct ov2680_dev *sensor)
 432 {
 433         if (!sensor->is_enabled)
 434                 return 0;
 435
 436         clk_disable_unprepare(sensor->xvclk);
 437         ov2680_power_down(sensor);
 438         regulator_bulk_disable(OV2680_NUM_SUPPLIES, sensor->supplies);
 439         sensor->is_enabled = false;
 440
 441         return 0;
 442 }
 443
 444 static int ov2680_power_on(struct ov2680_dev *sensor)
 445 {
 446         struct device *dev = ov2680_to_dev(sensor);
 447         int ret;
 448
 449         if (sensor->is_enabled)
 450                 return 0;
 451
 452         ret = regulator_bulk_enable(OV2680_NUM_SUPPLIES, sensor->supplies);
 453         if (ret < 0) {
 454                 dev_err(dev, "failed to enable regulators: %d\n", ret);
 455                 return ret;
 456         }
 457
 458         if (!sensor->reset_gpio) {
 459                 ret = ov2680_write_reg(sensor, OV2680_REG_SOFT_RESET, 0x01);
 460                 if (ret != 0) {
 461                         dev_err(dev, "sensor soft reset failed\n");
 462                         return ret;
 463                 }
 464                 usleep_range(1000, 2000);
 465         } else {
 466                 ov2680_power_down(sensor);
 467                 ov2680_power_up(sensor);
 468         }
 469
 470         ret = clk_prepare_enable(sensor->xvclk);
 471         if (ret < 0)
 472                 return ret;
 473
 474         sensor->is_enabled = true;
 475
 476         /* Set clock lane into LP-11 state */
 477         ov2680_stream_enable(sensor);
 478         usleep_range(1000, 2000);
 479         ov2680_stream_disable(sensor);
 480
 481         return 0;
 482 }
 483
 484 static int ov2680_s_power(struct v4l2_subdev *sd, int on)
 485 {
 486         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 487         int ret = 0;
 488
 489         mutex_lock(&sensor->lock);
 490
 491         if (on)
 492                 ret = ov2680_power_on(sensor);
 493         else
 494                 ret = ov2680_power_off(sensor);
 495
 496         if (on && ret == 0)
 497                 ret = ov2680_mode_restore(sensor);
 498
 499         mutex_unlock(&sensor->lock);
 500
 501         return ret;
 502 }
 503
 504 static int ov2680_s_g_frame_interval(struct v4l2_subdev *sd,
 505                                      struct v4l2_subdev_frame_interval *fi)
 506 {
 507         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 508
 509         mutex_lock(&sensor->lock);
 510         fi->interval = sensor->frame_interval;
 511         mutex_unlock(&sensor->lock);
 512
 513         return 0;
 514 }
 515
 516 static int ov2680_s_stream(struct v4l2_subdev *sd, int enable)
 517 {
 518         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 519         int ret = 0;
 520
 521         mutex_lock(&sensor->lock);
 522
 523         if (sensor->is_streaming == !!enable)
 524                 goto unlock;
 525
 526         if (enable && sensor->mode_pending_changes) {
 527                 ret = ov2680_mode_set(sensor);
 528                 if (ret < 0)
 529                         goto unlock;
 530         }
 531
 532         if (enable)
 533                 ret = ov2680_stream_enable(sensor);
 534         else
 535                 ret = ov2680_stream_disable(sensor);
 536
 537         sensor->is_streaming = !!enable;
 538
 539 unlock:
 540         mutex_unlock(&sensor->lock);
 541
 542         return ret;
 543 }
 544
 545 static int ov2680_enum_mbus_code(struct v4l2_subdev *sd,
 546                                  struct v4l2_subdev_state *sd_state,
 547                                  struct v4l2_subdev_mbus_code_enum *code)
 548 {
 549         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 550
 551         if (code->pad != 0 || code->index != 0)
 552                 return -EINVAL;
 553
 554         code->code = sensor->fmt.code;
 555
 556         return 0;
 557 }
 558
 559 static int ov2680_get_fmt(struct v4l2_subdev *sd,
 560                           struct v4l2_subdev_state *sd_state,
 561                           struct v4l2_subdev_format *format)
 562 {
 563         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 564         struct v4l2_mbus_framefmt *fmt = NULL;
 565
 566         if (format->pad != 0)
 567                 return -EINVAL;
 568
 569         mutex_lock(&sensor->lock);
 570
 571         if (format->which == V4L2_SUBDEV_FORMAT_TRY) {
 572                 fmt = v4l2_subdev_get_try_format(&sensor->sd, sd_state,
 573                                                  format->pad);
 574         } else {
 575                 fmt = &sensor->fmt;
 576         }
 577
 578         format->format = *fmt;
 579
 580         mutex_unlock(&sensor->lock);
 581
 582         return 0;
 583 }
 584
 585 static int ov2680_set_fmt(struct v4l2_subdev *sd,
 586                           struct v4l2_subdev_state *sd_state,
 587                           struct v4l2_subdev_format *format)
 588 {
 589         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 590         struct v4l2_mbus_framefmt *fmt = &format->format;
 591         struct v4l2_mbus_framefmt *try_fmt;
 592         const struct ov2680_mode_info *mode;
 593         int ret = 0;
 594
 595         if (format->pad != 0)
 596                 return -EINVAL;
 597
 598         mutex_lock(&sensor->lock);
 599
 600         if (sensor->is_streaming) {
 601                 ret = -EBUSY;
 602                 goto unlock;
 603         }
 604
 605         mode = v4l2_find_nearest_size(ov2680_mode_data,
 606                                       ARRAY_SIZE(ov2680_mode_data), width,
 607                                       height, fmt->width, fmt->height);
 608         if (!mode) {
 609                 ret = -EINVAL;
 610                 goto unlock;
 611         }
 612
 613         if (format->which == V4L2_SUBDEV_FORMAT_TRY) {
 614                 try_fmt = v4l2_subdev_get_try_format(sd, sd_state, 0);
 615                 format->format = *try_fmt;
 616                 goto unlock;
 617         }
 618
 619         fmt->width = mode->width;
 620         fmt->height = mode->height;
 621         fmt->code = sensor->fmt.code;
 622         fmt->colorspace = sensor->fmt.colorspace;
 623
 624         sensor->current_mode = mode;
 625         sensor->fmt = format->format;
 626         sensor->mode_pending_changes = true;
 627
 628 unlock:
 629         mutex_unlock(&sensor->lock);
 630
 631         return ret;
 632 }
 633
 634 static int ov2680_init_cfg(struct v4l2_subdev *sd,
 635                            struct v4l2_subdev_state *sd_state)
 636 {
 637         struct v4l2_subdev_format fmt = {
 638                 .which = sd_state ? V4L2_SUBDEV_FORMAT_TRY
 639                 : V4L2_SUBDEV_FORMAT_ACTIVE,
 640                 .format = {
 641                         .width = 800,
 642                         .height = 600,
 643                 }
 644         };
 645
 646         return ov2680_set_fmt(sd, sd_state, &fmt);
 647 }
 648
 649 static int ov2680_enum_frame_size(struct v4l2_subdev *sd,
 650                                   struct v4l2_subdev_state *sd_state,
 651                                   struct v4l2_subdev_frame_size_enum *fse)
 652 {
 653         int index = fse->index;
 654
 655         if (index >= OV2680_MODE_MAX || index < 0)
 656                 return -EINVAL;
 657
 658         fse->min_width = ov2680_mode_data[index].width;
 659         fse->min_height = ov2680_mode_data[index].height;
 660         fse->max_width = ov2680_mode_data[index].width;
 661         fse->max_height = ov2680_mode_data[index].height;
 662
 663         return 0;
 664 }
 665
 666 static int ov2680_enum_frame_interval(struct v4l2_subdev *sd,
 667                               struct v4l2_subdev_state *sd_state,
 668                               struct v4l2_subdev_frame_interval_enum *fie)
 669 {
 670         struct v4l2_fract tpf;
 671
 672         if (fie->index >= OV2680_MODE_MAX || fie->width > OV2680_WIDTH_MAX ||
 673             fie->height > OV2680_HEIGHT_MAX ||
 674             fie->which > V4L2_SUBDEV_FORMAT_ACTIVE)
 675                 return -EINVAL;
 676
 677         tpf.denominator = OV2680_FRAME_RATE;
 678         tpf.numerator = 1;
 679
 680         fie->interval = tpf;
 681
 682         return 0;
 683 }
 684
 685 static int ov2680_s_ctrl(struct v4l2_ctrl *ctrl)
 686 {
 687         struct v4l2_subdev *sd = ctrl_to_sd(ctrl);
 688         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 689
 690         if (!sensor->is_enabled)
 691                 return 0;
 692
 693         switch (ctrl->id) {
 694         case V4L2_CID_GAIN:
 695                 return ov2680_gain_set(sensor, ctrl->val);
 696         case V4L2_CID_EXPOSURE:
 697                 return ov2680_exposure_set(sensor, ctrl->val);
 698         case V4L2_CID_VFLIP:
 699                 return ov2680_set_vflip(sensor, ctrl->val);
 700         case V4L2_CID_HFLIP:
 701                 return ov2680_set_hflip(sensor, ctrl->val);
 702         case V4L2_CID_TEST_PATTERN:
 703                 return ov2680_test_pattern_set(sensor, ctrl->val);
 704         default:
 705                 break;
 706         }
 707
 708         return -EINVAL;
 709 }
 710
 711 static const struct v4l2_ctrl_ops ov2680_ctrl_ops = {
 712         .s_ctrl = ov2680_s_ctrl,
 713 };
 714
 715 static const struct v4l2_subdev_core_ops ov2680_core_ops = {
 716         .s_power = ov2680_s_power,
 717 };
 718
 719 static const struct v4l2_subdev_video_ops ov2680_video_ops = {
 720         .g_frame_interval       = ov2680_s_g_frame_interval,
 721         .s_frame_interval       = ov2680_s_g_frame_interval,
 722         .s_stream               = ov2680_s_stream,
 723 };
 724
 725 static const struct v4l2_subdev_pad_ops ov2680_pad_ops = {
 726         .init_cfg               = ov2680_init_cfg,
 727         .enum_mbus_code         = ov2680_enum_mbus_code,
 728         .get_fmt                = ov2680_get_fmt,
 729         .set_fmt                = ov2680_set_fmt,
 730         .enum_frame_size        = ov2680_enum_frame_size,
 731         .enum_frame_interval    = ov2680_enum_frame_interval,
 732 };
 733
 734 static const struct v4l2_subdev_ops ov2680_subdev_ops = {
 735         .core   = &ov2680_core_ops,
 736         .video  = &ov2680_video_ops,
 737         .pad    = &ov2680_pad_ops,
 738 };
 739
 740 static int ov2680_mode_init(struct ov2680_dev *sensor)
 741 {
 742         const struct ov2680_mode_info *init_mode;
 743
 744         /* set initial mode */
 745         sensor->fmt.code = MEDIA_BUS_FMT_SBGGR10_1X10;
 746         sensor->fmt.width = 800;
 747         sensor->fmt.height = 600;
 748         sensor->fmt.field = V4L2_FIELD_NONE;
 749         sensor->fmt.colorspace = V4L2_COLORSPACE_SRGB;
 750
 751         sensor->frame_interval.denominator = OV2680_FRAME_RATE;
 752         sensor->frame_interval.numerator = 1;
 753
 754         init_mode = &ov2680_mode_init_data;
 755
 756         sensor->current_mode = init_mode;
 757
 758         sensor->mode_pending_changes = true;
 759
 760         return 0;
 761 }
 762
 763 static int ov2680_v4l2_register(struct ov2680_dev *sensor)
 764 {
 765         const struct v4l2_ctrl_ops *ops = &ov2680_ctrl_ops;
 766         struct ov2680_ctrls *ctrls = &sensor->ctrls;
 767         struct v4l2_ctrl_handler *hdl = &ctrls->handler;
 768         int ret = 0;
 769
 770         v4l2_i2c_subdev_init(&sensor->sd, sensor->i2c_client,
 771                              &ov2680_subdev_ops);
 772
 773         sensor->sd.flags = V4L2_SUBDEV_FL_HAS_DEVNODE;
 774         sensor->pad.flags = MEDIA_PAD_FL_SOURCE;
 775         sensor->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
 776
 777         ret = media_entity_pads_init(&sensor->sd.entity, 1, &sensor->pad);
 778         if (ret < 0)
 779                 return ret;
 780
 781         v4l2_ctrl_handler_init(hdl, 5);
 782
 783         hdl->lock = &sensor->lock;
 784
 785         ctrls->vflip = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_VFLIP, 0, 1, 1, 0);
 786         ctrls->hflip = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_HFLIP, 0, 1, 1, 0);
 787
 788         ctrls->test_pattern = v4l2_ctrl_new_std_menu_items(hdl,
 789                                         &ov2680_ctrl_ops, V4L2_CID_TEST_PATTERN,
 790                                         ARRAY_SIZE(test_pattern_menu) - 1,
 791                                         0, 0, test_pattern_menu);
 792
 793         ctrls->exposure = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_EXPOSURE,
 794                                             0, 32767, 1, 0);
 795
 796         ctrls->gain = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_GAIN, 0, 2047, 1, 0);
 797
 798         if (hdl->error) {
 799                 ret = hdl->error;
 800                 goto cleanup_entity;
 801         }
 802
 803         ctrls->vflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
 804         ctrls->hflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
 805
 806         sensor->sd.ctrl_handler = hdl;
 807
 808         ret = v4l2_async_register_subdev(&sensor->sd);
 809         if (ret < 0)
 810                 goto cleanup_entity;
 811
 812         return 0;
 813
 814 cleanup_entity:
 815         media_entity_cleanup(&sensor->sd.entity);
 816         v4l2_ctrl_handler_free(hdl);
 817
 818         return ret;
 819 }
 820
 821 static int ov2680_get_regulators(struct ov2680_dev *sensor)
 822 {
 823         int i;
 824
 825         for (i = 0; i < OV2680_NUM_SUPPLIES; i++)
 826                 sensor->supplies[i].supply = ov2680_supply_name[i];
 827
 828         return devm_regulator_bulk_get(&sensor->i2c_client->dev,
 829                                        OV2680_NUM_SUPPLIES,
 830                                        sensor->supplies);
 831 }
 832
 833 static int ov2680_check_id(struct ov2680_dev *sensor)
 834 {
 835         struct device *dev = ov2680_to_dev(sensor);
 836         u32 chip_id;
 837         int ret;
 838
 839         ov2680_power_on(sensor);
 840
 841         ret = ov2680_read_reg16(sensor, OV2680_REG_CHIP_ID_HIGH, &chip_id);
 842         if (ret < 0) {
 843                 dev_err(dev, "failed to read chip id high\n");
 844                 return -ENODEV;
 845         }
 846
 847         if (chip_id != OV2680_CHIP_ID) {
 848                 dev_err(dev, "chip id: 0x%04x does not match expected 0x%04x\n",
 849                         chip_id, OV2680_CHIP_ID);
 850                 return -ENODEV;
 851         }
 852
 853         return 0;
 854 }
 855
 856 static int ov2680_parse_dt(struct ov2680_dev *sensor)
 857 {
 858         struct device *dev = ov2680_to_dev(sensor);
 859         int ret;
 860
 861         sensor->reset_gpio = devm_gpiod_get_optional(dev, "reset",
 862                                                      GPIOD_OUT_HIGH);
 863         ret = PTR_ERR_OR_ZERO(sensor->reset_gpio);
 864         if (ret < 0) {
 865                 dev_dbg(dev, "error while getting reset gpio: %d\n", ret);
 866                 return ret;
 867         }
 868
 869         sensor->xvclk = devm_clk_get(dev, "xvclk");
 870         if (IS_ERR(sensor->xvclk)) {
 871                 dev_err(dev, "xvclk clock missing or invalid\n");
 872                 return PTR_ERR(sensor->xvclk);
 873         }
 874
 875         sensor->xvclk_freq = clk_get_rate(sensor->xvclk);
 876         if (sensor->xvclk_freq != OV2680_XVCLK_VALUE) {
 877                 dev_err(dev, "wrong xvclk frequency %d HZ, expected: %d Hz\n",
 878                         sensor->xvclk_freq, OV2680_XVCLK_VALUE);
 879                 return -EINVAL;
 880         }
 881
 882         return 0;
 883 }
 884
 885 static int ov2680_probe(struct i2c_client *client)
 886 {
 887         struct device *dev = &client->dev;
 888         struct ov2680_dev *sensor;
 889         int ret;
 890
 891         sensor = devm_kzalloc(dev, sizeof(*sensor), GFP_KERNEL);
 892         if (!sensor)
 893                 return -ENOMEM;
 894
 895         sensor->i2c_client = client;
 896
 897         ret = ov2680_parse_dt(sensor);
 898         if (ret < 0)
 899                 return -EINVAL;
 900
 901         ret = ov2680_mode_init(sensor);
 902         if (ret < 0)
 903                 return ret;
 904
 905         ret = ov2680_get_regulators(sensor);
 906         if (ret < 0) {
 907                 dev_err(dev, "failed to get regulators\n");
 908                 return ret;
 909         }
 910
 911         mutex_init(&sensor->lock);
 912
 913         ret = ov2680_check_id(sensor);
 914         if (ret < 0)
 915                 goto lock_destroy;
 916
 917         ret = ov2680_v4l2_register(sensor);
 918         if (ret < 0)
 919                 goto lock_destroy;
 920
 921         dev_info(dev, "ov2680 init correctly\n");
 922
 923         return 0;
 924
 925 lock_destroy:
 926         dev_err(dev, "ov2680 init fail: %d\n", ret);
 927         mutex_destroy(&sensor->lock);
 928
 929         return ret;
 930 }
 931
 932 static void ov2680_remove(struct i2c_client *client)
 933 {
 934         struct v4l2_subdev *sd = i2c_get_clientdata(client);
 935         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 936
 937         v4l2_async_unregister_subdev(&sensor->sd);
 938         mutex_destroy(&sensor->lock);
 939         media_entity_cleanup(&sensor->sd.entity);
 940         v4l2_ctrl_handler_free(&sensor->ctrls.handler);
 941 }
 942
 943 static int __maybe_unused ov2680_suspend(struct device *dev)
 944 {
 945         struct v4l2_subdev *sd = dev_get_drvdata(dev);
 946         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 947
 948         if (sensor->is_streaming)
 949                 ov2680_stream_disable(sensor);
 950
 951         return 0;
 952 }
 953
 954 static int __maybe_unused ov2680_resume(struct device *dev)
 955 {
 956         struct v4l2_subdev *sd = dev_get_drvdata(dev);
 957         struct ov2680_dev *sensor = to_ov2680_dev(sd);
 958         int ret;
 959
 960         if (sensor->is_streaming) {
 961                 ret = ov2680_stream_enable(sensor);
 962                 if (ret < 0)
 963                         goto stream_disable;
 964         }
 965
 966         return 0;
 967
 968 stream_disable:
 969         ov2680_stream_disable(sensor);
 970         sensor->is_streaming = false;
 971
 972         return ret;
 973 }
 974
 975 static const struct dev_pm_ops ov2680_pm_ops = {
 976         SET_SYSTEM_SLEEP_PM_OPS(ov2680_suspend, ov2680_resume)
 977 };
 978
 979 static const struct of_device_id ov2680_dt_ids[] = {
 980         { .compatible = "ovti,ov2680" },
 981         { /* sentinel */ },
 982 };
 983 MODULE_DEVICE_TABLE(of, ov2680_dt_ids);
 984
 985 static struct i2c_driver ov2680_i2c_driver = {
 986         .driver = {
 987                 .name  = "ov2680",
 988                 .pm = &ov2680_pm_ops,
 989                 .of_match_table = ov2680_dt_ids,
 990         },
 991         .probe          = ov2680_probe,
 992         .remove         = ov2680_remove,
 993 };
 994 module_i2c_driver(ov2680_i2c_driver);
 995
 996 MODULE_AUTHOR("Rui Miguel Silva <rui.silva@linaro.org>");
 997 MODULE_DESCRIPTION("OV2680 CMOS Image Sensor driver");
 998 MODULE_LICENSE("GPL v2");