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_atomic_helper_shutdown(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 	.fops			= &fsl_dcu_drm_fops,
180 	.name			= "fsl-dcu-drm",
181 	.desc			= "Freescale DCU DRM",
182 	.date			= "20160425",
183 	.major			= 1,
184 	.minor			= 1,
185 };
186 
187 #ifdef CONFIG_PM_SLEEP
188 static int fsl_dcu_drm_pm_suspend(struct device *dev)
189 {
190 	struct fsl_dcu_drm_device *fsl_dev = dev_get_drvdata(dev);
191 
192 	if (!fsl_dev)
193 		return 0;
194 
195 	disable_irq(fsl_dev->irq);
196 	drm_kms_helper_poll_disable(fsl_dev->drm);
197 
198 	console_lock();
199 	drm_fbdev_cma_set_suspend(fsl_dev->fbdev, 1);
200 	console_unlock();
201 
202 	fsl_dev->state = drm_atomic_helper_suspend(fsl_dev->drm);
203 	if (IS_ERR(fsl_dev->state)) {
204 		console_lock();
205 		drm_fbdev_cma_set_suspend(fsl_dev->fbdev, 0);
206 		console_unlock();
207 
208 		drm_kms_helper_poll_enable(fsl_dev->drm);
209 		enable_irq(fsl_dev->irq);
210 		return PTR_ERR(fsl_dev->state);
211 	}
212 
213 	clk_disable_unprepare(fsl_dev->clk);
214 
215 	return 0;
216 }
217 
218 static int fsl_dcu_drm_pm_resume(struct device *dev)
219 {
220 	struct fsl_dcu_drm_device *fsl_dev = dev_get_drvdata(dev);
221 	int ret;
222 
223 	if (!fsl_dev)
224 		return 0;
225 
226 	ret = clk_prepare_enable(fsl_dev->clk);
227 	if (ret < 0) {
228 		dev_err(dev, "failed to enable dcu clk\n");
229 		return ret;
230 	}
231 
232 	if (fsl_dev->tcon)
233 		fsl_tcon_bypass_enable(fsl_dev->tcon);
234 	fsl_dcu_drm_init_planes(fsl_dev->drm);
235 	drm_atomic_helper_resume(fsl_dev->drm, fsl_dev->state);
236 
237 	console_lock();
238 	drm_fbdev_cma_set_suspend(fsl_dev->fbdev, 0);
239 	console_unlock();
240 
241 	drm_kms_helper_poll_enable(fsl_dev->drm);
242 	enable_irq(fsl_dev->irq);
243 
244 	return 0;
245 }
246 #endif
247 
248 static const struct dev_pm_ops fsl_dcu_drm_pm_ops = {
249 	SET_SYSTEM_SLEEP_PM_OPS(fsl_dcu_drm_pm_suspend, fsl_dcu_drm_pm_resume)
250 };
251 
252 static const struct fsl_dcu_soc_data fsl_dcu_ls1021a_data = {
253 	.name = "ls1021a",
254 	.total_layer = 16,
255 	.max_layer = 4,
256 	.layer_regs = LS1021A_LAYER_REG_NUM,
257 };
258 
259 static const struct fsl_dcu_soc_data fsl_dcu_vf610_data = {
260 	.name = "vf610",
261 	.total_layer = 64,
262 	.max_layer = 6,
263 	.layer_regs = VF610_LAYER_REG_NUM,
264 };
265 
266 static const struct of_device_id fsl_dcu_of_match[] = {
267 	{
268 		.compatible = "fsl,ls1021a-dcu",
269 		.data = &fsl_dcu_ls1021a_data,
270 	}, {
271 		.compatible = "fsl,vf610-dcu",
272 		.data = &fsl_dcu_vf610_data,
273 	}, {
274 	},
275 };
276 MODULE_DEVICE_TABLE(of, fsl_dcu_of_match);
277 
278 static int fsl_dcu_drm_probe(struct platform_device *pdev)
279 {
280 	struct fsl_dcu_drm_device *fsl_dev;
281 	struct drm_device *drm;
282 	struct device *dev = &pdev->dev;
283 	struct resource *res;
284 	void __iomem *base;
285 	struct drm_driver *driver = &fsl_dcu_drm_driver;
286 	struct clk *pix_clk_in;
287 	char pix_clk_name[32];
288 	const char *pix_clk_in_name;
289 	const struct of_device_id *id;
290 	int ret;
291 	u8 div_ratio_shift = 0;
292 
293 	fsl_dev = devm_kzalloc(dev, sizeof(*fsl_dev), GFP_KERNEL);
294 	if (!fsl_dev)
295 		return -ENOMEM;
296 
297 	id = of_match_node(fsl_dcu_of_match, pdev->dev.of_node);
298 	if (!id)
299 		return -ENODEV;
300 	fsl_dev->soc = id->data;
301 
302 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
303 	base = devm_ioremap_resource(dev, res);
304 	if (IS_ERR(base)) {
305 		ret = PTR_ERR(base);
306 		return ret;
307 	}
308 
309 	fsl_dev->irq = platform_get_irq(pdev, 0);
310 	if (fsl_dev->irq < 0) {
311 		dev_err(dev, "failed to get irq\n");
312 		return fsl_dev->irq;
313 	}
314 
315 	fsl_dev->regmap = devm_regmap_init_mmio(dev, base,
316 			&fsl_dcu_regmap_config);
317 	if (IS_ERR(fsl_dev->regmap)) {
318 		dev_err(dev, "regmap init failed\n");
319 		return PTR_ERR(fsl_dev->regmap);
320 	}
321 
322 	fsl_dev->clk = devm_clk_get(dev, "dcu");
323 	if (IS_ERR(fsl_dev->clk)) {
324 		dev_err(dev, "failed to get dcu clock\n");
325 		return PTR_ERR(fsl_dev->clk);
326 	}
327 	ret = clk_prepare_enable(fsl_dev->clk);
328 	if (ret < 0) {
329 		dev_err(dev, "failed to enable dcu clk\n");
330 		return ret;
331 	}
332 
333 	pix_clk_in = devm_clk_get(dev, "pix");
334 	if (IS_ERR(pix_clk_in)) {
335 		/* legancy binding, use dcu clock as pixel clock input */
336 		pix_clk_in = fsl_dev->clk;
337 	}
338 
339 	if (of_property_read_bool(dev->of_node, "big-endian"))
340 		div_ratio_shift = 24;
341 
342 	pix_clk_in_name = __clk_get_name(pix_clk_in);
343 	snprintf(pix_clk_name, sizeof(pix_clk_name), "%s_pix", pix_clk_in_name);
344 	fsl_dev->pix_clk = clk_register_divider(dev, pix_clk_name,
345 			pix_clk_in_name, 0, base + DCU_DIV_RATIO,
346 			div_ratio_shift, 8, CLK_DIVIDER_ROUND_CLOSEST, NULL);
347 	if (IS_ERR(fsl_dev->pix_clk)) {
348 		dev_err(dev, "failed to register pix clk\n");
349 		ret = PTR_ERR(fsl_dev->pix_clk);
350 		goto disable_clk;
351 	}
352 
353 	fsl_dev->tcon = fsl_tcon_init(dev);
354 
355 	drm = drm_dev_alloc(driver, dev);
356 	if (IS_ERR(drm)) {
357 		ret = PTR_ERR(drm);
358 		goto unregister_pix_clk;
359 	}
360 
361 	fsl_dev->dev = dev;
362 	fsl_dev->drm = drm;
363 	fsl_dev->np = dev->of_node;
364 	drm->dev_private = fsl_dev;
365 	dev_set_drvdata(dev, fsl_dev);
366 
367 	ret = drm_dev_register(drm, 0);
368 	if (ret < 0)
369 		goto unref;
370 
371 	return 0;
372 
373 unref:
374 	drm_dev_unref(drm);
375 unregister_pix_clk:
376 	clk_unregister(fsl_dev->pix_clk);
377 disable_clk:
378 	clk_disable_unprepare(fsl_dev->clk);
379 	return ret;
380 }
381 
382 static int fsl_dcu_drm_remove(struct platform_device *pdev)
383 {
384 	struct fsl_dcu_drm_device *fsl_dev = platform_get_drvdata(pdev);
385 
386 	drm_dev_unregister(fsl_dev->drm);
387 	drm_dev_unref(fsl_dev->drm);
388 	clk_disable_unprepare(fsl_dev->clk);
389 	clk_unregister(fsl_dev->pix_clk);
390 
391 	return 0;
392 }
393 
394 static struct platform_driver fsl_dcu_drm_platform_driver = {
395 	.probe		= fsl_dcu_drm_probe,
396 	.remove		= fsl_dcu_drm_remove,
397 	.driver		= {
398 		.name	= "fsl-dcu",
399 		.pm	= &fsl_dcu_drm_pm_ops,
400 		.of_match_table = fsl_dcu_of_match,
401 	},
402 };
403 
404 module_platform_driver(fsl_dcu_drm_platform_driver);
405 
406 MODULE_DESCRIPTION("Freescale DCU DRM Driver");
407 MODULE_LICENSE("GPL");
408