1 // SPDX-License-Identifier: (GPL-2.0+ OR MIT)
2 /*
3  * Rockchip ISP1 Driver - Base driver
4  *
5  * Copyright (C) 2019 Collabora, Ltd.
6  *
7  * Based on Rockchip ISP1 driver by Rockchip Electronics Co., Ltd.
8  * Copyright (C) 2017 Rockchip Electronics Co., Ltd.
9  */
10 
11 #include <linux/clk.h>
12 #include <linux/debugfs.h>
13 #include <linux/interrupt.h>
14 #include <linux/module.h>
15 #include <linux/of.h>
16 #include <linux/of_graph.h>
17 #include <linux/of_platform.h>
18 #include <linux/pinctrl/consumer.h>
19 #include <linux/phy/phy.h>
20 #include <linux/phy/phy-mipi-dphy.h>
21 #include <media/v4l2-fwnode.h>
22 
23 #include "rkisp1-common.h"
24 
25 /*
26  * ISP Details
27  * -----------
28  *
29  * ISP Comprises with:
30  *	MIPI serial camera interface
31  *	Image Signal Processing
32  *	Many Image Enhancement Blocks
33  *	Crop
34  *	Resizer
35  *	RBG display ready image
36  *	Image Rotation
37  *
38  * ISP Block Diagram
39  * -----------------
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  *                        +-----------+  +--+--+--+--+      +--------+  +--------+  +--------+  +-----------+
55  *                                               ^
56  * +--------+                                    |          |===============================================|
57  * |  DMA   |------------------------------------+                          Self Picture Path
58  * +--------+
59  *
60  *         rkisp1-stats.c        rkisp1-params.c
61  *       |===============|      |===============|
62  *       +---------------+      +---------------+
63  *       |               |      |               |
64  *       |      ISP      |      |      ISP      |
65  *       |               |      |               |
66  *       +---------------+      +---------------+
67  *
68  *
69  * Media Topology
70  * --------------
71  *      +----------+     +----------+
72  *      | Sensor 2 |     | Sensor X |
73  *      ------------ ... ------------
74  *      |    0     |     |    0     |
75  *      +----------+     +----------+      +-----------+
76  *                  \      |               |  params   |
77  *                   \     |               | (output)  |
78  *    +----------+    \    |               +-----------+
79  *    | Sensor 1 |     v   v                     |
80  *    ------------      +------+------+          |
81  *    |    0     |----->|  0   |  1   |<---------+
82  *    +----------+      |------+------|
83  *                      |     ISP     |
84  *                      |------+------|
85  *        +-------------|  2   |  3   |----------+
86  *        |             +------+------+          |
87  *        |                |                     |
88  *        v                v                     v
89  *  +- ---------+    +-----------+         +-----------+
90  *  |     0     |    |     0     |         |   stats   |
91  *  -------------    -------------         | (capture) |
92  *  |  Resizer  |    |  Resizer  |         +-----------+
93  *  ------------|    ------------|
94  *  |     1     |    |     1     |
95  *  +-----------+    +-----------+
96  *        |                |
97  *        v                v
98  *  +-----------+    +-----------+
99  *  | selfpath  |    | mainpath  |
100  *  | (capture) |    | (capture) |
101  *  +-----------+    +-----------+
102  */
103 
104 struct rkisp1_match_data {
105 	const char * const *clks;
106 	unsigned int size;
107 };
108 
109 /* ----------------------------------------------------------------------------
110  * Sensor DT bindings
111  */
112 
113 static int rkisp1_create_links(struct rkisp1_device *rkisp1)
114 {
115 	struct media_entity *source, *sink;
116 	unsigned int flags, source_pad;
117 	struct v4l2_subdev *sd;
118 	unsigned int i;
119 	int ret;
120 
121 	/* sensor links */
122 	flags = MEDIA_LNK_FL_ENABLED;
123 	list_for_each_entry(sd, &rkisp1->v4l2_dev.subdevs, list) {
124 		if (sd == &rkisp1->isp.sd ||
125 		    sd == &rkisp1->resizer_devs[RKISP1_MAINPATH].sd ||
126 		    sd == &rkisp1->resizer_devs[RKISP1_SELFPATH].sd)
127 			continue;
128 
129 		ret = media_entity_get_fwnode_pad(&sd->entity, sd->fwnode,
130 						  MEDIA_PAD_FL_SOURCE);
131 		if (ret < 0) {
132 			dev_err(rkisp1->dev, "failed to find src pad for %s\n",
133 				sd->name);
134 			return ret;
135 		}
136 		source_pad = ret;
137 
138 		ret = media_create_pad_link(&sd->entity, source_pad,
139 					    &rkisp1->isp.sd.entity,
140 					    RKISP1_ISP_PAD_SINK_VIDEO,
141 					    flags);
142 		if (ret)
143 			return ret;
144 
145 		flags = 0;
146 	}
147 
148 	flags = MEDIA_LNK_FL_ENABLED | MEDIA_LNK_FL_IMMUTABLE;
149 
150 	/* create ISP->RSZ->CAP links */
151 	for (i = 0; i < 2; i++) {
152 		source = &rkisp1->isp.sd.entity;
153 		sink = &rkisp1->resizer_devs[i].sd.entity;
154 		ret = media_create_pad_link(source, RKISP1_ISP_PAD_SOURCE_VIDEO,
155 					    sink, RKISP1_RSZ_PAD_SINK,
156 					    MEDIA_LNK_FL_ENABLED);
157 		if (ret)
158 			return ret;
159 
160 		source = sink;
161 		sink = &rkisp1->capture_devs[i].vnode.vdev.entity;
162 		ret = media_create_pad_link(source, RKISP1_RSZ_PAD_SRC,
163 					    sink, 0, flags);
164 		if (ret)
165 			return ret;
166 	}
167 
168 	/* params links */
169 	source = &rkisp1->params.vnode.vdev.entity;
170 	sink = &rkisp1->isp.sd.entity;
171 	ret = media_create_pad_link(source, 0, sink,
172 				    RKISP1_ISP_PAD_SINK_PARAMS, flags);
173 	if (ret)
174 		return ret;
175 
176 	/* 3A stats links */
177 	source = &rkisp1->isp.sd.entity;
178 	sink = &rkisp1->stats.vnode.vdev.entity;
179 	return media_create_pad_link(source, RKISP1_ISP_PAD_SOURCE_STATS,
180 				     sink, 0, flags);
181 }
182 
183 static int rkisp1_subdev_notifier_bound(struct v4l2_async_notifier *notifier,
184 					struct v4l2_subdev *sd,
185 					struct v4l2_async_subdev *asd)
186 {
187 	struct rkisp1_device *rkisp1 =
188 		container_of(notifier, struct rkisp1_device, notifier);
189 	struct rkisp1_sensor_async *s_asd =
190 		container_of(asd, struct rkisp1_sensor_async, asd);
191 
192 	s_asd->pixel_rate_ctrl = v4l2_ctrl_find(sd->ctrl_handler,
193 						V4L2_CID_PIXEL_RATE);
194 	s_asd->sd = sd;
195 	s_asd->dphy = devm_phy_get(rkisp1->dev, "dphy");
196 	if (IS_ERR(s_asd->dphy)) {
197 		if (PTR_ERR(s_asd->dphy) != -EPROBE_DEFER)
198 			dev_err(rkisp1->dev, "Couldn't get the MIPI D-PHY\n");
199 		return PTR_ERR(s_asd->dphy);
200 	}
201 
202 	phy_init(s_asd->dphy);
203 
204 	return 0;
205 }
206 
207 static void rkisp1_subdev_notifier_unbind(struct v4l2_async_notifier *notifier,
208 					  struct v4l2_subdev *sd,
209 					  struct v4l2_async_subdev *asd)
210 {
211 	struct rkisp1_sensor_async *s_asd =
212 		container_of(asd, struct rkisp1_sensor_async, asd);
213 
214 	phy_exit(s_asd->dphy);
215 }
216 
217 static int rkisp1_subdev_notifier_complete(struct v4l2_async_notifier *notifier)
218 {
219 	struct rkisp1_device *rkisp1 =
220 		container_of(notifier, struct rkisp1_device, notifier);
221 	int ret;
222 
223 	ret = rkisp1_create_links(rkisp1);
224 	if (ret)
225 		return ret;
226 
227 	ret = v4l2_device_register_subdev_nodes(&rkisp1->v4l2_dev);
228 	if (ret)
229 		return ret;
230 
231 	dev_dbg(rkisp1->dev, "Async subdev notifier completed\n");
232 
233 	return 0;
234 }
235 
236 static const struct v4l2_async_notifier_operations rkisp1_subdev_notifier_ops = {
237 	.bound = rkisp1_subdev_notifier_bound,
238 	.unbind = rkisp1_subdev_notifier_unbind,
239 	.complete = rkisp1_subdev_notifier_complete,
240 };
241 
242 static int rkisp1_subdev_notifier(struct rkisp1_device *rkisp1)
243 {
244 	struct v4l2_async_notifier *ntf = &rkisp1->notifier;
245 	unsigned int next_id = 0;
246 	int ret;
247 
248 	v4l2_async_notifier_init(ntf);
249 
250 	while (1) {
251 		struct v4l2_fwnode_endpoint vep = {
252 			.bus_type = V4L2_MBUS_CSI2_DPHY
253 		};
254 		struct rkisp1_sensor_async *rk_asd = NULL;
255 		struct fwnode_handle *ep;
256 
257 		ep = fwnode_graph_get_endpoint_by_id(dev_fwnode(rkisp1->dev),
258 						     0, next_id,
259 						     FWNODE_GRAPH_ENDPOINT_NEXT);
260 		if (!ep)
261 			break;
262 
263 		ret = v4l2_fwnode_endpoint_parse(ep, &vep);
264 		if (ret)
265 			goto err_parse;
266 
267 		rk_asd = kzalloc(sizeof(*rk_asd), GFP_KERNEL);
268 		if (!rk_asd) {
269 			ret = -ENOMEM;
270 			goto err_parse;
271 		}
272 
273 		rk_asd->mbus_type = vep.bus_type;
274 		rk_asd->mbus_flags = vep.bus.mipi_csi2.flags;
275 		rk_asd->lanes = vep.bus.mipi_csi2.num_data_lanes;
276 
277 		ret = v4l2_async_notifier_add_fwnode_remote_subdev(ntf, ep,
278 								   &rk_asd->asd);
279 		if (ret)
280 			goto err_parse;
281 
282 		dev_dbg(rkisp1->dev, "registered ep id %d with %d lanes\n",
283 			vep.base.id, rk_asd->lanes);
284 
285 		next_id = vep.base.id + 1;
286 
287 		fwnode_handle_put(ep);
288 
289 		continue;
290 err_parse:
291 		fwnode_handle_put(ep);
292 		kfree(rk_asd);
293 		v4l2_async_notifier_cleanup(ntf);
294 		return ret;
295 	}
296 
297 	if (next_id == 0)
298 		dev_dbg(rkisp1->dev, "no remote subdevice found\n");
299 	ntf->ops = &rkisp1_subdev_notifier_ops;
300 	ret = v4l2_async_notifier_register(&rkisp1->v4l2_dev, ntf);
301 	if (ret) {
302 		v4l2_async_notifier_cleanup(ntf);
303 		return ret;
304 	}
305 	return 0;
306 }
307 
308 /* ----------------------------------------------------------------------------
309  * Power
310  */
311 
312 static int __maybe_unused rkisp1_runtime_suspend(struct device *dev)
313 {
314 	struct rkisp1_device *rkisp1 = dev_get_drvdata(dev);
315 
316 	clk_bulk_disable_unprepare(rkisp1->clk_size, rkisp1->clks);
317 	return pinctrl_pm_select_sleep_state(dev);
318 }
319 
320 static int __maybe_unused rkisp1_runtime_resume(struct device *dev)
321 {
322 	struct rkisp1_device *rkisp1 = dev_get_drvdata(dev);
323 	int ret;
324 
325 	ret = pinctrl_pm_select_default_state(dev);
326 	if (ret)
327 		return ret;
328 	ret = clk_bulk_prepare_enable(rkisp1->clk_size, rkisp1->clks);
329 	if (ret)
330 		return ret;
331 
332 	return 0;
333 }
334 
335 static const struct dev_pm_ops rkisp1_pm_ops = {
336 	SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
337 				pm_runtime_force_resume)
338 	SET_RUNTIME_PM_OPS(rkisp1_runtime_suspend, rkisp1_runtime_resume, NULL)
339 };
340 
341 /* ----------------------------------------------------------------------------
342  * Core
343  */
344 
345 static int rkisp1_entities_register(struct rkisp1_device *rkisp1)
346 {
347 	int ret;
348 
349 	ret = rkisp1_isp_register(rkisp1);
350 	if (ret)
351 		return ret;
352 
353 	ret = rkisp1_resizer_devs_register(rkisp1);
354 	if (ret)
355 		goto err_unreg_isp_subdev;
356 
357 	ret = rkisp1_capture_devs_register(rkisp1);
358 	if (ret)
359 		goto err_unreg_resizer_devs;
360 
361 	ret = rkisp1_stats_register(rkisp1);
362 	if (ret)
363 		goto err_unreg_capture_devs;
364 
365 	ret = rkisp1_params_register(rkisp1);
366 	if (ret)
367 		goto err_unreg_stats;
368 
369 	ret = rkisp1_subdev_notifier(rkisp1);
370 	if (ret) {
371 		dev_err(rkisp1->dev,
372 			"Failed to register subdev notifier(%d)\n", ret);
373 		goto err_unreg_params;
374 	}
375 
376 	return 0;
377 err_unreg_params:
378 	rkisp1_params_unregister(rkisp1);
379 err_unreg_stats:
380 	rkisp1_stats_unregister(rkisp1);
381 err_unreg_capture_devs:
382 	rkisp1_capture_devs_unregister(rkisp1);
383 err_unreg_resizer_devs:
384 	rkisp1_resizer_devs_unregister(rkisp1);
385 err_unreg_isp_subdev:
386 	rkisp1_isp_unregister(rkisp1);
387 	return ret;
388 }
389 
390 static irqreturn_t rkisp1_isr(int irq, void *ctx)
391 {
392 	struct device *dev = ctx;
393 	struct rkisp1_device *rkisp1 = dev_get_drvdata(dev);
394 
395 	/*
396 	 * Call rkisp1_capture_isr() first to handle the frame that
397 	 * potentially completed using the current frame_sequence number before
398 	 * it is potentially incremented by rkisp1_isp_isr() in the vertical
399 	 * sync.
400 	 */
401 	rkisp1_capture_isr(rkisp1);
402 	rkisp1_isp_isr(rkisp1);
403 	rkisp1_mipi_isr(rkisp1);
404 
405 	return IRQ_HANDLED;
406 }
407 
408 static const char * const rk3399_isp_clks[] = {
409 	"isp",
410 	"aclk",
411 	"hclk",
412 };
413 
414 static const struct rkisp1_match_data rk3399_isp_clk_data = {
415 	.clks = rk3399_isp_clks,
416 	.size = ARRAY_SIZE(rk3399_isp_clks),
417 };
418 
419 static const struct of_device_id rkisp1_of_match[] = {
420 	{
421 		.compatible = "rockchip,rk3399-cif-isp",
422 		.data = &rk3399_isp_clk_data,
423 	},
424 	{},
425 };
426 MODULE_DEVICE_TABLE(of, rkisp1_of_match);
427 
428 static void rkisp1_debug_init(struct rkisp1_device *rkisp1)
429 {
430 	struct rkisp1_debug *debug = &rkisp1->debug;
431 
432 	debug->debugfs_dir = debugfs_create_dir(RKISP1_DRIVER_NAME, NULL);
433 	debugfs_create_ulong("data_loss", 0444, debug->debugfs_dir,
434 			     &debug->data_loss);
435 	debugfs_create_ulong("outform_size_err", 0444,  debug->debugfs_dir,
436 			     &debug->outform_size_error);
437 	debugfs_create_ulong("img_stabilization_size_error", 0444,
438 			     debug->debugfs_dir,
439 			     &debug->img_stabilization_size_error);
440 	debugfs_create_ulong("inform_size_error", 0444,  debug->debugfs_dir,
441 			     &debug->inform_size_error);
442 	debugfs_create_ulong("irq_delay", 0444,  debug->debugfs_dir,
443 			     &debug->irq_delay);
444 	debugfs_create_ulong("mipi_error", 0444, debug->debugfs_dir,
445 			     &debug->mipi_error);
446 	debugfs_create_ulong("stats_error", 0444, debug->debugfs_dir,
447 			     &debug->stats_error);
448 	debugfs_create_ulong("mp_stop_timeout", 0444, debug->debugfs_dir,
449 			     &debug->stop_timeout[RKISP1_MAINPATH]);
450 	debugfs_create_ulong("sp_stop_timeout", 0444, debug->debugfs_dir,
451 			     &debug->stop_timeout[RKISP1_SELFPATH]);
452 	debugfs_create_ulong("mp_frame_drop", 0444, debug->debugfs_dir,
453 			     &debug->frame_drop[RKISP1_MAINPATH]);
454 	debugfs_create_ulong("sp_frame_drop", 0444, debug->debugfs_dir,
455 			     &debug->frame_drop[RKISP1_SELFPATH]);
456 }
457 
458 static int rkisp1_probe(struct platform_device *pdev)
459 {
460 	const struct rkisp1_match_data *clk_data;
461 	struct device *dev = &pdev->dev;
462 	struct rkisp1_device *rkisp1;
463 	struct v4l2_device *v4l2_dev;
464 	unsigned int i;
465 	int ret, irq;
466 
467 	clk_data = of_device_get_match_data(&pdev->dev);
468 	if (!clk_data)
469 		return -ENODEV;
470 
471 	rkisp1 = devm_kzalloc(dev, sizeof(*rkisp1), GFP_KERNEL);
472 	if (!rkisp1)
473 		return -ENOMEM;
474 
475 	dev_set_drvdata(dev, rkisp1);
476 	rkisp1->dev = dev;
477 
478 	mutex_init(&rkisp1->stream_lock);
479 
480 	rkisp1->base_addr = devm_platform_ioremap_resource(pdev, 0);
481 	if (IS_ERR(rkisp1->base_addr))
482 		return PTR_ERR(rkisp1->base_addr);
483 
484 	irq = platform_get_irq(pdev, 0);
485 	if (irq < 0)
486 		return irq;
487 
488 	ret = devm_request_irq(dev, irq, rkisp1_isr, IRQF_SHARED,
489 			       dev_driver_string(dev), dev);
490 	if (ret) {
491 		dev_err(dev, "request irq failed: %d\n", ret);
492 		return ret;
493 	}
494 
495 	rkisp1->irq = irq;
496 
497 	for (i = 0; i < clk_data->size; i++)
498 		rkisp1->clks[i].id = clk_data->clks[i];
499 	ret = devm_clk_bulk_get(dev, clk_data->size, rkisp1->clks);
500 	if (ret)
501 		return ret;
502 	rkisp1->clk_size = clk_data->size;
503 
504 	pm_runtime_enable(&pdev->dev);
505 
506 	strscpy(rkisp1->media_dev.model, RKISP1_DRIVER_NAME,
507 		sizeof(rkisp1->media_dev.model));
508 	rkisp1->media_dev.dev = &pdev->dev;
509 	strscpy(rkisp1->media_dev.bus_info, RKISP1_BUS_INFO,
510 		sizeof(rkisp1->media_dev.bus_info));
511 	media_device_init(&rkisp1->media_dev);
512 
513 	v4l2_dev = &rkisp1->v4l2_dev;
514 	v4l2_dev->mdev = &rkisp1->media_dev;
515 	strscpy(v4l2_dev->name, RKISP1_DRIVER_NAME, sizeof(v4l2_dev->name));
516 
517 	ret = v4l2_device_register(rkisp1->dev, &rkisp1->v4l2_dev);
518 	if (ret)
519 		return ret;
520 
521 	ret = media_device_register(&rkisp1->media_dev);
522 	if (ret) {
523 		dev_err(dev, "Failed to register media device: %d\n", ret);
524 		goto err_unreg_v4l2_dev;
525 	}
526 
527 	ret = rkisp1_entities_register(rkisp1);
528 	if (ret)
529 		goto err_unreg_media_dev;
530 
531 	rkisp1_debug_init(rkisp1);
532 
533 	return 0;
534 
535 err_unreg_media_dev:
536 	media_device_unregister(&rkisp1->media_dev);
537 err_unreg_v4l2_dev:
538 	v4l2_device_unregister(&rkisp1->v4l2_dev);
539 	pm_runtime_disable(&pdev->dev);
540 	return ret;
541 }
542 
543 static int rkisp1_remove(struct platform_device *pdev)
544 {
545 	struct rkisp1_device *rkisp1 = platform_get_drvdata(pdev);
546 
547 	v4l2_async_notifier_unregister(&rkisp1->notifier);
548 	v4l2_async_notifier_cleanup(&rkisp1->notifier);
549 
550 	rkisp1_params_unregister(rkisp1);
551 	rkisp1_stats_unregister(rkisp1);
552 	rkisp1_capture_devs_unregister(rkisp1);
553 	rkisp1_resizer_devs_unregister(rkisp1);
554 	rkisp1_isp_unregister(rkisp1);
555 
556 	media_device_unregister(&rkisp1->media_dev);
557 	v4l2_device_unregister(&rkisp1->v4l2_dev);
558 
559 	pm_runtime_disable(&pdev->dev);
560 
561 	debugfs_remove_recursive(rkisp1->debug.debugfs_dir);
562 	return 0;
563 }
564 
565 static struct platform_driver rkisp1_drv = {
566 	.driver = {
567 		.name = RKISP1_DRIVER_NAME,
568 		.of_match_table = of_match_ptr(rkisp1_of_match),
569 		.pm = &rkisp1_pm_ops,
570 	},
571 	.probe = rkisp1_probe,
572 	.remove = rkisp1_remove,
573 };
574 
575 module_platform_driver(rkisp1_drv);
576 MODULE_DESCRIPTION("Rockchip ISP1 platform driver");
577 MODULE_LICENSE("Dual MIT/GPL");
578