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 
59 void rockchip_drm_dma_detach_device(struct drm_device *drm_dev,
60 				    struct device *dev)
61 {
62 	arm_iommu_detach_device(dev);
63 }
64 
65 int rockchip_register_crtc_funcs(struct drm_crtc *crtc,
66 				 const struct rockchip_crtc_funcs *crtc_funcs)
67 {
68 	int pipe = drm_crtc_index(crtc);
69 	struct rockchip_drm_private *priv = crtc->dev->dev_private;
70 
71 	if (pipe > ROCKCHIP_MAX_CRTC)
72 		return -EINVAL;
73 
74 	priv->crtc_funcs[pipe] = crtc_funcs;
75 
76 	return 0;
77 }
78 
79 void rockchip_unregister_crtc_funcs(struct drm_crtc *crtc)
80 {
81 	int pipe = drm_crtc_index(crtc);
82 	struct rockchip_drm_private *priv = crtc->dev->dev_private;
83 
84 	if (pipe > ROCKCHIP_MAX_CRTC)
85 		return;
86 
87 	priv->crtc_funcs[pipe] = NULL;
88 }
89 
90 static struct drm_crtc *rockchip_crtc_from_pipe(struct drm_device *drm,
91 						int pipe)
92 {
93 	struct drm_crtc *crtc;
94 	int i = 0;
95 
96 	list_for_each_entry(crtc, &drm->mode_config.crtc_list, head)
97 		if (i++ == pipe)
98 			return crtc;
99 
100 	return NULL;
101 }
102 
103 static int rockchip_drm_crtc_enable_vblank(struct drm_device *dev,
104 					   unsigned int pipe)
105 {
106 	struct rockchip_drm_private *priv = dev->dev_private;
107 	struct drm_crtc *crtc = rockchip_crtc_from_pipe(dev, pipe);
108 
109 	if (crtc && priv->crtc_funcs[pipe] &&
110 	    priv->crtc_funcs[pipe]->enable_vblank)
111 		return priv->crtc_funcs[pipe]->enable_vblank(crtc);
112 
113 	return 0;
114 }
115 
116 static void rockchip_drm_crtc_disable_vblank(struct drm_device *dev,
117 					     unsigned int pipe)
118 {
119 	struct rockchip_drm_private *priv = dev->dev_private;
120 	struct drm_crtc *crtc = rockchip_crtc_from_pipe(dev, pipe);
121 
122 	if (crtc && priv->crtc_funcs[pipe] &&
123 	    priv->crtc_funcs[pipe]->enable_vblank)
124 		priv->crtc_funcs[pipe]->disable_vblank(crtc);
125 }
126 
127 static int rockchip_drm_load(struct drm_device *drm_dev, unsigned long flags)
128 {
129 	struct rockchip_drm_private *private;
130 	struct dma_iommu_mapping *mapping;
131 	struct device *dev = drm_dev->dev;
132 	struct drm_connector *connector;
133 	int ret;
134 
135 	private = devm_kzalloc(drm_dev->dev, sizeof(*private), GFP_KERNEL);
136 	if (!private)
137 		return -ENOMEM;
138 
139 	mutex_init(&private->commit.lock);
140 	INIT_WORK(&private->commit.work, rockchip_drm_atomic_work);
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 	drm_mode_config_reset(drm_dev);
216 
217 	ret = rockchip_drm_fbdev_init(drm_dev);
218 	if (ret)
219 		goto err_vblank_cleanup;
220 
221 	return 0;
222 err_vblank_cleanup:
223 	drm_vblank_cleanup(drm_dev);
224 err_kms_helper_poll_fini:
225 	drm_kms_helper_poll_fini(drm_dev);
226 err_unbind:
227 	component_unbind_all(dev, drm_dev);
228 err_detach_device:
229 	arm_iommu_detach_device(dev);
230 err_release_mapping:
231 	arm_iommu_release_mapping(dev->archdata.mapping);
232 err_config_cleanup:
233 	drm_mode_config_cleanup(drm_dev);
234 	drm_dev->dev_private = NULL;
235 	return ret;
236 }
237 
238 static int rockchip_drm_unload(struct drm_device *drm_dev)
239 {
240 	struct device *dev = drm_dev->dev;
241 
242 	rockchip_drm_fbdev_fini(drm_dev);
243 	drm_vblank_cleanup(drm_dev);
244 	drm_kms_helper_poll_fini(drm_dev);
245 	component_unbind_all(dev, drm_dev);
246 	arm_iommu_detach_device(dev);
247 	arm_iommu_release_mapping(dev->archdata.mapping);
248 	drm_mode_config_cleanup(drm_dev);
249 	drm_dev->dev_private = NULL;
250 
251 	return 0;
252 }
253 
254 void rockchip_drm_lastclose(struct drm_device *dev)
255 {
256 	struct rockchip_drm_private *priv = dev->dev_private;
257 
258 	drm_fb_helper_restore_fbdev_mode_unlocked(&priv->fbdev_helper);
259 }
260 
261 static const struct file_operations rockchip_drm_driver_fops = {
262 	.owner = THIS_MODULE,
263 	.open = drm_open,
264 	.mmap = rockchip_gem_mmap,
265 	.poll = drm_poll,
266 	.read = drm_read,
267 	.unlocked_ioctl = drm_ioctl,
268 #ifdef CONFIG_COMPAT
269 	.compat_ioctl = drm_compat_ioctl,
270 #endif
271 	.release = drm_release,
272 };
273 
274 const struct vm_operations_struct rockchip_drm_vm_ops = {
275 	.open = drm_gem_vm_open,
276 	.close = drm_gem_vm_close,
277 };
278 
279 static struct drm_driver rockchip_drm_driver = {
280 	.driver_features	= DRIVER_MODESET | DRIVER_GEM |
281 				  DRIVER_PRIME | DRIVER_ATOMIC,
282 	.load			= rockchip_drm_load,
283 	.unload			= rockchip_drm_unload,
284 	.lastclose		= rockchip_drm_lastclose,
285 	.get_vblank_counter	= drm_vblank_no_hw_counter,
286 	.enable_vblank		= rockchip_drm_crtc_enable_vblank,
287 	.disable_vblank		= rockchip_drm_crtc_disable_vblank,
288 	.gem_vm_ops		= &rockchip_drm_vm_ops,
289 	.gem_free_object	= rockchip_gem_free_object,
290 	.dumb_create		= rockchip_gem_dumb_create,
291 	.dumb_map_offset	= rockchip_gem_dumb_map_offset,
292 	.dumb_destroy		= drm_gem_dumb_destroy,
293 	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
294 	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
295 	.gem_prime_import	= drm_gem_prime_import,
296 	.gem_prime_export	= drm_gem_prime_export,
297 	.gem_prime_get_sg_table	= rockchip_gem_prime_get_sg_table,
298 	.gem_prime_vmap		= rockchip_gem_prime_vmap,
299 	.gem_prime_vunmap	= rockchip_gem_prime_vunmap,
300 	.gem_prime_mmap		= rockchip_gem_mmap_buf,
301 	.fops			= &rockchip_drm_driver_fops,
302 	.name	= DRIVER_NAME,
303 	.desc	= DRIVER_DESC,
304 	.date	= DRIVER_DATE,
305 	.major	= DRIVER_MAJOR,
306 	.minor	= DRIVER_MINOR,
307 };
308 
309 #ifdef CONFIG_PM_SLEEP
310 static int rockchip_drm_sys_suspend(struct device *dev)
311 {
312 	struct drm_device *drm = dev_get_drvdata(dev);
313 	struct drm_connector *connector;
314 
315 	if (!drm)
316 		return 0;
317 
318 	drm_modeset_lock_all(drm);
319 	list_for_each_entry(connector, &drm->mode_config.connector_list, head) {
320 		int old_dpms = connector->dpms;
321 
322 		if (connector->funcs->dpms)
323 			connector->funcs->dpms(connector, DRM_MODE_DPMS_OFF);
324 
325 		/* Set the old mode back to the connector for resume */
326 		connector->dpms = old_dpms;
327 	}
328 	drm_modeset_unlock_all(drm);
329 
330 	return 0;
331 }
332 
333 static int rockchip_drm_sys_resume(struct device *dev)
334 {
335 	struct drm_device *drm = dev_get_drvdata(dev);
336 	struct drm_connector *connector;
337 	enum drm_connector_status status;
338 	bool changed = false;
339 
340 	if (!drm)
341 		return 0;
342 
343 	drm_modeset_lock_all(drm);
344 	list_for_each_entry(connector, &drm->mode_config.connector_list, head) {
345 		int desired_mode = connector->dpms;
346 
347 		/*
348 		 * at suspend time, we save dpms to connector->dpms,
349 		 * restore the old_dpms, and at current time, the connector
350 		 * dpms status must be DRM_MODE_DPMS_OFF.
351 		 */
352 		connector->dpms = DRM_MODE_DPMS_OFF;
353 
354 		/*
355 		 * If the connector has been disconnected during suspend,
356 		 * disconnect it from the encoder and leave it off. We'll notify
357 		 * userspace at the end.
358 		 */
359 		if (desired_mode == DRM_MODE_DPMS_ON) {
360 			status = connector->funcs->detect(connector, true);
361 			if (status == connector_status_disconnected) {
362 				connector->encoder = NULL;
363 				connector->status = status;
364 				changed = true;
365 				continue;
366 			}
367 		}
368 		if (connector->funcs->dpms)
369 			connector->funcs->dpms(connector, desired_mode);
370 	}
371 	drm_modeset_unlock_all(drm);
372 
373 	drm_helper_resume_force_mode(drm);
374 
375 	if (changed)
376 		drm_kms_helper_hotplug_event(drm);
377 
378 	return 0;
379 }
380 #endif
381 
382 static const struct dev_pm_ops rockchip_drm_pm_ops = {
383 	SET_SYSTEM_SLEEP_PM_OPS(rockchip_drm_sys_suspend,
384 				rockchip_drm_sys_resume)
385 };
386 
387 static int compare_of(struct device *dev, void *data)
388 {
389 	struct device_node *np = data;
390 
391 	return dev->of_node == np;
392 }
393 
394 static void rockchip_add_endpoints(struct device *dev,
395 				   struct component_match **match,
396 				   struct device_node *port)
397 {
398 	struct device_node *ep, *remote;
399 
400 	for_each_child_of_node(port, ep) {
401 		remote = of_graph_get_remote_port_parent(ep);
402 		if (!remote || !of_device_is_available(remote)) {
403 			of_node_put(remote);
404 			continue;
405 		} else if (!of_device_is_available(remote->parent)) {
406 			dev_warn(dev, "parent device of %s is not available\n",
407 				 remote->full_name);
408 			of_node_put(remote);
409 			continue;
410 		}
411 
412 		component_match_add(dev, match, compare_of, remote);
413 		of_node_put(remote);
414 	}
415 }
416 
417 static int rockchip_drm_bind(struct device *dev)
418 {
419 	struct drm_device *drm;
420 	int ret;
421 
422 	drm = drm_dev_alloc(&rockchip_drm_driver, dev);
423 	if (!drm)
424 		return -ENOMEM;
425 
426 	ret = drm_dev_register(drm, 0);
427 	if (ret)
428 		goto err_free;
429 
430 	dev_set_drvdata(dev, drm);
431 
432 	return 0;
433 
434 err_free:
435 	drm_dev_unref(drm);
436 	return ret;
437 }
438 
439 static void rockchip_drm_unbind(struct device *dev)
440 {
441 	struct drm_device *drm = dev_get_drvdata(dev);
442 
443 	drm_dev_unregister(drm);
444 	drm_dev_unref(drm);
445 	dev_set_drvdata(dev, NULL);
446 }
447 
448 static const struct component_master_ops rockchip_drm_ops = {
449 	.bind = rockchip_drm_bind,
450 	.unbind = rockchip_drm_unbind,
451 };
452 
453 static int rockchip_drm_platform_probe(struct platform_device *pdev)
454 {
455 	struct device *dev = &pdev->dev;
456 	struct component_match *match = NULL;
457 	struct device_node *np = dev->of_node;
458 	struct device_node *port;
459 	int i;
460 
461 	if (!np)
462 		return -ENODEV;
463 	/*
464 	 * Bind the crtc ports first, so that
465 	 * drm_of_find_possible_crtcs called from encoder .bind callbacks
466 	 * works as expected.
467 	 */
468 	for (i = 0;; i++) {
469 		port = of_parse_phandle(np, "ports", i);
470 		if (!port)
471 			break;
472 
473 		if (!of_device_is_available(port->parent)) {
474 			of_node_put(port);
475 			continue;
476 		}
477 
478 		component_match_add(dev, &match, compare_of, port->parent);
479 		of_node_put(port);
480 	}
481 
482 	if (i == 0) {
483 		dev_err(dev, "missing 'ports' property\n");
484 		return -ENODEV;
485 	}
486 
487 	if (!match) {
488 		dev_err(dev, "No available vop found for display-subsystem.\n");
489 		return -ENODEV;
490 	}
491 	/*
492 	 * For each bound crtc, bind the encoders attached to its
493 	 * remote endpoint.
494 	 */
495 	for (i = 0;; i++) {
496 		port = of_parse_phandle(np, "ports", i);
497 		if (!port)
498 			break;
499 
500 		if (!of_device_is_available(port->parent)) {
501 			of_node_put(port);
502 			continue;
503 		}
504 
505 		rockchip_add_endpoints(dev, &match, port);
506 		of_node_put(port);
507 	}
508 
509 	return component_master_add_with_match(dev, &rockchip_drm_ops, match);
510 }
511 
512 static int rockchip_drm_platform_remove(struct platform_device *pdev)
513 {
514 	component_master_del(&pdev->dev, &rockchip_drm_ops);
515 
516 	return 0;
517 }
518 
519 static const struct of_device_id rockchip_drm_dt_ids[] = {
520 	{ .compatible = "rockchip,display-subsystem", },
521 	{ /* sentinel */ },
522 };
523 MODULE_DEVICE_TABLE(of, rockchip_drm_dt_ids);
524 
525 static struct platform_driver rockchip_drm_platform_driver = {
526 	.probe = rockchip_drm_platform_probe,
527 	.remove = rockchip_drm_platform_remove,
528 	.driver = {
529 		.name = "rockchip-drm",
530 		.of_match_table = rockchip_drm_dt_ids,
531 		.pm = &rockchip_drm_pm_ops,
532 	},
533 };
534 
535 module_platform_driver(rockchip_drm_platform_driver);
536 
537 MODULE_AUTHOR("Mark Yao <mark.yao@rock-chips.com>");
538 MODULE_DESCRIPTION("ROCKCHIP DRM Driver");
539 MODULE_LICENSE("GPL v2");
540