1 // SPDX-License-Identifier: GPL-2.0
3 * imx214.c - imx214 sensor driver
5 * Copyright 2018 Qtechnology A/S
10 #include <linux/delay.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/i2c.h>
13 #include <linux/module.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/regmap.h>
16 #include <linux/regulator/consumer.h>
17 #include <media/media-entity.h>
18 #include <media/v4l2-ctrls.h>
19 #include <media/v4l2-fwnode.h>
20 #include <media/v4l2-subdev.h>
22 #define IMX214_DEFAULT_CLK_FREQ 24000000
23 #define IMX214_DEFAULT_LINK_FREQ 480000000
24 #define IMX214_DEFAULT_PIXEL_RATE ((IMX214_DEFAULT_LINK_FREQ * 8LL) / 10)
26 #define IMX214_MBUS_CODE MEDIA_BUS_FMT_SRGGB10_1X10
28 static const char * const imx214_supply_name[] = {
34 #define IMX214_NUM_SUPPLIES ARRAY_SIZE(imx214_supply_name)
39 struct regmap *regmap;
41 struct v4l2_subdev sd;
43 struct v4l2_mbus_framefmt fmt;
44 struct v4l2_rect crop;
46 struct v4l2_ctrl_handler ctrls;
47 struct v4l2_ctrl *pixel_rate;
48 struct v4l2_ctrl *link_freq;
49 struct v4l2_ctrl *exposure;
50 struct v4l2_ctrl *unit_size;
52 struct regulator_bulk_data supplies[IMX214_NUM_SUPPLIES];
54 struct gpio_desc *enable_gpio;
57 * Serialize control access, get/set format, get selection
58 * and start streaming.
71 IMX214_TABLE_WAIT_MS = 0,
77 /*From imx214_mode_tbls.h*/
78 static const struct reg_8 mode_4096x2304[] = {
177 {IMX214_TABLE_WAIT_MS, 10},
179 {IMX214_TABLE_END, 0x00}
182 static const struct reg_8 mode_1920x1080[] = {
281 {IMX214_TABLE_WAIT_MS, 10},
283 {IMX214_TABLE_END, 0x00}
286 static const struct reg_8 mode_table_common[] = {
289 /* software standby settings */
295 /* external clock setting */
375 /* CNR parameter setting */
378 /* Moire reduction */
381 /* image enhancement */
403 {IMX214_TABLE_END, 0x00}
407 * Declare modes in order, from biggest
408 * to smallest height.
410 static const struct imx214_mode {
413 const struct reg_8 *reg_table;
418 .reg_table = mode_4096x2304,
423 .reg_table = mode_1920x1080,
427 static inline struct imx214 *to_imx214(struct v4l2_subdev *sd)
429 return container_of(sd, struct imx214, sd);
432 static int __maybe_unused imx214_power_on(struct device *dev)
434 struct i2c_client *client = to_i2c_client(dev);
435 struct v4l2_subdev *sd = i2c_get_clientdata(client);
436 struct imx214 *imx214 = to_imx214(sd);
439 ret = regulator_bulk_enable(IMX214_NUM_SUPPLIES, imx214->supplies);
441 dev_err(imx214->dev, "failed to enable regulators: %d\n", ret);
445 usleep_range(2000, 3000);
447 ret = clk_prepare_enable(imx214->xclk);
449 regulator_bulk_disable(IMX214_NUM_SUPPLIES, imx214->supplies);
450 dev_err(imx214->dev, "clk prepare enable failed\n");
454 gpiod_set_value_cansleep(imx214->enable_gpio, 1);
455 usleep_range(12000, 15000);
460 static int __maybe_unused imx214_power_off(struct device *dev)
462 struct i2c_client *client = to_i2c_client(dev);
463 struct v4l2_subdev *sd = i2c_get_clientdata(client);
464 struct imx214 *imx214 = to_imx214(sd);
466 gpiod_set_value_cansleep(imx214->enable_gpio, 0);
468 clk_disable_unprepare(imx214->xclk);
470 regulator_bulk_disable(IMX214_NUM_SUPPLIES, imx214->supplies);
471 usleep_range(10, 20);
476 static int imx214_enum_mbus_code(struct v4l2_subdev *sd,
477 struct v4l2_subdev_state *sd_state,
478 struct v4l2_subdev_mbus_code_enum *code)
483 code->code = IMX214_MBUS_CODE;
488 static int imx214_enum_frame_size(struct v4l2_subdev *subdev,
489 struct v4l2_subdev_state *sd_state,
490 struct v4l2_subdev_frame_size_enum *fse)
492 if (fse->code != IMX214_MBUS_CODE)
495 if (fse->index >= ARRAY_SIZE(imx214_modes))
498 fse->min_width = fse->max_width = imx214_modes[fse->index].width;
499 fse->min_height = fse->max_height = imx214_modes[fse->index].height;
504 #ifdef CONFIG_VIDEO_ADV_DEBUG
505 static int imx214_s_register(struct v4l2_subdev *subdev,
506 const struct v4l2_dbg_register *reg)
508 struct imx214 *imx214 = container_of(subdev, struct imx214, sd);
510 return regmap_write(imx214->regmap, reg->reg, reg->val);
513 static int imx214_g_register(struct v4l2_subdev *subdev,
514 struct v4l2_dbg_register *reg)
516 struct imx214 *imx214 = container_of(subdev, struct imx214, sd);
521 ret = regmap_read(imx214->regmap, reg->reg, &aux);
528 static const struct v4l2_subdev_core_ops imx214_core_ops = {
529 #ifdef CONFIG_VIDEO_ADV_DEBUG
530 .g_register = imx214_g_register,
531 .s_register = imx214_s_register,
535 static struct v4l2_mbus_framefmt *
536 __imx214_get_pad_format(struct imx214 *imx214,
537 struct v4l2_subdev_state *sd_state,
539 enum v4l2_subdev_format_whence which)
542 case V4L2_SUBDEV_FORMAT_TRY:
543 return v4l2_subdev_get_try_format(&imx214->sd, sd_state, pad);
544 case V4L2_SUBDEV_FORMAT_ACTIVE:
551 static int imx214_get_format(struct v4l2_subdev *sd,
552 struct v4l2_subdev_state *sd_state,
553 struct v4l2_subdev_format *format)
555 struct imx214 *imx214 = to_imx214(sd);
557 mutex_lock(&imx214->mutex);
558 format->format = *__imx214_get_pad_format(imx214, sd_state,
561 mutex_unlock(&imx214->mutex);
566 static struct v4l2_rect *
567 __imx214_get_pad_crop(struct imx214 *imx214,
568 struct v4l2_subdev_state *sd_state,
569 unsigned int pad, enum v4l2_subdev_format_whence which)
572 case V4L2_SUBDEV_FORMAT_TRY:
573 return v4l2_subdev_get_try_crop(&imx214->sd, sd_state, pad);
574 case V4L2_SUBDEV_FORMAT_ACTIVE:
575 return &imx214->crop;
581 static int imx214_set_format(struct v4l2_subdev *sd,
582 struct v4l2_subdev_state *sd_state,
583 struct v4l2_subdev_format *format)
585 struct imx214 *imx214 = to_imx214(sd);
586 struct v4l2_mbus_framefmt *__format;
587 struct v4l2_rect *__crop;
588 const struct imx214_mode *mode;
590 mutex_lock(&imx214->mutex);
592 __crop = __imx214_get_pad_crop(imx214, sd_state, format->pad,
595 mode = v4l2_find_nearest_size(imx214_modes,
596 ARRAY_SIZE(imx214_modes), width, height,
597 format->format.width,
598 format->format.height);
600 __crop->width = mode->width;
601 __crop->height = mode->height;
603 __format = __imx214_get_pad_format(imx214, sd_state, format->pad,
605 __format->width = __crop->width;
606 __format->height = __crop->height;
607 __format->code = IMX214_MBUS_CODE;
608 __format->field = V4L2_FIELD_NONE;
609 __format->colorspace = V4L2_COLORSPACE_SRGB;
610 __format->ycbcr_enc = V4L2_MAP_YCBCR_ENC_DEFAULT(__format->colorspace);
611 __format->quantization = V4L2_MAP_QUANTIZATION_DEFAULT(true,
612 __format->colorspace, __format->ycbcr_enc);
613 __format->xfer_func = V4L2_MAP_XFER_FUNC_DEFAULT(__format->colorspace);
615 format->format = *__format;
617 mutex_unlock(&imx214->mutex);
622 static int imx214_get_selection(struct v4l2_subdev *sd,
623 struct v4l2_subdev_state *sd_state,
624 struct v4l2_subdev_selection *sel)
626 struct imx214 *imx214 = to_imx214(sd);
628 if (sel->target != V4L2_SEL_TGT_CROP)
631 mutex_lock(&imx214->mutex);
632 sel->r = *__imx214_get_pad_crop(imx214, sd_state, sel->pad,
634 mutex_unlock(&imx214->mutex);
638 static int imx214_entity_init_cfg(struct v4l2_subdev *subdev,
639 struct v4l2_subdev_state *sd_state)
641 struct v4l2_subdev_format fmt = { };
643 fmt.which = sd_state ? V4L2_SUBDEV_FORMAT_TRY : V4L2_SUBDEV_FORMAT_ACTIVE;
644 fmt.format.width = imx214_modes[0].width;
645 fmt.format.height = imx214_modes[0].height;
647 imx214_set_format(subdev, sd_state, &fmt);
652 static int imx214_set_ctrl(struct v4l2_ctrl *ctrl)
654 struct imx214 *imx214 = container_of(ctrl->handler,
655 struct imx214, ctrls);
660 * Applying V4L2 control value only happens
661 * when power is up for streaming
663 if (!pm_runtime_get_if_in_use(imx214->dev))
667 case V4L2_CID_EXPOSURE:
669 vals[0] = ctrl->val >> 8;
670 ret = regmap_bulk_write(imx214->regmap, 0x202, vals, 2);
672 dev_err(imx214->dev, "Error %d\n", ret);
680 pm_runtime_put(imx214->dev);
685 static const struct v4l2_ctrl_ops imx214_ctrl_ops = {
686 .s_ctrl = imx214_set_ctrl,
690 static int imx214_write_table(struct imx214 *imx214,
691 const struct reg_8 table[])
697 for (; table->addr != IMX214_TABLE_END ; table++) {
698 if (table->addr == IMX214_TABLE_WAIT_MS) {
699 usleep_range(table->val * 1000,
700 table->val * 1000 + 500);
704 for (i = 0; i < MAX_CMD; i++) {
705 if (table[i].addr != (table[0].addr + i))
707 vals[i] = table[i].val;
710 ret = regmap_bulk_write(imx214->regmap, table->addr, vals, i);
713 dev_err(imx214->dev, "write_table error: %d\n", ret);
723 static int imx214_start_streaming(struct imx214 *imx214)
725 const struct imx214_mode *mode;
728 mutex_lock(&imx214->mutex);
729 ret = imx214_write_table(imx214, mode_table_common);
731 dev_err(imx214->dev, "could not sent common table %d\n", ret);
735 mode = v4l2_find_nearest_size(imx214_modes,
736 ARRAY_SIZE(imx214_modes), width, height,
737 imx214->fmt.width, imx214->fmt.height);
738 ret = imx214_write_table(imx214, mode->reg_table);
740 dev_err(imx214->dev, "could not sent mode table %d\n", ret);
743 ret = __v4l2_ctrl_handler_setup(&imx214->ctrls);
745 dev_err(imx214->dev, "could not sync v4l2 controls\n");
748 ret = regmap_write(imx214->regmap, 0x100, 1);
750 dev_err(imx214->dev, "could not sent start table %d\n", ret);
754 mutex_unlock(&imx214->mutex);
758 mutex_unlock(&imx214->mutex);
762 static int imx214_stop_streaming(struct imx214 *imx214)
766 ret = regmap_write(imx214->regmap, 0x100, 0);
768 dev_err(imx214->dev, "could not sent stop table %d\n", ret);
773 static int imx214_s_stream(struct v4l2_subdev *subdev, int enable)
775 struct imx214 *imx214 = to_imx214(subdev);
778 if (imx214->streaming == enable)
782 ret = pm_runtime_resume_and_get(imx214->dev);
786 ret = imx214_start_streaming(imx214);
790 ret = imx214_stop_streaming(imx214);
793 pm_runtime_put(imx214->dev);
796 imx214->streaming = enable;
800 pm_runtime_put(imx214->dev);
804 static int imx214_g_frame_interval(struct v4l2_subdev *subdev,
805 struct v4l2_subdev_frame_interval *fival)
807 fival->interval.numerator = 1;
808 fival->interval.denominator = IMX214_FPS;
813 static int imx214_enum_frame_interval(struct v4l2_subdev *subdev,
814 struct v4l2_subdev_state *sd_state,
815 struct v4l2_subdev_frame_interval_enum *fie)
817 const struct imx214_mode *mode;
822 mode = v4l2_find_nearest_size(imx214_modes,
823 ARRAY_SIZE(imx214_modes), width, height,
824 fie->width, fie->height);
826 fie->code = IMX214_MBUS_CODE;
827 fie->width = mode->width;
828 fie->height = mode->height;
829 fie->interval.numerator = 1;
830 fie->interval.denominator = IMX214_FPS;
835 static const struct v4l2_subdev_video_ops imx214_video_ops = {
836 .s_stream = imx214_s_stream,
837 .g_frame_interval = imx214_g_frame_interval,
838 .s_frame_interval = imx214_g_frame_interval,
841 static const struct v4l2_subdev_pad_ops imx214_subdev_pad_ops = {
842 .enum_mbus_code = imx214_enum_mbus_code,
843 .enum_frame_size = imx214_enum_frame_size,
844 .enum_frame_interval = imx214_enum_frame_interval,
845 .get_fmt = imx214_get_format,
846 .set_fmt = imx214_set_format,
847 .get_selection = imx214_get_selection,
848 .init_cfg = imx214_entity_init_cfg,
851 static const struct v4l2_subdev_ops imx214_subdev_ops = {
852 .core = &imx214_core_ops,
853 .video = &imx214_video_ops,
854 .pad = &imx214_subdev_pad_ops,
857 static const struct regmap_config sensor_regmap_config = {
860 .cache_type = REGCACHE_RBTREE,
863 static int imx214_get_regulators(struct device *dev, struct imx214 *imx214)
867 for (i = 0; i < IMX214_NUM_SUPPLIES; i++)
868 imx214->supplies[i].supply = imx214_supply_name[i];
870 return devm_regulator_bulk_get(dev, IMX214_NUM_SUPPLIES,
874 static int imx214_parse_fwnode(struct device *dev)
876 struct fwnode_handle *endpoint;
877 struct v4l2_fwnode_endpoint bus_cfg = {
878 .bus_type = V4L2_MBUS_CSI2_DPHY,
883 endpoint = fwnode_graph_get_next_endpoint(dev_fwnode(dev), NULL);
885 dev_err(dev, "endpoint node not found\n");
889 ret = v4l2_fwnode_endpoint_alloc_parse(endpoint, &bus_cfg);
891 dev_err(dev, "parsing endpoint node failed\n");
895 for (i = 0; i < bus_cfg.nr_of_link_frequencies; i++)
896 if (bus_cfg.link_frequencies[i] == IMX214_DEFAULT_LINK_FREQ)
899 if (i == bus_cfg.nr_of_link_frequencies) {
900 dev_err(dev, "link-frequencies %d not supported, Please review your DT\n",
901 IMX214_DEFAULT_LINK_FREQ);
907 v4l2_fwnode_endpoint_free(&bus_cfg);
908 fwnode_handle_put(endpoint);
912 static int __maybe_unused imx214_suspend(struct device *dev)
914 struct i2c_client *client = to_i2c_client(dev);
915 struct v4l2_subdev *sd = i2c_get_clientdata(client);
916 struct imx214 *imx214 = to_imx214(sd);
918 if (imx214->streaming)
919 imx214_stop_streaming(imx214);
924 static int __maybe_unused imx214_resume(struct device *dev)
926 struct i2c_client *client = to_i2c_client(dev);
927 struct v4l2_subdev *sd = i2c_get_clientdata(client);
928 struct imx214 *imx214 = to_imx214(sd);
931 if (imx214->streaming) {
932 ret = imx214_start_streaming(imx214);
940 imx214_stop_streaming(imx214);
941 imx214->streaming = 0;
945 static int imx214_probe(struct i2c_client *client)
947 struct device *dev = &client->dev;
948 struct imx214 *imx214;
949 static const s64 link_freq[] = {
950 IMX214_DEFAULT_LINK_FREQ,
952 static const struct v4l2_area unit_size = {
958 ret = imx214_parse_fwnode(dev);
962 imx214 = devm_kzalloc(dev, sizeof(*imx214), GFP_KERNEL);
968 imx214->xclk = devm_clk_get(dev, NULL);
969 if (IS_ERR(imx214->xclk)) {
970 dev_err(dev, "could not get xclk");
971 return PTR_ERR(imx214->xclk);
974 ret = clk_set_rate(imx214->xclk, IMX214_DEFAULT_CLK_FREQ);
976 dev_err(dev, "could not set xclk frequency\n");
980 ret = imx214_get_regulators(dev, imx214);
982 dev_err(dev, "cannot get regulators\n");
986 imx214->enable_gpio = devm_gpiod_get(dev, "enable", GPIOD_OUT_LOW);
987 if (IS_ERR(imx214->enable_gpio)) {
988 dev_err(dev, "cannot get enable gpio\n");
989 return PTR_ERR(imx214->enable_gpio);
992 imx214->regmap = devm_regmap_init_i2c(client, &sensor_regmap_config);
993 if (IS_ERR(imx214->regmap)) {
994 dev_err(dev, "regmap init failed\n");
995 return PTR_ERR(imx214->regmap);
998 v4l2_i2c_subdev_init(&imx214->sd, client, &imx214_subdev_ops);
1001 * Enable power initially, to avoid warnings
1002 * from clk_disable on power_off
1004 imx214_power_on(imx214->dev);
1006 pm_runtime_set_active(imx214->dev);
1007 pm_runtime_enable(imx214->dev);
1008 pm_runtime_idle(imx214->dev);
1010 v4l2_ctrl_handler_init(&imx214->ctrls, 3);
1012 imx214->pixel_rate = v4l2_ctrl_new_std(&imx214->ctrls, NULL,
1013 V4L2_CID_PIXEL_RATE, 0,
1014 IMX214_DEFAULT_PIXEL_RATE, 1,
1015 IMX214_DEFAULT_PIXEL_RATE);
1016 imx214->link_freq = v4l2_ctrl_new_int_menu(&imx214->ctrls, NULL,
1018 ARRAY_SIZE(link_freq) - 1,
1020 if (imx214->link_freq)
1021 imx214->link_freq->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1025 * Values obtained reverse engineering blobs and/or devices.
1026 * Ranges and functionality might be wrong.
1028 * Sony, please release some register set documentation for the
1031 * Yours sincerely, Ricardo.
1033 imx214->exposure = v4l2_ctrl_new_std(&imx214->ctrls, &imx214_ctrl_ops,
1035 0, 3184, 1, 0x0c70);
1037 imx214->unit_size = v4l2_ctrl_new_std_compound(&imx214->ctrls,
1039 V4L2_CID_UNIT_CELL_SIZE,
1040 v4l2_ctrl_ptr_create((void *)&unit_size));
1041 ret = imx214->ctrls.error;
1043 dev_err(&client->dev, "%s control init failed (%d)\n",
1048 imx214->sd.ctrl_handler = &imx214->ctrls;
1049 mutex_init(&imx214->mutex);
1050 imx214->ctrls.lock = &imx214->mutex;
1052 imx214->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
1053 imx214->pad.flags = MEDIA_PAD_FL_SOURCE;
1054 imx214->sd.dev = &client->dev;
1055 imx214->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1057 ret = media_entity_pads_init(&imx214->sd.entity, 1, &imx214->pad);
1059 dev_err(dev, "could not register media entity\n");
1063 imx214_entity_init_cfg(&imx214->sd, NULL);
1065 ret = v4l2_async_register_subdev_sensor(&imx214->sd);
1067 dev_err(dev, "could not register v4l2 device\n");
1074 media_entity_cleanup(&imx214->sd.entity);
1076 mutex_destroy(&imx214->mutex);
1077 v4l2_ctrl_handler_free(&imx214->ctrls);
1078 pm_runtime_disable(imx214->dev);
1083 static void imx214_remove(struct i2c_client *client)
1085 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1086 struct imx214 *imx214 = to_imx214(sd);
1088 v4l2_async_unregister_subdev(&imx214->sd);
1089 media_entity_cleanup(&imx214->sd.entity);
1090 v4l2_ctrl_handler_free(&imx214->ctrls);
1092 pm_runtime_disable(&client->dev);
1093 pm_runtime_set_suspended(&client->dev);
1095 mutex_destroy(&imx214->mutex);
1098 static const struct of_device_id imx214_of_match[] = {
1099 { .compatible = "sony,imx214" },
1102 MODULE_DEVICE_TABLE(of, imx214_of_match);
1104 static const struct dev_pm_ops imx214_pm_ops = {
1105 SET_SYSTEM_SLEEP_PM_OPS(imx214_suspend, imx214_resume)
1106 SET_RUNTIME_PM_OPS(imx214_power_off, imx214_power_on, NULL)
1109 static struct i2c_driver imx214_i2c_driver = {
1111 .of_match_table = imx214_of_match,
1112 .pm = &imx214_pm_ops,
1115 .probe_new = imx214_probe,
1116 .remove = imx214_remove,
1119 module_i2c_driver(imx214_i2c_driver);
1121 MODULE_DESCRIPTION("Sony IMX214 Camera driver");
1123 MODULE_LICENSE("GPL v2");