1 // SPDX-License-Identifier: GPL-2.0
5 * Qualcomm MSM Camera Subsystem - CSID (CSI Decoder) Module
7 * Copyright (c) 2011-2015, The Linux Foundation. All rights reserved.
8 * Copyright (C) 2015-2018 Linaro Ltd.
10 #include <linux/clk.h>
11 #include <linux/completion.h>
12 #include <linux/interrupt.h>
14 #include <linux/kernel.h>
16 #include <linux/platform_device.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/regulator/consumer.h>
19 #include <media/media-entity.h>
20 #include <media/v4l2-device.h>
21 #include <media/v4l2-event.h>
22 #include <media/v4l2-subdev.h>
24 #include "camss-csid.h"
25 #include "camss-csid-gen1.h"
28 #define MSM_CSID_NAME "msm_csid"
30 const char * const csid_testgen_modes[] = {
33 "Alternating 0x55/0xAA",
44 u32 csid_find_code(u32 *codes, unsigned int ncodes,
45 unsigned int match_format_idx, u32 match_code)
49 if (!match_code && (match_format_idx >= ncodes))
52 for (i = 0; i < ncodes; i++)
54 if (codes[i] == match_code)
57 if (i == match_format_idx)
64 const struct csid_format *csid_get_fmt_entry(const struct csid_format *formats,
65 unsigned int nformats,
70 for (i = 0; i < nformats; i++)
71 if (code == formats[i].code)
74 WARN(1, "Unknown format\n");
80 * csid_set_clock_rates - Calculate and set clock rates on CSID module
81 * @csiphy: CSID device
83 static int csid_set_clock_rates(struct csid_device *csid)
85 struct device *dev = csid->camss->dev;
86 const struct csid_format *fmt;
91 fmt = csid_get_fmt_entry(csid->formats, csid->nformats,
92 csid->fmt[MSM_CSIPHY_PAD_SINK].code);
93 link_freq = camss_get_link_freq(&csid->subdev.entity, fmt->bpp,
98 for (i = 0; i < csid->nclocks; i++) {
99 struct camss_clock *clock = &csid->clock[i];
101 if (!strcmp(clock->name, "csi0") ||
102 !strcmp(clock->name, "csi1") ||
103 !strcmp(clock->name, "csi2") ||
104 !strcmp(clock->name, "csi3")) {
105 u64 min_rate = link_freq / 4;
108 camss_add_clock_margin(&min_rate);
110 for (j = 0; j < clock->nfreqs; j++)
111 if (min_rate < clock->freq[j])
114 if (j == clock->nfreqs) {
116 "Pixel clock is too high for CSID\n");
120 /* if sensor pixel clock is not available */
121 /* set highest possible CSID clock rate */
123 j = clock->nfreqs - 1;
125 rate = clk_round_rate(clock->clk, clock->freq[j]);
127 dev_err(dev, "clk round rate failed: %ld\n",
132 ret = clk_set_rate(clock->clk, rate);
134 dev_err(dev, "clk set rate failed: %d\n", ret);
137 } else if (clock->nfreqs) {
138 clk_set_rate(clock->clk, clock->freq[0]);
146 * csid_set_power - Power on/off CSID module
147 * @sd: CSID V4L2 subdevice
148 * @on: Requested power state
150 * Return 0 on success or a negative error code otherwise
152 static int csid_set_power(struct v4l2_subdev *sd, int on)
154 struct csid_device *csid = v4l2_get_subdevdata(sd);
155 struct device *dev = csid->camss->dev;
159 ret = pm_runtime_resume_and_get(dev);
163 ret = regulator_enable(csid->vdda);
165 pm_runtime_put_sync(dev);
169 ret = csid_set_clock_rates(csid);
171 regulator_disable(csid->vdda);
172 pm_runtime_put_sync(dev);
176 ret = camss_enable_clocks(csid->nclocks, csid->clock, dev);
178 regulator_disable(csid->vdda);
179 pm_runtime_put_sync(dev);
183 enable_irq(csid->irq);
185 ret = csid->ops->reset(csid);
187 disable_irq(csid->irq);
188 camss_disable_clocks(csid->nclocks, csid->clock);
189 regulator_disable(csid->vdda);
190 pm_runtime_put_sync(dev);
194 csid->ops->hw_version(csid);
196 disable_irq(csid->irq);
197 camss_disable_clocks(csid->nclocks, csid->clock);
198 ret = regulator_disable(csid->vdda);
199 pm_runtime_put_sync(dev);
206 * csid_set_stream - Enable/disable streaming on CSID module
207 * @sd: CSID V4L2 subdevice
208 * @enable: Requested streaming state
210 * Main configuration of CSID module is also done here.
212 * Return 0 on success or a negative error code otherwise
214 static int csid_set_stream(struct v4l2_subdev *sd, int enable)
216 struct csid_device *csid = v4l2_get_subdevdata(sd);
220 ret = v4l2_ctrl_handler_setup(&csid->ctrls);
222 dev_err(csid->camss->dev,
223 "could not sync v4l2 controls: %d\n", ret);
227 if (!csid->testgen.enabled &&
228 !media_entity_remote_pad(&csid->pads[MSM_CSID_PAD_SINK]))
232 csid->ops->configure_stream(csid, enable);
238 * __csid_get_format - Get pointer to format structure
240 * @cfg: V4L2 subdev pad configuration
241 * @pad: pad from which format is requested
242 * @which: TRY or ACTIVE format
244 * Return pointer to TRY or ACTIVE format structure
246 static struct v4l2_mbus_framefmt *
247 __csid_get_format(struct csid_device *csid,
248 struct v4l2_subdev_state *sd_state,
250 enum v4l2_subdev_format_whence which)
252 if (which == V4L2_SUBDEV_FORMAT_TRY)
253 return v4l2_subdev_get_try_format(&csid->subdev, sd_state,
256 return &csid->fmt[pad];
260 * csid_try_format - Handle try format by pad subdev method
262 * @cfg: V4L2 subdev pad configuration
263 * @pad: pad on which format is requested
264 * @fmt: pointer to v4l2 format structure
265 * @which: wanted subdev format
267 static void csid_try_format(struct csid_device *csid,
268 struct v4l2_subdev_state *sd_state,
270 struct v4l2_mbus_framefmt *fmt,
271 enum v4l2_subdev_format_whence which)
276 case MSM_CSID_PAD_SINK:
277 /* Set format on sink pad */
279 for (i = 0; i < csid->nformats; i++)
280 if (fmt->code == csid->formats[i].code)
283 /* If not found, use UYVY as default */
284 if (i >= csid->nformats)
285 fmt->code = MEDIA_BUS_FMT_UYVY8_2X8;
287 fmt->width = clamp_t(u32, fmt->width, 1, 8191);
288 fmt->height = clamp_t(u32, fmt->height, 1, 8191);
290 fmt->field = V4L2_FIELD_NONE;
291 fmt->colorspace = V4L2_COLORSPACE_SRGB;
295 case MSM_CSID_PAD_SRC:
296 if (csid->testgen_mode->cur.val == 0) {
297 /* Test generator is disabled, */
298 /* keep pad formats in sync */
299 u32 code = fmt->code;
301 *fmt = *__csid_get_format(csid, sd_state,
302 MSM_CSID_PAD_SINK, which);
303 fmt->code = csid->ops->src_pad_code(csid, fmt->code, 0, code);
305 /* Test generator is enabled, set format on source */
306 /* pad to allow test generator usage */
308 for (i = 0; i < csid->nformats; i++)
309 if (csid->formats[i].code == fmt->code)
312 /* If not found, use UYVY as default */
313 if (i >= csid->nformats)
314 fmt->code = MEDIA_BUS_FMT_UYVY8_2X8;
316 fmt->width = clamp_t(u32, fmt->width, 1, 8191);
317 fmt->height = clamp_t(u32, fmt->height, 1, 8191);
319 fmt->field = V4L2_FIELD_NONE;
324 fmt->colorspace = V4L2_COLORSPACE_SRGB;
328 * csid_enum_mbus_code - Handle pixel format enumeration
329 * @sd: CSID V4L2 subdevice
330 * @cfg: V4L2 subdev pad configuration
331 * @code: pointer to v4l2_subdev_mbus_code_enum structure
332 * return -EINVAL or zero on success
334 static int csid_enum_mbus_code(struct v4l2_subdev *sd,
335 struct v4l2_subdev_state *sd_state,
336 struct v4l2_subdev_mbus_code_enum *code)
338 struct csid_device *csid = v4l2_get_subdevdata(sd);
340 if (code->pad == MSM_CSID_PAD_SINK) {
341 if (code->index >= csid->nformats)
344 code->code = csid->formats[code->index].code;
346 if (csid->testgen_mode->cur.val == 0) {
347 struct v4l2_mbus_framefmt *sink_fmt;
349 sink_fmt = __csid_get_format(csid, sd_state,
353 code->code = csid->ops->src_pad_code(csid, sink_fmt->code,
358 if (code->index >= csid->nformats)
361 code->code = csid->formats[code->index].code;
369 * csid_enum_frame_size - Handle frame size enumeration
370 * @sd: CSID V4L2 subdevice
371 * @cfg: V4L2 subdev pad configuration
372 * @fse: pointer to v4l2_subdev_frame_size_enum structure
373 * return -EINVAL or zero on success
375 static int csid_enum_frame_size(struct v4l2_subdev *sd,
376 struct v4l2_subdev_state *sd_state,
377 struct v4l2_subdev_frame_size_enum *fse)
379 struct csid_device *csid = v4l2_get_subdevdata(sd);
380 struct v4l2_mbus_framefmt format;
385 format.code = fse->code;
388 csid_try_format(csid, sd_state, fse->pad, &format, fse->which);
389 fse->min_width = format.width;
390 fse->min_height = format.height;
392 if (format.code != fse->code)
395 format.code = fse->code;
398 csid_try_format(csid, sd_state, fse->pad, &format, fse->which);
399 fse->max_width = format.width;
400 fse->max_height = format.height;
406 * csid_get_format - Handle get format by pads subdev method
407 * @sd: CSID V4L2 subdevice
408 * @cfg: V4L2 subdev pad configuration
409 * @fmt: pointer to v4l2 subdev format structure
411 * Return -EINVAL or zero on success
413 static int csid_get_format(struct v4l2_subdev *sd,
414 struct v4l2_subdev_state *sd_state,
415 struct v4l2_subdev_format *fmt)
417 struct csid_device *csid = v4l2_get_subdevdata(sd);
418 struct v4l2_mbus_framefmt *format;
420 format = __csid_get_format(csid, sd_state, fmt->pad, fmt->which);
424 fmt->format = *format;
430 * csid_set_format - Handle set format by pads subdev method
431 * @sd: CSID V4L2 subdevice
432 * @cfg: V4L2 subdev pad configuration
433 * @fmt: pointer to v4l2 subdev format structure
435 * Return -EINVAL or zero on success
437 static int csid_set_format(struct v4l2_subdev *sd,
438 struct v4l2_subdev_state *sd_state,
439 struct v4l2_subdev_format *fmt)
441 struct csid_device *csid = v4l2_get_subdevdata(sd);
442 struct v4l2_mbus_framefmt *format;
444 format = __csid_get_format(csid, sd_state, fmt->pad, fmt->which);
448 csid_try_format(csid, sd_state, fmt->pad, &fmt->format, fmt->which);
449 *format = fmt->format;
451 /* Propagate the format from sink to source */
452 if (fmt->pad == MSM_CSID_PAD_SINK) {
453 format = __csid_get_format(csid, sd_state, MSM_CSID_PAD_SRC,
456 *format = fmt->format;
457 csid_try_format(csid, sd_state, MSM_CSID_PAD_SRC, format,
465 * csid_init_formats - Initialize formats on all pads
466 * @sd: CSID V4L2 subdevice
467 * @fh: V4L2 subdev file handle
469 * Initialize all pad formats with default values.
471 * Return 0 on success or a negative error code otherwise
473 static int csid_init_formats(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
475 struct v4l2_subdev_format format = {
476 .pad = MSM_CSID_PAD_SINK,
477 .which = fh ? V4L2_SUBDEV_FORMAT_TRY :
478 V4L2_SUBDEV_FORMAT_ACTIVE,
480 .code = MEDIA_BUS_FMT_UYVY8_2X8,
486 return csid_set_format(sd, fh ? fh->state : NULL, &format);
490 * csid_set_test_pattern - Set test generator's pattern mode
492 * @value: desired test pattern mode
494 * Return 0 on success or a negative error code otherwise
496 static int csid_set_test_pattern(struct csid_device *csid, s32 value)
498 struct csid_testgen_config *tg = &csid->testgen;
500 /* If CSID is linked to CSIPHY, do not allow to enable test generator */
501 if (value && media_entity_remote_pad(&csid->pads[MSM_CSID_PAD_SINK]))
504 tg->enabled = !!value;
506 return csid->ops->configure_testgen_pattern(csid, value);
510 * csid_s_ctrl - Handle set control subdev method
511 * @ctrl: pointer to v4l2 control structure
513 * Return 0 on success or a negative error code otherwise
515 static int csid_s_ctrl(struct v4l2_ctrl *ctrl)
517 struct csid_device *csid = container_of(ctrl->handler,
518 struct csid_device, ctrls);
522 case V4L2_CID_TEST_PATTERN:
523 ret = csid_set_test_pattern(csid, ctrl->val);
530 static const struct v4l2_ctrl_ops csid_ctrl_ops = {
531 .s_ctrl = csid_s_ctrl,
535 * msm_csid_subdev_init - Initialize CSID device structure and resources
537 * @res: CSID module resources table
538 * @id: CSID module id
540 * Return 0 on success or a negative error code otherwise
542 int msm_csid_subdev_init(struct camss *camss, struct csid_device *csid,
543 const struct resources *res, u8 id)
545 struct device *dev = camss->dev;
546 struct platform_device *pdev = to_platform_device(dev);
554 if (camss->version == CAMSS_8x16) {
555 csid->ops = &csid_ops_4_1;
556 } else if (camss->version == CAMSS_8x96 ||
557 camss->version == CAMSS_660) {
558 csid->ops = &csid_ops_4_7;
559 } else if (camss->version == CAMSS_845) {
560 csid->ops = &csid_ops_170;
564 csid->ops->subdev_init(csid);
568 csid->base = devm_platform_ioremap_resource_byname(pdev, res->reg[0]);
569 if (IS_ERR(csid->base))
570 return PTR_ERR(csid->base);
574 r = platform_get_resource_byname(pdev, IORESOURCE_IRQ,
577 dev_err(dev, "missing IRQ\n");
581 csid->irq = r->start;
582 snprintf(csid->irq_name, sizeof(csid->irq_name), "%s_%s%d",
583 dev_name(dev), MSM_CSID_NAME, csid->id);
584 ret = devm_request_irq(dev, csid->irq, csid->ops->isr,
585 IRQF_TRIGGER_RISING | IRQF_NO_AUTOEN,
586 csid->irq_name, csid);
588 dev_err(dev, "request_irq failed: %d\n", ret);
595 while (res->clock[csid->nclocks])
598 csid->clock = devm_kcalloc(dev, csid->nclocks, sizeof(*csid->clock),
603 for (i = 0; i < csid->nclocks; i++) {
604 struct camss_clock *clock = &csid->clock[i];
606 clock->clk = devm_clk_get(dev, res->clock[i]);
607 if (IS_ERR(clock->clk))
608 return PTR_ERR(clock->clk);
610 clock->name = res->clock[i];
613 while (res->clock_rate[i][clock->nfreqs])
616 if (!clock->nfreqs) {
621 clock->freq = devm_kcalloc(dev,
623 sizeof(*clock->freq),
628 for (j = 0; j < clock->nfreqs; j++)
629 clock->freq[j] = res->clock_rate[i][j];
634 csid->vdda = devm_regulator_get(dev, res->regulator[0]);
635 if (IS_ERR(csid->vdda)) {
636 dev_err(dev, "could not get regulator\n");
637 return PTR_ERR(csid->vdda);
640 init_completion(&csid->reset_complete);
646 * msm_csid_get_csid_id - Get CSID HW module id
647 * @entity: Pointer to CSID media entity structure
648 * @id: Return CSID HW module id here
650 void msm_csid_get_csid_id(struct media_entity *entity, u8 *id)
652 struct v4l2_subdev *sd = media_entity_to_v4l2_subdev(entity);
653 struct csid_device *csid = v4l2_get_subdevdata(sd);
659 * csid_get_lane_assign - Calculate CSI2 lane assign configuration parameter
660 * @lane_cfg - CSI2 lane configuration
664 static u32 csid_get_lane_assign(struct csiphy_lanes_cfg *lane_cfg)
669 for (i = 0; i < lane_cfg->num_data; i++)
670 lane_assign |= lane_cfg->data[i].pos << (i * 4);
676 * csid_link_setup - Setup CSID connections
677 * @entity: Pointer to media entity structure
678 * @local: Pointer to local pad
679 * @remote: Pointer to remote pad
682 * Return 0 on success
684 static int csid_link_setup(struct media_entity *entity,
685 const struct media_pad *local,
686 const struct media_pad *remote, u32 flags)
688 if (flags & MEDIA_LNK_FL_ENABLED)
689 if (media_entity_remote_pad(local))
692 if ((local->flags & MEDIA_PAD_FL_SINK) &&
693 (flags & MEDIA_LNK_FL_ENABLED)) {
694 struct v4l2_subdev *sd;
695 struct csid_device *csid;
696 struct csiphy_device *csiphy;
697 struct csiphy_lanes_cfg *lane_cfg;
698 struct v4l2_subdev_format format = { 0 };
700 sd = media_entity_to_v4l2_subdev(entity);
701 csid = v4l2_get_subdevdata(sd);
703 /* If test generator is enabled */
704 /* do not allow a link from CSIPHY to CSID */
705 if (csid->testgen_mode->cur.val != 0)
708 sd = media_entity_to_v4l2_subdev(remote->entity);
709 csiphy = v4l2_get_subdevdata(sd);
711 /* If a sensor is not linked to CSIPHY */
712 /* do no allow a link from CSIPHY to CSID */
713 if (!csiphy->cfg.csi2)
716 csid->phy.csiphy_id = csiphy->id;
718 lane_cfg = &csiphy->cfg.csi2->lane_cfg;
719 csid->phy.lane_cnt = lane_cfg->num_data;
720 csid->phy.lane_assign = csid_get_lane_assign(lane_cfg);
722 /* Reset format on source pad to sink pad format */
723 format.pad = MSM_CSID_PAD_SRC;
724 format.which = V4L2_SUBDEV_FORMAT_ACTIVE;
725 csid_set_format(&csid->subdev, NULL, &format);
731 static const struct v4l2_subdev_core_ops csid_core_ops = {
732 .s_power = csid_set_power,
733 .subscribe_event = v4l2_ctrl_subdev_subscribe_event,
734 .unsubscribe_event = v4l2_event_subdev_unsubscribe,
737 static const struct v4l2_subdev_video_ops csid_video_ops = {
738 .s_stream = csid_set_stream,
741 static const struct v4l2_subdev_pad_ops csid_pad_ops = {
742 .enum_mbus_code = csid_enum_mbus_code,
743 .enum_frame_size = csid_enum_frame_size,
744 .get_fmt = csid_get_format,
745 .set_fmt = csid_set_format,
748 static const struct v4l2_subdev_ops csid_v4l2_ops = {
749 .core = &csid_core_ops,
750 .video = &csid_video_ops,
751 .pad = &csid_pad_ops,
754 static const struct v4l2_subdev_internal_ops csid_v4l2_internal_ops = {
755 .open = csid_init_formats,
758 static const struct media_entity_operations csid_media_ops = {
759 .link_setup = csid_link_setup,
760 .link_validate = v4l2_subdev_link_validate,
764 * msm_csid_register_entity - Register subdev node for CSID module
766 * @v4l2_dev: V4L2 device
768 * Return 0 on success or a negative error code otherwise
770 int msm_csid_register_entity(struct csid_device *csid,
771 struct v4l2_device *v4l2_dev)
773 struct v4l2_subdev *sd = &csid->subdev;
774 struct media_pad *pads = csid->pads;
775 struct device *dev = csid->camss->dev;
778 v4l2_subdev_init(sd, &csid_v4l2_ops);
779 sd->internal_ops = &csid_v4l2_internal_ops;
780 sd->flags |= V4L2_SUBDEV_FL_HAS_DEVNODE |
781 V4L2_SUBDEV_FL_HAS_EVENTS;
782 snprintf(sd->name, ARRAY_SIZE(sd->name), "%s%d",
783 MSM_CSID_NAME, csid->id);
784 v4l2_set_subdevdata(sd, csid);
786 ret = v4l2_ctrl_handler_init(&csid->ctrls, 1);
788 dev_err(dev, "Failed to init ctrl handler: %d\n", ret);
792 csid->testgen_mode = v4l2_ctrl_new_std_menu_items(&csid->ctrls,
793 &csid_ctrl_ops, V4L2_CID_TEST_PATTERN,
794 csid->testgen.nmodes, 0, 0,
795 csid->testgen.modes);
797 if (csid->ctrls.error) {
798 dev_err(dev, "Failed to init ctrl: %d\n", csid->ctrls.error);
799 ret = csid->ctrls.error;
803 csid->subdev.ctrl_handler = &csid->ctrls;
805 ret = csid_init_formats(sd, NULL);
807 dev_err(dev, "Failed to init format: %d\n", ret);
811 pads[MSM_CSID_PAD_SINK].flags = MEDIA_PAD_FL_SINK;
812 pads[MSM_CSID_PAD_SRC].flags = MEDIA_PAD_FL_SOURCE;
814 sd->entity.function = MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER;
815 sd->entity.ops = &csid_media_ops;
816 ret = media_entity_pads_init(&sd->entity, MSM_CSID_PADS_NUM, pads);
818 dev_err(dev, "Failed to init media entity: %d\n", ret);
822 ret = v4l2_device_register_subdev(v4l2_dev, sd);
824 dev_err(dev, "Failed to register subdev: %d\n", ret);
831 media_entity_cleanup(&sd->entity);
833 v4l2_ctrl_handler_free(&csid->ctrls);
839 * msm_csid_unregister_entity - Unregister CSID module subdev node
842 void msm_csid_unregister_entity(struct csid_device *csid)
844 v4l2_device_unregister_subdev(&csid->subdev);
845 media_entity_cleanup(&csid->subdev.entity);
846 v4l2_ctrl_handler_free(&csid->ctrls);