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