1 // SPDX-License-Identifier: (GPL-2.0+ OR MIT)
3 * Rockchip ISP1 Driver - Base driver
5 * Copyright (C) 2019 Collabora, Ltd.
7 * Based on Rockchip ISP1 driver by Rockchip Electronics Co., Ltd.
8 * Copyright (C) 2017 Rockchip Electronics Co., Ltd.
11 #include <linux/clk.h>
12 #include <linux/interrupt.h>
13 #include <linux/module.h>
15 #include <linux/of_graph.h>
16 #include <linux/platform_device.h>
17 #include <linux/pinctrl/consumer.h>
18 #include <linux/pm_runtime.h>
19 #include <media/v4l2-fwnode.h>
20 #include <media/v4l2-mc.h>
22 #include "rkisp1-common.h"
23 #include "rkisp1-csi.h"
30 * MIPI serial camera interface
31 * Image Signal Processing
32 * Many Image Enhancement Blocks
35 * RBG display ready image
40 * rkisp1-resizer.c rkisp1-capture.c
41 * |====================| |=======================|
42 * rkisp1-isp.c Main Picture Path
43 * |==========================| |===============================================|
44 * +-----------+ +--+--+--+--+ +--------+ +--------+ +-----------+
45 * | | | | | | | | | | | | |
46 * +--------+ |\ | | | | | | | -->| Crop |->| RSZ |------------->| |
47 * | MIPI |--->| \ | | | | | | | | | | | | | |
48 * +--------+ | | | | |IE|IE|IE|IE| | +--------+ +--------+ | Memory |
49 * |MUX|--->| ISP |->|0 |1 |2 |3 |---+ | Interface |
50 * +--------+ | | | | | | | | | | +--------+ +--------+ +--------+ | |
51 * |Parallel|--->| / | | | | | | | | | | | | | | | |
52 * +--------+ |/ | | | | | | | -->| Crop |->| RSZ |->| RGB |->| |
53 * | | | | | | | | | | | | Rotate | | |
54 * +-----------+ +--+--+--+--+ +--------+ +--------+ +--------+ +-----------+
56 * +--------+ | |===============================================|
57 * | DMA |------------------------------------+ Self Picture Path
60 * rkisp1-stats.c rkisp1-params.c
61 * |===============| |===============|
62 * +---------------+ +---------------+
66 * +---------------+ +---------------+
72 * +----------+ +----------+
73 * | Sensor 1 | | Sensor X |
74 * ------------ ... ------------
76 * +----------+ +----------+
85 * --------------- +-----------+
87 * +-------------+ | (output) |
91 * | 0 | 1 |<---------+
95 * +-------------| 2 | 3 |----------+
99 * +- ---------+ +-----------+ +-----------+
100 * | 0 | | 0 | | stats |
101 * ------------- ------------- | (capture) |
102 * | Resizer | | Resizer | +-----------+
103 * ------------| ------------|
105 * +-----------+ +-----------+
108 * +-----------+ +-----------+
109 * | selfpath | | mainpath |
110 * | (capture) | | (capture) |
111 * +-----------+ +-----------+
114 struct rkisp1_isr_data {
116 irqreturn_t (*isr)(int irq, void *ctx);
120 /* ----------------------------------------------------------------------------
124 static int rkisp1_subdev_notifier_bound(struct v4l2_async_notifier *notifier,
125 struct v4l2_subdev *sd,
126 struct v4l2_async_connection *asc)
128 struct rkisp1_device *rkisp1 =
129 container_of(notifier, struct rkisp1_device, notifier);
130 struct rkisp1_sensor_async *s_asd =
131 container_of(asc, struct rkisp1_sensor_async, asd);
137 source_pad = media_entity_get_fwnode_pad(&sd->entity, s_asd->source_ep,
138 MEDIA_PAD_FL_SOURCE);
139 if (source_pad < 0) {
140 dev_err(rkisp1->dev, "failed to find source pad for %s\n",
145 if (s_asd->port == 0)
146 return rkisp1_csi_link_sensor(rkisp1, sd, s_asd, source_pad);
148 ret = media_create_pad_link(&sd->entity, source_pad,
149 &rkisp1->isp.sd.entity,
150 RKISP1_ISP_PAD_SINK_VIDEO,
151 !s_asd->index ? MEDIA_LNK_FL_ENABLED : 0);
153 dev_err(rkisp1->dev, "failed to link source pad of %s\n",
161 static int rkisp1_subdev_notifier_complete(struct v4l2_async_notifier *notifier)
163 struct rkisp1_device *rkisp1 =
164 container_of(notifier, struct rkisp1_device, notifier);
166 return v4l2_device_register_subdev_nodes(&rkisp1->v4l2_dev);
169 static void rkisp1_subdev_notifier_destroy(struct v4l2_async_connection *asc)
171 struct rkisp1_sensor_async *rk_asd =
172 container_of(asc, struct rkisp1_sensor_async, asd);
174 fwnode_handle_put(rk_asd->source_ep);
177 static const struct v4l2_async_notifier_operations rkisp1_subdev_notifier_ops = {
178 .bound = rkisp1_subdev_notifier_bound,
179 .complete = rkisp1_subdev_notifier_complete,
180 .destroy = rkisp1_subdev_notifier_destroy,
183 static int rkisp1_subdev_notifier_register(struct rkisp1_device *rkisp1)
185 struct v4l2_async_notifier *ntf = &rkisp1->notifier;
186 struct fwnode_handle *fwnode = dev_fwnode(rkisp1->dev);
187 struct fwnode_handle *ep;
188 unsigned int index = 0;
191 v4l2_async_nf_init(ntf, &rkisp1->v4l2_dev);
193 ntf->ops = &rkisp1_subdev_notifier_ops;
195 fwnode_graph_for_each_endpoint(fwnode, ep) {
196 struct fwnode_handle *port;
197 struct v4l2_fwnode_endpoint vep = { };
198 struct rkisp1_sensor_async *rk_asd;
199 struct fwnode_handle *source;
202 /* Select the bus type based on the port. */
203 port = fwnode_get_parent(ep);
204 fwnode_property_read_u32(port, "reg", ®);
205 fwnode_handle_put(port);
209 /* MIPI CSI-2 port */
210 if (!(rkisp1->info->features & RKISP1_FEATURE_MIPI_CSI2)) {
212 "internal CSI must be available for port 0\n");
217 vep.bus_type = V4L2_MBUS_CSI2_DPHY;
222 * Parallel port. The bus-type property in DT is
223 * mandatory for port 1, it will be used to determine if
224 * it's PARALLEL or BT656.
226 vep.bus_type = V4L2_MBUS_UNKNOWN;
230 /* Parse the endpoint and validate the bus type. */
231 ret = v4l2_fwnode_endpoint_parse(ep, &vep);
233 dev_err(rkisp1->dev, "failed to parse endpoint %pfw\n",
238 if (vep.base.port == 1) {
239 if (vep.bus_type != V4L2_MBUS_PARALLEL &&
240 vep.bus_type != V4L2_MBUS_BT656) {
242 "port 1 must be parallel or BT656\n");
248 /* Add the async subdev to the notifier. */
249 source = fwnode_graph_get_remote_endpoint(ep);
252 "endpoint %pfw has no remote endpoint\n",
258 rk_asd = v4l2_async_nf_add_fwnode(ntf, source,
259 struct rkisp1_sensor_async);
260 if (IS_ERR(rk_asd)) {
261 fwnode_handle_put(source);
262 ret = PTR_ERR(rk_asd);
266 rk_asd->index = index++;
267 rk_asd->source_ep = source;
268 rk_asd->mbus_type = vep.bus_type;
269 rk_asd->port = vep.base.port;
271 if (vep.bus_type == V4L2_MBUS_CSI2_DPHY) {
272 rk_asd->mbus_flags = vep.bus.mipi_csi2.flags;
273 rk_asd->lanes = vep.bus.mipi_csi2.num_data_lanes;
275 rk_asd->mbus_flags = vep.bus.parallel.flags;
278 dev_dbg(rkisp1->dev, "registered ep id %d, bus type %u, %u lanes\n",
279 vep.base.id, rk_asd->mbus_type, rk_asd->lanes);
283 fwnode_handle_put(ep);
284 v4l2_async_nf_cleanup(ntf);
289 dev_dbg(rkisp1->dev, "no remote subdevice found\n");
291 ret = v4l2_async_nf_register(ntf);
293 v4l2_async_nf_cleanup(ntf);
300 /* ----------------------------------------------------------------------------
304 static int __maybe_unused rkisp1_runtime_suspend(struct device *dev)
306 struct rkisp1_device *rkisp1 = dev_get_drvdata(dev);
308 rkisp1->irqs_enabled = false;
309 /* Make sure the IRQ handler will see the above */
313 * Wait until any running IRQ handler has returned. The IRQ handler
314 * may get called even after this (as it's a shared interrupt line)
315 * but the 'irqs_enabled' flag will make the handler return immediately.
317 for (unsigned int il = 0; il < ARRAY_SIZE(rkisp1->irqs); ++il) {
318 if (rkisp1->irqs[il] == -1)
321 /* Skip if the irq line is the same as previous */
322 if (il == 0 || rkisp1->irqs[il - 1] != rkisp1->irqs[il])
323 synchronize_irq(rkisp1->irqs[il]);
326 clk_bulk_disable_unprepare(rkisp1->clk_size, rkisp1->clks);
327 return pinctrl_pm_select_sleep_state(dev);
330 static int __maybe_unused rkisp1_runtime_resume(struct device *dev)
332 struct rkisp1_device *rkisp1 = dev_get_drvdata(dev);
335 ret = pinctrl_pm_select_default_state(dev);
338 ret = clk_bulk_prepare_enable(rkisp1->clk_size, rkisp1->clks);
342 rkisp1->irqs_enabled = true;
343 /* Make sure the IRQ handler will see the above */
349 static const struct dev_pm_ops rkisp1_pm_ops = {
350 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
351 pm_runtime_force_resume)
352 SET_RUNTIME_PM_OPS(rkisp1_runtime_suspend, rkisp1_runtime_resume, NULL)
355 /* ----------------------------------------------------------------------------
359 static int rkisp1_create_links(struct rkisp1_device *rkisp1)
364 if (rkisp1->info->features & RKISP1_FEATURE_MIPI_CSI2) {
365 /* Link the CSI receiver to the ISP. */
366 ret = media_create_pad_link(&rkisp1->csi.sd.entity,
368 &rkisp1->isp.sd.entity,
369 RKISP1_ISP_PAD_SINK_VIDEO,
370 MEDIA_LNK_FL_ENABLED);
375 /* create ISP->RSZ->CAP links */
376 for (i = 0; i < 2; i++) {
377 struct media_entity *resizer =
378 &rkisp1->resizer_devs[i].sd.entity;
379 struct media_entity *capture =
380 &rkisp1->capture_devs[i].vnode.vdev.entity;
382 ret = media_create_pad_link(&rkisp1->isp.sd.entity,
383 RKISP1_ISP_PAD_SOURCE_VIDEO,
384 resizer, RKISP1_RSZ_PAD_SINK,
385 MEDIA_LNK_FL_ENABLED);
389 ret = media_create_pad_link(resizer, RKISP1_RSZ_PAD_SRC,
391 MEDIA_LNK_FL_ENABLED |
392 MEDIA_LNK_FL_IMMUTABLE);
398 ret = media_create_pad_link(&rkisp1->params.vnode.vdev.entity, 0,
399 &rkisp1->isp.sd.entity,
400 RKISP1_ISP_PAD_SINK_PARAMS,
401 MEDIA_LNK_FL_ENABLED |
402 MEDIA_LNK_FL_IMMUTABLE);
407 return media_create_pad_link(&rkisp1->isp.sd.entity,
408 RKISP1_ISP_PAD_SOURCE_STATS,
409 &rkisp1->stats.vnode.vdev.entity, 0,
410 MEDIA_LNK_FL_ENABLED |
411 MEDIA_LNK_FL_IMMUTABLE);
414 static void rkisp1_entities_unregister(struct rkisp1_device *rkisp1)
416 if (rkisp1->info->features & RKISP1_FEATURE_MIPI_CSI2)
417 rkisp1_csi_unregister(rkisp1);
418 rkisp1_params_unregister(rkisp1);
419 rkisp1_stats_unregister(rkisp1);
420 rkisp1_capture_devs_unregister(rkisp1);
421 rkisp1_resizer_devs_unregister(rkisp1);
422 rkisp1_isp_unregister(rkisp1);
425 static int rkisp1_entities_register(struct rkisp1_device *rkisp1)
429 ret = rkisp1_isp_register(rkisp1);
433 ret = rkisp1_resizer_devs_register(rkisp1);
437 ret = rkisp1_capture_devs_register(rkisp1);
441 ret = rkisp1_stats_register(rkisp1);
445 ret = rkisp1_params_register(rkisp1);
449 if (rkisp1->info->features & RKISP1_FEATURE_MIPI_CSI2) {
450 ret = rkisp1_csi_register(rkisp1);
455 ret = rkisp1_create_links(rkisp1);
462 rkisp1_entities_unregister(rkisp1);
466 static irqreturn_t rkisp1_isr(int irq, void *ctx)
468 irqreturn_t ret = IRQ_NONE;
471 * Call rkisp1_capture_isr() first to handle the frame that
472 * potentially completed using the current frame_sequence number before
473 * it is potentially incremented by rkisp1_isp_isr() in the vertical
477 if (rkisp1_capture_isr(irq, ctx) == IRQ_HANDLED)
480 if (rkisp1_isp_isr(irq, ctx) == IRQ_HANDLED)
483 if (rkisp1_csi_isr(irq, ctx) == IRQ_HANDLED)
489 static const char * const px30_isp_clks[] = {
496 static const struct rkisp1_isr_data px30_isp_isrs[] = {
497 { "isp", rkisp1_isp_isr, BIT(RKISP1_IRQ_ISP) },
498 { "mi", rkisp1_capture_isr, BIT(RKISP1_IRQ_MI) },
499 { "mipi", rkisp1_csi_isr, BIT(RKISP1_IRQ_MIPI) },
502 static const struct rkisp1_info px30_isp_info = {
503 .clks = px30_isp_clks,
504 .clk_size = ARRAY_SIZE(px30_isp_clks),
505 .isrs = px30_isp_isrs,
506 .isr_size = ARRAY_SIZE(px30_isp_isrs),
507 .isp_ver = RKISP1_V12,
508 .features = RKISP1_FEATURE_MIPI_CSI2,
511 static const char * const rk3399_isp_clks[] = {
517 static const struct rkisp1_isr_data rk3399_isp_isrs[] = {
518 { NULL, rkisp1_isr, BIT(RKISP1_IRQ_ISP) | BIT(RKISP1_IRQ_MI) | BIT(RKISP1_IRQ_MIPI) },
521 static const struct rkisp1_info rk3399_isp_info = {
522 .clks = rk3399_isp_clks,
523 .clk_size = ARRAY_SIZE(rk3399_isp_clks),
524 .isrs = rk3399_isp_isrs,
525 .isr_size = ARRAY_SIZE(rk3399_isp_isrs),
526 .isp_ver = RKISP1_V10,
527 .features = RKISP1_FEATURE_MIPI_CSI2,
530 static const struct of_device_id rkisp1_of_match[] = {
532 .compatible = "rockchip,px30-cif-isp",
533 .data = &px30_isp_info,
536 .compatible = "rockchip,rk3399-cif-isp",
537 .data = &rk3399_isp_info,
541 MODULE_DEVICE_TABLE(of, rkisp1_of_match);
543 static int rkisp1_probe(struct platform_device *pdev)
545 const struct rkisp1_info *info;
546 struct device *dev = &pdev->dev;
547 struct rkisp1_device *rkisp1;
548 struct v4l2_device *v4l2_dev;
553 rkisp1 = devm_kzalloc(dev, sizeof(*rkisp1), GFP_KERNEL);
557 info = of_device_get_match_data(dev);
560 dev_set_drvdata(dev, rkisp1);
563 mutex_init(&rkisp1->stream_lock);
565 rkisp1->base_addr = devm_platform_ioremap_resource(pdev, 0);
566 if (IS_ERR(rkisp1->base_addr))
567 return PTR_ERR(rkisp1->base_addr);
569 for (unsigned int il = 0; il < ARRAY_SIZE(rkisp1->irqs); ++il)
570 rkisp1->irqs[il] = -1;
572 for (i = 0; i < info->isr_size; i++) {
573 irq = info->isrs[i].name
574 ? platform_get_irq_byname(pdev, info->isrs[i].name)
575 : platform_get_irq(pdev, i);
579 for (unsigned int il = 0; il < ARRAY_SIZE(rkisp1->irqs); ++il) {
580 if (info->isrs[i].line_mask & BIT(il))
581 rkisp1->irqs[il] = irq;
584 ret = devm_request_irq(dev, irq, info->isrs[i].isr, IRQF_SHARED,
585 dev_driver_string(dev), dev);
587 dev_err(dev, "request irq failed: %d\n", ret);
592 for (i = 0; i < info->clk_size; i++)
593 rkisp1->clks[i].id = info->clks[i];
594 ret = devm_clk_bulk_get(dev, info->clk_size, rkisp1->clks);
597 rkisp1->clk_size = info->clk_size;
599 pm_runtime_enable(&pdev->dev);
601 ret = pm_runtime_resume_and_get(&pdev->dev);
603 goto err_pm_runtime_disable;
605 cif_id = rkisp1_read(rkisp1, RKISP1_CIF_VI_ID);
606 dev_dbg(rkisp1->dev, "CIF_ID 0x%08x\n", cif_id);
608 pm_runtime_put(&pdev->dev);
610 rkisp1->media_dev.hw_revision = info->isp_ver;
611 strscpy(rkisp1->media_dev.model, RKISP1_DRIVER_NAME,
612 sizeof(rkisp1->media_dev.model));
613 rkisp1->media_dev.dev = &pdev->dev;
614 strscpy(rkisp1->media_dev.bus_info, RKISP1_BUS_INFO,
615 sizeof(rkisp1->media_dev.bus_info));
616 media_device_init(&rkisp1->media_dev);
618 v4l2_dev = &rkisp1->v4l2_dev;
619 v4l2_dev->mdev = &rkisp1->media_dev;
620 strscpy(v4l2_dev->name, RKISP1_DRIVER_NAME, sizeof(v4l2_dev->name));
622 ret = v4l2_device_register(rkisp1->dev, &rkisp1->v4l2_dev);
624 goto err_media_dev_cleanup;
626 ret = media_device_register(&rkisp1->media_dev);
628 dev_err(dev, "Failed to register media device: %d\n", ret);
629 goto err_unreg_v4l2_dev;
632 if (rkisp1->info->features & RKISP1_FEATURE_MIPI_CSI2) {
633 ret = rkisp1_csi_init(rkisp1);
635 goto err_unreg_media_dev;
638 ret = rkisp1_entities_register(rkisp1);
640 goto err_cleanup_csi;
642 ret = rkisp1_subdev_notifier_register(rkisp1);
644 goto err_unreg_entities;
646 rkisp1_debug_init(rkisp1);
651 rkisp1_entities_unregister(rkisp1);
653 if (rkisp1->info->features & RKISP1_FEATURE_MIPI_CSI2)
654 rkisp1_csi_cleanup(rkisp1);
656 media_device_unregister(&rkisp1->media_dev);
658 v4l2_device_unregister(&rkisp1->v4l2_dev);
659 err_media_dev_cleanup:
660 media_device_cleanup(&rkisp1->media_dev);
661 err_pm_runtime_disable:
662 pm_runtime_disable(&pdev->dev);
666 static void rkisp1_remove(struct platform_device *pdev)
668 struct rkisp1_device *rkisp1 = platform_get_drvdata(pdev);
670 v4l2_async_nf_unregister(&rkisp1->notifier);
671 v4l2_async_nf_cleanup(&rkisp1->notifier);
673 rkisp1_entities_unregister(rkisp1);
674 if (rkisp1->info->features & RKISP1_FEATURE_MIPI_CSI2)
675 rkisp1_csi_cleanup(rkisp1);
676 rkisp1_debug_cleanup(rkisp1);
678 media_device_unregister(&rkisp1->media_dev);
679 v4l2_device_unregister(&rkisp1->v4l2_dev);
681 media_device_cleanup(&rkisp1->media_dev);
683 pm_runtime_disable(&pdev->dev);
686 static struct platform_driver rkisp1_drv = {
688 .name = RKISP1_DRIVER_NAME,
689 .of_match_table = of_match_ptr(rkisp1_of_match),
690 .pm = &rkisp1_pm_ops,
692 .probe = rkisp1_probe,
693 .remove_new = rkisp1_remove,
696 module_platform_driver(rkisp1_drv);
697 MODULE_DESCRIPTION("Rockchip ISP1 platform driver");
698 MODULE_LICENSE("Dual MIT/GPL");