xref: /openbmc/linux/drivers/gpu/drm/mxsfb/mxsfb_drv.c (revision feac8c8b)
1 /*
2  * Copyright (C) 2016 Marek Vasut <marex@denx.de>
3  *
4  * This code is based on drivers/video/fbdev/mxsfb.c :
5  * Copyright (C) 2010 Juergen Beisert, Pengutronix
6  * Copyright (C) 2008-2009 Freescale Semiconductor, Inc. All Rights Reserved.
7  * Copyright (C) 2008 Embedded Alley Solutions, Inc All Rights Reserved.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  */
18 
19 #include <linux/module.h>
20 #include <linux/spinlock.h>
21 #include <linux/clk.h>
22 #include <linux/component.h>
23 #include <linux/list.h>
24 #include <linux/of_device.h>
25 #include <linux/of_graph.h>
26 #include <linux/of_reserved_mem.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/reservation.h>
29 
30 #include <drm/drmP.h>
31 #include <drm/drm_atomic.h>
32 #include <drm/drm_atomic_helper.h>
33 #include <drm/drm_crtc.h>
34 #include <drm/drm_crtc_helper.h>
35 #include <drm/drm_fb_helper.h>
36 #include <drm/drm_fb_cma_helper.h>
37 #include <drm/drm_gem_cma_helper.h>
38 #include <drm/drm_gem_framebuffer_helper.h>
39 #include <drm/drm_of.h>
40 #include <drm/drm_panel.h>
41 #include <drm/drm_simple_kms_helper.h>
42 
43 #include "mxsfb_drv.h"
44 #include "mxsfb_regs.h"
45 
46 enum mxsfb_devtype {
47 	MXSFB_V3,
48 	MXSFB_V4,
49 };
50 
51 static const struct mxsfb_devdata mxsfb_devdata[] = {
52 	[MXSFB_V3] = {
53 		.transfer_count	= LCDC_V3_TRANSFER_COUNT,
54 		.cur_buf	= LCDC_V3_CUR_BUF,
55 		.next_buf	= LCDC_V3_NEXT_BUF,
56 		.debug0		= LCDC_V3_DEBUG0,
57 		.hs_wdth_mask	= 0xff,
58 		.hs_wdth_shift	= 24,
59 		.ipversion	= 3,
60 	},
61 	[MXSFB_V4] = {
62 		.transfer_count	= LCDC_V4_TRANSFER_COUNT,
63 		.cur_buf	= LCDC_V4_CUR_BUF,
64 		.next_buf	= LCDC_V4_NEXT_BUF,
65 		.debug0		= LCDC_V4_DEBUG0,
66 		.hs_wdth_mask	= 0x3fff,
67 		.hs_wdth_shift	= 18,
68 		.ipversion	= 4,
69 	},
70 };
71 
72 static const uint32_t mxsfb_formats[] = {
73 	DRM_FORMAT_XRGB8888,
74 	DRM_FORMAT_RGB565
75 };
76 
77 static struct mxsfb_drm_private *
78 drm_pipe_to_mxsfb_drm_private(struct drm_simple_display_pipe *pipe)
79 {
80 	return container_of(pipe, struct mxsfb_drm_private, pipe);
81 }
82 
83 void mxsfb_enable_axi_clk(struct mxsfb_drm_private *mxsfb)
84 {
85 	if (mxsfb->clk_axi)
86 		clk_prepare_enable(mxsfb->clk_axi);
87 }
88 
89 void mxsfb_disable_axi_clk(struct mxsfb_drm_private *mxsfb)
90 {
91 	if (mxsfb->clk_axi)
92 		clk_disable_unprepare(mxsfb->clk_axi);
93 }
94 
95 static const struct drm_mode_config_funcs mxsfb_mode_config_funcs = {
96 	.fb_create		= drm_gem_fb_create,
97 	.atomic_check		= drm_atomic_helper_check,
98 	.atomic_commit		= drm_atomic_helper_commit,
99 };
100 
101 static void mxsfb_pipe_enable(struct drm_simple_display_pipe *pipe,
102 			      struct drm_crtc_state *crtc_state)
103 {
104 	struct mxsfb_drm_private *mxsfb = drm_pipe_to_mxsfb_drm_private(pipe);
105 
106 	drm_panel_prepare(mxsfb->panel);
107 	mxsfb_crtc_enable(mxsfb);
108 	drm_panel_enable(mxsfb->panel);
109 }
110 
111 static void mxsfb_pipe_disable(struct drm_simple_display_pipe *pipe)
112 {
113 	struct mxsfb_drm_private *mxsfb = drm_pipe_to_mxsfb_drm_private(pipe);
114 
115 	drm_panel_disable(mxsfb->panel);
116 	mxsfb_crtc_disable(mxsfb);
117 	drm_panel_unprepare(mxsfb->panel);
118 }
119 
120 static void mxsfb_pipe_update(struct drm_simple_display_pipe *pipe,
121 			      struct drm_plane_state *plane_state)
122 {
123 	struct mxsfb_drm_private *mxsfb = drm_pipe_to_mxsfb_drm_private(pipe);
124 
125 	mxsfb_plane_atomic_update(mxsfb, plane_state);
126 }
127 
128 static int mxsfb_pipe_prepare_fb(struct drm_simple_display_pipe *pipe,
129 				 struct drm_plane_state *plane_state)
130 {
131 	return drm_gem_fb_prepare_fb(&pipe->plane, plane_state);
132 }
133 
134 static struct drm_simple_display_pipe_funcs mxsfb_funcs = {
135 	.enable		= mxsfb_pipe_enable,
136 	.disable	= mxsfb_pipe_disable,
137 	.update		= mxsfb_pipe_update,
138 	.prepare_fb	= mxsfb_pipe_prepare_fb,
139 };
140 
141 static int mxsfb_load(struct drm_device *drm, unsigned long flags)
142 {
143 	struct platform_device *pdev = to_platform_device(drm->dev);
144 	struct mxsfb_drm_private *mxsfb;
145 	struct resource *res;
146 	int ret;
147 
148 	mxsfb = devm_kzalloc(&pdev->dev, sizeof(*mxsfb), GFP_KERNEL);
149 	if (!mxsfb)
150 		return -ENOMEM;
151 
152 	drm->dev_private = mxsfb;
153 	mxsfb->devdata = &mxsfb_devdata[pdev->id_entry->driver_data];
154 
155 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
156 	mxsfb->base = devm_ioremap_resource(drm->dev, res);
157 	if (IS_ERR(mxsfb->base))
158 		return PTR_ERR(mxsfb->base);
159 
160 	mxsfb->clk = devm_clk_get(drm->dev, NULL);
161 	if (IS_ERR(mxsfb->clk))
162 		return PTR_ERR(mxsfb->clk);
163 
164 	mxsfb->clk_axi = devm_clk_get(drm->dev, "axi");
165 	if (IS_ERR(mxsfb->clk_axi))
166 		mxsfb->clk_axi = NULL;
167 
168 	mxsfb->clk_disp_axi = devm_clk_get(drm->dev, "disp_axi");
169 	if (IS_ERR(mxsfb->clk_disp_axi))
170 		mxsfb->clk_disp_axi = NULL;
171 
172 	ret = dma_set_mask_and_coherent(drm->dev, DMA_BIT_MASK(32));
173 	if (ret)
174 		return ret;
175 
176 	pm_runtime_enable(drm->dev);
177 
178 	ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
179 	if (ret < 0) {
180 		dev_err(drm->dev, "Failed to initialise vblank\n");
181 		goto err_vblank;
182 	}
183 
184 	/* Modeset init */
185 	drm_mode_config_init(drm);
186 
187 	ret = mxsfb_create_output(drm);
188 	if (ret < 0) {
189 		dev_err(drm->dev, "Failed to create outputs\n");
190 		goto err_vblank;
191 	}
192 
193 	ret = drm_simple_display_pipe_init(drm, &mxsfb->pipe, &mxsfb_funcs,
194 			mxsfb_formats, ARRAY_SIZE(mxsfb_formats), NULL,
195 			&mxsfb->connector);
196 	if (ret < 0) {
197 		dev_err(drm->dev, "Cannot setup simple display pipe\n");
198 		goto err_vblank;
199 	}
200 
201 	ret = drm_panel_attach(mxsfb->panel, &mxsfb->connector);
202 	if (ret) {
203 		dev_err(drm->dev, "Cannot connect panel\n");
204 		goto err_vblank;
205 	}
206 
207 	drm->mode_config.min_width	= MXSFB_MIN_XRES;
208 	drm->mode_config.min_height	= MXSFB_MIN_YRES;
209 	drm->mode_config.max_width	= MXSFB_MAX_XRES;
210 	drm->mode_config.max_height	= MXSFB_MAX_YRES;
211 	drm->mode_config.funcs		= &mxsfb_mode_config_funcs;
212 
213 	drm_mode_config_reset(drm);
214 
215 	pm_runtime_get_sync(drm->dev);
216 	ret = drm_irq_install(drm, platform_get_irq(pdev, 0));
217 	pm_runtime_put_sync(drm->dev);
218 
219 	if (ret < 0) {
220 		dev_err(drm->dev, "Failed to install IRQ handler\n");
221 		goto err_irq;
222 	}
223 
224 	drm_kms_helper_poll_init(drm);
225 
226 	mxsfb->fbdev = drm_fbdev_cma_init(drm, 32,
227 					  drm->mode_config.num_connector);
228 	if (IS_ERR(mxsfb->fbdev)) {
229 		ret = PTR_ERR(mxsfb->fbdev);
230 		mxsfb->fbdev = NULL;
231 		dev_err(drm->dev, "Failed to init FB CMA area\n");
232 		goto err_cma;
233 	}
234 
235 	platform_set_drvdata(pdev, drm);
236 
237 	drm_helper_hpd_irq_event(drm);
238 
239 	return 0;
240 
241 err_cma:
242 	drm_irq_uninstall(drm);
243 err_irq:
244 	drm_panel_detach(mxsfb->panel);
245 err_vblank:
246 	pm_runtime_disable(drm->dev);
247 
248 	return ret;
249 }
250 
251 static void mxsfb_unload(struct drm_device *drm)
252 {
253 	struct mxsfb_drm_private *mxsfb = drm->dev_private;
254 
255 	if (mxsfb->fbdev)
256 		drm_fbdev_cma_fini(mxsfb->fbdev);
257 
258 	drm_kms_helper_poll_fini(drm);
259 	drm_mode_config_cleanup(drm);
260 
261 	pm_runtime_get_sync(drm->dev);
262 	drm_irq_uninstall(drm);
263 	pm_runtime_put_sync(drm->dev);
264 
265 	drm->dev_private = NULL;
266 
267 	pm_runtime_disable(drm->dev);
268 }
269 
270 static void mxsfb_lastclose(struct drm_device *drm)
271 {
272 	struct mxsfb_drm_private *mxsfb = drm->dev_private;
273 
274 	drm_fbdev_cma_restore_mode(mxsfb->fbdev);
275 }
276 
277 static int mxsfb_enable_vblank(struct drm_device *drm, unsigned int crtc)
278 {
279 	struct mxsfb_drm_private *mxsfb = drm->dev_private;
280 
281 	/* Clear and enable VBLANK IRQ */
282 	mxsfb_enable_axi_clk(mxsfb);
283 	writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR);
284 	writel(CTRL1_CUR_FRAME_DONE_IRQ_EN, mxsfb->base + LCDC_CTRL1 + REG_SET);
285 	mxsfb_disable_axi_clk(mxsfb);
286 
287 	return 0;
288 }
289 
290 static void mxsfb_disable_vblank(struct drm_device *drm, unsigned int crtc)
291 {
292 	struct mxsfb_drm_private *mxsfb = drm->dev_private;
293 
294 	/* Disable and clear VBLANK IRQ */
295 	mxsfb_enable_axi_clk(mxsfb);
296 	writel(CTRL1_CUR_FRAME_DONE_IRQ_EN, mxsfb->base + LCDC_CTRL1 + REG_CLR);
297 	writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR);
298 	mxsfb_disable_axi_clk(mxsfb);
299 }
300 
301 static void mxsfb_irq_preinstall(struct drm_device *drm)
302 {
303 	mxsfb_disable_vblank(drm, 0);
304 }
305 
306 static irqreturn_t mxsfb_irq_handler(int irq, void *data)
307 {
308 	struct drm_device *drm = data;
309 	struct mxsfb_drm_private *mxsfb = drm->dev_private;
310 	u32 reg;
311 
312 	mxsfb_enable_axi_clk(mxsfb);
313 
314 	reg = readl(mxsfb->base + LCDC_CTRL1);
315 
316 	if (reg & CTRL1_CUR_FRAME_DONE_IRQ)
317 		drm_crtc_handle_vblank(&mxsfb->pipe.crtc);
318 
319 	writel(CTRL1_CUR_FRAME_DONE_IRQ, mxsfb->base + LCDC_CTRL1 + REG_CLR);
320 
321 	mxsfb_disable_axi_clk(mxsfb);
322 
323 	return IRQ_HANDLED;
324 }
325 
326 DEFINE_DRM_GEM_CMA_FOPS(fops);
327 
328 static struct drm_driver mxsfb_driver = {
329 	.driver_features	= DRIVER_GEM | DRIVER_MODESET |
330 				  DRIVER_PRIME | DRIVER_ATOMIC |
331 				  DRIVER_HAVE_IRQ,
332 	.lastclose		= mxsfb_lastclose,
333 	.irq_handler		= mxsfb_irq_handler,
334 	.irq_preinstall		= mxsfb_irq_preinstall,
335 	.irq_uninstall		= mxsfb_irq_preinstall,
336 	.enable_vblank		= mxsfb_enable_vblank,
337 	.disable_vblank		= mxsfb_disable_vblank,
338 	.gem_free_object_unlocked = drm_gem_cma_free_object,
339 	.gem_vm_ops		= &drm_gem_cma_vm_ops,
340 	.dumb_create		= drm_gem_cma_dumb_create,
341 	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
342 	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
343 	.gem_prime_export	= drm_gem_prime_export,
344 	.gem_prime_import	= drm_gem_prime_import,
345 	.gem_prime_get_sg_table	= drm_gem_cma_prime_get_sg_table,
346 	.gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
347 	.gem_prime_vmap		= drm_gem_cma_prime_vmap,
348 	.gem_prime_vunmap	= drm_gem_cma_prime_vunmap,
349 	.gem_prime_mmap		= drm_gem_cma_prime_mmap,
350 	.fops	= &fops,
351 	.name	= "mxsfb-drm",
352 	.desc	= "MXSFB Controller DRM",
353 	.date	= "20160824",
354 	.major	= 1,
355 	.minor	= 0,
356 };
357 
358 static const struct platform_device_id mxsfb_devtype[] = {
359 	{ .name = "imx23-fb", .driver_data = MXSFB_V3, },
360 	{ .name = "imx28-fb", .driver_data = MXSFB_V4, },
361 	{ .name = "imx6sx-fb", .driver_data = MXSFB_V4, },
362 	{ /* sentinel */ }
363 };
364 MODULE_DEVICE_TABLE(platform, mxsfb_devtype);
365 
366 static const struct of_device_id mxsfb_dt_ids[] = {
367 	{ .compatible = "fsl,imx23-lcdif", .data = &mxsfb_devtype[0], },
368 	{ .compatible = "fsl,imx28-lcdif", .data = &mxsfb_devtype[1], },
369 	{ .compatible = "fsl,imx6sx-lcdif", .data = &mxsfb_devtype[2], },
370 	{ /* sentinel */ }
371 };
372 MODULE_DEVICE_TABLE(of, mxsfb_dt_ids);
373 
374 static int mxsfb_probe(struct platform_device *pdev)
375 {
376 	struct drm_device *drm;
377 	const struct of_device_id *of_id =
378 			of_match_device(mxsfb_dt_ids, &pdev->dev);
379 	int ret;
380 
381 	if (!pdev->dev.of_node)
382 		return -ENODEV;
383 
384 	if (of_id)
385 		pdev->id_entry = of_id->data;
386 
387 	drm = drm_dev_alloc(&mxsfb_driver, &pdev->dev);
388 	if (IS_ERR(drm))
389 		return PTR_ERR(drm);
390 
391 	ret = mxsfb_load(drm, 0);
392 	if (ret)
393 		goto err_free;
394 
395 	ret = drm_dev_register(drm, 0);
396 	if (ret)
397 		goto err_unload;
398 
399 	return 0;
400 
401 err_unload:
402 	mxsfb_unload(drm);
403 err_free:
404 	drm_dev_unref(drm);
405 
406 	return ret;
407 }
408 
409 static int mxsfb_remove(struct platform_device *pdev)
410 {
411 	struct drm_device *drm = platform_get_drvdata(pdev);
412 
413 	drm_dev_unregister(drm);
414 	mxsfb_unload(drm);
415 	drm_dev_unref(drm);
416 
417 	return 0;
418 }
419 
420 static struct platform_driver mxsfb_platform_driver = {
421 	.probe		= mxsfb_probe,
422 	.remove		= mxsfb_remove,
423 	.id_table	= mxsfb_devtype,
424 	.driver	= {
425 		.name		= "mxsfb",
426 		.of_match_table	= mxsfb_dt_ids,
427 	},
428 };
429 
430 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