1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2020-2022 Bootlin
4 * Author: Paul Kocialkowski <paul.kocialkowski@bootlin.com>
8 #include <linux/module.h>
10 #include <linux/of_device.h>
11 #include <linux/phy/phy.h>
12 #include <linux/platform_device.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/regmap.h>
15 #include <linux/reset.h>
16 #include <media/mipi-csi2.h>
17 #include <media/v4l2-ctrls.h>
18 #include <media/v4l2-device.h>
19 #include <media/v4l2-fwnode.h>
21 #include "sun6i_mipi_csi2.h"
22 #include "sun6i_mipi_csi2_reg.h"
26 static const struct sun6i_mipi_csi2_format sun6i_mipi_csi2_formats[] = {
28 .mbus_code = MEDIA_BUS_FMT_SBGGR8_1X8,
29 .data_type = MIPI_CSI2_DT_RAW8,
33 .mbus_code = MEDIA_BUS_FMT_SGBRG8_1X8,
34 .data_type = MIPI_CSI2_DT_RAW8,
38 .mbus_code = MEDIA_BUS_FMT_SGRBG8_1X8,
39 .data_type = MIPI_CSI2_DT_RAW8,
43 .mbus_code = MEDIA_BUS_FMT_SRGGB8_1X8,
44 .data_type = MIPI_CSI2_DT_RAW8,
48 .mbus_code = MEDIA_BUS_FMT_SBGGR10_1X10,
49 .data_type = MIPI_CSI2_DT_RAW10,
53 .mbus_code = MEDIA_BUS_FMT_SGBRG10_1X10,
54 .data_type = MIPI_CSI2_DT_RAW10,
58 .mbus_code = MEDIA_BUS_FMT_SGRBG10_1X10,
59 .data_type = MIPI_CSI2_DT_RAW10,
63 .mbus_code = MEDIA_BUS_FMT_SRGGB10_1X10,
64 .data_type = MIPI_CSI2_DT_RAW10,
69 static const struct sun6i_mipi_csi2_format *
70 sun6i_mipi_csi2_format_find(u32 mbus_code)
74 for (i = 0; i < ARRAY_SIZE(sun6i_mipi_csi2_formats); i++)
75 if (sun6i_mipi_csi2_formats[i].mbus_code == mbus_code)
76 return &sun6i_mipi_csi2_formats[i];
83 static void sun6i_mipi_csi2_enable(struct sun6i_mipi_csi2_device *csi2_dev)
85 struct regmap *regmap = csi2_dev->regmap;
87 regmap_update_bits(regmap, SUN6I_MIPI_CSI2_CTL_REG,
88 SUN6I_MIPI_CSI2_CTL_EN, SUN6I_MIPI_CSI2_CTL_EN);
91 static void sun6i_mipi_csi2_disable(struct sun6i_mipi_csi2_device *csi2_dev)
93 struct regmap *regmap = csi2_dev->regmap;
95 regmap_update_bits(regmap, SUN6I_MIPI_CSI2_CTL_REG,
96 SUN6I_MIPI_CSI2_CTL_EN, 0);
99 static void sun6i_mipi_csi2_configure(struct sun6i_mipi_csi2_device *csi2_dev)
101 struct regmap *regmap = csi2_dev->regmap;
102 unsigned int lanes_count =
103 csi2_dev->bridge.endpoint.bus.mipi_csi2.num_data_lanes;
104 struct v4l2_mbus_framefmt *mbus_format = &csi2_dev->bridge.mbus_format;
105 const struct sun6i_mipi_csi2_format *format;
106 struct device *dev = csi2_dev->dev;
109 format = sun6i_mipi_csi2_format_find(mbus_format->code);
110 if (WARN_ON(!format))
114 * The enable flow in the Allwinner BSP is a bit different: the enable
115 * and reset bits are set together before starting the CSI controller.
117 * In mainline we enable the CSI controller first (due to subdev logic).
118 * One reliable way to make this work is to deassert reset, configure
119 * registers and enable the controller when everything's ready.
121 * However, setting the version enable bit and removing it afterwards
122 * appears necessary for capture to work reliably, while replacing it
123 * with a delay doesn't do the trick.
125 regmap_write(regmap, SUN6I_MIPI_CSI2_CTL_REG,
126 SUN6I_MIPI_CSI2_CTL_RESET_N |
127 SUN6I_MIPI_CSI2_CTL_VERSION_EN |
128 SUN6I_MIPI_CSI2_CTL_UNPK_EN);
130 regmap_read(regmap, SUN6I_MIPI_CSI2_VERSION_REG, &version);
132 regmap_update_bits(regmap, SUN6I_MIPI_CSI2_CTL_REG,
133 SUN6I_MIPI_CSI2_CTL_VERSION_EN, 0);
135 dev_dbg(dev, "A31 MIPI CSI-2 version: %04x\n", version);
137 regmap_write(regmap, SUN6I_MIPI_CSI2_CFG_REG,
138 SUN6I_MIPI_CSI2_CFG_CHANNEL_MODE(1) |
139 SUN6I_MIPI_CSI2_CFG_LANE_COUNT(lanes_count));
142 * Only a single virtual channel (index 0) is currently supported.
143 * While the registers do mention multiple physical channels being
144 * available (which can be configured to match a specific virtual
145 * channel or data type), it's unclear whether channels > 0 are actually
146 * connected and available and the reference source code only makes use
149 * Using extra channels would also require matching channels to be
150 * available on the CSI (and ISP) side, which is also unsure although
151 * some CSI implementations are said to support multiple channels for
152 * BT656 time-sharing.
154 * We still configure virtual channel numbers to ensure that virtual
155 * channel 0 only goes to channel 0.
158 regmap_write(regmap, SUN6I_MIPI_CSI2_VCDT_RX_REG,
159 SUN6I_MIPI_CSI2_VCDT_RX_CH_VC(3, 3) |
160 SUN6I_MIPI_CSI2_VCDT_RX_CH_VC(2, 2) |
161 SUN6I_MIPI_CSI2_VCDT_RX_CH_VC(1, 1) |
162 SUN6I_MIPI_CSI2_VCDT_RX_CH_VC(0, 0) |
163 SUN6I_MIPI_CSI2_VCDT_RX_CH_DT(0, format->data_type));
165 regmap_write(regmap, SUN6I_MIPI_CSI2_CH_INT_PD_REG,
166 SUN6I_MIPI_CSI2_CH_INT_PD_CLEAR);
171 static int sun6i_mipi_csi2_s_stream(struct v4l2_subdev *subdev, int on)
173 struct sun6i_mipi_csi2_device *csi2_dev = v4l2_get_subdevdata(subdev);
174 struct v4l2_subdev *source_subdev = csi2_dev->bridge.source_subdev;
175 union phy_configure_opts dphy_opts = { 0 };
176 struct phy_configure_opts_mipi_dphy *dphy_cfg = &dphy_opts.mipi_dphy;
177 struct v4l2_mbus_framefmt *mbus_format = &csi2_dev->bridge.mbus_format;
178 const struct sun6i_mipi_csi2_format *format;
179 struct phy *dphy = csi2_dev->dphy;
180 struct device *dev = csi2_dev->dev;
181 struct v4l2_ctrl *ctrl;
182 unsigned int lanes_count =
183 csi2_dev->bridge.endpoint.bus.mipi_csi2.num_data_lanes;
184 unsigned long pixel_rate;
191 ret = v4l2_subdev_call(source_subdev, video, s_stream, 0);
197 ret = pm_runtime_resume_and_get(dev);
201 /* Sensor Pixel Rate */
203 ctrl = v4l2_ctrl_find(source_subdev->ctrl_handler, V4L2_CID_PIXEL_RATE);
205 dev_err(dev, "missing sensor pixel rate\n");
210 pixel_rate = (unsigned long)v4l2_ctrl_g_ctrl_int64(ctrl);
212 dev_err(dev, "missing (zero) sensor pixel rate\n");
220 dev_err(dev, "missing (zero) MIPI CSI-2 lanes count\n");
225 format = sun6i_mipi_csi2_format_find(mbus_format->code);
226 if (WARN_ON(!format)) {
231 phy_mipi_dphy_get_default_config(pixel_rate, format->bpp, lanes_count,
235 * Note that our hardware is using DDR, which is not taken in account by
236 * phy_mipi_dphy_get_default_config when calculating hs_clk_rate from
237 * the pixel rate, lanes count and bpp.
239 * The resulting clock rate is basically the symbol rate over the whole
240 * link. The actual clock rate is calculated with division by two since
241 * DDR samples both on rising and falling edges.
244 dev_dbg(dev, "A31 MIPI CSI-2 config:\n");
245 dev_dbg(dev, "%ld pixels/s, %u bits/pixel, %u lanes, %lu Hz clock\n",
246 pixel_rate, format->bpp, lanes_count,
247 dphy_cfg->hs_clk_rate / 2);
249 ret = phy_reset(dphy);
251 dev_err(dev, "failed to reset MIPI D-PHY\n");
255 ret = phy_configure(dphy, &dphy_opts);
257 dev_err(dev, "failed to configure MIPI D-PHY\n");
263 sun6i_mipi_csi2_configure(csi2_dev);
264 sun6i_mipi_csi2_enable(csi2_dev);
268 ret = phy_power_on(dphy);
270 dev_err(dev, "failed to power on MIPI D-PHY\n");
276 ret = v4l2_subdev_call(source_subdev, video, s_stream, 1);
277 if (ret && ret != -ENOIOCTLCMD)
286 sun6i_mipi_csi2_disable(csi2_dev);
294 static const struct v4l2_subdev_video_ops sun6i_mipi_csi2_video_ops = {
295 .s_stream = sun6i_mipi_csi2_s_stream,
299 sun6i_mipi_csi2_mbus_format_prepare(struct v4l2_mbus_framefmt *mbus_format)
301 if (!sun6i_mipi_csi2_format_find(mbus_format->code))
302 mbus_format->code = sun6i_mipi_csi2_formats[0].mbus_code;
304 mbus_format->field = V4L2_FIELD_NONE;
305 mbus_format->colorspace = V4L2_COLORSPACE_RAW;
306 mbus_format->quantization = V4L2_QUANTIZATION_DEFAULT;
307 mbus_format->xfer_func = V4L2_XFER_FUNC_DEFAULT;
310 static int sun6i_mipi_csi2_init_cfg(struct v4l2_subdev *subdev,
311 struct v4l2_subdev_state *state)
313 struct sun6i_mipi_csi2_device *csi2_dev = v4l2_get_subdevdata(subdev);
314 unsigned int pad = SUN6I_MIPI_CSI2_PAD_SINK;
315 struct v4l2_mbus_framefmt *mbus_format =
316 v4l2_subdev_get_try_format(subdev, state, pad);
317 struct mutex *lock = &csi2_dev->bridge.lock;
321 mbus_format->code = sun6i_mipi_csi2_formats[0].mbus_code;
322 mbus_format->width = 640;
323 mbus_format->height = 480;
325 sun6i_mipi_csi2_mbus_format_prepare(mbus_format);
333 sun6i_mipi_csi2_enum_mbus_code(struct v4l2_subdev *subdev,
334 struct v4l2_subdev_state *state,
335 struct v4l2_subdev_mbus_code_enum *code_enum)
337 if (code_enum->index >= ARRAY_SIZE(sun6i_mipi_csi2_formats))
340 code_enum->code = sun6i_mipi_csi2_formats[code_enum->index].mbus_code;
345 static int sun6i_mipi_csi2_get_fmt(struct v4l2_subdev *subdev,
346 struct v4l2_subdev_state *state,
347 struct v4l2_subdev_format *format)
349 struct sun6i_mipi_csi2_device *csi2_dev = v4l2_get_subdevdata(subdev);
350 struct v4l2_mbus_framefmt *mbus_format = &format->format;
351 struct mutex *lock = &csi2_dev->bridge.lock;
355 if (format->which == V4L2_SUBDEV_FORMAT_TRY)
356 *mbus_format = *v4l2_subdev_get_try_format(subdev, state,
359 *mbus_format = csi2_dev->bridge.mbus_format;
366 static int sun6i_mipi_csi2_set_fmt(struct v4l2_subdev *subdev,
367 struct v4l2_subdev_state *state,
368 struct v4l2_subdev_format *format)
370 struct sun6i_mipi_csi2_device *csi2_dev = v4l2_get_subdevdata(subdev);
371 struct v4l2_mbus_framefmt *mbus_format = &format->format;
372 struct mutex *lock = &csi2_dev->bridge.lock;
376 sun6i_mipi_csi2_mbus_format_prepare(mbus_format);
378 if (format->which == V4L2_SUBDEV_FORMAT_TRY)
379 *v4l2_subdev_get_try_format(subdev, state, format->pad) =
382 csi2_dev->bridge.mbus_format = *mbus_format;
389 static const struct v4l2_subdev_pad_ops sun6i_mipi_csi2_pad_ops = {
390 .init_cfg = sun6i_mipi_csi2_init_cfg,
391 .enum_mbus_code = sun6i_mipi_csi2_enum_mbus_code,
392 .get_fmt = sun6i_mipi_csi2_get_fmt,
393 .set_fmt = sun6i_mipi_csi2_set_fmt,
396 static const struct v4l2_subdev_ops sun6i_mipi_csi2_subdev_ops = {
397 .video = &sun6i_mipi_csi2_video_ops,
398 .pad = &sun6i_mipi_csi2_pad_ops,
403 static const struct media_entity_operations sun6i_mipi_csi2_entity_ops = {
404 .link_validate = v4l2_subdev_link_validate,
410 sun6i_mipi_csi2_notifier_bound(struct v4l2_async_notifier *notifier,
411 struct v4l2_subdev *remote_subdev,
412 struct v4l2_async_subdev *async_subdev)
414 struct v4l2_subdev *subdev = notifier->sd;
415 struct sun6i_mipi_csi2_device *csi2_dev =
416 container_of(notifier, struct sun6i_mipi_csi2_device,
418 struct media_entity *sink_entity = &subdev->entity;
419 struct media_entity *source_entity = &remote_subdev->entity;
420 struct device *dev = csi2_dev->dev;
421 int sink_pad_index = 0;
422 int source_pad_index;
425 ret = media_entity_get_fwnode_pad(source_entity, remote_subdev->fwnode,
426 MEDIA_PAD_FL_SOURCE);
428 dev_err(dev, "missing source pad in external entity %s\n",
429 source_entity->name);
433 source_pad_index = ret;
435 dev_dbg(dev, "creating %s:%u -> %s:%u link\n", source_entity->name,
436 source_pad_index, sink_entity->name, sink_pad_index);
438 ret = media_create_pad_link(source_entity, source_pad_index,
439 sink_entity, sink_pad_index,
440 MEDIA_LNK_FL_ENABLED |
441 MEDIA_LNK_FL_IMMUTABLE);
443 dev_err(dev, "failed to create %s:%u -> %s:%u link\n",
444 source_entity->name, source_pad_index,
445 sink_entity->name, sink_pad_index);
449 csi2_dev->bridge.source_subdev = remote_subdev;
454 static const struct v4l2_async_notifier_operations
455 sun6i_mipi_csi2_notifier_ops = {
456 .bound = sun6i_mipi_csi2_notifier_bound,
462 sun6i_mipi_csi2_bridge_source_setup(struct sun6i_mipi_csi2_device *csi2_dev)
464 struct v4l2_async_notifier *notifier = &csi2_dev->bridge.notifier;
465 struct v4l2_fwnode_endpoint *endpoint = &csi2_dev->bridge.endpoint;
466 struct v4l2_async_subdev *subdev_async;
467 struct fwnode_handle *handle;
468 struct device *dev = csi2_dev->dev;
471 handle = fwnode_graph_get_endpoint_by_id(dev_fwnode(dev), 0, 0,
472 FWNODE_GRAPH_ENDPOINT_NEXT);
476 endpoint->bus_type = V4L2_MBUS_CSI2_DPHY;
478 ret = v4l2_fwnode_endpoint_parse(handle, endpoint);
483 v4l2_async_nf_add_fwnode_remote(notifier, handle,
484 struct v4l2_async_subdev);
485 if (IS_ERR(subdev_async))
486 ret = PTR_ERR(subdev_async);
489 fwnode_handle_put(handle);
494 static int sun6i_mipi_csi2_bridge_setup(struct sun6i_mipi_csi2_device *csi2_dev)
496 struct sun6i_mipi_csi2_bridge *bridge = &csi2_dev->bridge;
497 struct v4l2_subdev *subdev = &bridge->subdev;
498 struct v4l2_async_notifier *notifier = &bridge->notifier;
499 struct media_pad *pads = bridge->pads;
500 struct device *dev = csi2_dev->dev;
503 mutex_init(&bridge->lock);
507 v4l2_subdev_init(subdev, &sun6i_mipi_csi2_subdev_ops);
508 strscpy(subdev->name, SUN6I_MIPI_CSI2_NAME, sizeof(subdev->name));
509 subdev->flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
510 subdev->owner = THIS_MODULE;
513 v4l2_set_subdevdata(subdev, csi2_dev);
517 subdev->entity.function = MEDIA_ENT_F_VID_IF_BRIDGE;
518 subdev->entity.ops = &sun6i_mipi_csi2_entity_ops;
522 pads[SUN6I_MIPI_CSI2_PAD_SINK].flags = MEDIA_PAD_FL_SINK;
523 pads[SUN6I_MIPI_CSI2_PAD_SOURCE].flags = MEDIA_PAD_FL_SOURCE;
525 ret = media_entity_pads_init(&subdev->entity, SUN6I_MIPI_CSI2_PAD_COUNT,
532 v4l2_async_nf_init(notifier);
533 notifier->ops = &sun6i_mipi_csi2_notifier_ops;
535 ret = sun6i_mipi_csi2_bridge_source_setup(csi2_dev);
537 goto error_v4l2_notifier_cleanup;
539 ret = v4l2_async_subdev_nf_register(subdev, notifier);
541 goto error_v4l2_notifier_cleanup;
545 ret = v4l2_async_register_subdev(subdev);
547 goto error_v4l2_notifier_unregister;
551 error_v4l2_notifier_unregister:
552 v4l2_async_nf_unregister(notifier);
554 error_v4l2_notifier_cleanup:
555 v4l2_async_nf_cleanup(notifier);
557 media_entity_cleanup(&subdev->entity);
563 sun6i_mipi_csi2_bridge_cleanup(struct sun6i_mipi_csi2_device *csi2_dev)
565 struct v4l2_subdev *subdev = &csi2_dev->bridge.subdev;
566 struct v4l2_async_notifier *notifier = &csi2_dev->bridge.notifier;
568 v4l2_async_unregister_subdev(subdev);
569 v4l2_async_nf_unregister(notifier);
570 v4l2_async_nf_cleanup(notifier);
571 media_entity_cleanup(&subdev->entity);
576 static int sun6i_mipi_csi2_suspend(struct device *dev)
578 struct sun6i_mipi_csi2_device *csi2_dev = dev_get_drvdata(dev);
580 clk_disable_unprepare(csi2_dev->clock_mod);
581 reset_control_assert(csi2_dev->reset);
586 static int sun6i_mipi_csi2_resume(struct device *dev)
588 struct sun6i_mipi_csi2_device *csi2_dev = dev_get_drvdata(dev);
591 ret = reset_control_deassert(csi2_dev->reset);
593 dev_err(dev, "failed to deassert reset\n");
597 ret = clk_prepare_enable(csi2_dev->clock_mod);
599 dev_err(dev, "failed to enable module clock\n");
606 reset_control_assert(csi2_dev->reset);
611 static const struct dev_pm_ops sun6i_mipi_csi2_pm_ops = {
612 .runtime_suspend = sun6i_mipi_csi2_suspend,
613 .runtime_resume = sun6i_mipi_csi2_resume,
616 static const struct regmap_config sun6i_mipi_csi2_regmap_config = {
620 .max_register = 0x400,
624 sun6i_mipi_csi2_resources_setup(struct sun6i_mipi_csi2_device *csi2_dev,
625 struct platform_device *platform_dev)
627 struct device *dev = csi2_dev->dev;
628 void __iomem *io_base;
633 io_base = devm_platform_ioremap_resource(platform_dev, 0);
635 return PTR_ERR(io_base);
638 devm_regmap_init_mmio_clk(dev, "bus", io_base,
639 &sun6i_mipi_csi2_regmap_config);
640 if (IS_ERR(csi2_dev->regmap)) {
641 dev_err(dev, "failed to init register map\n");
642 return PTR_ERR(csi2_dev->regmap);
647 csi2_dev->clock_mod = devm_clk_get(dev, "mod");
648 if (IS_ERR(csi2_dev->clock_mod)) {
649 dev_err(dev, "failed to acquire mod clock\n");
650 return PTR_ERR(csi2_dev->clock_mod);
653 ret = clk_set_rate_exclusive(csi2_dev->clock_mod, 297000000);
655 dev_err(dev, "failed to set mod clock rate\n");
661 csi2_dev->reset = devm_reset_control_get_shared(dev, NULL);
662 if (IS_ERR(csi2_dev->reset)) {
663 dev_err(dev, "failed to get reset controller\n");
664 ret = PTR_ERR(csi2_dev->reset);
665 goto error_clock_rate_exclusive;
670 csi2_dev->dphy = devm_phy_get(dev, "dphy");
671 if (IS_ERR(csi2_dev->dphy)) {
672 dev_err(dev, "failed to get MIPI D-PHY\n");
673 ret = PTR_ERR(csi2_dev->dphy);
674 goto error_clock_rate_exclusive;
677 ret = phy_init(csi2_dev->dphy);
679 dev_err(dev, "failed to initialize MIPI D-PHY\n");
680 goto error_clock_rate_exclusive;
685 pm_runtime_enable(dev);
689 error_clock_rate_exclusive:
690 clk_rate_exclusive_put(csi2_dev->clock_mod);
696 sun6i_mipi_csi2_resources_cleanup(struct sun6i_mipi_csi2_device *csi2_dev)
698 pm_runtime_disable(csi2_dev->dev);
699 phy_exit(csi2_dev->dphy);
700 clk_rate_exclusive_put(csi2_dev->clock_mod);
703 static int sun6i_mipi_csi2_probe(struct platform_device *platform_dev)
705 struct sun6i_mipi_csi2_device *csi2_dev;
706 struct device *dev = &platform_dev->dev;
709 csi2_dev = devm_kzalloc(dev, sizeof(*csi2_dev), GFP_KERNEL);
714 platform_set_drvdata(platform_dev, csi2_dev);
716 ret = sun6i_mipi_csi2_resources_setup(csi2_dev, platform_dev);
720 ret = sun6i_mipi_csi2_bridge_setup(csi2_dev);
722 goto error_resources;
727 sun6i_mipi_csi2_resources_cleanup(csi2_dev);
732 static int sun6i_mipi_csi2_remove(struct platform_device *platform_dev)
734 struct sun6i_mipi_csi2_device *csi2_dev =
735 platform_get_drvdata(platform_dev);
737 sun6i_mipi_csi2_bridge_cleanup(csi2_dev);
738 sun6i_mipi_csi2_resources_cleanup(csi2_dev);
743 static const struct of_device_id sun6i_mipi_csi2_of_match[] = {
744 { .compatible = "allwinner,sun6i-a31-mipi-csi2" },
747 MODULE_DEVICE_TABLE(of, sun6i_mipi_csi2_of_match);
749 static struct platform_driver sun6i_mipi_csi2_platform_driver = {
750 .probe = sun6i_mipi_csi2_probe,
751 .remove = sun6i_mipi_csi2_remove,
753 .name = SUN6I_MIPI_CSI2_NAME,
754 .of_match_table = of_match_ptr(sun6i_mipi_csi2_of_match),
755 .pm = &sun6i_mipi_csi2_pm_ops,
758 module_platform_driver(sun6i_mipi_csi2_platform_driver);
760 MODULE_DESCRIPTION("Allwinner A31 MIPI CSI-2 Controller Driver");
761 MODULE_AUTHOR("Paul Kocialkowski <paul.kocialkowski@bootlin.com>");
762 MODULE_LICENSE("GPL");