1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright © 2018-2020 Intel Corporation
7 #include <linux/module.h>
8 #include <linux/of_graph.h>
9 #include <linux/of_platform.h>
10 #include <linux/of_reserved_mem.h>
11 #include <linux/mfd/syscon.h>
12 #include <linux/platform_device.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/regmap.h>
16 #include <drm/drm_atomic_helper.h>
17 #include <drm/drm_drv.h>
18 #include <drm/drm_fbdev_dma.h>
19 #include <drm/drm_gem_dma_helper.h>
20 #include <drm/drm_gem_framebuffer_helper.h>
21 #include <drm/drm_module.h>
22 #include <drm/drm_probe_helper.h>
23 #include <drm/drm_vblank.h>
29 static int kmb_display_clk_enable(struct kmb_drm_private *kmb)
33 ret = clk_prepare_enable(kmb->kmb_clk.clk_lcd);
35 drm_err(&kmb->drm, "Failed to enable LCD clock: %d\n", ret);
38 DRM_INFO("SUCCESS : enabled LCD clocks\n");
42 static int kmb_initialize_clocks(struct kmb_drm_private *kmb, struct device *dev)
45 struct regmap *msscam;
47 kmb->kmb_clk.clk_lcd = devm_clk_get(dev, "clk_lcd");
48 if (IS_ERR(kmb->kmb_clk.clk_lcd)) {
49 drm_err(&kmb->drm, "clk_get() failed clk_lcd\n");
50 return PTR_ERR(kmb->kmb_clk.clk_lcd);
53 kmb->kmb_clk.clk_pll0 = devm_clk_get(dev, "clk_pll0");
54 if (IS_ERR(kmb->kmb_clk.clk_pll0)) {
55 drm_err(&kmb->drm, "clk_get() failed clk_pll0 ");
56 return PTR_ERR(kmb->kmb_clk.clk_pll0);
58 kmb->sys_clk_mhz = clk_get_rate(kmb->kmb_clk.clk_pll0) / 1000000;
59 drm_info(&kmb->drm, "system clk = %d Mhz", kmb->sys_clk_mhz);
61 ret = kmb_dsi_clk_init(kmb->kmb_dsi);
63 /* Set LCD clock to 200 Mhz */
64 clk_set_rate(kmb->kmb_clk.clk_lcd, KMB_LCD_DEFAULT_CLK);
65 if (clk_get_rate(kmb->kmb_clk.clk_lcd) != KMB_LCD_DEFAULT_CLK) {
66 drm_err(&kmb->drm, "failed to set to clk_lcd to %d\n",
70 drm_dbg(&kmb->drm, "clk_lcd = %ld\n", clk_get_rate(kmb->kmb_clk.clk_lcd));
72 ret = kmb_display_clk_enable(kmb);
76 msscam = syscon_regmap_lookup_by_compatible("intel,keembay-msscam");
78 drm_err(&kmb->drm, "failed to get msscam syscon");
82 /* Enable MSS_CAM_CLK_CTRL for MIPI TX and LCD */
83 regmap_update_bits(msscam, MSS_CAM_CLK_CTRL, 0x1fff, 0x1fff);
84 regmap_update_bits(msscam, MSS_CAM_RSTN_CTRL, 0xffffffff, 0xffffffff);
88 static void kmb_display_clk_disable(struct kmb_drm_private *kmb)
90 clk_disable_unprepare(kmb->kmb_clk.clk_lcd);
93 static void __iomem *kmb_map_mmio(struct drm_device *drm,
94 struct platform_device *pdev,
100 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
102 drm_err(drm, "failed to get resource for %s", name);
103 return ERR_PTR(-ENOMEM);
105 mem = devm_ioremap_resource(drm->dev, res);
107 drm_err(drm, "failed to ioremap %s registers", name);
111 static int kmb_hw_init(struct drm_device *drm, unsigned long flags)
113 struct kmb_drm_private *kmb = to_kmb(drm);
114 struct platform_device *pdev = to_platform_device(drm->dev);
118 /* Map LCD MMIO registers */
119 kmb->lcd_mmio = kmb_map_mmio(drm, pdev, "lcd");
120 if (IS_ERR(kmb->lcd_mmio)) {
121 drm_err(&kmb->drm, "failed to map LCD registers\n");
125 /* Map MIPI MMIO registers */
126 ret = kmb_dsi_map_mmio(kmb->kmb_dsi);
130 /* Enable display clocks */
131 kmb_initialize_clocks(kmb, &pdev->dev);
133 /* Register irqs here - section 17.3 in databook
134 * lists LCD at 79 and 82 for MIPI under MSS CPU -
135 * firmware has redirected 79 to A53 IRQ 33
138 /* Allocate LCD interrupt resources */
139 irq_lcd = platform_get_irq(pdev, 0);
142 drm_err(&kmb->drm, "irq_lcd not found");
146 /* Get the optional framebuffer memory resource */
147 ret = of_reserved_mem_device_init(drm->dev);
148 if (ret && ret != -ENODEV)
151 spin_lock_init(&kmb->irq_lock);
153 kmb->irq_lcd = irq_lcd;
158 of_reserved_mem_device_release(drm->dev);
163 static const struct drm_mode_config_funcs kmb_mode_config_funcs = {
164 .fb_create = drm_gem_fb_create,
165 .atomic_check = drm_atomic_helper_check,
166 .atomic_commit = drm_atomic_helper_commit,
169 static int kmb_setup_mode_config(struct drm_device *drm)
172 struct kmb_drm_private *kmb = to_kmb(drm);
174 ret = drmm_mode_config_init(drm);
177 drm->mode_config.min_width = KMB_FB_MIN_WIDTH;
178 drm->mode_config.min_height = KMB_FB_MIN_HEIGHT;
179 drm->mode_config.max_width = KMB_FB_MAX_WIDTH;
180 drm->mode_config.max_height = KMB_FB_MAX_HEIGHT;
181 drm->mode_config.preferred_depth = 24;
182 drm->mode_config.funcs = &kmb_mode_config_funcs;
184 ret = kmb_setup_crtc(drm);
186 drm_err(drm, "failed to create crtc\n");
189 ret = kmb_dsi_encoder_init(drm, kmb->kmb_dsi);
190 /* Set the CRTC's port so that the encoder component can find it */
191 kmb->crtc.port = of_graph_get_port_by_id(drm->dev->of_node, 0);
192 ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
194 drm_err(drm, "failed to initialize vblank\n");
195 pm_runtime_disable(drm->dev);
199 drm_mode_config_reset(drm);
203 static irqreturn_t handle_lcd_irq(struct drm_device *dev)
205 unsigned long status, val, val1;
206 int plane_id, dma0_state, dma1_state;
207 struct kmb_drm_private *kmb = to_kmb(dev);
210 status = kmb_read_lcd(kmb, LCD_INT_STATUS);
212 spin_lock(&kmb->irq_lock);
213 if (status & LCD_INT_EOF) {
214 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_EOF);
216 /* When disabling/enabling LCD layers, the change takes effect
217 * immediately and does not wait for EOF (end of frame).
218 * When kmb_plane_atomic_disable is called, mark the plane as
219 * disabled but actually disable the plane when EOF irq is
222 for (plane_id = LAYER_0;
223 plane_id < KMB_MAX_PLANES; plane_id++) {
224 if (kmb->plane_status[plane_id].disable) {
225 kmb_clr_bitmask_lcd(kmb,
228 LCD_DMA_LAYER_ENABLE);
230 kmb_clr_bitmask_lcd(kmb, LCD_CONTROL,
231 kmb->plane_status[plane_id].ctrl);
233 ctrl = kmb_read_lcd(kmb, LCD_CONTROL);
234 if (!(ctrl & (LCD_CTRL_VL1_ENABLE |
235 LCD_CTRL_VL2_ENABLE |
236 LCD_CTRL_GL1_ENABLE |
237 LCD_CTRL_GL2_ENABLE))) {
238 /* If no LCD layers are using DMA,
239 * then disable DMA pipelined AXI read
242 kmb_clr_bitmask_lcd(kmb, LCD_CONTROL,
243 LCD_CTRL_PIPELINE_DMA);
246 kmb->plane_status[plane_id].disable = false;
249 if (kmb->kmb_under_flow) {
250 /* DMA Recovery after underflow */
251 dma0_state = (kmb->layer_no == 0) ?
252 LCD_VIDEO0_DMA0_STATE : LCD_VIDEO1_DMA0_STATE;
253 dma1_state = (kmb->layer_no == 0) ?
254 LCD_VIDEO0_DMA1_STATE : LCD_VIDEO1_DMA1_STATE;
257 kmb_write_lcd(kmb, LCD_FIFO_FLUSH, 1);
258 val = kmb_read_lcd(kmb, dma0_state)
259 & LCD_DMA_STATE_ACTIVE;
260 val1 = kmb_read_lcd(kmb, dma1_state)
261 & LCD_DMA_STATE_ACTIVE;
262 } while ((val || val1));
264 kmb_clr_bitmask_lcd(kmb,
265 LCD_LAYERn_DMA_CFG(kmb->layer_no),
266 LCD_DMA_LAYER_ENABLE);
267 kmb_write_lcd(kmb, LCD_FIFO_FLUSH, 1);
268 kmb->kmb_flush_done = 1;
269 kmb->kmb_under_flow = 0;
273 if (status & LCD_INT_LINE_CMP) {
274 /* clear line compare interrupt */
275 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_LINE_CMP);
278 if (status & LCD_INT_VERT_COMP) {
280 val = kmb_read_lcd(kmb, LCD_VSTATUS);
281 val = (val & LCD_VSTATUS_VERTICAL_STATUS_MASK);
283 case LCD_VSTATUS_COMPARE_VSYNC:
284 /* Clear vertical compare interrupt */
285 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_VERT_COMP);
286 if (kmb->kmb_flush_done) {
287 kmb_set_bitmask_lcd(kmb,
290 LCD_DMA_LAYER_ENABLE);
291 kmb->kmb_flush_done = 0;
293 drm_crtc_handle_vblank(&kmb->crtc);
295 case LCD_VSTATUS_COMPARE_BACKPORCH:
296 case LCD_VSTATUS_COMPARE_ACTIVE:
297 case LCD_VSTATUS_COMPARE_FRONT_PORCH:
298 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_VERT_COMP);
302 if (status & LCD_INT_DMA_ERR) {
304 (status & LCD_INT_DMA_ERR &
305 kmb_read_lcd(kmb, LCD_INT_ENABLE));
307 if (val & (LAYER0_DMA_FIFO_UNDERFLOW |
308 LAYER0_DMA_CB_FIFO_UNDERFLOW |
309 LAYER0_DMA_CR_FIFO_UNDERFLOW)) {
310 kmb->kmb_under_flow++;
312 "!LAYER0:VL0 DMA UNDERFLOW val = 0x%lx,under_flow=%d",
313 val, kmb->kmb_under_flow);
314 /* disable underflow interrupt */
315 kmb_clr_bitmask_lcd(kmb, LCD_INT_ENABLE,
316 LAYER0_DMA_FIFO_UNDERFLOW |
317 LAYER0_DMA_CB_FIFO_UNDERFLOW |
318 LAYER0_DMA_CR_FIFO_UNDERFLOW);
319 kmb_set_bitmask_lcd(kmb, LCD_INT_CLEAR,
320 LAYER0_DMA_CB_FIFO_UNDERFLOW |
321 LAYER0_DMA_FIFO_UNDERFLOW |
322 LAYER0_DMA_CR_FIFO_UNDERFLOW);
323 /* disable auto restart mode */
324 kmb_clr_bitmask_lcd(kmb, LCD_LAYERn_DMA_CFG(0),
325 LCD_DMA_LAYER_CONT_PING_PONG_UPDATE);
330 if (val & LAYER0_DMA_FIFO_OVERFLOW)
332 "LAYER0:VL0 DMA OVERFLOW val = 0x%lx", val);
333 if (val & LAYER0_DMA_CB_FIFO_OVERFLOW)
335 "LAYER0:VL0 DMA CB OVERFLOW val = 0x%lx", val);
336 if (val & LAYER0_DMA_CR_FIFO_OVERFLOW)
338 "LAYER0:VL0 DMA CR OVERFLOW val = 0x%lx", val);
341 if (val & (LAYER1_DMA_FIFO_UNDERFLOW |
342 LAYER1_DMA_CB_FIFO_UNDERFLOW |
343 LAYER1_DMA_CR_FIFO_UNDERFLOW)) {
344 kmb->kmb_under_flow++;
346 "!LAYER1:VL1 DMA UNDERFLOW val = 0x%lx, under_flow=%d",
347 val, kmb->kmb_under_flow);
348 /* disable underflow interrupt */
349 kmb_clr_bitmask_lcd(kmb, LCD_INT_ENABLE,
350 LAYER1_DMA_FIFO_UNDERFLOW |
351 LAYER1_DMA_CB_FIFO_UNDERFLOW |
352 LAYER1_DMA_CR_FIFO_UNDERFLOW);
353 kmb_set_bitmask_lcd(kmb, LCD_INT_CLEAR,
354 LAYER1_DMA_CB_FIFO_UNDERFLOW |
355 LAYER1_DMA_FIFO_UNDERFLOW |
356 LAYER1_DMA_CR_FIFO_UNDERFLOW);
357 /* disable auto restart mode */
358 kmb_clr_bitmask_lcd(kmb, LCD_LAYERn_DMA_CFG(1),
359 LCD_DMA_LAYER_CONT_PING_PONG_UPDATE);
364 if (val & LAYER1_DMA_FIFO_OVERFLOW)
366 "LAYER1:VL1 DMA OVERFLOW val = 0x%lx", val);
367 if (val & LAYER1_DMA_CB_FIFO_OVERFLOW)
369 "LAYER1:VL1 DMA CB OVERFLOW val = 0x%lx", val);
370 if (val & LAYER1_DMA_CR_FIFO_OVERFLOW)
372 "LAYER1:VL1 DMA CR OVERFLOW val = 0x%lx", val);
375 if (val & LAYER2_DMA_FIFO_UNDERFLOW)
377 "LAYER2:GL0 DMA UNDERFLOW val = 0x%lx", val);
378 if (val & LAYER2_DMA_FIFO_OVERFLOW)
380 "LAYER2:GL0 DMA OVERFLOW val = 0x%lx", val);
383 if (val & LAYER3_DMA_FIFO_UNDERFLOW)
385 "LAYER3:GL1 DMA UNDERFLOW val = 0x%lx", val);
386 if (val & LAYER3_DMA_FIFO_OVERFLOW)
388 "LAYER3:GL1 DMA OVERFLOW val = 0x%lx", val);
391 spin_unlock(&kmb->irq_lock);
393 if (status & LCD_INT_LAYER) {
394 /* Clear layer interrupts */
395 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_LAYER);
398 /* Clear all interrupts */
399 kmb_set_bitmask_lcd(kmb, LCD_INT_CLEAR, 1);
404 static irqreturn_t kmb_isr(int irq, void *arg)
406 struct drm_device *dev = (struct drm_device *)arg;
412 static void kmb_irq_reset(struct drm_device *drm)
414 kmb_write_lcd(to_kmb(drm), LCD_INT_CLEAR, 0xFFFF);
415 kmb_write_lcd(to_kmb(drm), LCD_INT_ENABLE, 0);
418 static int kmb_irq_install(struct drm_device *drm, unsigned int irq)
420 if (irq == IRQ_NOTCONNECTED)
425 return request_irq(irq, kmb_isr, 0, drm->driver->name, drm);
428 static void kmb_irq_uninstall(struct drm_device *drm)
430 struct kmb_drm_private *kmb = to_kmb(drm);
433 free_irq(kmb->irq_lcd, drm);
436 DEFINE_DRM_GEM_DMA_FOPS(fops);
438 static const struct drm_driver kmb_driver = {
439 .driver_features = DRIVER_GEM |
440 DRIVER_MODESET | DRIVER_ATOMIC,
443 DRM_GEM_DMA_DRIVER_OPS_VMAP,
445 .desc = "KEEMBAY DISPLAY DRIVER",
447 .major = DRIVER_MAJOR,
448 .minor = DRIVER_MINOR,
451 static int kmb_remove(struct platform_device *pdev)
453 struct device *dev = &pdev->dev;
454 struct drm_device *drm = dev_get_drvdata(dev);
455 struct kmb_drm_private *kmb = to_kmb(drm);
457 drm_dev_unregister(drm);
458 drm_kms_helper_poll_fini(drm);
459 of_node_put(kmb->crtc.port);
460 kmb->crtc.port = NULL;
461 pm_runtime_get_sync(drm->dev);
462 kmb_irq_uninstall(drm);
463 pm_runtime_put_sync(drm->dev);
464 pm_runtime_disable(drm->dev);
466 of_reserved_mem_device_release(drm->dev);
469 kmb_display_clk_disable(kmb);
471 dev_set_drvdata(dev, NULL);
473 /* Unregister DSI host */
474 kmb_dsi_host_unregister(kmb->kmb_dsi);
475 drm_atomic_helper_shutdown(drm);
479 static int kmb_probe(struct platform_device *pdev)
481 struct device *dev = get_device(&pdev->dev);
482 struct kmb_drm_private *kmb;
484 struct device_node *dsi_in;
485 struct device_node *dsi_node;
486 struct platform_device *dsi_pdev;
488 /* The bridge (ADV 7535) will return -EPROBE_DEFER until it
489 * has a mipi_dsi_host to register its device to. So, we
490 * first register the DSI host during probe time, and then return
491 * -EPROBE_DEFER until the bridge is loaded. Probe will be called again
492 * and then the rest of the driver initialization can proceed
493 * afterwards and the bridge can be successfully attached.
495 dsi_in = of_graph_get_endpoint_by_regs(dev->of_node, 0, 0);
497 DRM_ERROR("Failed to get dsi_in node info from DT");
500 dsi_node = of_graph_get_remote_port_parent(dsi_in);
503 DRM_ERROR("Failed to get dsi node from DT\n");
507 dsi_pdev = of_find_device_by_node(dsi_node);
510 of_node_put(dsi_node);
511 DRM_ERROR("Failed to get dsi platform device\n");
516 of_node_put(dsi_node);
517 ret = kmb_dsi_host_bridge_init(get_device(&dsi_pdev->dev));
519 if (ret == -EPROBE_DEFER) {
520 return -EPROBE_DEFER;
522 DRM_ERROR("probe failed to initialize DSI host bridge\n");
526 /* Create DRM device */
527 kmb = devm_drm_dev_alloc(dev, &kmb_driver,
528 struct kmb_drm_private, drm);
532 dev_set_drvdata(dev, &kmb->drm);
534 /* Initialize MIPI DSI */
535 kmb->kmb_dsi = kmb_dsi_init(dsi_pdev);
536 if (IS_ERR(kmb->kmb_dsi)) {
537 drm_err(&kmb->drm, "failed to initialize DSI\n");
538 ret = PTR_ERR(kmb->kmb_dsi);
542 kmb->kmb_dsi->dev = &dsi_pdev->dev;
543 kmb->kmb_dsi->pdev = dsi_pdev;
544 ret = kmb_hw_init(&kmb->drm, 0);
548 ret = kmb_setup_mode_config(&kmb->drm);
552 ret = kmb_irq_install(&kmb->drm, kmb->irq_lcd);
554 drm_err(&kmb->drm, "failed to install IRQ handler\n");
558 drm_kms_helper_poll_init(&kmb->drm);
560 /* Register graphics device with the kernel */
561 ret = drm_dev_register(&kmb->drm, 0);
565 drm_fbdev_dma_setup(&kmb->drm, 0);
570 drm_kms_helper_poll_fini(&kmb->drm);
572 pm_runtime_disable(kmb->drm.dev);
574 drm_crtc_cleanup(&kmb->crtc);
575 drm_mode_config_cleanup(&kmb->drm);
577 dev_set_drvdata(dev, NULL);
578 kmb_dsi_host_unregister(kmb->kmb_dsi);
583 static const struct of_device_id kmb_of_match[] = {
584 {.compatible = "intel,keembay-display"},
588 MODULE_DEVICE_TABLE(of, kmb_of_match);
590 static int __maybe_unused kmb_pm_suspend(struct device *dev)
592 struct drm_device *drm = dev_get_drvdata(dev);
593 struct kmb_drm_private *kmb = to_kmb(drm);
595 drm_kms_helper_poll_disable(drm);
597 kmb->state = drm_atomic_helper_suspend(drm);
598 if (IS_ERR(kmb->state)) {
599 drm_kms_helper_poll_enable(drm);
600 return PTR_ERR(kmb->state);
606 static int __maybe_unused kmb_pm_resume(struct device *dev)
608 struct drm_device *drm = dev_get_drvdata(dev);
609 struct kmb_drm_private *kmb = drm ? to_kmb(drm) : NULL;
614 drm_atomic_helper_resume(drm, kmb->state);
615 drm_kms_helper_poll_enable(drm);
620 static SIMPLE_DEV_PM_OPS(kmb_pm_ops, kmb_pm_suspend, kmb_pm_resume);
622 static struct platform_driver kmb_platform_driver = {
624 .remove = kmb_remove,
628 .of_match_table = kmb_of_match,
632 drm_module_platform_driver(kmb_platform_driver);
634 MODULE_AUTHOR("Intel Corporation");
635 MODULE_DESCRIPTION("Keembay Display driver");
636 MODULE_LICENSE("GPL v2");