drivers/gpu/drm/mxsfb/mxsfb_drv.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Copyright (C) 2016 Marek Vasut <marex@denx.de>
   4  *
   5  * This code is based on drivers/video/fbdev/mxsfb.c :
   6  * Copyright (C) 2010 Juergen Beisert, Pengutronix
   7  * Copyright (C) 2008-2009 Freescale Semiconductor, Inc. All Rights Reserved.
   8  * Copyright (C) 2008 Embedded Alley Solutions, Inc All Rights Reserved.
   9  */
  10
  11 #include <linux/clk.h>
  12 #include <linux/dma-mapping.h>
  13 #include <linux/io.h>
  14 #include <linux/mod_devicetable.h>
  15 #include <linux/module.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/property.h>
  18 #include <linux/pm_runtime.h>
  19
  20 #include <drm/drm_atomic_helper.h>
  21 #include <drm/drm_bridge.h>
  22 #include <drm/drm_client_setup.h>
  23 #include <drm/drm_connector.h>
  24 #include <drm/drm_drv.h>
  25 #include <drm/drm_fbdev_dma.h>
  26 #include <drm/drm_fourcc.h>
  27 #include <drm/drm_gem_dma_helper.h>
  28 #include <drm/drm_gem_framebuffer_helper.h>
  29 #include <drm/drm_mode_config.h>
  30 #include <drm/drm_module.h>
  31 #include <drm/drm_of.h>
  32 #include <drm/drm_probe_helper.h>
  33 #include <drm/drm_vblank.h>
  34
  35 #include "mxsfb_drv.h"
  36 #include "mxsfb_regs.h"
  37
  38 enum mxsfb_devtype {
  39         MXSFB_V3,
  40         MXSFB_V4,
  41         /*
  42          * Starting at i.MX6 the hardware version register is gone, use the
  43          * i.MX family number as the version.
  44          */
  45         MXSFB_V6,
  46 };
  47
  48 static const struct mxsfb_devdata mxsfb_devdata[] = {
  49         [MXSFB_V3] = {
  50                 .transfer_count = LCDC_V3_TRANSFER_COUNT,
  51                 .cur_buf        = LCDC_V3_CUR_BUF,
  52                 .next_buf       = LCDC_V3_NEXT_BUF,
  53                 .hs_wdth_mask   = 0xff,
  54                 .hs_wdth_shift  = 24,
  55                 .has_overlay    = false,
  56                 .has_ctrl2      = false,
  57                 .has_crc32      = false,
  58         },
  59         [MXSFB_V4] = {
  60                 .transfer_count = LCDC_V4_TRANSFER_COUNT,
  61                 .cur_buf        = LCDC_V4_CUR_BUF,
  62                 .next_buf       = LCDC_V4_NEXT_BUF,
  63                 .hs_wdth_mask   = 0x3fff,
  64                 .hs_wdth_shift  = 18,
  65                 .has_overlay    = false,
  66                 .has_ctrl2      = true,
  67                 .has_crc32      = true,
  68         },
  69         [MXSFB_V6] = {
  70                 .transfer_count = LCDC_V4_TRANSFER_COUNT,
  71                 .cur_buf        = LCDC_V4_CUR_BUF,
  72                 .next_buf       = LCDC_V4_NEXT_BUF,
  73                 .hs_wdth_mask   = 0x3fff,
  74                 .hs_wdth_shift  = 18,
  75                 .has_overlay    = true,
  76                 .has_ctrl2      = true,
  77                 .has_crc32      = true,
  78         },
  79 };
  80
  81 void mxsfb_enable_axi_clk(struct mxsfb_drm_private *mxsfb)
  82 {
  83         clk_prepare_enable(mxsfb->clk_axi);
  84 }
  85
  86 void mxsfb_disable_axi_clk(struct mxsfb_drm_private *mxsfb)
  87 {
  88         clk_disable_unprepare(mxsfb->clk_axi);
  89 }
  90
  91 static struct drm_framebuffer *
  92 mxsfb_fb_create(struct drm_device *dev, struct drm_file *file_priv,
  93                 const struct drm_mode_fb_cmd2 *mode_cmd)
  94 {
  95         const struct drm_format_info *info;
  96
  97         info = drm_get_format_info(dev, mode_cmd);
  98         if (!info)
  99                 return ERR_PTR(-EINVAL);
 100
 101         if (mode_cmd->width * info->cpp[0] != mode_cmd->pitches[0]) {
 102                 dev_dbg(dev->dev, "Invalid pitch: fb width must match pitch\n");
 103                 return ERR_PTR(-EINVAL);
 104         }
 105
 106         return drm_gem_fb_create(dev, file_priv, mode_cmd);
 107 }
 108
 109 static const struct drm_mode_config_funcs mxsfb_mode_config_funcs = {
 110         .fb_create              = mxsfb_fb_create,
 111         .atomic_check           = drm_atomic_helper_check,
 112         .atomic_commit          = drm_atomic_helper_commit,
 113 };
 114
 115 static const struct drm_mode_config_helper_funcs mxsfb_mode_config_helpers = {
 116         .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
 117 };
 118
 119 static int mxsfb_attach_bridge(struct mxsfb_drm_private *mxsfb)
 120 {
 121         struct drm_device *drm = mxsfb->drm;
 122         struct drm_connector_list_iter iter;
 123         struct drm_panel *panel;
 124         struct drm_bridge *bridge;
 125         int ret;
 126
 127         ret = drm_of_find_panel_or_bridge(drm->dev->of_node, 0, 0, &panel,
 128                                           &bridge);
 129         if (ret)
 130                 return ret;
 131
 132         if (panel) {
 133                 bridge = devm_drm_panel_bridge_add_typed(drm->dev, panel,
 134                                                          DRM_MODE_CONNECTOR_DPI);
 135                 if (IS_ERR(bridge))
 136                         return PTR_ERR(bridge);
 137         }
 138
 139         if (!bridge)
 140                 return -ENODEV;
 141
 142         ret = drm_bridge_attach(&mxsfb->encoder, bridge, NULL, 0);
 143         if (ret)
 144                 return dev_err_probe(drm->dev, ret, "Failed to attach bridge\n");
 145
 146         mxsfb->bridge = bridge;
 147
 148         /*
 149          * Get hold of the connector. This is a bit of a hack, until the bridge
 150          * API gives us bus flags and formats.
 151          */
 152         drm_connector_list_iter_begin(drm, &iter);
 153         mxsfb->connector = drm_connector_list_iter_next(&iter);
 154         drm_connector_list_iter_end(&iter);
 155
 156         return 0;
 157 }
 158
 159 static irqreturn_t mxsfb_irq_handler(int irq, void *data)
 160 {
 161         struct drm_device *drm = data;
 162         struct mxsfb_drm_private *mxsfb = drm->dev_private;
 163         u32 reg, crc;
 164         u64 vbc;
 165
 166         reg = readl(mxsfb->base + LCDC_CTRL1);
 167
 168         if (reg & CTRL1_CUR_FRAME_DONE_IRQ) {
 169                 drm_crtc_handle_vblank(&mxsfb->crtc);
 170                 if (mxsfb->crc_active) {
 171                         crc = readl(mxsfb->base + LCDC_V4_CRC_STAT);
 172                         vbc = drm_crtc_accurate_vblank_count(&mxsfb->crtc);
 173                         drm_crtc_add_crc_entry(&mxsfb->crtc, true, vbc, &crc);
 174                 }
 175         }
 176
 177         writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR);
 178
 179         return IRQ_HANDLED;
 180 }
 181
 182 static void mxsfb_irq_disable(struct drm_device *drm)
 183 {
 184         struct mxsfb_drm_private *mxsfb = drm->dev_private;
 185
 186         mxsfb_enable_axi_clk(mxsfb);
 187
 188         /* Disable and clear VBLANK IRQ */
 189         writel(CTRL1_CUR_FRAME_DONE_IRQ_EN, mxsfb->base + LCDC_CTRL1 + REG_CLR);
 190         writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR);
 191
 192         mxsfb_disable_axi_clk(mxsfb);
 193 }
 194
 195 static int mxsfb_irq_install(struct drm_device *dev, int irq)
 196 {
 197         if (irq == IRQ_NOTCONNECTED)
 198                 return -ENOTCONN;
 199
 200         mxsfb_irq_disable(dev);
 201
 202         return request_irq(irq, mxsfb_irq_handler, 0,  dev->driver->name, dev);
 203 }
 204
 205 static void mxsfb_irq_uninstall(struct drm_device *dev)
 206 {
 207         struct mxsfb_drm_private *mxsfb = dev->dev_private;
 208
 209         mxsfb_irq_disable(dev);
 210         free_irq(mxsfb->irq, dev);
 211 }
 212
 213 static int mxsfb_load(struct drm_device *drm,
 214                       const struct mxsfb_devdata *devdata)
 215 {
 216         struct platform_device *pdev = to_platform_device(drm->dev);
 217         struct mxsfb_drm_private *mxsfb;
 218         struct resource *res;
 219         int ret;
 220
 221         mxsfb = devm_kzalloc(&pdev->dev, sizeof(*mxsfb), GFP_KERNEL);
 222         if (!mxsfb)
 223                 return -ENOMEM;
 224
 225         mxsfb->drm = drm;
 226         drm->dev_private = mxsfb;
 227         mxsfb->devdata = devdata;
 228
 229         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 230         mxsfb->base = devm_ioremap_resource(drm->dev, res);
 231         if (IS_ERR(mxsfb->base))
 232                 return PTR_ERR(mxsfb->base);
 233
 234         mxsfb->clk = devm_clk_get(drm->dev, NULL);
 235         if (IS_ERR(mxsfb->clk))
 236                 return PTR_ERR(mxsfb->clk);
 237
 238         mxsfb->clk_axi = devm_clk_get_optional(drm->dev, "axi");
 239         if (IS_ERR(mxsfb->clk_axi))
 240                 return PTR_ERR(mxsfb->clk_axi);
 241
 242         mxsfb->clk_disp_axi = devm_clk_get(drm->dev, "disp_axi");
 243         if (IS_ERR(mxsfb->clk_disp_axi))
 244                 mxsfb->clk_disp_axi = NULL;
 245
 246         ret = dma_set_mask_and_coherent(drm->dev, DMA_BIT_MASK(32));
 247         if (ret)
 248                 return ret;
 249
 250         pm_runtime_enable(drm->dev);
 251
 252         /* Modeset init */
 253         ret = drmm_mode_config_init(drm);
 254         if (ret) {
 255                 dev_err(drm->dev, "Failed to initialize mode config\n");
 256                 goto err_vblank;
 257         }
 258
 259         ret = mxsfb_kms_init(mxsfb);
 260         if (ret < 0) {
 261                 dev_err(drm->dev, "Failed to initialize KMS pipeline\n");
 262                 goto err_vblank;
 263         }
 264
 265         ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
 266         if (ret < 0) {
 267                 dev_err(drm->dev, "Failed to initialise vblank\n");
 268                 goto err_vblank;
 269         }
 270
 271         /* Start with vertical blanking interrupt reporting disabled. */
 272         drm_crtc_vblank_off(&mxsfb->crtc);
 273
 274         ret = mxsfb_attach_bridge(mxsfb);
 275         if (ret) {
 276                 dev_err_probe(drm->dev, ret, "Cannot connect bridge\n");
 277                 goto err_vblank;
 278         }
 279
 280         drm->mode_config.min_width      = MXSFB_MIN_XRES;
 281         drm->mode_config.min_height     = MXSFB_MIN_YRES;
 282         drm->mode_config.max_width      = MXSFB_MAX_XRES;
 283         drm->mode_config.max_height     = MXSFB_MAX_YRES;
 284         drm->mode_config.funcs          = &mxsfb_mode_config_funcs;
 285         drm->mode_config.helper_private = &mxsfb_mode_config_helpers;
 286
 287         drm_mode_config_reset(drm);
 288
 289         ret = platform_get_irq(pdev, 0);
 290         if (ret < 0)
 291                 goto err_vblank;
 292         mxsfb->irq = ret;
 293
 294         pm_runtime_get_sync(drm->dev);
 295         ret = mxsfb_irq_install(drm, mxsfb->irq);
 296         pm_runtime_put_sync(drm->dev);
 297
 298         if (ret < 0) {
 299                 dev_err(drm->dev, "Failed to install IRQ handler\n");
 300                 goto err_vblank;
 301         }
 302
 303         drm_kms_helper_poll_init(drm);
 304
 305         platform_set_drvdata(pdev, drm);
 306
 307         drm_helper_hpd_irq_event(drm);
 308
 309         return 0;
 310
 311 err_vblank:
 312         pm_runtime_disable(drm->dev);
 313
 314         return ret;
 315 }
 316
 317 static void mxsfb_unload(struct drm_device *drm)
 318 {
 319         drm_kms_helper_poll_fini(drm);
 320
 321         pm_runtime_get_sync(drm->dev);
 322         mxsfb_irq_uninstall(drm);
 323         pm_runtime_put_sync(drm->dev);
 324
 325         drm->dev_private = NULL;
 326
 327         pm_runtime_disable(drm->dev);
 328 }
 329
 330 DEFINE_DRM_GEM_DMA_FOPS(fops);
 331
 332 static const struct drm_driver mxsfb_driver = {
 333         .driver_features        = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
 334         DRM_GEM_DMA_DRIVER_OPS,
 335         DRM_FBDEV_DMA_DRIVER_OPS,
 336         .fops   = &fops,
 337         .name   = "mxsfb-drm",
 338         .desc   = "MXSFB Controller DRM",
 339         .date   = "20160824",
 340         .major  = 1,
 341         .minor  = 0,
 342 };
 343
 344 static const struct of_device_id mxsfb_dt_ids[] = {
 345         { .compatible = "fsl,imx23-lcdif", .data = &mxsfb_devdata[MXSFB_V3], },
 346         { .compatible = "fsl,imx28-lcdif", .data = &mxsfb_devdata[MXSFB_V4], },
 347         { .compatible = "fsl,imx6sx-lcdif", .data = &mxsfb_devdata[MXSFB_V6], },
 348         { /* sentinel */ }
 349 };
 350 MODULE_DEVICE_TABLE(of, mxsfb_dt_ids);
 351
 352 static int mxsfb_probe(struct platform_device *pdev)
 353 {
 354         struct drm_device *drm;
 355         int ret;
 356
 357         drm = drm_dev_alloc(&mxsfb_driver, &pdev->dev);
 358         if (IS_ERR(drm))
 359                 return PTR_ERR(drm);
 360
 361         ret = mxsfb_load(drm, device_get_match_data(&pdev->dev));
 362         if (ret)
 363                 goto err_free;
 364
 365         ret = drm_dev_register(drm, 0);
 366         if (ret)
 367                 goto err_unload;
 368
 369         drm_client_setup(drm, NULL);
 370
 371         return 0;
 372
 373 err_unload:
 374         mxsfb_unload(drm);
 375 err_free:
 376         drm_dev_put(drm);
 377
 378         return ret;
 379 }
 380
 381 static void mxsfb_remove(struct platform_device *pdev)
 382 {
 383         struct drm_device *drm = platform_get_drvdata(pdev);
 384
 385         drm_dev_unregister(drm);
 386         drm_atomic_helper_shutdown(drm);
 387         mxsfb_unload(drm);
 388         drm_dev_put(drm);
 389 }
 390
 391 static void mxsfb_shutdown(struct platform_device *pdev)
 392 {
 393         struct drm_device *drm = platform_get_drvdata(pdev);
 394
 395         drm_atomic_helper_shutdown(drm);
 396 }
 397
 398 #ifdef CONFIG_PM_SLEEP
 399 static int mxsfb_suspend(struct device *dev)
 400 {
 401         struct drm_device *drm = dev_get_drvdata(dev);
 402
 403         return drm_mode_config_helper_suspend(drm);
 404 }
 405
 406 static int mxsfb_resume(struct device *dev)
 407 {
 408         struct drm_device *drm = dev_get_drvdata(dev);
 409
 410         return drm_mode_config_helper_resume(drm);
 411 }
 412 #endif
 413
 414 static const struct dev_pm_ops mxsfb_pm_ops = {
 415         SET_SYSTEM_SLEEP_PM_OPS(mxsfb_suspend, mxsfb_resume)
 416 };
 417
 418 static struct platform_driver mxsfb_platform_driver = {
 419         .probe          = mxsfb_probe,
 420         .remove         = mxsfb_remove,
 421         .shutdown       = mxsfb_shutdown,
 422         .driver = {
 423                 .name           = "mxsfb",
 424                 .of_match_table = mxsfb_dt_ids,
 425                 .pm             = &mxsfb_pm_ops,
 426         },
 427 };
 428
 429 drm_module_platform_driver(mxsfb_platform_driver);
 430
 431 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
 432 MODULE_DESCRIPTION("Freescale MXS DRM/KMS driver");
 433 MODULE_LICENSE("GPL");