1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2011 Texas Instruments Incorporated - http://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;
72 priv->dispc_ops->runtime_get(priv->dispc);
74 /* Apply the atomic update. */
75 drm_atomic_helper_commit_modeset_disables(dev, old_state);
77 if (priv->omaprev != 0x3430) {
78 /* With the current dss dispc implementation we have to enable
79 * the new modeset before we can commit planes. The dispc ovl
80 * configuration relies on the video mode configuration been
81 * written into the HW when the ovl configuration is
84 * This approach is not ideal because after a mode change the
85 * plane update is executed only after the first vblank
86 * interrupt. The dispc implementation should be fixed so that
87 * it is able use uncommitted drm state information.
89 drm_atomic_helper_commit_modeset_enables(dev, old_state);
90 omap_atomic_wait_for_completion(dev, old_state);
92 drm_atomic_helper_commit_planes(dev, old_state, 0);
94 drm_atomic_helper_commit_hw_done(old_state);
97 * OMAP3 DSS seems to have issues with the work-around above,
98 * resulting in endless sync losts if a crtc is enabled without
99 * a plane. For now, skip the WA for OMAP3.
101 drm_atomic_helper_commit_planes(dev, old_state, 0);
103 drm_atomic_helper_commit_modeset_enables(dev, old_state);
105 drm_atomic_helper_commit_hw_done(old_state);
109 * Wait for completion of the page flips to ensure that old buffers
110 * can't be touched by the hardware anymore before cleaning up planes.
112 omap_atomic_wait_for_completion(dev, old_state);
114 drm_atomic_helper_cleanup_planes(dev, old_state);
116 priv->dispc_ops->runtime_put(priv->dispc);
119 static const struct drm_mode_config_helper_funcs omap_mode_config_helper_funcs = {
120 .atomic_commit_tail = omap_atomic_commit_tail,
123 static const struct drm_mode_config_funcs omap_mode_config_funcs = {
124 .fb_create = omap_framebuffer_create,
125 .output_poll_changed = drm_fb_helper_output_poll_changed,
126 .atomic_check = drm_atomic_helper_check,
127 .atomic_commit = drm_atomic_helper_commit,
130 static void omap_disconnect_pipelines(struct drm_device *ddev)
132 struct omap_drm_private *priv = ddev->dev_private;
135 for (i = 0; i < priv->num_pipes; i++) {
136 struct omap_drm_pipeline *pipe = &priv->pipes[i];
138 omapdss_device_disconnect(NULL, pipe->output);
140 omapdss_device_put(pipe->output);
144 memset(&priv->channels, 0, sizeof(priv->channels));
149 static int omap_connect_pipelines(struct drm_device *ddev)
151 struct omap_drm_private *priv = ddev->dev_private;
152 struct omap_dss_device *output = NULL;
155 for_each_dss_output(output) {
156 r = omapdss_device_connect(priv->dss, NULL, output);
157 if (r == -EPROBE_DEFER) {
158 omapdss_device_put(output);
161 dev_warn(output->dev, "could not connect output %s\n",
164 struct omap_drm_pipeline *pipe;
166 pipe = &priv->pipes[priv->num_pipes++];
167 pipe->output = omapdss_device_get(output);
169 if (priv->num_pipes == ARRAY_SIZE(priv->pipes)) {
170 /* To balance the 'for_each_dss_output' loop */
171 omapdss_device_put(output);
180 static int omap_compare_pipelines(const void *a, const void *b)
182 const struct omap_drm_pipeline *pipe1 = a;
183 const struct omap_drm_pipeline *pipe2 = b;
185 if (pipe1->alias_id > pipe2->alias_id)
187 else if (pipe1->alias_id < pipe2->alias_id)
192 static int omap_modeset_init_properties(struct drm_device *dev)
194 struct omap_drm_private *priv = dev->dev_private;
195 unsigned int num_planes = priv->dispc_ops->get_num_ovls(priv->dispc);
197 priv->zorder_prop = drm_property_create_range(dev, 0, "zorder", 0,
199 if (!priv->zorder_prop)
205 static int omap_display_id(struct omap_dss_device *output)
207 struct device_node *node = NULL;
210 struct omap_dss_device *display = output;
212 while (display->next)
213 display = display->next;
215 node = display->dev->of_node;
216 } else if (output->bridge) {
217 struct drm_bridge *bridge = output->bridge;
219 while (drm_bridge_get_next_bridge(bridge))
220 bridge = drm_bridge_get_next_bridge(bridge);
222 node = bridge->of_node;
225 return node ? of_alias_get_id(node, "display") : -ENODEV;
228 static int omap_modeset_init(struct drm_device *dev)
230 struct omap_drm_private *priv = dev->dev_private;
231 int num_ovls = priv->dispc_ops->get_num_ovls(priv->dispc);
232 int num_mgrs = priv->dispc_ops->get_num_mgrs(priv->dispc);
237 if (!omapdss_stack_is_ready())
238 return -EPROBE_DEFER;
240 drm_mode_config_init(dev);
242 ret = omap_modeset_init_properties(dev);
247 * This function creates exactly one connector, encoder, crtc,
248 * and primary plane per each connected dss-device. Each
249 * connector->encoder->crtc chain is expected to be separate
250 * and each crtc is connect to a single dss-channel. If the
251 * configuration does not match the expectations or exceeds
252 * the available resources, the configuration is rejected.
254 ret = omap_connect_pipelines(dev);
258 if (priv->num_pipes > num_mgrs || priv->num_pipes > num_ovls) {
259 dev_err(dev->dev, "%s(): Too many connected displays\n",
264 /* Create all planes first. They can all be put to any CRTC. */
265 plane_crtc_mask = (1 << priv->num_pipes) - 1;
267 for (i = 0; i < num_ovls; i++) {
268 enum drm_plane_type type = i < priv->num_pipes
269 ? DRM_PLANE_TYPE_PRIMARY
270 : DRM_PLANE_TYPE_OVERLAY;
271 struct drm_plane *plane;
273 if (WARN_ON(priv->num_planes >= ARRAY_SIZE(priv->planes)))
276 plane = omap_plane_init(dev, i, type, plane_crtc_mask);
278 return PTR_ERR(plane);
280 priv->planes[priv->num_planes++] = plane;
284 * Create the encoders, attach the bridges and get the pipeline alias
287 for (i = 0; i < priv->num_pipes; i++) {
288 struct omap_drm_pipeline *pipe = &priv->pipes[i];
291 pipe->encoder = omap_encoder_init(dev, pipe->output);
295 if (pipe->output->bridge) {
296 ret = drm_bridge_attach(pipe->encoder,
297 pipe->output->bridge, NULL,
298 DRM_BRIDGE_ATTACH_NO_CONNECTOR);
301 "unable to attach bridge %pOF\n",
302 pipe->output->bridge->of_node);
307 id = omap_display_id(pipe->output);
308 pipe->alias_id = id >= 0 ? id : i;
311 /* Sort the pipelines by DT aliases. */
312 sort(priv->pipes, priv->num_pipes, sizeof(priv->pipes[0]),
313 omap_compare_pipelines, NULL);
316 * Populate the pipeline lookup table by DISPC channel. Only one display
317 * is allowed per channel.
319 for (i = 0; i < priv->num_pipes; ++i) {
320 struct omap_drm_pipeline *pipe = &priv->pipes[i];
321 enum omap_channel channel = pipe->output->dispc_channel;
323 if (WARN_ON(priv->channels[channel] != NULL))
326 priv->channels[channel] = pipe;
329 /* Create the connectors and CRTCs. */
330 for (i = 0; i < priv->num_pipes; i++) {
331 struct omap_drm_pipeline *pipe = &priv->pipes[i];
332 struct drm_encoder *encoder = pipe->encoder;
333 struct drm_crtc *crtc;
335 if (pipe->output->next) {
336 pipe->connector = omap_connector_init(dev, pipe->output,
338 if (!pipe->connector)
341 pipe->connector = drm_bridge_connector_init(dev, encoder);
342 if (IS_ERR(pipe->connector)) {
344 "unable to create bridge connector for %s\n",
346 return PTR_ERR(pipe->connector);
350 drm_connector_attach_encoder(pipe->connector, encoder);
352 if (pipe->output->panel) {
353 ret = drm_panel_attach(pipe->output->panel,
359 crtc = omap_crtc_init(dev, pipe, priv->planes[i]);
361 return PTR_ERR(crtc);
363 encoder->possible_crtcs = 1 << i;
367 DBG("registered %u planes, %u crtcs/encoders/connectors\n",
368 priv->num_planes, priv->num_pipes);
370 dev->mode_config.min_width = 8;
371 dev->mode_config.min_height = 2;
374 * Note: these values are used for multiple independent things:
375 * connector mode filtering, buffer sizes, crtc sizes...
376 * Use big enough values here to cover all use cases, and do more
377 * specific checking in the respective code paths.
379 dev->mode_config.max_width = 8192;
380 dev->mode_config.max_height = 8192;
382 /* We want the zpos to be normalized */
383 dev->mode_config.normalize_zpos = true;
385 dev->mode_config.funcs = &omap_mode_config_funcs;
386 dev->mode_config.helper_private = &omap_mode_config_helper_funcs;
388 drm_mode_config_reset(dev);
390 omap_drm_irq_install(dev);
395 static void omap_modeset_fini(struct drm_device *ddev)
397 struct omap_drm_private *priv = ddev->dev_private;
400 omap_drm_irq_uninstall(ddev);
402 for (i = 0; i < priv->num_pipes; i++) {
403 struct omap_drm_pipeline *pipe = &priv->pipes[i];
405 if (pipe->output->panel)
406 drm_panel_detach(pipe->output->panel);
409 drm_mode_config_cleanup(ddev);
413 * Enable the HPD in external components if supported
415 static void omap_modeset_enable_external_hpd(struct drm_device *ddev)
417 struct omap_drm_private *priv = ddev->dev_private;
420 for (i = 0; i < priv->num_pipes; i++) {
421 struct drm_connector *connector = priv->pipes[i].connector;
426 if (priv->pipes[i].output->bridge)
427 drm_bridge_connector_enable_hpd(connector);
432 * Disable the HPD in external components if supported
434 static void omap_modeset_disable_external_hpd(struct drm_device *ddev)
436 struct omap_drm_private *priv = ddev->dev_private;
439 for (i = 0; i < priv->num_pipes; i++) {
440 struct drm_connector *connector = priv->pipes[i].connector;
445 if (priv->pipes[i].output->bridge)
446 drm_bridge_connector_disable_hpd(connector);
455 static int ioctl_get_param(struct drm_device *dev, void *data,
456 struct drm_file *file_priv)
458 struct omap_drm_private *priv = dev->dev_private;
459 struct drm_omap_param *args = data;
461 DBG("%p: param=%llu", dev, args->param);
463 switch (args->param) {
464 case OMAP_PARAM_CHIPSET_ID:
465 args->value = priv->omaprev;
468 DBG("unknown parameter %lld", args->param);
475 #define OMAP_BO_USER_MASK 0x00ffffff /* flags settable by userspace */
477 static int ioctl_gem_new(struct drm_device *dev, void *data,
478 struct drm_file *file_priv)
480 struct drm_omap_gem_new *args = data;
481 u32 flags = args->flags & OMAP_BO_USER_MASK;
483 VERB("%p:%p: size=0x%08x, flags=%08x", dev, file_priv,
484 args->size.bytes, flags);
486 return omap_gem_new_handle(dev, file_priv, args->size, flags,
490 static int ioctl_gem_info(struct drm_device *dev, void *data,
491 struct drm_file *file_priv)
493 struct drm_omap_gem_info *args = data;
494 struct drm_gem_object *obj;
497 VERB("%p:%p: handle=%d", dev, file_priv, args->handle);
499 obj = drm_gem_object_lookup(file_priv, args->handle);
503 args->size = omap_gem_mmap_size(obj);
504 args->offset = omap_gem_mmap_offset(obj);
506 drm_gem_object_put(obj);
511 static const struct drm_ioctl_desc ioctls[DRM_COMMAND_END - DRM_COMMAND_BASE] = {
512 DRM_IOCTL_DEF_DRV(OMAP_GET_PARAM, ioctl_get_param,
514 DRM_IOCTL_DEF_DRV(OMAP_SET_PARAM, drm_invalid_op,
515 DRM_AUTH | DRM_MASTER | DRM_ROOT_ONLY),
516 DRM_IOCTL_DEF_DRV(OMAP_GEM_NEW, ioctl_gem_new,
518 /* Deprecated, to be removed. */
519 DRM_IOCTL_DEF_DRV(OMAP_GEM_CPU_PREP, drm_noop,
521 /* Deprecated, to be removed. */
522 DRM_IOCTL_DEF_DRV(OMAP_GEM_CPU_FINI, drm_noop,
524 DRM_IOCTL_DEF_DRV(OMAP_GEM_INFO, ioctl_gem_info,
532 static int dev_open(struct drm_device *dev, struct drm_file *file)
534 file->driver_priv = NULL;
536 DBG("open: dev=%p, file=%p", dev, file);
541 static const struct vm_operations_struct omap_gem_vm_ops = {
542 .fault = omap_gem_fault,
543 .open = drm_gem_vm_open,
544 .close = drm_gem_vm_close,
547 static const struct file_operations omapdriver_fops = {
548 .owner = THIS_MODULE,
550 .unlocked_ioctl = drm_ioctl,
551 .compat_ioctl = drm_compat_ioctl,
552 .release = drm_release,
553 .mmap = omap_gem_mmap,
556 .llseek = noop_llseek,
559 static struct drm_driver omap_drm_driver = {
560 .driver_features = DRIVER_MODESET | DRIVER_GEM |
561 DRIVER_ATOMIC | DRIVER_RENDER,
563 .lastclose = drm_fb_helper_lastclose,
564 #ifdef CONFIG_DEBUG_FS
565 .debugfs_init = omap_debugfs_init,
567 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
568 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
569 .gem_prime_export = omap_gem_prime_export,
570 .gem_prime_import = omap_gem_prime_import,
571 .gem_free_object_unlocked = omap_gem_free_object,
572 .gem_vm_ops = &omap_gem_vm_ops,
573 .dumb_create = omap_gem_dumb_create,
574 .dumb_map_offset = omap_gem_dumb_map_offset,
576 .num_ioctls = DRM_OMAP_NUM_IOCTLS,
577 .fops = &omapdriver_fops,
581 .major = DRIVER_MAJOR,
582 .minor = DRIVER_MINOR,
583 .patchlevel = DRIVER_PATCHLEVEL,
586 static const struct soc_device_attribute omapdrm_soc_devices[] = {
587 { .family = "OMAP3", .data = (void *)0x3430 },
588 { .family = "OMAP4", .data = (void *)0x4430 },
589 { .family = "OMAP5", .data = (void *)0x5430 },
590 { .family = "DRA7", .data = (void *)0x0752 },
594 static int omapdrm_init(struct omap_drm_private *priv, struct device *dev)
596 const struct soc_device_attribute *soc;
597 struct drm_device *ddev;
600 DBG("%s", dev_name(dev));
602 /* Allocate and initialize the DRM device. */
603 ddev = drm_dev_alloc(&omap_drm_driver, dev);
605 return PTR_ERR(ddev);
608 ddev->dev_private = priv;
611 priv->dss = omapdss_get_dss();
612 priv->dispc = dispc_get_dispc(priv->dss);
613 priv->dispc_ops = dispc_get_ops(priv->dss);
615 omap_crtc_pre_init(priv);
617 soc = soc_device_match(omapdrm_soc_devices);
618 priv->omaprev = soc ? (unsigned int)soc->data : 0;
619 priv->wq = alloc_ordered_workqueue("omapdrm", 0);
621 mutex_init(&priv->list_lock);
622 INIT_LIST_HEAD(&priv->obj_list);
624 /* Get memory bandwidth limits */
625 if (priv->dispc_ops->get_memory_bandwidth_limit)
626 priv->max_bandwidth =
627 priv->dispc_ops->get_memory_bandwidth_limit(priv->dispc);
631 ret = omap_modeset_init(ddev);
633 dev_err(priv->dev, "omap_modeset_init failed: ret=%d\n", ret);
637 /* Initialize vblank handling, start with all CRTCs disabled. */
638 ret = drm_vblank_init(ddev, priv->num_pipes);
640 dev_err(priv->dev, "could not init vblank\n");
641 goto err_cleanup_modeset;
644 omap_fbdev_init(ddev);
646 drm_kms_helper_poll_init(ddev);
647 omap_modeset_enable_external_hpd(ddev);
650 * Register the DRM device with the core and the connectors with
653 ret = drm_dev_register(ddev, 0);
655 goto err_cleanup_helpers;
660 omap_modeset_disable_external_hpd(ddev);
661 drm_kms_helper_poll_fini(ddev);
663 omap_fbdev_fini(ddev);
665 omap_modeset_fini(ddev);
667 omap_gem_deinit(ddev);
668 destroy_workqueue(priv->wq);
669 omap_disconnect_pipelines(ddev);
670 omap_crtc_pre_uninit(priv);
675 static void omapdrm_cleanup(struct omap_drm_private *priv)
677 struct drm_device *ddev = priv->ddev;
681 drm_dev_unregister(ddev);
683 omap_modeset_disable_external_hpd(ddev);
684 drm_kms_helper_poll_fini(ddev);
686 omap_fbdev_fini(ddev);
688 drm_atomic_helper_shutdown(ddev);
690 omap_modeset_fini(ddev);
691 omap_gem_deinit(ddev);
693 destroy_workqueue(priv->wq);
695 omap_disconnect_pipelines(ddev);
696 omap_crtc_pre_uninit(priv);
701 static int pdev_probe(struct platform_device *pdev)
703 struct omap_drm_private *priv;
706 if (omapdss_is_initialized() == false)
707 return -EPROBE_DEFER;
709 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
711 dev_err(&pdev->dev, "Failed to set the DMA mask\n");
715 /* Allocate and initialize the driver private structure. */
716 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
720 platform_set_drvdata(pdev, priv);
722 ret = omapdrm_init(priv, &pdev->dev);
729 static int pdev_remove(struct platform_device *pdev)
731 struct omap_drm_private *priv = platform_get_drvdata(pdev);
733 omapdrm_cleanup(priv);
739 #ifdef CONFIG_PM_SLEEP
740 static int omap_drm_suspend(struct device *dev)
742 struct omap_drm_private *priv = dev_get_drvdata(dev);
743 struct drm_device *drm_dev = priv->ddev;
745 return drm_mode_config_helper_suspend(drm_dev);
748 static int omap_drm_resume(struct device *dev)
750 struct omap_drm_private *priv = dev_get_drvdata(dev);
751 struct drm_device *drm_dev = priv->ddev;
753 drm_mode_config_helper_resume(drm_dev);
755 return omap_gem_resume(drm_dev);
759 static SIMPLE_DEV_PM_OPS(omapdrm_pm_ops, omap_drm_suspend, omap_drm_resume);
761 static struct platform_driver pdev = {
764 .pm = &omapdrm_pm_ops,
767 .remove = pdev_remove,
770 static struct platform_driver * const drivers[] = {
775 static int __init omap_drm_init(void)
779 return platform_register_drivers(drivers, ARRAY_SIZE(drivers));
782 static void __exit omap_drm_fini(void)
786 platform_unregister_drivers(drivers, ARRAY_SIZE(drivers));
789 /* need late_initcall() so we load after dss_driver's are loaded */
790 late_initcall(omap_drm_init);
791 module_exit(omap_drm_fini);
794 MODULE_DESCRIPTION("OMAP DRM Display Driver");
795 MODULE_ALIAS("platform:" DRIVER_NAME);
796 MODULE_LICENSE("GPL v2");