2 * Freescale i.MX drm driver
4 * Copyright (C) 2011 Sascha Hauer, Pengutronix
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 #include <linux/component.h>
17 #include <linux/device.h>
19 #include <linux/module.h>
20 #include <linux/of_graph.h>
21 #include <linux/platform_device.h>
23 #include <drm/drm_fb_helper.h>
24 #include <drm/drm_crtc_helper.h>
25 #include <drm/drm_gem_cma_helper.h>
26 #include <drm/drm_fb_cma_helper.h>
27 #include <drm/drm_plane_helper.h>
33 struct imx_drm_component {
34 struct device_node *of_node;
35 struct list_head list;
38 struct imx_drm_device {
39 struct drm_device *drm;
40 struct imx_drm_crtc *crtc[MAX_CRTC];
42 struct drm_fbdev_cma *fbhelper;
46 struct drm_crtc *crtc;
48 struct imx_drm_crtc_helper_funcs imx_drm_helper_funcs;
49 struct device_node *port;
52 static int legacyfb_depth = 16;
53 module_param(legacyfb_depth, int, 0444);
55 int imx_drm_crtc_id(struct imx_drm_crtc *crtc)
59 EXPORT_SYMBOL_GPL(imx_drm_crtc_id);
61 static void imx_drm_driver_lastclose(struct drm_device *drm)
63 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
64 struct imx_drm_device *imxdrm = drm->dev_private;
67 drm_fbdev_cma_restore_mode(imxdrm->fbhelper);
71 static int imx_drm_driver_unload(struct drm_device *drm)
73 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
74 struct imx_drm_device *imxdrm = drm->dev_private;
77 drm_kms_helper_poll_fini(drm);
79 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
81 drm_fbdev_cma_fini(imxdrm->fbhelper);
84 component_unbind_all(drm->dev, drm);
86 drm_vblank_cleanup(drm);
87 drm_mode_config_cleanup(drm);
89 platform_set_drvdata(drm->platformdev, NULL);
94 static struct imx_drm_crtc *imx_drm_find_crtc(struct drm_crtc *crtc)
96 struct imx_drm_device *imxdrm = crtc->dev->dev_private;
99 for (i = 0; i < MAX_CRTC; i++)
100 if (imxdrm->crtc[i] && imxdrm->crtc[i]->crtc == crtc)
101 return imxdrm->crtc[i];
106 int imx_drm_panel_format_pins(struct drm_encoder *encoder,
107 u32 interface_pix_fmt, int hsync_pin, int vsync_pin)
109 struct imx_drm_crtc_helper_funcs *helper;
110 struct imx_drm_crtc *imx_crtc;
112 imx_crtc = imx_drm_find_crtc(encoder->crtc);
116 helper = &imx_crtc->imx_drm_helper_funcs;
117 if (helper->set_interface_pix_fmt)
118 return helper->set_interface_pix_fmt(encoder->crtc,
119 encoder->encoder_type, interface_pix_fmt,
120 hsync_pin, vsync_pin);
123 EXPORT_SYMBOL_GPL(imx_drm_panel_format_pins);
125 int imx_drm_panel_format(struct drm_encoder *encoder, u32 interface_pix_fmt)
127 return imx_drm_panel_format_pins(encoder, interface_pix_fmt, 2, 3);
129 EXPORT_SYMBOL_GPL(imx_drm_panel_format);
131 int imx_drm_crtc_vblank_get(struct imx_drm_crtc *imx_drm_crtc)
133 return drm_vblank_get(imx_drm_crtc->crtc->dev, imx_drm_crtc->pipe);
135 EXPORT_SYMBOL_GPL(imx_drm_crtc_vblank_get);
137 void imx_drm_crtc_vblank_put(struct imx_drm_crtc *imx_drm_crtc)
139 drm_vblank_put(imx_drm_crtc->crtc->dev, imx_drm_crtc->pipe);
141 EXPORT_SYMBOL_GPL(imx_drm_crtc_vblank_put);
143 void imx_drm_handle_vblank(struct imx_drm_crtc *imx_drm_crtc)
145 drm_handle_vblank(imx_drm_crtc->crtc->dev, imx_drm_crtc->pipe);
147 EXPORT_SYMBOL_GPL(imx_drm_handle_vblank);
149 static int imx_drm_enable_vblank(struct drm_device *drm, int crtc)
151 struct imx_drm_device *imxdrm = drm->dev_private;
152 struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[crtc];
158 if (!imx_drm_crtc->imx_drm_helper_funcs.enable_vblank)
161 ret = imx_drm_crtc->imx_drm_helper_funcs.enable_vblank(
167 static void imx_drm_disable_vblank(struct drm_device *drm, int crtc)
169 struct imx_drm_device *imxdrm = drm->dev_private;
170 struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[crtc];
175 if (!imx_drm_crtc->imx_drm_helper_funcs.disable_vblank)
178 imx_drm_crtc->imx_drm_helper_funcs.disable_vblank(imx_drm_crtc->crtc);
181 static void imx_drm_driver_preclose(struct drm_device *drm,
182 struct drm_file *file)
186 if (!file->is_master)
189 for (i = 0; i < MAX_CRTC; i++)
190 imx_drm_disable_vblank(drm, i);
193 static const struct file_operations imx_drm_driver_fops = {
194 .owner = THIS_MODULE,
196 .release = drm_release,
197 .unlocked_ioctl = drm_ioctl,
198 .mmap = drm_gem_cma_mmap,
201 .llseek = noop_llseek,
204 void imx_drm_connector_destroy(struct drm_connector *connector)
206 drm_connector_unregister(connector);
207 drm_connector_cleanup(connector);
209 EXPORT_SYMBOL_GPL(imx_drm_connector_destroy);
211 void imx_drm_encoder_destroy(struct drm_encoder *encoder)
213 drm_encoder_cleanup(encoder);
215 EXPORT_SYMBOL_GPL(imx_drm_encoder_destroy);
217 static void imx_drm_output_poll_changed(struct drm_device *drm)
219 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
220 struct imx_drm_device *imxdrm = drm->dev_private;
222 drm_fbdev_cma_hotplug_event(imxdrm->fbhelper);
226 static struct drm_mode_config_funcs imx_drm_mode_config_funcs = {
227 .fb_create = drm_fb_cma_create,
228 .output_poll_changed = imx_drm_output_poll_changed,
232 * Main DRM initialisation. This binds, initialises and registers
233 * with DRM the subcomponents of the driver.
235 static int imx_drm_driver_load(struct drm_device *drm, unsigned long flags)
237 struct imx_drm_device *imxdrm;
238 struct drm_connector *connector;
241 imxdrm = devm_kzalloc(drm->dev, sizeof(*imxdrm), GFP_KERNEL);
247 drm->dev_private = imxdrm;
250 * enable drm irq mode.
251 * - with irq_enabled = true, we can use the vblank feature.
253 * P.S. note that we wouldn't use drm irq handler but
254 * just specific driver own one instead because
255 * drm framework supports only one irq handler and
256 * drivers can well take care of their interrupts
258 drm->irq_enabled = true;
261 * set max width and height as default value(4096x4096).
262 * this value would be used to check framebuffer size limitation
263 * at drm_mode_addfb().
265 drm->mode_config.min_width = 64;
266 drm->mode_config.min_height = 64;
267 drm->mode_config.max_width = 4096;
268 drm->mode_config.max_height = 4096;
269 drm->mode_config.funcs = &imx_drm_mode_config_funcs;
271 drm_mode_config_init(drm);
273 ret = drm_vblank_init(drm, MAX_CRTC);
278 * with vblank_disable_allowed = true, vblank interrupt will be
279 * disabled by drm timer once a current process gives up ownership
280 * of vblank event. (after drm_vblank_put function is called)
282 drm->vblank_disable_allowed = true;
284 platform_set_drvdata(drm->platformdev, drm);
286 /* Now try and bind all our sub-components */
287 ret = component_bind_all(drm->dev, drm);
292 * All components are now added, we can publish the connector sysfs
293 * entries to userspace. This will generate hotplug events and so
294 * userspace will expect to be able to access DRM at this point.
296 list_for_each_entry(connector, &drm->mode_config.connector_list, head) {
297 ret = drm_connector_register(connector);
300 "[CONNECTOR:%d:%s] drm_connector_register failed: %d\n",
302 connector->name, ret);
308 * All components are now initialised, so setup the fb helper.
309 * The fb helper takes copies of key hardware information, so the
310 * crtcs/connectors/encoders must not change after this point.
312 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
313 if (legacyfb_depth != 16 && legacyfb_depth != 32) {
314 dev_warn(drm->dev, "Invalid legacyfb_depth. Defaulting to 16bpp\n");
317 imxdrm->fbhelper = drm_fbdev_cma_init(drm, legacyfb_depth,
318 drm->mode_config.num_crtc, MAX_CRTC);
319 if (IS_ERR(imxdrm->fbhelper)) {
320 ret = PTR_ERR(imxdrm->fbhelper);
321 imxdrm->fbhelper = NULL;
326 drm_kms_helper_poll_init(drm);
331 component_unbind_all(drm->dev, drm);
333 drm_vblank_cleanup(drm);
335 drm_mode_config_cleanup(drm);
341 * imx_drm_add_crtc - add a new crtc
343 int imx_drm_add_crtc(struct drm_device *drm, struct drm_crtc *crtc,
344 struct imx_drm_crtc **new_crtc,
345 const struct imx_drm_crtc_helper_funcs *imx_drm_helper_funcs,
346 struct device_node *port)
348 struct imx_drm_device *imxdrm = drm->dev_private;
349 struct imx_drm_crtc *imx_drm_crtc;
353 * The vblank arrays are dimensioned by MAX_CRTC - we can't
354 * pass IDs greater than this to those functions.
356 if (imxdrm->pipes >= MAX_CRTC)
359 if (imxdrm->drm->open_count)
362 imx_drm_crtc = kzalloc(sizeof(*imx_drm_crtc), GFP_KERNEL);
366 imx_drm_crtc->imx_drm_helper_funcs = *imx_drm_helper_funcs;
367 imx_drm_crtc->pipe = imxdrm->pipes++;
368 imx_drm_crtc->port = port;
369 imx_drm_crtc->crtc = crtc;
371 imxdrm->crtc[imx_drm_crtc->pipe] = imx_drm_crtc;
373 *new_crtc = imx_drm_crtc;
375 ret = drm_mode_crtc_set_gamma_size(imx_drm_crtc->crtc, 256);
379 drm_crtc_helper_add(crtc,
380 imx_drm_crtc->imx_drm_helper_funcs.crtc_helper_funcs);
382 drm_crtc_init(drm, crtc,
383 imx_drm_crtc->imx_drm_helper_funcs.crtc_funcs);
388 imxdrm->crtc[imx_drm_crtc->pipe] = NULL;
392 EXPORT_SYMBOL_GPL(imx_drm_add_crtc);
395 * imx_drm_remove_crtc - remove a crtc
397 int imx_drm_remove_crtc(struct imx_drm_crtc *imx_drm_crtc)
399 struct imx_drm_device *imxdrm = imx_drm_crtc->crtc->dev->dev_private;
401 drm_crtc_cleanup(imx_drm_crtc->crtc);
403 imxdrm->crtc[imx_drm_crtc->pipe] = NULL;
409 EXPORT_SYMBOL_GPL(imx_drm_remove_crtc);
412 * Find the DRM CRTC possible mask for the connected endpoint.
414 * The encoder possible masks are defined by their position in the
415 * mode_config crtc_list. This means that CRTCs must not be added
416 * or removed once the DRM device has been fully initialised.
418 static uint32_t imx_drm_find_crtc_mask(struct imx_drm_device *imxdrm,
419 struct device_node *endpoint)
421 struct device_node *port;
424 port = of_graph_get_remote_port(endpoint);
429 for (i = 0; i < MAX_CRTC; i++) {
430 struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[i];
432 if (imx_drm_crtc && imx_drm_crtc->port == port)
433 return drm_crtc_mask(imx_drm_crtc->crtc);
439 static struct device_node *imx_drm_of_get_next_endpoint(
440 const struct device_node *parent, struct device_node *prev)
442 struct device_node *node = of_graph_get_next_endpoint(parent, prev);
448 int imx_drm_encoder_parse_of(struct drm_device *drm,
449 struct drm_encoder *encoder, struct device_node *np)
451 struct imx_drm_device *imxdrm = drm->dev_private;
452 struct device_node *ep = NULL;
453 uint32_t crtc_mask = 0;
459 ep = imx_drm_of_get_next_endpoint(np, ep);
463 mask = imx_drm_find_crtc_mask(imxdrm, ep);
466 * If we failed to find the CRTC(s) which this encoder is
467 * supposed to be connected to, it's because the CRTC has
468 * not been registered yet. Defer probing, and hope that
469 * the required CRTC is added later.
472 return -EPROBE_DEFER;
481 encoder->possible_crtcs = crtc_mask;
483 /* FIXME: this is the mask of outputs which can clone this output. */
484 encoder->possible_clones = ~0;
488 EXPORT_SYMBOL_GPL(imx_drm_encoder_parse_of);
491 * @node: device tree node containing encoder input ports
492 * @encoder: drm_encoder
494 int imx_drm_encoder_get_mux_id(struct device_node *node,
495 struct drm_encoder *encoder)
497 struct imx_drm_crtc *imx_crtc = imx_drm_find_crtc(encoder->crtc);
498 struct device_node *ep = NULL;
499 struct of_endpoint endpoint;
500 struct device_node *port;
503 if (!node || !imx_crtc)
507 ep = imx_drm_of_get_next_endpoint(node, ep);
511 port = of_graph_get_remote_port(ep);
513 if (port == imx_crtc->port) {
514 ret = of_graph_parse_endpoint(ep, &endpoint);
515 return ret ? ret : endpoint.port;
521 EXPORT_SYMBOL_GPL(imx_drm_encoder_get_mux_id);
523 static const struct drm_ioctl_desc imx_drm_ioctls[] = {
527 static struct drm_driver imx_drm_driver = {
528 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME,
529 .load = imx_drm_driver_load,
530 .unload = imx_drm_driver_unload,
531 .lastclose = imx_drm_driver_lastclose,
532 .preclose = imx_drm_driver_preclose,
533 .set_busid = drm_platform_set_busid,
534 .gem_free_object = drm_gem_cma_free_object,
535 .gem_vm_ops = &drm_gem_cma_vm_ops,
536 .dumb_create = drm_gem_cma_dumb_create,
537 .dumb_map_offset = drm_gem_cma_dumb_map_offset,
538 .dumb_destroy = drm_gem_dumb_destroy,
540 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
541 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
542 .gem_prime_import = drm_gem_prime_import,
543 .gem_prime_export = drm_gem_prime_export,
544 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
545 .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
546 .gem_prime_vmap = drm_gem_cma_prime_vmap,
547 .gem_prime_vunmap = drm_gem_cma_prime_vunmap,
548 .gem_prime_mmap = drm_gem_cma_prime_mmap,
549 .get_vblank_counter = drm_vblank_count,
550 .enable_vblank = imx_drm_enable_vblank,
551 .disable_vblank = imx_drm_disable_vblank,
552 .ioctls = imx_drm_ioctls,
553 .num_ioctls = ARRAY_SIZE(imx_drm_ioctls),
554 .fops = &imx_drm_driver_fops,
556 .desc = "i.MX DRM graphics",
563 static int compare_of(struct device *dev, void *data)
565 struct device_node *np = data;
567 /* Special case for LDB, one device for two channels */
568 if (of_node_cmp(np->name, "lvds-channel") == 0) {
569 np = of_get_parent(np);
573 return dev->of_node == np;
576 static int imx_drm_bind(struct device *dev)
578 return drm_platform_init(&imx_drm_driver, to_platform_device(dev));
581 static void imx_drm_unbind(struct device *dev)
583 drm_put_dev(dev_get_drvdata(dev));
586 static const struct component_master_ops imx_drm_ops = {
587 .bind = imx_drm_bind,
588 .unbind = imx_drm_unbind,
591 static int imx_drm_platform_probe(struct platform_device *pdev)
593 struct device_node *ep, *port, *remote;
594 struct component_match *match = NULL;
599 * Bind the IPU display interface ports first, so that
600 * imx_drm_encoder_parse_of called from encoder .bind callbacks
604 port = of_parse_phandle(pdev->dev.of_node, "ports", i);
608 component_match_add(&pdev->dev, &match, compare_of, port);
612 dev_err(&pdev->dev, "missing 'ports' property\n");
616 /* Then bind all encoders */
618 port = of_parse_phandle(pdev->dev.of_node, "ports", i);
622 for_each_child_of_node(port, ep) {
623 remote = of_graph_get_remote_port_parent(ep);
624 if (!remote || !of_device_is_available(remote)) {
627 } else if (!of_device_is_available(remote->parent)) {
628 dev_warn(&pdev->dev, "parent device of %s is not available\n",
634 component_match_add(&pdev->dev, &match, compare_of,
641 ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
645 return component_master_add_with_match(&pdev->dev, &imx_drm_ops, match);
648 static int imx_drm_platform_remove(struct platform_device *pdev)
650 component_master_del(&pdev->dev, &imx_drm_ops);
654 #ifdef CONFIG_PM_SLEEP
655 static int imx_drm_suspend(struct device *dev)
657 struct drm_device *drm_dev = dev_get_drvdata(dev);
659 /* The drm_dev is NULL before .load hook is called */
663 drm_kms_helper_poll_disable(drm_dev);
668 static int imx_drm_resume(struct device *dev)
670 struct drm_device *drm_dev = dev_get_drvdata(dev);
675 drm_helper_resume_force_mode(drm_dev);
676 drm_kms_helper_poll_enable(drm_dev);
682 static SIMPLE_DEV_PM_OPS(imx_drm_pm_ops, imx_drm_suspend, imx_drm_resume);
684 static const struct of_device_id imx_drm_dt_ids[] = {
685 { .compatible = "fsl,imx-display-subsystem", },
688 MODULE_DEVICE_TABLE(of, imx_drm_dt_ids);
690 static struct platform_driver imx_drm_pdrv = {
691 .probe = imx_drm_platform_probe,
692 .remove = imx_drm_platform_remove,
695 .pm = &imx_drm_pm_ops,
696 .of_match_table = imx_drm_dt_ids,
699 module_platform_driver(imx_drm_pdrv);
701 MODULE_AUTHOR("Sascha Hauer <s.hauer@pengutronix.de>");
702 MODULE_DESCRIPTION("i.MX drm driver core");
703 MODULE_LICENSE("GPL");