1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * ZynqMP DisplayPort Subsystem Driver
4  *
5  * Copyright (C) 2017 - 2020 Xilinx, Inc.
6  *
7  * Authors:
8  * - Hyun Woo Kwon <hyun.kwon@xilinx.com>
9  * - Laurent Pinchart <laurent.pinchart@ideasonboard.com>
10  */
11 
12 #include <linux/clk.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/module.h>
15 #include <linux/of_reserved_mem.h>
16 #include <linux/platform_device.h>
17 #include <linux/pm_runtime.h>
18 
19 #include <drm/drm_atomic_helper.h>
20 #include <drm/drm_device.h>
21 #include <drm/drm_drv.h>
22 #include <drm/drm_fb_helper.h>
23 #include <drm/drm_fourcc.h>
24 #include <drm/drm_gem_cma_helper.h>
25 #include <drm/drm_gem_framebuffer_helper.h>
26 #include <drm/drm_managed.h>
27 #include <drm/drm_mode_config.h>
28 #include <drm/drm_probe_helper.h>
29 #include <drm/drm_vblank.h>
30 
31 #include "zynqmp_disp.h"
32 #include "zynqmp_dp.h"
33 #include "zynqmp_dpsub.h"
34 
35 /* -----------------------------------------------------------------------------
36  * Dumb Buffer & Framebuffer Allocation
37  */
38 
39 static int zynqmp_dpsub_dumb_create(struct drm_file *file_priv,
40 				    struct drm_device *drm,
41 				    struct drm_mode_create_dumb *args)
42 {
43 	struct zynqmp_dpsub *dpsub = to_zynqmp_dpsub(drm);
44 	unsigned int pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
45 
46 	/* Enforce the alignment constraints of the DMA engine. */
47 	args->pitch = ALIGN(pitch, dpsub->dma_align);
48 
49 	return drm_gem_cma_dumb_create_internal(file_priv, drm, args);
50 }
51 
52 static struct drm_framebuffer *
53 zynqmp_dpsub_fb_create(struct drm_device *drm, struct drm_file *file_priv,
54 		       const struct drm_mode_fb_cmd2 *mode_cmd)
55 {
56 	struct zynqmp_dpsub *dpsub = to_zynqmp_dpsub(drm);
57 	struct drm_mode_fb_cmd2 cmd = *mode_cmd;
58 	unsigned int i;
59 
60 	/* Enforce the alignment constraints of the DMA engine. */
61 	for (i = 0; i < ARRAY_SIZE(cmd.pitches); ++i)
62 		cmd.pitches[i] = ALIGN(cmd.pitches[i], dpsub->dma_align);
63 
64 	return drm_gem_fb_create(drm, file_priv, &cmd);
65 }
66 
67 static const struct drm_mode_config_funcs zynqmp_dpsub_mode_config_funcs = {
68 	.fb_create		= zynqmp_dpsub_fb_create,
69 	.atomic_check		= drm_atomic_helper_check,
70 	.atomic_commit		= drm_atomic_helper_commit,
71 };
72 
73 /* -----------------------------------------------------------------------------
74  * DRM/KMS Driver
75  */
76 
77 DEFINE_DRM_GEM_CMA_FOPS(zynqmp_dpsub_drm_fops);
78 
79 static const struct drm_driver zynqmp_dpsub_drm_driver = {
80 	.driver_features		= DRIVER_MODESET | DRIVER_GEM |
81 					  DRIVER_ATOMIC,
82 
83 	DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(zynqmp_dpsub_dumb_create),
84 
85 	.fops				= &zynqmp_dpsub_drm_fops,
86 
87 	.name				= "zynqmp-dpsub",
88 	.desc				= "Xilinx DisplayPort Subsystem Driver",
89 	.date				= "20130509",
90 	.major				= 1,
91 	.minor				= 0,
92 };
93 
94 static int zynqmp_dpsub_drm_init(struct zynqmp_dpsub *dpsub)
95 {
96 	struct drm_device *drm = &dpsub->drm;
97 	int ret;
98 
99 	/* Initialize mode config, vblank and the KMS poll helper. */
100 	ret = drmm_mode_config_init(drm);
101 	if (ret < 0)
102 		return ret;
103 
104 	drm->mode_config.funcs = &zynqmp_dpsub_mode_config_funcs;
105 	drm->mode_config.min_width = 0;
106 	drm->mode_config.min_height = 0;
107 	drm->mode_config.max_width = ZYNQMP_DISP_MAX_WIDTH;
108 	drm->mode_config.max_height = ZYNQMP_DISP_MAX_HEIGHT;
109 
110 	ret = drm_vblank_init(drm, 1);
111 	if (ret)
112 		return ret;
113 
114 	drm->irq_enabled = 1;
115 
116 	drm_kms_helper_poll_init(drm);
117 
118 	/*
119 	 * Initialize the DISP and DP components. This will creates planes,
120 	 * CRTC, encoder and connector. The DISP should be initialized first as
121 	 * the DP encoder needs the CRTC.
122 	 */
123 	ret = zynqmp_disp_drm_init(dpsub);
124 	if (ret)
125 		goto err_poll_fini;
126 
127 	ret = zynqmp_dp_drm_init(dpsub);
128 	if (ret)
129 		goto err_poll_fini;
130 
131 	/* Reset all components and register the DRM device. */
132 	drm_mode_config_reset(drm);
133 
134 	ret = drm_dev_register(drm, 0);
135 	if (ret < 0)
136 		goto err_poll_fini;
137 
138 	/* Initialize fbdev generic emulation. */
139 	drm_fbdev_generic_setup(drm, 24);
140 
141 	return 0;
142 
143 err_poll_fini:
144 	drm_kms_helper_poll_fini(drm);
145 	return ret;
146 }
147 
148 /* -----------------------------------------------------------------------------
149  * Power Management
150  */
151 
152 static int __maybe_unused zynqmp_dpsub_suspend(struct device *dev)
153 {
154 	struct zynqmp_dpsub *dpsub = dev_get_drvdata(dev);
155 
156 	return drm_mode_config_helper_suspend(&dpsub->drm);
157 }
158 
159 static int __maybe_unused zynqmp_dpsub_resume(struct device *dev)
160 {
161 	struct zynqmp_dpsub *dpsub = dev_get_drvdata(dev);
162 
163 	return drm_mode_config_helper_resume(&dpsub->drm);
164 }
165 
166 static const struct dev_pm_ops zynqmp_dpsub_pm_ops = {
167 	SET_SYSTEM_SLEEP_PM_OPS(zynqmp_dpsub_suspend, zynqmp_dpsub_resume)
168 };
169 
170 /* -----------------------------------------------------------------------------
171  * Probe & Remove
172  */
173 
174 static int zynqmp_dpsub_init_clocks(struct zynqmp_dpsub *dpsub)
175 {
176 	int ret;
177 
178 	dpsub->apb_clk = devm_clk_get(dpsub->dev, "dp_apb_clk");
179 	if (IS_ERR(dpsub->apb_clk))
180 		return PTR_ERR(dpsub->apb_clk);
181 
182 	ret = clk_prepare_enable(dpsub->apb_clk);
183 	if (ret) {
184 		dev_err(dpsub->dev, "failed to enable the APB clock\n");
185 		return ret;
186 	}
187 
188 	return 0;
189 }
190 
191 static int zynqmp_dpsub_probe(struct platform_device *pdev)
192 {
193 	struct zynqmp_dpsub *dpsub;
194 	int ret;
195 
196 	/* Allocate private data. */
197 	dpsub = devm_drm_dev_alloc(&pdev->dev, &zynqmp_dpsub_drm_driver,
198 				   struct zynqmp_dpsub, drm);
199 	if (IS_ERR(dpsub))
200 		return PTR_ERR(dpsub);
201 
202 	dpsub->dev = &pdev->dev;
203 	platform_set_drvdata(pdev, dpsub);
204 
205 	dma_set_mask(dpsub->dev, DMA_BIT_MASK(ZYNQMP_DISP_MAX_DMA_BIT));
206 
207 	/* Try the reserved memory. Proceed if there's none. */
208 	of_reserved_mem_device_init(&pdev->dev);
209 
210 	ret = zynqmp_dpsub_init_clocks(dpsub);
211 	if (ret < 0)
212 		goto err_mem;
213 
214 	pm_runtime_enable(&pdev->dev);
215 
216 	/*
217 	 * DP should be probed first so that the zynqmp_disp can set the output
218 	 * format accordingly.
219 	 */
220 	ret = zynqmp_dp_probe(dpsub, &dpsub->drm);
221 	if (ret)
222 		goto err_pm;
223 
224 	ret = zynqmp_disp_probe(dpsub, &dpsub->drm);
225 	if (ret)
226 		goto err_dp;
227 
228 	ret = zynqmp_dpsub_drm_init(dpsub);
229 	if (ret)
230 		goto err_disp;
231 
232 	dev_info(&pdev->dev, "ZynqMP DisplayPort Subsystem driver probed");
233 
234 	return 0;
235 
236 err_disp:
237 	zynqmp_disp_remove(dpsub);
238 err_dp:
239 	zynqmp_dp_remove(dpsub);
240 err_pm:
241 	pm_runtime_disable(&pdev->dev);
242 	clk_disable_unprepare(dpsub->apb_clk);
243 err_mem:
244 	of_reserved_mem_device_release(&pdev->dev);
245 	return ret;
246 }
247 
248 static int zynqmp_dpsub_remove(struct platform_device *pdev)
249 {
250 	struct zynqmp_dpsub *dpsub = platform_get_drvdata(pdev);
251 	struct drm_device *drm = &dpsub->drm;
252 
253 	drm_dev_unregister(drm);
254 	drm_atomic_helper_shutdown(drm);
255 	drm_kms_helper_poll_fini(drm);
256 
257 	zynqmp_disp_remove(dpsub);
258 	zynqmp_dp_remove(dpsub);
259 
260 	pm_runtime_disable(&pdev->dev);
261 	clk_disable_unprepare(dpsub->apb_clk);
262 	of_reserved_mem_device_release(&pdev->dev);
263 
264 	return 0;
265 }
266 
267 static void zynqmp_dpsub_shutdown(struct platform_device *pdev)
268 {
269 	struct zynqmp_dpsub *dpsub = platform_get_drvdata(pdev);
270 
271 	drm_atomic_helper_shutdown(&dpsub->drm);
272 }
273 
274 static const struct of_device_id zynqmp_dpsub_of_match[] = {
275 	{ .compatible = "xlnx,zynqmp-dpsub-1.7", },
276 	{ /* end of table */ },
277 };
278 MODULE_DEVICE_TABLE(of, zynqmp_dpsub_of_match);
279 
280 static struct platform_driver zynqmp_dpsub_driver = {
281 	.probe			= zynqmp_dpsub_probe,
282 	.remove			= zynqmp_dpsub_remove,
283 	.shutdown		= zynqmp_dpsub_shutdown,
284 	.driver			= {
285 		.name		= "zynqmp-dpsub",
286 		.pm		= &zynqmp_dpsub_pm_ops,
287 		.of_match_table	= zynqmp_dpsub_of_match,
288 	},
289 };
290 
291 module_platform_driver(zynqmp_dpsub_driver);
292 
293 MODULE_AUTHOR("Xilinx, Inc.");
294 MODULE_DESCRIPTION("ZynqMP DP Subsystem Driver");
295 MODULE_LICENSE("GPL v2");
296