1 // SPDX-License-Identifier: GPL-2.0-only
4 #include <drm/drm_bridge.h>
5 #include <drm/drm_bridge_connector.h>
6 #include <drm/drm_damage_helper.h>
7 #include <drm/drm_drv.h>
8 #include <drm/drm_fbdev_generic.h>
9 #include <drm/drm_fb_dma_helper.h>
10 #include <drm/drm_fourcc.h>
11 #include <drm/drm_framebuffer.h>
12 #include <drm/drm_gem_atomic_helper.h>
13 #include <drm/drm_gem_dma_helper.h>
14 #include <drm/drm_gem_framebuffer_helper.h>
15 #include <drm/drm_of.h>
16 #include <drm/drm_probe_helper.h>
17 #include <drm/drm_simple_kms_helper.h>
18 #include <drm/drm_vblank.h>
19 #include <linux/bitfield.h>
20 #include <linux/clk.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/module.h>
23 #include <linux/of_device.h>
24 #include <linux/platform_device.h>
26 #define IMX21LCDC_LSSAR 0x0000 /* LCDC Screen Start Address Register */
27 #define IMX21LCDC_LSR 0x0004 /* LCDC Size Register */
28 #define IMX21LCDC_LVPWR 0x0008 /* LCDC Virtual Page Width Register */
29 #define IMX21LCDC_LCPR 0x000C /* LCDC Cursor Position Register */
30 #define IMX21LCDC_LCWHB 0x0010 /* LCDC Cursor Width Height and Blink Register*/
31 #define IMX21LCDC_LCCMR 0x0014 /* LCDC Color Cursor Mapping Register */
32 #define IMX21LCDC_LPCR 0x0018 /* LCDC Panel Configuration Register */
33 #define IMX21LCDC_LHCR 0x001C /* LCDC Horizontal Configuration Register */
34 #define IMX21LCDC_LVCR 0x0020 /* LCDC Vertical Configuration Register */
35 #define IMX21LCDC_LPOR 0x0024 /* LCDC Panning Offset Register */
36 #define IMX21LCDC_LSCR 0x0028 /* LCDC Sharp Configuration Register */
37 #define IMX21LCDC_LPCCR 0x002C /* LCDC PWM Contrast Control Register */
38 #define IMX21LCDC_LDCR 0x0030 /* LCDC DMA Control Register */
39 #define IMX21LCDC_LRMCR 0x0034 /* LCDC Refresh Mode Control Register */
40 #define IMX21LCDC_LICR 0x0038 /* LCDC Interrupt Configuration Register */
41 #define IMX21LCDC_LIER 0x003C /* LCDC Interrupt Enable Register */
42 #define IMX21LCDC_LISR 0x0040 /* LCDC Interrupt Status Register */
43 #define IMX21LCDC_LGWSAR 0x0050 /* LCDC Graphic Window Start Address Register */
44 #define IMX21LCDC_LGWSR 0x0054 /* LCDC Graph Window Size Register */
45 #define IMX21LCDC_LGWVPWR 0x0058 /* LCDC Graphic Window Virtual Page Width Register */
46 #define IMX21LCDC_LGWPOR 0x005C /* LCDC Graphic Window Panning Offset Register */
47 #define IMX21LCDC_LGWPR 0x0060 /* LCDC Graphic Window Position Register */
48 #define IMX21LCDC_LGWCR 0x0064 /* LCDC Graphic Window Control Register */
49 #define IMX21LCDC_LGWDCR 0x0068 /* LCDC Graphic Window DMA Control Register */
50 #define IMX21LCDC_LAUSCR 0x0080 /* LCDC AUS Mode Control Register */
51 #define IMX21LCDC_LAUSCCR 0x0084 /* LCDC AUS Mode Cursor Control Register */
52 #define IMX21LCDC_BGLUT 0x0800 /* Background Lookup Table */
53 #define IMX21LCDC_GWLUT 0x0C00 /* Graphic Window Lookup Table */
55 #define IMX21LCDC_LCPR_CC0 BIT(30) /* Cursor Control Bit 0 */
56 #define IMX21LCDC_LCPR_CC1 BIT(31) /* Cursor Control Bit 1 */
58 /* Values HSYNC, VSYNC and Framesize Register */
59 #define IMX21LCDC_LHCR_HWIDTH GENMASK(31, 26)
60 #define IMX21LCDC_LHCR_HFPORCH GENMASK(15, 8) /* H_WAIT_1 in the i.MX25 Reference manual */
61 #define IMX21LCDC_LHCR_HBPORCH GENMASK(7, 0) /* H_WAIT_2 in the i.MX25 Reference manual */
63 #define IMX21LCDC_LVCR_VWIDTH GENMASK(31, 26)
64 #define IMX21LCDC_LVCR_VFPORCH GENMASK(15, 8) /* V_WAIT_1 in the i.MX25 Reference manual */
65 #define IMX21LCDC_LVCR_VBPORCH GENMASK(7, 0) /* V_WAIT_2 in the i.MX25 Reference manual */
67 #define IMX21LCDC_LSR_XMAX GENMASK(25, 20)
68 #define IMX21LCDC_LSR_YMAX GENMASK(9, 0)
70 /* Values for LPCR Register */
71 #define IMX21LCDC_LPCR_PCD GENMASK(5, 0)
72 #define IMX21LCDC_LPCR_SHARP BIT(6)
73 #define IMX21LCDC_LPCR_SCLKSEL BIT(7)
74 #define IMX21LCDC_LPCR_ACD GENMASK(14, 8)
75 #define IMX21LCDC_LPCR_ACDSEL BIT(15)
76 #define IMX21LCDC_LPCR_REV_VS BIT(16)
77 #define IMX21LCDC_LPCR_SWAP_SEL BIT(17)
78 #define IMX21LCDC_LPCR_END_SEL BIT(18)
79 #define IMX21LCDC_LPCR_SCLKIDLE BIT(19)
80 #define IMX21LCDC_LPCR_OEPOL BIT(20)
81 #define IMX21LCDC_LPCR_CLKPOL BIT(21)
82 #define IMX21LCDC_LPCR_LPPOL BIT(22)
83 #define IMX21LCDC_LPCR_FLMPOL BIT(23)
84 #define IMX21LCDC_LPCR_PIXPOL BIT(24)
85 #define IMX21LCDC_LPCR_BPIX GENMASK(27, 25)
86 #define IMX21LCDC_LPCR_PBSIZ GENMASK(29, 28)
87 #define IMX21LCDC_LPCR_COLOR BIT(30)
88 #define IMX21LCDC_LPCR_TFT BIT(31)
90 #define INTR_EOF BIT(1) /* VBLANK Interrupt Bit */
92 #define BPP_RGB565 0x05
93 #define BPP_XRGB8888 0x07
95 #define LCDC_MIN_XRES 64
96 #define LCDC_MIN_YRES 64
98 #define LCDC_MAX_XRES 1024
99 #define LCDC_MAX_YRES 1024
102 struct drm_device drm;
103 struct drm_simple_display_pipe pipe;
104 struct drm_connector *connector;
112 static const u32 imx_lcdc_formats[] = {
113 DRM_FORMAT_RGB565, DRM_FORMAT_XRGB8888,
116 static inline struct imx_lcdc *imx_lcdc_from_drmdev(struct drm_device *drm)
118 return container_of(drm, struct imx_lcdc, drm);
121 static unsigned int imx_lcdc_get_format(unsigned int drm_format)
123 switch (drm_format) {
125 DRM_WARN("Format not supported - fallback to XRGB8888\n");
128 case DRM_FORMAT_XRGB8888:
131 case DRM_FORMAT_RGB565:
136 static void imx_lcdc_update_hw_registers(struct drm_simple_display_pipe *pipe,
137 struct drm_plane_state *old_state,
140 struct drm_crtc *crtc = &pipe->crtc;
141 struct drm_plane_state *new_state = pipe->plane.state;
142 struct drm_framebuffer *fb = new_state->fb;
143 struct imx_lcdc *lcdc = imx_lcdc_from_drmdev(pipe->crtc.dev);
144 u32 lpcr, lvcr, lhcr;
148 addr = drm_fb_dma_get_gem_addr(fb, new_state, 0);
149 /* The LSSAR register specifies the LCD screen start address (SSA). */
150 writel(addr, lcdc->base + IMX21LCDC_LSSAR);
155 /* Disable PER clock to make register write possible */
156 if (old_state && old_state->crtc && old_state->crtc->enabled)
157 clk_disable_unprepare(lcdc->clk_per);
160 framesize = FIELD_PREP(IMX21LCDC_LSR_XMAX, crtc->mode.hdisplay >> 4) |
161 FIELD_PREP(IMX21LCDC_LSR_YMAX, crtc->mode.vdisplay);
162 writel(framesize, lcdc->base + IMX21LCDC_LSR);
165 lhcr = FIELD_PREP(IMX21LCDC_LHCR_HFPORCH, crtc->mode.hsync_start - crtc->mode.hdisplay - 1) |
166 FIELD_PREP(IMX21LCDC_LHCR_HWIDTH, crtc->mode.hsync_end - crtc->mode.hsync_start - 1) |
167 FIELD_PREP(IMX21LCDC_LHCR_HBPORCH, crtc->mode.htotal - crtc->mode.hsync_end - 3);
168 writel(lhcr, lcdc->base + IMX21LCDC_LHCR);
171 lvcr = FIELD_PREP(IMX21LCDC_LVCR_VFPORCH, crtc->mode.vsync_start - crtc->mode.vdisplay) |
172 FIELD_PREP(IMX21LCDC_LVCR_VWIDTH, crtc->mode.vsync_end - crtc->mode.vsync_start) |
173 FIELD_PREP(IMX21LCDC_LVCR_VBPORCH, crtc->mode.vtotal - crtc->mode.vsync_end);
174 writel(lvcr, lcdc->base + IMX21LCDC_LVCR);
176 lpcr = readl(lcdc->base + IMX21LCDC_LPCR);
177 lpcr &= ~IMX21LCDC_LPCR_BPIX;
178 lpcr |= FIELD_PREP(IMX21LCDC_LPCR_BPIX, imx_lcdc_get_format(fb->format->format));
179 writel(lpcr, lcdc->base + IMX21LCDC_LPCR);
181 /* Virtual Page Width */
182 writel(new_state->fb->pitches[0] / 4, lcdc->base + IMX21LCDC_LVPWR);
184 /* Enable PER clock */
185 if (new_state->crtc->enabled)
186 clk_prepare_enable(lcdc->clk_per);
189 static void imx_lcdc_pipe_enable(struct drm_simple_display_pipe *pipe,
190 struct drm_crtc_state *crtc_state,
191 struct drm_plane_state *plane_state)
196 struct imx_lcdc *lcdc = imx_lcdc_from_drmdev(pipe->crtc.dev);
197 struct drm_display_mode *mode = &pipe->crtc.mode;
198 struct drm_display_info *disp_info = &lcdc->connector->display_info;
199 const int hsync_pol = (mode->flags & DRM_MODE_FLAG_PHSYNC) ? 0 : 1;
200 const int vsync_pol = (mode->flags & DRM_MODE_FLAG_PVSYNC) ? 0 : 1;
201 const int data_enable_pol =
202 (disp_info->bus_flags & DRM_BUS_FLAG_DE_HIGH) ? 0 : 1;
204 (disp_info->bus_flags & DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE) ? 0 : 1;
206 clk_div = DIV_ROUND_CLOSEST_ULL(clk_get_rate(lcdc->clk_per),
208 bpp = imx_lcdc_get_format(plane_state->fb->format->format);
210 writel(FIELD_PREP(IMX21LCDC_LPCR_PCD, clk_div - 1) |
211 FIELD_PREP(IMX21LCDC_LPCR_LPPOL, hsync_pol) |
212 FIELD_PREP(IMX21LCDC_LPCR_FLMPOL, vsync_pol) |
213 FIELD_PREP(IMX21LCDC_LPCR_OEPOL, data_enable_pol) |
214 FIELD_PREP(IMX21LCDC_LPCR_TFT, 1) |
215 FIELD_PREP(IMX21LCDC_LPCR_COLOR, 1) |
216 FIELD_PREP(IMX21LCDC_LPCR_PBSIZ, 3) |
217 FIELD_PREP(IMX21LCDC_LPCR_BPIX, bpp) |
218 FIELD_PREP(IMX21LCDC_LPCR_SCLKSEL, 1) |
219 FIELD_PREP(IMX21LCDC_LPCR_PIXPOL, 0) |
220 FIELD_PREP(IMX21LCDC_LPCR_CLKPOL, clk_pol),
221 lcdc->base + IMX21LCDC_LPCR);
223 /* 0px panning offset */
224 writel(0x00000000, lcdc->base + IMX21LCDC_LPOR);
226 /* disable hardware cursor */
227 writel(readl(lcdc->base + IMX21LCDC_LCPR) & ~(IMX21LCDC_LCPR_CC0 | IMX21LCDC_LCPR_CC1),
228 lcdc->base + IMX21LCDC_LCPR);
230 ret = clk_prepare_enable(lcdc->clk_ipg);
232 dev_err(pipe->crtc.dev->dev, "Cannot enable ipg clock: %pe\n", ERR_PTR(ret));
235 ret = clk_prepare_enable(lcdc->clk_ahb);
237 dev_err(pipe->crtc.dev->dev, "Cannot enable ahb clock: %pe\n", ERR_PTR(ret));
239 clk_disable_unprepare(lcdc->clk_ipg);
244 imx_lcdc_update_hw_registers(pipe, NULL, true);
246 /* Enable VBLANK Interrupt */
247 writel(INTR_EOF, lcdc->base + IMX21LCDC_LIER);
250 static void imx_lcdc_pipe_disable(struct drm_simple_display_pipe *pipe)
252 struct imx_lcdc *lcdc = imx_lcdc_from_drmdev(pipe->crtc.dev);
253 struct drm_crtc *crtc = &lcdc->pipe.crtc;
254 struct drm_pending_vblank_event *event;
256 clk_disable_unprepare(lcdc->clk_ahb);
257 clk_disable_unprepare(lcdc->clk_ipg);
259 if (pipe->crtc.enabled)
260 clk_disable_unprepare(lcdc->clk_per);
262 spin_lock_irq(&lcdc->drm.event_lock);
263 event = crtc->state->event;
265 crtc->state->event = NULL;
266 drm_crtc_send_vblank_event(crtc, event);
268 spin_unlock_irq(&lcdc->drm.event_lock);
270 /* Disable VBLANK Interrupt */
271 writel(0, lcdc->base + IMX21LCDC_LIER);
274 static int imx_lcdc_pipe_check(struct drm_simple_display_pipe *pipe,
275 struct drm_plane_state *plane_state,
276 struct drm_crtc_state *crtc_state)
278 const struct drm_display_mode *mode = &crtc_state->mode;
279 const struct drm_display_mode *old_mode = &pipe->crtc.state->mode;
281 if (mode->hdisplay < LCDC_MIN_XRES || mode->hdisplay > LCDC_MAX_XRES ||
282 mode->vdisplay < LCDC_MIN_YRES || mode->vdisplay > LCDC_MAX_YRES ||
283 mode->hdisplay % 0x10) { /* must be multiple of 16 */
284 drm_err(pipe->crtc.dev, "unsupported display mode (%u x %u)\n",
285 mode->hdisplay, mode->vdisplay);
289 crtc_state->mode_changed =
290 old_mode->hdisplay != mode->hdisplay ||
291 old_mode->vdisplay != mode->vdisplay;
296 static void imx_lcdc_pipe_update(struct drm_simple_display_pipe *pipe,
297 struct drm_plane_state *old_state)
299 struct drm_crtc *crtc = &pipe->crtc;
300 struct drm_pending_vblank_event *event = crtc->state->event;
301 struct drm_plane_state *new_state = pipe->plane.state;
302 struct drm_framebuffer *fb = new_state->fb;
303 struct drm_framebuffer *old_fb = old_state->fb;
304 struct drm_crtc *old_crtc = old_state->crtc;
305 bool mode_changed = false;
307 if (old_fb && old_fb->format != fb->format)
309 else if (old_crtc != crtc)
312 imx_lcdc_update_hw_registers(pipe, old_state, mode_changed);
315 crtc->state->event = NULL;
317 spin_lock_irq(&crtc->dev->event_lock);
319 if (crtc->state->active && drm_crtc_vblank_get(crtc) == 0)
320 drm_crtc_arm_vblank_event(crtc, event);
322 drm_crtc_send_vblank_event(crtc, event);
324 spin_unlock_irq(&crtc->dev->event_lock);
328 static const struct drm_simple_display_pipe_funcs imx_lcdc_pipe_funcs = {
329 .enable = imx_lcdc_pipe_enable,
330 .disable = imx_lcdc_pipe_disable,
331 .check = imx_lcdc_pipe_check,
332 .update = imx_lcdc_pipe_update,
335 static const struct drm_mode_config_funcs imx_lcdc_mode_config_funcs = {
336 .fb_create = drm_gem_fb_create_with_dirty,
337 .atomic_check = drm_atomic_helper_check,
338 .atomic_commit = drm_atomic_helper_commit,
341 static const struct drm_mode_config_helper_funcs imx_lcdc_mode_config_helpers = {
342 .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
345 static void imx_lcdc_release(struct drm_device *drm)
347 struct imx_lcdc *lcdc = imx_lcdc_from_drmdev(drm);
349 drm_kms_helper_poll_fini(drm);
353 DEFINE_DRM_GEM_DMA_FOPS(imx_lcdc_drm_fops);
355 static struct drm_driver imx_lcdc_drm_driver = {
356 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
357 .fops = &imx_lcdc_drm_fops,
358 DRM_GEM_DMA_DRIVER_OPS_VMAP,
359 .release = imx_lcdc_release,
361 .desc = "i.MX LCDC driver",
365 static const struct of_device_id imx_lcdc_of_dev_id[] = {
367 .compatible = "fsl,imx21-lcdc",
370 .compatible = "fsl,imx25-lcdc",
374 MODULE_DEVICE_TABLE(of, imx_lcdc_of_dev_id);
376 static irqreturn_t imx_lcdc_irq_handler(int irq, void *arg)
378 struct imx_lcdc *lcdc = arg;
379 struct drm_crtc *crtc = &lcdc->pipe.crtc;
382 status = readl(lcdc->base + IMX21LCDC_LISR);
384 if (status & INTR_EOF) {
385 drm_crtc_handle_vblank(crtc);
392 static int imx_lcdc_probe(struct platform_device *pdev)
394 struct imx_lcdc *lcdc;
395 struct drm_device *drm;
396 struct drm_bridge *bridge;
399 struct device *dev = &pdev->dev;
401 lcdc = devm_drm_dev_alloc(dev, &imx_lcdc_drm_driver,
402 struct imx_lcdc, drm);
404 return PTR_ERR(lcdc);
408 lcdc->base = devm_platform_ioremap_resource(pdev, 0);
409 if (IS_ERR(lcdc->base))
410 return dev_err_probe(dev, PTR_ERR(lcdc->base), "Cannot get IO memory\n");
412 bridge = devm_drm_of_get_bridge(dev, dev->of_node, 0, 0);
414 return dev_err_probe(dev, PTR_ERR(bridge), "Failed to find bridge\n");
417 lcdc->clk_ipg = devm_clk_get(dev, "ipg");
418 if (IS_ERR(lcdc->clk_ipg))
419 return dev_err_probe(dev, PTR_ERR(lcdc->clk_ipg), "Failed to get %s clk\n", "ipg");
421 lcdc->clk_ahb = devm_clk_get(dev, "ahb");
422 if (IS_ERR(lcdc->clk_ahb))
423 return dev_err_probe(dev, PTR_ERR(lcdc->clk_ahb), "Failed to get %s clk\n", "ahb");
425 lcdc->clk_per = devm_clk_get(dev, "per");
426 if (IS_ERR(lcdc->clk_per))
427 return dev_err_probe(dev, PTR_ERR(lcdc->clk_per), "Failed to get %s clk\n", "per");
429 ret = dma_set_mask_and_coherent(drm->dev, DMA_BIT_MASK(32));
431 return dev_err_probe(dev, ret, "Cannot set DMA Mask\n");
434 ret = drmm_mode_config_init(drm);
436 return dev_err_probe(dev, ret, "Cannot initialize mode configuration structure\n");
438 /* CRTC, Plane, Encoder */
439 ret = drm_simple_display_pipe_init(drm, &lcdc->pipe,
440 &imx_lcdc_pipe_funcs,
442 ARRAY_SIZE(imx_lcdc_formats), NULL, NULL);
444 return dev_err_probe(drm->dev, ret, "Cannot setup simple display pipe\n");
446 ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
448 return dev_err_probe(drm->dev, ret, "Failed to initialize vblank\n");
450 ret = drm_bridge_attach(&lcdc->pipe.encoder, bridge, NULL, DRM_BRIDGE_ATTACH_NO_CONNECTOR);
452 return dev_err_probe(drm->dev, ret, "Cannot attach bridge\n");
454 lcdc->connector = drm_bridge_connector_init(drm, &lcdc->pipe.encoder);
455 if (IS_ERR(lcdc->connector))
456 return dev_err_probe(drm->dev, PTR_ERR(lcdc->connector), "Cannot init bridge connector\n");
458 drm_connector_attach_encoder(lcdc->connector, &lcdc->pipe.encoder);
461 * The LCDC controller does not have an enable bit. The
462 * controller starts directly when the clocks are enabled.
463 * If the clocks are enabled when the controller is not yet
464 * programmed with proper register values (enabled at the
465 * bootloader, for example) then it just goes into some undefined
467 * To avoid this issue, let's enable and disable LCDC IPG,
468 * PER and AHB clock so that we force some kind of 'reset'
472 ret = clk_prepare_enable(lcdc->clk_ipg);
474 return dev_err_probe(dev, ret, "Cannot enable ipg clock\n");
475 clk_disable_unprepare(lcdc->clk_ipg);
477 ret = clk_prepare_enable(lcdc->clk_per);
479 return dev_err_probe(dev, ret, "Cannot enable per clock\n");
480 clk_disable_unprepare(lcdc->clk_per);
482 ret = clk_prepare_enable(lcdc->clk_ahb);
484 return dev_err_probe(dev, ret, "Cannot enable ahb clock\n");
485 clk_disable_unprepare(lcdc->clk_ahb);
487 drm->mode_config.min_width = LCDC_MIN_XRES;
488 drm->mode_config.max_width = LCDC_MAX_XRES;
489 drm->mode_config.min_height = LCDC_MIN_YRES;
490 drm->mode_config.max_height = LCDC_MAX_YRES;
491 drm->mode_config.preferred_depth = 16;
492 drm->mode_config.funcs = &imx_lcdc_mode_config_funcs;
493 drm->mode_config.helper_private = &imx_lcdc_mode_config_helpers;
495 drm_mode_config_reset(drm);
497 irq = platform_get_irq(pdev, 0);
503 ret = devm_request_irq(dev, irq, imx_lcdc_irq_handler, 0, "imx-lcdc", lcdc);
505 return dev_err_probe(drm->dev, ret, "Failed to install IRQ handler\n");
507 platform_set_drvdata(pdev, drm);
509 ret = drm_dev_register(&lcdc->drm, 0);
511 return dev_err_probe(dev, ret, "Cannot register device\n");
513 drm_fbdev_generic_setup(drm, 0);
518 static int imx_lcdc_remove(struct platform_device *pdev)
520 struct drm_device *drm = platform_get_drvdata(pdev);
522 drm_dev_unregister(drm);
523 drm_atomic_helper_shutdown(drm);
528 static void imx_lcdc_shutdown(struct platform_device *pdev)
530 drm_atomic_helper_shutdown(platform_get_drvdata(pdev));
533 static struct platform_driver imx_lcdc_driver = {
536 .of_match_table = imx_lcdc_of_dev_id,
538 .probe = imx_lcdc_probe,
539 .remove = imx_lcdc_remove,
540 .shutdown = imx_lcdc_shutdown,
542 module_platform_driver(imx_lcdc_driver);
545 MODULE_DESCRIPTION("Freescale i.MX LCDC driver");
546 MODULE_LICENSE("GPL");