drivers/gpu/drm/imx/imx-drm-core.c

   1 /*
   2  * Freescale i.MX drm driver
   3  *
   4  * Copyright (C) 2011 Sascha Hauer, Pengutronix
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  */
  16 #include <linux/component.h>
  17 #include <linux/device.h>
  18 #include <linux/fb.h>
  19 #include <linux/module.h>
  20 #include <linux/of_graph.h>
  21 #include <linux/platform_device.h>
  22 #include <drm/drmP.h>
  23 #include <drm/drm_fb_helper.h>
  24 #include <drm/drm_crtc_helper.h>
  25 #include <drm/drm_gem_cma_helper.h>
  26 #include <drm/drm_fb_cma_helper.h>
  27 #include <drm/drm_plane_helper.h>
  28 #include <drm/drm_of.h>
  29
  30 #include "imx-drm.h"
  31
  32 #define MAX_CRTC        4
  33
  34 struct imx_drm_component {
  35         struct device_node *of_node;
  36         struct list_head list;
  37 };
  38
  39 struct imx_drm_device {
  40         struct drm_device                       *drm;
  41         struct imx_drm_crtc                     *crtc[MAX_CRTC];
  42         unsigned int                            pipes;
  43         struct drm_fbdev_cma                    *fbhelper;
  44 };
  45
  46 struct imx_drm_crtc {
  47         struct drm_crtc                         *crtc;
  48         struct imx_drm_crtc_helper_funcs        imx_drm_helper_funcs;
  49 };
  50
  51 #if IS_ENABLED(CONFIG_DRM_FBDEV_EMULATION)
  52 static int legacyfb_depth = 16;
  53 module_param(legacyfb_depth, int, 0444);
  54 #endif
  55
  56 unsigned int imx_drm_crtc_id(struct imx_drm_crtc *crtc)
  57 {
  58         return drm_crtc_index(crtc->crtc);
  59 }
  60 EXPORT_SYMBOL_GPL(imx_drm_crtc_id);
  61
  62 static void imx_drm_driver_lastclose(struct drm_device *drm)
  63 {
  64         struct imx_drm_device *imxdrm = drm->dev_private;
  65
  66         drm_fbdev_cma_restore_mode(imxdrm->fbhelper);
  67 }
  68
  69 static int imx_drm_driver_unload(struct drm_device *drm)
  70 {
  71         struct imx_drm_device *imxdrm = drm->dev_private;
  72
  73         drm_kms_helper_poll_fini(drm);
  74
  75         if (imxdrm->fbhelper)
  76                 drm_fbdev_cma_fini(imxdrm->fbhelper);
  77
  78         component_unbind_all(drm->dev, drm);
  79
  80         drm_vblank_cleanup(drm);
  81         drm_mode_config_cleanup(drm);
  82
  83         platform_set_drvdata(drm->platformdev, NULL);
  84
  85         return 0;
  86 }
  87
  88 static struct imx_drm_crtc *imx_drm_find_crtc(struct drm_crtc *crtc)
  89 {
  90         struct imx_drm_device *imxdrm = crtc->dev->dev_private;
  91         unsigned i;
  92
  93         for (i = 0; i < MAX_CRTC; i++)
  94                 if (imxdrm->crtc[i] && imxdrm->crtc[i]->crtc == crtc)
  95                         return imxdrm->crtc[i];
  96
  97         return NULL;
  98 }
  99
 100 int imx_drm_set_bus_format_pins(struct drm_encoder *encoder, u32 bus_format,
 101                 int hsync_pin, int vsync_pin)
 102 {
 103         struct imx_drm_crtc_helper_funcs *helper;
 104         struct imx_drm_crtc *imx_crtc;
 105
 106         imx_crtc = imx_drm_find_crtc(encoder->crtc);
 107         if (!imx_crtc)
 108                 return -EINVAL;
 109
 110         helper = &imx_crtc->imx_drm_helper_funcs;
 111         if (helper->set_interface_pix_fmt)
 112                 return helper->set_interface_pix_fmt(encoder->crtc,
 113                                         bus_format, hsync_pin, vsync_pin);
 114         return 0;
 115 }
 116 EXPORT_SYMBOL_GPL(imx_drm_set_bus_format_pins);
 117
 118 int imx_drm_set_bus_format(struct drm_encoder *encoder, u32 bus_format)
 119 {
 120         return imx_drm_set_bus_format_pins(encoder, bus_format, 2, 3);
 121 }
 122 EXPORT_SYMBOL_GPL(imx_drm_set_bus_format);
 123
 124 int imx_drm_crtc_vblank_get(struct imx_drm_crtc *imx_drm_crtc)
 125 {
 126         return drm_crtc_vblank_get(imx_drm_crtc->crtc);
 127 }
 128 EXPORT_SYMBOL_GPL(imx_drm_crtc_vblank_get);
 129
 130 void imx_drm_crtc_vblank_put(struct imx_drm_crtc *imx_drm_crtc)
 131 {
 132         drm_crtc_vblank_put(imx_drm_crtc->crtc);
 133 }
 134 EXPORT_SYMBOL_GPL(imx_drm_crtc_vblank_put);
 135
 136 void imx_drm_handle_vblank(struct imx_drm_crtc *imx_drm_crtc)
 137 {
 138         drm_crtc_handle_vblank(imx_drm_crtc->crtc);
 139 }
 140 EXPORT_SYMBOL_GPL(imx_drm_handle_vblank);
 141
 142 static int imx_drm_enable_vblank(struct drm_device *drm, unsigned int pipe)
 143 {
 144         struct imx_drm_device *imxdrm = drm->dev_private;
 145         struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[pipe];
 146         int ret;
 147
 148         if (!imx_drm_crtc)
 149                 return -EINVAL;
 150
 151         if (!imx_drm_crtc->imx_drm_helper_funcs.enable_vblank)
 152                 return -ENOSYS;
 153
 154         ret = imx_drm_crtc->imx_drm_helper_funcs.enable_vblank(
 155                         imx_drm_crtc->crtc);
 156
 157         return ret;
 158 }
 159
 160 static void imx_drm_disable_vblank(struct drm_device *drm, unsigned int pipe)
 161 {
 162         struct imx_drm_device *imxdrm = drm->dev_private;
 163         struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[pipe];
 164
 165         if (!imx_drm_crtc)
 166                 return;
 167
 168         if (!imx_drm_crtc->imx_drm_helper_funcs.disable_vblank)
 169                 return;
 170
 171         imx_drm_crtc->imx_drm_helper_funcs.disable_vblank(imx_drm_crtc->crtc);
 172 }
 173
 174 static void imx_drm_driver_preclose(struct drm_device *drm,
 175                 struct drm_file *file)
 176 {
 177         int i;
 178
 179         if (!file->is_master)
 180                 return;
 181
 182         for (i = 0; i < MAX_CRTC; i++)
 183                 imx_drm_disable_vblank(drm, i);
 184 }
 185
 186 static const struct file_operations imx_drm_driver_fops = {
 187         .owner = THIS_MODULE,
 188         .open = drm_open,
 189         .release = drm_release,
 190         .unlocked_ioctl = drm_ioctl,
 191         .mmap = drm_gem_cma_mmap,
 192         .poll = drm_poll,
 193         .read = drm_read,
 194         .llseek = noop_llseek,
 195 };
 196
 197 void imx_drm_connector_destroy(struct drm_connector *connector)
 198 {
 199         drm_connector_unregister(connector);
 200         drm_connector_cleanup(connector);
 201 }
 202 EXPORT_SYMBOL_GPL(imx_drm_connector_destroy);
 203
 204 void imx_drm_encoder_destroy(struct drm_encoder *encoder)
 205 {
 206         drm_encoder_cleanup(encoder);
 207 }
 208 EXPORT_SYMBOL_GPL(imx_drm_encoder_destroy);
 209
 210 static void imx_drm_output_poll_changed(struct drm_device *drm)
 211 {
 212         struct imx_drm_device *imxdrm = drm->dev_private;
 213
 214         drm_fbdev_cma_hotplug_event(imxdrm->fbhelper);
 215 }
 216
 217 static const struct drm_mode_config_funcs imx_drm_mode_config_funcs = {
 218         .fb_create = drm_fb_cma_create,
 219         .output_poll_changed = imx_drm_output_poll_changed,
 220 };
 221
 222 /*
 223  * Main DRM initialisation. This binds, initialises and registers
 224  * with DRM the subcomponents of the driver.
 225  */
 226 static int imx_drm_driver_load(struct drm_device *drm, unsigned long flags)
 227 {
 228         struct imx_drm_device *imxdrm;
 229         struct drm_connector *connector;
 230         int ret;
 231
 232         imxdrm = devm_kzalloc(drm->dev, sizeof(*imxdrm), GFP_KERNEL);
 233         if (!imxdrm)
 234                 return -ENOMEM;
 235
 236         imxdrm->drm = drm;
 237
 238         drm->dev_private = imxdrm;
 239
 240         /*
 241          * enable drm irq mode.
 242          * - with irq_enabled = true, we can use the vblank feature.
 243          *
 244          * P.S. note that we wouldn't use drm irq handler but
 245          *      just specific driver own one instead because
 246          *      drm framework supports only one irq handler and
 247          *      drivers can well take care of their interrupts
 248          */
 249         drm->irq_enabled = true;
 250
 251         /*
 252          * set max width and height as default value(4096x4096).
 253          * this value would be used to check framebuffer size limitation
 254          * at drm_mode_addfb().
 255          */
 256         drm->mode_config.min_width = 64;
 257         drm->mode_config.min_height = 64;
 258         drm->mode_config.max_width = 4096;
 259         drm->mode_config.max_height = 4096;
 260         drm->mode_config.funcs = &imx_drm_mode_config_funcs;
 261
 262         drm_mode_config_init(drm);
 263
 264         ret = drm_vblank_init(drm, MAX_CRTC);
 265         if (ret)
 266                 goto err_kms;
 267
 268         /*
 269          * with vblank_disable_allowed = true, vblank interrupt will be
 270          * disabled by drm timer once a current process gives up ownership
 271          * of vblank event. (after drm_vblank_put function is called)
 272          */
 273         drm->vblank_disable_allowed = true;
 274
 275         platform_set_drvdata(drm->platformdev, drm);
 276
 277         /* Now try and bind all our sub-components */
 278         ret = component_bind_all(drm->dev, drm);
 279         if (ret)
 280                 goto err_vblank;
 281
 282         /*
 283          * All components are now added, we can publish the connector sysfs
 284          * entries to userspace.  This will generate hotplug events and so
 285          * userspace will expect to be able to access DRM at this point.
 286          */
 287         list_for_each_entry(connector, &drm->mode_config.connector_list, head) {
 288                 ret = drm_connector_register(connector);
 289                 if (ret) {
 290                         dev_err(drm->dev,
 291                                 "[CONNECTOR:%d:%s] drm_connector_register failed: %d\n",
 292                                 connector->base.id,
 293                                 connector->name, ret);
 294                         goto err_unbind;
 295                 }
 296         }
 297
 298         /*
 299          * All components are now initialised, so setup the fb helper.
 300          * The fb helper takes copies of key hardware information, so the
 301          * crtcs/connectors/encoders must not change after this point.
 302          */
 303 #if IS_ENABLED(CONFIG_DRM_FBDEV_EMULATION)
 304         if (legacyfb_depth != 16 && legacyfb_depth != 32) {
 305                 dev_warn(drm->dev, "Invalid legacyfb_depth.  Defaulting to 16bpp\n");
 306                 legacyfb_depth = 16;
 307         }
 308         drm_helper_disable_unused_functions(drm);
 309         imxdrm->fbhelper = drm_fbdev_cma_init(drm, legacyfb_depth,
 310                                 drm->mode_config.num_crtc, MAX_CRTC);
 311         if (IS_ERR(imxdrm->fbhelper)) {
 312                 ret = PTR_ERR(imxdrm->fbhelper);
 313                 imxdrm->fbhelper = NULL;
 314                 goto err_unbind;
 315         }
 316 #endif
 317
 318         drm_kms_helper_poll_init(drm);
 319
 320         return 0;
 321
 322 err_unbind:
 323         component_unbind_all(drm->dev, drm);
 324 err_vblank:
 325         drm_vblank_cleanup(drm);
 326 err_kms:
 327         drm_mode_config_cleanup(drm);
 328
 329         return ret;
 330 }
 331
 332 /*
 333  * imx_drm_add_crtc - add a new crtc
 334  */
 335 int imx_drm_add_crtc(struct drm_device *drm, struct drm_crtc *crtc,
 336                 struct imx_drm_crtc **new_crtc, struct drm_plane *primary_plane,
 337                 const struct imx_drm_crtc_helper_funcs *imx_drm_helper_funcs,
 338                 struct device_node *port)
 339 {
 340         struct imx_drm_device *imxdrm = drm->dev_private;
 341         struct imx_drm_crtc *imx_drm_crtc;
 342         int ret;
 343
 344         /*
 345          * The vblank arrays are dimensioned by MAX_CRTC - we can't
 346          * pass IDs greater than this to those functions.
 347          */
 348         if (imxdrm->pipes >= MAX_CRTC)
 349                 return -EINVAL;
 350
 351         if (imxdrm->drm->open_count)
 352                 return -EBUSY;
 353
 354         imx_drm_crtc = kzalloc(sizeof(*imx_drm_crtc), GFP_KERNEL);
 355         if (!imx_drm_crtc)
 356                 return -ENOMEM;
 357
 358         imx_drm_crtc->imx_drm_helper_funcs = *imx_drm_helper_funcs;
 359         imx_drm_crtc->crtc = crtc;
 360
 361         crtc->port = port;
 362
 363         imxdrm->crtc[imxdrm->pipes++] = imx_drm_crtc;
 364
 365         *new_crtc = imx_drm_crtc;
 366
 367         ret = drm_mode_crtc_set_gamma_size(imx_drm_crtc->crtc, 256);
 368         if (ret)
 369                 goto err_register;
 370
 371         drm_crtc_helper_add(crtc,
 372                         imx_drm_crtc->imx_drm_helper_funcs.crtc_helper_funcs);
 373
 374         drm_crtc_init_with_planes(drm, crtc, primary_plane, NULL,
 375                         imx_drm_crtc->imx_drm_helper_funcs.crtc_funcs, NULL);
 376
 377         return 0;
 378
 379 err_register:
 380         imxdrm->crtc[--imxdrm->pipes] = NULL;
 381         kfree(imx_drm_crtc);
 382         return ret;
 383 }
 384 EXPORT_SYMBOL_GPL(imx_drm_add_crtc);
 385
 386 /*
 387  * imx_drm_remove_crtc - remove a crtc
 388  */
 389 int imx_drm_remove_crtc(struct imx_drm_crtc *imx_drm_crtc)
 390 {
 391         struct imx_drm_device *imxdrm = imx_drm_crtc->crtc->dev->dev_private;
 392         unsigned int pipe = drm_crtc_index(imx_drm_crtc->crtc);
 393
 394         drm_crtc_cleanup(imx_drm_crtc->crtc);
 395
 396         imxdrm->crtc[pipe] = NULL;
 397
 398         kfree(imx_drm_crtc);
 399
 400         return 0;
 401 }
 402 EXPORT_SYMBOL_GPL(imx_drm_remove_crtc);
 403
 404 int imx_drm_encoder_parse_of(struct drm_device *drm,
 405         struct drm_encoder *encoder, struct device_node *np)
 406 {
 407         uint32_t crtc_mask = drm_of_find_possible_crtcs(drm, np);
 408
 409         /*
 410          * If we failed to find the CRTC(s) which this encoder is
 411          * supposed to be connected to, it's because the CRTC has
 412          * not been registered yet.  Defer probing, and hope that
 413          * the required CRTC is added later.
 414          */
 415         if (crtc_mask == 0)
 416                 return -EPROBE_DEFER;
 417
 418         encoder->possible_crtcs = crtc_mask;
 419
 420         /* FIXME: this is the mask of outputs which can clone this output. */
 421         encoder->possible_clones = ~0;
 422
 423         return 0;
 424 }
 425 EXPORT_SYMBOL_GPL(imx_drm_encoder_parse_of);
 426
 427 /*
 428  * @node: device tree node containing encoder input ports
 429  * @encoder: drm_encoder
 430  */
 431 int imx_drm_encoder_get_mux_id(struct device_node *node,
 432                                struct drm_encoder *encoder)
 433 {
 434         struct imx_drm_crtc *imx_crtc = imx_drm_find_crtc(encoder->crtc);
 435         struct device_node *ep;
 436         struct of_endpoint endpoint;
 437         struct device_node *port;
 438         int ret;
 439
 440         if (!node || !imx_crtc)
 441                 return -EINVAL;
 442
 443         for_each_endpoint_of_node(node, ep) {
 444                 port = of_graph_get_remote_port(ep);
 445                 of_node_put(port);
 446                 if (port == imx_crtc->crtc->port) {
 447                         ret = of_graph_parse_endpoint(ep, &endpoint);
 448                         of_node_put(ep);
 449                         return ret ? ret : endpoint.port;
 450                 }
 451         }
 452
 453         return -EINVAL;
 454 }
 455 EXPORT_SYMBOL_GPL(imx_drm_encoder_get_mux_id);
 456
 457 static const struct drm_ioctl_desc imx_drm_ioctls[] = {
 458         /* none so far */
 459 };
 460
 461 static struct drm_driver imx_drm_driver = {
 462         .driver_features        = DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME,
 463         .load                   = imx_drm_driver_load,
 464         .unload                 = imx_drm_driver_unload,
 465         .lastclose              = imx_drm_driver_lastclose,
 466         .preclose               = imx_drm_driver_preclose,
 467         .set_busid              = drm_platform_set_busid,
 468         .gem_free_object        = drm_gem_cma_free_object,
 469         .gem_vm_ops             = &drm_gem_cma_vm_ops,
 470         .dumb_create            = drm_gem_cma_dumb_create,
 471         .dumb_map_offset        = drm_gem_cma_dumb_map_offset,
 472         .dumb_destroy           = drm_gem_dumb_destroy,
 473
 474         .prime_handle_to_fd     = drm_gem_prime_handle_to_fd,
 475         .prime_fd_to_handle     = drm_gem_prime_fd_to_handle,
 476         .gem_prime_import       = drm_gem_prime_import,
 477         .gem_prime_export       = drm_gem_prime_export,
 478         .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
 479         .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
 480         .gem_prime_vmap         = drm_gem_cma_prime_vmap,
 481         .gem_prime_vunmap       = drm_gem_cma_prime_vunmap,
 482         .gem_prime_mmap         = drm_gem_cma_prime_mmap,
 483         .get_vblank_counter     = drm_vblank_no_hw_counter,
 484         .enable_vblank          = imx_drm_enable_vblank,
 485         .disable_vblank         = imx_drm_disable_vblank,
 486         .ioctls                 = imx_drm_ioctls,
 487         .num_ioctls             = ARRAY_SIZE(imx_drm_ioctls),
 488         .fops                   = &imx_drm_driver_fops,
 489         .name                   = "imx-drm",
 490         .desc                   = "i.MX DRM graphics",
 491         .date                   = "20120507",
 492         .major                  = 1,
 493         .minor                  = 0,
 494         .patchlevel             = 0,
 495 };
 496
 497 static int compare_of(struct device *dev, void *data)
 498 {
 499         struct device_node *np = data;
 500
 501         /* Special case for LDB, one device for two channels */
 502         if (of_node_cmp(np->name, "lvds-channel") == 0) {
 503                 np = of_get_parent(np);
 504                 of_node_put(np);
 505         }
 506
 507         return dev->of_node == np;
 508 }
 509
 510 static int imx_drm_bind(struct device *dev)
 511 {
 512         return drm_platform_init(&imx_drm_driver, to_platform_device(dev));
 513 }
 514
 515 static void imx_drm_unbind(struct device *dev)
 516 {
 517         drm_put_dev(dev_get_drvdata(dev));
 518 }
 519
 520 static const struct component_master_ops imx_drm_ops = {
 521         .bind = imx_drm_bind,
 522         .unbind = imx_drm_unbind,
 523 };
 524
 525 static int imx_drm_platform_probe(struct platform_device *pdev)
 526 {
 527         int ret = drm_of_component_probe(&pdev->dev, compare_of, &imx_drm_ops);
 528
 529         if (!ret)
 530                 ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
 531
 532         return ret;
 533 }
 534
 535 static int imx_drm_platform_remove(struct platform_device *pdev)
 536 {
 537         component_master_del(&pdev->dev, &imx_drm_ops);
 538         return 0;
 539 }
 540
 541 #ifdef CONFIG_PM_SLEEP
 542 static int imx_drm_suspend(struct device *dev)
 543 {
 544         struct drm_device *drm_dev = dev_get_drvdata(dev);
 545
 546         /* The drm_dev is NULL before .load hook is called */
 547         if (drm_dev == NULL)
 548                 return 0;
 549
 550         drm_kms_helper_poll_disable(drm_dev);
 551
 552         return 0;
 553 }
 554
 555 static int imx_drm_resume(struct device *dev)
 556 {
 557         struct drm_device *drm_dev = dev_get_drvdata(dev);
 558
 559         if (drm_dev == NULL)
 560                 return 0;
 561
 562         drm_helper_resume_force_mode(drm_dev);
 563         drm_kms_helper_poll_enable(drm_dev);
 564
 565         return 0;
 566 }
 567 #endif
 568
 569 static SIMPLE_DEV_PM_OPS(imx_drm_pm_ops, imx_drm_suspend, imx_drm_resume);
 570
 571 static const struct of_device_id imx_drm_dt_ids[] = {
 572         { .compatible = "fsl,imx-display-subsystem", },
 573         { /* sentinel */ },
 574 };
 575 MODULE_DEVICE_TABLE(of, imx_drm_dt_ids);
 576
 577 static struct platform_driver imx_drm_pdrv = {
 578         .probe          = imx_drm_platform_probe,
 579         .remove         = imx_drm_platform_remove,
 580         .driver         = {
 581                 .name   = "imx-drm",
 582                 .pm     = &imx_drm_pm_ops,
 583                 .of_match_table = imx_drm_dt_ids,
 584         },
 585 };
 586 module_platform_driver(imx_drm_pdrv);
 587
 588 MODULE_AUTHOR("Sascha Hauer <[email protected]>");
 589 MODULE_DESCRIPTION("i.MX drm driver core");
 590 MODULE_LICENSE("GPL");