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