1 // SPDX-License-Identifier: GPL-2.0-only
15 #include <media/v4l2-ctrls.h>
16 #include <media/v4l2-fwnode.h>
17 #include <media/v4l2-subdev.h>
24 /* Lines per frame */
59  * struct imx335_reg - imx335 sensor register
69  * struct imx335_reg_list - imx335 sensor register list
79  * struct imx335_mode - imx335 sensor mode structure
83  * @hblank: Horizontal blanking in lines
84  * @vblank: Vertical blanking in lines
85  * @vblank_min: Minimum vertical blanking in lines
86  * @vblank_max: Maximum vertical blanking in lines
105  * struct imx335 - imx335 sensor device structure
108  * @sd: V4L2 sub-device
119  * @vblank: Vertical blanking in lines
127 	struct v4l2_subdev sd;  member
256  * to_imx335() - imx335 V4L2 sub-device to imx335 device.
257  * @subdev: pointer to imx335 V4L2 sub-device
263 	return container_of(subdev, struct imx335, sd);  in to_imx335()
267  * imx335_read_reg() - Read registers.
279 	struct i2c_client *client = v4l2_get_subdevdata(&imx335->sd);  in imx335_read_reg()
286 		return -EINVAL;  in imx335_read_reg()
291 	msgs[0].addr = client->addr;  in imx335_read_reg()
297 	msgs[1].addr = client->addr;  in imx335_read_reg()
302 	ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));  in imx335_read_reg()
304 		return -EIO;  in imx335_read_reg()
312  * imx335_write_reg() - Write register
324 	struct i2c_client *client = v4l2_get_subdevdata(&imx335->sd);  in imx335_write_reg()
328 		return -EINVAL;  in imx335_write_reg()
333 		return -EIO;  in imx335_write_reg()
339  * imx335_write_regs() - Write a list of registers
362  * imx335_update_controls() - Update control ranges based on streaming mode
373 	ret = __v4l2_ctrl_s_ctrl(imx335->link_freq_ctrl, mode->link_freq_idx);  in imx335_update_controls()
377 	ret = __v4l2_ctrl_s_ctrl(imx335->hblank_ctrl, mode->hblank);  in imx335_update_controls()
381 	return __v4l2_ctrl_modify_range(imx335->vblank_ctrl, mode->vblank_min,  in imx335_update_controls()
382 					mode->vblank_max, 1, mode->vblank);  in imx335_update_controls()
386  * imx335_update_exp_gain() - Set updated exposure and gain
398 	lpfr = imx335->vblank + imx335->cur_mode->height;  in imx335_update_exp_gain()
399 	shutter = lpfr - exposure;  in imx335_update_exp_gain()
401 	dev_dbg(imx335->dev, "Set exp %u, analog gain %u, shutter %u, lpfr %u",  in imx335_update_exp_gain()
425  * imx335_set_ctrl() - Set subdevice control
429  * - V4L2_CID_VBLANK
430  * - cluster controls:
431  *   - V4L2_CID_ANALOGUE_GAIN
432  *   - V4L2_CID_EXPOSURE
439 		container_of(ctrl->handler, struct imx335, ctrl_handler);  in imx335_set_ctrl()
444 	switch (ctrl->id) {  in imx335_set_ctrl()
446 		imx335->vblank = imx335->vblank_ctrl->val;  in imx335_set_ctrl()
448 		dev_dbg(imx335->dev, "Received vblank %u, new lpfr %u",  in imx335_set_ctrl()
449 			imx335->vblank,  in imx335_set_ctrl()
450 			imx335->vblank + imx335->cur_mode->height);  in imx335_set_ctrl()
452 		ret = __v4l2_ctrl_modify_range(imx335->exp_ctrl,  in imx335_set_ctrl()
454 					       imx335->vblank +  in imx335_set_ctrl()
455 					       imx335->cur_mode->height -  in imx335_set_ctrl()
461 		if (!pm_runtime_get_if_in_use(imx335->dev))  in imx335_set_ctrl()
464 		exposure = ctrl->val;  in imx335_set_ctrl()
465 		analog_gain = imx335->again_ctrl->val;  in imx335_set_ctrl()
467 		dev_dbg(imx335->dev, "Received exp %u, analog gain %u",  in imx335_set_ctrl()
472 		pm_runtime_put(imx335->dev);  in imx335_set_ctrl()
476 		dev_err(imx335->dev, "Invalid control %d", ctrl->id);  in imx335_set_ctrl()
477 		ret = -EINVAL;  in imx335_set_ctrl()
489  * imx335_enum_mbus_code() - Enumerate V4L2 sub-device mbus codes
490  * @sd: pointer to imx335 V4L2 sub-device structure
491  * @sd_state: V4L2 sub-device configuration
492  * @code: V4L2 sub-device code enumeration need to be filled
496 static int imx335_enum_mbus_code(struct v4l2_subdev *sd,  in imx335_enum_mbus_code()  argument
500 	if (code->index > 0)  in imx335_enum_mbus_code()
501 		return -EINVAL;  in imx335_enum_mbus_code()
503 	code->code = supported_mode.code;  in imx335_enum_mbus_code()
509  * imx335_enum_frame_size() - Enumerate V4L2 sub-device frame sizes
510  * @sd: pointer to imx335 V4L2 sub-device structure
511  * @sd_state: V4L2 sub-device configuration
512  * @fsize: V4L2 sub-device size enumeration need to be filled
516 static int imx335_enum_frame_size(struct v4l2_subdev *sd,  in imx335_enum_frame_size()  argument
520 	if (fsize->index > 0)  in imx335_enum_frame_size()
521 		return -EINVAL;  in imx335_enum_frame_size()
523 	if (fsize->code != supported_mode.code)  in imx335_enum_frame_size()
524 		return -EINVAL;  in imx335_enum_frame_size()
526 	fsize->min_width = supported_mode.width;  in imx335_enum_frame_size()
527 	fsize->max_width = fsize->min_width;  in imx335_enum_frame_size()
528 	fsize->min_height = supported_mode.height;  in imx335_enum_frame_size()
529 	fsize->max_height = fsize->min_height;  in imx335_enum_frame_size()
535  * imx335_fill_pad_format() - Fill subdevice pad format
539  * @fmt: V4L2 sub-device format need to be filled
545 	fmt->format.width = mode->width;  in imx335_fill_pad_format()
546 	fmt->format.height = mode->height;  in imx335_fill_pad_format()
547 	fmt->format.code = mode->code;  in imx335_fill_pad_format()
548 	fmt->format.field = V4L2_FIELD_NONE;  in imx335_fill_pad_format()
549 	fmt->format.colorspace = V4L2_COLORSPACE_RAW;  in imx335_fill_pad_format()
550 	fmt->format.ycbcr_enc = V4L2_YCBCR_ENC_DEFAULT;  in imx335_fill_pad_format()
551 	fmt->format.quantization = V4L2_QUANTIZATION_DEFAULT;  in imx335_fill_pad_format()
552 	fmt->format.xfer_func = V4L2_XFER_FUNC_NONE;  in imx335_fill_pad_format()
556  * imx335_get_pad_format() - Get subdevice pad format
557  * @sd: pointer to imx335 V4L2 sub-device structure
558  * @sd_state: V4L2 sub-device configuration
559  * @fmt: V4L2 sub-device format need to be set
563 static int imx335_get_pad_format(struct v4l2_subdev *sd,  in imx335_get_pad_format()  argument
567 	struct imx335 *imx335 = to_imx335(sd);  in imx335_get_pad_format()
569 	mutex_lock(&imx335->mutex);  in imx335_get_pad_format()
571 	if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {  in imx335_get_pad_format()
574 		framefmt = v4l2_subdev_get_try_format(sd, sd_state, fmt->pad);  in imx335_get_pad_format()
575 		fmt->format = *framefmt;  in imx335_get_pad_format()
577 		imx335_fill_pad_format(imx335, imx335->cur_mode, fmt);  in imx335_get_pad_format()
580 	mutex_unlock(&imx335->mutex);  in imx335_get_pad_format()
586  * imx335_set_pad_format() - Set subdevice pad format
587  * @sd: pointer to imx335 V4L2 sub-device structure
588  * @sd_state: V4L2 sub-device configuration
589  * @fmt: V4L2 sub-device format need to be set
593 static int imx335_set_pad_format(struct v4l2_subdev *sd,  in imx335_set_pad_format()  argument
597 	struct imx335 *imx335 = to_imx335(sd);  in imx335_set_pad_format()
601 	mutex_lock(&imx335->mutex);  in imx335_set_pad_format()
606 	if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {  in imx335_set_pad_format()
609 		framefmt = v4l2_subdev_get_try_format(sd, sd_state, fmt->pad);  in imx335_set_pad_format()
610 		*framefmt = fmt->format;  in imx335_set_pad_format()
614 			imx335->cur_mode = mode;  in imx335_set_pad_format()
617 	mutex_unlock(&imx335->mutex);  in imx335_set_pad_format()
623  * imx335_init_pad_cfg() - Initialize sub-device pad configuration
624  * @sd: pointer to imx335 V4L2 sub-device structure
625  * @sd_state: V4L2 sub-device configuration
629 static int imx335_init_pad_cfg(struct v4l2_subdev *sd,  in imx335_init_pad_cfg()  argument
632 	struct imx335 *imx335 = to_imx335(sd);  in imx335_init_pad_cfg()
638 	return imx335_set_pad_format(sd, sd_state, &fmt);  in imx335_init_pad_cfg()
642  * imx335_start_streaming() - Start sensor stream
653 	reg_list = &imx335->cur_mode->reg_list;  in imx335_start_streaming()
654 	ret = imx335_write_regs(imx335, reg_list->regs,  in imx335_start_streaming()
655 				reg_list->num_of_regs);  in imx335_start_streaming()
657 		dev_err(imx335->dev, "fail to write initial registers");  in imx335_start_streaming()
662 	ret =  __v4l2_ctrl_handler_setup(imx335->sd.ctrl_handler);  in imx335_start_streaming()
664 		dev_err(imx335->dev, "fail to setup handler");  in imx335_start_streaming()
672 		dev_err(imx335->dev, "fail to start streaming");  in imx335_start_streaming()
683  * imx335_stop_streaming() - Stop sensor stream
695  * imx335_set_stream() - Enable sensor streaming
696  * @sd: pointer to imx335 subdevice
701 static int imx335_set_stream(struct v4l2_subdev *sd, int enable)  in imx335_set_stream()  argument
703 	struct imx335 *imx335 = to_imx335(sd);  in imx335_set_stream()
706 	mutex_lock(&imx335->mutex);  in imx335_set_stream()
708 	if (imx335->streaming == enable) {  in imx335_set_stream()
709 		mutex_unlock(&imx335->mutex);  in imx335_set_stream()
714 		ret = pm_runtime_resume_and_get(imx335->dev);  in imx335_set_stream()
723 		pm_runtime_put(imx335->dev);  in imx335_set_stream()
726 	imx335->streaming = enable;  in imx335_set_stream()
728 	mutex_unlock(&imx335->mutex);  in imx335_set_stream()
733 	pm_runtime_put(imx335->dev);  in imx335_set_stream()
735 	mutex_unlock(&imx335->mutex);  in imx335_set_stream()
741  * imx335_detect() - Detect imx335 sensor
744  * Return: 0 if successful, -EIO if sensor id does not match
756 		dev_err(imx335->dev, "chip id mismatch: %x!=%x",  in imx335_detect()
758 		return -ENXIO;  in imx335_detect()
765  * imx335_parse_hw_config() - Parse HW configuration and check if supported
772 	struct fwnode_handle *fwnode = dev_fwnode(imx335->dev);  in imx335_parse_hw_config()
782 		return -ENXIO;  in imx335_parse_hw_config()
785 	imx335->reset_gpio = devm_gpiod_get_optional(imx335->dev, "reset",  in imx335_parse_hw_config()
787 	if (IS_ERR(imx335->reset_gpio)) {  in imx335_parse_hw_config()
788 		dev_err(imx335->dev, "failed to get reset gpio %ld",  in imx335_parse_hw_config()
789 			PTR_ERR(imx335->reset_gpio));  in imx335_parse_hw_config()
790 		return PTR_ERR(imx335->reset_gpio);  in imx335_parse_hw_config()
794 	imx335->inclk = devm_clk_get(imx335->dev, NULL);  in imx335_parse_hw_config()
795 	if (IS_ERR(imx335->inclk)) {  in imx335_parse_hw_config()
796 		dev_err(imx335->dev, "could not get inclk");  in imx335_parse_hw_config()
797 		return PTR_ERR(imx335->inclk);  in imx335_parse_hw_config()
800 	rate = clk_get_rate(imx335->inclk);  in imx335_parse_hw_config()
802 		dev_err(imx335->dev, "inclk frequency mismatch");  in imx335_parse_hw_config()
803 		return -EINVAL;  in imx335_parse_hw_config()
808 		return -ENXIO;  in imx335_parse_hw_config()
816 		dev_err(imx335->dev,  in imx335_parse_hw_config()
819 		ret = -EINVAL;  in imx335_parse_hw_config()
824 		dev_err(imx335->dev, "no link frequencies defined");  in imx335_parse_hw_config()
825 		ret = -EINVAL;  in imx335_parse_hw_config()
833 	ret = -EINVAL;  in imx335_parse_hw_config()
860  * imx335_power_on() - Sensor power on sequence
867 	struct v4l2_subdev *sd = dev_get_drvdata(dev);  in imx335_power_on()  local
868 	struct imx335 *imx335 = to_imx335(sd);  in imx335_power_on()
871 	gpiod_set_value_cansleep(imx335->reset_gpio, 1);  in imx335_power_on()
873 	ret = clk_prepare_enable(imx335->inclk);  in imx335_power_on()
875 		dev_err(imx335->dev, "fail to enable inclk");  in imx335_power_on()
884 	gpiod_set_value_cansleep(imx335->reset_gpio, 0);  in imx335_power_on()
890  * imx335_power_off() - Sensor power off sequence
897 	struct v4l2_subdev *sd = dev_get_drvdata(dev);  in imx335_power_off()  local
898 	struct imx335 *imx335 = to_imx335(sd);  in imx335_power_off()
900 	gpiod_set_value_cansleep(imx335->reset_gpio, 0);  in imx335_power_off()
902 	clk_disable_unprepare(imx335->inclk);  in imx335_power_off()
908  * imx335_init_controls() - Initialize sensor subdevice controls
915 	struct v4l2_ctrl_handler *ctrl_hdlr = &imx335->ctrl_handler;  in imx335_init_controls()
916 	const struct imx335_mode *mode = imx335->cur_mode;  in imx335_init_controls()
925 	ctrl_hdlr->lock = &imx335->mutex;  in imx335_init_controls()
928 	lpfr = mode->vblank + mode->height;  in imx335_init_controls()
929 	imx335->exp_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,  in imx335_init_controls()
933 					     lpfr - IMX335_EXPOSURE_OFFSET,  in imx335_init_controls()
937 	imx335->again_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,  in imx335_init_controls()
945 	v4l2_ctrl_cluster(2, &imx335->exp_ctrl);  in imx335_init_controls()
947 	imx335->vblank_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,  in imx335_init_controls()
950 						mode->vblank_min,  in imx335_init_controls()
951 						mode->vblank_max,  in imx335_init_controls()
952 						1, mode->vblank);  in imx335_init_controls()
955 	imx335->pclk_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,  in imx335_init_controls()
958 					      mode->pclk, mode->pclk,  in imx335_init_controls()
959 					      1, mode->pclk);  in imx335_init_controls()
961 	imx335->link_freq_ctrl = v4l2_ctrl_new_int_menu(ctrl_hdlr,  in imx335_init_controls()
964 							ARRAY_SIZE(link_freq) -  in imx335_init_controls()
966 							mode->link_freq_idx,  in imx335_init_controls()
968 	if (imx335->link_freq_ctrl)  in imx335_init_controls()
969 		imx335->link_freq_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;  in imx335_init_controls()
971 	imx335->hblank_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,  in imx335_init_controls()
976 						1, mode->hblank);  in imx335_init_controls()
977 	if (imx335->hblank_ctrl)  in imx335_init_controls()
978 		imx335->hblank_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;  in imx335_init_controls()
980 	if (ctrl_hdlr->error) {  in imx335_init_controls()
981 		dev_err(imx335->dev, "control init failed: %d",  in imx335_init_controls()
982 			ctrl_hdlr->error);  in imx335_init_controls()
984 		return ctrl_hdlr->error;  in imx335_init_controls()
987 	imx335->sd.ctrl_handler = ctrl_hdlr;  in imx335_init_controls()
993  * imx335_probe() - I2C client device binding
1003 	imx335 = devm_kzalloc(&client->dev, sizeof(*imx335), GFP_KERNEL);  in imx335_probe()
1005 		return -ENOMEM;  in imx335_probe()
1007 	imx335->dev = &client->dev;  in imx335_probe()
1010 	v4l2_i2c_subdev_init(&imx335->sd, client, &imx335_subdev_ops);  in imx335_probe()
1014 		dev_err(imx335->dev, "HW configuration is not supported");  in imx335_probe()
1018 	mutex_init(&imx335->mutex);  in imx335_probe()
1020 	ret = imx335_power_on(imx335->dev);  in imx335_probe()
1022 		dev_err(imx335->dev, "failed to power-on the sensor");  in imx335_probe()
1029 		dev_err(imx335->dev, "failed to find sensor: %d", ret);  in imx335_probe()
1034 	imx335->cur_mode = &supported_mode;  in imx335_probe()
1035 	imx335->vblank = imx335->cur_mode->vblank;  in imx335_probe()
1039 		dev_err(imx335->dev, "failed to init controls: %d", ret);  in imx335_probe()
1044 	imx335->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;  in imx335_probe()
1045 	imx335->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;  in imx335_probe()
1048 	imx335->pad.flags = MEDIA_PAD_FL_SOURCE;  in imx335_probe()
1049 	ret = media_entity_pads_init(&imx335->sd.entity, 1, &imx335->pad);  in imx335_probe()
1051 		dev_err(imx335->dev, "failed to init entity pads: %d", ret);  in imx335_probe()
1055 	ret = v4l2_async_register_subdev_sensor(&imx335->sd);  in imx335_probe()
1057 		dev_err(imx335->dev,  in imx335_probe()
1062 	pm_runtime_set_active(imx335->dev);  in imx335_probe()
1063 	pm_runtime_enable(imx335->dev);  in imx335_probe()
1064 	pm_runtime_idle(imx335->dev);  in imx335_probe()
1069 	media_entity_cleanup(&imx335->sd.entity);  in imx335_probe()
1071 	v4l2_ctrl_handler_free(imx335->sd.ctrl_handler);  in imx335_probe()
1073 	imx335_power_off(imx335->dev);  in imx335_probe()
1075 	mutex_destroy(&imx335->mutex);  in imx335_probe()
1081  * imx335_remove() - I2C client device unbinding
1088 	struct v4l2_subdev *sd = i2c_get_clientdata(client);  in imx335_remove()  local
1089 	struct imx335 *imx335 = to_imx335(sd);  in imx335_remove()
1091 	v4l2_async_unregister_subdev(sd);  in imx335_remove()
1092 	media_entity_cleanup(&sd->entity);  in imx335_remove()
1093 	v4l2_ctrl_handler_free(sd->ctrl_handler);  in imx335_remove()
1095 	pm_runtime_disable(&client->dev);  in imx335_remove()
1096 	if (!pm_runtime_status_suspended(&client->dev))  in imx335_remove()
1097 		imx335_power_off(&client->dev);  in imx335_remove()
1098 	pm_runtime_set_suspended(&client->dev);  in imx335_remove()
1100 	mutex_destroy(&imx335->mutex);  in imx335_remove()