xref: /linux/drivers/gpu/drm/mxsfb/lcdif_drv.c (revision bba2c3615bd6cfee7456d1130f2e6b01b3f4e9ba)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (C) 2022 Marek Vasut <marex@denx.de>
4  *
5  * This code is based on drivers/gpu/drm/mxsfb/mxsfb*
6  */
7 
8 #include <linux/cleanup.h>
9 #include <linux/clk.h>
10 #include <linux/dma-mapping.h>
11 #include <linux/io.h>
12 #include <linux/module.h>
13 #include <linux/of.h>
14 #include <linux/of_graph.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 
18 #include <drm/clients/drm_client_setup.h>
19 #include <drm/drm_atomic_helper.h>
20 #include <drm/drm_bridge.h>
21 #include <drm/drm_bridge_connector.h>
22 #include <drm/drm_drv.h>
23 #include <drm/drm_encoder.h>
24 #include <drm/drm_fbdev_dma.h>
25 #include <drm/drm_gem_dma_helper.h>
26 #include <drm/drm_gem_framebuffer_helper.h>
27 #include <drm/drm_mode_config.h>
28 #include <drm/drm_module.h>
29 #include <drm/drm_of.h>
30 #include <drm/drm_probe_helper.h>
31 #include <drm/drm_vblank.h>
32 
33 #include "lcdif_drv.h"
34 #include "lcdif_regs.h"
35 
36 static const struct drm_mode_config_funcs lcdif_mode_config_funcs = {
37 	.fb_create		= drm_gem_fb_create,
38 	.atomic_check		= drm_atomic_helper_check,
39 	.atomic_commit		= drm_atomic_helper_commit,
40 };
41 
42 static const struct drm_mode_config_helper_funcs lcdif_mode_config_helpers = {
43 	.atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
44 };
45 
46 static const struct drm_encoder_funcs lcdif_encoder_funcs = {
47 	.destroy = drm_encoder_cleanup,
48 };
49 
50 static int lcdif_attach_bridge(struct lcdif_drm_private *lcdif)
51 {
52 	struct device *dev = lcdif->drm->dev;
53 	struct device_node *ep __free(device_node) = NULL;
54 
55 	for_each_endpoint_of_node(dev->of_node, ep) {
56 		struct device_node *remote __free(device_node) =
57 			of_graph_get_remote_port_parent(ep);
58 		struct of_endpoint of_ep;
59 		struct drm_bridge *bridge;
60 		struct drm_encoder *encoder;
61 		struct drm_connector *connector;
62 		int ret;
63 
64 		if (!of_device_is_available(remote))
65 			continue;
66 
67 		ret = of_graph_parse_endpoint(ep, &of_ep);
68 		if (ret < 0)
69 			return dev_err_probe(dev, ret, "Failed to parse endpoint %pOF\n", ep);
70 
71 		bridge = devm_drm_of_get_bridge(dev, dev->of_node, 0, of_ep.id);
72 		if (IS_ERR(bridge))
73 			return dev_err_probe(dev, PTR_ERR(bridge),
74 					     "Failed to get bridge for endpoint%u\n",
75 					     of_ep.id);
76 
77 		encoder = devm_kzalloc(dev, sizeof(*encoder), GFP_KERNEL);
78 		if (!encoder)
79 			return dev_err_probe(dev, -ENOMEM,
80 					     "Failed to allocate encoder for endpoint%u\n",
81 					     of_ep.id);
82 
83 		encoder->possible_crtcs = drm_crtc_mask(&lcdif->crtc);
84 		ret = drm_encoder_init(lcdif->drm, encoder, &lcdif_encoder_funcs,
85 				       DRM_MODE_ENCODER_NONE, NULL);
86 		if (ret)
87 			return dev_err_probe(dev, ret,
88 					     "Failed to initialize encoder for endpoint%u\n",
89 					     of_ep.id);
90 
91 		ret = drm_bridge_attach(encoder, bridge, NULL, DRM_BRIDGE_ATTACH_NO_CONNECTOR);
92 		if (ret)
93 			return dev_err_probe(dev, ret,
94 					     "Failed to attach bridge for endpoint%u\n",
95 					     of_ep.id);
96 
97 		connector = drm_bridge_connector_init(lcdif->drm, encoder);
98 		if (IS_ERR(connector))
99 			return dev_err_probe(dev, PTR_ERR(connector),
100 					     "Failed to init bridge_connector for endpoint%u\n",
101 					     of_ep.id);
102 	}
103 
104 	return 0;
105 }
106 
107 static irqreturn_t lcdif_irq_handler(int irq, void *data)
108 {
109 	struct drm_device *drm = data;
110 	struct lcdif_drm_private *lcdif = drm->dev_private;
111 	u32 reg, stat;
112 
113 	stat = readl(lcdif->base + LCDC_V8_INT_STATUS_D0);
114 	if (!stat)
115 		return IRQ_NONE;
116 
117 	if (stat & INT_STATUS_D0_VS_BLANK) {
118 		reg = readl(lcdif->base + LCDC_V8_CTRLDESCL0_5);
119 		if (!(reg & CTRLDESCL0_5_SHADOW_LOAD_EN))
120 			drm_crtc_handle_vblank(&lcdif->crtc);
121 	}
122 
123 	writel(stat, lcdif->base + LCDC_V8_INT_STATUS_D0);
124 
125 	return IRQ_HANDLED;
126 }
127 
128 static int lcdif_load(struct drm_device *drm)
129 {
130 	struct platform_device *pdev = to_platform_device(drm->dev);
131 	struct lcdif_drm_private *lcdif;
132 	int ret;
133 
134 	lcdif = devm_kzalloc(&pdev->dev, sizeof(*lcdif), GFP_KERNEL);
135 	if (!lcdif)
136 		return -ENOMEM;
137 
138 	lcdif->drm = drm;
139 	drm->dev_private = lcdif;
140 
141 	lcdif->base = devm_platform_ioremap_resource(pdev, 0);
142 	if (IS_ERR(lcdif->base))
143 		return PTR_ERR(lcdif->base);
144 
145 	lcdif->clk = devm_clk_get(drm->dev, "pix");
146 	if (IS_ERR(lcdif->clk))
147 		return dev_err_probe(drm->dev, PTR_ERR(lcdif->clk), "Failed to get pix clock\n");
148 
149 	lcdif->clk_axi = devm_clk_get(drm->dev, "axi");
150 	if (IS_ERR(lcdif->clk_axi))
151 		return dev_err_probe(drm->dev, PTR_ERR(lcdif->clk_axi),
152 				     "Failed to get axi clock\n");
153 
154 	lcdif->clk_disp_axi = devm_clk_get(drm->dev, "disp_axi");
155 	if (IS_ERR(lcdif->clk_disp_axi))
156 		return dev_err_probe(drm->dev, PTR_ERR(lcdif->clk_disp_axi),
157 				     "Failed to get disp_axi clock\n");
158 
159 	platform_set_drvdata(pdev, drm);
160 
161 	ret = dma_set_mask_and_coherent(drm->dev, DMA_BIT_MASK(36));
162 	if (ret)
163 		return ret;
164 
165 	/* Modeset init */
166 	ret = drmm_mode_config_init(drm);
167 	if (ret) {
168 		dev_err(drm->dev, "Failed to initialize mode config\n");
169 		return ret;
170 	}
171 
172 	ret = lcdif_kms_init(lcdif);
173 	if (ret < 0) {
174 		dev_err(drm->dev, "Failed to initialize KMS pipeline\n");
175 		return ret;
176 	}
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 		return ret;
182 	}
183 
184 	/* Start with vertical blanking interrupt reporting disabled. */
185 	drm_crtc_vblank_off(&lcdif->crtc);
186 
187 	ret = lcdif_attach_bridge(lcdif);
188 	if (ret)
189 		return dev_err_probe(drm->dev, ret, "Cannot connect bridge\n");
190 
191 	drm->mode_config.min_width	= LCDIF_MIN_XRES;
192 	drm->mode_config.min_height	= LCDIF_MIN_YRES;
193 	drm->mode_config.max_width	= LCDIF_MAX_XRES;
194 	drm->mode_config.max_height	= LCDIF_MAX_YRES;
195 	drm->mode_config.funcs		= &lcdif_mode_config_funcs;
196 	drm->mode_config.helper_private	= &lcdif_mode_config_helpers;
197 
198 	drm_mode_config_reset(drm);
199 
200 	ret = platform_get_irq(pdev, 0);
201 	if (ret < 0)
202 		return ret;
203 	lcdif->irq = ret;
204 
205 	ret = devm_request_irq(drm->dev, lcdif->irq, lcdif_irq_handler, 0,
206 			       drm->driver->name, drm);
207 	if (ret < 0) {
208 		dev_err(drm->dev, "Failed to install IRQ handler\n");
209 		return ret;
210 	}
211 
212 	drm_kms_helper_poll_init(drm);
213 
214 	drm_helper_hpd_irq_event(drm);
215 
216 	pm_runtime_enable(drm->dev);
217 
218 	return 0;
219 }
220 
221 static void lcdif_unload(struct drm_device *drm)
222 {
223 	struct lcdif_drm_private *lcdif = drm->dev_private;
224 
225 	pm_runtime_get_sync(drm->dev);
226 
227 	drm_crtc_vblank_off(&lcdif->crtc);
228 
229 	drm_kms_helper_poll_fini(drm);
230 
231 	pm_runtime_put_sync(drm->dev);
232 	pm_runtime_disable(drm->dev);
233 
234 	drm->dev_private = NULL;
235 }
236 
237 DEFINE_DRM_GEM_DMA_FOPS(fops);
238 
239 static const struct drm_driver lcdif_driver = {
240 	.driver_features	= DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
241 	DRM_GEM_DMA_DRIVER_OPS,
242 	DRM_FBDEV_DMA_DRIVER_OPS,
243 	.fops	= &fops,
244 	.name	= "imx-lcdif",
245 	.desc	= "i.MX LCDIF Controller DRM",
246 	.major	= 1,
247 	.minor	= 0,
248 };
249 
250 static const struct of_device_id lcdif_dt_ids[] = {
251 	{ .compatible = "fsl,imx8mp-lcdif" },
252 	{ .compatible = "fsl,imx93-lcdif" },
253 	{ /* sentinel */ }
254 };
255 MODULE_DEVICE_TABLE(of, lcdif_dt_ids);
256 
257 static int lcdif_probe(struct platform_device *pdev)
258 {
259 	struct drm_device *drm;
260 	int ret;
261 
262 	drm = drm_dev_alloc(&lcdif_driver, &pdev->dev);
263 	if (IS_ERR(drm))
264 		return PTR_ERR(drm);
265 
266 	ret = lcdif_load(drm);
267 	if (ret)
268 		goto err_free;
269 
270 	ret = drm_dev_register(drm, 0);
271 	if (ret)
272 		goto err_unload;
273 
274 	drm_client_setup(drm, NULL);
275 
276 	return 0;
277 
278 err_unload:
279 	lcdif_unload(drm);
280 err_free:
281 	drm_dev_put(drm);
282 
283 	return ret;
284 }
285 
286 static void lcdif_remove(struct platform_device *pdev)
287 {
288 	struct drm_device *drm = platform_get_drvdata(pdev);
289 
290 	drm_dev_unregister(drm);
291 	drm_atomic_helper_shutdown(drm);
292 	lcdif_unload(drm);
293 	drm_dev_put(drm);
294 }
295 
296 static void lcdif_shutdown(struct platform_device *pdev)
297 {
298 	struct drm_device *drm = platform_get_drvdata(pdev);
299 
300 	drm_atomic_helper_shutdown(drm);
301 }
302 
303 static int __maybe_unused lcdif_rpm_suspend(struct device *dev)
304 {
305 	struct drm_device *drm = dev_get_drvdata(dev);
306 	struct lcdif_drm_private *lcdif = drm->dev_private;
307 
308 	/* These clock supply the DISPLAY CLOCK Domain */
309 	clk_disable_unprepare(lcdif->clk);
310 	/* These clock supply the System Bus, AXI, Write Path, LFIFO */
311 	clk_disable_unprepare(lcdif->clk_disp_axi);
312 	/* These clock supply the Control Bus, APB, APBH Ctrl Registers */
313 	clk_disable_unprepare(lcdif->clk_axi);
314 
315 	return 0;
316 }
317 
318 static int __maybe_unused lcdif_rpm_resume(struct device *dev)
319 {
320 	struct drm_device *drm = dev_get_drvdata(dev);
321 	struct lcdif_drm_private *lcdif = drm->dev_private;
322 
323 	/* These clock supply the Control Bus, APB, APBH Ctrl Registers */
324 	clk_prepare_enable(lcdif->clk_axi);
325 	/* These clock supply the System Bus, AXI, Write Path, LFIFO */
326 	clk_prepare_enable(lcdif->clk_disp_axi);
327 	/* These clock supply the DISPLAY CLOCK Domain */
328 	clk_prepare_enable(lcdif->clk);
329 
330 	return 0;
331 }
332 
333 static int __maybe_unused lcdif_suspend(struct device *dev)
334 {
335 	struct drm_device *drm = dev_get_drvdata(dev);
336 	int ret;
337 
338 	ret = drm_mode_config_helper_suspend(drm);
339 	if (ret)
340 		return ret;
341 
342 	if (pm_runtime_suspended(dev))
343 		return 0;
344 
345 	return lcdif_rpm_suspend(dev);
346 }
347 
348 static int __maybe_unused lcdif_resume(struct device *dev)
349 {
350 	struct drm_device *drm = dev_get_drvdata(dev);
351 
352 	if (!pm_runtime_suspended(dev))
353 		lcdif_rpm_resume(dev);
354 
355 	return drm_mode_config_helper_resume(drm);
356 }
357 
358 static const struct dev_pm_ops lcdif_pm_ops = {
359 	SET_SYSTEM_SLEEP_PM_OPS(lcdif_suspend, lcdif_resume)
360 	SET_RUNTIME_PM_OPS(lcdif_rpm_suspend, lcdif_rpm_resume, NULL)
361 };
362 
363 static struct platform_driver lcdif_platform_driver = {
364 	.probe		= lcdif_probe,
365 	.remove		= lcdif_remove,
366 	.shutdown	= lcdif_shutdown,
367 	.driver	= {
368 		.name		= "imx-lcdif",
369 		.of_match_table	= lcdif_dt_ids,
370 		.pm		= &lcdif_pm_ops,
371 	},
372 };
373 
374 drm_module_platform_driver(lcdif_platform_driver);
375 
376 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
377 MODULE_DESCRIPTION("Freescale LCDIF DRM/KMS driver");
378 MODULE_LICENSE("GPL");
379