2 * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved.
4 * Parts of this file were based on sources as follows:
6 * Copyright (c) 2006-2008 Intel Corporation
7 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
8 * Copyright (C) 2011 Texas Instruments
10 * This program is free software and is provided to you under the terms of the
11 * GNU General Public License version 2 as published by the Free Software
12 * Foundation, and any use by you of this program is subject to the terms of
17 #include <linux/amba/clcd-regs.h>
18 #include <linux/clk.h>
19 #include <linux/version.h>
20 #include <linux/dma-buf.h>
21 #include <linux/of_graph.h>
24 #include <drm/drm_gem_cma_helper.h>
25 #include <drm/drm_gem_framebuffer_helper.h>
26 #include <drm/drm_fb_cma_helper.h>
28 #include "pl111_drm.h"
30 irqreturn_t pl111_irq(int irq, void *data)
32 struct pl111_drm_dev_private *priv = data;
34 irqreturn_t status = IRQ_NONE;
36 irq_stat = readl(priv->regs + CLCD_PL111_MIS);
41 if (irq_stat & CLCD_IRQ_NEXTBASE_UPDATE) {
42 drm_crtc_handle_vblank(&priv->pipe.crtc);
47 /* Clear the interrupt once done */
48 writel(irq_stat, priv->regs + CLCD_PL111_ICR);
53 static enum drm_mode_status
54 pl111_mode_valid(struct drm_crtc *crtc,
55 const struct drm_display_mode *mode)
57 struct drm_device *drm = crtc->dev;
58 struct pl111_drm_dev_private *priv = drm->dev_private;
59 u32 cpp = priv->variant->fb_bpp / 8;
63 * We use the pixelclock to also account for interlaced modes, the
64 * resulting bandwidth is in bytes per second.
66 bw = mode->clock * 1000; /* In Hz */
67 bw = bw * mode->hdisplay * mode->vdisplay * cpp;
68 bw = div_u64(bw, mode->htotal * mode->vtotal);
71 * If no bandwidth constraints, anything goes, else
72 * check if we are too fast.
74 if (priv->memory_bw && (bw > priv->memory_bw)) {
75 DRM_DEBUG_KMS("%d x %d @ %d Hz, %d cpp, bw %llu too fast\n",
76 mode->hdisplay, mode->vdisplay,
77 mode->clock * 1000, cpp, bw);
81 DRM_DEBUG_KMS("%d x %d @ %d Hz, %d cpp, bw %llu bytes/s OK\n",
82 mode->hdisplay, mode->vdisplay,
83 mode->clock * 1000, cpp, bw);
88 static int pl111_display_check(struct drm_simple_display_pipe *pipe,
89 struct drm_plane_state *pstate,
90 struct drm_crtc_state *cstate)
92 const struct drm_display_mode *mode = &cstate->mode;
93 struct drm_framebuffer *old_fb = pipe->plane.state->fb;
94 struct drm_framebuffer *fb = pstate->fb;
96 if (mode->hdisplay % 16)
100 u32 offset = drm_fb_cma_get_gem_addr(fb, pstate, 0);
102 /* FB base address must be dword aligned. */
106 /* There's no pitch register -- the mode's hdisplay
109 if (fb->pitches[0] != mode->hdisplay * fb->format->cpp[0])
112 /* We can't change the FB format in a flicker-free
113 * manner (and only update it during CRTC enable).
115 if (old_fb && old_fb->format != fb->format)
116 cstate->mode_changed = true;
122 static void pl111_display_enable(struct drm_simple_display_pipe *pipe,
123 struct drm_crtc_state *cstate)
125 struct drm_crtc *crtc = &pipe->crtc;
126 struct drm_plane *plane = &pipe->plane;
127 struct drm_device *drm = crtc->dev;
128 struct pl111_drm_dev_private *priv = drm->dev_private;
129 const struct drm_display_mode *mode = &cstate->mode;
130 struct drm_framebuffer *fb = plane->state->fb;
131 struct drm_connector *connector = priv->connector;
132 struct drm_bridge *bridge = priv->bridge;
134 u32 ppl, hsw, hfp, hbp;
135 u32 lpp, vsw, vfp, vbp;
139 ret = clk_set_rate(priv->clk, mode->clock * 1000);
142 "Failed to set pixel clock rate to %d: %d\n",
143 mode->clock * 1000, ret);
146 clk_prepare_enable(priv->clk);
148 ppl = (mode->hdisplay / 16) - 1;
149 hsw = mode->hsync_end - mode->hsync_start - 1;
150 hfp = mode->hsync_start - mode->hdisplay - 1;
151 hbp = mode->htotal - mode->hsync_end - 1;
153 lpp = mode->vdisplay - 1;
154 vsw = mode->vsync_end - mode->vsync_start - 1;
155 vfp = mode->vsync_start - mode->vdisplay;
156 vbp = mode->vtotal - mode->vsync_end;
158 cpl = mode->hdisplay - 1;
164 priv->regs + CLCD_TIM0);
169 priv->regs + CLCD_TIM1);
171 spin_lock(&priv->tim2_lock);
173 tim2 = readl(priv->regs + CLCD_TIM2);
174 tim2 &= (TIM2_BCD | TIM2_PCD_LO_MASK | TIM2_PCD_HI_MASK);
176 if (priv->variant->broken_clockdivider)
179 if (mode->flags & DRM_MODE_FLAG_NHSYNC)
182 if (mode->flags & DRM_MODE_FLAG_NVSYNC)
186 if (connector->display_info.bus_flags & DRM_BUS_FLAG_DE_LOW)
189 if (connector->display_info.bus_flags &
190 DRM_BUS_FLAG_PIXDATA_NEGEDGE)
195 const struct drm_bridge_timings *btimings = bridge->timings;
198 * Here is when things get really fun. Sometimes the bridge
199 * timings are such that the signal out from PL11x is not
200 * stable before the receiving bridge (such as a dumb VGA DAC
201 * or similar) samples it. If that happens, we compensate by
202 * the only method we have: output the data on the opposite
203 * edge of the clock so it is for sure stable when it gets
206 * The PL111 manual does not contain proper timining diagrams
207 * or data for these details, but we know from experiments
208 * that the setup time is more than 3000 picoseconds (3 ns).
209 * If we have a bridge that requires the signal to be stable
210 * earlier than 3000 ps before the clock pulse, we have to
211 * output the data on the opposite edge to avoid flicker.
213 if (btimings && btimings->setup_time_ps >= 3000)
218 writel(tim2, priv->regs + CLCD_TIM2);
219 spin_unlock(&priv->tim2_lock);
221 writel(0, priv->regs + CLCD_TIM3);
223 /* Hard-code TFT panel */
224 cntl = CNTL_LCDEN | CNTL_LCDTFT | CNTL_LCDVCOMP(1);
226 /* Note that the the hardware's format reader takes 'r' from
227 * the low bit, while DRM formats list channels from high bit
228 * to low bit as you read left to right.
230 switch (fb->format->format) {
231 case DRM_FORMAT_ABGR8888:
232 case DRM_FORMAT_XBGR8888:
233 cntl |= CNTL_LCDBPP24;
235 case DRM_FORMAT_ARGB8888:
236 case DRM_FORMAT_XRGB8888:
237 cntl |= CNTL_LCDBPP24 | CNTL_BGR;
239 case DRM_FORMAT_BGR565:
240 if (priv->variant->is_pl110)
241 cntl |= CNTL_LCDBPP16;
243 cntl |= CNTL_LCDBPP16_565;
245 case DRM_FORMAT_RGB565:
246 if (priv->variant->is_pl110)
247 cntl |= CNTL_LCDBPP16;
249 cntl |= CNTL_LCDBPP16_565;
252 case DRM_FORMAT_ABGR1555:
253 case DRM_FORMAT_XBGR1555:
254 cntl |= CNTL_LCDBPP16;
256 case DRM_FORMAT_ARGB1555:
257 case DRM_FORMAT_XRGB1555:
258 cntl |= CNTL_LCDBPP16 | CNTL_BGR;
260 case DRM_FORMAT_ABGR4444:
261 case DRM_FORMAT_XBGR4444:
262 cntl |= CNTL_LCDBPP16_444;
264 case DRM_FORMAT_ARGB4444:
265 case DRM_FORMAT_XRGB4444:
266 cntl |= CNTL_LCDBPP16_444 | CNTL_BGR;
269 WARN_ONCE(true, "Unknown FB format 0x%08x\n",
274 /* The PL110 in Integrator/Versatile does the BGR routing externally */
275 if (priv->variant->external_bgr)
278 /* Power sequence: first enable and chill */
279 writel(cntl, priv->regs + priv->ctrl);
282 * We expect this delay to stabilize the contrast
283 * voltage Vee as stipulated by the manual
287 if (priv->variant_display_enable)
288 priv->variant_display_enable(drm, fb->format->format);
292 writel(cntl, priv->regs + priv->ctrl);
294 if (!priv->variant->broken_vblank)
295 drm_crtc_vblank_on(crtc);
298 void pl111_display_disable(struct drm_simple_display_pipe *pipe)
300 struct drm_crtc *crtc = &pipe->crtc;
301 struct drm_device *drm = crtc->dev;
302 struct pl111_drm_dev_private *priv = drm->dev_private;
305 if (!priv->variant->broken_vblank)
306 drm_crtc_vblank_off(crtc);
309 cntl = readl(priv->regs + priv->ctrl);
310 if (cntl & CNTL_LCDPWR) {
311 cntl &= ~CNTL_LCDPWR;
312 writel(cntl, priv->regs + priv->ctrl);
316 * We expect this delay to stabilize the contrast voltage Vee as
317 * stipulated by the manual
321 if (priv->variant_display_disable)
322 priv->variant_display_disable(drm);
325 writel(0, priv->regs + priv->ctrl);
327 clk_disable_unprepare(priv->clk);
330 static void pl111_display_update(struct drm_simple_display_pipe *pipe,
331 struct drm_plane_state *old_pstate)
333 struct drm_crtc *crtc = &pipe->crtc;
334 struct drm_device *drm = crtc->dev;
335 struct pl111_drm_dev_private *priv = drm->dev_private;
336 struct drm_pending_vblank_event *event = crtc->state->event;
337 struct drm_plane *plane = &pipe->plane;
338 struct drm_plane_state *pstate = plane->state;
339 struct drm_framebuffer *fb = pstate->fb;
342 u32 addr = drm_fb_cma_get_gem_addr(fb, pstate, 0);
344 writel(addr, priv->regs + CLCD_UBAS);
348 crtc->state->event = NULL;
350 spin_lock_irq(&crtc->dev->event_lock);
351 if (crtc->state->active && drm_crtc_vblank_get(crtc) == 0)
352 drm_crtc_arm_vblank_event(crtc, event);
354 drm_crtc_send_vblank_event(crtc, event);
355 spin_unlock_irq(&crtc->dev->event_lock);
359 static int pl111_display_enable_vblank(struct drm_simple_display_pipe *pipe)
361 struct drm_crtc *crtc = &pipe->crtc;
362 struct drm_device *drm = crtc->dev;
363 struct pl111_drm_dev_private *priv = drm->dev_private;
365 writel(CLCD_IRQ_NEXTBASE_UPDATE, priv->regs + priv->ienb);
370 static void pl111_display_disable_vblank(struct drm_simple_display_pipe *pipe)
372 struct drm_crtc *crtc = &pipe->crtc;
373 struct drm_device *drm = crtc->dev;
374 struct pl111_drm_dev_private *priv = drm->dev_private;
376 writel(0, priv->regs + priv->ienb);
379 static int pl111_display_prepare_fb(struct drm_simple_display_pipe *pipe,
380 struct drm_plane_state *plane_state)
382 return drm_gem_fb_prepare_fb(&pipe->plane, plane_state);
385 static struct drm_simple_display_pipe_funcs pl111_display_funcs = {
386 .mode_valid = pl111_mode_valid,
387 .check = pl111_display_check,
388 .enable = pl111_display_enable,
389 .disable = pl111_display_disable,
390 .update = pl111_display_update,
391 .prepare_fb = pl111_display_prepare_fb,
394 static int pl111_clk_div_choose_div(struct clk_hw *hw, unsigned long rate,
395 unsigned long *prate, bool set_parent)
397 int best_div = 1, div;
398 struct clk_hw *parent = clk_hw_get_parent(hw);
399 unsigned long best_prate = 0;
400 unsigned long best_diff = ~0ul;
401 int max_div = (1 << (TIM2_PCD_LO_BITS + TIM2_PCD_HI_BITS)) - 1;
403 for (div = 1; div < max_div; div++) {
404 unsigned long this_prate, div_rate, diff;
407 this_prate = clk_hw_round_rate(parent, rate * div);
410 div_rate = DIV_ROUND_UP_ULL(this_prate, div);
411 diff = abs(rate - div_rate);
413 if (diff < best_diff) {
416 best_prate = this_prate;
424 static long pl111_clk_div_round_rate(struct clk_hw *hw, unsigned long rate,
425 unsigned long *prate)
427 int div = pl111_clk_div_choose_div(hw, rate, prate, true);
429 return DIV_ROUND_UP_ULL(*prate, div);
432 static unsigned long pl111_clk_div_recalc_rate(struct clk_hw *hw,
435 struct pl111_drm_dev_private *priv =
436 container_of(hw, struct pl111_drm_dev_private, clk_div);
437 u32 tim2 = readl(priv->regs + CLCD_TIM2);
443 div = tim2 & TIM2_PCD_LO_MASK;
444 div |= (tim2 & TIM2_PCD_HI_MASK) >>
445 (TIM2_PCD_HI_SHIFT - TIM2_PCD_LO_BITS);
448 return DIV_ROUND_UP_ULL(prate, div);
451 static int pl111_clk_div_set_rate(struct clk_hw *hw, unsigned long rate,
454 struct pl111_drm_dev_private *priv =
455 container_of(hw, struct pl111_drm_dev_private, clk_div);
456 int div = pl111_clk_div_choose_div(hw, rate, &prate, false);
459 spin_lock(&priv->tim2_lock);
460 tim2 = readl(priv->regs + CLCD_TIM2);
461 tim2 &= ~(TIM2_BCD | TIM2_PCD_LO_MASK | TIM2_PCD_HI_MASK);
467 tim2 |= div & TIM2_PCD_LO_MASK;
468 tim2 |= (div >> TIM2_PCD_LO_BITS) << TIM2_PCD_HI_SHIFT;
471 writel(tim2, priv->regs + CLCD_TIM2);
472 spin_unlock(&priv->tim2_lock);
477 static const struct clk_ops pl111_clk_div_ops = {
478 .recalc_rate = pl111_clk_div_recalc_rate,
479 .round_rate = pl111_clk_div_round_rate,
480 .set_rate = pl111_clk_div_set_rate,
484 pl111_init_clock_divider(struct drm_device *drm)
486 struct pl111_drm_dev_private *priv = drm->dev_private;
487 struct clk *parent = devm_clk_get(drm->dev, "clcdclk");
488 struct clk_hw *div = &priv->clk_div;
489 const char *parent_name;
490 struct clk_init_data init = {
492 .ops = &pl111_clk_div_ops,
493 .parent_names = &parent_name,
495 .flags = CLK_SET_RATE_PARENT,
499 if (IS_ERR(parent)) {
500 dev_err(drm->dev, "CLCD: unable to get clcdclk.\n");
501 return PTR_ERR(parent);
503 /* If the clock divider is broken, use the parent directly */
504 if (priv->variant->broken_clockdivider) {
508 parent_name = __clk_get_name(parent);
510 spin_lock_init(&priv->tim2_lock);
513 ret = devm_clk_hw_register(drm->dev, div);
515 priv->clk = div->clk;
519 int pl111_display_init(struct drm_device *drm)
521 struct pl111_drm_dev_private *priv = drm->dev_private;
522 struct device *dev = drm->dev;
523 struct device_node *endpoint;
527 endpoint = of_graph_get_next_endpoint(dev->of_node, NULL);
531 if (of_property_read_u32_array(endpoint,
532 "arm,pl11x,tft-r0g0b0-pads",
534 ARRAY_SIZE(tft_r0b0g0)) != 0) {
535 dev_err(dev, "arm,pl11x,tft-r0g0b0-pads should be 3 ints\n");
536 of_node_put(endpoint);
539 of_node_put(endpoint);
541 ret = pl111_init_clock_divider(drm);
545 if (!priv->variant->broken_vblank) {
546 pl111_display_funcs.enable_vblank = pl111_display_enable_vblank;
547 pl111_display_funcs.disable_vblank = pl111_display_disable_vblank;
550 ret = drm_simple_display_pipe_init(drm, &priv->pipe,
551 &pl111_display_funcs,
552 priv->variant->formats,
553 priv->variant->nformats,