2 * Driver for M-5MOLS 8M Pixel camera sensor with ISP
4 * Copyright (C) 2011 Samsung Electronics Co., Ltd.
5 * Author: HeungJun Kim <riverful.kim@samsung.com>
7 * Copyright (C) 2009 Samsung Electronics Co., Ltd.
8 * Author: Dongsoo Nathaniel Kim <dongsoo45.kim@samsung.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
16 #include <linux/i2c.h>
17 #include <linux/slab.h>
18 #include <linux/irq.h>
19 #include <linux/interrupt.h>
20 #include <linux/delay.h>
21 #include <linux/gpio.h>
22 #include <linux/regulator/consumer.h>
23 #include <linux/videodev2.h>
24 #include <linux/module.h>
25 #include <media/v4l2-ctrls.h>
26 #include <media/v4l2-device.h>
27 #include <media/v4l2-subdev.h>
28 #include <media/i2c/m5mols.h>
31 #include "m5mols_reg.h"
34 module_param(m5mols_debug, int, 0644);
36 #define MODULE_NAME "M5MOLS"
37 #define M5MOLS_I2C_CHECK_RETRY 500
39 /* The regulator consumer names for external voltage regulators */
40 static struct regulator_bulk_data supplies[] = {
42 .supply = "core", /* ARM core power, 1.2V */
44 .supply = "dig_18", /* digital power 1, 1.8V */
46 .supply = "d_sensor", /* sensor power 1, 1.8V */
48 .supply = "dig_28", /* digital power 2, 2.8V */
50 .supply = "a_sensor", /* analog power */
52 .supply = "dig_12", /* digital power 3, 1.2V */
56 static struct v4l2_mbus_framefmt m5mols_default_ffmt[M5MOLS_RESTYPE_MAX] = {
57 [M5MOLS_RESTYPE_MONITOR] = {
60 .code = MEDIA_BUS_FMT_VYUY8_2X8,
61 .field = V4L2_FIELD_NONE,
62 .colorspace = V4L2_COLORSPACE_JPEG,
64 [M5MOLS_RESTYPE_CAPTURE] = {
67 .code = MEDIA_BUS_FMT_JPEG_1X8,
68 .field = V4L2_FIELD_NONE,
69 .colorspace = V4L2_COLORSPACE_JPEG,
72 #define SIZE_DEFAULT_FFMT ARRAY_SIZE(m5mols_default_ffmt)
74 static const struct m5mols_resolution m5mols_reg_res[] = {
75 { 0x01, M5MOLS_RESTYPE_MONITOR, 128, 96 }, /* SUB-QCIF */
76 { 0x03, M5MOLS_RESTYPE_MONITOR, 160, 120 }, /* QQVGA */
77 { 0x05, M5MOLS_RESTYPE_MONITOR, 176, 144 }, /* QCIF */
78 { 0x06, M5MOLS_RESTYPE_MONITOR, 176, 176 },
79 { 0x08, M5MOLS_RESTYPE_MONITOR, 240, 320 }, /* QVGA */
80 { 0x09, M5MOLS_RESTYPE_MONITOR, 320, 240 }, /* QVGA */
81 { 0x0c, M5MOLS_RESTYPE_MONITOR, 240, 400 }, /* WQVGA */
82 { 0x0d, M5MOLS_RESTYPE_MONITOR, 400, 240 }, /* WQVGA */
83 { 0x0e, M5MOLS_RESTYPE_MONITOR, 352, 288 }, /* CIF */
84 { 0x13, M5MOLS_RESTYPE_MONITOR, 480, 360 },
85 { 0x15, M5MOLS_RESTYPE_MONITOR, 640, 360 }, /* qHD */
86 { 0x17, M5MOLS_RESTYPE_MONITOR, 640, 480 }, /* VGA */
87 { 0x18, M5MOLS_RESTYPE_MONITOR, 720, 480 },
88 { 0x1a, M5MOLS_RESTYPE_MONITOR, 800, 480 }, /* WVGA */
89 { 0x1f, M5MOLS_RESTYPE_MONITOR, 800, 600 }, /* SVGA */
90 { 0x21, M5MOLS_RESTYPE_MONITOR, 1280, 720 }, /* HD */
91 { 0x25, M5MOLS_RESTYPE_MONITOR, 1920, 1080 }, /* 1080p */
92 { 0x29, M5MOLS_RESTYPE_MONITOR, 3264, 2448 }, /* 2.63fps 8M */
93 { 0x39, M5MOLS_RESTYPE_MONITOR, 800, 602 }, /* AHS_MON debug */
95 { 0x02, M5MOLS_RESTYPE_CAPTURE, 320, 240 }, /* QVGA */
96 { 0x04, M5MOLS_RESTYPE_CAPTURE, 400, 240 }, /* WQVGA */
97 { 0x07, M5MOLS_RESTYPE_CAPTURE, 480, 360 },
98 { 0x08, M5MOLS_RESTYPE_CAPTURE, 640, 360 }, /* qHD */
99 { 0x09, M5MOLS_RESTYPE_CAPTURE, 640, 480 }, /* VGA */
100 { 0x0a, M5MOLS_RESTYPE_CAPTURE, 800, 480 }, /* WVGA */
101 { 0x10, M5MOLS_RESTYPE_CAPTURE, 1280, 720 }, /* HD */
102 { 0x14, M5MOLS_RESTYPE_CAPTURE, 1280, 960 }, /* 1M */
103 { 0x17, M5MOLS_RESTYPE_CAPTURE, 1600, 1200 }, /* 2M */
104 { 0x19, M5MOLS_RESTYPE_CAPTURE, 1920, 1080 }, /* Full-HD */
105 { 0x1a, M5MOLS_RESTYPE_CAPTURE, 2048, 1152 }, /* 3Mega */
106 { 0x1b, M5MOLS_RESTYPE_CAPTURE, 2048, 1536 },
107 { 0x1c, M5MOLS_RESTYPE_CAPTURE, 2560, 1440 }, /* 4Mega */
108 { 0x1d, M5MOLS_RESTYPE_CAPTURE, 2560, 1536 },
109 { 0x1f, M5MOLS_RESTYPE_CAPTURE, 2560, 1920 }, /* 5Mega */
110 { 0x21, M5MOLS_RESTYPE_CAPTURE, 3264, 1836 }, /* 6Mega */
111 { 0x22, M5MOLS_RESTYPE_CAPTURE, 3264, 1960 },
112 { 0x25, M5MOLS_RESTYPE_CAPTURE, 3264, 2448 }, /* 8Mega */
116 * m5mols_swap_byte - an byte array to integer conversion function
118 * @length: size in bytes of I2C packet defined in the M-5MOLS datasheet
120 * Convert I2C data byte array with performing any required byte
121 * reordering to assure proper values for each data type, regardless
122 * of the architecture endianness.
124 static u32 m5mols_swap_byte(u8 *data, u8 length)
128 else if (length == 2)
129 return be16_to_cpu(*((__be16 *)data));
131 return be32_to_cpu(*((__be32 *)data));
135 * m5mols_read - I2C read function
136 * @sd: sub-device, as pointed by struct v4l2_subdev
137 * @size: desired size of I2C packet
138 * @reg: combination of size, category and command for the I2C packet
141 * Returns 0 on success, or else negative errno.
143 static int m5mols_read(struct v4l2_subdev *sd, u32 size, u32 reg, u32 *val)
145 struct i2c_client *client = v4l2_get_subdevdata(sd);
146 struct m5mols_info *info = to_m5mols(sd);
147 u8 rbuf[M5MOLS_I2C_MAX_SIZE + 1];
148 u8 category = I2C_CATEGORY(reg);
149 u8 cmd = I2C_COMMAND(reg);
150 struct i2c_msg msg[2];
154 if (!client->adapter)
157 msg[0].addr = client->addr;
162 wbuf[1] = M5MOLS_BYTE_READ;
167 msg[1].addr = client->addr;
168 msg[1].flags = I2C_M_RD;
169 msg[1].len = size + 1;
172 /* minimum stabilization time */
173 usleep_range(200, 300);
175 ret = i2c_transfer(client->adapter, msg, 2);
178 *val = m5mols_swap_byte(&rbuf[1], size);
183 v4l2_err(sd, "read failed: size:%d cat:%02x cmd:%02x. %d\n",
184 size, category, cmd, ret);
186 return ret < 0 ? ret : -EIO;
189 int m5mols_read_u8(struct v4l2_subdev *sd, u32 reg, u8 *val)
194 if (I2C_SIZE(reg) != 1) {
195 v4l2_err(sd, "Wrong data size\n");
199 ret = m5mols_read(sd, I2C_SIZE(reg), reg, &val_32);
207 int m5mols_read_u16(struct v4l2_subdev *sd, u32 reg, u16 *val)
212 if (I2C_SIZE(reg) != 2) {
213 v4l2_err(sd, "Wrong data size\n");
217 ret = m5mols_read(sd, I2C_SIZE(reg), reg, &val_32);
225 int m5mols_read_u32(struct v4l2_subdev *sd, u32 reg, u32 *val)
227 if (I2C_SIZE(reg) != 4) {
228 v4l2_err(sd, "Wrong data size\n");
232 return m5mols_read(sd, I2C_SIZE(reg), reg, val);
236 * m5mols_write - I2C command write function
237 * @sd: sub-device, as pointed by struct v4l2_subdev
238 * @reg: combination of size, category and command for the I2C packet
239 * @val: value to write
241 * Returns 0 on success, or else negative errno.
243 int m5mols_write(struct v4l2_subdev *sd, u32 reg, u32 val)
245 struct i2c_client *client = v4l2_get_subdevdata(sd);
246 struct m5mols_info *info = to_m5mols(sd);
247 u8 wbuf[M5MOLS_I2C_MAX_SIZE + 4];
248 u8 category = I2C_CATEGORY(reg);
249 u8 cmd = I2C_COMMAND(reg);
250 u8 size = I2C_SIZE(reg);
251 u32 *buf = (u32 *)&wbuf[4];
252 struct i2c_msg msg[1];
255 if (!client->adapter)
258 if (size != 1 && size != 2 && size != 4) {
259 v4l2_err(sd, "Wrong data size\n");
263 msg->addr = client->addr;
265 msg->len = (u16)size + 4;
268 wbuf[1] = M5MOLS_BYTE_WRITE;
272 *buf = m5mols_swap_byte((u8 *)&val, size);
274 /* minimum stabilization time */
275 usleep_range(200, 300);
277 ret = i2c_transfer(client->adapter, msg, 1);
282 v4l2_err(sd, "write failed: cat:%02x cmd:%02x ret:%d\n",
285 return ret < 0 ? ret : -EIO;
289 * m5mols_busy_wait - Busy waiting with I2C register polling
290 * @sd: sub-device, as pointed by struct v4l2_subdev
291 * @reg: the I2C_REG() address of an 8-bit status register to check
292 * @value: expected status register value
293 * @mask: bit mask for the read status register value
294 * @timeout: timeout in miliseconds, or -1 for default timeout
296 * The @reg register value is ORed with @mask before comparing with @value.
298 * Return: 0 if the requested condition became true within less than
299 * @timeout ms, or else negative errno.
301 int m5mols_busy_wait(struct v4l2_subdev *sd, u32 reg, u32 value, u32 mask,
304 int ms = timeout < 0 ? M5MOLS_BUSY_WAIT_DEF_TIMEOUT : timeout;
305 unsigned long end = jiffies + msecs_to_jiffies(ms);
309 int ret = m5mols_read_u8(sd, reg, &status);
311 if (ret < 0 && !(mask & M5MOLS_I2C_RDY_WAIT_FL))
313 if (!ret && (status & mask & 0xff) == (value & 0xff))
315 usleep_range(100, 250);
316 } while (ms > 0 && time_is_after_jiffies(end));
322 * m5mols_enable_interrupt - Clear interrupt pending bits and unmask interrupts
323 * @sd: sub-device, as pointed by struct v4l2_subdev
324 * @reg: combination of size, category and command for the I2C packet
326 * Before writing desired interrupt value the INT_FACTOR register should
327 * be read to clear pending interrupts.
329 int m5mols_enable_interrupt(struct v4l2_subdev *sd, u8 reg)
331 struct m5mols_info *info = to_m5mols(sd);
332 u8 mask = is_available_af(info) ? REG_INT_AF : 0;
336 ret = m5mols_read_u8(sd, SYSTEM_INT_FACTOR, &dummy);
338 ret = m5mols_write(sd, SYSTEM_INT_ENABLE, reg & ~mask);
342 int m5mols_wait_interrupt(struct v4l2_subdev *sd, u8 irq_mask, u32 timeout)
344 struct m5mols_info *info = to_m5mols(sd);
346 int ret = wait_event_interruptible_timeout(info->irq_waitq,
347 atomic_add_unless(&info->irq_done, -1, 0),
348 msecs_to_jiffies(timeout));
350 return ret ? ret : -ETIMEDOUT;
352 return m5mols_busy_wait(sd, SYSTEM_INT_FACTOR, irq_mask,
353 M5MOLS_I2C_RDY_WAIT_FL | irq_mask, -1);
357 * m5mols_reg_mode - Write the mode and check busy status
358 * @sd: sub-device, as pointed by struct v4l2_subdev
359 * @mode: the required operation mode
361 * It always accompanies a little delay changing the M-5MOLS mode, so it is
362 * needed checking current busy status to guarantee right mode.
364 static int m5mols_reg_mode(struct v4l2_subdev *sd, u8 mode)
366 int ret = m5mols_write(sd, SYSTEM_SYSMODE, mode);
369 return m5mols_busy_wait(sd, SYSTEM_SYSMODE, mode, 0xff,
370 M5MOLS_MODE_CHANGE_TIMEOUT);
374 * m5mols_set_mode - set the M-5MOLS controller mode
375 * @info: M-5MOLS driver data structure
376 * @mode: the required operation mode
378 * The commands of M-5MOLS are grouped into specific modes. Each functionality
379 * can be guaranteed only when the sensor is operating in mode which a command
382 int m5mols_set_mode(struct m5mols_info *info, u8 mode)
384 struct v4l2_subdev *sd = &info->sd;
388 if (mode < REG_PARAMETER || mode > REG_CAPTURE)
391 ret = m5mols_read_u8(sd, SYSTEM_SYSMODE, ®);
392 if (ret || reg == mode)
397 ret = m5mols_reg_mode(sd, REG_MONITOR);
398 if (mode == REG_MONITOR)
401 ret = m5mols_reg_mode(sd, REG_CAPTURE);
405 if (mode == REG_PARAMETER) {
406 ret = m5mols_reg_mode(sd, REG_PARAMETER);
410 ret = m5mols_reg_mode(sd, REG_CAPTURE);
414 ret = m5mols_reg_mode(sd, REG_MONITOR);
415 if (mode == REG_MONITOR)
418 ret = m5mols_reg_mode(sd, REG_PARAMETER);
422 v4l2_warn(sd, "Wrong mode: %d\n", mode);
432 * m5mols_get_version - retrieve full revisions information of M-5MOLS
433 * @sd: sub-device, as pointed by struct v4l2_subdev
435 * The version information includes revisions of hardware and firmware,
436 * AutoFocus alghorithm version and the version string.
438 static int m5mols_get_version(struct v4l2_subdev *sd)
440 struct m5mols_info *info = to_m5mols(sd);
441 struct m5mols_version *ver = &info->ver;
446 ret = m5mols_read_u8(sd, SYSTEM_VER_CUSTOMER, &ver->customer);
448 ret = m5mols_read_u8(sd, SYSTEM_VER_PROJECT, &ver->project);
450 ret = m5mols_read_u16(sd, SYSTEM_VER_FIRMWARE, &ver->fw);
452 ret = m5mols_read_u16(sd, SYSTEM_VER_HARDWARE, &ver->hw);
454 ret = m5mols_read_u16(sd, SYSTEM_VER_PARAMETER, &ver->param);
456 ret = m5mols_read_u16(sd, SYSTEM_VER_AWB, &ver->awb);
458 ret = m5mols_read_u8(sd, AF_VERSION, &ver->af);
462 for (i = 0; i < VERSION_STRING_SIZE; i++) {
463 ret = m5mols_read_u8(sd, SYSTEM_VER_STRING, &str[i]);
468 v4l2_info(sd, "Manufacturer\t[%s]\n",
469 is_manufacturer(info, REG_SAMSUNG_ELECTRO) ?
470 "Samsung Electro-Mechanics" :
471 is_manufacturer(info, REG_SAMSUNG_OPTICS) ?
472 "Samsung Fiber-Optics" :
473 is_manufacturer(info, REG_SAMSUNG_TECHWIN) ?
474 "Samsung Techwin" : "None");
475 v4l2_info(sd, "Customer/Project\t[0x%02x/0x%02x]\n",
476 info->ver.customer, info->ver.project);
478 if (!is_available_af(info))
479 v4l2_info(sd, "No support Auto Focus on this firmware\n");
485 * __find_restype - Lookup M-5MOLS resolution type according to pixel code
488 static enum m5mols_restype __find_restype(u32 code)
490 enum m5mols_restype type = M5MOLS_RESTYPE_MONITOR;
493 if (code == m5mols_default_ffmt[type].code)
495 } while (++type != SIZE_DEFAULT_FFMT);
501 * __find_resolution - Lookup preset and type of M-5MOLS's resolution
502 * @sd: sub-device, as pointed by struct v4l2_subdev
503 * @mf: pixel format to find/negotiate the resolution preset for
504 * @type: M-5MOLS resolution type
505 * @resolution: M-5MOLS resolution preset register value
507 * Find nearest resolution matching resolution preset and adjust mf
508 * to supported values.
510 static int __find_resolution(struct v4l2_subdev *sd,
511 struct v4l2_mbus_framefmt *mf,
512 enum m5mols_restype *type,
515 const struct m5mols_resolution *fsize = &m5mols_reg_res[0];
516 const struct m5mols_resolution *match = NULL;
517 enum m5mols_restype stype = __find_restype(mf->code);
518 int i = ARRAY_SIZE(m5mols_reg_res);
519 unsigned int min_err = ~0;
523 if (stype == fsize->type) {
524 err = abs(fsize->width - mf->width)
525 + abs(fsize->height - mf->height);
535 mf->width = match->width;
536 mf->height = match->height;
537 *resolution = match->reg;
545 static struct v4l2_mbus_framefmt *__find_format(struct m5mols_info *info,
546 struct v4l2_subdev_pad_config *cfg,
547 enum v4l2_subdev_format_whence which,
548 enum m5mols_restype type)
550 if (which == V4L2_SUBDEV_FORMAT_TRY)
551 return cfg ? v4l2_subdev_get_try_format(&info->sd, cfg, 0) : NULL;
553 return &info->ffmt[type];
556 static int m5mols_get_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_pad_config *cfg,
557 struct v4l2_subdev_format *fmt)
559 struct m5mols_info *info = to_m5mols(sd);
560 struct v4l2_mbus_framefmt *format;
563 mutex_lock(&info->lock);
565 format = __find_format(info, cfg, fmt->which, info->res_type);
567 fmt->format = *format;
571 mutex_unlock(&info->lock);
575 static int m5mols_set_fmt(struct v4l2_subdev *sd, struct v4l2_subdev_pad_config *cfg,
576 struct v4l2_subdev_format *fmt)
578 struct m5mols_info *info = to_m5mols(sd);
579 struct v4l2_mbus_framefmt *format = &fmt->format;
580 struct v4l2_mbus_framefmt *sfmt;
581 enum m5mols_restype type;
585 ret = __find_resolution(sd, format, &type, &resolution);
589 sfmt = __find_format(info, cfg, fmt->which, type);
593 mutex_lock(&info->lock);
595 format->code = m5mols_default_ffmt[type].code;
596 format->colorspace = V4L2_COLORSPACE_JPEG;
597 format->field = V4L2_FIELD_NONE;
599 if (fmt->which == V4L2_SUBDEV_FORMAT_ACTIVE) {
601 info->resolution = resolution;
602 info->res_type = type;
605 mutex_unlock(&info->lock);
609 static int m5mols_get_frame_desc(struct v4l2_subdev *sd, unsigned int pad,
610 struct v4l2_mbus_frame_desc *fd)
612 struct m5mols_info *info = to_m5mols(sd);
614 if (pad != 0 || fd == NULL)
617 mutex_lock(&info->lock);
619 * .get_frame_desc is only used for compressed formats,
620 * thus we always return the capture frame parameters here.
622 fd->entry[0].length = info->cap.buf_size;
623 fd->entry[0].pixelcode = info->ffmt[M5MOLS_RESTYPE_CAPTURE].code;
624 mutex_unlock(&info->lock);
626 fd->entry[0].flags = V4L2_MBUS_FRAME_DESC_FL_LEN_MAX;
632 static int m5mols_set_frame_desc(struct v4l2_subdev *sd, unsigned int pad,
633 struct v4l2_mbus_frame_desc *fd)
635 struct m5mols_info *info = to_m5mols(sd);
636 struct v4l2_mbus_framefmt *mf = &info->ffmt[M5MOLS_RESTYPE_CAPTURE];
638 if (pad != 0 || fd == NULL)
641 fd->entry[0].flags = V4L2_MBUS_FRAME_DESC_FL_LEN_MAX;
643 fd->entry[0].length = clamp_t(u32, fd->entry[0].length,
644 mf->width * mf->height,
645 M5MOLS_MAIN_JPEG_SIZE_MAX);
646 mutex_lock(&info->lock);
647 info->cap.buf_size = fd->entry[0].length;
648 mutex_unlock(&info->lock);
654 static int m5mols_enum_mbus_code(struct v4l2_subdev *sd,
655 struct v4l2_subdev_pad_config *cfg,
656 struct v4l2_subdev_mbus_code_enum *code)
658 if (!code || code->index >= SIZE_DEFAULT_FFMT)
661 code->code = m5mols_default_ffmt[code->index].code;
666 static const struct v4l2_subdev_pad_ops m5mols_pad_ops = {
667 .enum_mbus_code = m5mols_enum_mbus_code,
668 .get_fmt = m5mols_get_fmt,
669 .set_fmt = m5mols_set_fmt,
670 .get_frame_desc = m5mols_get_frame_desc,
671 .set_frame_desc = m5mols_set_frame_desc,
675 * m5mols_restore_controls - Apply current control values to the registers
676 * @info: M-5MOLS driver data structure
678 * m5mols_do_scenemode() handles all parameters for which there is yet no
679 * individual control. It should be replaced at some point by setting each
680 * control individually, in required register set up order.
682 int m5mols_restore_controls(struct m5mols_info *info)
689 ret = m5mols_do_scenemode(info, REG_SCENE_NORMAL);
693 ret = v4l2_ctrl_handler_setup(&info->handle);
694 info->ctrl_sync = !ret;
700 * m5mols_start_monitor - Start the monitor mode
701 * @info: M-5MOLS driver data structure
703 * Before applying the controls setup the resolution and frame rate
704 * in PARAMETER mode, and then switch over to MONITOR mode.
706 static int m5mols_start_monitor(struct m5mols_info *info)
708 struct v4l2_subdev *sd = &info->sd;
711 ret = m5mols_set_mode(info, REG_PARAMETER);
713 ret = m5mols_write(sd, PARM_MON_SIZE, info->resolution);
715 ret = m5mols_write(sd, PARM_MON_FPS, REG_FPS_30);
717 ret = m5mols_set_mode(info, REG_MONITOR);
719 ret = m5mols_restore_controls(info);
724 static int m5mols_s_stream(struct v4l2_subdev *sd, int enable)
726 struct m5mols_info *info = to_m5mols(sd);
730 mutex_lock(&info->lock);
731 code = info->ffmt[info->res_type].code;
734 if (is_code(code, M5MOLS_RESTYPE_MONITOR))
735 ret = m5mols_start_monitor(info);
736 else if (is_code(code, M5MOLS_RESTYPE_CAPTURE))
737 ret = m5mols_start_capture(info);
741 ret = m5mols_set_mode(info, REG_PARAMETER);
744 mutex_unlock(&info->lock);
748 static const struct v4l2_subdev_video_ops m5mols_video_ops = {
749 .s_stream = m5mols_s_stream,
752 static int m5mols_sensor_power(struct m5mols_info *info, bool enable)
754 struct v4l2_subdev *sd = &info->sd;
755 struct i2c_client *client = v4l2_get_subdevdata(sd);
756 const struct m5mols_platform_data *pdata = info->pdata;
759 if (info->power == enable)
763 if (info->set_power) {
764 ret = info->set_power(&client->dev, 1);
769 ret = regulator_bulk_enable(ARRAY_SIZE(supplies), supplies);
772 info->set_power(&client->dev, 0);
776 gpio_set_value(pdata->gpio_reset, !pdata->reset_polarity);
782 ret = regulator_bulk_disable(ARRAY_SIZE(supplies), supplies);
787 info->set_power(&client->dev, 0);
789 gpio_set_value(pdata->gpio_reset, pdata->reset_polarity);
797 /* m5mols_update_fw - optional firmware update routine */
798 int __attribute__ ((weak)) m5mols_update_fw(struct v4l2_subdev *sd,
799 int (*set_power)(struct m5mols_info *, bool))
805 * m5mols_fw_start - M-5MOLS internal ARM controller initialization
806 * @sd: sub-device, as pointed by struct v4l2_subdev
808 * Execute the M-5MOLS internal ARM controller initialization sequence.
809 * This function should be called after the supply voltage has been
810 * applied and before any requests to the device are made.
812 static int m5mols_fw_start(struct v4l2_subdev *sd)
814 struct m5mols_info *info = to_m5mols(sd);
817 atomic_set(&info->irq_done, 0);
818 /* Wait until I2C slave is initialized in Flash Writer mode */
819 ret = m5mols_busy_wait(sd, FLASH_CAM_START, REG_IN_FLASH_MODE,
820 M5MOLS_I2C_RDY_WAIT_FL | 0xff, -1);
822 ret = m5mols_write(sd, FLASH_CAM_START, REG_START_ARM_BOOT);
824 ret = m5mols_wait_interrupt(sd, REG_INT_MODE, 2000);
830 ret = m5mols_get_version(sd);
832 ret = m5mols_update_fw(sd, m5mols_sensor_power);
836 v4l2_dbg(1, m5mols_debug, sd, "Success ARM Booting\n");
838 ret = m5mols_write(sd, PARM_INTERFACE, REG_INTERFACE_MIPI);
840 ret = m5mols_enable_interrupt(sd,
841 REG_INT_AF | REG_INT_CAPTURE);
846 /* Execute the lens soft-landing algorithm */
847 static int m5mols_auto_focus_stop(struct m5mols_info *info)
851 ret = m5mols_write(&info->sd, AF_EXECUTE, REG_AF_STOP);
853 ret = m5mols_write(&info->sd, AF_MODE, REG_AF_POWEROFF);
855 ret = m5mols_busy_wait(&info->sd, SYSTEM_STATUS, REG_AF_IDLE,
861 * m5mols_s_power - Main sensor power control function
862 * @sd: sub-device, as pointed by struct v4l2_subdev
863 * @on: if true, powers on the device; powers off otherwise.
865 * To prevent breaking the lens when the sensor is powered off the Soft-Landing
866 * algorithm is called where available. The Soft-Landing algorithm availability
867 * dependends on the firmware provider.
869 static int m5mols_s_power(struct v4l2_subdev *sd, int on)
871 struct m5mols_info *info = to_m5mols(sd);
874 mutex_lock(&info->lock);
877 ret = m5mols_sensor_power(info, true);
879 ret = m5mols_fw_start(sd);
881 if (is_manufacturer(info, REG_SAMSUNG_TECHWIN)) {
882 ret = m5mols_set_mode(info, REG_MONITOR);
884 ret = m5mols_auto_focus_stop(info);
886 v4l2_warn(sd, "Soft landing lens failed\n");
888 ret = m5mols_sensor_power(info, false);
893 mutex_unlock(&info->lock);
897 static int m5mols_log_status(struct v4l2_subdev *sd)
899 struct m5mols_info *info = to_m5mols(sd);
901 v4l2_ctrl_handler_log_status(&info->handle, sd->name);
906 static const struct v4l2_subdev_core_ops m5mols_core_ops = {
907 .s_power = m5mols_s_power,
908 .log_status = m5mols_log_status,
912 * V4L2 subdev internal operations
914 static int m5mols_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
916 struct v4l2_mbus_framefmt *format = v4l2_subdev_get_try_format(sd, fh->pad, 0);
918 *format = m5mols_default_ffmt[0];
922 static const struct v4l2_subdev_internal_ops m5mols_subdev_internal_ops = {
926 static const struct v4l2_subdev_ops m5mols_ops = {
927 .core = &m5mols_core_ops,
928 .pad = &m5mols_pad_ops,
929 .video = &m5mols_video_ops,
932 static irqreturn_t m5mols_irq_handler(int irq, void *data)
934 struct m5mols_info *info = to_m5mols(data);
936 atomic_set(&info->irq_done, 1);
937 wake_up_interruptible(&info->irq_waitq);
942 static int m5mols_probe(struct i2c_client *client,
943 const struct i2c_device_id *id)
945 const struct m5mols_platform_data *pdata = client->dev.platform_data;
946 unsigned long gpio_flags;
947 struct m5mols_info *info;
948 struct v4l2_subdev *sd;
952 dev_err(&client->dev, "No platform data\n");
956 if (!gpio_is_valid(pdata->gpio_reset)) {
957 dev_err(&client->dev, "No valid RESET GPIO specified\n");
962 dev_err(&client->dev, "Interrupt not assigned\n");
966 info = devm_kzalloc(&client->dev, sizeof(*info), GFP_KERNEL);
971 info->set_power = pdata->set_power;
973 gpio_flags = pdata->reset_polarity
974 ? GPIOF_OUT_INIT_HIGH : GPIOF_OUT_INIT_LOW;
975 ret = devm_gpio_request_one(&client->dev, pdata->gpio_reset, gpio_flags,
978 dev_err(&client->dev, "Failed to request gpio: %d\n", ret);
982 ret = devm_regulator_bulk_get(&client->dev, ARRAY_SIZE(supplies),
985 dev_err(&client->dev, "Failed to get regulators: %d\n", ret);
990 v4l2_i2c_subdev_init(sd, client, &m5mols_ops);
991 strlcpy(sd->name, MODULE_NAME, sizeof(sd->name));
992 sd->flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
994 sd->internal_ops = &m5mols_subdev_internal_ops;
995 info->pad.flags = MEDIA_PAD_FL_SOURCE;
996 ret = media_entity_pads_init(&sd->entity, 1, &info->pad);
999 sd->entity.function = MEDIA_ENT_F_CAM_SENSOR;
1001 init_waitqueue_head(&info->irq_waitq);
1002 mutex_init(&info->lock);
1004 ret = devm_request_irq(&client->dev, client->irq, m5mols_irq_handler,
1005 IRQF_TRIGGER_RISING, MODULE_NAME, sd);
1007 dev_err(&client->dev, "Interrupt request failed: %d\n", ret);
1010 info->res_type = M5MOLS_RESTYPE_MONITOR;
1011 info->ffmt[0] = m5mols_default_ffmt[0];
1012 info->ffmt[1] = m5mols_default_ffmt[1];
1014 ret = m5mols_sensor_power(info, true);
1018 ret = m5mols_fw_start(sd);
1020 ret = m5mols_init_controls(sd);
1022 ret = m5mols_sensor_power(info, false);
1026 media_entity_cleanup(&sd->entity);
1030 static int m5mols_remove(struct i2c_client *client)
1032 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1034 v4l2_device_unregister_subdev(sd);
1035 v4l2_ctrl_handler_free(sd->ctrl_handler);
1036 media_entity_cleanup(&sd->entity);
1041 static const struct i2c_device_id m5mols_id[] = {
1045 MODULE_DEVICE_TABLE(i2c, m5mols_id);
1047 static struct i2c_driver m5mols_i2c_driver = {
1049 .name = MODULE_NAME,
1051 .probe = m5mols_probe,
1052 .remove = m5mols_remove,
1053 .id_table = m5mols_id,
1056 module_i2c_driver(m5mols_i2c_driver);
1058 MODULE_AUTHOR("HeungJun Kim <riverful.kim@samsung.com>");
1059 MODULE_AUTHOR("Dongsoo Kim <dongsoo45.kim@samsung.com>");
1060 MODULE_DESCRIPTION("Fujitsu M-5MOLS 8M Pixel camera driver");
1061 MODULE_LICENSE("GPL");