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