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