1 /*
2  * Copyright (C) Fuzhou Rockchip Electronics Co.Ltd
3  * Author:Mark Yao <mark.yao@rock-chips.com>
4  *
5  * based on exynos_drm_drv.c
6  *
7  * This software is licensed under the terms of the GNU General Public
8  * License version 2, as published by the Free Software Foundation, and
9  * may be copied, distributed, and modified under those terms.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  */
16 
17 #include <asm/dma-iommu.h>
18 
19 #include <drm/drmP.h>
20 #include <drm/drm_crtc_helper.h>
21 #include <drm/drm_fb_helper.h>
22 #include <linux/dma-mapping.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/module.h>
25 #include <linux/of_graph.h>
26 #include <linux/component.h>
27 
28 #include "rockchip_drm_drv.h"
29 #include "rockchip_drm_fb.h"
30 #include "rockchip_drm_fbdev.h"
31 #include "rockchip_drm_gem.h"
32 
33 #define DRIVER_NAME	"rockchip"
34 #define DRIVER_DESC	"RockChip Soc DRM"
35 #define DRIVER_DATE	"20140818"
36 #define DRIVER_MAJOR	1
37 #define DRIVER_MINOR	0
38 
39 /*
40  * Attach a (component) device to the shared drm dma mapping from master drm
41  * device.  This is used by the VOPs to map GEM buffers to a common DMA
42  * mapping.
43  */
44 int rockchip_drm_dma_attach_device(struct drm_device *drm_dev,
45 				   struct device *dev)
46 {
47 	struct dma_iommu_mapping *mapping = drm_dev->dev->archdata.mapping;
48 	int ret;
49 
50 	ret = dma_set_coherent_mask(dev, DMA_BIT_MASK(32));
51 	if (ret)
52 		return ret;
53 
54 	dma_set_max_seg_size(dev, DMA_BIT_MASK(32));
55 
56 	return arm_iommu_attach_device(dev, mapping);
57 }
58 EXPORT_SYMBOL_GPL(rockchip_drm_dma_attach_device);
59 
60 void rockchip_drm_dma_detach_device(struct drm_device *drm_dev,
61 				    struct device *dev)
62 {
63 	arm_iommu_detach_device(dev);
64 }
65 EXPORT_SYMBOL_GPL(rockchip_drm_dma_detach_device);
66 
67 int rockchip_register_crtc_funcs(struct drm_device *dev,
68 				 const struct rockchip_crtc_funcs *crtc_funcs,
69 				 int pipe)
70 {
71 	struct rockchip_drm_private *priv = dev->dev_private;
72 
73 	if (pipe > ROCKCHIP_MAX_CRTC)
74 		return -EINVAL;
75 
76 	priv->crtc_funcs[pipe] = crtc_funcs;
77 
78 	return 0;
79 }
80 EXPORT_SYMBOL_GPL(rockchip_register_crtc_funcs);
81 
82 void rockchip_unregister_crtc_funcs(struct drm_device *dev, int pipe)
83 {
84 	struct rockchip_drm_private *priv = dev->dev_private;
85 
86 	if (pipe > ROCKCHIP_MAX_CRTC)
87 		return;
88 
89 	priv->crtc_funcs[pipe] = NULL;
90 }
91 EXPORT_SYMBOL_GPL(rockchip_unregister_crtc_funcs);
92 
93 static struct drm_crtc *rockchip_crtc_from_pipe(struct drm_device *drm,
94 						int pipe)
95 {
96 	struct drm_crtc *crtc;
97 	int i = 0;
98 
99 	list_for_each_entry(crtc, &drm->mode_config.crtc_list, head)
100 		if (i++ == pipe)
101 			return crtc;
102 
103 	return NULL;
104 }
105 
106 static int rockchip_drm_crtc_enable_vblank(struct drm_device *dev,
107 					   unsigned int pipe)
108 {
109 	struct rockchip_drm_private *priv = dev->dev_private;
110 	struct drm_crtc *crtc = rockchip_crtc_from_pipe(dev, pipe);
111 
112 	if (crtc && priv->crtc_funcs[pipe] &&
113 	    priv->crtc_funcs[pipe]->enable_vblank)
114 		return priv->crtc_funcs[pipe]->enable_vblank(crtc);
115 
116 	return 0;
117 }
118 
119 static void rockchip_drm_crtc_disable_vblank(struct drm_device *dev,
120 					     unsigned int pipe)
121 {
122 	struct rockchip_drm_private *priv = dev->dev_private;
123 	struct drm_crtc *crtc = rockchip_crtc_from_pipe(dev, pipe);
124 
125 	if (crtc && priv->crtc_funcs[pipe] &&
126 	    priv->crtc_funcs[pipe]->enable_vblank)
127 		priv->crtc_funcs[pipe]->disable_vblank(crtc);
128 }
129 
130 static int rockchip_drm_load(struct drm_device *drm_dev, unsigned long flags)
131 {
132 	struct rockchip_drm_private *private;
133 	struct dma_iommu_mapping *mapping;
134 	struct device *dev = drm_dev->dev;
135 	struct drm_connector *connector;
136 	int ret;
137 
138 	private = devm_kzalloc(drm_dev->dev, sizeof(*private), GFP_KERNEL);
139 	if (!private)
140 		return -ENOMEM;
141 
142 	drm_dev->dev_private = private;
143 
144 	drm_mode_config_init(drm_dev);
145 
146 	rockchip_drm_mode_config_init(drm_dev);
147 
148 	dev->dma_parms = devm_kzalloc(dev, sizeof(*dev->dma_parms),
149 				      GFP_KERNEL);
150 	if (!dev->dma_parms) {
151 		ret = -ENOMEM;
152 		goto err_config_cleanup;
153 	}
154 
155 	/* TODO(djkurtz): fetch the mapping start/size from somewhere */
156 	mapping = arm_iommu_create_mapping(&platform_bus_type, 0x00000000,
157 					   SZ_2G);
158 	if (IS_ERR(mapping)) {
159 		ret = PTR_ERR(mapping);
160 		goto err_config_cleanup;
161 	}
162 
163 	ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
164 	if (ret)
165 		goto err_release_mapping;
166 
167 	dma_set_max_seg_size(dev, DMA_BIT_MASK(32));
168 
169 	ret = arm_iommu_attach_device(dev, mapping);
170 	if (ret)
171 		goto err_release_mapping;
172 
173 	/* Try to bind all sub drivers. */
174 	ret = component_bind_all(dev, drm_dev);
175 	if (ret)
176 		goto err_detach_device;
177 
178 	/*
179 	 * All components are now added, we can publish the connector sysfs
180 	 * entries to userspace.  This will generate hotplug events and so
181 	 * userspace will expect to be able to access DRM at this point.
182 	 */
183 	list_for_each_entry(connector, &drm_dev->mode_config.connector_list,
184 			head) {
185 		ret = drm_connector_register(connector);
186 		if (ret) {
187 			dev_err(drm_dev->dev,
188 				"[CONNECTOR:%d:%s] drm_connector_register failed: %d\n",
189 				connector->base.id,
190 				connector->name, ret);
191 			goto err_unbind;
192 		}
193 	}
194 
195 	/* init kms poll for handling hpd */
196 	drm_kms_helper_poll_init(drm_dev);
197 
198 	/*
199 	 * enable drm irq mode.
200 	 * - with irq_enabled = true, we can use the vblank feature.
201 	 */
202 	drm_dev->irq_enabled = true;
203 
204 	ret = drm_vblank_init(drm_dev, ROCKCHIP_MAX_CRTC);
205 	if (ret)
206 		goto err_kms_helper_poll_fini;
207 
208 	/*
209 	 * with vblank_disable_allowed = true, vblank interrupt will be disabled
210 	 * by drm timer once a current process gives up ownership of
211 	 * vblank event.(after drm_vblank_put function is called)
212 	 */
213 	drm_dev->vblank_disable_allowed = true;
214 
215 	ret = rockchip_drm_fbdev_init(drm_dev);
216 	if (ret)
217 		goto err_vblank_cleanup;
218 
219 	return 0;
220 err_vblank_cleanup:
221 	drm_vblank_cleanup(drm_dev);
222 err_kms_helper_poll_fini:
223 	drm_kms_helper_poll_fini(drm_dev);
224 err_unbind:
225 	component_unbind_all(dev, drm_dev);
226 err_detach_device:
227 	arm_iommu_detach_device(dev);
228 err_release_mapping:
229 	arm_iommu_release_mapping(dev->archdata.mapping);
230 err_config_cleanup:
231 	drm_mode_config_cleanup(drm_dev);
232 	drm_dev->dev_private = NULL;
233 	return ret;
234 }
235 
236 static int rockchip_drm_unload(struct drm_device *drm_dev)
237 {
238 	struct device *dev = drm_dev->dev;
239 
240 	rockchip_drm_fbdev_fini(drm_dev);
241 	drm_vblank_cleanup(drm_dev);
242 	drm_kms_helper_poll_fini(drm_dev);
243 	component_unbind_all(dev, drm_dev);
244 	arm_iommu_detach_device(dev);
245 	arm_iommu_release_mapping(dev->archdata.mapping);
246 	drm_mode_config_cleanup(drm_dev);
247 	drm_dev->dev_private = NULL;
248 
249 	return 0;
250 }
251 
252 void rockchip_drm_lastclose(struct drm_device *dev)
253 {
254 	struct rockchip_drm_private *priv = dev->dev_private;
255 
256 	drm_fb_helper_restore_fbdev_mode_unlocked(&priv->fbdev_helper);
257 }
258 
259 static const struct file_operations rockchip_drm_driver_fops = {
260 	.owner = THIS_MODULE,
261 	.open = drm_open,
262 	.mmap = rockchip_gem_mmap,
263 	.poll = drm_poll,
264 	.read = drm_read,
265 	.unlocked_ioctl = drm_ioctl,
266 #ifdef CONFIG_COMPAT
267 	.compat_ioctl = drm_compat_ioctl,
268 #endif
269 	.release = drm_release,
270 };
271 
272 const struct vm_operations_struct rockchip_drm_vm_ops = {
273 	.open = drm_gem_vm_open,
274 	.close = drm_gem_vm_close,
275 };
276 
277 static struct drm_driver rockchip_drm_driver = {
278 	.driver_features	= DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME,
279 	.load			= rockchip_drm_load,
280 	.unload			= rockchip_drm_unload,
281 	.lastclose		= rockchip_drm_lastclose,
282 	.get_vblank_counter	= drm_vblank_no_hw_counter,
283 	.enable_vblank		= rockchip_drm_crtc_enable_vblank,
284 	.disable_vblank		= rockchip_drm_crtc_disable_vblank,
285 	.gem_vm_ops		= &rockchip_drm_vm_ops,
286 	.gem_free_object	= rockchip_gem_free_object,
287 	.dumb_create		= rockchip_gem_dumb_create,
288 	.dumb_map_offset	= rockchip_gem_dumb_map_offset,
289 	.dumb_destroy		= drm_gem_dumb_destroy,
290 	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
291 	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
292 	.gem_prime_import	= drm_gem_prime_import,
293 	.gem_prime_export	= drm_gem_prime_export,
294 	.gem_prime_get_sg_table	= rockchip_gem_prime_get_sg_table,
295 	.gem_prime_vmap		= rockchip_gem_prime_vmap,
296 	.gem_prime_vunmap	= rockchip_gem_prime_vunmap,
297 	.gem_prime_mmap		= rockchip_gem_mmap_buf,
298 	.fops			= &rockchip_drm_driver_fops,
299 	.name	= DRIVER_NAME,
300 	.desc	= DRIVER_DESC,
301 	.date	= DRIVER_DATE,
302 	.major	= DRIVER_MAJOR,
303 	.minor	= DRIVER_MINOR,
304 };
305 
306 #ifdef CONFIG_PM_SLEEP
307 static int rockchip_drm_sys_suspend(struct device *dev)
308 {
309 	struct drm_device *drm = dev_get_drvdata(dev);
310 	struct drm_connector *connector;
311 
312 	if (!drm)
313 		return 0;
314 
315 	drm_modeset_lock_all(drm);
316 	list_for_each_entry(connector, &drm->mode_config.connector_list, head) {
317 		int old_dpms = connector->dpms;
318 
319 		if (connector->funcs->dpms)
320 			connector->funcs->dpms(connector, DRM_MODE_DPMS_OFF);
321 
322 		/* Set the old mode back to the connector for resume */
323 		connector->dpms = old_dpms;
324 	}
325 	drm_modeset_unlock_all(drm);
326 
327 	return 0;
328 }
329 
330 static int rockchip_drm_sys_resume(struct device *dev)
331 {
332 	struct drm_device *drm = dev_get_drvdata(dev);
333 	struct drm_connector *connector;
334 	enum drm_connector_status status;
335 	bool changed = false;
336 
337 	if (!drm)
338 		return 0;
339 
340 	drm_modeset_lock_all(drm);
341 	list_for_each_entry(connector, &drm->mode_config.connector_list, head) {
342 		int desired_mode = connector->dpms;
343 
344 		/*
345 		 * at suspend time, we save dpms to connector->dpms,
346 		 * restore the old_dpms, and at current time, the connector
347 		 * dpms status must be DRM_MODE_DPMS_OFF.
348 		 */
349 		connector->dpms = DRM_MODE_DPMS_OFF;
350 
351 		/*
352 		 * If the connector has been disconnected during suspend,
353 		 * disconnect it from the encoder and leave it off. We'll notify
354 		 * userspace at the end.
355 		 */
356 		if (desired_mode == DRM_MODE_DPMS_ON) {
357 			status = connector->funcs->detect(connector, true);
358 			if (status == connector_status_disconnected) {
359 				connector->encoder = NULL;
360 				connector->status = status;
361 				changed = true;
362 				continue;
363 			}
364 		}
365 		if (connector->funcs->dpms)
366 			connector->funcs->dpms(connector, desired_mode);
367 	}
368 	drm_modeset_unlock_all(drm);
369 
370 	drm_helper_resume_force_mode(drm);
371 
372 	if (changed)
373 		drm_kms_helper_hotplug_event(drm);
374 
375 	return 0;
376 }
377 #endif
378 
379 static const struct dev_pm_ops rockchip_drm_pm_ops = {
380 	SET_SYSTEM_SLEEP_PM_OPS(rockchip_drm_sys_suspend,
381 				rockchip_drm_sys_resume)
382 };
383 
384 /*
385  * @node: device tree node containing encoder input ports
386  * @encoder: drm_encoder
387  */
388 int rockchip_drm_encoder_get_mux_id(struct device_node *node,
389 				    struct drm_encoder *encoder)
390 {
391 	struct device_node *ep;
392 	struct drm_crtc *crtc = encoder->crtc;
393 	struct of_endpoint endpoint;
394 	struct device_node *port;
395 	int ret;
396 
397 	if (!node || !crtc)
398 		return -EINVAL;
399 
400 	for_each_endpoint_of_node(node, ep) {
401 		port = of_graph_get_remote_port(ep);
402 		of_node_put(port);
403 		if (port == crtc->port) {
404 			ret = of_graph_parse_endpoint(ep, &endpoint);
405 			of_node_put(ep);
406 			return ret ?: endpoint.id;
407 		}
408 	}
409 
410 	return -EINVAL;
411 }
412 EXPORT_SYMBOL_GPL(rockchip_drm_encoder_get_mux_id);
413 
414 static int compare_of(struct device *dev, void *data)
415 {
416 	struct device_node *np = data;
417 
418 	return dev->of_node == np;
419 }
420 
421 static void rockchip_add_endpoints(struct device *dev,
422 				   struct component_match **match,
423 				   struct device_node *port)
424 {
425 	struct device_node *ep, *remote;
426 
427 	for_each_child_of_node(port, ep) {
428 		remote = of_graph_get_remote_port_parent(ep);
429 		if (!remote || !of_device_is_available(remote)) {
430 			of_node_put(remote);
431 			continue;
432 		} else if (!of_device_is_available(remote->parent)) {
433 			dev_warn(dev, "parent device of %s is not available\n",
434 				 remote->full_name);
435 			of_node_put(remote);
436 			continue;
437 		}
438 
439 		component_match_add(dev, match, compare_of, remote);
440 		of_node_put(remote);
441 	}
442 }
443 
444 static int rockchip_drm_bind(struct device *dev)
445 {
446 	struct drm_device *drm;
447 	int ret;
448 
449 	drm = drm_dev_alloc(&rockchip_drm_driver, dev);
450 	if (!drm)
451 		return -ENOMEM;
452 
453 	ret = drm_dev_set_unique(drm, "%s", dev_name(dev));
454 	if (ret)
455 		goto err_free;
456 
457 	ret = drm_dev_register(drm, 0);
458 	if (ret)
459 		goto err_free;
460 
461 	dev_set_drvdata(dev, drm);
462 
463 	return 0;
464 
465 err_free:
466 	drm_dev_unref(drm);
467 	return ret;
468 }
469 
470 static void rockchip_drm_unbind(struct device *dev)
471 {
472 	struct drm_device *drm = dev_get_drvdata(dev);
473 
474 	drm_dev_unregister(drm);
475 	drm_dev_unref(drm);
476 	dev_set_drvdata(dev, NULL);
477 }
478 
479 static const struct component_master_ops rockchip_drm_ops = {
480 	.bind = rockchip_drm_bind,
481 	.unbind = rockchip_drm_unbind,
482 };
483 
484 static int rockchip_drm_platform_probe(struct platform_device *pdev)
485 {
486 	struct device *dev = &pdev->dev;
487 	struct component_match *match = NULL;
488 	struct device_node *np = dev->of_node;
489 	struct device_node *port;
490 	int i;
491 
492 	if (!np)
493 		return -ENODEV;
494 	/*
495 	 * Bind the crtc ports first, so that
496 	 * drm_of_find_possible_crtcs called from encoder .bind callbacks
497 	 * works as expected.
498 	 */
499 	for (i = 0;; i++) {
500 		port = of_parse_phandle(np, "ports", i);
501 		if (!port)
502 			break;
503 
504 		if (!of_device_is_available(port->parent)) {
505 			of_node_put(port);
506 			continue;
507 		}
508 
509 		component_match_add(dev, &match, compare_of, port->parent);
510 		of_node_put(port);
511 	}
512 
513 	if (i == 0) {
514 		dev_err(dev, "missing 'ports' property\n");
515 		return -ENODEV;
516 	}
517 
518 	if (!match) {
519 		dev_err(dev, "No available vop found for display-subsystem.\n");
520 		return -ENODEV;
521 	}
522 	/*
523 	 * For each bound crtc, bind the encoders attached to its
524 	 * remote endpoint.
525 	 */
526 	for (i = 0;; i++) {
527 		port = of_parse_phandle(np, "ports", i);
528 		if (!port)
529 			break;
530 
531 		if (!of_device_is_available(port->parent)) {
532 			of_node_put(port);
533 			continue;
534 		}
535 
536 		rockchip_add_endpoints(dev, &match, port);
537 		of_node_put(port);
538 	}
539 
540 	return component_master_add_with_match(dev, &rockchip_drm_ops, match);
541 }
542 
543 static int rockchip_drm_platform_remove(struct platform_device *pdev)
544 {
545 	component_master_del(&pdev->dev, &rockchip_drm_ops);
546 
547 	return 0;
548 }
549 
550 static const struct of_device_id rockchip_drm_dt_ids[] = {
551 	{ .compatible = "rockchip,display-subsystem", },
552 	{ /* sentinel */ },
553 };
554 MODULE_DEVICE_TABLE(of, rockchip_drm_dt_ids);
555 
556 static struct platform_driver rockchip_drm_platform_driver = {
557 	.probe = rockchip_drm_platform_probe,
558 	.remove = rockchip_drm_platform_remove,
559 	.driver = {
560 		.name = "rockchip-drm",
561 		.of_match_table = rockchip_drm_dt_ids,
562 		.pm = &rockchip_drm_pm_ops,
563 	},
564 };
565 
566 module_platform_driver(rockchip_drm_platform_driver);
567 
568 MODULE_AUTHOR("Mark Yao <mark.yao@rock-chips.com>");
569 MODULE_DESCRIPTION("ROCKCHIP DRM Driver");
570 MODULE_LICENSE("GPL v2");
571