1 /*
2  * Copyright 2015 Freescale Semiconductor, Inc.
3  *
4  * Freescale DCU drm device driver
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  */
11 
12 #include <linux/clk.h>
13 #include <linux/clk-provider.h>
14 #include <linux/console.h>
15 #include <linux/io.h>
16 #include <linux/mfd/syscon.h>
17 #include <linux/mm.h>
18 #include <linux/module.h>
19 #include <linux/of_platform.h>
20 #include <linux/platform_device.h>
21 #include <linux/pm.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/regmap.h>
24 
25 #include <drm/drmP.h>
26 #include <drm/drm_atomic_helper.h>
27 #include <drm/drm_crtc_helper.h>
28 #include <drm/drm_fb_cma_helper.h>
29 #include <drm/drm_gem_cma_helper.h>
30 
31 #include "fsl_dcu_drm_crtc.h"
32 #include "fsl_dcu_drm_drv.h"
33 #include "fsl_tcon.h"
34 
35 static int legacyfb_depth = 24;
36 module_param(legacyfb_depth, int, 0444);
37 
38 static bool fsl_dcu_drm_is_volatile_reg(struct device *dev, unsigned int reg)
39 {
40 	if (reg == DCU_INT_STATUS || reg == DCU_UPDATE_MODE)
41 		return true;
42 
43 	return false;
44 }
45 
46 static const struct regmap_config fsl_dcu_regmap_config = {
47 	.reg_bits = 32,
48 	.reg_stride = 4,
49 	.val_bits = 32,
50 
51 	.volatile_reg = fsl_dcu_drm_is_volatile_reg,
52 };
53 
54 static int fsl_dcu_drm_irq_init(struct drm_device *dev)
55 {
56 	struct fsl_dcu_drm_device *fsl_dev = dev->dev_private;
57 	int ret;
58 
59 	ret = drm_irq_install(dev, fsl_dev->irq);
60 	if (ret < 0)
61 		dev_err(dev->dev, "failed to install IRQ handler\n");
62 
63 	regmap_write(fsl_dev->regmap, DCU_INT_STATUS, 0);
64 	regmap_write(fsl_dev->regmap, DCU_INT_MASK, ~0);
65 
66 	return ret;
67 }
68 
69 static int fsl_dcu_load(struct drm_device *dev, unsigned long flags)
70 {
71 	struct fsl_dcu_drm_device *fsl_dev = dev->dev_private;
72 	int ret;
73 
74 	ret = fsl_dcu_drm_modeset_init(fsl_dev);
75 	if (ret < 0) {
76 		dev_err(dev->dev, "failed to initialize mode setting\n");
77 		return ret;
78 	}
79 
80 	ret = drm_vblank_init(dev, dev->mode_config.num_crtc);
81 	if (ret < 0) {
82 		dev_err(dev->dev, "failed to initialize vblank\n");
83 		goto done;
84 	}
85 
86 	ret = fsl_dcu_drm_irq_init(dev);
87 	if (ret < 0)
88 		goto done;
89 	dev->irq_enabled = true;
90 
91 	if (legacyfb_depth != 16 && legacyfb_depth != 24 &&
92 	    legacyfb_depth != 32) {
93 		dev_warn(dev->dev,
94 			"Invalid legacyfb_depth.  Defaulting to 24bpp\n");
95 		legacyfb_depth = 24;
96 	}
97 	fsl_dev->fbdev = drm_fbdev_cma_init(dev, legacyfb_depth, 1);
98 	if (IS_ERR(fsl_dev->fbdev)) {
99 		ret = PTR_ERR(fsl_dev->fbdev);
100 		fsl_dev->fbdev = NULL;
101 		goto done;
102 	}
103 
104 	return 0;
105 done:
106 	drm_kms_helper_poll_fini(dev);
107 
108 	if (fsl_dev->fbdev)
109 		drm_fbdev_cma_fini(fsl_dev->fbdev);
110 
111 	drm_mode_config_cleanup(dev);
112 	drm_vblank_cleanup(dev);
113 	drm_irq_uninstall(dev);
114 	dev->dev_private = NULL;
115 
116 	return ret;
117 }
118 
119 static void fsl_dcu_unload(struct drm_device *dev)
120 {
121 	struct fsl_dcu_drm_device *fsl_dev = dev->dev_private;
122 
123 	drm_crtc_force_disable_all(dev);
124 	drm_kms_helper_poll_fini(dev);
125 
126 	if (fsl_dev->fbdev)
127 		drm_fbdev_cma_fini(fsl_dev->fbdev);
128 
129 	drm_mode_config_cleanup(dev);
130 	drm_vblank_cleanup(dev);
131 	drm_irq_uninstall(dev);
132 
133 	dev->dev_private = NULL;
134 }
135 
136 static irqreturn_t fsl_dcu_drm_irq(int irq, void *arg)
137 {
138 	struct drm_device *dev = arg;
139 	struct fsl_dcu_drm_device *fsl_dev = dev->dev_private;
140 	unsigned int int_status;
141 	int ret;
142 
143 	ret = regmap_read(fsl_dev->regmap, DCU_INT_STATUS, &int_status);
144 	if (ret) {
145 		dev_err(dev->dev, "read DCU_INT_STATUS failed\n");
146 		return IRQ_NONE;
147 	}
148 
149 	if (int_status & DCU_INT_STATUS_VBLANK)
150 		drm_handle_vblank(dev, 0);
151 
152 	regmap_write(fsl_dev->regmap, DCU_INT_STATUS, int_status);
153 
154 	return IRQ_HANDLED;
155 }
156 
157 static void fsl_dcu_drm_lastclose(struct drm_device *dev)
158 {
159 	struct fsl_dcu_drm_device *fsl_dev = dev->dev_private;
160 
161 	drm_fbdev_cma_restore_mode(fsl_dev->fbdev);
162 }
163 
164 DEFINE_DRM_GEM_CMA_FOPS(fsl_dcu_drm_fops);
165 
166 static struct drm_driver fsl_dcu_drm_driver = {
167 	.driver_features	= DRIVER_HAVE_IRQ | DRIVER_GEM | DRIVER_MODESET
168 				| DRIVER_PRIME | DRIVER_ATOMIC,
169 	.lastclose		= fsl_dcu_drm_lastclose,
170 	.load			= fsl_dcu_load,
171 	.unload			= fsl_dcu_unload,
172 	.irq_handler		= fsl_dcu_drm_irq,
173 	.gem_free_object_unlocked = drm_gem_cma_free_object,
174 	.gem_vm_ops		= &drm_gem_cma_vm_ops,
175 	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
176 	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
177 	.gem_prime_import	= drm_gem_prime_import,
178 	.gem_prime_export	= drm_gem_prime_export,
179 	.gem_prime_get_sg_table	= drm_gem_cma_prime_get_sg_table,
180 	.gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
181 	.gem_prime_vmap		= drm_gem_cma_prime_vmap,
182 	.gem_prime_vunmap	= drm_gem_cma_prime_vunmap,
183 	.gem_prime_mmap		= drm_gem_cma_prime_mmap,
184 	.dumb_create		= drm_gem_cma_dumb_create,
185 	.dumb_map_offset	= drm_gem_cma_dumb_map_offset,
186 	.dumb_destroy		= drm_gem_dumb_destroy,
187 	.fops			= &fsl_dcu_drm_fops,
188 	.name			= "fsl-dcu-drm",
189 	.desc			= "Freescale DCU DRM",
190 	.date			= "20160425",
191 	.major			= 1,
192 	.minor			= 1,
193 };
194 
195 #ifdef CONFIG_PM_SLEEP
196 static int fsl_dcu_drm_pm_suspend(struct device *dev)
197 {
198 	struct fsl_dcu_drm_device *fsl_dev = dev_get_drvdata(dev);
199 
200 	if (!fsl_dev)
201 		return 0;
202 
203 	disable_irq(fsl_dev->irq);
204 	drm_kms_helper_poll_disable(fsl_dev->drm);
205 
206 	console_lock();
207 	drm_fbdev_cma_set_suspend(fsl_dev->fbdev, 1);
208 	console_unlock();
209 
210 	fsl_dev->state = drm_atomic_helper_suspend(fsl_dev->drm);
211 	if (IS_ERR(fsl_dev->state)) {
212 		console_lock();
213 		drm_fbdev_cma_set_suspend(fsl_dev->fbdev, 0);
214 		console_unlock();
215 
216 		drm_kms_helper_poll_enable(fsl_dev->drm);
217 		enable_irq(fsl_dev->irq);
218 		return PTR_ERR(fsl_dev->state);
219 	}
220 
221 	clk_disable_unprepare(fsl_dev->pix_clk);
222 	clk_disable_unprepare(fsl_dev->clk);
223 
224 	return 0;
225 }
226 
227 static int fsl_dcu_drm_pm_resume(struct device *dev)
228 {
229 	struct fsl_dcu_drm_device *fsl_dev = dev_get_drvdata(dev);
230 	int ret;
231 
232 	if (!fsl_dev)
233 		return 0;
234 
235 	ret = clk_prepare_enable(fsl_dev->clk);
236 	if (ret < 0) {
237 		dev_err(dev, "failed to enable dcu clk\n");
238 		return ret;
239 	}
240 
241 	if (fsl_dev->tcon)
242 		fsl_tcon_bypass_enable(fsl_dev->tcon);
243 	fsl_dcu_drm_init_planes(fsl_dev->drm);
244 	drm_atomic_helper_resume(fsl_dev->drm, fsl_dev->state);
245 
246 	console_lock();
247 	drm_fbdev_cma_set_suspend(fsl_dev->fbdev, 0);
248 	console_unlock();
249 
250 	drm_kms_helper_poll_enable(fsl_dev->drm);
251 	enable_irq(fsl_dev->irq);
252 
253 	return 0;
254 }
255 #endif
256 
257 static const struct dev_pm_ops fsl_dcu_drm_pm_ops = {
258 	SET_SYSTEM_SLEEP_PM_OPS(fsl_dcu_drm_pm_suspend, fsl_dcu_drm_pm_resume)
259 };
260 
261 static const struct fsl_dcu_soc_data fsl_dcu_ls1021a_data = {
262 	.name = "ls1021a",
263 	.total_layer = 16,
264 	.max_layer = 4,
265 	.layer_regs = LS1021A_LAYER_REG_NUM,
266 };
267 
268 static const struct fsl_dcu_soc_data fsl_dcu_vf610_data = {
269 	.name = "vf610",
270 	.total_layer = 64,
271 	.max_layer = 6,
272 	.layer_regs = VF610_LAYER_REG_NUM,
273 };
274 
275 static const struct of_device_id fsl_dcu_of_match[] = {
276 	{
277 		.compatible = "fsl,ls1021a-dcu",
278 		.data = &fsl_dcu_ls1021a_data,
279 	}, {
280 		.compatible = "fsl,vf610-dcu",
281 		.data = &fsl_dcu_vf610_data,
282 	}, {
283 	},
284 };
285 MODULE_DEVICE_TABLE(of, fsl_dcu_of_match);
286 
287 static int fsl_dcu_drm_probe(struct platform_device *pdev)
288 {
289 	struct fsl_dcu_drm_device *fsl_dev;
290 	struct drm_device *drm;
291 	struct device *dev = &pdev->dev;
292 	struct resource *res;
293 	void __iomem *base;
294 	struct drm_driver *driver = &fsl_dcu_drm_driver;
295 	struct clk *pix_clk_in;
296 	char pix_clk_name[32];
297 	const char *pix_clk_in_name;
298 	const struct of_device_id *id;
299 	int ret;
300 	u8 div_ratio_shift = 0;
301 
302 	fsl_dev = devm_kzalloc(dev, sizeof(*fsl_dev), GFP_KERNEL);
303 	if (!fsl_dev)
304 		return -ENOMEM;
305 
306 	id = of_match_node(fsl_dcu_of_match, pdev->dev.of_node);
307 	if (!id)
308 		return -ENODEV;
309 	fsl_dev->soc = id->data;
310 
311 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
312 	base = devm_ioremap_resource(dev, res);
313 	if (IS_ERR(base)) {
314 		ret = PTR_ERR(base);
315 		return ret;
316 	}
317 
318 	fsl_dev->irq = platform_get_irq(pdev, 0);
319 	if (fsl_dev->irq < 0) {
320 		dev_err(dev, "failed to get irq\n");
321 		return fsl_dev->irq;
322 	}
323 
324 	fsl_dev->regmap = devm_regmap_init_mmio(dev, base,
325 			&fsl_dcu_regmap_config);
326 	if (IS_ERR(fsl_dev->regmap)) {
327 		dev_err(dev, "regmap init failed\n");
328 		return PTR_ERR(fsl_dev->regmap);
329 	}
330 
331 	fsl_dev->clk = devm_clk_get(dev, "dcu");
332 	if (IS_ERR(fsl_dev->clk)) {
333 		dev_err(dev, "failed to get dcu clock\n");
334 		return PTR_ERR(fsl_dev->clk);
335 	}
336 	ret = clk_prepare_enable(fsl_dev->clk);
337 	if (ret < 0) {
338 		dev_err(dev, "failed to enable dcu clk\n");
339 		return ret;
340 	}
341 
342 	pix_clk_in = devm_clk_get(dev, "pix");
343 	if (IS_ERR(pix_clk_in)) {
344 		/* legancy binding, use dcu clock as pixel clock input */
345 		pix_clk_in = fsl_dev->clk;
346 	}
347 
348 	if (of_property_read_bool(dev->of_node, "big-endian"))
349 		div_ratio_shift = 24;
350 
351 	pix_clk_in_name = __clk_get_name(pix_clk_in);
352 	snprintf(pix_clk_name, sizeof(pix_clk_name), "%s_pix", pix_clk_in_name);
353 	fsl_dev->pix_clk = clk_register_divider(dev, pix_clk_name,
354 			pix_clk_in_name, 0, base + DCU_DIV_RATIO,
355 			div_ratio_shift, 8, CLK_DIVIDER_ROUND_CLOSEST, NULL);
356 	if (IS_ERR(fsl_dev->pix_clk)) {
357 		dev_err(dev, "failed to register pix clk\n");
358 		ret = PTR_ERR(fsl_dev->pix_clk);
359 		goto disable_clk;
360 	}
361 
362 	fsl_dev->tcon = fsl_tcon_init(dev);
363 
364 	drm = drm_dev_alloc(driver, dev);
365 	if (IS_ERR(drm)) {
366 		ret = PTR_ERR(drm);
367 		goto unregister_pix_clk;
368 	}
369 
370 	fsl_dev->dev = dev;
371 	fsl_dev->drm = drm;
372 	fsl_dev->np = dev->of_node;
373 	drm->dev_private = fsl_dev;
374 	dev_set_drvdata(dev, fsl_dev);
375 
376 	ret = drm_dev_register(drm, 0);
377 	if (ret < 0)
378 		goto unref;
379 
380 	return 0;
381 
382 unref:
383 	drm_dev_unref(drm);
384 unregister_pix_clk:
385 	clk_unregister(fsl_dev->pix_clk);
386 disable_clk:
387 	clk_disable_unprepare(fsl_dev->clk);
388 	return ret;
389 }
390 
391 static int fsl_dcu_drm_remove(struct platform_device *pdev)
392 {
393 	struct fsl_dcu_drm_device *fsl_dev = platform_get_drvdata(pdev);
394 
395 	drm_dev_unregister(fsl_dev->drm);
396 	drm_dev_unref(fsl_dev->drm);
397 	clk_disable_unprepare(fsl_dev->clk);
398 	clk_unregister(fsl_dev->pix_clk);
399 
400 	return 0;
401 }
402 
403 static struct platform_driver fsl_dcu_drm_platform_driver = {
404 	.probe		= fsl_dcu_drm_probe,
405 	.remove		= fsl_dcu_drm_remove,
406 	.driver		= {
407 		.name	= "fsl-dcu",
408 		.pm	= &fsl_dcu_drm_pm_ops,
409 		.of_match_table = fsl_dcu_of_match,
410 	},
411 };
412 
413 module_platform_driver(fsl_dcu_drm_platform_driver);
414 
415 MODULE_DESCRIPTION("Freescale DCU DRM Driver");
416 MODULE_LICENSE("GPL");
417