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>
10 #include <linux/sort.h>
11 #include <linux/sys_soc.h>
13 #include <drm/drm_atomic.h>
14 #include <drm/drm_atomic_helper.h>
15 #include <drm/drm_bridge.h>
16 #include <drm/drm_bridge_connector.h>
17 #include <drm/drm_drv.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"
27 #include "omap_fbdev.h"
29 #define DRIVER_NAME MODULE_NAME
30 #define DRIVER_DESC "OMAP DRM"
31 #define DRIVER_DATE "20110917"
32 #define DRIVER_MAJOR 1
33 #define DRIVER_MINOR 0
34 #define DRIVER_PATCHLEVEL 0
40 /* Notes about mapping DSS and DRM entities:
42 * encoder: manager.. with some extension to allow one primary CRTC
43 * and zero or more video CRTC's to be mapped to one encoder?
44 * connector: dssdev.. manager can be attached/detached from different
48 static void omap_atomic_wait_for_completion(struct drm_device *dev,
49 struct drm_atomic_state *old_state)
51 struct drm_crtc_state *new_crtc_state;
52 struct drm_crtc *crtc;
56 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
57 if (!new_crtc_state->active)
60 ret = omap_crtc_wait_pending(crtc);
64 "atomic complete timeout (pipe %u)!\n", i);
68 static void omap_atomic_commit_tail(struct drm_atomic_state *old_state)
70 struct drm_device *dev = old_state->dev;
71 struct omap_drm_private *priv = dev->dev_private;
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);
95 drm_atomic_helper_commit_hw_done(old_state);
98 * OMAP3 DSS seems to have issues with the work-around above,
99 * resulting in endless sync losts if a crtc is enabled without
100 * a plane. For now, skip the WA for OMAP3.
102 drm_atomic_helper_commit_planes(dev, old_state, 0);
104 drm_atomic_helper_commit_modeset_enables(dev, old_state);
106 drm_atomic_helper_commit_hw_done(old_state);
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 int drm_atomic_state_normalized_zpos_cmp(const void *a, const void *b)
122 const struct drm_plane_state *sa = *(struct drm_plane_state **)a;
123 const struct drm_plane_state *sb = *(struct drm_plane_state **)b;
125 if (sa->normalized_zpos != sb->normalized_zpos)
126 return sa->normalized_zpos - sb->normalized_zpos;
128 return sa->plane->base.id - sb->plane->base.id;
132 * This replaces the drm_atomic_normalize_zpos to handle the dual overlay case.
134 * Since both halves need to be 'appear' side by side the zpos is
135 * recalculated when dealing with dual overlay cases so that the other
136 * planes zpos is consistent.
138 static int omap_atomic_update_normalize_zpos(struct drm_device *dev,
139 struct drm_atomic_state *state)
141 struct drm_crtc *crtc;
142 struct drm_crtc_state *old_state, *new_state;
143 struct drm_plane *plane;
145 int total_planes = dev->mode_config.num_total_plane;
146 struct drm_plane_state **states;
149 states = kmalloc_array(total_planes, sizeof(*states), GFP_KERNEL);
153 for_each_oldnew_crtc_in_state(state, crtc, old_state, new_state, c) {
154 if (old_state->plane_mask == new_state->plane_mask &&
155 !new_state->zpos_changed)
158 /* Reset plane increment and index value for every crtc */
162 * Normalization process might create new states for planes
163 * which normalized_zpos has to be recalculated.
165 drm_for_each_plane_mask(plane, dev, new_state->plane_mask) {
166 struct drm_plane_state *plane_state =
167 drm_atomic_get_plane_state(new_state->state,
169 if (IS_ERR(plane_state)) {
170 ret = PTR_ERR(plane_state);
173 states[n++] = plane_state;
176 sort(states, n, sizeof(*states),
177 drm_atomic_state_normalized_zpos_cmp, NULL);
179 for (i = 0, inc = 0; i < n; i++) {
180 plane = states[i]->plane;
182 states[i]->normalized_zpos = i + inc;
183 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] updated normalized zpos value %d\n",
184 plane->base.id, plane->name,
185 states[i]->normalized_zpos);
187 if (is_omap_plane_dual_overlay(states[i]))
190 new_state->zpos_changed = true;
198 static int omap_atomic_check(struct drm_device *dev,
199 struct drm_atomic_state *state)
203 ret = drm_atomic_helper_check(dev, state);
207 if (dev->mode_config.normalize_zpos) {
208 ret = omap_atomic_update_normalize_zpos(dev, state);
216 static const struct drm_mode_config_helper_funcs omap_mode_config_helper_funcs = {
217 .atomic_commit_tail = omap_atomic_commit_tail,
220 static const struct drm_mode_config_funcs omap_mode_config_funcs = {
221 .fb_create = omap_framebuffer_create,
222 .atomic_check = omap_atomic_check,
223 .atomic_commit = drm_atomic_helper_commit,
226 /* Global/shared object state funcs */
229 * This is a helper that returns the private state currently in operation.
230 * Note that this would return the "old_state" if called in the atomic check
231 * path, and the "new_state" after the atomic swap has been done.
233 struct omap_global_state *
234 omap_get_existing_global_state(struct omap_drm_private *priv)
236 return to_omap_global_state(priv->glob_obj.state);
240 * This acquires the modeset lock set aside for global state, creates
241 * a new duplicated private object state.
243 struct omap_global_state *__must_check
244 omap_get_global_state(struct drm_atomic_state *s)
246 struct omap_drm_private *priv = s->dev->dev_private;
247 struct drm_private_state *priv_state;
249 priv_state = drm_atomic_get_private_obj_state(s, &priv->glob_obj);
250 if (IS_ERR(priv_state))
251 return ERR_CAST(priv_state);
253 return to_omap_global_state(priv_state);
256 static struct drm_private_state *
257 omap_global_duplicate_state(struct drm_private_obj *obj)
259 struct omap_global_state *state;
261 state = kmemdup(obj->state, sizeof(*state), GFP_KERNEL);
265 __drm_atomic_helper_private_obj_duplicate_state(obj, &state->base);
270 static void omap_global_destroy_state(struct drm_private_obj *obj,
271 struct drm_private_state *state)
273 struct omap_global_state *omap_state = to_omap_global_state(state);
278 static const struct drm_private_state_funcs omap_global_state_funcs = {
279 .atomic_duplicate_state = omap_global_duplicate_state,
280 .atomic_destroy_state = omap_global_destroy_state,
283 static int omap_global_obj_init(struct drm_device *dev)
285 struct omap_drm_private *priv = dev->dev_private;
286 struct omap_global_state *state;
288 state = kzalloc(sizeof(*state), GFP_KERNEL);
292 drm_atomic_private_obj_init(dev, &priv->glob_obj, &state->base,
293 &omap_global_state_funcs);
297 static void omap_global_obj_fini(struct omap_drm_private *priv)
299 drm_atomic_private_obj_fini(&priv->glob_obj);
302 static void omap_disconnect_pipelines(struct drm_device *ddev)
304 struct omap_drm_private *priv = ddev->dev_private;
307 for (i = 0; i < priv->num_pipes; i++) {
308 struct omap_drm_pipeline *pipe = &priv->pipes[i];
310 omapdss_device_disconnect(NULL, pipe->output);
312 omapdss_device_put(pipe->output);
316 memset(&priv->channels, 0, sizeof(priv->channels));
321 static int omap_connect_pipelines(struct drm_device *ddev)
323 struct omap_drm_private *priv = ddev->dev_private;
324 struct omap_dss_device *output = NULL;
327 for_each_dss_output(output) {
328 r = omapdss_device_connect(priv->dss, NULL, output);
329 if (r == -EPROBE_DEFER) {
330 omapdss_device_put(output);
333 dev_warn(output->dev, "could not connect output %s\n",
336 struct omap_drm_pipeline *pipe;
338 pipe = &priv->pipes[priv->num_pipes++];
339 pipe->output = omapdss_device_get(output);
341 if (priv->num_pipes == ARRAY_SIZE(priv->pipes)) {
342 /* To balance the 'for_each_dss_output' loop */
343 omapdss_device_put(output);
352 static int omap_compare_pipelines(const void *a, const void *b)
354 const struct omap_drm_pipeline *pipe1 = a;
355 const struct omap_drm_pipeline *pipe2 = b;
357 if (pipe1->alias_id > pipe2->alias_id)
359 else if (pipe1->alias_id < pipe2->alias_id)
364 static int omap_modeset_init_properties(struct drm_device *dev)
366 struct omap_drm_private *priv = dev->dev_private;
367 unsigned int num_planes = dispc_get_num_ovls(priv->dispc);
369 priv->zorder_prop = drm_property_create_range(dev, 0, "zorder", 0,
371 if (!priv->zorder_prop)
377 static int omap_display_id(struct omap_dss_device *output)
379 struct device_node *node = NULL;
381 if (output->bridge) {
382 struct drm_bridge *bridge = output->bridge;
384 while (drm_bridge_get_next_bridge(bridge))
385 bridge = drm_bridge_get_next_bridge(bridge);
387 node = bridge->of_node;
390 return node ? of_alias_get_id(node, "display") : -ENODEV;
393 static int omap_modeset_init(struct drm_device *dev)
395 struct omap_drm_private *priv = dev->dev_private;
396 int num_ovls = dispc_get_num_ovls(priv->dispc);
397 int num_mgrs = dispc_get_num_mgrs(priv->dispc);
402 if (!omapdss_stack_is_ready())
403 return -EPROBE_DEFER;
405 ret = omap_modeset_init_properties(dev);
410 * This function creates exactly one connector, encoder, crtc,
411 * and primary plane per each connected dss-device. Each
412 * connector->encoder->crtc chain is expected to be separate
413 * and each crtc is connect to a single dss-channel. If the
414 * configuration does not match the expectations or exceeds
415 * the available resources, the configuration is rejected.
417 ret = omap_connect_pipelines(dev);
421 if (priv->num_pipes > num_mgrs || priv->num_pipes > num_ovls) {
422 dev_err(dev->dev, "%s(): Too many connected displays\n",
427 /* Create all planes first. They can all be put to any CRTC. */
428 plane_crtc_mask = (1 << priv->num_pipes) - 1;
430 for (i = 0; i < num_ovls; i++) {
431 enum drm_plane_type type = i < priv->num_pipes
432 ? DRM_PLANE_TYPE_PRIMARY
433 : DRM_PLANE_TYPE_OVERLAY;
434 struct drm_plane *plane;
436 if (WARN_ON(priv->num_planes >= ARRAY_SIZE(priv->planes)))
439 plane = omap_plane_init(dev, i, type, plane_crtc_mask);
441 return PTR_ERR(plane);
443 priv->planes[priv->num_planes++] = plane;
447 * Create the encoders, attach the bridges and get the pipeline alias
450 for (i = 0; i < priv->num_pipes; i++) {
451 struct omap_drm_pipeline *pipe = &priv->pipes[i];
454 pipe->encoder = omap_encoder_init(dev, pipe->output);
458 if (pipe->output->bridge) {
459 ret = drm_bridge_attach(pipe->encoder,
460 pipe->output->bridge, NULL,
461 DRM_BRIDGE_ATTACH_NO_CONNECTOR);
466 id = omap_display_id(pipe->output);
467 pipe->alias_id = id >= 0 ? id : i;
470 /* Sort the pipelines by DT aliases. */
471 sort(priv->pipes, priv->num_pipes, sizeof(priv->pipes[0]),
472 omap_compare_pipelines, NULL);
475 * Populate the pipeline lookup table by DISPC channel. Only one display
476 * is allowed per channel.
478 for (i = 0; i < priv->num_pipes; ++i) {
479 struct omap_drm_pipeline *pipe = &priv->pipes[i];
480 enum omap_channel channel = pipe->output->dispc_channel;
482 if (WARN_ON(priv->channels[channel] != NULL))
485 priv->channels[channel] = pipe;
488 /* Create the connectors and CRTCs. */
489 for (i = 0; i < priv->num_pipes; i++) {
490 struct omap_drm_pipeline *pipe = &priv->pipes[i];
491 struct drm_encoder *encoder = pipe->encoder;
492 struct drm_crtc *crtc;
494 pipe->connector = drm_bridge_connector_init(dev, encoder);
495 if (IS_ERR(pipe->connector)) {
497 "unable to create bridge connector for %s\n",
499 return PTR_ERR(pipe->connector);
502 drm_connector_attach_encoder(pipe->connector, encoder);
504 crtc = omap_crtc_init(dev, pipe, priv->planes[i]);
506 return PTR_ERR(crtc);
508 encoder->possible_crtcs = 1 << i;
512 DBG("registered %u planes, %u crtcs/encoders/connectors\n",
513 priv->num_planes, priv->num_pipes);
515 dev->mode_config.min_width = 8;
516 dev->mode_config.min_height = 2;
519 * Note: these values are used for multiple independent things:
520 * connector mode filtering, buffer sizes, crtc sizes...
521 * Use big enough values here to cover all use cases, and do more
522 * specific checking in the respective code paths.
524 dev->mode_config.max_width = 8192;
525 dev->mode_config.max_height = 8192;
527 /* We want the zpos to be normalized */
528 dev->mode_config.normalize_zpos = true;
530 dev->mode_config.funcs = &omap_mode_config_funcs;
531 dev->mode_config.helper_private = &omap_mode_config_helper_funcs;
533 drm_mode_config_reset(dev);
535 omap_drm_irq_install(dev);
540 static void omap_modeset_fini(struct drm_device *ddev)
542 omap_drm_irq_uninstall(ddev);
544 drm_mode_config_cleanup(ddev);
552 static int ioctl_get_param(struct drm_device *dev, void *data,
553 struct drm_file *file_priv)
555 struct omap_drm_private *priv = dev->dev_private;
556 struct drm_omap_param *args = data;
558 DBG("%p: param=%llu", dev, args->param);
560 switch (args->param) {
561 case OMAP_PARAM_CHIPSET_ID:
562 args->value = priv->omaprev;
565 DBG("unknown parameter %lld", args->param);
572 #define OMAP_BO_USER_MASK 0x00ffffff /* flags settable by userspace */
574 static int ioctl_gem_new(struct drm_device *dev, void *data,
575 struct drm_file *file_priv)
577 struct drm_omap_gem_new *args = data;
578 u32 flags = args->flags & OMAP_BO_USER_MASK;
580 VERB("%p:%p: size=0x%08x, flags=%08x", dev, file_priv,
581 args->size.bytes, flags);
583 return omap_gem_new_handle(dev, file_priv, args->size, flags,
587 static int ioctl_gem_info(struct drm_device *dev, void *data,
588 struct drm_file *file_priv)
590 struct drm_omap_gem_info *args = data;
591 struct drm_gem_object *obj;
594 VERB("%p:%p: handle=%d", dev, file_priv, args->handle);
596 obj = drm_gem_object_lookup(file_priv, args->handle);
600 args->size = omap_gem_mmap_size(obj);
601 args->offset = omap_gem_mmap_offset(obj);
603 drm_gem_object_put(obj);
608 static const struct drm_ioctl_desc ioctls[DRM_COMMAND_END - DRM_COMMAND_BASE] = {
609 DRM_IOCTL_DEF_DRV(OMAP_GET_PARAM, ioctl_get_param,
611 DRM_IOCTL_DEF_DRV(OMAP_SET_PARAM, drm_invalid_op,
612 DRM_AUTH | DRM_MASTER | DRM_ROOT_ONLY),
613 DRM_IOCTL_DEF_DRV(OMAP_GEM_NEW, ioctl_gem_new,
615 /* Deprecated, to be removed. */
616 DRM_IOCTL_DEF_DRV(OMAP_GEM_CPU_PREP, drm_noop,
618 /* Deprecated, to be removed. */
619 DRM_IOCTL_DEF_DRV(OMAP_GEM_CPU_FINI, drm_noop,
621 DRM_IOCTL_DEF_DRV(OMAP_GEM_INFO, ioctl_gem_info,
629 static int dev_open(struct drm_device *dev, struct drm_file *file)
631 file->driver_priv = NULL;
633 DBG("open: dev=%p, file=%p", dev, file);
638 DEFINE_DRM_GEM_FOPS(omapdriver_fops);
640 static const struct drm_driver omap_drm_driver = {
641 .driver_features = DRIVER_MODESET | DRIVER_GEM |
642 DRIVER_ATOMIC | DRIVER_RENDER,
644 #ifdef CONFIG_DEBUG_FS
645 .debugfs_init = omap_debugfs_init,
647 .gem_prime_import = omap_gem_prime_import,
648 .dumb_create = omap_gem_dumb_create,
649 .dumb_map_offset = omap_gem_dumb_map_offset,
651 .num_ioctls = DRM_OMAP_NUM_IOCTLS,
652 .fops = &omapdriver_fops,
656 .major = DRIVER_MAJOR,
657 .minor = DRIVER_MINOR,
658 .patchlevel = DRIVER_PATCHLEVEL,
661 static const struct soc_device_attribute omapdrm_soc_devices[] = {
662 { .family = "OMAP3", .data = (void *)0x3430 },
663 { .family = "OMAP4", .data = (void *)0x4430 },
664 { .family = "OMAP5", .data = (void *)0x5430 },
665 { .family = "DRA7", .data = (void *)0x0752 },
669 static int omapdrm_init(struct omap_drm_private *priv, struct device *dev)
671 const struct soc_device_attribute *soc;
672 struct dss_pdata *pdata = dev->platform_data;
673 struct drm_device *ddev;
676 DBG("%s", dev_name(dev));
678 if (drm_firmware_drivers_only())
681 /* Allocate and initialize the DRM device. */
682 ddev = drm_dev_alloc(&omap_drm_driver, dev);
684 return PTR_ERR(ddev);
687 ddev->dev_private = priv;
690 priv->dss = pdata->dss;
691 priv->dispc = dispc_get_dispc(priv->dss);
693 priv->dss->mgr_ops_priv = priv;
695 soc = soc_device_match(omapdrm_soc_devices);
696 priv->omaprev = soc ? (uintptr_t)soc->data : 0;
697 priv->wq = alloc_ordered_workqueue("omapdrm", 0);
699 mutex_init(&priv->list_lock);
700 INIT_LIST_HEAD(&priv->obj_list);
702 /* Get memory bandwidth limits */
703 priv->max_bandwidth = dispc_get_memory_bandwidth_limit(priv->dispc);
707 drm_mode_config_init(ddev);
709 ret = omap_global_obj_init(ddev);
713 ret = omap_hwoverlays_init(priv);
715 goto err_free_priv_obj;
717 ret = omap_modeset_init(ddev);
719 dev_err(priv->dev, "omap_modeset_init failed: ret=%d\n", ret);
720 goto err_free_overlays;
723 /* Initialize vblank handling, start with all CRTCs disabled. */
724 ret = drm_vblank_init(ddev, priv->num_pipes);
726 dev_err(priv->dev, "could not init vblank\n");
727 goto err_cleanup_modeset;
730 drm_kms_helper_poll_init(ddev);
733 * Register the DRM device with the core and the connectors with
736 ret = drm_dev_register(ddev, 0);
738 goto err_cleanup_helpers;
740 omap_fbdev_setup(ddev);
745 drm_kms_helper_poll_fini(ddev);
747 omap_modeset_fini(ddev);
749 omap_hwoverlays_destroy(priv);
751 omap_global_obj_fini(priv);
753 drm_mode_config_cleanup(ddev);
754 omap_gem_deinit(ddev);
755 destroy_workqueue(priv->wq);
756 omap_disconnect_pipelines(ddev);
761 static void omapdrm_cleanup(struct omap_drm_private *priv)
763 struct drm_device *ddev = priv->ddev;
767 drm_dev_unregister(ddev);
769 drm_kms_helper_poll_fini(ddev);
771 drm_atomic_helper_shutdown(ddev);
773 omap_modeset_fini(ddev);
774 omap_hwoverlays_destroy(priv);
775 omap_global_obj_fini(priv);
776 drm_mode_config_cleanup(ddev);
777 omap_gem_deinit(ddev);
779 destroy_workqueue(priv->wq);
781 omap_disconnect_pipelines(ddev);
786 static int pdev_probe(struct platform_device *pdev)
788 struct omap_drm_private *priv;
791 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
793 dev_err(&pdev->dev, "Failed to set the DMA mask\n");
797 /* Allocate and initialize the driver private structure. */
798 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
802 platform_set_drvdata(pdev, priv);
804 ret = omapdrm_init(priv, &pdev->dev);
811 static void pdev_remove(struct platform_device *pdev)
813 struct omap_drm_private *priv = platform_get_drvdata(pdev);
815 omapdrm_cleanup(priv);
819 static void pdev_shutdown(struct platform_device *pdev)
821 struct omap_drm_private *priv = platform_get_drvdata(pdev);
823 drm_atomic_helper_shutdown(priv->ddev);
826 #ifdef CONFIG_PM_SLEEP
827 static int omap_drm_suspend(struct device *dev)
829 struct omap_drm_private *priv = dev_get_drvdata(dev);
830 struct drm_device *drm_dev = priv->ddev;
832 return drm_mode_config_helper_suspend(drm_dev);
835 static int omap_drm_resume(struct device *dev)
837 struct omap_drm_private *priv = dev_get_drvdata(dev);
838 struct drm_device *drm_dev = priv->ddev;
840 drm_mode_config_helper_resume(drm_dev);
842 return omap_gem_resume(drm_dev);
846 static SIMPLE_DEV_PM_OPS(omapdrm_pm_ops, omap_drm_suspend, omap_drm_resume);
848 static struct platform_driver pdev = {
851 .pm = &omapdrm_pm_ops,
854 .remove_new = pdev_remove,
855 .shutdown = pdev_shutdown,
858 static struct platform_driver * const drivers[] = {
863 static int __init omap_drm_init(void)
873 r = platform_register_drivers(drivers, ARRAY_SIZE(drivers));
882 static void __exit omap_drm_fini(void)
886 platform_unregister_drivers(drivers, ARRAY_SIZE(drivers));
891 module_init(omap_drm_init);
892 module_exit(omap_drm_fini);
896 MODULE_DESCRIPTION("OMAP DRM Display Driver");
897 MODULE_ALIAS("platform:" DRIVER_NAME);
898 MODULE_LICENSE("GPL v2");