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