1// SPDX-License-Identifier: GPL-2.0+
  2/*
  3 * Freescale i.MX drm driver
  4 *
  5 * Copyright (C) 2011 Sascha Hauer, Pengutronix
  6 */
  7
  8#include <linux/component.h>
  9#include <linux/device.h>
 10#include <linux/dma-buf.h>
 11#include <linux/module.h>
 12#include <linux/platform_device.h>
 13
 14#include <video/imx-ipu-v3.h>
 15
 16#include <drm/drm_atomic.h>
 17#include <drm/drm_atomic_helper.h>
 18#include <drm/drm_drv.h>
 19#include <drm/drm_fb_cma_helper.h>
 20#include <drm/drm_fb_helper.h>
 21#include <drm/drm_gem_cma_helper.h>
 22#include <drm/drm_gem_framebuffer_helper.h>
 23#include <drm/drm_of.h>
 24#include <drm/drm_plane_helper.h>
 25#include <drm/drm_probe_helper.h>
 26#include <drm/drm_vblank.h>
 27
 28#include "imx-drm.h"
 29#include "ipuv3-plane.h"
 30
 31#define MAX_CRTC	4
 32
 33static int legacyfb_depth = 16;
 34module_param(legacyfb_depth, int, 0444);
 35
 36DEFINE_DRM_GEM_CMA_FOPS(imx_drm_driver_fops);
 37
 38void imx_drm_connector_destroy(struct drm_connector *connector)
 39{
 40	drm_connector_unregister(connector);
 41	drm_connector_cleanup(connector);
 42}
 43EXPORT_SYMBOL_GPL(imx_drm_connector_destroy);
 44
 45void imx_drm_encoder_destroy(struct drm_encoder *encoder)
 46{
 47	drm_encoder_cleanup(encoder);
 48}
 49EXPORT_SYMBOL_GPL(imx_drm_encoder_destroy);
 50
 51static int imx_drm_atomic_check(struct drm_device *dev,
 52				struct drm_atomic_state *state)
 53{
 54	int ret;
 55
 56	ret = drm_atomic_helper_check(dev, state);
 57	if (ret)
 58		return ret;
 59
 60	/*
 61	 * Check modeset again in case crtc_state->mode_changed is
 62	 * updated in plane's ->atomic_check callback.
 63	 */
 64	ret = drm_atomic_helper_check_modeset(dev, state);
 65	if (ret)
 66		return ret;
 67
 68	/* Assign PRG/PRE channels and check if all constrains are satisfied. */
 69	ret = ipu_planes_assign_pre(dev, state);
 70	if (ret)
 71		return ret;
 72
 73	return ret;
 74}
 75
 76static const struct drm_mode_config_funcs imx_drm_mode_config_funcs = {
 77	.fb_create = drm_gem_fb_create,
 78	.atomic_check = imx_drm_atomic_check,
 79	.atomic_commit = drm_atomic_helper_commit,
 80};
 81
 82static void imx_drm_atomic_commit_tail(struct drm_atomic_state *state)
 83{
 84	struct drm_device *dev = state->dev;
 85	struct drm_plane *plane;
 86	struct drm_plane_state *old_plane_state, *new_plane_state;
 87	bool plane_disabling = false;
 88	int i;
 89
 90	drm_atomic_helper_commit_modeset_disables(dev, state);
 91
 92	drm_atomic_helper_commit_planes(dev, state,
 93				DRM_PLANE_COMMIT_ACTIVE_ONLY |
 94				DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET);
 95
 96	drm_atomic_helper_commit_modeset_enables(dev, state);
 97
 98	for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
 99		if (drm_atomic_plane_disabling(old_plane_state, new_plane_state))
100			plane_disabling = true;
101	}
102
103	/*
104	 * The flip done wait is only strictly required by imx-drm if a deferred
105	 * plane disable is in-flight. As the core requires blocking commits
106	 * to wait for the flip it is done here unconditionally. This keeps the
107	 * workitem around a bit longer than required for the majority of
108	 * non-blocking commits, but we accept that for the sake of simplicity.
109	 */
110	drm_atomic_helper_wait_for_flip_done(dev, state);
111
112	if (plane_disabling) {
113		for_each_old_plane_in_state(state, plane, old_plane_state, i)
114			ipu_plane_disable_deferred(plane);
115
116	}
117
118	drm_atomic_helper_commit_hw_done(state);
119}
120
121static const struct drm_mode_config_helper_funcs imx_drm_mode_config_helpers = {
122	.atomic_commit_tail = imx_drm_atomic_commit_tail,
123};
124
125
126int imx_drm_encoder_parse_of(struct drm_device *drm,
127	struct drm_encoder *encoder, struct device_node *np)
128{
129	uint32_t crtc_mask = drm_of_find_possible_crtcs(drm, np);
130
131	/*
132	 * If we failed to find the CRTC(s) which this encoder is
133	 * supposed to be connected to, it's because the CRTC has
134	 * not been registered yet.  Defer probing, and hope that
135	 * the required CRTC is added later.
136	 */
137	if (crtc_mask == 0)
138		return -EPROBE_DEFER;
139
140	encoder->possible_crtcs = crtc_mask;
141
142	/* FIXME: this is the mask of outputs which can clone this output. */
143	encoder->possible_clones = ~0;
144
145	return 0;
146}
147EXPORT_SYMBOL_GPL(imx_drm_encoder_parse_of);
148
149static const struct drm_ioctl_desc imx_drm_ioctls[] = {
150	/* none so far */
151};
152
153static struct drm_driver imx_drm_driver = {
154	.driver_features	= DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
155	.gem_free_object_unlocked = drm_gem_cma_free_object,
156	.gem_vm_ops		= &drm_gem_cma_vm_ops,
157	.dumb_create		= drm_gem_cma_dumb_create,
158
159	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
160	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
161	.gem_prime_get_sg_table	= drm_gem_cma_prime_get_sg_table,
162	.gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
163	.gem_prime_vmap		= drm_gem_cma_prime_vmap,
164	.gem_prime_vunmap	= drm_gem_cma_prime_vunmap,
165	.gem_prime_mmap		= drm_gem_cma_prime_mmap,
166	.ioctls			= imx_drm_ioctls,
167	.num_ioctls		= ARRAY_SIZE(imx_drm_ioctls),
168	.fops			= &imx_drm_driver_fops,
169	.name			= "imx-drm",
170	.desc			= "i.MX DRM graphics",
171	.date			= "20120507",
172	.major			= 1,
173	.minor			= 0,
174	.patchlevel		= 0,
175};
176
177static int compare_of(struct device *dev, void *data)
178{
179	struct device_node *np = data;
180
181	/* Special case for DI, dev->of_node may not be set yet */
182	if (strcmp(dev->driver->name, "imx-ipuv3-crtc") == 0) {
183		struct ipu_client_platformdata *pdata = dev->platform_data;
184
185		return pdata->of_node == np;
186	}
187
188	/* Special case for LDB, one device for two channels */
189	if (of_node_name_eq(np, "lvds-channel")) {
190		np = of_get_parent(np);
191		of_node_put(np);
192	}
193
194	return dev->of_node == np;
195}
196
197static int imx_drm_bind(struct device *dev)
198{
199	struct drm_device *drm;
200	int ret;
201
202	drm = drm_dev_alloc(&imx_drm_driver, dev);
203	if (IS_ERR(drm))
204		return PTR_ERR(drm);
205
206	/*
207	 * enable drm irq mode.
208	 * - with irq_enabled = true, we can use the vblank feature.
209	 *
210	 * P.S. note that we wouldn't use drm irq handler but
211	 *      just specific driver own one instead because
212	 *      drm framework supports only one irq handler and
213	 *      drivers can well take care of their interrupts
214	 */
215	drm->irq_enabled = true;
216
217	/*
218	 * set max width and height as default value(4096x4096).
219	 * this value would be used to check framebuffer size limitation
220	 * at drm_mode_addfb().
221	 */
222	drm->mode_config.min_width = 1;
223	drm->mode_config.min_height = 1;
224	drm->mode_config.max_width = 4096;
225	drm->mode_config.max_height = 4096;
226	drm->mode_config.funcs = &imx_drm_mode_config_funcs;
227	drm->mode_config.helper_private = &imx_drm_mode_config_helpers;
228	drm->mode_config.allow_fb_modifiers = true;
229	drm->mode_config.normalize_zpos = true;
230
231	drm_mode_config_init(drm);
232
233	ret = drm_vblank_init(drm, MAX_CRTC);
234	if (ret)
235		goto err_kms;
236
237	dev_set_drvdata(dev, drm);
238
239	/* Now try and bind all our sub-components */
240	ret = component_bind_all(dev, drm);
241	if (ret)
242		goto err_kms;
243
244	drm_mode_config_reset(drm);
245
246	/*
247	 * All components are now initialised, so setup the fb helper.
248	 * The fb helper takes copies of key hardware information, so the
249	 * crtcs/connectors/encoders must not change after this point.
250	 */
251	if (legacyfb_depth != 16 && legacyfb_depth != 32) {
252		dev_warn(dev, "Invalid legacyfb_depth.  Defaulting to 16bpp\n");
253		legacyfb_depth = 16;
254	}
255
256	drm_kms_helper_poll_init(drm);
257
258	ret = drm_dev_register(drm, 0);
259	if (ret)
260		goto err_poll_fini;
261
262	drm_fbdev_generic_setup(drm, legacyfb_depth);
263
264	return 0;
265
266err_poll_fini:
267	drm_kms_helper_poll_fini(drm);
268	component_unbind_all(drm->dev, drm);
269err_kms:
270	drm_mode_config_cleanup(drm);
271	drm_dev_put(drm);
272
273	return ret;
274}
275
276static void imx_drm_unbind(struct device *dev)
277{
278	struct drm_device *drm = dev_get_drvdata(dev);
279
280	drm_dev_unregister(drm);
281
282	drm_kms_helper_poll_fini(drm);
283
284	drm_mode_config_cleanup(drm);
285
286	component_unbind_all(drm->dev, drm);
287	dev_set_drvdata(dev, NULL);
288
289	drm_dev_put(drm);
290}
291
292static const struct component_master_ops imx_drm_ops = {
293	.bind = imx_drm_bind,
294	.unbind = imx_drm_unbind,
295};
296
297static int imx_drm_platform_probe(struct platform_device *pdev)
298{
299	int ret = drm_of_component_probe(&pdev->dev, compare_of, &imx_drm_ops);
300
301	if (!ret)
302		ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
303
304	return ret;
305}
306
307static int imx_drm_platform_remove(struct platform_device *pdev)
308{
309	component_master_del(&pdev->dev, &imx_drm_ops);
310	return 0;
311}
312
313#ifdef CONFIG_PM_SLEEP
314static int imx_drm_suspend(struct device *dev)
315{
316	struct drm_device *drm_dev = dev_get_drvdata(dev);
317
318	return drm_mode_config_helper_suspend(drm_dev);
319}
320
321static int imx_drm_resume(struct device *dev)
322{
323	struct drm_device *drm_dev = dev_get_drvdata(dev);
324
325	return drm_mode_config_helper_resume(drm_dev);
326}
327#endif
328
329static SIMPLE_DEV_PM_OPS(imx_drm_pm_ops, imx_drm_suspend, imx_drm_resume);
330
331static const struct of_device_id imx_drm_dt_ids[] = {
332	{ .compatible = "fsl,imx-display-subsystem", },
333	{ /* sentinel */ },
334};
335MODULE_DEVICE_TABLE(of, imx_drm_dt_ids);
336
337static struct platform_driver imx_drm_pdrv = {
338	.probe		= imx_drm_platform_probe,
339	.remove		= imx_drm_platform_remove,
340	.driver		= {
341		.name	= "imx-drm",
342		.pm	= &imx_drm_pm_ops,
343		.of_match_table = imx_drm_dt_ids,
344	},
345};
346
347static struct platform_driver * const drivers[] = {
348	&imx_drm_pdrv,
349	&ipu_drm_driver,
350};
351
352static int __init imx_drm_init(void)
353{
354	return platform_register_drivers(drivers, ARRAY_SIZE(drivers));
355}
356module_init(imx_drm_init);
357
358static void __exit imx_drm_exit(void)
359{
360	platform_unregister_drivers(drivers, ARRAY_SIZE(drivers));
361}
362module_exit(imx_drm_exit);
363
364MODULE_AUTHOR("Sascha Hauer <s.hauer@pengutronix.de>");
365MODULE_DESCRIPTION("i.MX drm driver core");
366MODULE_LICENSE("GPL");