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_irq.h>
28 #include <drm/drm_mode_config.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 	},
55 	[MXSFB_V4] = {
56 		.transfer_count	= LCDC_V4_TRANSFER_COUNT,
57 		.cur_buf	= LCDC_V4_CUR_BUF,
58 		.next_buf	= LCDC_V4_NEXT_BUF,
59 		.hs_wdth_mask	= 0x3fff,
60 		.hs_wdth_shift	= 18,
61 		.has_overlay	= false,
62 	},
63 	[MXSFB_V6] = {
64 		.transfer_count	= LCDC_V4_TRANSFER_COUNT,
65 		.cur_buf	= LCDC_V4_CUR_BUF,
66 		.next_buf	= LCDC_V4_NEXT_BUF,
67 		.hs_wdth_mask	= 0x3fff,
68 		.hs_wdth_shift	= 18,
69 		.has_overlay	= true,
70 	},
71 };
72 
mxsfb_enable_axi_clk(struct mxsfb_drm_private * mxsfb)73 void mxsfb_enable_axi_clk(struct mxsfb_drm_private *mxsfb)
74 {
75 	if (mxsfb->clk_axi)
76 		clk_prepare_enable(mxsfb->clk_axi);
77 }
78 
mxsfb_disable_axi_clk(struct mxsfb_drm_private * mxsfb)79 void mxsfb_disable_axi_clk(struct mxsfb_drm_private *mxsfb)
80 {
81 	if (mxsfb->clk_axi)
82 		clk_disable_unprepare(mxsfb->clk_axi);
83 }
84 
85 static struct drm_framebuffer *
mxsfb_fb_create(struct drm_device * dev,struct drm_file * file_priv,const struct drm_mode_fb_cmd2 * mode_cmd)86 mxsfb_fb_create(struct drm_device *dev, struct drm_file *file_priv,
87 		const struct drm_mode_fb_cmd2 *mode_cmd)
88 {
89 	const struct drm_format_info *info;
90 
91 	info = drm_get_format_info(dev, mode_cmd);
92 	if (!info)
93 		return ERR_PTR(-EINVAL);
94 
95 	if (mode_cmd->width * info->cpp[0] != mode_cmd->pitches[0]) {
96 		dev_dbg(dev->dev, "Invalid pitch: fb width must match pitch\n");
97 		return ERR_PTR(-EINVAL);
98 	}
99 
100 	return drm_gem_fb_create(dev, file_priv, mode_cmd);
101 }
102 
103 static const struct drm_mode_config_funcs mxsfb_mode_config_funcs = {
104 	.fb_create		= mxsfb_fb_create,
105 	.atomic_check		= drm_atomic_helper_check,
106 	.atomic_commit		= drm_atomic_helper_commit,
107 };
108 
109 static const struct drm_mode_config_helper_funcs mxsfb_mode_config_helpers = {
110 	.atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
111 };
112 
mxsfb_attach_bridge(struct mxsfb_drm_private * mxsfb)113 static int mxsfb_attach_bridge(struct mxsfb_drm_private *mxsfb)
114 {
115 	struct drm_device *drm = mxsfb->drm;
116 	struct drm_connector_list_iter iter;
117 	struct drm_panel *panel;
118 	struct drm_bridge *bridge;
119 	int ret;
120 
121 	ret = drm_of_find_panel_or_bridge(drm->dev->of_node, 0, 0, &panel,
122 					  &bridge);
123 	if (ret)
124 		return ret;
125 
126 	if (panel) {
127 		bridge = devm_drm_panel_bridge_add_typed(drm->dev, panel,
128 							 DRM_MODE_CONNECTOR_DPI);
129 		if (IS_ERR(bridge))
130 			return PTR_ERR(bridge);
131 	}
132 
133 	if (!bridge)
134 		return -ENODEV;
135 
136 	ret = drm_bridge_attach(&mxsfb->encoder, bridge, NULL, 0);
137 	if (ret) {
138 		DRM_DEV_ERROR(drm->dev,
139 			      "failed to attach bridge: %d\n", ret);
140 		return ret;
141 	}
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_load(struct drm_device * drm,const struct mxsfb_devdata * devdata)156 static int mxsfb_load(struct drm_device *drm,
157 		      const struct mxsfb_devdata *devdata)
158 {
159 	struct platform_device *pdev = to_platform_device(drm->dev);
160 	struct mxsfb_drm_private *mxsfb;
161 	struct resource *res;
162 	int ret;
163 
164 	mxsfb = devm_kzalloc(&pdev->dev, sizeof(*mxsfb), GFP_KERNEL);
165 	if (!mxsfb)
166 		return -ENOMEM;
167 
168 	mxsfb->drm = drm;
169 	drm->dev_private = mxsfb;
170 	mxsfb->devdata = devdata;
171 
172 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
173 	mxsfb->base = devm_ioremap_resource(drm->dev, res);
174 	if (IS_ERR(mxsfb->base))
175 		return PTR_ERR(mxsfb->base);
176 
177 	mxsfb->clk = devm_clk_get(drm->dev, NULL);
178 	if (IS_ERR(mxsfb->clk))
179 		return PTR_ERR(mxsfb->clk);
180 
181 	mxsfb->clk_axi = devm_clk_get(drm->dev, "axi");
182 	if (IS_ERR(mxsfb->clk_axi))
183 		mxsfb->clk_axi = NULL;
184 
185 	mxsfb->clk_disp_axi = devm_clk_get(drm->dev, "disp_axi");
186 	if (IS_ERR(mxsfb->clk_disp_axi))
187 		mxsfb->clk_disp_axi = NULL;
188 
189 	ret = dma_set_mask_and_coherent(drm->dev, DMA_BIT_MASK(32));
190 	if (ret)
191 		return ret;
192 
193 	pm_runtime_enable(drm->dev);
194 
195 	/* Modeset init */
196 	drm_mode_config_init(drm);
197 
198 	ret = mxsfb_kms_init(mxsfb);
199 	if (ret < 0) {
200 		dev_err(drm->dev, "Failed to initialize KMS pipeline\n");
201 		goto err_vblank;
202 	}
203 
204 	ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
205 	if (ret < 0) {
206 		dev_err(drm->dev, "Failed to initialise vblank\n");
207 		goto err_vblank;
208 	}
209 
210 	/* Start with vertical blanking interrupt reporting disabled. */
211 	drm_crtc_vblank_off(&mxsfb->crtc);
212 
213 	ret = mxsfb_attach_bridge(mxsfb);
214 	if (ret) {
215 		dev_err(drm->dev, "Cannot connect bridge: %d\n", ret);
216 		goto err_vblank;
217 	}
218 
219 	drm->mode_config.min_width	= MXSFB_MIN_XRES;
220 	drm->mode_config.min_height	= MXSFB_MIN_YRES;
221 	drm->mode_config.max_width	= MXSFB_MAX_XRES;
222 	drm->mode_config.max_height	= MXSFB_MAX_YRES;
223 	drm->mode_config.funcs		= &mxsfb_mode_config_funcs;
224 	drm->mode_config.helper_private	= &mxsfb_mode_config_helpers;
225 
226 	drm_mode_config_reset(drm);
227 
228 	pm_runtime_get_sync(drm->dev);
229 	ret = drm_irq_install(drm, platform_get_irq(pdev, 0));
230 	pm_runtime_put_sync(drm->dev);
231 
232 	if (ret < 0) {
233 		dev_err(drm->dev, "Failed to install IRQ handler\n");
234 		goto err_vblank;
235 	}
236 
237 	drm_kms_helper_poll_init(drm);
238 
239 	platform_set_drvdata(pdev, drm);
240 
241 	drm_helper_hpd_irq_event(drm);
242 
243 	return 0;
244 
245 err_vblank:
246 	pm_runtime_disable(drm->dev);
247 
248 	return ret;
249 }
250 
mxsfb_unload(struct drm_device * drm)251 static void mxsfb_unload(struct drm_device *drm)
252 {
253 	drm_kms_helper_poll_fini(drm);
254 	drm_mode_config_cleanup(drm);
255 
256 	pm_runtime_get_sync(drm->dev);
257 	drm_irq_uninstall(drm);
258 	pm_runtime_put_sync(drm->dev);
259 
260 	drm->dev_private = NULL;
261 
262 	pm_runtime_disable(drm->dev);
263 }
264 
mxsfb_irq_disable(struct drm_device * drm)265 static void mxsfb_irq_disable(struct drm_device *drm)
266 {
267 	struct mxsfb_drm_private *mxsfb = drm->dev_private;
268 
269 	mxsfb_enable_axi_clk(mxsfb);
270 	mxsfb->crtc.funcs->disable_vblank(&mxsfb->crtc);
271 	mxsfb_disable_axi_clk(mxsfb);
272 }
273 
mxsfb_irq_handler(int irq,void * data)274 static irqreturn_t mxsfb_irq_handler(int irq, void *data)
275 {
276 	struct drm_device *drm = data;
277 	struct mxsfb_drm_private *mxsfb = drm->dev_private;
278 	u32 reg;
279 
280 	reg = readl(mxsfb->base + LCDC_CTRL1);
281 
282 	if (reg & CTRL1_CUR_FRAME_DONE_IRQ)
283 		drm_crtc_handle_vblank(&mxsfb->crtc);
284 
285 	writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR);
286 
287 	return IRQ_HANDLED;
288 }
289 
290 DEFINE_DRM_GEM_CMA_FOPS(fops);
291 
292 static struct drm_driver mxsfb_driver = {
293 	.driver_features	= DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
294 	.irq_handler		= mxsfb_irq_handler,
295 	.irq_preinstall		= mxsfb_irq_disable,
296 	.irq_uninstall		= mxsfb_irq_disable,
297 	DRM_GEM_CMA_DRIVER_OPS,
298 	.fops	= &fops,
299 	.name	= "mxsfb-drm",
300 	.desc	= "MXSFB Controller DRM",
301 	.date	= "20160824",
302 	.major	= 1,
303 	.minor	= 0,
304 };
305 
306 static const struct of_device_id mxsfb_dt_ids[] = {
307 	{ .compatible = "fsl,imx23-lcdif", .data = &mxsfb_devdata[MXSFB_V3], },
308 	{ .compatible = "fsl,imx28-lcdif", .data = &mxsfb_devdata[MXSFB_V4], },
309 	{ .compatible = "fsl,imx6sx-lcdif", .data = &mxsfb_devdata[MXSFB_V6], },
310 	{ /* sentinel */ }
311 };
312 MODULE_DEVICE_TABLE(of, mxsfb_dt_ids);
313 
mxsfb_probe(struct platform_device * pdev)314 static int mxsfb_probe(struct platform_device *pdev)
315 {
316 	struct drm_device *drm;
317 	const struct of_device_id *of_id =
318 			of_match_device(mxsfb_dt_ids, &pdev->dev);
319 	int ret;
320 
321 	if (!pdev->dev.of_node)
322 		return -ENODEV;
323 
324 	drm = drm_dev_alloc(&mxsfb_driver, &pdev->dev);
325 	if (IS_ERR(drm))
326 		return PTR_ERR(drm);
327 
328 	ret = mxsfb_load(drm, of_id->data);
329 	if (ret)
330 		goto err_free;
331 
332 	ret = drm_dev_register(drm, 0);
333 	if (ret)
334 		goto err_unload;
335 
336 	drm_fbdev_generic_setup(drm, 32);
337 
338 	return 0;
339 
340 err_unload:
341 	mxsfb_unload(drm);
342 err_free:
343 	drm_dev_put(drm);
344 
345 	return ret;
346 }
347 
mxsfb_remove(struct platform_device * pdev)348 static int mxsfb_remove(struct platform_device *pdev)
349 {
350 	struct drm_device *drm = platform_get_drvdata(pdev);
351 
352 	drm_dev_unregister(drm);
353 	mxsfb_unload(drm);
354 	drm_dev_put(drm);
355 
356 	return 0;
357 }
358 
359 #ifdef CONFIG_PM_SLEEP
mxsfb_suspend(struct device * dev)360 static int mxsfb_suspend(struct device *dev)
361 {
362 	struct drm_device *drm = dev_get_drvdata(dev);
363 
364 	return drm_mode_config_helper_suspend(drm);
365 }
366 
mxsfb_resume(struct device * dev)367 static int mxsfb_resume(struct device *dev)
368 {
369 	struct drm_device *drm = dev_get_drvdata(dev);
370 
371 	return drm_mode_config_helper_resume(drm);
372 }
373 #endif
374 
375 static const struct dev_pm_ops mxsfb_pm_ops = {
376 	SET_SYSTEM_SLEEP_PM_OPS(mxsfb_suspend, mxsfb_resume)
377 };
378 
379 static struct platform_driver mxsfb_platform_driver = {
380 	.probe		= mxsfb_probe,
381 	.remove		= mxsfb_remove,
382 	.driver	= {
383 		.name		= "mxsfb",
384 		.of_match_table	= mxsfb_dt_ids,
385 		.pm		= &mxsfb_pm_ops,
386 	},
387 };
388 
389 module_platform_driver(mxsfb_platform_driver);
390 
391 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
392 MODULE_DESCRIPTION("Freescale MXS DRM/KMS driver");
393 MODULE_LICENSE("GPL");
394