drm/mediatek: Introduce GEM object functions
[sfrench/cifs-2.6.git] / drivers / gpu / drm / mediatek / mtk_drm_drv.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (c) 2015 MediaTek Inc.
4  * Author: YT SHEN <yt.shen@mediatek.com>
5  */
6
7 #include <linux/component.h>
8 #include <linux/iommu.h>
9 #include <linux/module.h>
10 #include <linux/of_address.h>
11 #include <linux/of_platform.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/soc/mediatek/mtk-mmsys.h>
14 #include <linux/dma-mapping.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_helper.h>
20 #include <drm/drm_fourcc.h>
21 #include <drm/drm_gem.h>
22 #include <drm/drm_gem_cma_helper.h>
23 #include <drm/drm_gem_framebuffer_helper.h>
24 #include <drm/drm_of.h>
25 #include <drm/drm_probe_helper.h>
26 #include <drm/drm_vblank.h>
27
28 #include "mtk_drm_crtc.h"
29 #include "mtk_drm_ddp.h"
30 #include "mtk_drm_ddp_comp.h"
31 #include "mtk_drm_drv.h"
32 #include "mtk_drm_gem.h"
33
34 #define DRIVER_NAME "mediatek"
35 #define DRIVER_DESC "Mediatek SoC DRM"
36 #define DRIVER_DATE "20150513"
37 #define DRIVER_MAJOR 1
38 #define DRIVER_MINOR 0
39
40 static const struct drm_mode_config_helper_funcs mtk_drm_mode_config_helpers = {
41         .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
42 };
43
44 static struct drm_framebuffer *
45 mtk_drm_mode_fb_create(struct drm_device *dev,
46                        struct drm_file *file,
47                        const struct drm_mode_fb_cmd2 *cmd)
48 {
49         const struct drm_format_info *info = drm_get_format_info(dev, cmd);
50
51         if (info->num_planes != 1)
52                 return ERR_PTR(-EINVAL);
53
54         return drm_gem_fb_create(dev, file, cmd);
55 }
56
57 static const struct drm_mode_config_funcs mtk_drm_mode_config_funcs = {
58         .fb_create = mtk_drm_mode_fb_create,
59         .atomic_check = drm_atomic_helper_check,
60         .atomic_commit = drm_atomic_helper_commit,
61 };
62
63 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_main[] = {
64         DDP_COMPONENT_OVL0,
65         DDP_COMPONENT_RDMA0,
66         DDP_COMPONENT_COLOR0,
67         DDP_COMPONENT_BLS,
68         DDP_COMPONENT_DSI0,
69 };
70
71 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_ext[] = {
72         DDP_COMPONENT_RDMA1,
73         DDP_COMPONENT_DPI0,
74 };
75
76 static const enum mtk_ddp_comp_id mt7623_mtk_ddp_main[] = {
77         DDP_COMPONENT_OVL0,
78         DDP_COMPONENT_RDMA0,
79         DDP_COMPONENT_COLOR0,
80         DDP_COMPONENT_BLS,
81         DDP_COMPONENT_DPI0,
82 };
83
84 static const enum mtk_ddp_comp_id mt7623_mtk_ddp_ext[] = {
85         DDP_COMPONENT_RDMA1,
86         DDP_COMPONENT_DSI0,
87 };
88
89 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_main[] = {
90         DDP_COMPONENT_OVL0,
91         DDP_COMPONENT_COLOR0,
92         DDP_COMPONENT_AAL0,
93         DDP_COMPONENT_OD0,
94         DDP_COMPONENT_RDMA0,
95         DDP_COMPONENT_DPI0,
96         DDP_COMPONENT_PWM0,
97 };
98
99 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_ext[] = {
100         DDP_COMPONENT_OVL1,
101         DDP_COMPONENT_COLOR1,
102         DDP_COMPONENT_AAL1,
103         DDP_COMPONENT_OD1,
104         DDP_COMPONENT_RDMA1,
105         DDP_COMPONENT_DPI1,
106         DDP_COMPONENT_PWM1,
107 };
108
109 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_third[] = {
110         DDP_COMPONENT_RDMA2,
111         DDP_COMPONENT_DSI3,
112         DDP_COMPONENT_PWM2,
113 };
114
115 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_main[] = {
116         DDP_COMPONENT_OVL0,
117         DDP_COMPONENT_COLOR0,
118         DDP_COMPONENT_AAL0,
119         DDP_COMPONENT_OD0,
120         DDP_COMPONENT_RDMA0,
121         DDP_COMPONENT_UFOE,
122         DDP_COMPONENT_DSI0,
123         DDP_COMPONENT_PWM0,
124 };
125
126 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_ext[] = {
127         DDP_COMPONENT_OVL1,
128         DDP_COMPONENT_COLOR1,
129         DDP_COMPONENT_GAMMA,
130         DDP_COMPONENT_RDMA1,
131         DDP_COMPONENT_DPI0,
132 };
133
134 static const struct mtk_mmsys_driver_data mt2701_mmsys_driver_data = {
135         .main_path = mt2701_mtk_ddp_main,
136         .main_len = ARRAY_SIZE(mt2701_mtk_ddp_main),
137         .ext_path = mt2701_mtk_ddp_ext,
138         .ext_len = ARRAY_SIZE(mt2701_mtk_ddp_ext),
139         .shadow_register = true,
140 };
141
142 static const struct mtk_mmsys_driver_data mt7623_mmsys_driver_data = {
143         .main_path = mt7623_mtk_ddp_main,
144         .main_len = ARRAY_SIZE(mt7623_mtk_ddp_main),
145         .ext_path = mt7623_mtk_ddp_ext,
146         .ext_len = ARRAY_SIZE(mt7623_mtk_ddp_ext),
147         .shadow_register = true,
148 };
149
150 static const struct mtk_mmsys_driver_data mt2712_mmsys_driver_data = {
151         .main_path = mt2712_mtk_ddp_main,
152         .main_len = ARRAY_SIZE(mt2712_mtk_ddp_main),
153         .ext_path = mt2712_mtk_ddp_ext,
154         .ext_len = ARRAY_SIZE(mt2712_mtk_ddp_ext),
155         .third_path = mt2712_mtk_ddp_third,
156         .third_len = ARRAY_SIZE(mt2712_mtk_ddp_third),
157 };
158
159 static const struct mtk_mmsys_driver_data mt8173_mmsys_driver_data = {
160         .main_path = mt8173_mtk_ddp_main,
161         .main_len = ARRAY_SIZE(mt8173_mtk_ddp_main),
162         .ext_path = mt8173_mtk_ddp_ext,
163         .ext_len = ARRAY_SIZE(mt8173_mtk_ddp_ext),
164 };
165
166 static int mtk_drm_kms_init(struct drm_device *drm)
167 {
168         struct mtk_drm_private *private = drm->dev_private;
169         struct platform_device *pdev;
170         struct device_node *np;
171         struct device *dma_dev;
172         int ret;
173
174         if (!iommu_present(&platform_bus_type))
175                 return -EPROBE_DEFER;
176
177         pdev = of_find_device_by_node(private->mutex_node);
178         if (!pdev) {
179                 dev_err(drm->dev, "Waiting for disp-mutex device %pOF\n",
180                         private->mutex_node);
181                 of_node_put(private->mutex_node);
182                 return -EPROBE_DEFER;
183         }
184         private->mutex_dev = &pdev->dev;
185
186         ret = drmm_mode_config_init(drm);
187         if (ret)
188                 goto put_mutex_dev;
189
190         drm->mode_config.min_width = 64;
191         drm->mode_config.min_height = 64;
192
193         /*
194          * set max width and height as default value(4096x4096).
195          * this value would be used to check framebuffer size limitation
196          * at drm_mode_addfb().
197          */
198         drm->mode_config.max_width = 4096;
199         drm->mode_config.max_height = 4096;
200         drm->mode_config.funcs = &mtk_drm_mode_config_funcs;
201         drm->mode_config.helper_private = &mtk_drm_mode_config_helpers;
202
203         ret = component_bind_all(drm->dev, drm);
204         if (ret)
205                 goto put_mutex_dev;
206
207         /*
208          * We currently support two fixed data streams, each optional,
209          * and each statically assigned to a crtc:
210          * OVL0 -> COLOR0 -> AAL -> OD -> RDMA0 -> UFOE -> DSI0 ...
211          */
212         ret = mtk_drm_crtc_create(drm, private->data->main_path,
213                                   private->data->main_len);
214         if (ret < 0)
215                 goto err_component_unbind;
216         /* ... and OVL1 -> COLOR1 -> GAMMA -> RDMA1 -> DPI0. */
217         ret = mtk_drm_crtc_create(drm, private->data->ext_path,
218                                   private->data->ext_len);
219         if (ret < 0)
220                 goto err_component_unbind;
221
222         ret = mtk_drm_crtc_create(drm, private->data->third_path,
223                                   private->data->third_len);
224         if (ret < 0)
225                 goto err_component_unbind;
226
227         /* Use OVL device for all DMA memory allocations */
228         np = private->comp_node[private->data->main_path[0]] ?:
229              private->comp_node[private->data->ext_path[0]];
230         pdev = of_find_device_by_node(np);
231         if (!pdev) {
232                 ret = -ENODEV;
233                 dev_err(drm->dev, "Need at least one OVL device\n");
234                 goto err_component_unbind;
235         }
236
237         dma_dev = &pdev->dev;
238         private->dma_dev = dma_dev;
239
240         /*
241          * Configure the DMA segment size to make sure we get contiguous IOVA
242          * when importing PRIME buffers.
243          */
244         ret = dma_set_max_seg_size(dma_dev, UINT_MAX);
245         if (ret) {
246                 dev_err(dma_dev, "Failed to set DMA segment size\n");
247                 goto err_component_unbind;
248         }
249
250         /*
251          * We don't use the drm_irq_install() helpers provided by the DRM
252          * core, so we need to set this manually in order to allow the
253          * DRM_IOCTL_WAIT_VBLANK to operate correctly.
254          */
255         drm->irq_enabled = true;
256         ret = drm_vblank_init(drm, MAX_CRTC);
257         if (ret < 0)
258                 goto err_component_unbind;
259
260         drm_kms_helper_poll_init(drm);
261         drm_mode_config_reset(drm);
262
263         return 0;
264
265 err_component_unbind:
266         component_unbind_all(drm->dev, drm);
267 put_mutex_dev:
268         put_device(private->mutex_dev);
269         return ret;
270 }
271
272 static void mtk_drm_kms_deinit(struct drm_device *drm)
273 {
274         drm_kms_helper_poll_fini(drm);
275         drm_atomic_helper_shutdown(drm);
276
277         component_unbind_all(drm->dev, drm);
278 }
279
280 static const struct file_operations mtk_drm_fops = {
281         .owner = THIS_MODULE,
282         .open = drm_open,
283         .release = drm_release,
284         .unlocked_ioctl = drm_ioctl,
285         .mmap = mtk_drm_gem_mmap,
286         .poll = drm_poll,
287         .read = drm_read,
288         .compat_ioctl = drm_compat_ioctl,
289 };
290
291 /*
292  * We need to override this because the device used to import the memory is
293  * not dev->dev, as drm_gem_prime_import() expects.
294  */
295 static struct drm_gem_object *mtk_drm_gem_prime_import(struct drm_device *dev,
296                                                        struct dma_buf *dma_buf)
297 {
298         struct mtk_drm_private *private = dev->dev_private;
299
300         return drm_gem_prime_import_dev(dev, dma_buf, private->dma_dev);
301 }
302
303 static struct drm_driver mtk_drm_driver = {
304         .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
305
306         .dumb_create = mtk_drm_gem_dumb_create,
307
308         .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
309         .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
310         .gem_prime_import = mtk_drm_gem_prime_import,
311         .gem_prime_import_sg_table = mtk_gem_prime_import_sg_table,
312         .gem_prime_mmap = mtk_drm_gem_mmap_buf,
313         .fops = &mtk_drm_fops,
314
315         .name = DRIVER_NAME,
316         .desc = DRIVER_DESC,
317         .date = DRIVER_DATE,
318         .major = DRIVER_MAJOR,
319         .minor = DRIVER_MINOR,
320 };
321
322 static int compare_of(struct device *dev, void *data)
323 {
324         return dev->of_node == data;
325 }
326
327 static int mtk_drm_bind(struct device *dev)
328 {
329         struct mtk_drm_private *private = dev_get_drvdata(dev);
330         struct drm_device *drm;
331         int ret;
332
333         drm = drm_dev_alloc(&mtk_drm_driver, dev);
334         if (IS_ERR(drm))
335                 return PTR_ERR(drm);
336
337         drm->dev_private = private;
338         private->drm = drm;
339
340         ret = mtk_drm_kms_init(drm);
341         if (ret < 0)
342                 goto err_free;
343
344         ret = drm_dev_register(drm, 0);
345         if (ret < 0)
346                 goto err_deinit;
347
348         drm_fbdev_generic_setup(drm, 32);
349
350         return 0;
351
352 err_deinit:
353         mtk_drm_kms_deinit(drm);
354 err_free:
355         drm_dev_put(drm);
356         return ret;
357 }
358
359 static void mtk_drm_unbind(struct device *dev)
360 {
361         struct mtk_drm_private *private = dev_get_drvdata(dev);
362
363         drm_dev_unregister(private->drm);
364         mtk_drm_kms_deinit(private->drm);
365         drm_dev_put(private->drm);
366         private->num_pipes = 0;
367         private->drm = NULL;
368 }
369
370 static const struct component_master_ops mtk_drm_ops = {
371         .bind           = mtk_drm_bind,
372         .unbind         = mtk_drm_unbind,
373 };
374
375 static const struct of_device_id mtk_ddp_comp_dt_ids[] = {
376         { .compatible = "mediatek,mt2701-disp-ovl",
377           .data = (void *)MTK_DISP_OVL },
378         { .compatible = "mediatek,mt8173-disp-ovl",
379           .data = (void *)MTK_DISP_OVL },
380         { .compatible = "mediatek,mt2701-disp-rdma",
381           .data = (void *)MTK_DISP_RDMA },
382         { .compatible = "mediatek,mt8173-disp-rdma",
383           .data = (void *)MTK_DISP_RDMA },
384         { .compatible = "mediatek,mt8173-disp-wdma",
385           .data = (void *)MTK_DISP_WDMA },
386         { .compatible = "mediatek,mt2701-disp-color",
387           .data = (void *)MTK_DISP_COLOR },
388         { .compatible = "mediatek,mt8173-disp-color",
389           .data = (void *)MTK_DISP_COLOR },
390         { .compatible = "mediatek,mt8173-disp-aal",
391           .data = (void *)MTK_DISP_AAL},
392         { .compatible = "mediatek,mt8173-disp-gamma",
393           .data = (void *)MTK_DISP_GAMMA, },
394         { .compatible = "mediatek,mt8173-disp-ufoe",
395           .data = (void *)MTK_DISP_UFOE },
396         { .compatible = "mediatek,mt2701-dsi",
397           .data = (void *)MTK_DSI },
398         { .compatible = "mediatek,mt8173-dsi",
399           .data = (void *)MTK_DSI },
400         { .compatible = "mediatek,mt2701-dpi",
401           .data = (void *)MTK_DPI },
402         { .compatible = "mediatek,mt8173-dpi",
403           .data = (void *)MTK_DPI },
404         { .compatible = "mediatek,mt2701-disp-mutex",
405           .data = (void *)MTK_DISP_MUTEX },
406         { .compatible = "mediatek,mt2712-disp-mutex",
407           .data = (void *)MTK_DISP_MUTEX },
408         { .compatible = "mediatek,mt8173-disp-mutex",
409           .data = (void *)MTK_DISP_MUTEX },
410         { .compatible = "mediatek,mt2701-disp-pwm",
411           .data = (void *)MTK_DISP_BLS },
412         { .compatible = "mediatek,mt8173-disp-pwm",
413           .data = (void *)MTK_DISP_PWM },
414         { .compatible = "mediatek,mt8173-disp-od",
415           .data = (void *)MTK_DISP_OD },
416         { }
417 };
418
419 static const struct of_device_id mtk_drm_of_ids[] = {
420         { .compatible = "mediatek,mt2701-mmsys",
421           .data = &mt2701_mmsys_driver_data},
422         { .compatible = "mediatek,mt7623-mmsys",
423           .data = &mt7623_mmsys_driver_data},
424         { .compatible = "mediatek,mt2712-mmsys",
425           .data = &mt2712_mmsys_driver_data},
426         { .compatible = "mediatek,mt8173-mmsys",
427           .data = &mt8173_mmsys_driver_data},
428         { }
429 };
430
431 static int mtk_drm_probe(struct platform_device *pdev)
432 {
433         struct device *dev = &pdev->dev;
434         struct device_node *phandle = dev->parent->of_node;
435         const struct of_device_id *of_id;
436         struct mtk_drm_private *private;
437         struct device_node *node;
438         struct component_match *match = NULL;
439         int ret;
440         int i;
441
442         private = devm_kzalloc(dev, sizeof(*private), GFP_KERNEL);
443         if (!private)
444                 return -ENOMEM;
445
446         private->mmsys_dev = dev->parent;
447         if (!private->mmsys_dev) {
448                 dev_err(dev, "Failed to get MMSYS device\n");
449                 return -ENODEV;
450         }
451
452         of_id = of_match_node(mtk_drm_of_ids, phandle);
453         if (!of_id)
454                 return -ENODEV;
455
456         private->data = of_id->data;
457
458         /* Iterate over sibling DISP function blocks */
459         for_each_child_of_node(phandle->parent, node) {
460                 const struct of_device_id *of_id;
461                 enum mtk_ddp_comp_type comp_type;
462                 int comp_id;
463
464                 of_id = of_match_node(mtk_ddp_comp_dt_ids, node);
465                 if (!of_id)
466                         continue;
467
468                 if (!of_device_is_available(node)) {
469                         dev_dbg(dev, "Skipping disabled component %pOF\n",
470                                 node);
471                         continue;
472                 }
473
474                 comp_type = (enum mtk_ddp_comp_type)of_id->data;
475
476                 if (comp_type == MTK_DISP_MUTEX) {
477                         private->mutex_node = of_node_get(node);
478                         continue;
479                 }
480
481                 comp_id = mtk_ddp_comp_get_id(node, comp_type);
482                 if (comp_id < 0) {
483                         dev_warn(dev, "Skipping unknown component %pOF\n",
484                                  node);
485                         continue;
486                 }
487
488                 private->comp_node[comp_id] = of_node_get(node);
489
490                 /*
491                  * Currently only the COLOR, OVL, RDMA, DSI, and DPI blocks have
492                  * separate component platform drivers and initialize their own
493                  * DDP component structure. The others are initialized here.
494                  */
495                 if (comp_type == MTK_DISP_COLOR ||
496                     comp_type == MTK_DISP_OVL ||
497                     comp_type == MTK_DISP_OVL_2L ||
498                     comp_type == MTK_DISP_RDMA ||
499                     comp_type == MTK_DSI ||
500                     comp_type == MTK_DPI) {
501                         dev_info(dev, "Adding component match for %pOF\n",
502                                  node);
503                         drm_of_component_match_add(dev, &match, compare_of,
504                                                    node);
505                 } else {
506                         struct mtk_ddp_comp *comp;
507
508                         comp = devm_kzalloc(dev, sizeof(*comp), GFP_KERNEL);
509                         if (!comp) {
510                                 ret = -ENOMEM;
511                                 of_node_put(node);
512                                 goto err_node;
513                         }
514
515                         ret = mtk_ddp_comp_init(dev->parent, node, comp,
516                                                 comp_id, NULL);
517                         if (ret) {
518                                 of_node_put(node);
519                                 goto err_node;
520                         }
521
522                         private->ddp_comp[comp_id] = comp;
523                 }
524         }
525
526         if (!private->mutex_node) {
527                 dev_err(dev, "Failed to find disp-mutex node\n");
528                 ret = -ENODEV;
529                 goto err_node;
530         }
531
532         pm_runtime_enable(dev);
533
534         platform_set_drvdata(pdev, private);
535
536         ret = component_master_add_with_match(dev, &mtk_drm_ops, match);
537         if (ret)
538                 goto err_pm;
539
540         return 0;
541
542 err_pm:
543         pm_runtime_disable(dev);
544 err_node:
545         of_node_put(private->mutex_node);
546         for (i = 0; i < DDP_COMPONENT_ID_MAX; i++) {
547                 of_node_put(private->comp_node[i]);
548                 if (private->ddp_comp[i]) {
549                         put_device(private->ddp_comp[i]->larb_dev);
550                         private->ddp_comp[i] = NULL;
551                 }
552         }
553         return ret;
554 }
555
556 static int mtk_drm_remove(struct platform_device *pdev)
557 {
558         struct mtk_drm_private *private = platform_get_drvdata(pdev);
559         int i;
560
561         component_master_del(&pdev->dev, &mtk_drm_ops);
562         pm_runtime_disable(&pdev->dev);
563         of_node_put(private->mutex_node);
564         for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
565                 of_node_put(private->comp_node[i]);
566
567         return 0;
568 }
569
570 #ifdef CONFIG_PM_SLEEP
571 static int mtk_drm_sys_suspend(struct device *dev)
572 {
573         struct mtk_drm_private *private = dev_get_drvdata(dev);
574         struct drm_device *drm = private->drm;
575         int ret;
576
577         ret = drm_mode_config_helper_suspend(drm);
578
579         return ret;
580 }
581
582 static int mtk_drm_sys_resume(struct device *dev)
583 {
584         struct mtk_drm_private *private = dev_get_drvdata(dev);
585         struct drm_device *drm = private->drm;
586         int ret;
587
588         ret = drm_mode_config_helper_resume(drm);
589
590         return ret;
591 }
592 #endif
593
594 static SIMPLE_DEV_PM_OPS(mtk_drm_pm_ops, mtk_drm_sys_suspend,
595                          mtk_drm_sys_resume);
596
597 static struct platform_driver mtk_drm_platform_driver = {
598         .probe  = mtk_drm_probe,
599         .remove = mtk_drm_remove,
600         .driver = {
601                 .name   = "mediatek-drm",
602                 .pm     = &mtk_drm_pm_ops,
603         },
604 };
605
606 static struct platform_driver * const mtk_drm_drivers[] = {
607         &mtk_ddp_driver,
608         &mtk_disp_color_driver,
609         &mtk_disp_ovl_driver,
610         &mtk_disp_rdma_driver,
611         &mtk_dpi_driver,
612         &mtk_drm_platform_driver,
613         &mtk_mipi_tx_driver,
614         &mtk_dsi_driver,
615 };
616
617 static int __init mtk_drm_init(void)
618 {
619         return platform_register_drivers(mtk_drm_drivers,
620                                          ARRAY_SIZE(mtk_drm_drivers));
621 }
622
623 static void __exit mtk_drm_exit(void)
624 {
625         platform_unregister_drivers(mtk_drm_drivers,
626                                     ARRAY_SIZE(mtk_drm_drivers));
627 }
628
629 module_init(mtk_drm_init);
630 module_exit(mtk_drm_exit);
631
632 MODULE_AUTHOR("YT SHEN <yt.shen@mediatek.com>");
633 MODULE_DESCRIPTION("Mediatek SoC DRM driver");
634 MODULE_LICENSE("GPL v2");