2 * Copyright (C) 2012 Texas Instruments
3 * Author: Rob Clark <robdclark@gmail.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program. If not, see <http://www.gnu.org/licenses/>.
18 /* LCDC DRM driver, based on da8xx-fb */
20 #include <linux/component.h>
21 #include <linux/mod_devicetable.h>
22 #include <linux/module.h>
23 #include <linux/pinctrl/consumer.h>
24 #include <linux/platform_device.h>
25 #include <linux/pm_runtime.h>
27 #include <drm/drm_atomic_helper.h>
28 #include <drm/drm_debugfs.h>
29 #include <drm/drm_drv.h>
30 #include <drm/drm_fb_helper.h>
31 #include <drm/drm_fourcc.h>
32 #include <drm/drm_gem_cma_helper.h>
33 #include <drm/drm_gem_framebuffer_helper.h>
34 #include <drm/drm_irq.h>
35 #include <drm/drm_mm.h>
36 #include <drm/drm_probe_helper.h>
37 #include <drm/drm_vblank.h>
40 #include "tilcdc_drv.h"
41 #include "tilcdc_external.h"
42 #include "tilcdc_panel.h"
43 #include "tilcdc_regs.h"
44 #include "tilcdc_tfp410.h"
46 static LIST_HEAD(module_list);
48 static const u32 tilcdc_rev1_formats[] = { DRM_FORMAT_RGB565 };
50 static const u32 tilcdc_straight_formats[] = { DRM_FORMAT_RGB565,
52 DRM_FORMAT_XBGR8888 };
54 static const u32 tilcdc_crossed_formats[] = { DRM_FORMAT_BGR565,
56 DRM_FORMAT_XRGB8888 };
58 static const u32 tilcdc_legacy_formats[] = { DRM_FORMAT_RGB565,
60 DRM_FORMAT_XRGB8888 };
62 void tilcdc_module_init(struct tilcdc_module *mod, const char *name,
63 const struct tilcdc_module_ops *funcs)
67 INIT_LIST_HEAD(&mod->list);
68 list_add(&mod->list, &module_list);
71 void tilcdc_module_cleanup(struct tilcdc_module *mod)
76 static struct of_device_id tilcdc_of_match[];
78 static struct drm_framebuffer *tilcdc_fb_create(struct drm_device *dev,
79 struct drm_file *file_priv, const struct drm_mode_fb_cmd2 *mode_cmd)
81 return drm_gem_fb_create(dev, file_priv, mode_cmd);
84 static int tilcdc_atomic_check(struct drm_device *dev,
85 struct drm_atomic_state *state)
89 ret = drm_atomic_helper_check_modeset(dev, state);
93 ret = drm_atomic_helper_check_planes(dev, state);
98 * tilcdc ->atomic_check can update ->mode_changed if pixel format
99 * changes, hence will we check modeset changes again.
101 ret = drm_atomic_helper_check_modeset(dev, state);
108 static int tilcdc_commit(struct drm_device *dev,
109 struct drm_atomic_state *state,
114 ret = drm_atomic_helper_prepare_planes(dev, state);
118 ret = drm_atomic_helper_swap_state(state, true);
120 drm_atomic_helper_cleanup_planes(dev, state);
125 * Everything below can be run asynchronously without the need to grab
126 * any modeset locks at all under one condition: It must be guaranteed
127 * that the asynchronous work has either been cancelled (if the driver
128 * supports it, which at least requires that the framebuffers get
129 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
130 * before the new state gets committed on the software side with
131 * drm_atomic_helper_swap_state().
133 * This scheme allows new atomic state updates to be prepared and
134 * checked in parallel to the asynchronous completion of the previous
135 * update. Which is important since compositors need to figure out the
136 * composition of the next frame right after having submitted the
140 drm_atomic_helper_commit_modeset_disables(dev, state);
142 drm_atomic_helper_commit_planes(dev, state, 0);
144 drm_atomic_helper_commit_modeset_enables(dev, state);
146 drm_atomic_helper_wait_for_vblanks(dev, state);
148 drm_atomic_helper_cleanup_planes(dev, state);
153 static const struct drm_mode_config_funcs mode_config_funcs = {
154 .fb_create = tilcdc_fb_create,
155 .atomic_check = tilcdc_atomic_check,
156 .atomic_commit = tilcdc_commit,
159 static void modeset_init(struct drm_device *dev)
161 struct tilcdc_drm_private *priv = dev->dev_private;
162 struct tilcdc_module *mod;
164 list_for_each_entry(mod, &module_list, list) {
165 DBG("loading module: %s", mod->name);
166 mod->funcs->modeset_init(mod, dev);
169 dev->mode_config.min_width = 0;
170 dev->mode_config.min_height = 0;
171 dev->mode_config.max_width = tilcdc_crtc_max_width(priv->crtc);
172 dev->mode_config.max_height = 2048;
173 dev->mode_config.funcs = &mode_config_funcs;
176 #ifdef CONFIG_CPU_FREQ
177 static int cpufreq_transition(struct notifier_block *nb,
178 unsigned long val, void *data)
180 struct tilcdc_drm_private *priv = container_of(nb,
181 struct tilcdc_drm_private, freq_transition);
183 if (val == CPUFREQ_POSTCHANGE)
184 tilcdc_crtc_update_clk(priv->crtc);
194 static void tilcdc_fini(struct drm_device *dev)
196 struct tilcdc_drm_private *priv = dev->dev_private;
198 #ifdef CONFIG_CPU_FREQ
199 if (priv->freq_transition.notifier_call)
200 cpufreq_unregister_notifier(&priv->freq_transition,
201 CPUFREQ_TRANSITION_NOTIFIER);
205 tilcdc_crtc_shutdown(priv->crtc);
207 if (priv->is_registered)
208 drm_dev_unregister(dev);
210 drm_kms_helper_poll_fini(dev);
211 drm_irq_uninstall(dev);
212 drm_mode_config_cleanup(dev);
213 tilcdc_remove_external_device(dev);
222 flush_workqueue(priv->wq);
223 destroy_workqueue(priv->wq);
226 dev->dev_private = NULL;
228 pm_runtime_disable(dev->dev);
233 static int tilcdc_init(struct drm_driver *ddrv, struct device *dev)
235 struct drm_device *ddev;
236 struct platform_device *pdev = to_platform_device(dev);
237 struct device_node *node = dev->of_node;
238 struct tilcdc_drm_private *priv;
239 struct resource *res;
243 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
247 ddev = drm_dev_alloc(ddrv, dev);
249 return PTR_ERR(ddev);
251 ddev->dev_private = priv;
252 platform_set_drvdata(pdev, ddev);
253 drm_mode_config_init(ddev);
255 priv->is_componentized =
256 tilcdc_get_external_components(dev, NULL) > 0;
258 priv->wq = alloc_ordered_workqueue("tilcdc", 0);
264 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
266 dev_err(dev, "failed to get memory resource\n");
271 priv->mmio = ioremap_nocache(res->start, resource_size(res));
273 dev_err(dev, "failed to ioremap\n");
278 priv->clk = clk_get(dev, "fck");
279 if (IS_ERR(priv->clk)) {
280 dev_err(dev, "failed to get functional clock\n");
285 if (of_property_read_u32(node, "max-bandwidth", &priv->max_bandwidth))
286 priv->max_bandwidth = TILCDC_DEFAULT_MAX_BANDWIDTH;
288 DBG("Maximum Bandwidth Value %d", priv->max_bandwidth);
290 if (of_property_read_u32(node, "max-width", &priv->max_width))
291 priv->max_width = TILCDC_DEFAULT_MAX_WIDTH;
293 DBG("Maximum Horizontal Pixel Width Value %dpixels", priv->max_width);
295 if (of_property_read_u32(node, "max-pixelclock",
296 &priv->max_pixelclock))
297 priv->max_pixelclock = TILCDC_DEFAULT_MAX_PIXELCLOCK;
299 DBG("Maximum Pixel Clock Value %dKHz", priv->max_pixelclock);
301 pm_runtime_enable(dev);
303 /* Determine LCD IP Version */
304 pm_runtime_get_sync(dev);
305 switch (tilcdc_read(ddev, LCDC_PID_REG)) {
314 dev_warn(dev, "Unknown PID Reg value 0x%08x, "
315 "defaulting to LCD revision 1\n",
316 tilcdc_read(ddev, LCDC_PID_REG));
321 pm_runtime_put_sync(dev);
323 if (priv->rev == 1) {
324 DBG("Revision 1 LCDC supports only RGB565 format");
325 priv->pixelformats = tilcdc_rev1_formats;
326 priv->num_pixelformats = ARRAY_SIZE(tilcdc_rev1_formats);
329 const char *str = "\0";
331 of_property_read_string(node, "blue-and-red-wiring", &str);
332 if (0 == strcmp(str, "crossed")) {
333 DBG("Configured for crossed blue and red wires");
334 priv->pixelformats = tilcdc_crossed_formats;
335 priv->num_pixelformats =
336 ARRAY_SIZE(tilcdc_crossed_formats);
337 bpp = 32; /* Choose bpp with RGB support for fbdef */
338 } else if (0 == strcmp(str, "straight")) {
339 DBG("Configured for straight blue and red wires");
340 priv->pixelformats = tilcdc_straight_formats;
341 priv->num_pixelformats =
342 ARRAY_SIZE(tilcdc_straight_formats);
343 bpp = 16; /* Choose bpp with RGB support for fbdef */
345 DBG("Blue and red wiring '%s' unknown, use legacy mode",
347 priv->pixelformats = tilcdc_legacy_formats;
348 priv->num_pixelformats =
349 ARRAY_SIZE(tilcdc_legacy_formats);
350 bpp = 16; /* This is just a guess */
354 ret = tilcdc_crtc_create(ddev);
356 dev_err(dev, "failed to create crtc\n");
361 #ifdef CONFIG_CPU_FREQ
362 priv->freq_transition.notifier_call = cpufreq_transition;
363 ret = cpufreq_register_notifier(&priv->freq_transition,
364 CPUFREQ_TRANSITION_NOTIFIER);
366 dev_err(dev, "failed to register cpufreq notifier\n");
367 priv->freq_transition.notifier_call = NULL;
372 if (priv->is_componentized) {
373 ret = component_bind_all(dev, ddev);
377 ret = tilcdc_add_component_encoder(ddev);
381 ret = tilcdc_attach_external_device(ddev);
386 if (!priv->external_connector &&
387 ((priv->num_encoders == 0) || (priv->num_connectors == 0))) {
388 dev_err(dev, "no encoders/connectors found\n");
393 ret = drm_vblank_init(ddev, 1);
395 dev_err(dev, "failed to initialize vblank\n");
399 ret = drm_irq_install(ddev, platform_get_irq(pdev, 0));
401 dev_err(dev, "failed to install IRQ handler\n");
405 drm_mode_config_reset(ddev);
407 drm_kms_helper_poll_init(ddev);
409 ret = drm_dev_register(ddev, 0);
413 drm_fbdev_generic_setup(ddev, bpp);
415 priv->is_registered = true;
424 static irqreturn_t tilcdc_irq(int irq, void *arg)
426 struct drm_device *dev = arg;
427 struct tilcdc_drm_private *priv = dev->dev_private;
428 return tilcdc_crtc_irq(priv->crtc);
431 #if defined(CONFIG_DEBUG_FS)
432 static const struct {
438 #define REG(rev, save, reg) { #reg, rev, save, reg }
439 /* exists in revision 1: */
440 REG(1, false, LCDC_PID_REG),
441 REG(1, true, LCDC_CTRL_REG),
442 REG(1, false, LCDC_STAT_REG),
443 REG(1, true, LCDC_RASTER_CTRL_REG),
444 REG(1, true, LCDC_RASTER_TIMING_0_REG),
445 REG(1, true, LCDC_RASTER_TIMING_1_REG),
446 REG(1, true, LCDC_RASTER_TIMING_2_REG),
447 REG(1, true, LCDC_DMA_CTRL_REG),
448 REG(1, true, LCDC_DMA_FB_BASE_ADDR_0_REG),
449 REG(1, true, LCDC_DMA_FB_CEILING_ADDR_0_REG),
450 REG(1, true, LCDC_DMA_FB_BASE_ADDR_1_REG),
451 REG(1, true, LCDC_DMA_FB_CEILING_ADDR_1_REG),
452 /* new in revision 2: */
453 REG(2, false, LCDC_RAW_STAT_REG),
454 REG(2, false, LCDC_MASKED_STAT_REG),
455 REG(2, true, LCDC_INT_ENABLE_SET_REG),
456 REG(2, false, LCDC_INT_ENABLE_CLR_REG),
457 REG(2, false, LCDC_END_OF_INT_IND_REG),
458 REG(2, true, LCDC_CLK_ENABLE_REG),
464 #ifdef CONFIG_DEBUG_FS
465 static int tilcdc_regs_show(struct seq_file *m, void *arg)
467 struct drm_info_node *node = (struct drm_info_node *) m->private;
468 struct drm_device *dev = node->minor->dev;
469 struct tilcdc_drm_private *priv = dev->dev_private;
472 pm_runtime_get_sync(dev->dev);
474 seq_printf(m, "revision: %d\n", priv->rev);
476 for (i = 0; i < ARRAY_SIZE(registers); i++)
477 if (priv->rev >= registers[i].rev)
478 seq_printf(m, "%s:\t %08x\n", registers[i].name,
479 tilcdc_read(dev, registers[i].reg));
481 pm_runtime_put_sync(dev->dev);
486 static int tilcdc_mm_show(struct seq_file *m, void *arg)
488 struct drm_info_node *node = (struct drm_info_node *) m->private;
489 struct drm_device *dev = node->minor->dev;
490 struct drm_printer p = drm_seq_file_printer(m);
491 drm_mm_print(&dev->vma_offset_manager->vm_addr_space_mm, &p);
495 static struct drm_info_list tilcdc_debugfs_list[] = {
496 { "regs", tilcdc_regs_show, 0 },
497 { "mm", tilcdc_mm_show, 0 },
500 static int tilcdc_debugfs_init(struct drm_minor *minor)
502 struct drm_device *dev = minor->dev;
503 struct tilcdc_module *mod;
506 ret = drm_debugfs_create_files(tilcdc_debugfs_list,
507 ARRAY_SIZE(tilcdc_debugfs_list),
508 minor->debugfs_root, minor);
510 list_for_each_entry(mod, &module_list, list)
511 if (mod->funcs->debugfs_init)
512 mod->funcs->debugfs_init(mod, minor);
515 dev_err(dev->dev, "could not install tilcdc_debugfs_list\n");
523 DEFINE_DRM_GEM_CMA_FOPS(fops);
525 static struct drm_driver tilcdc_driver = {
526 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
527 .irq_handler = tilcdc_irq,
528 .gem_free_object_unlocked = drm_gem_cma_free_object,
529 .gem_print_info = drm_gem_cma_print_info,
530 .gem_vm_ops = &drm_gem_cma_vm_ops,
531 .dumb_create = drm_gem_cma_dumb_create,
533 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
534 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
535 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
536 .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
537 .gem_prime_vmap = drm_gem_cma_prime_vmap,
538 .gem_prime_vunmap = drm_gem_cma_prime_vunmap,
539 .gem_prime_mmap = drm_gem_cma_prime_mmap,
540 #ifdef CONFIG_DEBUG_FS
541 .debugfs_init = tilcdc_debugfs_init,
545 .desc = "TI LCD Controller DRM",
555 #ifdef CONFIG_PM_SLEEP
556 static int tilcdc_pm_suspend(struct device *dev)
558 struct drm_device *ddev = dev_get_drvdata(dev);
561 ret = drm_mode_config_helper_suspend(ddev);
563 /* Select sleep pin state */
564 pinctrl_pm_select_sleep_state(dev);
569 static int tilcdc_pm_resume(struct device *dev)
571 struct drm_device *ddev = dev_get_drvdata(dev);
573 /* Select default pin state */
574 pinctrl_pm_select_default_state(dev);
575 return drm_mode_config_helper_resume(ddev);
579 static const struct dev_pm_ops tilcdc_pm_ops = {
580 SET_SYSTEM_SLEEP_PM_OPS(tilcdc_pm_suspend, tilcdc_pm_resume)
586 static int tilcdc_bind(struct device *dev)
588 return tilcdc_init(&tilcdc_driver, dev);
591 static void tilcdc_unbind(struct device *dev)
593 struct drm_device *ddev = dev_get_drvdata(dev);
595 /* Check if a subcomponent has already triggered the unloading. */
596 if (!ddev->dev_private)
599 tilcdc_fini(dev_get_drvdata(dev));
602 static const struct component_master_ops tilcdc_comp_ops = {
604 .unbind = tilcdc_unbind,
607 static int tilcdc_pdev_probe(struct platform_device *pdev)
609 struct component_match *match = NULL;
612 /* bail out early if no DT data: */
613 if (!pdev->dev.of_node) {
614 dev_err(&pdev->dev, "device-tree data is missing\n");
618 ret = tilcdc_get_external_components(&pdev->dev, &match);
622 return tilcdc_init(&tilcdc_driver, &pdev->dev);
624 return component_master_add_with_match(&pdev->dev,
629 static int tilcdc_pdev_remove(struct platform_device *pdev)
633 ret = tilcdc_get_external_components(&pdev->dev, NULL);
637 tilcdc_fini(platform_get_drvdata(pdev));
639 component_master_del(&pdev->dev, &tilcdc_comp_ops);
644 static struct of_device_id tilcdc_of_match[] = {
645 { .compatible = "ti,am33xx-tilcdc", },
646 { .compatible = "ti,da850-tilcdc", },
649 MODULE_DEVICE_TABLE(of, tilcdc_of_match);
651 static struct platform_driver tilcdc_platform_driver = {
652 .probe = tilcdc_pdev_probe,
653 .remove = tilcdc_pdev_remove,
656 .pm = &tilcdc_pm_ops,
657 .of_match_table = tilcdc_of_match,
661 static int __init tilcdc_drm_init(void)
664 tilcdc_tfp410_init();
666 return platform_driver_register(&tilcdc_platform_driver);
669 static void __exit tilcdc_drm_fini(void)
672 platform_driver_unregister(&tilcdc_platform_driver);
674 tilcdc_tfp410_fini();
677 module_init(tilcdc_drm_init);
678 module_exit(tilcdc_drm_fini);
680 MODULE_AUTHOR("Rob Clark <robdclark@gmail.com");
681 MODULE_DESCRIPTION("TI LCD Controller DRM Driver");
682 MODULE_LICENSE("GPL");