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_gem_cma_helper.h>
19 #include <drm/drm_gem_framebuffer_helper.h>
20 #include <drm/drm_irq.h>
21 #include <drm/drm_probe_helper.h>
22 #include <drm/drm_vblank.h>
28 static int kmb_display_clk_enable(struct kmb_drm_private *kmb)
32 ret = clk_prepare_enable(kmb->kmb_clk.clk_lcd);
34 drm_err(&kmb->drm, "Failed to enable LCD clock: %d\n", ret);
37 DRM_INFO("SUCCESS : enabled LCD clocks\n");
41 static int kmb_initialize_clocks(struct kmb_drm_private *kmb, struct device *dev)
44 struct regmap *msscam;
46 kmb->kmb_clk.clk_lcd = devm_clk_get(dev, "clk_lcd");
47 if (IS_ERR(kmb->kmb_clk.clk_lcd)) {
48 drm_err(&kmb->drm, "clk_get() failed clk_lcd\n");
49 return PTR_ERR(kmb->kmb_clk.clk_lcd);
52 kmb->kmb_clk.clk_pll0 = devm_clk_get(dev, "clk_pll0");
53 if (IS_ERR(kmb->kmb_clk.clk_pll0)) {
54 drm_err(&kmb->drm, "clk_get() failed clk_pll0 ");
55 return PTR_ERR(kmb->kmb_clk.clk_pll0);
57 kmb->sys_clk_mhz = clk_get_rate(kmb->kmb_clk.clk_pll0) / 1000000;
58 drm_info(&kmb->drm, "system clk = %d Mhz", kmb->sys_clk_mhz);
60 ret = kmb_dsi_clk_init(kmb->kmb_dsi);
62 /* Set LCD clock to 200 Mhz */
63 clk_set_rate(kmb->kmb_clk.clk_lcd, KMB_LCD_DEFAULT_CLK);
64 if (clk_get_rate(kmb->kmb_clk.clk_lcd) != KMB_LCD_DEFAULT_CLK) {
65 drm_err(&kmb->drm, "failed to set to clk_lcd to %d\n",
69 drm_dbg(&kmb->drm, "clk_lcd = %ld\n", clk_get_rate(kmb->kmb_clk.clk_lcd));
71 ret = kmb_display_clk_enable(kmb);
75 msscam = syscon_regmap_lookup_by_compatible("intel,keembay-msscam");
77 drm_err(&kmb->drm, "failed to get msscam syscon");
81 /* Enable MSS_CAM_CLK_CTRL for MIPI TX and LCD */
82 regmap_update_bits(msscam, MSS_CAM_CLK_CTRL, 0x1fff, 0x1fff);
83 regmap_update_bits(msscam, MSS_CAM_RSTN_CTRL, 0xffffffff, 0xffffffff);
87 static void kmb_display_clk_disable(struct kmb_drm_private *kmb)
89 clk_disable_unprepare(kmb->kmb_clk.clk_lcd);
92 static void __iomem *kmb_map_mmio(struct drm_device *drm,
93 struct platform_device *pdev,
99 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, name);
101 drm_err(drm, "failed to get resource for %s", name);
102 return ERR_PTR(-ENOMEM);
104 mem = devm_ioremap_resource(drm->dev, res);
106 drm_err(drm, "failed to ioremap %s registers", name);
110 static int kmb_hw_init(struct drm_device *drm, unsigned long flags)
112 struct kmb_drm_private *kmb = to_kmb(drm);
113 struct platform_device *pdev = to_platform_device(drm->dev);
117 /* Map LCD MMIO registers */
118 kmb->lcd_mmio = kmb_map_mmio(drm, pdev, "lcd");
119 if (IS_ERR(kmb->lcd_mmio)) {
120 drm_err(&kmb->drm, "failed to map LCD registers\n");
124 /* Map MIPI MMIO registers */
125 ret = kmb_dsi_map_mmio(kmb->kmb_dsi);
129 /* Enable display clocks */
130 kmb_initialize_clocks(kmb, &pdev->dev);
132 /* Register irqs here - section 17.3 in databook
133 * lists LCD at 79 and 82 for MIPI under MSS CPU -
134 * firmware has redirected 79 to A53 IRQ 33
137 /* Allocate LCD interrupt resources */
138 irq_lcd = platform_get_irq(pdev, 0);
141 drm_err(&kmb->drm, "irq_lcd not found");
145 /* Get the optional framebuffer memory resource */
146 ret = of_reserved_mem_device_init(drm->dev);
147 if (ret && ret != -ENODEV)
150 spin_lock_init(&kmb->irq_lock);
152 kmb->irq_lcd = irq_lcd;
157 of_reserved_mem_device_release(drm->dev);
162 static const struct drm_mode_config_funcs kmb_mode_config_funcs = {
163 .fb_create = drm_gem_fb_create,
164 .atomic_check = drm_atomic_helper_check,
165 .atomic_commit = drm_atomic_helper_commit,
168 static int kmb_setup_mode_config(struct drm_device *drm)
171 struct kmb_drm_private *kmb = to_kmb(drm);
173 ret = drmm_mode_config_init(drm);
176 drm->mode_config.min_width = KMB_MIN_WIDTH;
177 drm->mode_config.min_height = KMB_MIN_HEIGHT;
178 drm->mode_config.max_width = KMB_MAX_WIDTH;
179 drm->mode_config.max_height = KMB_MAX_HEIGHT;
180 drm->mode_config.funcs = &kmb_mode_config_funcs;
182 ret = kmb_setup_crtc(drm);
184 drm_err(drm, "failed to create crtc\n");
187 ret = kmb_dsi_encoder_init(drm, kmb->kmb_dsi);
188 /* Set the CRTC's port so that the encoder component can find it */
189 kmb->crtc.port = of_graph_get_port_by_id(drm->dev->of_node, 0);
190 ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
192 drm_err(drm, "failed to initialize vblank\n");
193 pm_runtime_disable(drm->dev);
197 drm_mode_config_reset(drm);
201 static irqreturn_t handle_lcd_irq(struct drm_device *dev)
203 unsigned long status, val, val1;
204 int plane_id, dma0_state, dma1_state;
205 struct kmb_drm_private *kmb = to_kmb(dev);
208 status = kmb_read_lcd(kmb, LCD_INT_STATUS);
210 spin_lock(&kmb->irq_lock);
211 if (status & LCD_INT_EOF) {
212 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_EOF);
214 /* When disabling/enabling LCD layers, the change takes effect
215 * immediately and does not wait for EOF (end of frame).
216 * When kmb_plane_atomic_disable is called, mark the plane as
217 * disabled but actually disable the plane when EOF irq is
220 for (plane_id = LAYER_0;
221 plane_id < KMB_MAX_PLANES; plane_id++) {
222 if (kmb->plane_status[plane_id].disable) {
223 kmb_clr_bitmask_lcd(kmb,
226 LCD_DMA_LAYER_ENABLE);
228 kmb_clr_bitmask_lcd(kmb, LCD_CONTROL,
229 kmb->plane_status[plane_id].ctrl);
231 ctrl = kmb_read_lcd(kmb, LCD_CONTROL);
232 if (!(ctrl & (LCD_CTRL_VL1_ENABLE |
233 LCD_CTRL_VL2_ENABLE |
234 LCD_CTRL_GL1_ENABLE |
235 LCD_CTRL_GL2_ENABLE))) {
236 /* If no LCD layers are using DMA,
237 * then disable DMA pipelined AXI read
240 kmb_clr_bitmask_lcd(kmb, LCD_CONTROL,
241 LCD_CTRL_PIPELINE_DMA);
244 kmb->plane_status[plane_id].disable = false;
247 if (kmb->kmb_under_flow) {
248 /* DMA Recovery after underflow */
249 dma0_state = (kmb->layer_no == 0) ?
250 LCD_VIDEO0_DMA0_STATE : LCD_VIDEO1_DMA0_STATE;
251 dma1_state = (kmb->layer_no == 0) ?
252 LCD_VIDEO0_DMA1_STATE : LCD_VIDEO1_DMA1_STATE;
255 kmb_write_lcd(kmb, LCD_FIFO_FLUSH, 1);
256 val = kmb_read_lcd(kmb, dma0_state)
257 & LCD_DMA_STATE_ACTIVE;
258 val1 = kmb_read_lcd(kmb, dma1_state)
259 & LCD_DMA_STATE_ACTIVE;
260 } while ((val || val1));
262 kmb_clr_bitmask_lcd(kmb,
263 LCD_LAYERn_DMA_CFG(kmb->layer_no),
264 LCD_DMA_LAYER_ENABLE);
265 kmb_write_lcd(kmb, LCD_FIFO_FLUSH, 1);
266 kmb->kmb_flush_done = 1;
267 kmb->kmb_under_flow = 0;
271 if (status & LCD_INT_LINE_CMP) {
272 /* clear line compare interrupt */
273 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_LINE_CMP);
276 if (status & LCD_INT_VERT_COMP) {
278 val = kmb_read_lcd(kmb, LCD_VSTATUS);
279 val = (val & LCD_VSTATUS_VERTICAL_STATUS_MASK);
281 case LCD_VSTATUS_COMPARE_VSYNC:
282 /* Clear vertical compare interrupt */
283 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_VERT_COMP);
284 if (kmb->kmb_flush_done) {
285 kmb_set_bitmask_lcd(kmb,
288 LCD_DMA_LAYER_ENABLE);
289 kmb->kmb_flush_done = 0;
291 drm_crtc_handle_vblank(&kmb->crtc);
293 case LCD_VSTATUS_COMPARE_BACKPORCH:
294 case LCD_VSTATUS_COMPARE_ACTIVE:
295 case LCD_VSTATUS_COMPARE_FRONT_PORCH:
296 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_VERT_COMP);
300 if (status & LCD_INT_DMA_ERR) {
302 (status & LCD_INT_DMA_ERR &
303 kmb_read_lcd(kmb, LCD_INT_ENABLE));
305 if (val & (LAYER0_DMA_FIFO_UNDERFLOW |
306 LAYER0_DMA_CB_FIFO_UNDERFLOW |
307 LAYER0_DMA_CR_FIFO_UNDERFLOW)) {
308 kmb->kmb_under_flow++;
310 "!LAYER0:VL0 DMA UNDERFLOW val = 0x%lx,under_flow=%d",
311 val, kmb->kmb_under_flow);
312 /* disable underflow interrupt */
313 kmb_clr_bitmask_lcd(kmb, LCD_INT_ENABLE,
314 LAYER0_DMA_FIFO_UNDERFLOW |
315 LAYER0_DMA_CB_FIFO_UNDERFLOW |
316 LAYER0_DMA_CR_FIFO_UNDERFLOW);
317 kmb_set_bitmask_lcd(kmb, LCD_INT_CLEAR,
318 LAYER0_DMA_CB_FIFO_UNDERFLOW |
319 LAYER0_DMA_FIFO_UNDERFLOW |
320 LAYER0_DMA_CR_FIFO_UNDERFLOW);
321 /* disable auto restart mode */
322 kmb_clr_bitmask_lcd(kmb, LCD_LAYERn_DMA_CFG(0),
323 LCD_DMA_LAYER_CONT_PING_PONG_UPDATE);
328 if (val & LAYER0_DMA_FIFO_OVERFLOW)
330 "LAYER0:VL0 DMA OVERFLOW val = 0x%lx", val);
331 if (val & LAYER0_DMA_CB_FIFO_OVERFLOW)
333 "LAYER0:VL0 DMA CB OVERFLOW val = 0x%lx", val);
334 if (val & LAYER0_DMA_CR_FIFO_OVERFLOW)
336 "LAYER0:VL0 DMA CR OVERFLOW val = 0x%lx", val);
339 if (val & (LAYER1_DMA_FIFO_UNDERFLOW |
340 LAYER1_DMA_CB_FIFO_UNDERFLOW |
341 LAYER1_DMA_CR_FIFO_UNDERFLOW)) {
342 kmb->kmb_under_flow++;
344 "!LAYER1:VL1 DMA UNDERFLOW val = 0x%lx, under_flow=%d",
345 val, kmb->kmb_under_flow);
346 /* disable underflow interrupt */
347 kmb_clr_bitmask_lcd(kmb, LCD_INT_ENABLE,
348 LAYER1_DMA_FIFO_UNDERFLOW |
349 LAYER1_DMA_CB_FIFO_UNDERFLOW |
350 LAYER1_DMA_CR_FIFO_UNDERFLOW);
351 kmb_set_bitmask_lcd(kmb, LCD_INT_CLEAR,
352 LAYER1_DMA_CB_FIFO_UNDERFLOW |
353 LAYER1_DMA_FIFO_UNDERFLOW |
354 LAYER1_DMA_CR_FIFO_UNDERFLOW);
355 /* disable auto restart mode */
356 kmb_clr_bitmask_lcd(kmb, LCD_LAYERn_DMA_CFG(1),
357 LCD_DMA_LAYER_CONT_PING_PONG_UPDATE);
362 if (val & LAYER1_DMA_FIFO_OVERFLOW)
364 "LAYER1:VL1 DMA OVERFLOW val = 0x%lx", val);
365 if (val & LAYER1_DMA_CB_FIFO_OVERFLOW)
367 "LAYER1:VL1 DMA CB OVERFLOW val = 0x%lx", val);
368 if (val & LAYER1_DMA_CR_FIFO_OVERFLOW)
370 "LAYER1:VL1 DMA CR OVERFLOW val = 0x%lx", val);
373 if (val & LAYER2_DMA_FIFO_UNDERFLOW)
375 "LAYER2:GL0 DMA UNDERFLOW val = 0x%lx", val);
376 if (val & LAYER2_DMA_FIFO_OVERFLOW)
378 "LAYER2:GL0 DMA OVERFLOW val = 0x%lx", val);
381 if (val & LAYER3_DMA_FIFO_UNDERFLOW)
383 "LAYER3:GL1 DMA UNDERFLOW val = 0x%lx", val);
384 if (val & LAYER3_DMA_FIFO_UNDERFLOW)
386 "LAYER3:GL1 DMA OVERFLOW val = 0x%lx", val);
389 spin_unlock(&kmb->irq_lock);
391 if (status & LCD_INT_LAYER) {
392 /* Clear layer interrupts */
393 kmb_write_lcd(kmb, LCD_INT_CLEAR, LCD_INT_LAYER);
396 /* Clear all interrupts */
397 kmb_set_bitmask_lcd(kmb, LCD_INT_CLEAR, 1);
402 static irqreturn_t kmb_isr(int irq, void *arg)
404 struct drm_device *dev = (struct drm_device *)arg;
410 static void kmb_irq_reset(struct drm_device *drm)
412 kmb_write_lcd(to_kmb(drm), LCD_INT_CLEAR, 0xFFFF);
413 kmb_write_lcd(to_kmb(drm), LCD_INT_ENABLE, 0);
416 DEFINE_DRM_GEM_CMA_FOPS(fops);
418 static const struct drm_driver kmb_driver = {
419 .driver_features = DRIVER_GEM |
420 DRIVER_MODESET | DRIVER_ATOMIC,
421 .irq_handler = kmb_isr,
422 .irq_preinstall = kmb_irq_reset,
423 .irq_uninstall = kmb_irq_reset,
426 DRM_GEM_CMA_DRIVER_OPS_VMAP,
428 .desc = "KEEMBAY DISPLAY DRIVER",
430 .major = DRIVER_MAJOR,
431 .minor = DRIVER_MINOR,
434 static int kmb_remove(struct platform_device *pdev)
436 struct device *dev = &pdev->dev;
437 struct drm_device *drm = dev_get_drvdata(dev);
438 struct kmb_drm_private *kmb = to_kmb(drm);
440 drm_dev_unregister(drm);
441 drm_kms_helper_poll_fini(drm);
442 of_node_put(kmb->crtc.port);
443 kmb->crtc.port = NULL;
444 pm_runtime_get_sync(drm->dev);
445 drm_irq_uninstall(drm);
446 pm_runtime_put_sync(drm->dev);
447 pm_runtime_disable(drm->dev);
449 of_reserved_mem_device_release(drm->dev);
452 kmb_display_clk_disable(kmb);
454 dev_set_drvdata(dev, NULL);
456 /* Unregister DSI host */
457 kmb_dsi_host_unregister(kmb->kmb_dsi);
458 drm_atomic_helper_shutdown(drm);
462 static int kmb_probe(struct platform_device *pdev)
464 struct device *dev = get_device(&pdev->dev);
465 struct kmb_drm_private *kmb;
467 struct device_node *dsi_in;
468 struct device_node *dsi_node;
469 struct platform_device *dsi_pdev;
471 /* The bridge (ADV 7535) will return -EPROBE_DEFER until it
472 * has a mipi_dsi_host to register its device to. So, we
473 * first register the DSI host during probe time, and then return
474 * -EPROBE_DEFER until the bridge is loaded. Probe will be called again
475 * and then the rest of the driver initialization can proceed
476 * afterwards and the bridge can be successfully attached.
478 dsi_in = of_graph_get_endpoint_by_regs(dev->of_node, 0, 0);
480 DRM_ERROR("Failed to get dsi_in node info from DT");
483 dsi_node = of_graph_get_remote_port_parent(dsi_in);
486 DRM_ERROR("Failed to get dsi node from DT\n");
490 dsi_pdev = of_find_device_by_node(dsi_node);
493 of_node_put(dsi_node);
494 DRM_ERROR("Failed to get dsi platform device\n");
499 of_node_put(dsi_node);
500 ret = kmb_dsi_host_bridge_init(get_device(&dsi_pdev->dev));
502 if (ret == -EPROBE_DEFER) {
503 return -EPROBE_DEFER;
505 DRM_ERROR("probe failed to initialize DSI host bridge\n");
509 /* Create DRM device */
510 kmb = devm_drm_dev_alloc(dev, &kmb_driver,
511 struct kmb_drm_private, drm);
515 dev_set_drvdata(dev, &kmb->drm);
517 /* Initialize MIPI DSI */
518 kmb->kmb_dsi = kmb_dsi_init(dsi_pdev);
519 if (IS_ERR(kmb->kmb_dsi)) {
520 drm_err(&kmb->drm, "failed to initialize DSI\n");
521 ret = PTR_ERR(kmb->kmb_dsi);
525 kmb->kmb_dsi->dev = &dsi_pdev->dev;
526 kmb->kmb_dsi->pdev = dsi_pdev;
527 ret = kmb_hw_init(&kmb->drm, 0);
531 ret = kmb_setup_mode_config(&kmb->drm);
535 ret = drm_irq_install(&kmb->drm, kmb->irq_lcd);
537 drm_err(&kmb->drm, "failed to install IRQ handler\n");
541 drm_kms_helper_poll_init(&kmb->drm);
543 /* Register graphics device with the kernel */
544 ret = drm_dev_register(&kmb->drm, 0);
551 drm_kms_helper_poll_fini(&kmb->drm);
553 pm_runtime_disable(kmb->drm.dev);
555 drm_crtc_cleanup(&kmb->crtc);
556 drm_mode_config_cleanup(&kmb->drm);
558 dev_set_drvdata(dev, NULL);
559 kmb_dsi_host_unregister(kmb->kmb_dsi);
564 static const struct of_device_id kmb_of_match[] = {
565 {.compatible = "intel,keembay-display"},
569 MODULE_DEVICE_TABLE(of, kmb_of_match);
571 static int __maybe_unused kmb_pm_suspend(struct device *dev)
573 struct drm_device *drm = dev_get_drvdata(dev);
574 struct kmb_drm_private *kmb = to_kmb(drm);
576 drm_kms_helper_poll_disable(drm);
578 kmb->state = drm_atomic_helper_suspend(drm);
579 if (IS_ERR(kmb->state)) {
580 drm_kms_helper_poll_enable(drm);
581 return PTR_ERR(kmb->state);
587 static int __maybe_unused kmb_pm_resume(struct device *dev)
589 struct drm_device *drm = dev_get_drvdata(dev);
590 struct kmb_drm_private *kmb = drm ? to_kmb(drm) : NULL;
595 drm_atomic_helper_resume(drm, kmb->state);
596 drm_kms_helper_poll_enable(drm);
601 static SIMPLE_DEV_PM_OPS(kmb_pm_ops, kmb_pm_suspend, kmb_pm_resume);
603 static struct platform_driver kmb_platform_driver = {
605 .remove = kmb_remove,
609 .of_match_table = kmb_of_match,
613 module_platform_driver(kmb_platform_driver);
615 MODULE_AUTHOR("Intel Corporation");
616 MODULE_DESCRIPTION("Keembay Display driver");
617 MODULE_LICENSE("GPL v2");