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_mode_fb_cmd2 *mode_cmd) 95 { 96 const struct drm_format_info *info; 97 98 info = drm_get_format_info(dev, mode_cmd); 99 if (!info) 100 return ERR_PTR(-EINVAL); 101 102 if (mode_cmd->width * info->cpp[0] != mode_cmd->pitches[0]) { 103 dev_dbg(dev->dev, "Invalid pitch: fb width must match pitch\n"); 104 return ERR_PTR(-EINVAL); 105 } 106 107 return drm_gem_fb_create(dev, file_priv, mode_cmd); 108 } 109 110 static const struct drm_mode_config_funcs mxsfb_mode_config_funcs = { 111 .fb_create = mxsfb_fb_create, 112 .atomic_check = drm_atomic_helper_check, 113 .atomic_commit = drm_atomic_helper_commit, 114 }; 115 116 static const struct drm_mode_config_helper_funcs mxsfb_mode_config_helpers = { 117 .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm, 118 }; 119 120 static int mxsfb_attach_bridge(struct mxsfb_drm_private *mxsfb) 121 { 122 struct drm_device *drm = mxsfb->drm; 123 struct drm_connector_list_iter iter; 124 struct drm_panel *panel; 125 struct drm_bridge *bridge; 126 int ret; 127 128 ret = drm_of_find_panel_or_bridge(drm->dev->of_node, 0, 0, &panel, 129 &bridge); 130 if (ret) 131 return ret; 132 133 if (panel) { 134 bridge = devm_drm_panel_bridge_add_typed(drm->dev, panel, 135 DRM_MODE_CONNECTOR_DPI); 136 if (IS_ERR(bridge)) 137 return PTR_ERR(bridge); 138 } 139 140 if (!bridge) 141 return -ENODEV; 142 143 ret = drm_bridge_attach(&mxsfb->encoder, bridge, NULL, 0); 144 if (ret) 145 return dev_err_probe(drm->dev, ret, "Failed to attach bridge\n"); 146 147 mxsfb->bridge = bridge; 148 149 /* 150 * Get hold of the connector. This is a bit of a hack, until the bridge 151 * API gives us bus flags and formats. 152 */ 153 drm_connector_list_iter_begin(drm, &iter); 154 mxsfb->connector = drm_connector_list_iter_next(&iter); 155 drm_connector_list_iter_end(&iter); 156 157 return 0; 158 } 159 160 static irqreturn_t mxsfb_irq_handler(int irq, void *data) 161 { 162 struct drm_device *drm = data; 163 struct mxsfb_drm_private *mxsfb = drm->dev_private; 164 u32 reg, crc; 165 u64 vbc; 166 167 reg = readl(mxsfb->base + LCDC_CTRL1); 168 169 if (reg & CTRL1_CUR_FRAME_DONE_IRQ) { 170 drm_crtc_handle_vblank(&mxsfb->crtc); 171 if (mxsfb->crc_active) { 172 crc = readl(mxsfb->base + LCDC_V4_CRC_STAT); 173 vbc = drm_crtc_accurate_vblank_count(&mxsfb->crtc); 174 drm_crtc_add_crc_entry(&mxsfb->crtc, true, vbc, &crc); 175 } 176 } 177 178 writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR); 179 180 return IRQ_HANDLED; 181 } 182 183 static void mxsfb_irq_disable(struct drm_device *drm) 184 { 185 struct mxsfb_drm_private *mxsfb = drm->dev_private; 186 187 mxsfb_enable_axi_clk(mxsfb); 188 189 /* Disable and clear VBLANK IRQ */ 190 writel(CTRL1_CUR_FRAME_DONE_IRQ_EN, mxsfb->base + LCDC_CTRL1 + REG_CLR); 191 writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR); 192 193 mxsfb_disable_axi_clk(mxsfb); 194 } 195 196 static int mxsfb_irq_install(struct drm_device *dev, int irq) 197 { 198 if (irq == IRQ_NOTCONNECTED) 199 return -ENOTCONN; 200 201 mxsfb_irq_disable(dev); 202 203 return request_irq(irq, mxsfb_irq_handler, 0, dev->driver->name, dev); 204 } 205 206 static void mxsfb_irq_uninstall(struct drm_device *dev) 207 { 208 struct mxsfb_drm_private *mxsfb = dev->dev_private; 209 210 mxsfb_irq_disable(dev); 211 free_irq(mxsfb->irq, dev); 212 } 213 214 static int mxsfb_load(struct drm_device *drm, 215 const struct mxsfb_devdata *devdata) 216 { 217 struct platform_device *pdev = to_platform_device(drm->dev); 218 struct mxsfb_drm_private *mxsfb; 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 mxsfb->base = devm_platform_ioremap_resource(pdev, 0); 230 if (IS_ERR(mxsfb->base)) 231 return PTR_ERR(mxsfb->base); 232 233 mxsfb->clk = devm_clk_get(drm->dev, NULL); 234 if (IS_ERR(mxsfb->clk)) 235 return PTR_ERR(mxsfb->clk); 236 237 mxsfb->clk_axi = devm_clk_get_optional(drm->dev, "axi"); 238 if (IS_ERR(mxsfb->clk_axi)) 239 return PTR_ERR(mxsfb->clk_axi); 240 241 mxsfb->clk_disp_axi = devm_clk_get(drm->dev, "disp_axi"); 242 if (IS_ERR(mxsfb->clk_disp_axi)) 243 mxsfb->clk_disp_axi = NULL; 244 245 ret = dma_set_mask_and_coherent(drm->dev, DMA_BIT_MASK(32)); 246 if (ret) 247 return ret; 248 249 pm_runtime_enable(drm->dev); 250 251 /* Modeset init */ 252 ret = drmm_mode_config_init(drm); 253 if (ret) { 254 dev_err(drm->dev, "Failed to initialize mode config\n"); 255 goto err_vblank; 256 } 257 258 ret = mxsfb_kms_init(mxsfb); 259 if (ret < 0) { 260 dev_err(drm->dev, "Failed to initialize KMS pipeline\n"); 261 goto err_vblank; 262 } 263 264 ret = drm_vblank_init(drm, drm->mode_config.num_crtc); 265 if (ret < 0) { 266 dev_err(drm->dev, "Failed to initialise vblank\n"); 267 goto err_vblank; 268 } 269 270 /* Start with vertical blanking interrupt reporting disabled. */ 271 drm_crtc_vblank_off(&mxsfb->crtc); 272 273 ret = mxsfb_attach_bridge(mxsfb); 274 if (ret) { 275 dev_err_probe(drm->dev, ret, "Cannot connect bridge\n"); 276 goto err_vblank; 277 } 278 279 drm->mode_config.min_width = MXSFB_MIN_XRES; 280 drm->mode_config.min_height = MXSFB_MIN_YRES; 281 drm->mode_config.max_width = MXSFB_MAX_XRES; 282 drm->mode_config.max_height = MXSFB_MAX_YRES; 283 drm->mode_config.funcs = &mxsfb_mode_config_funcs; 284 drm->mode_config.helper_private = &mxsfb_mode_config_helpers; 285 286 drm_mode_config_reset(drm); 287 288 ret = platform_get_irq(pdev, 0); 289 if (ret < 0) 290 goto err_vblank; 291 mxsfb->irq = ret; 292 293 pm_runtime_get_sync(drm->dev); 294 ret = mxsfb_irq_install(drm, mxsfb->irq); 295 pm_runtime_put_sync(drm->dev); 296 297 if (ret < 0) { 298 dev_err(drm->dev, "Failed to install IRQ handler\n"); 299 goto err_vblank; 300 } 301 302 drm_kms_helper_poll_init(drm); 303 304 platform_set_drvdata(pdev, drm); 305 306 drm_helper_hpd_irq_event(drm); 307 308 return 0; 309 310 err_vblank: 311 pm_runtime_disable(drm->dev); 312 313 return ret; 314 } 315 316 static void mxsfb_unload(struct drm_device *drm) 317 { 318 drm_kms_helper_poll_fini(drm); 319 320 pm_runtime_get_sync(drm->dev); 321 mxsfb_irq_uninstall(drm); 322 pm_runtime_put_sync(drm->dev); 323 324 drm->dev_private = NULL; 325 326 pm_runtime_disable(drm->dev); 327 } 328 329 DEFINE_DRM_GEM_DMA_FOPS(fops); 330 331 static const struct drm_driver mxsfb_driver = { 332 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC, 333 DRM_GEM_DMA_DRIVER_OPS, 334 DRM_FBDEV_DMA_DRIVER_OPS, 335 .fops = &fops, 336 .name = "mxsfb-drm", 337 .desc = "MXSFB Controller DRM", 338 .major = 1, 339 .minor = 0, 340 }; 341 342 static const struct of_device_id mxsfb_dt_ids[] = { 343 { .compatible = "fsl,imx23-lcdif", .data = &mxsfb_devdata[MXSFB_V3], }, 344 { .compatible = "fsl,imx28-lcdif", .data = &mxsfb_devdata[MXSFB_V4], }, 345 { .compatible = "fsl,imx6sx-lcdif", .data = &mxsfb_devdata[MXSFB_V6], }, 346 { /* sentinel */ } 347 }; 348 MODULE_DEVICE_TABLE(of, mxsfb_dt_ids); 349 350 static int mxsfb_probe(struct platform_device *pdev) 351 { 352 struct drm_device *drm; 353 int ret; 354 355 drm = drm_dev_alloc(&mxsfb_driver, &pdev->dev); 356 if (IS_ERR(drm)) 357 return PTR_ERR(drm); 358 359 ret = mxsfb_load(drm, device_get_match_data(&pdev->dev)); 360 if (ret) 361 goto err_free; 362 363 /* 364 * Remove early framebuffers (ie. simplefb). The framebuffer can be 365 * located anywhere in RAM 366 */ 367 ret = aperture_remove_all_conflicting_devices(mxsfb_driver.name); 368 if (ret) 369 return dev_err_probe(&pdev->dev, ret, 370 "can't kick out existing framebuffers\n"); 371 372 ret = drm_dev_register(drm, 0); 373 if (ret) 374 goto err_unload; 375 376 drm_client_setup(drm, NULL); 377 378 return 0; 379 380 err_unload: 381 mxsfb_unload(drm); 382 err_free: 383 drm_dev_put(drm); 384 385 return ret; 386 } 387 388 static void mxsfb_remove(struct platform_device *pdev) 389 { 390 struct drm_device *drm = platform_get_drvdata(pdev); 391 392 drm_dev_unregister(drm); 393 drm_atomic_helper_shutdown(drm); 394 mxsfb_unload(drm); 395 drm_dev_put(drm); 396 } 397 398 static void mxsfb_shutdown(struct platform_device *pdev) 399 { 400 struct drm_device *drm = platform_get_drvdata(pdev); 401 402 drm_atomic_helper_shutdown(drm); 403 } 404 405 #ifdef CONFIG_PM_SLEEP 406 static int mxsfb_suspend(struct device *dev) 407 { 408 struct drm_device *drm = dev_get_drvdata(dev); 409 410 return drm_mode_config_helper_suspend(drm); 411 } 412 413 static int mxsfb_resume(struct device *dev) 414 { 415 struct drm_device *drm = dev_get_drvdata(dev); 416 417 return drm_mode_config_helper_resume(drm); 418 } 419 #endif 420 421 static const struct dev_pm_ops mxsfb_pm_ops = { 422 SET_SYSTEM_SLEEP_PM_OPS(mxsfb_suspend, mxsfb_resume) 423 }; 424 425 static struct platform_driver mxsfb_platform_driver = { 426 .probe = mxsfb_probe, 427 .remove = mxsfb_remove, 428 .shutdown = mxsfb_shutdown, 429 .driver = { 430 .name = "mxsfb", 431 .of_match_table = mxsfb_dt_ids, 432 .pm = &mxsfb_pm_ops, 433 }, 434 }; 435 436 drm_module_platform_driver(mxsfb_platform_driver); 437 438 MODULE_AUTHOR("Marek Vasut <marex@denx.de>"); 439 MODULE_DESCRIPTION("Freescale MXS DRM/KMS driver"); 440 MODULE_LICENSE("GPL"); 441