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>
35 struct imx_drm_component {
36 struct device_node *of_node;
37 struct list_head list;
40 struct imx_drm_device {
41 struct drm_device *drm;
42 struct imx_drm_crtc *crtc[MAX_CRTC];
44 struct drm_fbdev_cma *fbhelper;
48 struct drm_crtc *crtc;
50 struct imx_drm_crtc_helper_funcs imx_drm_helper_funcs;
51 struct device_node *port;
54 static int legacyfb_depth = 16;
55 module_param(legacyfb_depth, int, 0444);
57 int imx_drm_crtc_id(struct imx_drm_crtc *crtc)
61 EXPORT_SYMBOL_GPL(imx_drm_crtc_id);
63 static void imx_drm_driver_lastclose(struct drm_device *drm)
65 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
66 struct imx_drm_device *imxdrm = drm->dev_private;
69 drm_fbdev_cma_restore_mode(imxdrm->fbhelper);
73 static int imx_drm_driver_unload(struct drm_device *drm)
75 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
76 struct imx_drm_device *imxdrm = drm->dev_private;
79 drm_kms_helper_poll_fini(drm);
81 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
83 drm_fbdev_cma_fini(imxdrm->fbhelper);
86 component_unbind_all(drm->dev, drm);
88 drm_vblank_cleanup(drm);
89 drm_mode_config_cleanup(drm);
91 platform_set_drvdata(drm->platformdev, NULL);
96 static struct imx_drm_crtc *imx_drm_find_crtc(struct drm_crtc *crtc)
98 struct imx_drm_device *imxdrm = crtc->dev->dev_private;
101 for (i = 0; i < MAX_CRTC; i++)
102 if (imxdrm->crtc[i] && imxdrm->crtc[i]->crtc == crtc)
103 return imxdrm->crtc[i];
108 int imx_drm_panel_format_pins(struct drm_encoder *encoder,
109 u32 interface_pix_fmt, int hsync_pin, int vsync_pin)
111 struct imx_drm_crtc_helper_funcs *helper;
112 struct imx_drm_crtc *imx_crtc;
114 imx_crtc = imx_drm_find_crtc(encoder->crtc);
118 helper = &imx_crtc->imx_drm_helper_funcs;
119 if (helper->set_interface_pix_fmt)
120 return helper->set_interface_pix_fmt(encoder->crtc,
121 encoder->encoder_type, interface_pix_fmt,
122 hsync_pin, vsync_pin);
125 EXPORT_SYMBOL_GPL(imx_drm_panel_format_pins);
127 int imx_drm_panel_format(struct drm_encoder *encoder, u32 interface_pix_fmt)
129 return imx_drm_panel_format_pins(encoder, interface_pix_fmt, 2, 3);
131 EXPORT_SYMBOL_GPL(imx_drm_panel_format);
133 int imx_drm_crtc_vblank_get(struct imx_drm_crtc *imx_drm_crtc)
135 return drm_vblank_get(imx_drm_crtc->crtc->dev, imx_drm_crtc->pipe);
137 EXPORT_SYMBOL_GPL(imx_drm_crtc_vblank_get);
139 void imx_drm_crtc_vblank_put(struct imx_drm_crtc *imx_drm_crtc)
141 drm_vblank_put(imx_drm_crtc->crtc->dev, imx_drm_crtc->pipe);
143 EXPORT_SYMBOL_GPL(imx_drm_crtc_vblank_put);
145 void imx_drm_handle_vblank(struct imx_drm_crtc *imx_drm_crtc)
147 drm_handle_vblank(imx_drm_crtc->crtc->dev, imx_drm_crtc->pipe);
149 EXPORT_SYMBOL_GPL(imx_drm_handle_vblank);
151 static int imx_drm_enable_vblank(struct drm_device *drm, int crtc)
153 struct imx_drm_device *imxdrm = drm->dev_private;
154 struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[crtc];
160 if (!imx_drm_crtc->imx_drm_helper_funcs.enable_vblank)
163 ret = imx_drm_crtc->imx_drm_helper_funcs.enable_vblank(
169 static void imx_drm_disable_vblank(struct drm_device *drm, int crtc)
171 struct imx_drm_device *imxdrm = drm->dev_private;
172 struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[crtc];
177 if (!imx_drm_crtc->imx_drm_helper_funcs.disable_vblank)
180 imx_drm_crtc->imx_drm_helper_funcs.disable_vblank(imx_drm_crtc->crtc);
183 static void imx_drm_driver_preclose(struct drm_device *drm,
184 struct drm_file *file)
188 if (!file->is_master)
191 for (i = 0; i < MAX_CRTC; i++)
192 imx_drm_disable_vblank(drm, i);
195 static const struct file_operations imx_drm_driver_fops = {
196 .owner = THIS_MODULE,
198 .release = drm_release,
199 .unlocked_ioctl = drm_ioctl,
200 .mmap = drm_gem_cma_mmap,
203 .llseek = noop_llseek,
206 void imx_drm_connector_destroy(struct drm_connector *connector)
208 drm_connector_unregister(connector);
209 drm_connector_cleanup(connector);
211 EXPORT_SYMBOL_GPL(imx_drm_connector_destroy);
213 void imx_drm_encoder_destroy(struct drm_encoder *encoder)
215 drm_encoder_cleanup(encoder);
217 EXPORT_SYMBOL_GPL(imx_drm_encoder_destroy);
219 static void imx_drm_output_poll_changed(struct drm_device *drm)
221 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
222 struct imx_drm_device *imxdrm = drm->dev_private;
224 drm_fbdev_cma_hotplug_event(imxdrm->fbhelper);
228 static struct drm_mode_config_funcs imx_drm_mode_config_funcs = {
229 .fb_create = drm_fb_cma_create,
230 .output_poll_changed = imx_drm_output_poll_changed,
234 * Main DRM initialisation. This binds, initialises and registers
235 * with DRM the subcomponents of the driver.
237 static int imx_drm_driver_load(struct drm_device *drm, unsigned long flags)
239 struct imx_drm_device *imxdrm;
240 struct drm_connector *connector;
243 imxdrm = devm_kzalloc(drm->dev, sizeof(*imxdrm), GFP_KERNEL);
249 drm->dev_private = imxdrm;
252 * enable drm irq mode.
253 * - with irq_enabled = true, we can use the vblank feature.
255 * P.S. note that we wouldn't use drm irq handler but
256 * just specific driver own one instead because
257 * drm framework supports only one irq handler and
258 * drivers can well take care of their interrupts
260 drm->irq_enabled = true;
263 * set max width and height as default value(4096x4096).
264 * this value would be used to check framebuffer size limitation
265 * at drm_mode_addfb().
267 drm->mode_config.min_width = 64;
268 drm->mode_config.min_height = 64;
269 drm->mode_config.max_width = 4096;
270 drm->mode_config.max_height = 4096;
271 drm->mode_config.funcs = &imx_drm_mode_config_funcs;
273 drm_mode_config_init(drm);
275 ret = drm_vblank_init(drm, MAX_CRTC);
280 * with vblank_disable_allowed = true, vblank interrupt will be
281 * disabled by drm timer once a current process gives up ownership
282 * of vblank event. (after drm_vblank_put function is called)
284 drm->vblank_disable_allowed = true;
286 platform_set_drvdata(drm->platformdev, drm);
288 /* Now try and bind all our sub-components */
289 ret = component_bind_all(drm->dev, drm);
294 * All components are now added, we can publish the connector sysfs
295 * entries to userspace. This will generate hotplug events and so
296 * userspace will expect to be able to access DRM at this point.
298 list_for_each_entry(connector, &drm->mode_config.connector_list, head) {
299 ret = drm_connector_register(connector);
302 "[CONNECTOR:%d:%s] drm_connector_register failed: %d\n",
304 connector->name, ret);
310 * All components are now initialised, so setup the fb helper.
311 * The fb helper takes copies of key hardware information, so the
312 * crtcs/connectors/encoders must not change after this point.
314 #if IS_ENABLED(CONFIG_DRM_IMX_FB_HELPER)
315 if (legacyfb_depth != 16 && legacyfb_depth != 32) {
316 dev_warn(drm->dev, "Invalid legacyfb_depth. Defaulting to 16bpp\n");
319 imxdrm->fbhelper = drm_fbdev_cma_init(drm, legacyfb_depth,
320 drm->mode_config.num_crtc, MAX_CRTC);
321 if (IS_ERR(imxdrm->fbhelper)) {
322 ret = PTR_ERR(imxdrm->fbhelper);
323 imxdrm->fbhelper = NULL;
328 drm_kms_helper_poll_init(drm);
333 component_unbind_all(drm->dev, drm);
335 drm_vblank_cleanup(drm);
337 drm_mode_config_cleanup(drm);
343 * imx_drm_add_crtc - add a new crtc
345 int imx_drm_add_crtc(struct drm_device *drm, struct drm_crtc *crtc,
346 struct imx_drm_crtc **new_crtc,
347 const struct imx_drm_crtc_helper_funcs *imx_drm_helper_funcs,
348 struct device_node *port)
350 struct imx_drm_device *imxdrm = drm->dev_private;
351 struct imx_drm_crtc *imx_drm_crtc;
355 * The vblank arrays are dimensioned by MAX_CRTC - we can't
356 * pass IDs greater than this to those functions.
358 if (imxdrm->pipes >= MAX_CRTC)
361 if (imxdrm->drm->open_count)
364 imx_drm_crtc = kzalloc(sizeof(*imx_drm_crtc), GFP_KERNEL);
368 imx_drm_crtc->imx_drm_helper_funcs = *imx_drm_helper_funcs;
369 imx_drm_crtc->pipe = imxdrm->pipes++;
370 imx_drm_crtc->port = port;
371 imx_drm_crtc->crtc = crtc;
373 imxdrm->crtc[imx_drm_crtc->pipe] = imx_drm_crtc;
375 *new_crtc = imx_drm_crtc;
377 ret = drm_mode_crtc_set_gamma_size(imx_drm_crtc->crtc, 256);
381 drm_crtc_helper_add(crtc,
382 imx_drm_crtc->imx_drm_helper_funcs.crtc_helper_funcs);
384 drm_crtc_init(drm, crtc,
385 imx_drm_crtc->imx_drm_helper_funcs.crtc_funcs);
390 imxdrm->crtc[imx_drm_crtc->pipe] = NULL;
394 EXPORT_SYMBOL_GPL(imx_drm_add_crtc);
397 * imx_drm_remove_crtc - remove a crtc
399 int imx_drm_remove_crtc(struct imx_drm_crtc *imx_drm_crtc)
401 struct imx_drm_device *imxdrm = imx_drm_crtc->crtc->dev->dev_private;
403 drm_crtc_cleanup(imx_drm_crtc->crtc);
405 imxdrm->crtc[imx_drm_crtc->pipe] = NULL;
411 EXPORT_SYMBOL_GPL(imx_drm_remove_crtc);
414 * Find the DRM CRTC possible mask for the connected endpoint.
416 * The encoder possible masks are defined by their position in the
417 * mode_config crtc_list. This means that CRTCs must not be added
418 * or removed once the DRM device has been fully initialised.
420 static uint32_t imx_drm_find_crtc_mask(struct imx_drm_device *imxdrm,
421 struct device_node *endpoint)
423 struct device_node *port;
426 port = of_graph_get_remote_port(endpoint);
431 for (i = 0; i < MAX_CRTC; i++) {
432 struct imx_drm_crtc *imx_drm_crtc = imxdrm->crtc[i];
434 if (imx_drm_crtc && imx_drm_crtc->port == port)
435 return drm_crtc_mask(imx_drm_crtc->crtc);
441 static struct device_node *imx_drm_of_get_next_endpoint(
442 const struct device_node *parent, struct device_node *prev)
444 struct device_node *node = of_graph_get_next_endpoint(parent, prev);
450 int imx_drm_encoder_parse_of(struct drm_device *drm,
451 struct drm_encoder *encoder, struct device_node *np)
453 struct imx_drm_device *imxdrm = drm->dev_private;
454 struct device_node *ep = NULL;
455 uint32_t crtc_mask = 0;
461 ep = imx_drm_of_get_next_endpoint(np, ep);
465 mask = imx_drm_find_crtc_mask(imxdrm, ep);
468 * If we failed to find the CRTC(s) which this encoder is
469 * supposed to be connected to, it's because the CRTC has
470 * not been registered yet. Defer probing, and hope that
471 * the required CRTC is added later.
474 return -EPROBE_DEFER;
483 encoder->possible_crtcs = crtc_mask;
485 /* FIXME: this is the mask of outputs which can clone this output. */
486 encoder->possible_clones = ~0;
490 EXPORT_SYMBOL_GPL(imx_drm_encoder_parse_of);
493 * @node: device tree node containing encoder input ports
494 * @encoder: drm_encoder
496 int imx_drm_encoder_get_mux_id(struct device_node *node,
497 struct drm_encoder *encoder)
499 struct imx_drm_crtc *imx_crtc = imx_drm_find_crtc(encoder->crtc);
500 struct device_node *ep = NULL;
501 struct of_endpoint endpoint;
502 struct device_node *port;
505 if (!node || !imx_crtc)
509 ep = imx_drm_of_get_next_endpoint(node, ep);
513 port = of_graph_get_remote_port(ep);
515 if (port == imx_crtc->port) {
516 ret = of_graph_parse_endpoint(ep, &endpoint);
517 return ret ? ret : endpoint.port;
523 EXPORT_SYMBOL_GPL(imx_drm_encoder_get_mux_id);
525 static const struct drm_ioctl_desc imx_drm_ioctls[] = {
529 static struct drm_driver imx_drm_driver = {
530 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME,
531 .load = imx_drm_driver_load,
532 .unload = imx_drm_driver_unload,
533 .lastclose = imx_drm_driver_lastclose,
534 .preclose = imx_drm_driver_preclose,
535 .set_busid = drm_platform_set_busid,
536 .gem_free_object = drm_gem_cma_free_object,
537 .gem_vm_ops = &drm_gem_cma_vm_ops,
538 .dumb_create = drm_gem_cma_dumb_create,
539 .dumb_map_offset = drm_gem_cma_dumb_map_offset,
540 .dumb_destroy = drm_gem_dumb_destroy,
542 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
543 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
544 .gem_prime_import = drm_gem_prime_import,
545 .gem_prime_export = drm_gem_prime_export,
546 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
547 .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
548 .gem_prime_vmap = drm_gem_cma_prime_vmap,
549 .gem_prime_vunmap = drm_gem_cma_prime_vunmap,
550 .gem_prime_mmap = drm_gem_cma_prime_mmap,
551 .get_vblank_counter = drm_vblank_count,
552 .enable_vblank = imx_drm_enable_vblank,
553 .disable_vblank = imx_drm_disable_vblank,
554 .ioctls = imx_drm_ioctls,
555 .num_ioctls = ARRAY_SIZE(imx_drm_ioctls),
556 .fops = &imx_drm_driver_fops,
558 .desc = "i.MX DRM graphics",
565 static int compare_of(struct device *dev, void *data)
567 struct device_node *np = data;
569 /* Special case for LDB, one device for two channels */
570 if (of_node_cmp(np->name, "lvds-channel") == 0) {
571 np = of_get_parent(np);
575 return dev->of_node == np;
578 static int imx_drm_bind(struct device *dev)
580 return drm_platform_init(&imx_drm_driver, to_platform_device(dev));
583 static void imx_drm_unbind(struct device *dev)
585 drm_put_dev(dev_get_drvdata(dev));
588 static const struct component_master_ops imx_drm_ops = {
589 .bind = imx_drm_bind,
590 .unbind = imx_drm_unbind,
593 static int imx_drm_platform_probe(struct platform_device *pdev)
595 struct device_node *ep, *port, *remote;
596 struct component_match *match = NULL;
601 * Bind the IPU display interface ports first, so that
602 * imx_drm_encoder_parse_of called from encoder .bind callbacks
606 port = of_parse_phandle(pdev->dev.of_node, "ports", i);
610 component_match_add(&pdev->dev, &match, compare_of, port);
614 dev_err(&pdev->dev, "missing 'ports' property\n");
618 /* Then bind all encoders */
620 port = of_parse_phandle(pdev->dev.of_node, "ports", i);
624 for_each_child_of_node(port, ep) {
625 remote = of_graph_get_remote_port_parent(ep);
626 if (!remote || !of_device_is_available(remote)) {
629 } else if (!of_device_is_available(remote->parent)) {
630 dev_warn(&pdev->dev, "parent device of %s is not available\n",
636 component_match_add(&pdev->dev, &match, compare_of, remote);
642 ret = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
646 return component_master_add_with_match(&pdev->dev, &imx_drm_ops, match);
649 static int imx_drm_platform_remove(struct platform_device *pdev)
651 component_master_del(&pdev->dev, &imx_drm_ops);
655 #ifdef CONFIG_PM_SLEEP
656 static int imx_drm_suspend(struct device *dev)
658 struct drm_device *drm_dev = dev_get_drvdata(dev);
660 /* The drm_dev is NULL before .load hook is called */
664 drm_kms_helper_poll_disable(drm_dev);
669 static int imx_drm_resume(struct device *dev)
671 struct drm_device *drm_dev = dev_get_drvdata(dev);
676 drm_helper_resume_force_mode(drm_dev);
677 drm_kms_helper_poll_enable(drm_dev);
683 static SIMPLE_DEV_PM_OPS(imx_drm_pm_ops, imx_drm_suspend, imx_drm_resume);
685 static const struct of_device_id imx_drm_dt_ids[] = {
686 { .compatible = "fsl,imx-display-subsystem", },
689 MODULE_DEVICE_TABLE(of, imx_drm_dt_ids);
691 static struct platform_driver imx_drm_pdrv = {
692 .probe = imx_drm_platform_probe,
693 .remove = imx_drm_platform_remove,
696 .pm = &imx_drm_pm_ops,
697 .of_match_table = imx_drm_dt_ids,
700 module_platform_driver(imx_drm_pdrv);
702 MODULE_AUTHOR("Sascha Hauer <s.hauer@pengutronix.de>");
703 MODULE_DESCRIPTION("i.MX drm driver core");
704 MODULE_LICENSE("GPL");