xref: /OK3568_Linux_fs/kernel/drivers/media/i2c/max96714.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)

// SPDX-License-Identifier: GPL-2.0
/*
 * max96714 GMSL2/GMSL1 to CSI-2 Deserializer driver
 *
 * Copyright (C) 2022 Rockchip Electronics Co., Ltd.
 *
 * V0.0X01.0X00 first version.
 *
 */

#include <linux/clk.h>
#include <linux/device.h>
#include <linux/delay.h>
#include <linux/gpio/consumer.h>
#include <linux/i2c.h>
#include <linux/module.h>
#include <linux/pm_runtime.h>
#include <linux/regulator/consumer.h>
#include <linux/sysfs.h>
#include <linux/slab.h>
#include <linux/version.h>
#include <linux/compat.h>
#include <linux/rk-camera-module.h>
#include <media/media-entity.h>
#include <media/v4l2-async.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-subdev.h>
#include <linux/pinctrl/consumer.h>
#include "max96714.h"

#define DRIVER_VERSION			KERNEL_VERSION(0, 0x01, 0x00)

#ifndef V4L2_CID_DIGITAL_GAIN
#define V4L2_CID_DIGITAL_GAIN		V4L2_CID_GAIN
#endif

#define MAX96714_LINK_FREQ_150MHZ	150000000UL
/* pixel rate = link frequency * 2 * lanes / BITS_PER_SAMPLE */
#define MAX96714_PIXEL_RATE		(MAX96714_LINK_FREQ_150MHZ * 2LL * 4LL / 8LL)
#define MAX96714_XVCLK_FREQ		24000000

#define CHIP_ID				0xC9
#define MAX96714_REG_CHIP_ID		0x0D

#define MAX96714_REG_CTRL_MODE		0x0313
#define MAX96714_MODE_SW_STANDBY	0x0
#define MAX96714_MODE_STREAMING		BIT(1)

#define REG_NULL			0xFFFF

#define MAX96714_LANES			4
#define MAX96714_BITS_PER_SAMPLE	8

#define OF_CAMERA_PINCTRL_STATE_DEFAULT	"rockchip,camera_default"
#define OF_CAMERA_PINCTRL_STATE_SLEEP	"rockchip,camera_sleep"

#define MAX96714_REG_VALUE_08BIT	1
#define MAX96714_REG_VALUE_16BIT	2
#define MAX96714_REG_VALUE_24BIT	3

#define MAX96714_NAME			"max96714"
#define MAX96714_MEDIA_BUS_FMT		MEDIA_BUS_FMT_UYVY8_2X8

static const char * const max96714_supply_names[] = {
	"avdd",		/* Analog power */
	"dovdd",	/* Digital I/O power */
	"dvdd",		/* Digital core power */
};

#define MAX96714_NUM_SUPPLIES ARRAY_SIZE(max96714_supply_names)

struct regval {
	u16 i2c_addr;
	u16 addr;
	u8 val;
	u16 delay;
};

struct max96714_mode {
	u32 width;
	u32 height;
	struct v4l2_fract max_fps;
	u32 hts_def;
	u32 vts_def;
	u32 exp_def;
	u32 link_freq_idx;
	u32 bpp;
	const struct regval *reg_list;
};

struct max96714 {
	struct i2c_client	*client;
	struct clk		*xvclk;
	struct gpio_desc	*power_gpio;
	struct gpio_desc	*reset_gpio;
	struct gpio_desc	*pwdn_gpio;
	struct regulator_bulk_data supplies[MAX96714_NUM_SUPPLIES];

	struct pinctrl		*pinctrl;
	struct pinctrl_state	*pins_default;
	struct pinctrl_state	*pins_sleep;

	struct v4l2_subdev	subdev;
	struct media_pad	pad;
	struct v4l2_ctrl_handler ctrl_handler;
	struct v4l2_ctrl	*exposure;
	struct v4l2_ctrl	*anal_gain;
	struct v4l2_ctrl	*digi_gain;
	struct v4l2_ctrl	*hblank;
	struct v4l2_ctrl	*vblank;
	struct v4l2_ctrl	*pixel_rate;
	struct v4l2_ctrl	*link_freq;
	struct v4l2_ctrl	*test_pattern;
	struct mutex		mutex;
	bool			streaming;
	bool			power_on;
	bool			hot_plug;
	u8			is_reset;
	const struct max96714_mode *cur_mode;
	u32			module_index;
	const char		*module_facing;
	const char		*module_name;
	const char		*len_name;
};

#define to_max96714(sd) container_of(sd, struct max96714, subdev)

static const struct regval max96714_mipi_1080p_30fps[] = {
	{0x4C, 0x0313, 0x00, 0x00},
	{0x4C, 0x0001, 0x01, 0x00},
	{0x4C, 0x0010, 0x21, 0x00},
	{0x4C, 0x0320, 0x23, 0x00},
	{0x4C, 0x0325, 0x80, 0x00},
	{0x4C, 0x0313, 0x00, 0x00},
	{0x4C, REG_NULL, 0x00, 0x00},
};

static const struct max96714_mode supported_modes[] = {
	{
		.width = 1920,
		.height = 1080,
		.max_fps = {
			.numerator = 10000,
			.denominator = 300000,
		},
		.reg_list = max96714_mipi_1080p_30fps,
		.link_freq_idx = 0,
	},
};

static const s64 link_freq_items[] = {
	MAX96714_LINK_FREQ_150MHZ,
};

/* Write registers up to 4 at a time */
static int max96714_write_reg(struct i2c_client *client, u16 reg,
			     u32 len, u32 val)
{
	u32 buf_i, val_i;
	u8 buf[6];
	u8 *val_p;
	__be32 val_be;

	dev_dbg(&client->dev, "write reg(0x%x val:0x%x)!\n", reg, val);

	if (len > 4)
		return -EINVAL;

	buf[0] = reg >> 8;
	buf[1] = reg & 0xff;

	val_be = cpu_to_be32(val);
	val_p = (u8 *)&val_be;
	buf_i = 2;
	val_i = 4 - len;

	while (val_i < 4)
		buf[buf_i++] = val_p[val_i++];

	if (i2c_master_send(client, buf, len + 2) != len + 2)
		return -EIO;

	return 0;
}

static int max96714_write_array(struct i2c_client *client,
			       const struct regval *regs)
{
	u32 i;
	int ret = 0;

	for (i = 0; ret == 0 && regs[i].addr != REG_NULL; i++) {
		client->addr = regs[i].i2c_addr;
		ret = max96714_write_reg(client, regs[i].addr,
					MAX96714_REG_VALUE_08BIT,
					regs[i].val);
		msleep(regs[i].delay);
	}

	return ret;
}

/* Read registers up to 4 at a time */
static int max96714_read_reg(struct i2c_client *client, u16 reg,
			    unsigned int len, u32 *val)
{
	struct i2c_msg msgs[2];
	u8 *data_be_p;
	__be32 data_be = 0;
	__be16 reg_addr_be = cpu_to_be16(reg);
	int ret;

	if (len > 4 || !len)
		return -EINVAL;

	data_be_p = (u8 *)&data_be;
	/* Write register address */
	msgs[0].addr = client->addr;
	msgs[0].flags = 0;
	msgs[0].len = 2;
	msgs[0].buf = (u8 *)&reg_addr_be;

	/* Read data from register */
	msgs[1].addr = client->addr;
	msgs[1].flags = I2C_M_RD;
	msgs[1].len = len;
	msgs[1].buf = &data_be_p[4 - len];

	ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
	if (ret != ARRAY_SIZE(msgs))
		return -EIO;

	*val = be32_to_cpu(data_be);

	return 0;
}

static int max96714_get_reso_dist(const struct max96714_mode *mode,
				 struct v4l2_mbus_framefmt *framefmt)
{
	return abs(mode->width - framefmt->width) +
		abs(mode->height - framefmt->height);
}

static const struct max96714_mode *
max96714_find_best_fit(struct v4l2_subdev_format *fmt)
{
	struct v4l2_mbus_framefmt *framefmt = &fmt->format;
	int dist;
	int cur_best_fit = 0;
	int cur_best_fit_dist = -1;
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(supported_modes); i++) {
		dist = max96714_get_reso_dist(&supported_modes[i], framefmt);
		if (cur_best_fit_dist == -1 || dist < cur_best_fit_dist) {
			cur_best_fit_dist = dist;
			cur_best_fit = i;
		}
	}

	return &supported_modes[cur_best_fit];
}

static int max96714_set_fmt(struct v4l2_subdev *sd,
			   struct v4l2_subdev_pad_config *cfg,
			  struct v4l2_subdev_format *fmt)
{
	struct max96714 *max96714 = to_max96714(sd);
	const struct max96714_mode *mode;

	mutex_lock(&max96714->mutex);

	mode = max96714_find_best_fit(fmt);
	fmt->format.code = MAX96714_MEDIA_BUS_FMT;
	fmt->format.width = mode->width;
	fmt->format.height = mode->height;
	fmt->format.field = V4L2_FIELD_NONE;
	if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
#ifdef CONFIG_VIDEO_V4L2_SUBDEV_API
		*v4l2_subdev_get_try_format(sd, cfg, fmt->pad) = fmt->format;
#else
		mutex_unlock(&max96714->mutex);
		return -ENOTTY;
#endif
	} else {
		if (max96714->streaming) {
			mutex_unlock(&max96714->mutex);
			return -EBUSY;
		}
	}

	mutex_unlock(&max96714->mutex);

	return 0;
}

static int max96714_get_fmt(struct v4l2_subdev *sd,
			   struct v4l2_subdev_pad_config *cfg,
			   struct v4l2_subdev_format *fmt)
{
	struct max96714 *max96714 = to_max96714(sd);
	const struct max96714_mode *mode = max96714->cur_mode;

	mutex_lock(&max96714->mutex);
	if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
#ifdef CONFIG_VIDEO_V4L2_SUBDEV_API
		fmt->format = *v4l2_subdev_get_try_format(sd, cfg, fmt->pad);
#else
		mutex_unlock(&max96714->mutex);
		return -ENOTTY;
#endif
	} else {
		fmt->format.width = mode->width;
		fmt->format.height = mode->height;
		fmt->format.code = MAX96714_MEDIA_BUS_FMT;
		fmt->format.field = V4L2_FIELD_NONE;
	}
	mutex_unlock(&max96714->mutex);

	return 0;
}

static int max96714_enum_mbus_code(struct v4l2_subdev *sd,
				  struct v4l2_subdev_pad_config *cfg,
				  struct v4l2_subdev_mbus_code_enum *code)
{
	if (code->index != 0)
		return -EINVAL;
	code->code = MAX96714_MEDIA_BUS_FMT;

	return 0;
}

static int max96714_enum_frame_sizes(struct v4l2_subdev *sd,
				    struct v4l2_subdev_pad_config *cfg,
				   struct v4l2_subdev_frame_size_enum *fse)
{
	if (fse->index >= ARRAY_SIZE(supported_modes))
		return -EINVAL;

	if (fse->code != MAX96714_MEDIA_BUS_FMT)
		return -EINVAL;

	fse->min_width  = supported_modes[fse->index].width;
	fse->max_width  = supported_modes[fse->index].width;
	fse->max_height = supported_modes[fse->index].height;
	fse->min_height = supported_modes[fse->index].height;

	return 0;
}

static int max96714_g_frame_interval(struct v4l2_subdev *sd,
				    struct v4l2_subdev_frame_interval *fi)
{
	struct max96714 *max96714 = to_max96714(sd);
	const struct max96714_mode *mode = max96714->cur_mode;

	mutex_lock(&max96714->mutex);
	fi->interval = mode->max_fps;
	mutex_unlock(&max96714->mutex);

	return 0;
}

static void max96714_get_module_inf(struct max96714 *max96714,
				   struct rkmodule_inf *inf)
{
	memset(inf, 0, sizeof(*inf));
	strscpy(inf->base.sensor, MAX96714_NAME, sizeof(inf->base.sensor));
	strscpy(inf->base.module, max96714->module_name,
		sizeof(inf->base.module));
	strscpy(inf->base.lens, max96714->len_name, sizeof(inf->base.lens));
}

static void max96714_get_vicap_rst_inf(struct max96714 *max96714,
				   struct rkmodule_vicap_reset_info *rst_info)
{
	struct i2c_client *client = max96714->client;

	rst_info->is_reset = max96714->hot_plug;
	max96714->hot_plug = false;
	rst_info->src = RKCIF_RESET_SRC_ERR_HOTPLUG;
	dev_info(&client->dev, "%s: rst_info->is_reset:%d.\n", __func__, rst_info->is_reset);
}

static void max96714_set_vicap_rst_inf(struct max96714 *max96714,
				   struct rkmodule_vicap_reset_info rst_info)
{
	max96714->is_reset = rst_info.is_reset;
}

static long max96714_ioctl(struct v4l2_subdev *sd, unsigned int cmd, void *arg)
{
	struct max96714 *max96714 = to_max96714(sd);
	long ret = 0;
	u32 stream = 0;

	switch (cmd) {
	case RKMODULE_GET_MODULE_INFO:
		max96714_get_module_inf(max96714, (struct rkmodule_inf *)arg);
		break;
	case RKMODULE_SET_QUICK_STREAM:

		stream = *((u32 *)arg);

		if (stream)
			ret = max96714_write_reg(max96714->client,
				 MAX96714_REG_CTRL_MODE,
				 MAX96714_REG_VALUE_08BIT,
				 MAX96714_MODE_STREAMING);
		else
			ret = max96714_write_reg(max96714->client,
				 MAX96714_REG_CTRL_MODE,
				 MAX96714_REG_VALUE_08BIT,
				 MAX96714_MODE_SW_STANDBY);
		break;
	case RKMODULE_GET_VICAP_RST_INFO:
		max96714_get_vicap_rst_inf(max96714,
			(struct rkmodule_vicap_reset_info *)arg);
		break;
	case RKMODULE_SET_VICAP_RST_INFO:
		max96714_set_vicap_rst_inf(max96714,
			*(struct rkmodule_vicap_reset_info *)arg);
		break;
	case RKMODULE_GET_START_STREAM_SEQ:
		// +*(int *)arg = RKMODULE_START_STREAM_FRONT;
		// *(int *)arg = RKMODULE_START_STREAM_BEHIND;
		break;
	default:
		ret = -ENOIOCTLCMD;
		break;
	}

	return ret;
}

#ifdef CONFIG_COMPAT
static long max96714_compat_ioctl32(struct v4l2_subdev *sd,
				   unsigned int cmd, unsigned long arg)
{
	void __user *up = compat_ptr(arg);
	struct rkmodule_inf *inf;
	struct rkmodule_awb_cfg *cfg;
	struct rkmodule_vicap_reset_info *vicap_rst_inf;
	long ret = 0;
	int *seq;
	u32 stream = 0;

	switch (cmd) {
	case RKMODULE_GET_MODULE_INFO:
		inf = kzalloc(sizeof(*inf), GFP_KERNEL);
		if (!inf) {
			ret = -ENOMEM;
			return ret;
		}

		ret = max96714_ioctl(sd, cmd, inf);
		if (!ret) {
			ret = copy_to_user(up, inf, sizeof(*inf));
			if (ret)
				ret = -EFAULT;
		}
		kfree(inf);
		break;
	case RKMODULE_AWB_CFG:
		cfg = kzalloc(sizeof(*cfg), GFP_KERNEL);
		if (!cfg) {
			ret = -ENOMEM;
			return ret;
		}

		ret = copy_from_user(cfg, up, sizeof(*cfg));
		if (!ret)
			ret = max96714_ioctl(sd, cmd, cfg);
		else
			ret = -EFAULT;
		kfree(cfg);
		break;
	case RKMODULE_GET_VICAP_RST_INFO:
		vicap_rst_inf = kzalloc(sizeof(*vicap_rst_inf), GFP_KERNEL);
		if (!vicap_rst_inf) {
			ret = -ENOMEM;
			return ret;
		}

		ret = max96714_ioctl(sd, cmd, vicap_rst_inf);
		if (!ret) {
			ret = copy_to_user(up, vicap_rst_inf, sizeof(*vicap_rst_inf));
			if (ret)
				ret = -EFAULT;
		}
		kfree(vicap_rst_inf);
		break;
	case RKMODULE_SET_VICAP_RST_INFO:
		vicap_rst_inf = kzalloc(sizeof(*vicap_rst_inf), GFP_KERNEL);
		if (!vicap_rst_inf) {
			ret = -ENOMEM;
			return ret;
		}

		ret = copy_from_user(vicap_rst_inf, up, sizeof(*vicap_rst_inf));
		if (!ret)
			ret = max96714_ioctl(sd, cmd, vicap_rst_inf);
		else
			ret = -EFAULT;
		kfree(vicap_rst_inf);
		break;
	case RKMODULE_GET_START_STREAM_SEQ:
		seq = kzalloc(sizeof(*seq), GFP_KERNEL);
		if (!seq) {
			ret = -ENOMEM;
			return ret;
		}

		ret = max96714_ioctl(sd, cmd, seq);
		if (!ret) {
			ret = copy_to_user(up, seq, sizeof(*seq));
			if (ret)
				ret = -EFAULT;
		}
		kfree(seq);
		break;
	case RKMODULE_SET_QUICK_STREAM:
		ret = copy_from_user(&stream, up, sizeof(u32));
		if (!ret)
			ret = max96714_ioctl(sd, cmd, &stream);
		else
			ret = -EFAULT;
		break;
	default:
		ret = -ENOIOCTLCMD;
		break;
	}

	return ret;
}
#endif

static int __max96714_start_stream(struct max96714 *max96714)
{
	int ret;

	ret = max96714_write_array(max96714->client, max96714->cur_mode->reg_list);
	if (ret)
		return ret;

	/* In case these controls are set before streaming */
	mutex_unlock(&max96714->mutex);
	ret = v4l2_ctrl_handler_setup(&max96714->ctrl_handler);
	mutex_lock(&max96714->mutex);
	if (ret)
		return ret;

	return max96714_write_reg(max96714->client,
				 MAX96714_REG_CTRL_MODE,
				 MAX96714_REG_VALUE_08BIT,
				 MAX96714_MODE_STREAMING);
}

static int __max96714_stop_stream(struct max96714 *max96714)
{
	return max96714_write_reg(max96714->client,
				 MAX96714_REG_CTRL_MODE,
				 MAX96714_REG_VALUE_08BIT,
				 MAX96714_MODE_SW_STANDBY);
}

static int max96714_s_stream(struct v4l2_subdev *sd, int on)
{
	struct max96714 *max96714 = to_max96714(sd);
	struct i2c_client *client = max96714->client;
	int ret = 0;

	dev_info(&client->dev, "%s: on: %d, %dx%d@%d\n", __func__, on,
				max96714->cur_mode->width,
				max96714->cur_mode->height,
		DIV_ROUND_CLOSEST(max96714->cur_mode->max_fps.denominator,
				  max96714->cur_mode->max_fps.numerator));

	mutex_lock(&max96714->mutex);
	on = !!on;
	if (on == max96714->streaming)
		goto unlock_and_return;

	if (on) {
		ret = pm_runtime_get_sync(&client->dev);
		if (ret < 0) {
			pm_runtime_put_noidle(&client->dev);
			goto unlock_and_return;
		}

		ret = __max96714_start_stream(max96714);
		if (ret) {
			v4l2_err(sd, "start stream failed while write regs\n");
			pm_runtime_put(&client->dev);
			goto unlock_and_return;
		}
	} else {
		__max96714_stop_stream(max96714);
		pm_runtime_put(&client->dev);
	}

	max96714->streaming = on;

unlock_and_return:
	mutex_unlock(&max96714->mutex);

	return ret;
}

static int max96714_s_power(struct v4l2_subdev *sd, int on)
{
	struct max96714 *max96714 = to_max96714(sd);
	struct i2c_client *client = max96714->client;
	int ret = 0;

	mutex_lock(&max96714->mutex);

	/* If the power state is not modified - no work to do. */
	if (max96714->power_on == !!on)
		goto unlock_and_return;

	if (on) {
		ret = pm_runtime_get_sync(&client->dev);
		if (ret < 0) {
			pm_runtime_put_noidle(&client->dev);
			goto unlock_and_return;
		}

		max96714->power_on = true;
	} else {
		pm_runtime_put(&client->dev);
		max96714->power_on = false;
	}

unlock_and_return:
	mutex_unlock(&max96714->mutex);

	return ret;
}

/* Calculate the delay in us by clock rate and clock cycles */
static inline u32 max96714_cal_delay(u32 cycles)
{
	return DIV_ROUND_UP(cycles, MAX96714_XVCLK_FREQ / 1000 / 1000);
}

static int __max96714_power_on(struct max96714 *max96714)
{
	int ret;
	u32 delay_us;
	struct device *dev = &max96714->client->dev;

	if (!IS_ERR(max96714->power_gpio))
		gpiod_set_value_cansleep(max96714->power_gpio, 1);

	usleep_range(1000, 2000);

	if (!IS_ERR_OR_NULL(max96714->pins_default)) {
		ret = pinctrl_select_state(max96714->pinctrl,
					   max96714->pins_default);
		if (ret < 0)
			dev_err(dev, "could not set pins\n");
	}

	if (!IS_ERR(max96714->reset_gpio))
		gpiod_set_value_cansleep(max96714->reset_gpio, 0);

	ret = regulator_bulk_enable(MAX96714_NUM_SUPPLIES, max96714->supplies);
	if (ret < 0) {
		dev_err(dev, "Failed to enable regulators\n");
		goto disable_clk;
	}

	if (!IS_ERR(max96714->reset_gpio))
		gpiod_set_value_cansleep(max96714->reset_gpio, 1);

	usleep_range(500, 1000);
	if (!IS_ERR(max96714->pwdn_gpio))
		gpiod_set_value_cansleep(max96714->pwdn_gpio, 1);

	/* 8192 cycles prior to first SCCB transaction */
	delay_us = max96714_cal_delay(8192);
	usleep_range(delay_us, delay_us * 2);

	return 0;

disable_clk:
	clk_disable_unprepare(max96714->xvclk);

	return ret;
}

static void __max96714_power_off(struct max96714 *max96714)
{
	int ret;
	struct device *dev = &max96714->client->dev;

	if (!IS_ERR(max96714->pwdn_gpio))
		gpiod_set_value_cansleep(max96714->pwdn_gpio, 0);
	clk_disable_unprepare(max96714->xvclk);
	if (!IS_ERR(max96714->reset_gpio))
		gpiod_set_value_cansleep(max96714->reset_gpio, 0);

	if (!IS_ERR_OR_NULL(max96714->pins_sleep)) {
		ret = pinctrl_select_state(max96714->pinctrl,
					   max96714->pins_sleep);
		if (ret < 0)
			dev_dbg(dev, "could not set pins\n");
	}
	if (!IS_ERR(max96714->power_gpio))
		gpiod_set_value_cansleep(max96714->power_gpio, 0);

	regulator_bulk_disable(MAX96714_NUM_SUPPLIES, max96714->supplies);
}

static int max96714_runtime_resume(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct v4l2_subdev *sd = i2c_get_clientdata(client);
	struct max96714 *max96714 = to_max96714(sd);

	return __max96714_power_on(max96714);
}

static int max96714_runtime_suspend(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct v4l2_subdev *sd = i2c_get_clientdata(client);
	struct max96714 *max96714 = to_max96714(sd);

	__max96714_power_off(max96714);

	return 0;
}

#ifdef CONFIG_VIDEO_V4L2_SUBDEV_API
static int max96714_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
{
	struct max96714 *max96714 = to_max96714(sd);
	struct v4l2_mbus_framefmt *try_fmt =
				v4l2_subdev_get_try_format(sd, fh->pad, 0);
	const struct max96714_mode *def_mode = &supported_modes[0];

	mutex_lock(&max96714->mutex);
	/* Initialize try_fmt */
	try_fmt->width = def_mode->width;
	try_fmt->height = def_mode->height;
	try_fmt->code = MAX96714_MEDIA_BUS_FMT;
	try_fmt->field = V4L2_FIELD_NONE;

	mutex_unlock(&max96714->mutex);
	/* No crop or compose */

	return 0;
}
#endif

static int max96714_enum_frame_interval(struct v4l2_subdev *sd,
				       struct v4l2_subdev_pad_config *cfg,
				       struct v4l2_subdev_frame_interval_enum *fie)
{
	if (fie->index >= ARRAY_SIZE(supported_modes))
		return -EINVAL;

	fie->code = MAX96714_MEDIA_BUS_FMT;

	fie->width = supported_modes[fie->index].width;
	fie->height = supported_modes[fie->index].height;
	fie->interval = supported_modes[fie->index].max_fps;

	return 0;
}

static int max96714_g_mbus_config(struct v4l2_subdev *sd, unsigned int pad,
				struct v4l2_mbus_config *config)
{
	config->type = V4L2_MBUS_CSI2_DPHY;
	config->flags = V4L2_MBUS_CSI2_4_LANE |
			V4L2_MBUS_CSI2_CHANNEL_0 |
			V4L2_MBUS_CSI2_CONTINUOUS_CLOCK;

	return 0;
}

static int max96714_get_selection(struct v4l2_subdev *sd,
				struct v4l2_subdev_pad_config *cfg,
				struct v4l2_subdev_selection *sel)
{
	struct max96714 *max96714 = to_max96714(sd);

	if (sel->target == V4L2_SEL_TGT_CROP_BOUNDS) {
		sel->r.left = 0;
		sel->r.width = max96714->cur_mode->width;
		sel->r.top = 0;
		sel->r.height = max96714->cur_mode->height;
		return 0;
	}

	return -EINVAL;
}

static const struct dev_pm_ops max96714_pm_ops = {
	SET_RUNTIME_PM_OPS(max96714_runtime_suspend,
			   max96714_runtime_resume, NULL)
};

#ifdef CONFIG_VIDEO_V4L2_SUBDEV_API
static const struct v4l2_subdev_internal_ops max96714_internal_ops = {
	.open = max96714_open,
};
#endif

static const struct v4l2_subdev_core_ops max96714_core_ops = {
	.s_power = max96714_s_power,
	.ioctl = max96714_ioctl,
#ifdef CONFIG_COMPAT
	.compat_ioctl32 = max96714_compat_ioctl32,
#endif
};

static const struct v4l2_subdev_video_ops max96714_video_ops = {
	.s_stream = max96714_s_stream,
	.g_frame_interval = max96714_g_frame_interval,
};

static const struct v4l2_subdev_pad_ops max96714_pad_ops = {
	.enum_mbus_code = max96714_enum_mbus_code,
	.enum_frame_size = max96714_enum_frame_sizes,
	.enum_frame_interval = max96714_enum_frame_interval,
	.get_fmt = max96714_get_fmt,
	.set_fmt = max96714_set_fmt,
	.get_selection = max96714_get_selection,
	.get_mbus_config = max96714_g_mbus_config,
};

static const struct v4l2_subdev_ops max96714_subdev_ops = {
	.core	= &max96714_core_ops,
	.video	= &max96714_video_ops,
	.pad	= &max96714_pad_ops,
};

static int max96714_initialize_controls(struct max96714 *max96714)
{
	const struct max96714_mode *mode;
	struct v4l2_ctrl_handler *handler;
	int ret;

	handler = &max96714->ctrl_handler;
	mode = max96714->cur_mode;
	ret = v4l2_ctrl_handler_init(handler, 2);
	if (ret)
		return ret;
	handler->lock = &max96714->mutex;

	max96714->link_freq = v4l2_ctrl_new_int_menu(handler, NULL,
			V4L2_CID_LINK_FREQ,
			1, 0, link_freq_items);

	max96714->pixel_rate = v4l2_ctrl_new_std(handler, NULL,
			V4L2_CID_PIXEL_RATE,
			0, MAX96714_PIXEL_RATE,
			1, MAX96714_PIXEL_RATE);

	__v4l2_ctrl_s_ctrl(max96714->link_freq,
			   mode->link_freq_idx);

	if (handler->error) {
		ret = handler->error;
		dev_err(&max96714->client->dev,
			"Failed to init controls(%d)\n", ret);
		goto err_free_handler;
	}

	max96714->subdev.ctrl_handler = handler;

	return 0;

err_free_handler:
	v4l2_ctrl_handler_free(handler);

	return ret;
}

static int max96714_check_sensor_id(struct max96714 *max96714,
				   struct i2c_client *client)
{
	struct device *dev = &max96714->client->dev;
	u32 id = 0;
	int ret;

	ret = max96714_read_reg(client, MAX96714_REG_CHIP_ID,
			       MAX96714_REG_VALUE_08BIT, &id);
	if (id != CHIP_ID) {
		dev_err(dev, "Unexpected sensor id(%02x), ret(%d)\n", id, ret);
		return -ENODEV;
	}

	dev_info(dev, "Detected %02x sensor\n", CHIP_ID);

	return 0;
}

static int max96714_configure_regulators(struct max96714 *max96714)
{
	unsigned int i;

	for (i = 0; i < MAX96714_NUM_SUPPLIES; i++)
		max96714->supplies[i].supply = max96714_supply_names[i];

	return devm_regulator_bulk_get(&max96714->client->dev,
					MAX96714_NUM_SUPPLIES,
					max96714->supplies);
}

static int max96714_probe(struct i2c_client *client,
			 const struct i2c_device_id *id)
{
	struct device *dev = &client->dev;
	struct device_node *node = dev->of_node;
	struct max96714 *max96714;
	struct v4l2_subdev *sd;
	char facing[2];
	int ret;

	dev_info(dev, "driver version: %02x.%02x.%02x",
		DRIVER_VERSION >> 16,
		(DRIVER_VERSION & 0xff00) >> 8,
		DRIVER_VERSION & 0x00ff);

	max96714 = devm_kzalloc(dev, sizeof(*max96714), GFP_KERNEL);
	if (!max96714)
		return -ENOMEM;

	ret = of_property_read_u32(node, RKMODULE_CAMERA_MODULE_INDEX,
				   &max96714->module_index);
	ret |= of_property_read_string(node, RKMODULE_CAMERA_MODULE_FACING,
				       &max96714->module_facing);
	ret |= of_property_read_string(node, RKMODULE_CAMERA_MODULE_NAME,
				       &max96714->module_name);
	ret |= of_property_read_string(node, RKMODULE_CAMERA_LENS_NAME,
				       &max96714->len_name);
	if (ret) {
		dev_err(dev, "could not get module information!\n");
		return -EINVAL;
	}

	max96714->client = client;
	max96714->cur_mode = &supported_modes[0];

	max96714->power_gpio = devm_gpiod_get(dev, "power", GPIOD_OUT_LOW);
	if (IS_ERR(max96714->power_gpio))
		dev_warn(dev, "Failed to get power-gpios, maybe no use\n");

	max96714->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_OUT_LOW);
	if (IS_ERR(max96714->reset_gpio))
		dev_warn(dev, "Failed to get reset-gpios\n");

	max96714->pwdn_gpio = devm_gpiod_get(dev, "pwdn", GPIOD_OUT_LOW);
	if (IS_ERR(max96714->pwdn_gpio))
		dev_warn(dev, "Failed to get pwdn-gpios\n");

	ret = max96714_configure_regulators(max96714);
	if (ret) {
		dev_err(dev, "Failed to get power regulators\n");
		return ret;
	}

	max96714->pinctrl = devm_pinctrl_get(dev);
	if (!IS_ERR(max96714->pinctrl)) {
		max96714->pins_default =
			pinctrl_lookup_state(max96714->pinctrl,
					     OF_CAMERA_PINCTRL_STATE_DEFAULT);
		if (IS_ERR(max96714->pins_default))
			dev_err(dev, "could not get default pinstate\n");

		max96714->pins_sleep =
			pinctrl_lookup_state(max96714->pinctrl,
					     OF_CAMERA_PINCTRL_STATE_SLEEP);
		if (IS_ERR(max96714->pins_sleep))
			dev_err(dev, "could not get sleep pinstate\n");
	}

	mutex_init(&max96714->mutex);

	sd = &max96714->subdev;
	v4l2_i2c_subdev_init(sd, client, &max96714_subdev_ops);
	ret = max96714_initialize_controls(max96714);
	if (ret)
		goto err_destroy_mutex;

	ret = __max96714_power_on(max96714);
	if (ret)
		goto err_free_handler;

	ret = max96714_check_sensor_id(max96714, client);
	if (ret)
		goto err_power_off;

#ifdef CONFIG_VIDEO_V4L2_SUBDEV_API
	sd->internal_ops = &max96714_internal_ops;
	sd->flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
#endif
#if defined(CONFIG_MEDIA_CONTROLLER)
	max96714->pad.flags = MEDIA_PAD_FL_SOURCE;
	sd->entity.function = MEDIA_ENT_F_CAM_SENSOR;
	ret = media_entity_pads_init(&sd->entity, 1, &max96714->pad);
	if (ret < 0)
		goto err_power_off;
#endif

	memset(facing, 0, sizeof(facing));
	if (strcmp(max96714->module_facing, "back") == 0)
		facing[0] = 'b';
	else
		facing[0] = 'f';

	snprintf(sd->name, sizeof(sd->name), "m%02d_%s_%s %s",
		 max96714->module_index, facing,
		 MAX96714_NAME, dev_name(sd->dev));
	ret = v4l2_async_register_subdev_sensor_common(sd);
	if (ret) {
		dev_err(dev, "v4l2 async register subdev failed\n");
		goto err_clean_entity;
	}

	pm_runtime_set_active(dev);
	pm_runtime_enable(dev);
	pm_runtime_idle(dev);

	return 0;

err_clean_entity:
#if defined(CONFIG_MEDIA_CONTROLLER)
	media_entity_cleanup(&sd->entity);
#endif
err_power_off:
	__max96714_power_off(max96714);
err_free_handler:
	v4l2_ctrl_handler_free(&max96714->ctrl_handler);
err_destroy_mutex:
	mutex_destroy(&max96714->mutex);

	return ret;
}

static int max96714_remove(struct i2c_client *client)
{
	struct v4l2_subdev *sd = i2c_get_clientdata(client);
	struct max96714 *max96714 = to_max96714(sd);

	v4l2_async_unregister_subdev(sd);
#if defined(CONFIG_MEDIA_CONTROLLER)
	media_entity_cleanup(&sd->entity);
#endif
	v4l2_ctrl_handler_free(&max96714->ctrl_handler);
	mutex_destroy(&max96714->mutex);

	pm_runtime_disable(&client->dev);
	if (!pm_runtime_status_suspended(&client->dev))
		__max96714_power_off(max96714);
	pm_runtime_set_suspended(&client->dev);

	return 0;
}

#if IS_ENABLED(CONFIG_OF)
static const struct of_device_id max96714_of_match[] = {
	{ .compatible = "maxim,max96714" },
	{},
};
MODULE_DEVICE_TABLE(of, max96714_of_match);
#endif

static const struct i2c_device_id max96714_match_id[] = {
	{ "maxim,max96714", 0 },
	{},
};

static struct i2c_driver max96714_i2c_driver = {
	.driver = {
		.name = MAX96714_NAME,
		.pm = &max96714_pm_ops,
		.of_match_table = of_match_ptr(max96714_of_match),
	},
	.probe		= &max96714_probe,
	.remove		= &max96714_remove,
	.id_table	= max96714_match_id,
};

int max96714_sensor_mod_init(void)
{
	return i2c_add_driver(&max96714_i2c_driver);
}

#ifndef CONFIG_VIDEO_REVERSE_IMAGE
device_initcall_sync(max96714_sensor_mod_init);
#endif

static void __exit sensor_mod_exit(void)
{
	i2c_del_driver(&max96714_i2c_driver);
}

module_exit(sensor_mod_exit);

MODULE_DESCRIPTION("Maxim max96714 sensor driver");
MODULE_LICENSE("GPL");