1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2011 Texas Instruments Incorporated - https://www.ti.com/
7 #include <linux/dma-mapping.h>
8 #include <linux/platform_device.h>
9 #include <linux/sort.h>
10 #include <linux/sys_soc.h>
12 #include <drm/drm_atomic.h>
13 #include <drm/drm_atomic_helper.h>
14 #include <drm/drm_bridge.h>
15 #include <drm/drm_bridge_connector.h>
16 #include <drm/drm_drv.h>
17 #include <drm/drm_fb_helper.h>
18 #include <drm/drm_file.h>
19 #include <drm/drm_ioctl.h>
20 #include <drm/drm_panel.h>
21 #include <drm/drm_prime.h>
22 #include <drm/drm_probe_helper.h>
23 #include <drm/drm_vblank.h>
25 #include "omap_dmm_tiler.h"
28 #define DRIVER_NAME MODULE_NAME
29 #define DRIVER_DESC "OMAP DRM"
30 #define DRIVER_DATE "20110917"
31 #define DRIVER_MAJOR 1
32 #define DRIVER_MINOR 0
33 #define DRIVER_PATCHLEVEL 0
39 /* Notes about mapping DSS and DRM entities:
41 * encoder: manager.. with some extension to allow one primary CRTC
42 * and zero or more video CRTC's to be mapped to one encoder?
43 * connector: dssdev.. manager can be attached/detached from different
47 static void omap_atomic_wait_for_completion(struct drm_device *dev,
48 struct drm_atomic_state *old_state)
50 struct drm_crtc_state *new_crtc_state;
51 struct drm_crtc *crtc;
55 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
56 if (!new_crtc_state->active)
59 ret = omap_crtc_wait_pending(crtc);
63 "atomic complete timeout (pipe %u)!\n", i);
67 static void omap_atomic_commit_tail(struct drm_atomic_state *old_state)
69 struct drm_device *dev = old_state->dev;
70 struct omap_drm_private *priv = dev->dev_private;
71 bool fence_cookie = dma_fence_begin_signalling();
73 dispc_runtime_get(priv->dispc);
75 /* Apply the atomic update. */
76 drm_atomic_helper_commit_modeset_disables(dev, old_state);
78 if (priv->omaprev != 0x3430) {
79 /* With the current dss dispc implementation we have to enable
80 * the new modeset before we can commit planes. The dispc ovl
81 * configuration relies on the video mode configuration been
82 * written into the HW when the ovl configuration is
85 * This approach is not ideal because after a mode change the
86 * plane update is executed only after the first vblank
87 * interrupt. The dispc implementation should be fixed so that
88 * it is able use uncommitted drm state information.
90 drm_atomic_helper_commit_modeset_enables(dev, old_state);
91 omap_atomic_wait_for_completion(dev, old_state);
93 drm_atomic_helper_commit_planes(dev, old_state, 0);
96 * OMAP3 DSS seems to have issues with the work-around above,
97 * resulting in endless sync losts if a crtc is enabled without
98 * a plane. For now, skip the WA for OMAP3.
100 drm_atomic_helper_commit_planes(dev, old_state, 0);
102 drm_atomic_helper_commit_modeset_enables(dev, old_state);
105 drm_atomic_helper_commit_hw_done(old_state);
107 dma_fence_end_signalling(fence_cookie);
110 * Wait for completion of the page flips to ensure that old buffers
111 * can't be touched by the hardware anymore before cleaning up planes.
113 omap_atomic_wait_for_completion(dev, old_state);
115 drm_atomic_helper_cleanup_planes(dev, old_state);
117 dispc_runtime_put(priv->dispc);
120 static const struct drm_mode_config_helper_funcs omap_mode_config_helper_funcs = {
121 .atomic_commit_tail = omap_atomic_commit_tail,
124 static const struct drm_mode_config_funcs omap_mode_config_funcs = {
125 .fb_create = omap_framebuffer_create,
126 .output_poll_changed = drm_fb_helper_output_poll_changed,
127 .atomic_check = drm_atomic_helper_check,
128 .atomic_commit = drm_atomic_helper_commit,
131 static void omap_disconnect_pipelines(struct drm_device *ddev)
133 struct omap_drm_private *priv = ddev->dev_private;
136 for (i = 0; i < priv->num_pipes; i++) {
137 struct omap_drm_pipeline *pipe = &priv->pipes[i];
139 omapdss_device_disconnect(NULL, pipe->output);
141 omapdss_device_put(pipe->output);
145 memset(&priv->channels, 0, sizeof(priv->channels));
150 static int omap_connect_pipelines(struct drm_device *ddev)
152 struct omap_drm_private *priv = ddev->dev_private;
153 struct omap_dss_device *output = NULL;
156 for_each_dss_output(output) {
157 r = omapdss_device_connect(priv->dss, NULL, output);
158 if (r == -EPROBE_DEFER) {
159 omapdss_device_put(output);
162 dev_warn(output->dev, "could not connect output %s\n",
165 struct omap_drm_pipeline *pipe;
167 pipe = &priv->pipes[priv->num_pipes++];
168 pipe->output = omapdss_device_get(output);
170 if (priv->num_pipes == ARRAY_SIZE(priv->pipes)) {
171 /* To balance the 'for_each_dss_output' loop */
172 omapdss_device_put(output);
181 static int omap_compare_pipelines(const void *a, const void *b)
183 const struct omap_drm_pipeline *pipe1 = a;
184 const struct omap_drm_pipeline *pipe2 = b;
186 if (pipe1->alias_id > pipe2->alias_id)
188 else if (pipe1->alias_id < pipe2->alias_id)
193 static int omap_modeset_init_properties(struct drm_device *dev)
195 struct omap_drm_private *priv = dev->dev_private;
196 unsigned int num_planes = dispc_get_num_ovls(priv->dispc);
198 priv->zorder_prop = drm_property_create_range(dev, 0, "zorder", 0,
200 if (!priv->zorder_prop)
206 static int omap_display_id(struct omap_dss_device *output)
208 struct device_node *node = NULL;
210 if (output->bridge) {
211 struct drm_bridge *bridge = output->bridge;
213 while (drm_bridge_get_next_bridge(bridge))
214 bridge = drm_bridge_get_next_bridge(bridge);
216 node = bridge->of_node;
219 return node ? of_alias_get_id(node, "display") : -ENODEV;
222 static int omap_modeset_init(struct drm_device *dev)
224 struct omap_drm_private *priv = dev->dev_private;
225 int num_ovls = dispc_get_num_ovls(priv->dispc);
226 int num_mgrs = dispc_get_num_mgrs(priv->dispc);
231 if (!omapdss_stack_is_ready())
232 return -EPROBE_DEFER;
234 drm_mode_config_init(dev);
236 ret = omap_modeset_init_properties(dev);
241 * This function creates exactly one connector, encoder, crtc,
242 * and primary plane per each connected dss-device. Each
243 * connector->encoder->crtc chain is expected to be separate
244 * and each crtc is connect to a single dss-channel. If the
245 * configuration does not match the expectations or exceeds
246 * the available resources, the configuration is rejected.
248 ret = omap_connect_pipelines(dev);
252 if (priv->num_pipes > num_mgrs || priv->num_pipes > num_ovls) {
253 dev_err(dev->dev, "%s(): Too many connected displays\n",
258 /* Create all planes first. They can all be put to any CRTC. */
259 plane_crtc_mask = (1 << priv->num_pipes) - 1;
261 for (i = 0; i < num_ovls; i++) {
262 enum drm_plane_type type = i < priv->num_pipes
263 ? DRM_PLANE_TYPE_PRIMARY
264 : DRM_PLANE_TYPE_OVERLAY;
265 struct drm_plane *plane;
267 if (WARN_ON(priv->num_planes >= ARRAY_SIZE(priv->planes)))
270 plane = omap_plane_init(dev, i, type, plane_crtc_mask);
272 return PTR_ERR(plane);
274 priv->planes[priv->num_planes++] = plane;
278 * Create the encoders, attach the bridges and get the pipeline alias
281 for (i = 0; i < priv->num_pipes; i++) {
282 struct omap_drm_pipeline *pipe = &priv->pipes[i];
285 pipe->encoder = omap_encoder_init(dev, pipe->output);
289 if (pipe->output->bridge) {
290 ret = drm_bridge_attach(pipe->encoder,
291 pipe->output->bridge, NULL,
292 DRM_BRIDGE_ATTACH_NO_CONNECTOR);
295 "unable to attach bridge %pOF\n",
296 pipe->output->bridge->of_node);
301 id = omap_display_id(pipe->output);
302 pipe->alias_id = id >= 0 ? id : i;
305 /* Sort the pipelines by DT aliases. */
306 sort(priv->pipes, priv->num_pipes, sizeof(priv->pipes[0]),
307 omap_compare_pipelines, NULL);
310 * Populate the pipeline lookup table by DISPC channel. Only one display
311 * is allowed per channel.
313 for (i = 0; i < priv->num_pipes; ++i) {
314 struct omap_drm_pipeline *pipe = &priv->pipes[i];
315 enum omap_channel channel = pipe->output->dispc_channel;
317 if (WARN_ON(priv->channels[channel] != NULL))
320 priv->channels[channel] = pipe;
323 /* Create the connectors and CRTCs. */
324 for (i = 0; i < priv->num_pipes; i++) {
325 struct omap_drm_pipeline *pipe = &priv->pipes[i];
326 struct drm_encoder *encoder = pipe->encoder;
327 struct drm_crtc *crtc;
329 pipe->connector = drm_bridge_connector_init(dev, encoder);
330 if (IS_ERR(pipe->connector)) {
332 "unable to create bridge connector for %s\n",
334 return PTR_ERR(pipe->connector);
337 drm_connector_attach_encoder(pipe->connector, encoder);
339 crtc = omap_crtc_init(dev, pipe, priv->planes[i]);
341 return PTR_ERR(crtc);
343 encoder->possible_crtcs = 1 << i;
347 DBG("registered %u planes, %u crtcs/encoders/connectors\n",
348 priv->num_planes, priv->num_pipes);
350 dev->mode_config.min_width = 8;
351 dev->mode_config.min_height = 2;
354 * Note: these values are used for multiple independent things:
355 * connector mode filtering, buffer sizes, crtc sizes...
356 * Use big enough values here to cover all use cases, and do more
357 * specific checking in the respective code paths.
359 dev->mode_config.max_width = 8192;
360 dev->mode_config.max_height = 8192;
362 /* We want the zpos to be normalized */
363 dev->mode_config.normalize_zpos = true;
365 dev->mode_config.funcs = &omap_mode_config_funcs;
366 dev->mode_config.helper_private = &omap_mode_config_helper_funcs;
368 drm_mode_config_reset(dev);
370 omap_drm_irq_install(dev);
375 static void omap_modeset_fini(struct drm_device *ddev)
377 omap_drm_irq_uninstall(ddev);
379 drm_mode_config_cleanup(ddev);
383 * Enable the HPD in external components if supported
385 static void omap_modeset_enable_external_hpd(struct drm_device *ddev)
387 struct omap_drm_private *priv = ddev->dev_private;
390 for (i = 0; i < priv->num_pipes; i++) {
391 struct drm_connector *connector = priv->pipes[i].connector;
396 if (priv->pipes[i].output->bridge)
397 drm_bridge_connector_enable_hpd(connector);
402 * Disable the HPD in external components if supported
404 static void omap_modeset_disable_external_hpd(struct drm_device *ddev)
406 struct omap_drm_private *priv = ddev->dev_private;
409 for (i = 0; i < priv->num_pipes; i++) {
410 struct drm_connector *connector = priv->pipes[i].connector;
415 if (priv->pipes[i].output->bridge)
416 drm_bridge_connector_disable_hpd(connector);
425 static int ioctl_get_param(struct drm_device *dev, void *data,
426 struct drm_file *file_priv)
428 struct omap_drm_private *priv = dev->dev_private;
429 struct drm_omap_param *args = data;
431 DBG("%p: param=%llu", dev, args->param);
433 switch (args->param) {
434 case OMAP_PARAM_CHIPSET_ID:
435 args->value = priv->omaprev;
438 DBG("unknown parameter %lld", args->param);
445 #define OMAP_BO_USER_MASK 0x00ffffff /* flags settable by userspace */
447 static int ioctl_gem_new(struct drm_device *dev, void *data,
448 struct drm_file *file_priv)
450 struct drm_omap_gem_new *args = data;
451 u32 flags = args->flags & OMAP_BO_USER_MASK;
453 VERB("%p:%p: size=0x%08x, flags=%08x", dev, file_priv,
454 args->size.bytes, flags);
456 return omap_gem_new_handle(dev, file_priv, args->size, flags,
460 static int ioctl_gem_info(struct drm_device *dev, void *data,
461 struct drm_file *file_priv)
463 struct drm_omap_gem_info *args = data;
464 struct drm_gem_object *obj;
467 VERB("%p:%p: handle=%d", dev, file_priv, args->handle);
469 obj = drm_gem_object_lookup(file_priv, args->handle);
473 args->size = omap_gem_mmap_size(obj);
474 args->offset = omap_gem_mmap_offset(obj);
476 drm_gem_object_put(obj);
481 static const struct drm_ioctl_desc ioctls[DRM_COMMAND_END - DRM_COMMAND_BASE] = {
482 DRM_IOCTL_DEF_DRV(OMAP_GET_PARAM, ioctl_get_param,
484 DRM_IOCTL_DEF_DRV(OMAP_SET_PARAM, drm_invalid_op,
485 DRM_AUTH | DRM_MASTER | DRM_ROOT_ONLY),
486 DRM_IOCTL_DEF_DRV(OMAP_GEM_NEW, ioctl_gem_new,
488 /* Deprecated, to be removed. */
489 DRM_IOCTL_DEF_DRV(OMAP_GEM_CPU_PREP, drm_noop,
491 /* Deprecated, to be removed. */
492 DRM_IOCTL_DEF_DRV(OMAP_GEM_CPU_FINI, drm_noop,
494 DRM_IOCTL_DEF_DRV(OMAP_GEM_INFO, ioctl_gem_info,
502 static int dev_open(struct drm_device *dev, struct drm_file *file)
504 file->driver_priv = NULL;
506 DBG("open: dev=%p, file=%p", dev, file);
511 static const struct file_operations omapdriver_fops = {
512 .owner = THIS_MODULE,
514 .unlocked_ioctl = drm_ioctl,
515 .compat_ioctl = drm_compat_ioctl,
516 .release = drm_release,
517 .mmap = omap_gem_mmap,
520 .llseek = noop_llseek,
523 static const struct drm_driver omap_drm_driver = {
524 .driver_features = DRIVER_MODESET | DRIVER_GEM |
525 DRIVER_ATOMIC | DRIVER_RENDER,
527 .lastclose = drm_fb_helper_lastclose,
528 #ifdef CONFIG_DEBUG_FS
529 .debugfs_init = omap_debugfs_init,
531 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
532 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
533 .gem_prime_import = omap_gem_prime_import,
534 .dumb_create = omap_gem_dumb_create,
535 .dumb_map_offset = omap_gem_dumb_map_offset,
537 .num_ioctls = DRM_OMAP_NUM_IOCTLS,
538 .fops = &omapdriver_fops,
542 .major = DRIVER_MAJOR,
543 .minor = DRIVER_MINOR,
544 .patchlevel = DRIVER_PATCHLEVEL,
547 static const struct soc_device_attribute omapdrm_soc_devices[] = {
548 { .family = "OMAP3", .data = (void *)0x3430 },
549 { .family = "OMAP4", .data = (void *)0x4430 },
550 { .family = "OMAP5", .data = (void *)0x5430 },
551 { .family = "DRA7", .data = (void *)0x0752 },
555 static int omapdrm_init(struct omap_drm_private *priv, struct device *dev)
557 const struct soc_device_attribute *soc;
558 struct dss_pdata *pdata = dev->platform_data;
559 struct drm_device *ddev;
562 DBG("%s", dev_name(dev));
564 /* Allocate and initialize the DRM device. */
565 ddev = drm_dev_alloc(&omap_drm_driver, dev);
567 return PTR_ERR(ddev);
570 ddev->dev_private = priv;
573 priv->dss = pdata->dss;
574 priv->dispc = dispc_get_dispc(priv->dss);
576 priv->dss->mgr_ops_priv = priv;
578 soc = soc_device_match(omapdrm_soc_devices);
579 priv->omaprev = soc ? (unsigned int)soc->data : 0;
580 priv->wq = alloc_ordered_workqueue("omapdrm", 0);
582 mutex_init(&priv->list_lock);
583 INIT_LIST_HEAD(&priv->obj_list);
585 /* Get memory bandwidth limits */
586 priv->max_bandwidth = dispc_get_memory_bandwidth_limit(priv->dispc);
590 ret = omap_modeset_init(ddev);
592 dev_err(priv->dev, "omap_modeset_init failed: ret=%d\n", ret);
596 /* Initialize vblank handling, start with all CRTCs disabled. */
597 ret = drm_vblank_init(ddev, priv->num_pipes);
599 dev_err(priv->dev, "could not init vblank\n");
600 goto err_cleanup_modeset;
603 omap_fbdev_init(ddev);
605 drm_kms_helper_poll_init(ddev);
606 omap_modeset_enable_external_hpd(ddev);
609 * Register the DRM device with the core and the connectors with
612 ret = drm_dev_register(ddev, 0);
614 goto err_cleanup_helpers;
619 omap_modeset_disable_external_hpd(ddev);
620 drm_kms_helper_poll_fini(ddev);
622 omap_fbdev_fini(ddev);
624 omap_modeset_fini(ddev);
626 omap_gem_deinit(ddev);
627 destroy_workqueue(priv->wq);
628 omap_disconnect_pipelines(ddev);
633 static void omapdrm_cleanup(struct omap_drm_private *priv)
635 struct drm_device *ddev = priv->ddev;
639 drm_dev_unregister(ddev);
641 omap_modeset_disable_external_hpd(ddev);
642 drm_kms_helper_poll_fini(ddev);
644 omap_fbdev_fini(ddev);
646 drm_atomic_helper_shutdown(ddev);
648 omap_modeset_fini(ddev);
649 omap_gem_deinit(ddev);
651 destroy_workqueue(priv->wq);
653 omap_disconnect_pipelines(ddev);
658 static int pdev_probe(struct platform_device *pdev)
660 struct omap_drm_private *priv;
663 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
665 dev_err(&pdev->dev, "Failed to set the DMA mask\n");
669 /* Allocate and initialize the driver private structure. */
670 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
674 platform_set_drvdata(pdev, priv);
676 ret = omapdrm_init(priv, &pdev->dev);
683 static int pdev_remove(struct platform_device *pdev)
685 struct omap_drm_private *priv = platform_get_drvdata(pdev);
687 omapdrm_cleanup(priv);
693 #ifdef CONFIG_PM_SLEEP
694 static int omap_drm_suspend(struct device *dev)
696 struct omap_drm_private *priv = dev_get_drvdata(dev);
697 struct drm_device *drm_dev = priv->ddev;
699 return drm_mode_config_helper_suspend(drm_dev);
702 static int omap_drm_resume(struct device *dev)
704 struct omap_drm_private *priv = dev_get_drvdata(dev);
705 struct drm_device *drm_dev = priv->ddev;
707 drm_mode_config_helper_resume(drm_dev);
709 return omap_gem_resume(drm_dev);
713 static SIMPLE_DEV_PM_OPS(omapdrm_pm_ops, omap_drm_suspend, omap_drm_resume);
715 static struct platform_driver pdev = {
718 .pm = &omapdrm_pm_ops,
721 .remove = pdev_remove,
724 static struct platform_driver * const drivers[] = {
729 static int __init omap_drm_init(void)
739 r = platform_register_drivers(drivers, ARRAY_SIZE(drivers));
748 static void __exit omap_drm_fini(void)
752 platform_unregister_drivers(drivers, ARRAY_SIZE(drivers));
757 module_init(omap_drm_init);
758 module_exit(omap_drm_fini);
762 MODULE_DESCRIPTION("OMAP DRM Display Driver");
763 MODULE_ALIAS("platform:" DRIVER_NAME);
764 MODULE_LICENSE("GPL v2");