Loading...
Note: File does not exist in v3.1.
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 2018 Linus Walleij <linus.walleij@linaro.org>
4 * Parts of this file were based on the MCDE driver by Marcus Lorentzon
5 * (C) ST-Ericsson SA 2013
6 */
7
8/**
9 * DOC: ST-Ericsson MCDE Driver
10 *
11 * The MCDE (short for multi-channel display engine) is a graphics
12 * controller found in the Ux500 chipsets, such as NovaThor U8500.
13 * It was initially conceptualized by ST Microelectronics for the
14 * successor of the Nomadik line, STn8500 but productified in the
15 * ST-Ericsson U8500 where is was used for mass-market deployments
16 * in Android phones from Samsung and Sony Ericsson.
17 *
18 * It can do 1080p30 on SDTV CCIR656, DPI-2, DBI-2 or DSI for
19 * panels with or without frame buffering and can convert most
20 * input formats including most variants of RGB and YUV.
21 *
22 * The hardware has four display pipes, and the layout is a little
23 * bit like this::
24 *
25 * Memory -> Overlay -> Channel -> FIFO -> 8 formatters -> DSI/DPI
26 * External 0..5 0..3 A,B, 6 x DSI bridge
27 * source 0..9 C0,C1 2 x DPI
28 *
29 * FIFOs A and B are for LCD and HDMI while FIFO CO/C1 are for
30 * panels with embedded buffer.
31 * 6 of the formatters are for DSI, 3 pairs for VID/CMD respectively.
32 * 2 of the formatters are for DPI.
33 *
34 * Behind the formatters are the DSI or DPI ports that route to
35 * the external pins of the chip. As there are 3 DSI ports and one
36 * DPI port, it is possible to configure up to 4 display pipelines
37 * (effectively using channels 0..3) for concurrent use.
38 *
39 * In the current DRM/KMS setup, we use one external source, one overlay,
40 * one FIFO and one formatter which we connect to the simple DMA framebuffer
41 * helpers. We then provide a bridge to the DSI port, and on the DSI port
42 * bridge we connect hang a panel bridge or other bridge. This may be subject
43 * to change as we exploit more of the hardware capabilities.
44 *
45 * TODO:
46 *
47 * - Enabled damaged rectangles using drm_plane_enable_fb_damage_clips()
48 * so we can selectively just transmit the damaged area to a
49 * command-only display.
50 * - Enable mixing of more planes, possibly at the cost of moving away
51 * from using the simple framebuffer pipeline.
52 * - Enable output to bridges such as the AV8100 HDMI encoder from
53 * the DSI bridge.
54 */
55
56#include <linux/clk.h>
57#include <linux/component.h>
58#include <linux/dma-buf.h>
59#include <linux/irq.h>
60#include <linux/io.h>
61#include <linux/module.h>
62#include <linux/of_platform.h>
63#include <linux/platform_device.h>
64#include <linux/regulator/consumer.h>
65#include <linux/slab.h>
66#include <linux/delay.h>
67
68#include <drm/drm_atomic_helper.h>
69#include <drm/drm_bridge.h>
70#include <drm/drm_client_setup.h>
71#include <drm/drm_drv.h>
72#include <drm/drm_fb_dma_helper.h>
73#include <drm/drm_fbdev_dma.h>
74#include <drm/drm_gem.h>
75#include <drm/drm_gem_dma_helper.h>
76#include <drm/drm_gem_framebuffer_helper.h>
77#include <drm/drm_managed.h>
78#include <drm/drm_of.h>
79#include <drm/drm_probe_helper.h>
80#include <drm/drm_panel.h>
81#include <drm/drm_vblank.h>
82
83#include "mcde_drm.h"
84
85#define DRIVER_DESC "DRM module for MCDE"
86
87#define MCDE_PID 0x000001FC
88#define MCDE_PID_METALFIX_VERSION_SHIFT 0
89#define MCDE_PID_METALFIX_VERSION_MASK 0x000000FF
90#define MCDE_PID_DEVELOPMENT_VERSION_SHIFT 8
91#define MCDE_PID_DEVELOPMENT_VERSION_MASK 0x0000FF00
92#define MCDE_PID_MINOR_VERSION_SHIFT 16
93#define MCDE_PID_MINOR_VERSION_MASK 0x00FF0000
94#define MCDE_PID_MAJOR_VERSION_SHIFT 24
95#define MCDE_PID_MAJOR_VERSION_MASK 0xFF000000
96
97static const struct drm_mode_config_funcs mcde_mode_config_funcs = {
98 .fb_create = drm_gem_fb_create,
99 .atomic_check = drm_atomic_helper_check,
100 .atomic_commit = drm_atomic_helper_commit,
101};
102
103static const struct drm_mode_config_helper_funcs mcde_mode_config_helpers = {
104 /*
105 * Using this function is necessary to commit atomic updates
106 * that need the CRTC to be enabled before a commit, as is
107 * the case with e.g. DSI displays.
108 */
109 .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
110};
111
112static irqreturn_t mcde_irq(int irq, void *data)
113{
114 struct mcde *mcde = data;
115 u32 val;
116
117 val = readl(mcde->regs + MCDE_MISERR);
118
119 mcde_display_irq(mcde);
120
121 if (val)
122 dev_info(mcde->dev, "some error IRQ\n");
123 writel(val, mcde->regs + MCDE_RISERR);
124
125 return IRQ_HANDLED;
126}
127
128static int mcde_modeset_init(struct drm_device *drm)
129{
130 struct drm_mode_config *mode_config;
131 struct mcde *mcde = to_mcde(drm);
132 int ret;
133
134 /*
135 * If no other bridge was found, check if we have a DPI panel or
136 * any other bridge connected directly to the MCDE DPI output.
137 * If a DSI bridge is found, DSI will take precedence.
138 *
139 * TODO: more elaborate bridge selection if we have more than one
140 * thing attached to the system.
141 */
142 if (!mcde->bridge) {
143 struct drm_panel *panel;
144 struct drm_bridge *bridge;
145
146 ret = drm_of_find_panel_or_bridge(drm->dev->of_node,
147 0, 0, &panel, &bridge);
148 if (ret) {
149 dev_err(drm->dev,
150 "Could not locate any output bridge or panel\n");
151 return ret;
152 }
153 if (panel) {
154 bridge = drm_panel_bridge_add_typed(panel,
155 DRM_MODE_CONNECTOR_DPI);
156 if (IS_ERR(bridge)) {
157 dev_err(drm->dev,
158 "Could not connect panel bridge\n");
159 return PTR_ERR(bridge);
160 }
161 }
162 mcde->dpi_output = true;
163 mcde->bridge = bridge;
164 mcde->flow_mode = MCDE_DPI_FORMATTER_FLOW;
165 }
166
167 mode_config = &drm->mode_config;
168 mode_config->funcs = &mcde_mode_config_funcs;
169 mode_config->helper_private = &mcde_mode_config_helpers;
170 /* This hardware can do 1080p */
171 mode_config->min_width = 1;
172 mode_config->max_width = 1920;
173 mode_config->min_height = 1;
174 mode_config->max_height = 1080;
175
176 ret = drm_vblank_init(drm, 1);
177 if (ret) {
178 dev_err(drm->dev, "failed to init vblank\n");
179 return ret;
180 }
181
182 ret = mcde_display_init(drm);
183 if (ret) {
184 dev_err(drm->dev, "failed to init display\n");
185 return ret;
186 }
187
188 /* Attach the bridge. */
189 ret = drm_simple_display_pipe_attach_bridge(&mcde->pipe,
190 mcde->bridge);
191 if (ret) {
192 dev_err(drm->dev, "failed to attach display output bridge\n");
193 return ret;
194 }
195
196 drm_mode_config_reset(drm);
197 drm_kms_helper_poll_init(drm);
198
199 return 0;
200}
201
202DEFINE_DRM_GEM_DMA_FOPS(drm_fops);
203
204static const struct drm_driver mcde_drm_driver = {
205 .driver_features =
206 DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
207 .ioctls = NULL,
208 .fops = &drm_fops,
209 .name = "mcde",
210 .desc = DRIVER_DESC,
211 .date = "20180529",
212 .major = 1,
213 .minor = 0,
214 .patchlevel = 0,
215 DRM_GEM_DMA_DRIVER_OPS,
216 DRM_FBDEV_DMA_DRIVER_OPS,
217};
218
219static int mcde_drm_bind(struct device *dev)
220{
221 struct drm_device *drm = dev_get_drvdata(dev);
222 int ret;
223
224 ret = drmm_mode_config_init(drm);
225 if (ret)
226 return ret;
227
228 ret = component_bind_all(drm->dev, drm);
229 if (ret) {
230 dev_err(dev, "can't bind component devices\n");
231 return ret;
232 }
233
234 ret = mcde_modeset_init(drm);
235 if (ret)
236 goto unbind;
237
238 ret = drm_dev_register(drm, 0);
239 if (ret < 0)
240 goto unbind;
241
242 drm_client_setup(drm, NULL);
243
244 return 0;
245
246unbind:
247 component_unbind_all(drm->dev, drm);
248 return ret;
249}
250
251static void mcde_drm_unbind(struct device *dev)
252{
253 struct drm_device *drm = dev_get_drvdata(dev);
254
255 drm_dev_unregister(drm);
256 drm_atomic_helper_shutdown(drm);
257 component_unbind_all(drm->dev, drm);
258}
259
260static const struct component_master_ops mcde_drm_comp_ops = {
261 .bind = mcde_drm_bind,
262 .unbind = mcde_drm_unbind,
263};
264
265static struct platform_driver *const mcde_component_drivers[] = {
266 &mcde_dsi_driver,
267};
268
269static int mcde_probe(struct platform_device *pdev)
270{
271 struct device *dev = &pdev->dev;
272 struct drm_device *drm;
273 struct mcde *mcde;
274 struct component_match *match = NULL;
275 u32 pid;
276 int irq;
277 int ret;
278 int i;
279
280 mcde = devm_drm_dev_alloc(dev, &mcde_drm_driver, struct mcde, drm);
281 if (IS_ERR(mcde))
282 return PTR_ERR(mcde);
283 drm = &mcde->drm;
284 mcde->dev = dev;
285 platform_set_drvdata(pdev, drm);
286
287 /* First obtain and turn on the main power */
288 mcde->epod = devm_regulator_get(dev, "epod");
289 if (IS_ERR(mcde->epod)) {
290 ret = PTR_ERR(mcde->epod);
291 dev_err(dev, "can't get EPOD regulator\n");
292 return ret;
293 }
294 ret = regulator_enable(mcde->epod);
295 if (ret) {
296 dev_err(dev, "can't enable EPOD regulator\n");
297 return ret;
298 }
299 mcde->vana = devm_regulator_get(dev, "vana");
300 if (IS_ERR(mcde->vana)) {
301 ret = PTR_ERR(mcde->vana);
302 dev_err(dev, "can't get VANA regulator\n");
303 goto regulator_epod_off;
304 }
305 ret = regulator_enable(mcde->vana);
306 if (ret) {
307 dev_err(dev, "can't enable VANA regulator\n");
308 goto regulator_epod_off;
309 }
310 /*
311 * The vendor code uses ESRAM (onchip RAM) and need to activate
312 * the v-esram34 regulator, but we don't use that yet
313 */
314
315 /* Clock the silicon so we can access the registers */
316 mcde->mcde_clk = devm_clk_get(dev, "mcde");
317 if (IS_ERR(mcde->mcde_clk)) {
318 dev_err(dev, "unable to get MCDE main clock\n");
319 ret = PTR_ERR(mcde->mcde_clk);
320 goto regulator_off;
321 }
322 ret = clk_prepare_enable(mcde->mcde_clk);
323 if (ret) {
324 dev_err(dev, "failed to enable MCDE main clock\n");
325 goto regulator_off;
326 }
327 dev_info(dev, "MCDE clk rate %lu Hz\n", clk_get_rate(mcde->mcde_clk));
328
329 mcde->lcd_clk = devm_clk_get(dev, "lcd");
330 if (IS_ERR(mcde->lcd_clk)) {
331 dev_err(dev, "unable to get LCD clock\n");
332 ret = PTR_ERR(mcde->lcd_clk);
333 goto clk_disable;
334 }
335 mcde->hdmi_clk = devm_clk_get(dev, "hdmi");
336 if (IS_ERR(mcde->hdmi_clk)) {
337 dev_err(dev, "unable to get HDMI clock\n");
338 ret = PTR_ERR(mcde->hdmi_clk);
339 goto clk_disable;
340 }
341
342 mcde->regs = devm_platform_ioremap_resource(pdev, 0);
343 if (IS_ERR(mcde->regs)) {
344 dev_err(dev, "no MCDE regs\n");
345 ret = -EINVAL;
346 goto clk_disable;
347 }
348
349 irq = platform_get_irq(pdev, 0);
350 if (irq < 0) {
351 ret = irq;
352 goto clk_disable;
353 }
354
355 ret = devm_request_irq(dev, irq, mcde_irq, 0, "mcde", mcde);
356 if (ret) {
357 dev_err(dev, "failed to request irq %d\n", ret);
358 goto clk_disable;
359 }
360
361 /*
362 * Check hardware revision, we only support U8500v2 version
363 * as this was the only version used for mass market deployment,
364 * but surely you can add more versions if you have them and
365 * need them.
366 */
367 pid = readl(mcde->regs + MCDE_PID);
368 dev_info(dev, "found MCDE HW revision %d.%d (dev %d, metal fix %d)\n",
369 (pid & MCDE_PID_MAJOR_VERSION_MASK)
370 >> MCDE_PID_MAJOR_VERSION_SHIFT,
371 (pid & MCDE_PID_MINOR_VERSION_MASK)
372 >> MCDE_PID_MINOR_VERSION_SHIFT,
373 (pid & MCDE_PID_DEVELOPMENT_VERSION_MASK)
374 >> MCDE_PID_DEVELOPMENT_VERSION_SHIFT,
375 (pid & MCDE_PID_METALFIX_VERSION_MASK)
376 >> MCDE_PID_METALFIX_VERSION_SHIFT);
377 if (pid != 0x03000800) {
378 dev_err(dev, "unsupported hardware revision\n");
379 ret = -ENODEV;
380 goto clk_disable;
381 }
382
383 /* Disable and clear any pending interrupts */
384 mcde_display_disable_irqs(mcde);
385 writel(0, mcde->regs + MCDE_IMSCERR);
386 writel(0xFFFFFFFF, mcde->regs + MCDE_RISERR);
387
388 /* Spawn child devices for the DSI ports */
389 devm_of_platform_populate(dev);
390
391 /* Create something that will match the subdrivers when we bind */
392 for (i = 0; i < ARRAY_SIZE(mcde_component_drivers); i++) {
393 struct device_driver *drv = &mcde_component_drivers[i]->driver;
394 struct device *p = NULL, *d;
395
396 while ((d = platform_find_device_by_driver(p, drv))) {
397 put_device(p);
398 component_match_add(dev, &match, component_compare_dev, d);
399 p = d;
400 }
401 put_device(p);
402 }
403 if (!match) {
404 dev_err(dev, "no matching components\n");
405 ret = -ENODEV;
406 goto clk_disable;
407 }
408 if (IS_ERR(match)) {
409 dev_err(dev, "could not create component match\n");
410 ret = PTR_ERR(match);
411 goto clk_disable;
412 }
413
414 /*
415 * Perform an invasive reset of the MCDE and all blocks by
416 * cutting the power to the subsystem, then bring it back up
417 * later when we enable the display as a result of
418 * component_master_add_with_match().
419 */
420 ret = regulator_disable(mcde->epod);
421 if (ret) {
422 dev_err(dev, "can't disable EPOD regulator\n");
423 return ret;
424 }
425 /* Wait 50 ms so we are sure we cut the power */
426 usleep_range(50000, 70000);
427
428 ret = component_master_add_with_match(&pdev->dev, &mcde_drm_comp_ops,
429 match);
430 if (ret) {
431 dev_err(dev, "failed to add component master\n");
432 /*
433 * The EPOD regulator is already disabled at this point so some
434 * special errorpath code is needed
435 */
436 clk_disable_unprepare(mcde->mcde_clk);
437 regulator_disable(mcde->vana);
438 return ret;
439 }
440
441 return 0;
442
443clk_disable:
444 clk_disable_unprepare(mcde->mcde_clk);
445regulator_off:
446 regulator_disable(mcde->vana);
447regulator_epod_off:
448 regulator_disable(mcde->epod);
449 return ret;
450
451}
452
453static void mcde_remove(struct platform_device *pdev)
454{
455 struct drm_device *drm = platform_get_drvdata(pdev);
456 struct mcde *mcde = to_mcde(drm);
457
458 component_master_del(&pdev->dev, &mcde_drm_comp_ops);
459 clk_disable_unprepare(mcde->mcde_clk);
460 regulator_disable(mcde->vana);
461 regulator_disable(mcde->epod);
462}
463
464static void mcde_shutdown(struct platform_device *pdev)
465{
466 struct drm_device *drm = platform_get_drvdata(pdev);
467
468 if (drm->registered)
469 drm_atomic_helper_shutdown(drm);
470}
471
472static const struct of_device_id mcde_of_match[] = {
473 {
474 .compatible = "ste,mcde",
475 },
476 {},
477};
478MODULE_DEVICE_TABLE(of, mcde_of_match);
479
480static struct platform_driver mcde_driver = {
481 .driver = {
482 .name = "mcde",
483 .of_match_table = mcde_of_match,
484 },
485 .probe = mcde_probe,
486 .remove = mcde_remove,
487 .shutdown = mcde_shutdown,
488};
489
490static struct platform_driver *const component_drivers[] = {
491 &mcde_dsi_driver,
492};
493
494static int __init mcde_drm_register(void)
495{
496 int ret;
497
498 if (drm_firmware_drivers_only())
499 return -ENODEV;
500
501 ret = platform_register_drivers(component_drivers,
502 ARRAY_SIZE(component_drivers));
503 if (ret)
504 return ret;
505
506 return platform_driver_register(&mcde_driver);
507}
508
509static void __exit mcde_drm_unregister(void)
510{
511 platform_unregister_drivers(component_drivers,
512 ARRAY_SIZE(component_drivers));
513 platform_driver_unregister(&mcde_driver);
514}
515
516module_init(mcde_drm_register);
517module_exit(mcde_drm_unregister);
518
519MODULE_ALIAS("platform:mcde-drm");
520MODULE_DESCRIPTION(DRIVER_DESC);
521MODULE_AUTHOR("Linus Walleij <linus.walleij@linaro.org>");
522MODULE_LICENSE("GPL");